abstract class MailCacheStatic in Simplenews 3.x

Abstract implementation of the mail caching that does static caching.

Subclasses need to implement the abstract function isCacheable() to decide what should be cached.

Hierarchy

• class \Drupal\simplenews\Mail\MailCacheStatic implements MailCacheInterface

File

src/Mail/MailCacheStatic.php, line 13

Namespace

Drupal\simplenews\Mail

abstract class MailCacheStatic implements MailCacheInterface {

  /**
   * The static cache.
   *
   * @var array
   */
  protected $cache = [];

  /**
   * Returns the cache identifier for the mail.
   *
   * @param \Drupal\simplenews\Mail\MailInterface $mail
   *   The mail object.
   *
   * @return string
   *   Cache identifier.
   */
  protected function getCid(MailInterface $mail) {
    $entity_id = $mail
      ->getIssue()
      ->id();
    return $mail
      ->getIssue()
      ->getEntityTypeId() . ':' . $entity_id . ':' . $mail
      ->getLanguage();
  }

  /**
   * {@inheritdoc}
   */
  public function get(MailInterface $mail, $group, $key) {
    if (!$this
      ->isCacheable($mail, $group, $key)) {
      return NULL;
    }
    if (isset($this->cache[$this
      ->getCid($mail)][$group][$key])) {
      return $this->cache[$this
        ->getCid($mail)][$group][$key];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function set(MailInterface $mail, $group, $key, $data) {
    if (!$this
      ->isCacheable($mail, $group, $key)) {
      return;
    }
    $this->cache[$this
      ->getCid($mail)][$group][$key] = $data;
  }

  /**
   * Return if the requested element should be cached.
   *
   * @param \Drupal\simplenews\Mail\MailInterface $mail
   *   The mail object.
   * @param string $group
   *   Group of the cache key, which allows cache implementations to decide what
   *   they want to cache. Currently used groups:
   *     - data: Raw data, e.g. attachments.
   *     - build: Built and themed content, before personalizations like tokens.
   *     - final: The final returned data. Caching this means that newsletter
   *       can not be personalized anymore.
   * @param string $key
   *   Identifies the requested element, e.g. body or attachments.
   *
   * @return bool
   *   TRUE if it should be cached, FALSE otherwise.
   */
  public abstract function isCacheable(MailInterface $mail, $group, $key);

}

Members

Name	Modifiers	Type	Description	Overrides
MailCacheStatic::$cache	protected	property	The static cache.
MailCacheStatic::get	public	function	Return a cached element, if existing. Overrides MailCacheInterface::get
MailCacheStatic::getCid	protected	function	Returns the cache identifier for the mail.
MailCacheStatic::isCacheable	abstract public	function	Return if the requested element should be cached.	2
MailCacheStatic::set	public	function	Write an element to the cache. Overrides MailCacheInterface::set