class EntityQueue in Entityqueue 8

Defines the EntityQueue entity class.

Plugin annotation


@ConfigEntityType(
  id = "entity_queue",
  label = @Translation("Entity queue"),
  handlers = {
    "list_builder" = "Drupal\entityqueue\EntityQueueListBuilder",
    "form" = {
      "add" = "Drupal\entityqueue\Form\EntityQueueForm",
      "edit" = "Drupal\entityqueue\Form\EntityQueueForm",
      "delete" = "Drupal\Core\Entity\EntityDeleteForm"
    },
    "access" = "Drupal\entityqueue\EntityQueueAccessControlHandler",
  },
  admin_permission = "administer entityqueue",
  config_prefix = "entity_queue",
  bundle_of = "entity_subqueue",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid",
    "status" = "status"
  },
  links = {
    "edit-form" = "/admin/structure/entityqueue/{entity_queue}",
    "delete-form" = "/admin/structure/entityqueue/{entity_queue}/delete",
    "collection" = "/admin/structure/entityqueue",
    "enable" = "/admin/structure/entityqueue/{entity_queue}/enable",
    "disable" = "/admin/structure/entityqueue/{entity_queue}/disable",
    "subqueue-list" = "/admin/structure/entityqueue/{entity_queue}/list"
  },
  config_export = {
    "id",
    "label",
    "handler",
    "handler_configuration",
    "entity_settings",
    "queue_settings"
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
    class \Drupal\entityqueue\Entity\EntityQueue implements EntityWithPluginCollectionInterface, EntityQueueInterface

Expanded class hierarchy of EntityQueue

7 files declare their use of EntityQueue

entityqueue.module in ./entityqueue.module: Allows users to collect entities in arbitrarily ordered lists.
entityqueue.views.inc in ./entityqueue.views.inc: Provide views data for the Entityqueue module.
EntityQueueCrudTest.php in tests/src/Kernel/EntityQueueCrudTest.php
EntityQueuePermissions.php in src/EntityQueuePermissions.php
EntityQueueRelationship.php in src/Plugin/views/relationship/EntityQueueRelationship.php

... See full list

File

src/Entity/EntityQueue.php, line 55

Namespace

Drupal\entityqueue\Entity

View source

class EntityQueue extends ConfigEntityBundleBase implements EntityQueueInterface, EntityWithPluginCollectionInterface {

  /**
   * The EntityQueue ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The EntityQueue label.
   *
   * @var string
   */
  protected $label;

  /**
   * The entity selection settings used for the subqueue's 'items' field.
   *
   * @var array
   */
  protected $entity_settings = [
    'target_type' => 'node',
    'handler' => 'default',
    'handler_settings' => [],
  ];

  /**
   * The queue settings.
   *
   * @var array
   */
  protected $queue_settings = [
    'min_size' => 0,
    'max_size' => 0,
    'act_as_queue' => FALSE,
    'reverse' => FALSE,
  ];

  /**
   * The ID of the EntityQueueHandler.
   *
   * @var string
   */
  protected $handler = 'simple';

  /**
   * An array to store and load the EntityQueueHandler plugin configuration.
   *
   * @var array
   */
  protected $handler_configuration = [];

  /**
   * The EntityQueueHandler plugin.
   *
   * @var \Drupal\entityqueue\EntityQueueHandlerPluginCollection
   */
  protected $handlerPluginCollection;

  /**
   * {@inheritdoc}
   */
  public function getTargetEntityTypeId() {
    return $this->entity_settings['target_type'];
  }

  /**
   * {@inheritdoc}
   */
  public function getMinimumSize() {
    return $this->queue_settings['min_size'];
  }

  /**
   * {@inheritdoc}
   */
  public function getMaximumSize() {
    return $this->queue_settings['max_size'];
  }

  /**
   * {@inheritdoc}
   */
  public function getActAsQueue() {
    return $this->queue_settings['act_as_queue'];
  }

  /**
   * {@inheritdoc}
   */
  public function isReversed() {
    return isset($this->queue_settings['reverse']) ? $this->queue_settings['reverse'] : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getEntitySettings() {
    return $this->entity_settings + [
      // Ensure that we always have an empty array by default for the
      // 'handler_settings', regardless of the incoming form values.
      'handler_settings' => [],
    ];
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function setHandler($handler_id) {
    $this->handler = $handler_id;
    $this
      ->getPluginCollection()
      ->addInstanceID($handler_id, []);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getHandlerPlugin() {
    return $this
      ->getPluginCollection()
      ->get($this->handler);
  }

  /**
   * {@inheritdoc}
   */
  public function setHandlerPlugin($handler) {
    $this
      ->getPluginCollection()
      ->set($handler
      ->getPluginId(), $handler);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginCollections() {
    return [
      'handler_configuration' => $this
        ->getPluginCollection(),
    ];
  }

  /**
   * Encapsulates the creation of the EntityQueueHandlerPluginCollection.
   *
   * @return \Drupal\entityqueue\EntityQueueHandlerPluginCollection
   *   The entity queue's plugin collection.
   */
  protected function getPluginCollection() {
    if (!$this->handlerPluginCollection) {
      $this->handlerPluginCollection = new EntityQueueHandlerPluginCollection(\Drupal::service('plugin.manager.entityqueue.handler'), $this->handler, $this->handler_configuration, $this);
    }
    return $this->handlerPluginCollection;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();

    // Ensure that the queue depends on the module that provides the target
    // entity type.
    $target_entity_type = \Drupal::entityTypeManager()
      ->getDefinition($this
      ->getTargetEntityTypeId());
    $this
      ->addDependency('module', $target_entity_type
      ->getProvider());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);
    $this
      ->getHandlerPlugin()
      ->onQueuePreSave($this, $storage);
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    $this
      ->getHandlerPlugin()
      ->onQueuePostSave($this, $storage, $update);
  }

  /**
   * {@inheritdoc}
   */
  public static function preDelete(EntityStorageInterface $storage, array $entities) {
    parent::preDelete($storage, $entities);
    foreach ($entities as $queue) {
      $queue
        ->getHandlerPlugin()
        ->onQueuePreDelete($queue, $storage);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function postDelete(EntityStorageInterface $storage, array $entities) {
    parent::postDelete($storage, $entities);
    foreach ($entities as $queue) {
      $queue
        ->getHandlerPlugin()
        ->onQueuePostDelete($queue, $storage);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function postLoad(EntityStorageInterface $storage, array &$entities) {
    parent::postLoad($storage, $entities);
    foreach ($entities as $queue) {
      $queue
        ->getHandlerPlugin()
        ->onQueuePostLoad($queue, $storage);
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function invalidateTagsOnSave($update) {

    // In addition to the parent implementation, we also need to invalidate
    // queue-specific cache tags.
    $tags = Cache::mergeTags($this
      ->getEntityType()
      ->getListCacheTags(), $this
      ->getCacheTagsToInvalidate());
    Cache::invalidateTags($tags);
  }

  /**
   * {@inheritdoc}
   *
   * Override to never invalidate the individual entities' cache tags; the
   * config system already invalidates them.
   */
  protected static function invalidateTagsOnDelete(EntityTypeInterface $entity_type, array $entities) {
    $tags = $entity_type
      ->getListCacheTags();

    // In addition to the parent implementation, we also need to invalidate
    // queue-specific cache tags.
    foreach ($entities as $entity) {
      $tags = Cache::mergeTags($tags, $entity
        ->getCacheTagsToInvalidate());
    }
    Cache::invalidateTags($tags);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTagsToInvalidate() {

    // A newly created or deleted queue could alter views data relationships, so
    // we must invalidate the associated 'views_data' cache tag.
    return Cache::mergeTags(parent::getCacheTagsToInvalidate(), [
      'views_data',
      'entity_field_info',
    ]);
  }

  /**
   * {@inheritdoc}
   *
   * @return static[]
   *   An array of entity queue objects, indexed by their IDs.
   */
  public static function loadMultipleByTargetType($target_entity_type_id) {
    $ids = \Drupal::entityTypeManager()
      ->getStorage('entity_queue')
      ->getQuery()
      ->condition('entity_settings.target_type', $target_entity_type_id)
      ->execute();
    return $ids ? static::loadMultiple($ids) : [];
  }

}

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::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	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::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::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::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
ConfigEntityBundleBase::deleteDisplays	protected	function	Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays	protected	function	Returns view or form displays for this bundle.
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::id	public	function	Gets the identifier. Overrides EntityInterface::id	11
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::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.
EntityQueue::$entity_settings	protected	property	The entity selection settings used for the subqueue's 'items' field.
EntityQueue::$handler	protected	property	The ID of the EntityQueueHandler.
EntityQueue::$handlerPluginCollection	protected	property	The EntityQueueHandler plugin.
EntityQueue::$handler_configuration	protected	property	An array to store and load the EntityQueueHandler plugin configuration.
EntityQueue::$id	protected	property	The EntityQueue ID.
EntityQueue::$label	protected	property	The EntityQueue label.
EntityQueue::$queue_settings	protected	property	The queue settings.
EntityQueue::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
EntityQueue::getActAsQueue	public	function	Returns the behavior of exceeding the maximum number of queue items. Overrides EntityQueueInterface::getActAsQueue
EntityQueue::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides ConfigEntityBase::getCacheTagsToInvalidate
EntityQueue::getEntitySettings	public	function	Gets the selection settings used by a subqueue's 'items' reference field. Overrides EntityQueueInterface::getEntitySettings
EntityQueue::getHandler	public	function	Gets the EntityQueueHandler plugin ID. Overrides EntityQueueInterface::getHandler
EntityQueue::getHandlerConfiguration	public	function	Gets the handler plugin configuration for this queue. Overrides EntityQueueInterface::getHandlerConfiguration
EntityQueue::getHandlerPlugin	public	function	Gets the EntityQueueHandler plugin object. Overrides EntityQueueInterface::getHandlerPlugin
EntityQueue::getMaximumSize	public	function	Gets the maximum number of items that this queue can hold. Overrides EntityQueueInterface::getMaximumSize
EntityQueue::getMinimumSize	public	function	Gets the minimum number of items that this queue can hold. Overrides EntityQueueInterface::getMinimumSize
EntityQueue::getPluginCollection	protected	function	Encapsulates the creation of the EntityQueueHandlerPluginCollection.
EntityQueue::getPluginCollections	public	function	Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
EntityQueue::getQueueSettings	public	function	Gets the queue settings. Overrides EntityQueueInterface::getQueueSettings
EntityQueue::getTargetEntityTypeId	public	function	Gets the ID of the target entity type. Overrides EntityQueueInterface::getTargetEntityTypeId
EntityQueue::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides ConfigEntityBase::invalidateTagsOnDelete
EntityQueue::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides ConfigEntityBase::invalidateTagsOnSave
EntityQueue::isReversed	public	function	Returns the behavior of adding new items to a queue. Overrides EntityQueueInterface::isReversed
EntityQueue::loadMultipleByTargetType	public static	function	Overrides EntityQueueInterface::loadMultipleByTargetType
EntityQueue::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides ConfigEntityBundleBase::postDelete
EntityQueue::postLoad	public static	function	Acts on loaded entities. Overrides EntityBase::postLoad
EntityQueue::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase::postSave
EntityQueue::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides ConfigEntityBase::preDelete
EntityQueue::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBundleBase::preSave
EntityQueue::setHandler	public	function	Sets the EntityQueueHandler. Overrides EntityQueueInterface::setHandler
EntityQueue::setHandlerPlugin	public	function	Sets the EntityQueueHandler plugin object. Overrides EntityQueueInterface::setHandlerPlugin
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 EntityQueue in Entityqueue 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation