You are here

Home » API reference » Field Menu 8 » TreeWidget.php

class TreeWidget in Field Menu 8

Plugin implementation of the 'field_menu_tree_widget' widget.

Plugin annotation


@FieldWidget(
  id = "field_menu_tree_widget",
  module = "field_menu",
  label = @Translation("Menu item as tree key"),
  field_types = {
    "field_menu"
  }
)

Hierarchy

Expanded class hierarchy of TreeWidget

File

src/Plugin/Field/FieldWidget/TreeWidget.php, line 26

Namespace

Drupal\field_menu\Plugin\Field\FieldWidget
View source 
class TreeWidget extends WidgetBase implements ContainerFactoryPluginInterface {
  use StringTranslationTrait;

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

  /**
   * Constructs a TreeWidget object.
   *
   * @param string $plugin_id
   *   The plugin_id for the widget.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the widget is associated.
   * @param array $settings
   *   The widget settings.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Menu\MenuParentFormSelectorInterface $menu_parent_selector
   *   The menu link tree.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, MenuParentFormSelectorInterface $menu_parent_selector) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->menuParentSelector = $menu_parent_selector;
  }

  /**
   * {@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'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'max_depth' => 0,
      'menu_item_key' => '',
      'include_root' => FALSE,
      'menu_title' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element['menu_title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Title'),
      '#default_value' => isset($items[$delta]->menu_title) ? $items[$delta]->menu_title : $this
        ->getSetting('menu_title'),
      '#description' => $this
        ->t('Optional title for the menu.'),
    ];
    $menu_key_value = isset($items[$delta]->menu_item_key) ? $items[$delta]->menu_item_key : $this
      ->getSetting('menu_item_key');

    // Get existing data from field if there is any.
    $menu_key_value_arr = explode(':', $menu_key_value);
    $menu_name = isset($menu_key_value_arr[0]) && $menu_key_value_arr[0] ? $menu_key_value_arr[0] : NULL;
    $parent = isset($menu_key_value_arr[1]) && $menu_key_value_arr[1] ? $menu_key_value_arr[1] : NULL;
    $menu_link = isset($menu_key_value_arr[2]) && $menu_key_value_arr[2] ? $menu_key_value_arr[2] : NULL;
    $menu_parent = $menu_name . ':' . $parent;

    /* Build a select field with all the menus the current user
     * has access to with a unique key
     * (uses the same fuctionality as when a user adds a menu link to a node)
     */

    // Limit menu list from field settings.
    $menus = NULL;
    if (!empty($items
      ->getSetting('menu_type_checkbox'))) {
      $menu_selected = array_diff($items
        ->getSetting('menu_type_checkbox'), [
        0,
      ]);
      $menus = empty($menu_selected) ? NULL : $menu_selected;
    }
    $menu_item_key_field = $this->menuParentSelector
      ->parentSelectElement($menu_parent, $menu_link, $menus);
    $menu_item_key_field['#default_value'] = $menu_key_value;
    $menu_item_key_field['#description'] = $this
      ->t('Select a menu root item from the available menu links');
    $menu_item_key_field += [
      '#empty_value' => '',
      '#title' => $this
        ->t('Root'),
    ];
    $element['menu_item_key'] = $menu_item_key_field;
    $element['max_depth'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Max depth'),
      '#default_value' => isset($items[$delta]->max_depth) ? $items[$delta]->max_depth : $this
        ->getSetting('max_depth'),
      '#description' => $this
        ->t('Maximum depth of the menu tree (0 is no limit).'),
      '#min' => 0,
    ];
    $element['include_root'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include root?'),
      '#description' => $this
        ->t('Include the root item in the tree or just the child elements'),
      '#default_value' => isset($items[$delta]->include_root) ? $items[$delta]->include_root : $this
        ->getSetting('include_root'),
    ];
    $element += [
      '#element_validate' => [
        [
          $this,
          'validate',
        ],
      ],
    ];

    // If cardinality is 1, ensure a label is output for the field by wrapping
    // it in a details element.
    if ($this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality() == 1) {
      $element += [
        '#type' => 'fieldset',
        '#attributes' => [
          'class' => [
            'container',
          ],
        ],
      ];
    }
    return $element;
  }

  /**
   * Validate the Menu item Key field.
   */
  public function validate($element, FormStateInterface $form_state) {
    $menu_item_key = isset($element['menu_item_key']['#value']) ? $element['menu_item_key']['#value'] : '';
    if (strlen($menu_item_key) == 0) {
      $form_state
        ->setValueForElement($element['menu_item_key'], '');
      if ($element['menu_title']['#value']) {
        $form_state
          ->setError($element['menu_item_key'], $this
          ->t("You must select a menu item if you have set a title"));
      }
    }
  }

}

Members

Namesort descending 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
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::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.
TreeWidget::$menuParentSelector protected property The parent form selector service.
TreeWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
TreeWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TreeWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
TreeWidget::validate public function Validate the Menu item Key field.
TreeWidget::__construct public function Constructs a TreeWidget object. Overrides WidgetBase::__construct
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::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
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