interface ContextInterface in Plug 7
A generic context interface for wrapping data a plugin needs to operate.
Hierarchy
- interface \Drupal\Component\Plugin\Context\ContextInterface
Expanded class hierarchy of ContextInterface
All classes that implement ContextInterface
2 files declare their use of ContextInterface
- ContextAwarePluginBase.php in lib/
Drupal/ Component/ Plugin/ ContextAwarePluginBase.php - Contains \Drupal\Component\Plugin\ContextAwarePluginBase.
- ContextAwarePluginInterface.php in lib/
Drupal/ Component/ Plugin/ ContextAwarePluginInterface.php - Contains \Drupal\Component\Plugin\ContextAwarePluginInterface.
File
- lib/
Drupal/ Component/ Plugin/ Context/ ContextInterface.php, line 13 - Contains \Drupal\Component\Plugin\Context\ContextInterface.
Namespace
Drupal\Component\Plugin\ContextView source
interface ContextInterface {
/**
* Gets the context value.
*
* @return mixed
* The currently set context value, or NULL if it is not set.
*/
public function getContextValue();
/**
* Returns whether the context has a value.
*
* @return bool
* TRUE if the context has a value, FALSE otherwise.
*/
public function hasContextValue();
/**
* Gets the provided definition that the context must conform to.
*
* @return \Drupal\Component\Plugin\Context\ContextDefinitionInterface
* The defining characteristic representation of the context.
*/
public function getContextDefinition();
/**
* Gets a list of validation constraints.
*
* @return array
* Array of constraints, each being an instance of
* \Symfony\Component\Validator\Constraint.
*/
public function getConstraints();
/**
* Validates the set context value.
*
* @return \Symfony\Component\Validator\ConstraintViolationListInterface
* A list of constraint violations. If the list is empty, validation
* succeeded.
*/
public function validate();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContextInterface:: |
public | function | Gets a list of validation constraints. | 1 |
ContextInterface:: |
public | function | Gets the provided definition that the context must conform to. | 1 |
ContextInterface:: |
public | function | Gets the context value. | 1 |
ContextInterface:: |
public | function | Returns whether the context has a value. | 1 |
ContextInterface:: |
public | function | Validates the set context value. | 1 |