You are here

Home » API reference » Panopoly 8.2 » PanopolyAdminBlocksForm.php

class PanopolyAdminBlocksForm in Panopoly 8.2

Form to administer available blocks.

Hierarchy

Expanded class hierarchy of PanopolyAdminBlocksForm

1 string reference to 'PanopolyAdminBlocksForm'
panopoly_admin.routing.yml in modules/panopoly/panopoly_admin/panopoly_admin.routing.yml
modules/panopoly/panopoly_admin/panopoly_admin.routing.yml

File

modules/panopoly/panopoly_admin/src/Form/PanopolyAdminBlocksForm.php, line 14

Namespace

Drupal\panopoly_admin\Form
View source 
class PanopolyAdminBlocksForm extends FormBase {

  /**
   * The block plugin manager.
   *
   * @var \Drupal\Core\Block\BlockManagerInterface
   */
  protected $blockManager;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * PanopolyAdminLayoutsForm constructor.
   *
   * @param \Drupal\Core\Block\BlockManagerInterface $block_manager
   *   The block plugin manager.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(BlockManagerInterface $block_manager, ConfigFactoryInterface $config_factory) {
    $this->blockManager = $block_manager;
    $this->configFactory = $config_factory;
  }

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

  /**
   * {@inheritDoc}
   */
  public function getFormId() {
    return 'panopoly_admin_blocks_form';
  }

  /**
   * {@inheritDoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this->configFactory
      ->get('panopoly_admin.settings');
    $blocks = $config
      ->get('blocks');
    $form['blocks'] = [
      '#type' => 'vertical_tabs',
    ];
    $definitions = $this->blockManager
      ->getFilteredDefinitions('layout_builder', NULL, [
      'panopoly_admin_blocks_form' => TRUE,
    ]);
    $definitions = $this->blockManager
      ->getGroupedDefinitions($definitions);
    foreach ($definitions as $group_name => $group) {
      $key = $group_name;
      if (empty($group_name)) {
        $group_name = $this
          ->t('Miscellaneous');
      }
      $form[$key] = [
        '#type' => 'details',
        '#title' => $group_name,
        '#group' => 'blocks',
      ];
      foreach ($group as $block_id => $definition) {
        $form[$key][$block_id] = [
          '#type' => 'checkbox',
          '#title' => isset($definition['admin_label']) ? $definition['admin_label'] : $block_id,
          '#default_value' => isset($blocks[$block_id]) ? $blocks[$block_id] : TRUE,
          '#parents' => [
            'block_values',
            $block_id,
          ],
        ];
      }
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    ];
    return $form;
  }

  /**
   * {@inheritDoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this->configFactory
      ->getEditable('panopoly_admin.settings');
    $config
      ->set('blocks', $form_state
      ->getValue('block_values'));
    $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::$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.
PanopolyAdminBlocksForm::$blockManager protected property The block plugin manager.
PanopolyAdminBlocksForm::$configFactory protected property The config factory. Overrides FormBase::$configFactory
PanopolyAdminBlocksForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
PanopolyAdminBlocksForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
PanopolyAdminBlocksForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PanopolyAdminBlocksForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
PanopolyAdminBlocksForm::__construct public function PanopolyAdminLayoutsForm constructor.
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.