public function MailCacheInterface::get in Simplenews 3.x

Same name and namespace in other branches

1. 8.2 src/Mail/MailCacheInterface.php \Drupal\simplenews\Mail\MailCacheInterface::get()
2. 8 src/Mail/MailCacheInterface.php \Drupal\simplenews\Mail\MailCacheInterface::get()

Return a cached element, if existing.

Although group and key can be used to identify the requested cache, the implementations are responsible to create a unique cache key themself using the $mail. For example based on the node id and the language.

Parameters

\Drupal\simplenews\Mail\MailInterface $mail: The mail object.

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.

string $key: Identifies the requested element, e.g. body or attachments.

Return value

mixed The cached data or NULL.

1 method overrides MailCacheInterface::get()

MailCacheStatic::get in src/Mail/MailCacheStatic.php

Return a cached element, if existing.

File

src/Mail/MailCacheInterface.php, line 34

Class

MailCacheInterface

Interface for a simplenews mail cache implementation.

Namespace

Drupal\simplenews\Mail

Code

public function get(MailInterface $mail, $group, $key);