class CheeseburgerMenu in Cheeseburger Menu 8

Same name and namespace in other branches

8.4 src/Plugin/Block/CheeseburgerMenu.php \Drupal\cheeseburger_menu\Plugin\Block\CheeseburgerMenu
8.2 src/Plugin/Block/CheeseburgerMenu.php \Drupal\cheeseburger_menu\Plugin\Block\CheeseburgerMenu
8.3 src/Plugin/Block/CheeseburgerMenu.php \Drupal\cheeseburger_menu\Plugin\Block\CheeseburgerMenu

Plugin annotation


@Block(
  id = "cheesebuger_menu_block",
  admin_label = @Translation("Cheeseburger Menu"),
  category = @Translation("Block")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\cheeseburger_menu\Plugin\Block\CheeseburgerMenu implements ContainerFactoryPluginInterface

Expanded class hierarchy of CheeseburgerMenu

File

src/Plugin/Block/CheeseburgerMenu.php, line 27

Namespace

Drupal\cheeseburger_menu\Plugin\Block

View source

class CheeseburgerMenu extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManager
   */
  protected $entityFieldManager;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityTypeManager;
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityFieldManagerInterface $entity_field_manager, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityFieldManager = $entity_field_manager;
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   *
   * @return $form
   * builds up the block form
   *
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $config = $this
      ->getConfiguration();
    $controller = new renderCheeseburgerMenuBlock();
    $menu_names = $controller
      ->getAllMenuLinkNames();
    $menu_ids = $controller
      ->getAllMenuLinkId();
    $taxonomy_term_names = $controller
      ->getAllTaxonomyTermNames();
    $taxonomy_term_ids = $controller
      ->getAllTaxonomyTermIds();
    $moduleHandler = \Drupal::service('module_handler');

    /** @var Drupal\Core\Language\LanguageManager $languageManager */
    $languageManager = \Drupal::service('language_manager');

    // TITLE AND LANGUAGE SWITCHER
    if ($languageManager
      ->isMultilingual()) {
      $form['lang_switcher_checkbox'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Enable language switcher'),
        '#default_value' => isset($config['lang_switcher']) ? $config['lang_switcher'] : 0,
      ];
      $form['language_switcher_weight'] = [
        '#type' => 'weight',
        '#default_value' => isset($config['language_switcher_weight']) ? $config['language_switcher_weight'] : 0,
        '#states' => [
          'invisible' => [
            ':input[name="settings[lang_switcher_checkbox]"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ];
    }
    $container_inline = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'container-inline',
        ],
      ],
    ];
    $form['css_default'] = [
      '#prefix' => '<div class="container-inline">',
      '#type' => 'checkbox',
      '#suffix' => '<label>Use default CSS file</label></div>',
      '#default_value' => isset($config['css_default']) ? $config['css_default'] : TRUE,
    ];
    $form['headerHeight'] = [
      '#title' => 'Header height',
      '#type' => 'number',
      '#default_value' => isset($config['headerHeight']) ? $config['headerHeight'] : 0,
    ];
    $form['headerPadding'] = [
      '#title' => 'Header padding',
      '#type' => 'number',
      '#default_value' => isset($config['headerPadding']) ? $config['headerPadding'] : 0,
    ];

    //ADDITIONAL OPTIONS
    $form['additional_options'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Additional options'),
    ];
    $form['additional_options']['hr1'] = [
      '#type' => 'markup',
      '#markup' => '<hr>',
    ];
    if ($moduleHandler
      ->moduleExists('commerce_cart')) {
      $form['additional_options']['cart'] = [
        '#prefix' => '<div class="container-inline">',
        '#type' => 'checkbox',
        '#suffix' => '<label>Cart</label></div>',
        '#default_value' => isset($config['cart_appear']) ? $config['cart_appear'] : FALSE,
      ];
      $form['additional_options']['cart_weight'] = [
        '#type' => 'weight',
        '#default_value' => isset($config['cart_weight']) ? $config['cart_weight'] : 0,
        '#states' => [
          'invisible' => [
            ':input[name="settings[additional_options][cart]"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ];
    }
    $form['additional_options']['hr2'] = [
      '#type' => 'markup',
      '#markup' => '<hr>',
    ];
    $form['additional_options']['phone'] = [
      '#prefix' => '<div class="container-inline">',
      '#type' => 'checkbox',
      '#suffix' => '<label>Phone</label></div>',
      '#default_value' => isset($config['phone_appear']) ? $config['phone_appear'] : FALSE,
    ];
    $form['additional_options']['phone_weight'] = [
      '#type' => 'weight',
      '#default_value' => isset($config['phone_weight']) ? $config['phone_weight'] : 0,
      '#states' => [
        'invisible' => [
          ':input[name="settings[additional_options][phone]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $options[0] = 'manual';
    if ($moduleHandler
      ->moduleExists('commerce_store')) {
      $sql = db_query("SELECT store_id, name FROM commerce_store_field_data")
        ->fetchAll();
      foreach ($sql as $stores) {
        $options[$stores->store_id] = $stores->name;
        $store = Store::load($stores->store_id);
      }
    }
    $form['additional_options']['phone_store'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Choose your store'),
      '#options' => $options,
      '#states' => [
        'invisible' => [
          ':input[name="settings[additional_options][phone]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
      '#default_value' => isset($config['phone_store']) ? $config['phone_store'] : 0,
    ];
    $form['additional_options']['phone_number'] = [
      '#title' => 'Phone number',
      '#type' => 'textfield',
      '#states' => [
        'visible' => [
          ':input[name="settings[additional_options][phone_store]"]' => [
            'value' => 0,
          ],
          ':input[name="settings[additional_options][phone]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#default_value' => isset($config['phone_number']) ? $config['phone_number'] : '',
    ];
    $form['additional_options']['hr3'] = [
      '#type' => 'markup',
      '#markup' => '<hr>',
    ];
    $form['menu_fieldset'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Check the menus you want to appear:'),
    ];
    foreach ($menu_names as $name) {
      $form['menu_fieldset'][$menu_ids[$name] . '_hr1'] = [
        '#type' => 'markup',
        '#markup' => '<hr>',
      ];

      // container used to display the elements inline
      $form['menu_fieldset'][$menu_ids[$name] . '_container'] = $container_inline;
      $form['menu_fieldset'][$menu_ids[$name] . '_container'][$menu_ids[$name] . '_checkbox'] = [
        '#type' => 'checkbox',
        '#default_value' => isset($config['menus_appear'][$menu_ids[$name]]) ? $config['menus_appear'][$menu_ids[$name]] : 0,
      ];
      $form['menu_fieldset'][$menu_ids[$name] . '_container'][$name] = [
        '#type' => 'markup',
        '#markup' => $this
          ->t($name),
      ];
      $form['menu_fieldset'][$menu_ids[$name] . '_weight'] = [
        '#type' => 'weight',
        '#default_value' => isset($config['menus_weight'][$menu_ids[$name]]) ? $config['menus_weight'][$menu_ids[$name]] : 0,
        '#states' => [
          'invisible' => [
            ':input[name="settings[menu_fieldset][' . $menu_ids[$name] . '_container][' . $menu_ids[$name] . '_checkbox]"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ];
      if (isset($config['menus_title'][$menu_ids[$name]]) && $config['menus_title'][$menu_ids[$name]] === FALSE) {
        $default_value = 0;
      }
      elseif (isset($config['menus_title'][$menu_ids[$name]]) && $config['menus_title'][$menu_ids[$name]] === TRUE) {
        $default_value = 1;
      }
      elseif (isset($config['menus_title'][$menu_ids[$name]])) {
        $default_value = 2;
      }
      else {
        $default_value = 0;
      }
      $form['menu_fieldset'][$menu_ids[$name] . '_title'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Choose title'),
        '#options' => [
          0 => 'Do not show',
          1 => 'Use default title',
          2 => 'Manual title',
        ],
        '#states' => [
          'invisible' => [
            ':input[name="settings[menu_fieldset][' . $menu_ids[$name] . '_container][' . $menu_ids[$name] . '_checkbox]"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
        '#default_value' => $default_value,
      ];
      $form['menu_fieldset'][$menu_ids[$name] . '_manual_title'] = [
        '#title' => 'Manual title',
        '#type' => 'textfield',
        '#states' => [
          'visible' => [
            ':input[name="settings[menu_fieldset][' . $menu_ids[$name] . '_title]"]' => [
              'value' => 2,
            ],
            ':input[name="settings[menu_fieldset][' . $menu_ids[$name] . '_container][' . $menu_ids[$name] . '_checkbox]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
        '#default_value' => $default_value == 2 ? $config['menus_title'][$menu_ids[$name]] : '',
      ];
      $form['menu_fieldset'][$menu_ids[$name] . '_hr2'] = [
        '#type' => 'markup',
        '#markup' => '<hr>',
      ];
    }
    $form['taxonomies'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Check the taxonomies you want to appear:'),
    ];
    foreach ($taxonomy_term_names as $name) {
      $form['taxonomies'][$taxonomy_term_ids[$name] . '_hr1'] = [
        '#type' => 'markup',
        '#markup' => '<hr>',
      ];
      $name = trim($name);
      $form['taxonomies'][$taxonomy_term_ids[$name] . '_container'] = $container_inline;
      $form['taxonomies'][$taxonomy_term_ids[$name] . '_container'][$taxonomy_term_ids[$name] . '_checkbox'] = [
        '#type' => 'checkbox',
        '#default_value' => isset($config['taxonomy_appear'][$taxonomy_term_ids[$name]]) ? $config['taxonomy_appear'][$taxonomy_term_ids[$name]] : 0,
      ];
      $form['taxonomies'][$taxonomy_term_ids[$name] . '_container'][$name] = [
        '#type' => 'markup',
        '#markup' => $this
          ->t($name),
      ];
      $form['taxonomies'][$taxonomy_term_ids[$name] . '_weight'] = [
        '#type' => 'weight',
        '#default_value' => isset($config['taxonomy_weight'][$taxonomy_term_ids[$name]]) ? $config['taxonomy_weight'][$taxonomy_term_ids[$name]] : 0,
        '#states' => [
          'invisible' => [
            ':input[name="settings[taxonomies][' . $taxonomy_term_ids[$name] . '_container][' . $taxonomy_term_ids[$name] . '_checkbox]"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ];
      if (isset($config['taxonomy_title'][$taxonomy_term_ids[$name]]) && $config['taxonomy_title'][$taxonomy_term_ids[$name]] === FALSE) {
        $default_value = 0;
      }
      elseif (isset($config['taxonomy_title'][$taxonomy_term_ids[$name]]) && $config['taxonomy_title'][$taxonomy_term_ids[$name]] === TRUE) {
        $default_value = 1;
      }
      elseif (isset($config['taxonomy_title'][$taxonomy_term_ids[$name]])) {
        $default_value = 2;
      }
      else {
        $default_value = 0;
      }
      $form['taxonomies'][$taxonomy_term_ids[$name] . '_title'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Choose title'),
        '#options' => [
          0 => 'Do not show',
          1 => 'Use default title',
          2 => 'Manual title',
        ],
        '#states' => [
          'invisible' => [
            ':input[name="settings[taxonomies][' . $taxonomy_term_ids[$name] . '_container][' . $taxonomy_term_ids[$name] . '_checkbox]"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
        '#default_value' => $default_value,
      ];
      $form['taxonomies'][$taxonomy_term_ids[$name] . '_manual_title'] = [
        '#title' => 'Manual title',
        '#type' => 'textfield',
        '#states' => [
          'visible' => [
            ':input[name="settings[taxonomies][' . $taxonomy_term_ids[$name] . '_title]"]' => [
              'value' => 2,
            ],
            ':input[name="settings[taxonomies][' . $taxonomy_term_ids[$name] . '_container][' . $taxonomy_term_ids[$name] . '_checkbox]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
        '#default_value' => $default_value == 2 ? $config['taxonomy_title'][$taxonomy_term_ids[$name]] : '',
      ];
      $form['taxonomies'][$taxonomy_term_ids[$name] . '_hr2'] = [
        '#type' => 'markup',
        '#markup' => '<hr>',
      ];
    }
    $breakpoints = $controller
      ->returnBreakpointsForDefaultTheme();
    if (!empty($breakpoints)) {
      $form['breakpoint_fielset_data'] = [
        '#type' => 'fieldset',
        '#title' => 'Enable breakpoints',
      ];
      $default_value_all = isset($config['breakpoint_all']) ? $config['breakpoint_all'] : TRUE;
      $default_value_all = $default_value_all == TRUE ? 0 : 1;
      $form['breakpoint_fielset_data']['all'] = [
        '#type' => 'select',
        '#options' => [
          0 => 'All',
          1 => 'Custom',
        ],
        '#default_value' => $default_value_all,
      ];
      $i = 0;
      foreach ($breakpoints as $name => $breakpoint) {
        if (strtolower($breakpoint['label']) != 'all') {
          if (isset($config['breakpoints'][$i]['name']) && $config['breakpoints'][$i]['name'] != FALSE) {
            $default_value = 1;
          }
          else {
            $default_value = 0;
          }
          $form['breakpoint_fielset_data']['breakpoint_checkbox_' . $name] = [
            '#type' => 'checkbox',
            '#title' => t($breakpoint['label']),
            '#default_value' => $default_value,
            '#states' => [
              'visible' => [
                ':input[name="settings[breakpoint_fielset_data][all]"]' => [
                  'value' => 1,
                ],
              ],
            ],
          ];
          $i++;
        }
      }
    }
    return $form;
  }

  /**
   *sends and store the block by collected data
   */
  public function blockSubmit($form, FormStateInterface $form_state) {

    /*
      The data used to collect all the information
      that used to be to display the block
    */
    parent::blockSubmit($form, $form_state);
    $values = $form_state
      ->getValues();
    $controller = new renderCheeseburgerMenuBlock();
    $menus = $controller
      ->getAllMenuLinkId();
    $taxonomies = $controller
      ->getAllTaxonomyTermIds();
    $breakpoints = $controller
      ->returnBreakpointsForDefaultTheme();
    $taxonomiesConf = [];
    $taxonomiesWeight = [];
    $taxonomyTitles = [];

    //getting menus which will be shown
    foreach ($menus as $id) {
      if ($values['menu_fieldset'][$id . '_container'][$id . '_checkbox'] == 1) {
        $menusConf[$id] = 1;
        $menusWeight[$id] = $values['menu_fieldset'][$id . '_weight'];
        $menusTitle = $values['menu_fieldset'][$id . '_title'];
        if ($menusTitle == 0) {
          $menusTitles[$id] = FALSE;
        }
        elseif ($menusTitle == 1) {
          $menusTitles[$id] = TRUE;
        }
        elseif ($menusTitle == 2) {
          $menusTitles[$id] = $values['menu_fieldset'][$id . '_manual_title'];
        }
      }
    }

    //getting taxonomies which will be shown
    foreach ($taxonomies as $id) {
      if ($values['taxonomies'][$id . '_container'][$id . '_checkbox'] == 1) {
        $taxonomiesConf[$id] = 1;
        $taxonomiesWeight[$id] = $values['taxonomies'][$id . '_weight'];
        $taxonomyTitle = $values['taxonomies'][$id . '_title'];
        if ($taxonomyTitle == 0) {
          $taxonomyTitles[$id] = FALSE;
        }
        elseif ($taxonomyTitle == 1) {
          $taxonomyTitles[$id] = TRUE;
        }
        elseif ($taxonomyTitle == 2) {
          $taxonomyTitles[$id] = $values['taxonomies'][$id . '_manual_title'];
        }
      }
    }
    $breakpointsConf = [];
    if ($values['breakpoint_fielset_data']['all'] == 1) {
      $this->configuration['breakpoint_all'] = FALSE;
      foreach ($breakpoints as $name => $breakpoint) {
        if (strtolower($breakpoint['label']) == 'all') {
          continue;
        }
        if ($values['breakpoint_fielset_data']['breakpoint_checkbox_' . $name] == 1) {
          $help_array = [];
          $help_array['name'] = $name;
          $help_array['mediaQuery'] = $breakpoint['mediaQuery'];
          $breakpointsConf[] = $help_array;
        }
        else {
          $help_array = [];
          $help_array['name'] = FALSE;
          $help_array['mediaQuery'] = $breakpoint['mediaQuery'];
          $breakpointsConf[] = $help_array;
        }
      }
    }
    else {
      $this->configuration['breakpoint_all'] = TRUE;
    }
    $this->configuration['menus_appear'] = $menusConf;
    $this->configuration['menus_weight'] = $menusWeight;
    $this->configuration['menus_title'] = $menusTitles;
    $this->configuration['taxonomy_appear'] = $taxonomiesConf;
    $this->configuration['taxonomy_weight'] = $taxonomiesWeight;
    $this->configuration['taxonomy_title'] = $taxonomyTitles;
    if (array_key_exists('cart', $values['additional_options'])) {
      $this->configuration['cart_appear'] = $values['additional_options']['cart'];
      $this->configuration['cart_weight'] = $values['additional_options']['cart_weight'];
    }
    $this->configuration['phone_appear'] = $values['additional_options']['phone'];
    $this->configuration['phone_weight'] = $values['additional_options']['phone_weight'];
    $this->configuration['phone_store'] = $values['additional_options']['phone_store'];
    $this->configuration['phone_number'] = $values['additional_options']['phone_number'];
    $this->configuration['lang_switcher'] = isset($values['lang_switcher_checkbox']) ? $values['lang_switcher_checkbox'] : FALSE;
    $this->configuration['lang_switcher_weight'] = isset($values['language_switcher_weight']) ? $values['language_switcher_weight'] : 0;

    /*$this->configuration['collapsible_menu'] = $values['additional_options']['collapsibleMenu'];
      $this->configuration['interactive_parent'] = $values['additional_options']['interactiveParentMenu'];*/
    $this->configuration['css_default'] = $values['css_default'];
    $this->configuration['headerHeight'] = $values['headerHeight'];
    $this->configuration['headerPadding'] = $values['headerPadding'];
    $this->configuration['breakpoints'] = $breakpointsConf;
  }

  /**
   *
   * @return complete block
   * the complete block stored in configuration's 'data' field
   *
   */
  public function build() {
    $config = $this
      ->getConfiguration();
    $headerHeight = isset($config['headerHeight']) ? $config['headerHeight'] : 0;
    $headerPadding = isset($config['headerPadding']) ? $config['headerPadding'] : 0;
    $showOnAll = isset($config['breakpoint_all']) ? $config['breakpoint_all'] : TRUE;
    $page_type = 'unknown';
    if ($route_id = \Drupal::routeMatch()
      ->getParameters()
      ->get('taxonomy_term') != NULL) {
      $route_id = \Drupal::routeMatch()
        ->getParameters()
        ->get('taxonomy_term')
        ->id();
      $page_type = 'taxonomy_term';
    }
    elseif (\Drupal::routeMatch()
      ->getParameters()
      ->get('node') != NULL) {
      $route_id = \Drupal::routeMatch()
        ->getParameters()
        ->get('node')
        ->id();
      $page_type = 'node';
    }
    elseif (\Drupal::routeMatch()
      ->getParameters()
      ->get('view_id') != NULL) {
      $route_id = 'view.' . \Drupal::routeMatch()
        ->getParameters()
        ->get('view_id');
      $page_type = 'view';
    }
    elseif (\Drupal::routeMatch()
      ->getParameters()
      ->get('user') != NULL) {
      $route_id = \Drupal::routeMatch()
        ->getParameters()
        ->get('user')
        ->id();
      $page_type = 'user';
    }
    elseif (\Drupal::routeMatch()
      ->getRouteName() != NULL) {
      $route_id = \Drupal::routeMatch()
        ->getRouteName();
      if (strpos($route_id, 'commerce_cart') !== FALSE) {
        $page_type = 'cart';
      }
    }
    else {
      $route_id = 0;
      $page_type = 'unknown';
    }
    $current_route = \Drupal\Core\Url::fromRoute('<current>');
    $current_route = $current_route
      ->toString();
    if ($showOnAll) {
      $controller = new renderCheeseburgerMenuBlock();
      $tree = $controller
        ->render_tree($route_id, $page_type, $current_route, $config);
      $tree['#attached']['drupalSettings'] = [
        'collapsibleMenu' => 1,
        'interactiveParentMenu' => 0,
        'headerHeight' => $headerHeight,
        'headerPadding' => $headerPadding,
        'instant_show' => TRUE,
      ];
      return $tree;
    }
    else {
      $tree = [];
      $tree[] = [
        '#markup' => '<div class="cheeseburger-menu__menus">',
      ];
      if ($config['css_default']) {
        $tree['#attached']['library'][] = 'cheeseburger_menu/cheeseburger_menu.css';
      }
      $breakpoints = $config['breakpoints'];
      foreach ($breakpoints as $key => $breakpoint) {
        if ($breakpoint['name'] != NULL && $key != 'All') {
          $breakpoints[$key]['mediaQuery'] = str_replace('min', 'max', $breakpoints[$key]['mediaQuery']);
        }
      }
      $tree['#attached'] = [
        'drupalSettings' => [
          'collapsibleMenu' => 1,
          'interactiveParentMenu' => 0,
          'headerHeight' => $headerHeight,
          'headerPadding' => $headerPadding,
          'route_id' => $route_id,
          'page_type' => $page_type,
          'current_route' => $current_route,
          'breakpoints' => $breakpoints,
          'block_id' => str_replace('_', '', $config['provider']),
          'instant_show' => FALSE,
        ],
      ];
      $tree[] = [
        '#markup' => '</div>',
      ];
      return $tree;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE		constant	Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration	protected	property	The transliteration service.
BlockPluginTrait::access	public	function
BlockPluginTrait::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess	protected	function	Indicates whether the block should be shown.	16
BlockPluginTrait::blockValidate	public	function		3
BlockPluginTrait::buildConfigurationForm	public	function	Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements.	2
BlockPluginTrait::calculateDependencies	public	function
BlockPluginTrait::defaultConfiguration	public	function		19
BlockPluginTrait::getConfiguration	public	function		1
BlockPluginTrait::getMachineNameSuggestion	public	function		1
BlockPluginTrait::getPreviewFallbackString	public	function		3
BlockPluginTrait::label	public	function
BlockPluginTrait::setConfiguration	public	function
BlockPluginTrait::setConfigurationValue	public	function
BlockPluginTrait::setTransliteration	public	function	Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm	public	function	Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration	protected	function	Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm	public	function	Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().	1
CheeseburgerMenu::$entityFieldManager	protected	property	The entity field manager.
CheeseburgerMenu::$entityTypeManager	protected	property	The entity type manager.
CheeseburgerMenu::blockForm	public	function	Overrides BlockPluginTrait::blockForm
CheeseburgerMenu::blockSubmit	public	function	sends and store the block by collected data Overrides BlockPluginTrait::blockSubmit
CheeseburgerMenu::build	public	function	Overrides BlockPluginInterface::build
CheeseburgerMenu::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CheeseburgerMenu::__construct	public	function	Overrides BlockPluginTrait::__construct
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
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.
PluginWithFormsTrait::getFormClass	public	function
PluginWithFormsTrait::hasFormClass	public	function
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class CheeseburgerMenu in Cheeseburger Menu 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation