1. 8.2.x core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php Condition
  2. 8.2.x core/lib/Drupal/Core/Database/Query/Condition.php Condition
  3. 8.2.x core/lib/Drupal/Core/Entity/Query/Sql/Condition.php Condition
  4. 8.2.x core/lib/Drupal/Core/Entity/Query/Null/Condition.php Condition
  5. 8.2.x core/lib/Drupal/Core/Config/Entity/Query/Condition.php Condition
  6. 8.2.x core/lib/Drupal/Core/Condition/Annotation/Condition.php Condition
  7. 8.2.x core/lib/Drupal/Core/Entity/Query/Sql/pgsql/Condition.php Condition
  8. 8.0.x core/lib/Drupal/Core/Config/Entity/Query/Condition.php Condition
  9. 8.0.x core/lib/Drupal/Core/Database/Query/Condition.php Condition
  10. 8.0.x core/lib/Drupal/Core/Entity/Query/Sql/pgsql/Condition.php Condition
  11. 8.0.x core/lib/Drupal/Core/Condition/Annotation/Condition.php Condition
  12. 8.0.x core/lib/Drupal/Core/Entity/Query/Sql/Condition.php Condition
  13. 8.0.x core/lib/Drupal/Core/Entity/Query/Null/Condition.php Condition
  14. 8.0.x core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php Condition
  15. 8.1.x core/lib/Drupal/Core/Entity/Query/Null/Condition.php Condition
  16. 8.1.x core/lib/Drupal/Core/Entity/Query/Sql/pgsql/Condition.php Condition
  17. 8.1.x core/lib/Drupal/Core/Config/Entity/Query/Condition.php Condition
  18. 8.1.x core/lib/Drupal/Core/Entity/Query/Sql/Condition.php Condition
  19. 8.1.x core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php Condition
  20. 8.1.x core/lib/Drupal/Core/Condition/Annotation/Condition.php Condition
  21. 8.1.x core/lib/Drupal/Core/Database/Query/Condition.php Condition
  22. 8.3.x core/lib/Drupal/Core/Entity/Query/Sql/Condition.php Condition
  23. 8.3.x core/lib/Drupal/Core/Entity/Query/Sql/pgsql/Condition.php Condition
  24. 8.3.x core/lib/Drupal/Core/Entity/Query/Null/Condition.php Condition
  25. 8.3.x core/lib/Drupal/Core/Database/Query/Condition.php Condition
  26. 8.3.x core/lib/Drupal/Core/Condition/Annotation/Condition.php Condition
  27. 8.3.x core/lib/Drupal/Core/Config/Entity/Query/Condition.php Condition
  28. 8.3.x core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php Condition

Defines a condition plugin annotation object.

Condition plugins provide generalized conditions for use in other operations, such as conditional block placement.

Plugin Namespace: Plugin\Condition

For a working example, see \Drupal\user\Plugin\Condition\UserRole.

Hierarchy

Expanded class hierarchy of Condition

See also

\Drupal\Core\Condition\ConditionManager

\Drupal\Core\Condition\ConditionInterface

\Drupal\Core\Condition\ConditionPluginBase

Block API

Related topics

3 string references to 'Condition'
ConditionAggregate::compile in core/lib/Drupal/Core/Entity/Query/Sql/ConditionAggregate.php
Compiles this conditional clause.
core.data_types.schema.yml in core/config/schema/core.data_types.schema.yml
core/config/schema/core.data_types.schema.yml
QueryBase::conditionGroupFactory in core/lib/Drupal/Core/Entity/Query/QueryBase.php
Creates an object holding a group of conditions.
10 classes are annotated with Condition
BaloneySpam in core/modules/block/tests/modules/block_test/src/Plugin/Condition/BaloneySpam.php
Provides a 'baloney_spam' condition.
ConditionTestDualUser in core/modules/system/tests/modules/condition_test/src/Plugin/Condition/ConditionTestDualUser.php
Provides a condition that requires two users.
ConditionTestNoExistingType in core/modules/system/tests/modules/condition_test/src/Plugin/Condition/ConditionTestNoExistingType.php
Provides a condition that has a no existing context.
CurrentThemeCondition in core/modules/system/src/Plugin/Condition/CurrentThemeCondition.php
Provides a 'Current Theme' condition.
Language in core/modules/language/src/Plugin/Condition/Language.php
Provides a 'Language' condition.

... See full list

File

core/lib/Drupal/Core/Condition/Annotation/Condition.php, line 26

Namespace

Drupal\Core\Condition\Annotation
View source
class Condition extends Plugin {

  /**
   * The condition plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the condition.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The name of the module providing the type.
   *
   * @var string
   */
  public $module;

  /**
   * An array of context definitions describing the context used by the plugin.
   *
   * The array is keyed by context names.
   *
   * @var \Drupal\Core\Annotation\ContextDefinition[]
   */
  public $context = array();

  /**
   * The category under which the condition should listed in the UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $category;

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
Condition::$category public property The category under which the condition should listed in the UI.
Condition::$context public property An array of context definitions describing the context used by the plugin.
Condition::$id public property The condition plugin ID.
Condition::$label public property The human-readable name of the condition.
Condition::$module public property The name of the module providing the type.
Plugin::$definition protected property The plugin definition read from the class annotation.
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object.