class MeanMenu in Responsive Menus 8

Defines the "mean_menu" plugin.

Plugin annotation


@ResponsiveMenus(
  id = "mean_menu",
  label = @Translation("Mean Menu"),
  library = "responsive_menus/mean_menu"
)

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\responsive_menus\ResponsiveMenusPluginBase implements ResponsiveMenusPluginInterface
    class \Drupal\responsive_menus\Plugin\ResponsiveMenus\MeanMenu implements ResponsiveMenusPluginInterface

Expanded class hierarchy of MeanMenu

File

src/Plugin/ResponsiveMenus/MeanMenu.php, line 18

Namespace

Drupal\responsive_menus\Plugin\ResponsiveMenus

View source

class MeanMenu extends ResponsiveMenusPluginBase implements ResponsiveMenusPluginInterface {

  /**
   * {@inheritdoc}
   */
  public static function getSelectorInfo() {
    return t('Parent of the @ul.  Example: Given <code>@code</code> you would use @use', [
      '@ul' => '<ul>',
      '@code' => '<div id="parent-div"> <ul class="menu"> </ul> </div>',
      '@use' => '<strong>#parent-div</strong>',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'responsive_menus_mean_menu_css_selectors' => '#main-menu',
      'responsive_menus_mean_menu_container' => 'body',
      'responsive_menus_mean_menu_trigger_txt' => '<span /><span /><span />',
      'responsive_menus_mean_menu_close_txt' => 'X',
      'responsive_menus_mean_menu_close_size' => '18px',
      'responsive_menus_mean_menu_position' => 'right',
      'responsive_menus_mean_menu_media_size' => 480,
      'responsive_menus_mean_menu_show_children' => 1,
      'responsive_menus_mean_menu_expand_children' => 1,
      'responsive_menus_mean_menu_expand_txt' => '+',
      'responsive_menus_mean_menu_contract_txt' => '-',
      'responsive_menus_mean_menu_remove_attrs' => 1,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form['responsive_menus_mean_menu_css_selectors'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('CSS selectors for which menu to responsify'),
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_css_selectors'),
      '#description' => $this
        ->t('Enter CSS/jQuery selector of menus to responsify.'),
    ];
    $form['responsive_menus_mean_menu_container'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('CSS selector for where to attach the menu on the page'),
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_container'),
      '#description' => $this
        ->t('Enter CSS/jQuery selector of where MeanMenu gets attached.'),
    ];
    $form['responsive_menus_mean_menu_trigger_txt'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Text or HTML for trigger button'),
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_trigger_txt'),
      '#description' => $this
        ->t('Default of 3 spans will show the triple bars (!bars).', [
        '!bars' => '☰',
      ]),
    ];
    $form['responsive_menus_mean_menu_close_txt'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Text or HTML for close button'),
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_close_txt'),
    ];
    $form['responsive_menus_mean_menu_close_size'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Size of close button'),
      '#size' => 5,
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_close_size'),
      '#description' => $this
        ->t('Size in px, em, %'),
    ];
    $form['responsive_menus_mean_menu_position'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Position of the open/close buttons'),
      '#options' => [
        'right' => $this
          ->t('right'),
        'left' => $this
          ->t('left'),
        'center' => $this
          ->t('center'),
      ],
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_position'),
    ];
    $form['responsive_menus_mean_menu_media_size'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Screen width to respond to'),
      '#size' => 5,
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_media_size'),
      '#description' => $this
        ->t('Width in pixels when we swap out responsive menu e.g. 768'),
    ];
    $form['responsive_menus_mean_menu_show_children'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Allow multi-level menus'),
      '#options' => [
        1 => $this
          ->t('Yes'),
        0 => $this
          ->t('No'),
      ],
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_show_children'),
    ];
    $form['responsive_menus_mean_menu_expand_children'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Ability to expand & collapse children'),
      '#options' => [
        1 => $this
          ->t('Yes'),
        0 => $this
          ->t('No'),
      ],
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_expand_children'),
    ];
    $form['responsive_menus_mean_menu_expand_txt'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Text for the expand children button'),
      '#size' => 5,
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_expand_txt'),
    ];
    $form['responsive_menus_mean_menu_contract_txt'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Text for the collapse children button'),
      '#size' => 5,
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_contract_txt'),
    ];
    $form['responsive_menus_mean_menu_remove_attrs'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Temporarily remove other classes & IDs (Recommended)'),
      '#options' => [
        1 => $this
          ->t('Yes'),
        0 => $this
          ->t('No'),
      ],
      '#default_value' => $this
        ->getSetting('responsive_menus_mean_menu_remove_attrs'),
      '#description' => $this
        ->t('This will help ensure the style of Mean Menus.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getJsSettings() {
    $js_settings = [
      'selectors' => $this
        ->getSetting('responsive_menus_mean_menu_css_selectors'),
      'container' => $this
        ->getSetting('responsive_menus_mean_menu_container'),
      'trigger_txt' => $this
        ->getSetting('responsive_menus_mean_menu_trigger_txt'),
      'close_txt' => $this
        ->getSetting('responsive_menus_mean_menu_close_txt'),
      'close_size' => $this
        ->getSetting('responsive_menus_mean_menu_close_size'),
      'position' => $this
        ->getSetting('responsive_menus_mean_menu_position'),
      'media_size' => $this
        ->getSetting('responsive_menus_mean_menu_media_size'),
      'show_children' => $this
        ->getSetting('responsive_menus_mean_menu_show_children'),
      'expand_children' => $this
        ->getSetting('responsive_menus_mean_menu_expand_children'),
      'expand_txt' => $this
        ->getSetting('responsive_menus_mean_menu_expand_txt'),
      'contract_txt' => $this
        ->getSetting('responsive_menus_mean_menu_contract_txt'),
      'remove_attrs' => $this
        ->getSetting('responsive_menus_mean_menu_remove_attrs'),
    ];
    return $js_settings;
  }

  /**
   * Gets this plugin's configuration.
   *
   * @return array
   *   An array of this plugin's configuration.
   */
  public function getConfiguration() {

    // TODO: Implement getConfiguration() method.
  }

  /**
   * Sets the configuration for this plugin instance.
   *
   * @param array $configuration
   *   An associative array containing the plugin's configuration.
   */
  public function setConfiguration(array $configuration) {

    // TODO: Implement setConfiguration() method.
  }

  /**
   * Gets default configuration for this plugin.
   *
   * @return array
   *   An associative array with the default configuration.
   */
  public function defaultConfiguration() {

    // TODO: Implement defaultConfiguration() method.
  }

}

Members

Name	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
MeanMenu::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
MeanMenu::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
MeanMenu::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
MeanMenu::getJsSettings	public	function	Get Drupal Javscript settings array. Overrides ResponsiveMenusPluginBase::getJsSettings
MeanMenu::getSelectorInfo	public static	function	Provide UI with plugins selector information. Overrides ResponsiveMenusPluginBase::getSelectorInfo
MeanMenu::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MeanMenu::settingsForm	public	function	Form constructor. Overrides ResponsiveMenusPluginBase::settingsForm
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::$settings	protected	property	The plugin settings.	2
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
ResponsiveMenusPluginBase::getSettingArray	protected	function	Return array of selectors for JS settings.
ResponsiveMenusPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.

You are here

class MeanMenu in Responsive Menus 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation