abstract class ChainConditionBase in Access Filter 8

Base class for condition plugins that chains other conditions.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\access_filter\Plugin\AccessFilter\Condition\ConditionBase implements ConditionInterface, ContainerFactoryPluginInterface
      • class \Drupal\access_filter\Plugin\AccessFilter\Condition\ChainConditionBase

File

src/Plugin/AccessFilter/Condition/ChainConditionBase.php, line 11

Namespace

Drupal\access_filter\Plugin\AccessFilter\Condition

abstract class ChainConditionBase extends ConditionBase {

  /**
   * The access filter condition plugin manager.
   *
   * @var \Drupal\access_filter\Plugin\AccessFilterPluginManagerInterface
   */
  protected $conditionPluginManager;

  /**
   * Creates a new PathCondition object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\access_filter\Plugin\AccessFilterPluginManagerInterface $condition_plugin_manager
   *   The access filter condition plugin manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, AccessFilterPluginManagerInterface $condition_plugin_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->conditionPluginManager = $condition_plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.access_filter.condition'));
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {
    $summary = '<ul>';
    foreach ($this->configuration['conditions'] as $condition) {
      $instance = $this
        ->createPluginInstance($condition);
      if ($instance) {
        $summary .= '<li>' . $instance
          ->getPluginId() . ': ' . $instance
          ->summary() . '</li>';
      }
    }
    $summary .= '</ul>';
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfiguration(array $configuration) {
    $errors = [];
    foreach ($configuration['conditions'] as $condition) {
      $instance = $this
        ->createPluginInstance($condition);
      if ($instance) {
        $errors = array_merge($errors, $instance
          ->validateConfiguration($condition));
      }
      else {
        $errors[] = $this
          ->t("Condition type '@type' does not exist.", [
          '@type' => $condition['type'],
        ]);
      }
    }
    return $errors;
  }

  /**
   * Creates plugin instance.
   *
   * @param array $condition
   *   The array containing condition data.
   *
   * @return \Drupal\access_filter\Plugin\ConditionInterface|bool
   *   Plugin instance or FALSE if failed.
   */
  protected function createPluginInstance(array $condition) {
    $plugins = $this->conditionPluginManager
      ->getDefinitions();
    $plugin_id = $condition['type'];
    if (isset($plugins[$plugin_id])) {
      return $this->conditionPluginManager
        ->createInstance($plugin_id, $condition);
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChainConditionBase::$conditionPluginManager	protected	property	The access filter condition plugin manager.
ChainConditionBase::create	public static	function	Creates an instance of the plugin. Overrides ConditionBase::create
ChainConditionBase::createPluginInstance	protected	function	Creates plugin instance.
ChainConditionBase::summary	public	function	Gets summary text for the condition. Overrides ConditionInterface::summary
ChainConditionBase::validateConfiguration	public	function	Validates configuration data. Overrides ConditionInterface::validateConfiguration
ChainConditionBase::__construct	public	function	Creates a new PathCondition object. Overrides PluginBase::__construct
ConditionBase::isNegated	public	function	Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
ConditionInterface::isMatched	public	function	Checks the current access is matched to the condition.	7
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
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.
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.