You are here

Home » API reference » Entity Legal 8 » AcceptanceMethodPluginManager.php

class AcceptanceMethodPluginManager in Entity Legal 8

Plugin type manager for acceptance methods.

Hierarchy

Expanded class hierarchy of AcceptanceMethodPluginManager

1 string reference to 'AcceptanceMethodPluginManager'
entity_legal.services.yml in ./entity_legal.services.yml
entity_legal.services.yml
1 service uses AcceptanceMethodPluginManager
plugin.manager.entity_legal.acceptance_method in ./entity_legal.services.yml
Drupal\entity_legal\Plugin\AcceptanceMethodPluginManager

File

src/Plugin/AcceptanceMethodPluginManager.php, line 18
Contains \Drupal\entity_legal\Plugin\AcceptanceMethodPluginManager.

Namespace

Drupal\entity_legal\Plugin
View source 
class AcceptanceMethodPluginManager extends DefaultPluginManager {

  /**
   * An array of formatter options for each field type.
   *
   * @var array
   */
  protected $formatterOptions;

  /**
   * The field type manager to define field.
   *
   * @var \Drupal\Core\Field\FieldTypePluginManagerInterface
   */
  protected $fieldTypeManager;

  /**
   * Constructs a FormatterPluginManager object.
   *
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
   *   The 'field type' plugin manager.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/EntityLegal/AcceptanceMethod', $namespaces, $module_handler, 'Drupal\\entity_legal\\AcceptanceMethod\\AcceptanceMethodInterface', 'Drupal\\entity_legal\\Annotation\\AcceptanceMethod');
    $this
      ->setCacheBackend($cache_backend, 'entity_legal_acceptance_method_plugins');

    //    $this->alterInfo('field_formatter_info');
    //    $this->fieldTypeManager = $field_type_manager;
  }

  /**
   * Get plugins only related to new users.
   *
   * @return array
   */
  public function getNewUserPlugins() {
    $new_user_plugins = array();
    $definitions = $this
      ->getDefinitions();
    foreach ($definitions as $plugin_name => $plugin_definition) {
      if (!empty($plugin_definition['new_users'])) {
        $new_user_plugins[$plugin_name] = $plugin_definition;
      }
    }
    return $new_user_plugins;
  }

  /**
   * Get new user plugin option list.
   *
   * @return array
   */
  public function getNewUserPluginOptions() {
    $new_user_plugins = $this
      ->getNewUserPlugins();
    return $this
      ->getPluginsListAsOptions($new_user_plugins);
  }

  /**
   * {@inheritdoc}
   */
  public function getExistingUserPlugins() {
    $existing_user_plugins = array();
    $definitions = $this
      ->getDefinitions();
    foreach ($definitions as $plugin_name => $plugin_definition) {
      if (!empty($plugin_definition['existing_users'])) {
        $existing_user_plugins[$plugin_name] = $plugin_definition;
      }
    }
    return $existing_user_plugins;
  }

  /**
   * Get existing user plugin option list.
   *
   * @return array
   */
  public function getExistingUserPluginOptions() {
    $existing_user_plugins = $this
      ->getExistingUserPlugins();
    return $this
      ->getPluginsListAsOptions($existing_user_plugins);
  }

  /**
   * Get plugin definition list as options usable in Form API.
   *
   * @param array $plugin_definition_list
   *   The plugin definition list to convert.
   *
   * @return array
   *   The plugin options keyed by ID and labeled using label.
   */
  protected function getPluginsListAsOptions(array $plugin_definition_list) {
    $plugin_options = array();
    foreach ($plugin_definition_list as $plugin_definition) {
      $plugin_options[$plugin_definition['id']] = $plugin_definition['label']
        ->render();
    }
    return $plugin_options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AcceptanceMethodPluginManager::$fieldTypeManager protected property The field type manager to define field.
AcceptanceMethodPluginManager::$formatterOptions protected property An array of formatter options for each field type.
AcceptanceMethodPluginManager::getExistingUserPluginOptions public function Get existing user plugin option list.
AcceptanceMethodPluginManager::getExistingUserPlugins public function
AcceptanceMethodPluginManager::getNewUserPluginOptions public function Get new user plugin option list.
AcceptanceMethodPluginManager::getNewUserPlugins public function Get plugins only related to new users.
AcceptanceMethodPluginManager::getPluginsListAsOptions protected function Get plugin definition list as options usable in Form API.
AcceptanceMethodPluginManager::__construct public function Constructs a FormatterPluginManager object. Overrides DefaultPluginManager::__construct
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
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
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.