class GridStackEngineManager in GridStack 8.2

Implements GridStackEngineManagerInterface.

Hierarchy

class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
  - class \Drupal\gridstack\GridStackPluginManagerBase implements MapperInterface, GridStackPluginManagerInterface uses StringTranslationTrait
    class \Drupal\gridstack\GridStackEngineManager implements GridStackEngineManagerInterface

Expanded class hierarchy of GridStackEngineManager

1 string reference to 'GridStackEngineManager'

gridstack.services.yml in ./gridstack.services.yml: gridstack.services.yml

1 service uses GridStackEngineManager

gridstack.engine_manager in ./gridstack.services.yml: Drupal\gridstack\GridStackEngineManager

File

src/GridStackEngineManager.php, line 8

Namespace

Drupal\gridstack

View source

class GridStackEngineManager extends GridStackPluginManagerBase implements GridStackEngineManagerInterface {

  /**
   * {@inheritdoc}
   */
  protected static $path = 'Plugin/gridstack/engine';

  /**
   * {@inheritdoc}
   */
  protected static $interface = 'Drupal\\gridstack\\GridStackEnginePluginInterface';

  /**
   * {@inheritdoc}
   */
  protected static $annotation = 'Drupal\\gridstack\\Annotation\\GridStackEngine';

  /**
   * {@inheritdoc}
   */
  protected static $key = 'gridstack_engine';

  /**
   * The active CSS framework.
   *
   * @var array
   */
  protected $framework;

  /**
   * The gridstack layout CSS classes applicable to .row or .box__content.
   *
   * @var array
   */
  protected $classOptions;

  /**
   * Provides gridstack skins and libraries.
   */
  public function attach(array &$load, array $attach = []) {
    if (isset($attach['_engine']) && ($engine = $attach['_engine'])) {
      $this
        ->load($engine, $attach)
        ->attach($load, $attach);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function framework(array $configuration = []) {
    if (!isset($this->framework)) {
      if ($framework = $this
        ->config('framework')) {
        $this->framework = $this
          ->load($framework, $configuration);
      }
    }
    return $this->framework;
  }

  /**
   * Returns preset classes with the custom defined for .row or .box__content.
   */
  public function getClassOptions($type = 'generic') {
    if (!isset($this->classOptions[$type])) {
      if ($this
        ->framework()) {
        $this->classOptions[$type] = $type == 'row' ? $this
          ->framework()
          ->rowClassOptions() : $this
          ->framework()
          ->classOptions();
      }
    }
    return $this->classOptions[$type];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultPluginManager::$additionalAnnotationNamespaces	protected	property	Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook	protected	property	Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey	protected	property	The cache key.
DefaultPluginManager::$cacheTags	protected	property	An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults	protected	property	A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes.	9
DefaultPluginManager::$moduleHandler	protected	property	The module handler to invoke the alter hook.	1
DefaultPluginManager::$namespaces	protected	property	An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName	protected	property	The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface	protected	property	The interface each plugin should implement.	1
DefaultPluginManager::$subdir	protected	property	The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions	protected	function	Invokes the hook to alter the definitions if the alter hook is set.	1
DefaultPluginManager::alterInfo	protected	function	Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions	5
DefaultPluginManager::extractProviderFromDefinition	protected	function	Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions	protected	function	Finds plugin definitions.	7
DefaultPluginManager::fixContextAwareDefinitions	private	function	Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions	protected	function	Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions	public	function	Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions	2
DefaultPluginManager::getDiscovery	protected	function	Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery	12
DefaultPluginManager::getFactory	protected	function	Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition	public	function	Performs extra processing on plugin definitions.	13
DefaultPluginManager::providerExists	protected	function	Determines if the provider of a definition exists.	3
DefaultPluginManager::setCacheBackend	public	function	Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions	protected	function	Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches	public	function	Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches	1
DiscoveryCachedTrait::$definitions	protected	property	Cached definitions array.	1
DiscoveryCachedTrait::getDefinition	public	function	Overrides DiscoveryTrait::getDefinition	3
DiscoveryTrait::doGetDefinition	protected	function	Gets a specific plugin definition.
DiscoveryTrait::hasDefinition	public	function
GridStackEngineManager::$annotation	protected static	property	The plugin annotation. Overrides GridStackPluginManagerBase::$annotation
GridStackEngineManager::$classOptions	protected	property	The gridstack layout CSS classes applicable to .row or .box__content.
GridStackEngineManager::$framework	protected	property	The active CSS framework.
GridStackEngineManager::$interface	protected static	property	The plugin interface. Overrides GridStackPluginManagerBase::$interface
GridStackEngineManager::$key	protected static	property	The plugin key. Overrides GridStackPluginManagerBase::$key
GridStackEngineManager::$path	protected static	property	The plugin path. Overrides GridStackPluginManagerBase::$path
GridStackEngineManager::attach	public	function	Provides gridstack skins and libraries.
GridStackEngineManager::framework	public	function
GridStackEngineManager::getClassOptions	public	function	Returns preset classes with the custom defined for .row or .box__content.
GridStackPluginManagerBase::$attachments	protected	property	The plugin attachments.
GridStackPluginManagerBase::$config	protected	property	The config factory.
GridStackPluginManagerBase::$implementors	protected	property	The implementors of a method.
GridStackPluginManagerBase::config	public	function	Returns gridstack config shortcut.
GridStackPluginManagerBase::getCache	public	function	Returns cache backend service.
GridStackPluginManagerBase::getData	protected	function	Returns gridstack plugin data.
GridStackPluginManagerBase::getDataOptions	public	function	Returns available data for select options.
GridStackPluginManagerBase::getImplementors	protected	function	Returns plugins names implementing a method.
GridStackPluginManagerBase::load	public	function	Returns an instance of a plugin given a plugin id. Overrides GridStackPluginManagerInterface::load
GridStackPluginManagerBase::loadMultiple	public	function	Returns all available plugins.
GridStackPluginManagerBase::setAttachments	protected	function	Collects attachments from plugins.
GridStackPluginManagerBase::__construct	public	function	Creates the discovery object. Overrides DefaultPluginManager::__construct
PluginManagerBase::$discovery	protected	property	The object that discovers plugins managed by this manager.
PluginManagerBase::$factory	protected	property	The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper	protected	property	The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::createInstance	public	function	Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance	12
PluginManagerBase::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance	7
PluginManagerBase::handlePluginNotFound	protected	function	Allows plugin managers to specify custom behavior if a plugin is not found.	1
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.
UseCacheBackendTrait::$cacheBackend	protected	property	Cache backend instance.
UseCacheBackendTrait::$useCaches	protected	property	Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet	protected	function	Fetches from the cache backend, respecting the use caches flag.	1
UseCacheBackendTrait::cacheSet	protected	function	Stores data in the persistent cache, respecting the use caches flag.

You are here

class GridStackEngineManager in GridStack 8.2

Hierarchy

File

Namespace

Members

API Navigation