You are here

Home » API reference » Extensible BBCode 8.2 » XBBCodeHandlerForm.php

class XBBCodeHandlerForm in Extensible BBCode 8.2

Hierarchy

Expanded class hierarchy of XBBCodeHandlerForm

1 file declares its use of XBBCodeHandlerForm
XBBCodeFilter.php in src/Plugin/Filter/XBBCodeFilter.php
Contains Drupal\xbbcode\Plugin\Filter\XBBCodeFilter.
1 string reference to 'XBBCodeHandlerForm'
xbbcode.routing.yml in ./xbbcode.routing.yml
xbbcode.routing.yml

File

src/Form/XBBCodeHandlerForm.php, line 14
Contains \Drupal\xbbcode\Form\XBBCodeTagForm.

Namespace

Drupal\xbbcode\Form
View source 
class XBBCodeHandlerForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'xbbcode.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['global'] = [
      '#weight' => -1,
      '#markup' => $this
        ->t('You are changing the global settings. These settings can be overridden in each <a href="@url">text format</a> that uses Extensible BBCode.', [
        '@url' => Drupal::url('filter.admin_overview'),
      ]),
    ];
    $defaults = $this
      ->config('xbbcode.settings')
      ->get('tags');
    $form = self::buildFormHandlers($form, $defaults);
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

  /**
   * Generate the handler subform.
   */
  public static function buildFormHandlers(array $form, array $defaults) {
    module_load_include('inc', 'xbbcode');
    $handlers = _xbbcode_build_handlers();
    $form['handlers'] = [
      '#type' => 'fieldset',
      '#tree' => FALSE,
      '#theme' => 'xbbcode_settings_handlers_format',
      '#attached' => [
        'library' => [
          'xbbcode/handlers-table',
        ],
      ],
      '#title' => t('Tag settings'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    ];

    // We need another #tree element named "tags" to provide a hierarchy for
    // the module selection menus.
    $form['handlers']['extra']['#tree'] = FALSE;
    $form['handlers']['extra']['tags']['#tree'] = TRUE;
    $form['handlers']['tags'] = [
      '#type' => 'tableselect',
      '#header' => [
        'tag' => t('Name'),
        'description' => t('Description'),
        'module' => t('Module'),
      ],
      '#default_value' => [],
      '#options' => [],
      '#attributes' => [
        'id' => 'xbbcode-handlers',
      ],
      '#empty' => t('No tags or handlers are defined. Please <a href="@modules">install a tag module</a> or <a href="@custom">create some custom tags</a>.', [
        '@modules' => Drupal::url('system.modules_list', [], [
          'fragment' => 'edit-modules-extensible-bbcode',
        ]),
        '@custom' => Drupal::url('xbbcode.admin_tags'),
      ]),
      // The #process function pushes each tableselect checkbox down into an
      // "enabled" sub-element.
      '#process' => [
        [
          'Drupal\\Core\\Render\\Element\\Tableselect',
          'processTableselect',
        ],
        'xbbcode_settings_handlers_process',
      ],
      // Don't aggregate the checkboxes.
      '#value_callback' => NULL,
    ];
    foreach ($handlers as $name => $handler) {
      if (!array_key_exists($name, $defaults)) {
        $defaults[$name] = [
          'enabled' => FALSE,
          'module' => NULL,
        ];
      }
      $form['handlers']['tags']['#options'][$name] = [
        'tag' => [
          'data' => "[{$name}]",
          'class' => [
            'xbbcode-tag-td',
          ],
        ],
        'description' => [
          'data' => [
            '#markup' => _xbbcode_build_descriptions($name, $handler['info'], $defaults[$name]['module']),
          ],
          'class' => [
            'xbbcode-tag-description',
          ],
        ],
        'module' => [
          'data' => 'handler-select',
          'class' => [
            'xbbcode-tag-td',
          ],
        ],
        '#attributes' => [
          'class' => $defaults[$name]['enabled'] ? [
            'selected',
          ] : [],
        ],
      ];
      $form['handlers']['tags']['#default_value'][$name] = $defaults[$name]['enabled'] ? 1 : NULL;
      if (count($handler['modules']) > 1) {
        $module_selector = [
          '#type' => 'select',
          '#options' => $handler['modules'],
          '#default_value' => $defaults[$name]['enabled'],
          '#attributes' => [
            'class' => [
              'xbbcode-tag-handler',
            ],
          ],
        ];
      }
      else {
        $module_selector = [
          'shown' => [
            '#type' => 'markup',
            '#markup' => current($handler['modules']),
          ],
          '#type' => 'value',
          '#value' => key($handler['modules']),
        ];
      }
      $form['handlers']['extra']['tags'][$name]['module'] = $module_selector;
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('xbbcode.settings')
      ->set('tags', $form_state
      ->getValue('tags'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
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.
XBBCodeHandlerForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
XBBCodeHandlerForm::buildFormHandlers public static function Generate the handler subform.
XBBCodeHandlerForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
XBBCodeHandlerForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
XBBCodeHandlerForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm