You are here

Home » API reference » Responsive Menus 8 » ResponsiveMenusPluginBase.php

abstract class ResponsiveMenusPluginBase in Responsive Menus 8

Class ResponsiveMenusPluginBase.

@package Drupal\responsive_menus

Hierarchy

Expanded class hierarchy of ResponsiveMenusPluginBase

6 files declare their use of ResponsiveMenusPluginBase
CodropsGoogleNexus.php in src/Plugin/ResponsiveMenus/CodropsGoogleNexus.php
CodropsResponsiveMulti.php in src/Plugin/ResponsiveMenus/CodropsResponsiveMulti.php
MeanMenu.php in src/Plugin/ResponsiveMenus/MeanMenu.php
MultiLevelPushMenu.php in src/Plugin/ResponsiveMenus/MultiLevelPushMenu.php
ResponsiveMenusSimple.php in src/Plugin/ResponsiveMenus/ResponsiveMenusSimple.php

... See full list

File

src/ResponsiveMenusPluginBase.php, line 13

Namespace

Drupal\responsive_menus
View source 
abstract class ResponsiveMenusPluginBase extends PluginSettingsBase implements ResponsiveMenusPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->settings = $configuration['settings'];
  }

  /**
   * {@inheritdoc}
   */
  public static function getSelectorInfo() {
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getJsSettings() {
    return [];
  }

  /**
   * Return array of selectors for JS settings.
   *
   * @params string $name
   *   The settings name.
   *
   * @return array
   *   Array of settings to pass with drupal_add_js().
   */
  protected function getSettingArray($name) {
    $selectors = $this
      ->getSetting($name);
    $delimiter = ', ';

    // Strip out carriage returns.
    $selectors = str_replace("\r", '', $selectors);

    // Replace new lines with delimiter.
    $selectors = str_replace("\n", $delimiter, $selectors);

    // Explode to include original delimited.
    $values = explode($delimiter, $selectors);
    $values = array_filter($values);
    return $values;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 11
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 12
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 12
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::$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::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
ResponsiveMenusPluginBase::getJsSettings public function Get Drupal Javscript settings array. Overrides ResponsiveMenusPluginInterface::getJsSettings 6
ResponsiveMenusPluginBase::getSelectorInfo public static function Provide UI with plugins selector information. Overrides ResponsiveMenusPluginInterface::getSelectorInfo 6
ResponsiveMenusPluginBase::getSettingArray protected function Return array of selectors for JS settings.
ResponsiveMenusPluginBase::settingsForm public function Form constructor. Overrides ResponsiveMenusPluginInterface::settingsForm 6
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.