class Queue in Advanced Queue 8
Defines the queue entity class.
Plugin annotation
@ConfigEntityType(
id = "advancedqueue_queue",
label = @Translation("Queue"),
label_collection = @Translation("Queues"),
label_singular = @Translation("queue"),
label_plural = @Translation("queues"),
label_count = @PluralTranslation(
singular = "@count queue",
plural = "@count queues",
),
handlers = {
"access" = "Drupal\advancedqueue\QueueAccessControlHandler",
"list_builder" = "Drupal\advancedqueue\QueueListBuilder",
"form" = {
"add" = "Drupal\advancedqueue\Form\QueueForm",
"edit" = "Drupal\advancedqueue\Form\QueueForm",
"delete" = "Drupal\Core\Entity\EntityDeleteForm"
},
"route_provider" = {
"default" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
},
},
config_prefix = "advancedqueue_queue",
admin_permission = "administer advancedqueue",
entity_keys = {
"id" = "id",
"label" = "label",
"uuid" = "uuid"
},
config_export = {
"id",
"label",
"backend",
"backend_configuration",
"processor",
"processing_time",
"locked",
},
links = {
"add-form" = "/admin/config/system/queues/add",
"edit-form" = "/admin/config/system/queues/manage/{advancedqueue_queue}",
"delete-form" = "/admin/config/system/queues/manage/{advancedqueue_queue}/delete",
"collection" = "/admin/config/system/queues"
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\advancedqueue\Entity\Queue implements QueueInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of Queue
4 files declare their use of Queue
- DatabaseBackendTest.php in tests/
src/ Kernel/ DatabaseBackendTest.php - ProcessorTest.php in tests/
src/ Kernel/ ProcessorTest.php - QueueBackend.php in src/
Plugin/ views/ argument_validator/ QueueBackend.php - QueueTest.php in tests/
src/ Functional/ QueueTest.php
2 string references to 'Queue'
- advancedqueue.schema.yml in config/
schema/ advancedqueue.schema.yml - config/schema/advancedqueue.schema.yml
- QueueListBuilder::buildHeader in src/
QueueListBuilder.php - Builds the header row for the entity listing.
File
- src/
Entity/ Queue.php, line 59
Namespace
Drupal\advancedqueue\EntityView source
class Queue extends ConfigEntityBase implements QueueInterface {
/**
* The queue ID.
*
* @var string
*/
protected $id;
/**
* The queue label.
*
* @var string
*/
protected $label;
/**
* The queue backend plugin ID.
*
* @var string
*/
protected $backend;
/**
* The queue backend plugin configuration.
*
* @var array
*/
protected $backend_configuration = [];
/**
* The selected processor.
*
* One of the QueueInterface::PROCESSOR_ constants.
*
* @var string
*/
protected $processor = self::PROCESSOR_CRON;
/**
* The processing time, in seconds.
*
* @var int
*/
protected $processing_time = 90;
/**
* Whether the queue is locked, indicating that it cannot be deleted.
*
* @var bool
*/
protected $locked = FALSE;
/**
* The plugin collection that holds the backend plugin.
*
* @var \Drupal\advancedqueue\BackendPluginCollection
*/
protected $pluginCollection;
/**
* {@inheritdoc}
*/
public function enqueueJob(Job $job, $delay = 0) {
return $this
->getBackend()
->enqueueJob($job, $delay);
}
/**
* {@inheritdoc}
*/
public function enqueueJobs(array $jobs, $delay = 0) {
return $this
->getBackend()
->enqueueJobs($jobs, $delay);
}
/**
* {@inheritdoc}
*/
public function getBackend() {
return $this
->getBackendCollection()
->get($this->backend);
}
/**
* {@inheritdoc}
*/
public function getBackendId() {
return $this->backend;
}
/**
* {@inheritdoc}
*/
public function setBackendId($backend_id) {
$this->backend = $backend_id;
$this->backend_configuration = [];
$this->pluginCollection = NULL;
return $this;
}
/**
* {@inheritdoc}
*/
public function getBackendConfiguration() {
return $this->backend_configuration;
}
/**
* {@inheritdoc}
*/
public function setBackendConfiguration(array $configuration) {
$this->backend_configuration = $configuration;
$this->pluginCollection = NULL;
return $this;
}
/**
* {@inheritdoc}
*/
public function getProcessor() {
return $this->processor;
}
/**
* {@inheritdoc}
*/
public function setProcessor($processor) {
$this->processor = $processor;
return $this;
}
/**
* {@inheritdoc}
*/
public function getProcessingTime() {
return $this->processing_time;
}
/**
* {@inheritdoc}
*/
public function setProcessingTime($processing_time) {
$this->processing_time = $processing_time;
return $this;
}
/**
* {@inheritdoc}
*/
public function isLocked() {
return (bool) $this->locked;
}
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return [
'backend_configuration' => $this
->getBackendCollection(),
];
}
/**
* {@inheritdoc}
*/
public function set($property_name, $value) {
// Invoke the setters to clear related properties.
if ($property_name == 'backend') {
$this
->setBackendId($value);
}
elseif ($property_name == 'backend_configuration') {
$this
->setBackendConfiguration($value);
}
else {
return parent::set($property_name, $value);
}
}
/**
* Gets the backend plugin collection.
*
* Ensures the plugin collection is initialized before returning it.
*
* @return \Drupal\advancedqueue\BackendPluginCollection
* The backend plugin collection.
*/
protected function getBackendCollection() {
if (!$this->pluginCollection) {
$plugin_manager = \Drupal::service('plugin.manager.advancedqueue_backend');
$this->pluginCollection = new BackendPluginCollection($plugin_manager, $this->backend, $this->backend_configuration, $this->id);
}
return $this->pluginCollection;
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
if (!$update) {
$this
->getBackend()
->createQueue();
}
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
foreach ($entities as $entity) {
$entity
->getBackend()
->deleteQueue();
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
13 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
13 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
Queue:: |
protected | property | The queue backend plugin ID. | |
Queue:: |
protected | property | The queue backend plugin configuration. | |
Queue:: |
protected | property | The queue ID. | |
Queue:: |
protected | property | The queue label. | |
Queue:: |
protected | property | Whether the queue is locked, indicating that it cannot be deleted. | |
Queue:: |
protected | property | The plugin collection that holds the backend plugin. | |
Queue:: |
protected | property | The processing time, in seconds. | |
Queue:: |
protected | property | The selected processor. | |
Queue:: |
public | function |
Enqueues the given job. Overrides QueueInterface:: |
|
Queue:: |
public | function |
Enqueues the given jobs. Overrides QueueInterface:: |
|
Queue:: |
public | function |
Gets the backend plugin. Overrides QueueInterface:: |
|
Queue:: |
protected | function | Gets the backend plugin collection. | |
Queue:: |
public | function |
Gets the backend plugin configuration. Overrides QueueInterface:: |
|
Queue:: |
public | function |
Gets the backend plugin ID. Overrides QueueInterface:: |
|
Queue:: |
public | function |
Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface:: |
|
Queue:: |
public | function |
Gets the queue processing time. Overrides QueueInterface:: |
|
Queue:: |
public | function |
Gets the queue processor. Overrides QueueInterface:: |
|
Queue:: |
public | function |
Gets whether the queue is locked. Overrides QueueInterface:: |
|
Queue:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityBase:: |
|
Queue:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
|
Queue:: |
public | function |
Sets the value of a property. Overrides ConfigEntityBase:: |
|
Queue:: |
public | function |
Sets the backend plugin configuration. Overrides QueueInterface:: |
|
Queue:: |
public | function |
Sets the backend plugin ID. Overrides QueueInterface:: |
|
Queue:: |
public | function |
Sets the queue processing time. Overrides QueueInterface:: |
|
Queue:: |
public | function |
Sets the queue processor. Overrides QueueInterface:: |
|
QueueInterface:: |
constant | Available queue processors. | ||
QueueInterface:: |
constant | |||
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |