You are here

abstract class GridStackPluginBase in GridStack 8.2

Provides base class for all gridstack plugins.

Hierarchy

Expanded class hierarchy of GridStackPluginBase

File

src/GridStackPluginBase.php, line 13

Namespace

Drupal\gridstack
View source
abstract class GridStackPluginBase extends PluginBase implements GridStackPluginInterface {

  /**
   * The gridstack optionset.
   *
   * @var \Drupal\gridstack\Entity\GridStack
   */
  protected $optionset;

  /**
   * The layout breakpoints.
   *
   * @var array
   */
  protected $breakpoints = [];

  /**
   * The breakpoint columns.
   *
   * @var array
   */
  protected $columns = [];

  /**
   * The optionset min-width.
   *
   * @var int
   */
  protected $minWidth;

  /**
   * The optionset cell height.
   *
   * @var int
   */
  protected $cellHeight;

  /**
   * The optionset vertical margin.
   *
   * @var int
   */
  protected $verticalMargin;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The gridstack manager service.
   *
   * @var \Drupal\gridstack\GridStackManagerInterface
   */
  protected $manager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = new static($configuration, $plugin_id, $plugin_definition);
    $instance
      ->setConfiguration($configuration);
    if (!empty($configuration['optionset'])) {
      $instance
        ->setOptionset($configuration['optionset']);
    }
    $instance->currentUser = $container
      ->get('current_user');
    $instance->manager = $container
      ->get('gridstack.manager');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return $this->pluginDefinition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function get($key) {
    return isset($this->pluginDefinition[$key]) ? $this->pluginDefinition[$key] : NULL;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $this->configuration + $this
      ->defaultConfiguration();
    $this->configuration = NestedArray::mergeDeep($this->configuration, $configuration);
    return $this;
  }

  /**
   * Returns gridstack config shortcut.
   */
  protected function config($key = '', $settings = 'gridstack.settings') {
    return $this->manager
      ->configLoad($key, $settings);
  }

  /**
   * {@inheritdoc}
   */
  public function getSetting($key, $default = NULL) {
    return isset($this->configuration[$key]) ? $this->configuration[$key] : $default;
  }

  /**
   * {@inheritdoc}
   */
  public function setSetting($key, $value) {
    $this->configuration[$key] = $value;
    return $this;
  }

  /**
   * Sets the optionset.
   */
  public function setOptionset($optionset) {
    $this->optionset = is_string($optionset) ? GridStack::loadWithFallback($optionset) : $optionset;
    $this->breakpoints = $this->optionset
      ->breakpointsToArray();
    $this->columns = $this->optionset
      ->getColumns();
    $this->minWidth = (int) $this->optionset
      ->getSetting('minWidth', 481);
    $this->cellHeight = $this->optionset
      ->getSetting('cellHeight', 80);
    $this->verticalMargin = $this->optionset
      ->getSetting('verticalMargin', 0);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getOptionset() {
    if (!isset($this->optionset)) {
      $this->optionset = GridStack::loadWithFallback($this
        ->getSetting('optionset', 'default'));
    }
    return $this->optionset;
  }

}

Members

Namesort descending 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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 3
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
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.