class MenuLinkWidget in Menu Link (Field) 8

Same name and namespace in other branches

2.0.x src/Plugin/Field/FieldWidget/MenuLinkWidget.php \Drupal\menu_link\Plugin\Field\FieldWidget\MenuLinkWidget

Provides a widget for the menu_link field type.

Plugin annotation


@FieldWidget(
  id = "menu_link_default",
  label = @Translation("Menu link"),
  field_types = {
    "menu_link"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\menu_link\Plugin\Field\FieldWidget\MenuLinkWidget

Expanded class hierarchy of MenuLinkWidget

File

src/Plugin/Field/FieldWidget/MenuLinkWidget.php, line 25

Namespace

Drupal\menu_link\Plugin\Field\FieldWidget

View source

class MenuLinkWidget extends WidgetBase {

  /**
   * The parent menu link selector.
   *
   * @var \Drupal\Core\Menu\MenuParentFormSelectorInterface
   */
  protected $menuParentSelector;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $account;

  /**
   * The menu link manager.
   *
   * @var \Drupal\Core\Menu\MenuLinkManagerInterface
   */
  protected $menuLinkManager;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, MenuParentFormSelectorInterface $menu_parent_selector, AccountInterface $account, MenuLinkManagerInterface $menu_link_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->menuParentSelector = $menu_parent_selector;
    $this->account = $account;
    $this->menuLinkManager = $menu_link_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('menu.parent_form_selector'), $container
      ->get('current_user'), $container
      ->get('plugin.manager.menu.link'));
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) : array {
    $default_weight = isset($items[$delta]->weight) ? $items[$delta]->weight : 0;
    $available_menu_names = array_filter($items
      ->getSetting('available_menus'));
    $available_menus = array_combine($available_menu_names, $available_menu_names);
    if (empty($items[$delta]->menu_name)) {
      $default_menu_parent = $items
        ->getSetting('default_menu_parent');
      if (empty($available_menus[rtrim($default_menu_parent, ':')])) {
        $default_menu_parent = reset($available_menu_names) . ':';
      }
    }
    else {
      $menu = $items[$delta]->menu_name;
      $parent = !empty($items[$delta]->parent) ? $items[$delta]->parent : '';
      $default_menu_parent = "{$menu}:{$parent}";
    }
    $default_title = isset($items[$delta]->title) ? $items[$delta]->title : NULL;
    $default_description = isset($items[$delta]->description) ? $items[$delta]->description : NULL;

    // The widget form may be used to define default values, so make sure the
    // form object is an entity form, rather than a configuration form.

    /** @var \Drupal\Core\Entity\EntityInterface $entity */
    $entity = $items
      ->getParent()
      ->getValue();
    $class = get_class($this);
    $element['#pre_render'][] = [
      [
        $class,
        'preRenderMenuDetails',
      ],
    ];
    $element['#attached']['library'][] = 'menu_link/menu_link.form';
    $element['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Menu link title'),
      '#default_value' => $default_title,
      '#attributes' => [
        'class' => [
          'menu-link-title',
        ],
      ],
    ];
    $element['description'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Description'),
      '#default_value' => $default_description,
      '#rows' => 1,
      '#description' => $this
        ->t('Shown when hovering over the menu link.'),
    ];
    $plugin_id = $items[$delta]
      ->getMenuPluginId();
    $has_plugin = $plugin_id && $this->menuLinkManager
      ->hasDefinition($plugin_id);
    $element['enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Provide a menu link'),
      '#default_value' => (int) (bool) $has_plugin,
      '#attributes' => [
        'class' => [
          'menu-link-enabled',
        ],
      ],
      '#multilingual' => FALSE,
    ];
    $element['menu'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Menu settings'),
      '#open' => (bool) $has_plugin,
      '#tree' => FALSE,
      '#weight' => $entity
        ->getEntityTypeId() === 'node' ? -2 : 0,
      '#group' => $entity
        ->getEntityTypeId() === 'node' ? 'advanced' : NULL,
      '#attributes' => [
        'class' => [
          'menu-link-form',
        ],
      ],
      '#attached' => [
        'library' => [
          'menu_ui/drupal.menu_ui',
        ],
      ],
    ];
    $plugin_id = $items[$delta]
      ->getMenuPluginId();
    $parent_element = $this->menuParentSelector
      ->parentSelectElement($default_menu_parent, $plugin_id, $available_menus);
    $element['menu_parent'] = $parent_element;
    $element['menu_parent']['#title'] = $this
      ->t('Parent item');
    $element['menu_parent']['#attributes']['class'][] = 'menu-parent-select';
    $element['weight'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Weight'),
      '#default_value' => $default_weight,
      '#description' => $this
        ->t('Menu links with lower weights are displayed before links with higher weights.'),
    ];
    return $element;
  }

  /**
   * Pre-render callback: Builds a renderable array for the menu link widget.
   *
   * @param array $element
   *   A renderable array.
   *
   * @return array
   *   A renderable array.
   */
  public static function preRenderMenuDetails($element) : array {
    $element['menu']['enabled'] = $element['enabled'];
    $element['menu']['title'] = $element['title'];
    $element['menu']['description'] = $element['description'];
    $element['menu']['menu_parent'] = $element['menu_parent'];
    $element['menu']['weight'] = $element['weight'];

    // Hide the elements when enabled is disabled.
    foreach ([
      'title',
      'description',
      'menu_parent',
      'weight',
    ] as $form_element) {
      $element['menu'][$form_element]['#states'] = [
        'invisible' => [
          'input[name="' . $element['menu']['enabled']['#name'] . '"]' => [
            'checked' => FALSE,
          ],
        ],
      ];
    }
    unset($element['enabled'], $element['title'], $element['description'], $element['menu_parent'], $element['weight']);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function extractFormValues(FieldItemListInterface $items, array $form, FormStateInterface $form_state) : void {
    parent::extractFormValues($items, $form, $form_state);

    // Extract menu and parent menu link from single select element.
    foreach ($items as $delta => $item) {
      if (!empty($item->enabled) && !empty($item->menu_parent) && $item->menu_parent !== ':') {
        list($item->menu_name, $item->parent) = explode(':', $item->menu_parent, 2);
      }
      else {
        $item->title = '';
        $item->description = '';
        $item->menu_name = '';
        $item->parent = '';
      }
      unset($item->enabled, $item->menu_parent);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AllowedTagsXssTrait::allowedTags	public	function	Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags	public	function	Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss	public	function	Filters an HTML string to prevent XSS vulnerabilities.
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
MenuLinkWidget::$account	protected	property	The current user.
MenuLinkWidget::$menuLinkManager	protected	property	The menu link manager.
MenuLinkWidget::$menuParentSelector	protected	property	The parent menu link selector.
MenuLinkWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
MenuLinkWidget::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
MenuLinkWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
MenuLinkWidget::preRenderMenuDetails	public static	function	Pre-render callback: Builds a renderable array for the menu link widget.
MenuLinkWidget::__construct	public	function	Constructs a WidgetBase object. Overrides WidgetBase::__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.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings	42
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
WidgetBase::$fieldDefinition	protected	property	The field definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax	public static	function	Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit	public static	function	Submission handler for the "Add another item" button.
WidgetBase::afterBuild	public static	function	After-build handler for field elements in a form.
WidgetBase::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
WidgetBase::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
WidgetBase::formMultipleElements	protected	function	Special handling to create form elements for multiple values.	1
WidgetBase::formSingleElement	protected	function	Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting	protected	function	Returns the value of a field setting.
WidgetBase::getFieldSettings	protected	function	Returns the array of field settings.
WidgetBase::getFilteredDescription	protected	function	Returns the filtered field description.
WidgetBase::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents	protected static	function	Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues	protected	function	Returns whether the widget handles multiple values.
WidgetBase::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable	4
WidgetBase::isDefaultValueWidget	protected	function	Returns whether the widget used for default value form.
WidgetBase::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues	7
WidgetBase::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm	16
WidgetBase::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary	15
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState

You are here

class MenuLinkWidget in Menu Link (Field) 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation