abstract class GridStackSkinPluginBase in GridStack 8.2

Provides base class for all gridstack skins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\gridstack\GridStackPluginBase implements GridStackPluginInterface
      • class \Drupal\gridstack\GridStackSkinPluginBase implements GridStackSkinPluginInterface

2 files declare their use of GridStackSkinPluginBase

GridStackExampleSkin.php in modules/gridstack_example/src/Plugin/gridstack/GridStackExampleSkin.php

GridStackSkin.php in src/Plugin/gridstack/GridStackSkin.php

File

src/GridStackSkinPluginBase.php, line 10

Namespace

Drupal\gridstack

abstract class GridStackSkinPluginBase extends GridStackPluginBase implements GridStackSkinPluginInterface {

  /**
   * The gridstack skin definitions.
   *
   * @var array
   */
  protected $skins;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance->skins = $instance
      ->setSkins();
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function skins() {
    return $this->skins;
  }

  /**
   * Sets the required plugin skins.
   */
  protected abstract function setSkins();

}

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
GridStackPluginBase::$breakpoints	protected	property	The layout breakpoints.
GridStackPluginBase::$cellHeight	protected	property	The optionset cell height.
GridStackPluginBase::$columns	protected	property	The breakpoint columns.
GridStackPluginBase::$currentUser	protected	property	The current user.
GridStackPluginBase::$manager	protected	property	The gridstack manager service.
GridStackPluginBase::$minWidth	protected	property	The optionset min-width.
GridStackPluginBase::$optionset	protected	property	The gridstack optionset.
GridStackPluginBase::$verticalMargin	protected	property	The optionset vertical margin.
GridStackPluginBase::config	protected	function	Returns gridstack config shortcut.
GridStackPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	1
GridStackPluginBase::get	public	function
GridStackPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
GridStackPluginBase::getOptionset	public	function
GridStackPluginBase::getSetting	public	function
GridStackPluginBase::label	public	function	Returns the plugin label. Overrides GridStackPluginInterface::label
GridStackPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
GridStackPluginBase::setOptionset	public	function	Sets the optionset.
GridStackPluginBase::setSetting	public	function
GridStackSkinPluginBase::$skins	protected	property	The gridstack skin definitions.
GridStackSkinPluginBase::create	public static	function	Creates an instance of the plugin. Overrides GridStackPluginBase::create
GridStackSkinPluginBase::setSkins	abstract protected	function	Sets the required plugin skins.	2
GridStackSkinPluginBase::skins	public	function	Returns the GridStack skins. Overrides GridStackSkinPluginInterface::skins
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.