Same name in this branch
- 10 core/lib/Drupal/Core/Condition/Annotation/Condition.php \Drupal\Core\Condition\Annotation\Condition
- 10 core/lib/Drupal/Core/Database/Query/Condition.php \Drupal\Core\Database\Query\Condition
- 10 core/lib/Drupal/Core/Config/Entity/Query/Condition.php \Drupal\Core\Config\Entity\Query\Condition
- 10 core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php \Drupal\Core\Entity\KeyValueStore\Query\Condition
- 10 core/lib/Drupal/Core/Entity/Query/Null/Condition.php \Drupal\Core\Entity\Query\Null\Condition
- 10 core/lib/Drupal/Core/Entity/Query/Sql/pgsql/Condition.php \Drupal\Core\Entity\Query\Sql\pgsql\Condition
Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Condition/Annotation/Condition.php \Drupal\Core\Condition\Annotation\Condition
- 9 core/lib/Drupal/Core/Condition/Annotation/Condition.php \Drupal\Core\Condition\Annotation\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
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\Core\Condition\Annotation\Condition
Expanded class hierarchy of Condition
See also
\Drupal\Core\Condition\ConditionManager
\Drupal\Core\Condition\ConditionInterface
\Drupal\Core\Condition\ConditionPluginBase
Related topics
1 string reference to 'Condition'
- core.data_types.schema.yml in core/
config/ schema/ core.data_types.schema.yml - core/config/schema/core.data_types.schema.yml
File
- core/
lib/ Drupal/ Core/ Condition/ Annotation/ Condition.php, line 26
Namespace
Drupal\Core\Condition\AnnotationView 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_definitions = [];
/**
* The category under which the condition should listed in the UI.
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $category;
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Condition:: |
public | property | The category under which the condition should listed in the UI. | |
Condition:: |
public | property | An array of context definitions describing the context used by the plugin. | |
Condition:: |
public | property | The condition plugin ID. | |
Condition:: |
public | property | The human-readable name of the condition. | |
Condition:: |
public | property | The name of the module providing the type. | |
Plugin:: |
protected | property | The plugin definition read from the class annotation. | 1 |
Plugin:: |
public | function |
Gets the value of an annotation. Overrides AnnotationInterface:: |
6 |
Plugin:: |
public | function |
Gets the class of the annotated class. Overrides AnnotationInterface:: |
1 |
Plugin:: |
public | function |
Gets the unique ID for this annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Gets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
1 |
Plugin:: |
protected | function | Parses an annotation into its definition. | |
Plugin:: |
public | function |
Sets the class of the annotated class. Overrides AnnotationInterface:: |
1 |
Plugin:: |
public | function |
Sets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function | Constructs a Plugin object. | 3 |