You are here

Home » API reference » Entityqueue 8 » EntityQueueInterface.php

interface EntityQueueInterface in Entityqueue 8

Provides an interface defining a EntityQueue entity.

Hierarchy

Expanded class hierarchy of EntityQueueInterface

All classes that implement EntityQueueInterface

7 files declare their use of EntityQueueInterface
EntityQueue.php in src/Entity/EntityQueue.php
EntityQueueForm.php in src/Form/EntityQueueForm.php
EntityQueueUIController.php in src/Controller/EntityQueueUIController.php
EntitySubqueue.php in src/Entity/EntitySubqueue.php
Multiple.php in src/Plugin/EntityQueueHandler/Multiple.php

... See full list

File

src/EntityQueueInterface.php, line 10

Namespace

Drupal\entityqueue
View source 
interface EntityQueueInterface extends ConfigEntityInterface {

  /**
   * Gets the EntityQueueHandler plugin ID.
   *
   * @return string
   */
  public function getHandler();

  /**
   * Gets the handler plugin configuration for this queue.
   *
   * @return mixed[]
   *   The handler plugin configuration.
   */
  public function getHandlerConfiguration();

  /**
   * Sets the EntityQueueHandler.
   *
   * @param string $handler_id
   *   The handler name.
   *
   * @return $this
   */
  public function setHandler($handler_id);

  /**
   * Gets the EntityQueueHandler plugin object.
   *
   * @return EntityQueueHandlerInterface
   */
  public function getHandlerPlugin();

  /**
   * Sets the EntityQueueHandler plugin object.
   *
   * @param \Drupal\entityqueue\EntityQueueHandlerInterface $handler
   *   A queue handler plugin.
   *
   * @return $this
   */
  public function setHandlerPlugin($handler);

  /**
   * Gets the ID of the target entity type.
   *
   * @return string
   *   The target entity type ID.
   */
  public function getTargetEntityTypeId();

  /**
   * Gets the minimum number of items that this queue can hold.
   *
   * @return int
   */
  public function getMinimumSize();

  /**
   * Gets the maximum number of items that this queue can hold.
   *
   * @return int
   */
  public function getMaximumSize();

  /**
   * Returns the behavior of exceeding the maximum number of queue items.
   *
   * If TRUE, when a maximum size is set and it is exceeded, the queue will be
   * truncated to the maximum size by removing items from the front of the
   * queue. However, if the 'reverse' option is TRUE as well, the items that
   * exceed the maximum size will be removed from the top instead.
   *
   * @return bool
   */
  public function getActAsQueue();

  /**
   * Returns the behavior of adding new items to a queue.
   *
   * By default, new items are added to the bottom of the queue. If the
   * 'reverse' setting is set to TRUE, the new items will be added to the top
   * of the queue instead.
   *
   * @return bool
   */
  public function isReversed();

  /**
   * Gets the selection settings used by a subqueue's 'items' reference field.
   *
   * @return array
   *   An array with the following keys:
   *   - target_type: The type of the entities that will be queued.
   *   - handler: The entity reference selection handler that will be used by
   *     the subqueue's 'items' field.
   *   - handler_settings: The entity reference selection handler settings that
   *     will be used by the subqueue's 'items' field.
   */
  public function getEntitySettings();

  /**
   * Gets the queue settings.
   *
   * @return array
   *   An array with the following keys:
   *   - min_size: The minimum number of items that this queue can hold.
   *   - max_size: The maximum number of items that this queue can hold.
   *   - act_as_queue: The behavior of exceeding the maximum number of queue
   *     items.
   *   - reverse: New items will be added to the top of the queue.
   */
  public function getQueueSettings();

  /**
   * Loads one or more queues based on their target entity type.
   *
   * @param string $target_entity_type_id
   *   The target entity type ID.
   *
   * @return static[]
   *   An array of entity queue objects, indexed by their IDs.
   */
  public static function loadMultipleByTargetType($target_entity_type_id);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
EntityQueueInterface::getActAsQueue public function Returns the behavior of exceeding the maximum number of queue items. 1
EntityQueueInterface::getEntitySettings public function Gets the selection settings used by a subqueue's 'items' reference field. 1
EntityQueueInterface::getHandler public function Gets the EntityQueueHandler plugin ID. 1
EntityQueueInterface::getHandlerConfiguration public function Gets the handler plugin configuration for this queue. 1
EntityQueueInterface::getHandlerPlugin public function Gets the EntityQueueHandler plugin object. 1
EntityQueueInterface::getMaximumSize public function Gets the maximum number of items that this queue can hold. 1
EntityQueueInterface::getMinimumSize public function Gets the minimum number of items that this queue can hold. 1
EntityQueueInterface::getQueueSettings public function Gets the queue settings. 1
EntityQueueInterface::getTargetEntityTypeId public function Gets the ID of the target entity type. 1
EntityQueueInterface::isReversed public function Returns the behavior of adding new items to a queue. 1
EntityQueueInterface::loadMultipleByTargetType public static function Loads one or more queues based on their target entity type. 1
EntityQueueInterface::setHandler public function Sets the EntityQueueHandler. 1
EntityQueueInterface::setHandlerPlugin public function Sets the EntityQueueHandler plugin object. 1
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5