MessageQueueItem.php in Courier 2.x

Namespace

Drupal\courier\Entity

File

src/Entity/MessageQueueItem.php

<?php

namespace Drupal\courier\Entity;

use Drupal\Core\Entity\ContentEntityBase;
use Drupal\courier\MessageQueueItemInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\courier\ChannelInterface;

/**
 * Defines a Message queue item entity.
 *
 * @ContentEntityType(
 *   id = "courier_message_queue_item",
 *   label = @Translation("Message queue item"),
 *   base_table = "courier_message_queue_item",
 *   entity_keys = {
 *     "id" = "id",
 *   }
 * )
 */
class MessageQueueItem extends ContentEntityBase implements MessageQueueItemInterface {

  /**
   * {@inheritdoc}
   */
  public function getIdentity() {
    return $this
      ->get('identity')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function setIdentity(EntityInterface $identity) {
    $this
      ->set('identity', [
      'entity' => $identity,
    ]);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getMessage($entity_type_id) {
    foreach ($this
      ->getMessages() as $message) {
      if ($message
        ->getEntityTypeId() == $entity_type_id) {
        return $message;
      }
    }
    return NULL;
  }

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

  /**
   * {@inheritdoc}
   */
  public function addMessage(ChannelInterface $message) {
    $this->messages[] = $message;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions() {
    return $this
      ->get('options')
      ->first() ? $this
      ->get('options')
      ->first()
      ->getValue() : [];
  }

  /**
   * {@inheritdoc}
   */
  public function setOptions(array $options) {
    $this
      ->set('options', $options);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCreatedTime() {
    return $this
      ->get('created')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setCreatedTime($timestamp) {
    $this
      ->set('created', $timestamp);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields['id'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Message queue item ID'))
      ->setDescription(t('Message queue item ID.'))
      ->setReadOnly(TRUE)
      ->setSetting('unsigned', TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Date of creation'))
      ->setDescription(t('The date the queue item was created.'))
      ->setRequired(TRUE);
    $fields['identity'] = BaseFieldDefinition::create('dynamic_entity_reference')
      ->setLabel(t('Identity'))
      ->setDescription(t('Identity to send the message.'))
      ->setCardinality(1)
      ->setReadOnly(TRUE);
    $fields['messages'] = BaseFieldDefinition::create('dynamic_entity_reference')
      ->setLabel(t('Messages'))
      ->setDescription(t('Messages for this this queue item.'))
      ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
      ->setReadOnly(TRUE);
    $fields['options'] = BaseFieldDefinition::create('map')
      ->setLabel(t('Options'))
      ->setDescription(t('Options to pass to channels when sending.'))
      ->setRequired(TRUE);
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public static function preDelete(EntityStorageInterface $storage, array $entities) {

    /** @var static[] $entities */
    foreach ($entities as $message_queue_item) {

      // Delete messages attached to this queue item.
      foreach ($message_queue_item
        ->getMessages() as $message) {
        $message
          ->delete();
      }
    }
    parent::preDelete($storage, $entities);
  }

}

Classes

Name	Description
MessageQueueItem	Defines a Message queue item entity.