class Menu in Context 8.4

Provides a content reaction that adds a css 'active' class to menu item.

Plugin annotation

@ContextReaction(
  id = "menu",
  label = @Translation("Menu")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\context\ContextReactionPluginBase implements ContextReactionInterface
      • class \Drupal\context\Plugin\ContextReaction\Menu implements ContainerFactoryPluginInterface

1 string reference to 'Menu'

Menu::buildConfigurationForm in src/Plugin/ContextReaction/Menu.php

Form constructor.

File

src/Plugin/ContextReaction/Menu.php, line 19

Namespace

Drupal\context\Plugin\ContextReaction

class Menu extends ContextReactionPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The menu parent form selector service.
   *
   * @var \Drupal\Core\Menu\MenuParentFormSelector
   */
  protected $menuParentFormSelector;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MenuParentFormSelectorInterface $menu_parent_form_selector) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->menuParentFormSelector = $menu_parent_form_selector;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('menu.parent_form_selector'));
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {
    return $this
      ->t('Set active menu item based on conditions.');
  }

  /**
   * {@inheritdoc}
   */
  public function execute(array &$vars = []) {
    $config = $this
      ->getConfiguration();
    return $config['menu'];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $parent_element = $this->menuParentFormSelector
      ->parentSelectElement('main:');
    $config = $this
      ->getConfiguration();
    $form['menu_items'] = [
      '#title' => $this
        ->t('Menu'),
      '#type' => 'select',
      '#options' => $parent_element['#options'],
      '#multiple' => TRUE,
      '#default_value' => isset($config['menu']) ? $config['menu'] : '',
      '#size' => 15,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $values = array_keys($form_state
      ->getValue('menu_items'));
    $this
      ->setConfiguration([
      'menu' => $values,
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContextReactionPluginBase::calculateDependencies	public	function		1
ContextReactionPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	2
ContextReactionPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration	1
ContextReactionPluginBase::getId	public	function	Get the unique ID of this context reaction. Overrides ContextReactionInterface::getId
ContextReactionPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
ContextReactionPluginBase::validateConfigurationForm	public	function	Form validation handler is optional. Overrides PluginFormInterface::validateConfigurationForm
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
Menu::$menuParentFormSelector	protected	property	The menu parent form selector service.
Menu::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
Menu::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Menu::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
Menu::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
Menu::summary	public	function	Provides a human readable summary of the condition's configuration. Overrides ContextReactionInterface::summary
Menu::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides ContextReactionPluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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.