You are here

Home » API reference » Layout Builder Restrictions 8.2 » RestrictionPluginConfigForm.php

class RestrictionPluginConfigForm in Layout Builder Restrictions 8.2

Class RestrictionPluginConfigForm.

Hierarchy

Expanded class hierarchy of RestrictionPluginConfigForm

1 string reference to 'RestrictionPluginConfigForm'
layout_builder_restrictions.routing.yml in ./layout_builder_restrictions.routing.yml
layout_builder_restrictions.routing.yml

File

src/Form/RestrictionPluginConfigForm.php, line 14

Namespace

Drupal\layout_builder_restrictions\Form
View source 
class RestrictionPluginConfigForm extends FormBase {

  /**
   * The UI for managing Layout Builder Restrictions Plugins.
   *
   * @var \Drupal\layout_builder_restrictions\Plugin\LayoutBuilderRestrictionManager
   */
  protected $pluginManagerLayoutBuilderRestriction;

  /**
   * Drupal\Core\Config\ConfigManager definition.
   *
   * @var \Drupal\Core\Config\ConfigManager
   */
  protected $configManager;

  /**
   * Constructs a new RestrictionPluginConfigForm object.
   */
  public function __construct(LayoutBuilderRestrictionManager $plugin_manager_layout_builder_restriction, ConfigManager $config_manager) {
    $this->pluginManagerLayoutBuilderRestriction = $plugin_manager_layout_builder_restriction;
    $this->configManager = $config_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.layout_builder_restriction'), $container
      ->get('config.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $plugin_list = $this->pluginManagerLayoutBuilderRestriction
      ->getSortedPlugins(TRUE);
    $form['plugin-table'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Plugin'),
        $this
          ->t('ID'),
        $this
          ->t('Enabled'),
        $this
          ->t('Weight'),
      ],
      '#empty' => $this
        ->t('There are no restriction plugins defined.'),
      // TableDrag: Each array value is a list of callback arguments for
      // drupal_add_tabledrag().
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'plugin-table-order-weight',
        ],
      ],
      '#prefix' => '<p>Set the order the Layout Builder Restriction plugins should be called, and enable or disable as needed.</p>',
    ];

    // Build the table rows and columns.
    // The first nested level in the render array forms the table row,
    // on which you likely want to set #attributes and #weight.
    foreach ($plugin_list as $id => $data) {

      // TableDrag: Mark the table row as draggable.
      $form['plugin-table'][$id]['#attributes']['class'][] = 'draggable';

      // Sort the row according to its existing/configured weight.
      $form['plugin-table'][$id]['#weight'] = $data['weight'];
      if ($data['description']) {
        $form['plugin-table'][$id]['title'] = [
          '#markup' => '<strong>' . $data['title'] . '</strong><br>' . $data['description'],
        ];
      }
      else {
        $form['plugin-table'][$id]['title'] = [
          '#markup' => '<strong>' . $data['title'] . '</strong>',
        ];
      }
      $form['plugin-table'][$id]['id'] = [
        '#plain_text' => $id,
      ];
      $form['plugin-table'][$id]['enabled'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Enabled'),
        '#title_display' => 'invisible',
        '#default_value' => $data['enabled'],
        // Classify the weight element for #tabledrag.
        '#attributes' => [
          'class' => [
            'plugin-table-enabled',
          ],
        ],
      ];

      // TableDrag: Weight column element.
      $form['plugin-table'][$id]['weight'] = [
        '#type' => 'weight',
        '#title' => $this
          ->t('Weight for @title', [
          '@title' => $id,
        ]),
        '#title_display' => 'invisible',
        '#default_value' => $data['weight'],
        // Classify the weight element for #tabledrag.
        '#attributes' => [
          'class' => [
            'plugin-table-order-weight',
          ],
        ],
      ];
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $data_to_save = [];
    $restriction_definitions = $this->pluginManagerLayoutBuilderRestriction
      ->getDefinitions();
    foreach ($form_state
      ->getValue('plugin-table') as $plugin_id => $vals) {

      // Verify we have a registered plugin key.
      if (isset($restriction_definitions[$plugin_id])) {
        $data_to_save[$plugin_id] = [
          'weight' => (int) $vals['weight'],
          'enabled' => (bool) $vals['enabled'],
        ];
      }
    }

    // Save config.
    $plugin_weighting_config = $this
      ->configFactory()
      ->getEditable('layout_builder_restrictions.plugins');
    $plugin_weighting_config
      ->set('plugin_config', $data_to_save);
    $plugin_weighting_config
      ->save();
  }

}

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
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::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.
RestrictionPluginConfigForm::$configManager protected property Drupal\Core\Config\ConfigManager definition.
RestrictionPluginConfigForm::$pluginManagerLayoutBuilderRestriction protected property The UI for managing Layout Builder Restrictions Plugins.
RestrictionPluginConfigForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
RestrictionPluginConfigForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
RestrictionPluginConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RestrictionPluginConfigForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
RestrictionPluginConfigForm::__construct public function Constructs a new RestrictionPluginConfigForm object.
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.