class MessagePurgePluginManager in Message 8

Plugin type manager for MessagePurge plugins.

Hierarchy

class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
  - class \Drupal\message\MessagePurgePluginManager uses StringTranslationTrait

Expanded class hierarchy of MessagePurgePluginManager

2 files declare their use of MessagePurgePluginManager

MessageSettingsForm.php in src/Form/MessageSettingsForm.php
MessageTemplateForm.php in src/Form/MessageTemplateForm.php

1 string reference to 'MessagePurgePluginManager'

message.services.yml in ./message.services.yml: message.services.yml

1 service uses MessagePurgePluginManager

plugin.manager.message.purge in ./message.services.yml: Drupal\message\MessagePurgePluginManager

File

src/MessagePurgePluginManager.php, line 14

Namespace

Drupal\message

View source

class MessagePurgePluginManager extends DefaultPluginManager {
  use StringTranslationTrait;

  /**
   * Constructs an MessagePurgePluginManager 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 to invoke the alter hook with.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/MessagePurge', $namespaces, $module_handler, 'Drupal\\message\\MessagePurgeInterface', 'Drupal\\message\\Annotation\\MessagePurge');
    $this
      ->setCacheBackend($cache_backend, 'message_purge');
    $this
      ->alterInfo('message_purge');
  }

  /**
   * Construct the purge method form.
   *
   * This can be used on either the message template form, or the global
   * message settings form.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   * @param array $purge_settings
   *   The default purge plugin settings to use.
   */
  public function purgeSettingsForm(array &$form, FormStateInterface $form_state, array $purge_settings) {

    // Loop through all purge plugins and add to form.
    $form['settings']['purge_methods'] = [
      '#type' => 'table',
      '#states' => [
        'visible' => [
          // Configure visibility for both the template form and the global
          // settings form.
          [
            [
              ':input[name="settings[purge_override]"]' => [
                'checked' => TRUE,
              ],
            ],
            'or',
            [
              ':input[name="settings[purge_enable]"]' => [
                'checked' => TRUE,
              ],
            ],
          ],
        ],
      ],
      '#theme_wrappers' => [
        'form_element',
      ],
      '#header' => [
        $this
          ->t('Purge method'),
        $this
          ->t('Weight'),
        $this
          ->t('Enabled'),
        $this
          ->t('Settings'),
      ],
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'message-purge-order-weight',
        ],
      ],
    ];
    $user_input = $form_state
      ->getUserInput();
    $definitions = $this
      ->getDefinitions();
    $this
      ->sortDefinitions($definitions, $purge_settings);
    foreach ($definitions as $plugin_id => $definition) {

      /** @var \Drupal\message\MessagePurgeInterface $plugin */
      $plugin = $this
        ->createInstance($plugin_id, isset($purge_settings[$plugin_id]) ? $purge_settings[$plugin_id] : []);

      // Create the table row.
      $form['settings']['purge_methods'][$plugin_id]['#attributes']['class'][] = 'draggable';
      $form['settings']['purge_methods'][$plugin_id]['#weight'] = isset($user_input['settings']['purge_methods']) ? $user_input['settings']['purge_methods'][$plugin_id]['weight'] : $plugin
        ->getWeight();
      $form['settings']['purge_methods'][$plugin_id]['plugin'] = [
        '#tree' => FALSE,
        'data' => [
          'label' => [
            '#plain_text' => $plugin
              ->label(),
          ],
        ],
      ];

      // Purge weight.
      $form['settings']['purge_methods'][$plugin_id]['weight'] = [
        '#type' => 'weight',
        '#title' => $this
          ->t('Weight for @title', [
          '@title' => $plugin
            ->label(),
        ]),
        '#title_display' => 'invisible',
        '#default_value' => $plugin
          ->getWeight(),
        '#attributes' => [
          'class' => [
            'message-purge-order-weight',
          ],
        ],
      ];

      // Plugin enabled.
      $form['settings']['purge_methods'][$plugin_id]['enabled'] = [
        '#type' => 'checkbox',
        '#title' => $plugin
          ->description(),
        '#default_value' => isset($purge_settings[$plugin_id]),
      ];

      // Purge plugin-specific settings.
      $element = [];
      $form['settings']['purge_methods'][$plugin_id]['data'] = $plugin
        ->buildConfigurationForm($element, $form_state);
    }
  }

  /**
   * Gather the purge plugin settings on form submission.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return array
   *   The purge plugin configurations that are enabled, keyed by plugin ID.
   */
  public function getPurgeConfiguration(array $form, FormStateInterface $form_state) {
    $purge_plugins = [];
    foreach ($form_state
      ->getValue([
      'settings',
      'purge_methods',
    ]) as $plugin_id => $configuration) {
      if ($configuration['enabled']) {

        /** @var \Drupal\message\MessagePurgeInterface $plugin */
        $plugin = $this
          ->createInstance($plugin_id, $configuration);
        $plugin
          ->submitConfigurationForm($form, $form_state);
        $purge_plugins[$plugin_id] = $plugin
          ->getConfiguration();
      }
    }
    return $purge_plugins;
  }

  /**
   * Sort plugin definitions based on plugin settings.
   */
  protected function sortDefinitions(array &$definitions, array $settings) {
    uasort($definitions, function ($a, $b) use ($settings) {
      $weight_a = isset($settings[$a['id']]) ? $settings[$a['id']]['weight'] : 0;
      $weight_b = isset($settings[$b['id']]) ? $settings[$b['id']]['weight'] : 0;
      if ($weight_a == $weight_b) {
        return 0;
      }
      return $weight_a < $weight_b ? -1 : 1;
    });
  }

}

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
MessagePurgePluginManager::getPurgeConfiguration	public	function	Gather the purge plugin settings on form submission.
MessagePurgePluginManager::purgeSettingsForm	public	function	Construct the purge method form.
MessagePurgePluginManager::sortDefinitions	protected	function	Sort plugin definitions based on plugin settings.
MessagePurgePluginManager::__construct	public	function	Constructs an MessagePurgePluginManager 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 MessagePurgePluginManager in Message 8

Hierarchy

File

Namespace

Members

API Navigation