class Context in Context 8

Same name and namespace in other branches

8.4 src/Entity/Context.php \Drupal\context\Entity\Context
8.0 src/Entity/Context.php \Drupal\context\Entity\Context

Defines the Context entity.

Plugin annotation


@ConfigEntityType(
  id = "context",
  label = @Translation("Context"),
  handlers = {
    "access" = "Drupal\context\Entity\ContextAccess",
    "list_builder" = "Drupal\context_ui\ContextListBuilder",
    "form" = {
      "add" = "Drupal\context_ui\Form\ContextAddForm",
      "edit" = "Drupal\context_ui\Form\ContextEditForm",
      "delete" = "Drupal\context_ui\Form\ContextDeleteForm",
      "disable" = "Drupal\context_ui\Form\ContextDisableForm",
    }
  },
  links = {
    "edit-form" = "/admin/structure/context/{context}",
    "delete-form" = "/admin/structure/context/{context}/delete",
    "disable-form" = "/admin/structure/context/{context}/disable",
    "collection" = "/admin/structure/context",
  },
  admin_permission = "administer contexts",
  entity_keys = {
    "id" = "name",
    "label" = "label",
  },
  config_export = {
    "name",
    "label",
    "group",
    "description",
    "requireAllConditions",
    "disabled",
    "conditions",
    "reactions",
    "weight",
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\context\Entity\Context implements ContextInterface

Expanded class hierarchy of Context

4 files declare their use of Context

ContextFormBase.php in modules/context_ui/src/Form/ContextFormBase.php
ContextListBuilder.php in modules/context_ui/src/ContextListBuilder.php
ContextManager.php in src/ContextManager.php
MenuBuilder.php in modules/context_ui/src/MenuBuilder.php

5 string references to 'Context'

context.info.yml in ./context.info.yml: context.info.yml
ContextListBuilder::buildForm in modules/context_ui/src/ContextListBuilder.php: Form constructor.
context_ui.info.yml in modules/context_ui/context_ui.info.yml: modules/context_ui/context_ui.info.yml
context_ui.links.menu.yml in modules/context_ui/context_ui.links.menu.yml: modules/context_ui/context_ui.links.menu.yml
context_ui.routing.yml in modules/context_ui/context_ui.routing.yml: modules/context_ui/context_ui.routing.yml

File

src/Entity/Context.php, line 52

Namespace

Drupal\context\Entity

View source

class Context extends ConfigEntityBase implements ContextInterface {

  /**
   * The machine name of the context.
   *
   * @var string
   */
  protected $name;

  /**
   * The label of the context.
   *
   * @var string
   */
  protected $label;

  /**
   * A description for this context.
   *
   * @var string
   */
  protected $description = '';

  /**
   * The group this context belongs to.
   *
   * @var string|null
   */
  protected $group = self::CONTEXT_GROUP_NONE;

  /**
   * If all conditions must validate for this context.
   *
   * @var bool
   */
  protected $requireAllConditions = FALSE;

  /**
   * The context conditions as a collection.
   *
   * @var ConditionPluginCollection
   */
  protected $conditionsCollection;

  /**
   * The context reactions as a collection.
   *
   * @var ContextReactionPluginCollection
   */
  protected $reactionsCollection;

  /**
   * A list of conditions this context should react to.
   *
   * @var array
   */
  protected $conditions = [];

  /**
   * A list of reactions that should be taken when conditions match.
   *
   * @var array
   */
  protected $reactions = [];

  /**
   * If the context is disabled or not.
   *
   * @var bool
   */
  protected $disabled = FALSE;

  /**
   * The weight for this context.
   *
   * @var int
   */
  protected $weight = 0;

  /**
   * Returns the ID of the context. The ID is the unique machine name of the
   * context.
   */
  public function id() {
    return $this->name;
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this->name;
  }

  /**
   * {@inheritdoc}
   */
  public function setName($name) {
    if (!is_string($name)) {
      throw new InvalidArgumentException('The context name must be a string.');
    }
    $this->name = $name;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return $this->label;
  }

  /**
   * {@inheritdoc}
   */
  public function setLabel($label) {
    if (!is_string($label)) {
      throw new InvalidArgumentException('The context label must be a string.');
    }
    $this->label = $label;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * {@inheritdoc}
   */
  public function setDescription($description) {
    if (!is_string($description)) {
      throw new InvalidArgumentException('The context description must be a string.');
    }
    $this->description = $description;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getGroup() {
    return $this->group;
  }

  /**
   * {@inheritdoc}
   */
  public function setGroup($group) {
    $this->group = is_string($group) && !empty($group) ? $group : self::CONTEXT_GROUP_NONE;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this->weight;
  }

  /**
   * {@inheritdoc}
   */
  public function setWeight($weight) {
    $this->weight = (int) $weight;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function requiresAllConditions() {
    return $this->requireAllConditions;
  }

  /**
   * {@inheritdoc}
   */
  public function setRequireAllConditions($require) {
    $this->requireAllConditions = (bool) $require;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getConditions() {
    if (!$this->conditionsCollection) {
      $conditionManager = Drupal::service('plugin.manager.condition');
      $this->conditionsCollection = new ConditionPluginCollection($conditionManager, $this->conditions);
    }
    return $this->conditionsCollection;
  }

  /**
   * {@inheritdoc}
   */
  public function getCondition($condition_id) {
    return $this
      ->getConditions()
      ->get($condition_id);
  }

  /**
   * {@inheritdoc}
   */
  public function addCondition(array $configuration) {

    // Add an UUID to the condition to make sure the configuration is saved
    // since the configuration export from the conditions collection wont
    // export configuration that has not been "configured".
    $configuration['uuid'] = $this
      ->uuidGenerator()
      ->generate();
    $this
      ->getConditions()
      ->addInstanceId($configuration['id'], $configuration);
    return $configuration['id'];
  }

  /**
   * {@inheritdoc}
   */
  public function removeCondition($condition_id) {
    $this
      ->getConditions()
      ->removeInstanceId($condition_id);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function hasCondition($condition_id) {
    return $this
      ->getConditions()
      ->has($condition_id);
  }

  /**
   * {@inheritdoc}
   */
  public function getReactions() {
    if (!$this->reactionsCollection) {
      $reactionManager = Drupal::service('plugin.manager.context_reaction');
      $this->reactionsCollection = new ContextReactionPluginCollection($reactionManager, $this->reactions);
    }
    return $this->reactionsCollection;
  }

  /**
   * {@inheritdoc}
   */
  public function getReaction($reaction_id) {
    return $this
      ->getReactions()
      ->get($reaction_id);
  }

  /**
   * {@inheritdoc}
   */
  public function addReaction(array $configuration) {

    // Add an UUID to the condition to make sure the configuration is saved
    // since the configuration export from the conditions collection wont
    // export configuration that has not been "configured".
    $configuration['uuid'] = $this
      ->uuidGenerator()
      ->generate();
    $this
      ->getReactions()
      ->addInstanceId($configuration['id'], $configuration);
    return $configuration['id'];
  }

  /**
   * {@inheritdoc}
   */
  public function removeReaction($reaction_id) {
    $this
      ->getReactions()
      ->removeInstanceId($reaction_id);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function hasReaction($reaction_id) {
    return $this
      ->getReactions()
      ->has($reaction_id);
  }

  /**
   * Gets the plugin collections used by this entity.
   *
   * @return \Drupal\Component\Plugin\LazyPluginCollection[]
   *   An array of plugin collections, keyed by the property name they use to
   *   store their configuration.
   */
  public function getPluginCollections() {
    return [
      'reactions' => $this
        ->getReactions(),
      'conditions' => $this
        ->getConditions(),
    ];
  }

  /**
   * Disable context.
   */
  public function disable() {
    $this->disabled = !$this
      ->disabled();
    $this
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function disabled() {
    return $this->disabled;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$status	protected	property	The enabled/disabled status of the configuration entity.	4
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies	13
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	13
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
Context::$conditions	protected	property	A list of conditions this context should react to.
Context::$conditionsCollection	protected	property	The context conditions as a collection.
Context::$description	protected	property	A description for this context.
Context::$disabled	protected	property	If the context is disabled or not.
Context::$group	protected	property	The group this context belongs to.
Context::$label	protected	property	The label of the context.
Context::$name	protected	property	The machine name of the context.
Context::$reactions	protected	property	A list of reactions that should be taken when conditions match.
Context::$reactionsCollection	protected	property	The context reactions as a collection.
Context::$requireAllConditions	protected	property	If all conditions must validate for this context.
Context::$weight	protected	property	The weight for this context.
Context::addCondition	public	function	Set the conditions. Overrides ContextInterface::addCondition
Context::addReaction	public	function	Add a context reaction. Overrides ContextInterface::addReaction
Context::disable	public	function	Disable context. Overrides ConfigEntityBase::disable
Context::disabled	public	function
Context::getCondition	public	function	Get a condition with the specified ID. Overrides ContextInterface::getCondition
Context::getConditions	public	function	Get a list of all conditions. Overrides ContextInterface::getConditions
Context::getDescription	public	function	Get the context description. Overrides ContextInterface::getDescription
Context::getGroup	public	function	Get the group this context belongs to. Overrides ContextInterface::getGroup
Context::getLabel	public	function	Get the context label. Overrides ContextInterface::getLabel
Context::getName	public	function	Get the machine name of the context. Overrides ContextInterface::getName
Context::getPluginCollections	public	function	Gets the plugin collections used by this entity. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
Context::getReaction	public	function	Get a reaction with the specified ID. Overrides ContextInterface::getReaction
Context::getReactions	public	function	Get a list of all the reactions. Overrides ContextInterface::getReactions
Context::getWeight	public	function	Get the weight for this context. Overrides ContextInterface::getWeight
Context::hasCondition	public	function	Check to see if the context has the specified condition. Overrides ContextInterface::hasCondition
Context::hasReaction	public	function	Check to see if the context has the specified reaction. Overrides ContextInterface::hasReaction
Context::id	public	function	Returns the ID of the context. The ID is the unique machine name of the context. Overrides EntityBase::id
Context::removeCondition	public	function	Remove the specified condition. Overrides ContextInterface::removeCondition
Context::removeReaction	public	function	Remove the specified reaction. Overrides ContextInterface::removeReaction
Context::requiresAllConditions	public	function	If the context requires all conditions to validate. Overrides ContextInterface::requiresAllConditions
Context::setDescription	public	function	Set the context description. Overrides ContextInterface::setDescription
Context::setGroup	public	function	Set the group this context should belong to. Overrides ContextInterface::setGroup
Context::setLabel	public	function	Set the context label. Overrides ContextInterface::setLabel
Context::setName	public	function	Set the machine name of the context. Overrides ContextInterface::setName
Context::setRequireAllConditions	public	function	Set if all conditions should be required for this context to validate. Overrides ContextInterface::setRequireAllConditions
Context::setWeight	public	function	Set the weight for this context. Overrides ContextInterface::setWeight
ContextInterface::CONTEXT_GROUP_NONE		constant	The default value for a context that is not assigned to a group.
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	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	6
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	14
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function

You are here

class Context in Context 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation