interface SimplenewsSourceEntityInterface in Simplenews 7.2

Source interface based on an entity.

Hierarchy

• interface \SimplenewsSourceInterface
  • interface \SimplenewsSourceEntityInterface

File

includes/simplenews.source.inc, line 114

Contains SimplenewsSource interface and implementations.

interface SimplenewsSourceEntityInterface extends SimplenewsSourceInterface {

  /**
   * Create a source based on an entity.
   */
  function __construct($entity, $subscriber, $entity_type);

  /**
   * Returns the actually used entity of this source.
   */
  function getEntity();

  /**
   * Returns the entity type of the given entity.
   */
  function getEntityType();

  /**
   * Returns the subscriber object.
   */
  function getSubscriber();

}

Members

Name	Modifiers	Type	Description	Overrides
SimplenewsSourceEntityInterface::getEntity		function	Returns the actually used entity of this source.	1
SimplenewsSourceEntityInterface::getEntityType		function	Returns the entity type of the given entity.	1
SimplenewsSourceEntityInterface::getSubscriber		function	Returns the subscriber object.	1
SimplenewsSourceEntityInterface::__construct		function	Create a source based on an entity.	1
SimplenewsSourceInterface::getAttachments		function	Returns an array of attachments for this newsletter mail.	2
SimplenewsSourceInterface::getBody		function	Returns the mail body.	2
SimplenewsSourceInterface::getFooter		function	Returns the mail footer.	2
SimplenewsSourceInterface::getFormat		function	Returns the mail format.	2
SimplenewsSourceInterface::getFromAddress		function	Returns the plain mail address.	2
SimplenewsSourceInterface::getFromFormatted		function	Returns the formatted from mail address.	2
SimplenewsSourceInterface::getHeaders		function	Returns the mail headers.	2
SimplenewsSourceInterface::getKey		function	Returns the mail key to be used for drupal_mail().	2
SimplenewsSourceInterface::getLanguage		function	The language that should be used for this newsletter mail.	2
SimplenewsSourceInterface::getPlainBody		function	Returns the plaintext body.	2
SimplenewsSourceInterface::getPlainFooter		function	Returns the plain footer.	2
SimplenewsSourceInterface::getRecipient		function	Returns the recipent of this newsletter mail.	2
SimplenewsSourceInterface::getSubject		function	Returns the mail subject.	2
SimplenewsSourceInterface::getTokenContext		function	Returns the token context to be used with token replacements.	2