You are here

Home » API reference » Font Awesome Icons 8 » EditorIconDialog.php

class EditorIconDialog in Font Awesome Icons 8

Same name and namespace in other branches
  1. 8.2 src/Form/EditorIconDialog.php \Drupal\fontawesome\Form\EditorIconDialog

Provides a Font Awesome icon dialog for text editors.

Hierarchy

Expanded class hierarchy of EditorIconDialog

1 string reference to 'EditorIconDialog'
fontawesome.routing.yml in ./fontawesome.routing.yml
fontawesome.routing.yml

File

src/Form/EditorIconDialog.php, line 17

Namespace

Drupal\fontawesome\Form
View source 
class EditorIconDialog extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'fontawesome_icon_dialog';
  }

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\editor\Entity\Editor $editor
   *   The text editor to which this dialog corresponds.
   */
  public function buildForm(array $form, FormStateInterface $form_state, Editor $editor = NULL) {
    $form['#tree'] = TRUE;
    $form['#attached']['library'][] = 'editor/drupal.editor.dialog';
    $form['#prefix'] = '<div id="fontawesome-icon-dialog-form">';
    $form['#suffix'] = '</div>';
    $form['information'] = [
      '#type' => 'container',
      '#attributes' => [],
      '#children' => $this
        ->t('For more information on icon selection, see <a href=":iconurl" target="_blank">:iconurl</a>', [
        ':iconurl' => 'http://fontawesome.io/icons/',
      ]),
    ];
    $form['preview'] = [
      [
        '#type' => 'html_tag',
        '#tag' => 'h3',
        '#value' => $this
          ->t('Preview'),
      ],
      [
        '#type' => 'container',
        '#attributes' => [
          'id' => 'fontawesome-icon-preview',
        ],
        '#children' => $this
          ->t('<i class=":iconclass"></i> :iconclass', [
          ':iconclass' => $this
            ->buildClassString([
            'flag',
          ]),
        ]),
      ],
    ];

    // Build additional settings.
    $form['settings'] = [
      '#type' => 'details',
      '#open' => FALSE,
      '#title' => $this
        ->t('Additional Settings'),
    ];

    // Allow user to determine size.
    $form['settings']['size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Size'),
      '#description' => $this
        ->t('This increases icon sizes relative to their container'),
      '#options' => [
        '' => $this
          ->t('Default'),
        'lg' => $this
          ->t('Large'),
        '2x' => $this
          ->t('2x'),
        '3x' => $this
          ->t('3x'),
        '4x' => $this
          ->t('4x'),
        '5x' => $this
          ->t('5x'),
      ],
      '#default_value' => '',
      '#ajax' => [
        'callback' => [
          $this,
          'previewIcon',
        ],
        'wrapper' => 'fontawesome-icon-preview',
        'method' => 'html',
      ],
    ];

    // Set icon to fixed width.
    $form['settings']['fixed-width'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Fixed Width?'),
      '#description' => $this
        ->t('Use to set icons at a fixed width. Great to use when different icon widths throw off alignment. Especially useful in things like nav lists & list groups.'),
      '#default_value' => FALSE,
      '#return_value' => 'fw',
      '#ajax' => [
        'callback' => [
          $this,
          'previewIcon',
        ],
        'wrapper' => 'fontawesome-icon-preview',
        'method' => 'html',
      ],
    ];

    // Add border.
    $form['settings']['border'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Border?'),
      '#description' => $this
        ->t('Adds a border to the icon.'),
      '#default_value' => FALSE,
      '#return_value' => 'border',
      '#ajax' => [
        'callback' => [
          $this,
          'previewIcon',
        ],
        'wrapper' => 'fontawesome-icon-preview',
        'method' => 'html',
      ],
    ];

    // Invert color.
    $form['settings']['border'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Invert color?'),
      '#description' => $this
        ->t('Inverts the color of the icon (black becomes white, etc.)'),
      '#default_value' => FALSE,
      '#return_value' => 'inverse',
      '#ajax' => [
        'callback' => [
          $this,
          'previewIcon',
        ],
        'wrapper' => 'fontawesome-icon-preview',
        'method' => 'html',
      ],
    ];

    // Rotate/flip the icon..
    $form['settings']['rotate'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Rotate'),
      '#options' => [
        '' => $this
          ->t('None'),
        'rotate-90' => $this
          ->t('90°'),
        'rotate-180' => $this
          ->t('180°'),
        'rotate-270' => $this
          ->t('270°'),
      ],
      '#default_value' => '',
      '#ajax' => [
        'callback' => [
          $this,
          'previewIcon',
        ],
        'wrapper' => 'fontawesome-icon-preview',
        'method' => 'html',
      ],
    ];
    $form['settings']['flip'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Flip'),
      '#options' => [
        '' => $this
          ->t('None'),
        'flip-horizontal' => $this
          ->t('Horizontal'),
        'flip-vertical' => $this
          ->t('Vertical'),
      ],
      '#default_value' => '',
      '#ajax' => [
        'callback' => [
          $this,
          'previewIcon',
        ],
        'wrapper' => 'fontawesome-icon-preview',
        'method' => 'html',
      ],
    ];

    // Animated the icon.
    $form['settings']['animation'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Animation'),
      '#options' => [
        '' => $this
          ->t('None'),
        'spin' => $this
          ->t('Spin'),
        'pulse' => $this
          ->t('Pulse'),
      ],
      '#default_value' => '',
      '#ajax' => [
        'callback' => [
          $this,
          'previewIcon',
        ],
        'wrapper' => 'fontawesome-icon-preview',
        'method' => 'html',
      ],
    ];

    // Pull the icons.
    $form['settings']['animation'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Pull'),
      '#description' => $this
        ->t('This setting will pull the icon (float) to one side or the other in relation to its nearby content'),
      '#options' => [
        '' => $this
          ->t('None'),
        'pull-left' => $this
          ->t('Left'),
        'pull-right' => $this
          ->t('Right'),
      ],
      '#default_value' => '',
      '#ajax' => [
        'callback' => [
          $this,
          'previewIcon',
        ],
        'wrapper' => 'fontawesome-icon-preview',
        'method' => 'html',
      ],
    ];

    // Select an icon.
    $form['icon'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Icon'),
      '#description' => $this
        ->t('For information on how to stack icons or use them in ordered lists, see <a href=":iconlink" target="_blank">:iconlink</a>', [
        ':iconlink' => 'http://fontawesome.io/examples/',
      ]),
      '#options' => [],
      '#default_value' => 'flag',
      '#ajax' => [
        'callback' => [
          $this,
          'previewIcon',
        ],
        'wrapper' => 'fontawesome-icon-preview',
        'method' => 'html',
      ],
    ];

    // Add all icon options to the list.
    foreach (fontawesome_extract_icons() as $iconName) {
      $form['icon']['#options'][$iconName] = $this
        ->t('<i class=":iconclass" title=":iconname"></i> :iconname', [
        ':iconclass' => $this
          ->buildClassString([
          $iconName,
          'lg',
          'fw',
        ]),
        ':iconname' => $iconName,
      ]);
    }
    if (count($form['icon']['#options']) == 0) {
      $form['icon'] = [
        '#type' => 'container',
        '#attributes' => '',
        '#children' => $this
          ->t('Error: invalid CSS found for Font Awesome. Please check the <a href=":status_report">Status Report</a> to verify that Font Awesome is properly installed.', [
          ':status_report' => Url::fromRoute('system.status')
            ->toString(),
        ]),
      ];
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['save_modal'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Insert Icon'),
      // No regular submit-handler. This form only works via JavaScript.
      '#submit' => [],
      '#ajax' => [
        'callback' => '::submitForm',
        'event' => 'click',
      ],
    ];
    return $form;
  }

  /**
   * Callback for previewing the Icon.
   */
  public function previewIcon(array &$form, FormStateInterface $form_state) {
    $form_values = $form_state
      ->getValues();
    $icon_class = $this
      ->buildClassString([
      $form_values['icon'],
    ] + $form_values['settings']);
    return [
      '#type' => 'html_tag',
      '#tag' => 'i',
      '#attributes' => [
        'class' => $icon_class,
      ],
      '#suffix' => $icon_class,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    if ($form_state
      ->getErrors()) {
      unset($form['#prefix'], $form['#suffix']);
      $form['status_messages'] = [
        '#type' => 'status_messages',
        '#weight' => -10,
      ];
      $response
        ->addCommand(new HtmlCommand('#fontawesome-icon-dialog-form', $form));
    }
    else {
      $form_values = $form_state
        ->getValues();
      $icon_attributes = [
        'attributes' => [
          'class' => $this
            ->buildClassString([
            $form_values['icon'],
          ] + $form_values['settings']),
        ],
      ];
      $response
        ->addCommand(new EditorDialogSave($icon_attributes));
      $response
        ->addCommand(new CloseModalDialogCommand());
    }
    return $response;
  }

  /**
   * Build Font Awesome class string from an array of attributes.
   *
   * @param array $attributes
   *   The attributes being used for this Font Awesome icon.
   *
   * @return string
   *   The class string for rendering an icon.
   */
  private function buildClassString(array $attributes) {
    $attributes = array_filter($attributes);
    foreach ($attributes as &$attribute) {
      if (substr($attribute, 0, 3) != 'fa-') {
        $attribute = 'fa-' . $attribute;
      }
    }
    return 'fa ' . implode(' ', $attributes);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EditorIconDialog::buildClassString private function Build Font Awesome class string from an array of attributes.
EditorIconDialog::buildForm public function Overrides FormInterface::buildForm
EditorIconDialog::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EditorIconDialog::previewIcon public function Callback for previewing the Icon.
EditorIconDialog::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.