class SimplenewsSubscriber in Simplenews 7.2

Class for simplenews_subscriber entity.

@incroup newsletter

Hierarchy

• class \Entity implements EntityInterface
  • class \SimplenewsSubscriber

1 string reference to 'SimplenewsSubscriber'

simplenews_entity_info in ./simplenews.module

Implements hook_entity_info().

File

includes/simplenews.entity.inc, line 159

Simplenews entities definitions.

class SimplenewsSubscriber extends Entity {

  /**
   * An array of newsletter ids this subscriber is subscribed to.
   */
  public $newsletter_ids = array();

  /**
   * Overrides Entity::setUp().
   *
   * Prevent failure if the entity system ist not fully loaded.
   */
  protected function setUp() {

    // Hack to get arount the not loaded entity system.
    // @todo: fix this and remove hack.
    if (function_exists('entity_get_info')) {
      parent::setUp();
    }
  }

  /**
   * Overrides Entity::__sleep().
   *
   * Prevent failure if the entity system ist not fully loaded.
   */
  public function __sleep() {

    // @todo: fix this and remove hack.
    $vars = get_object_vars($this);
    unset($vars['entityInfo'], $vars['idKey'], $vars['nameKey'], $vars['statusKey']);
    return array_combine(array_keys($vars), array_keys($vars));
  }

  /**
   * Overrides Entity::defaultLabel().
   */
  protected function defaultLabel() {
    return $this->mail;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entity::$defaultLabel	protected	property		1
Entity::$entityInfo	protected	property
Entity::$entityType	protected	property
Entity::$idKey	protected	property
Entity::$wrapper	protected	property
Entity::buildContent	public	function	Builds a structured array representing the entity's content. Overrides EntityInterface::buildContent	1
Entity::bundle	public	function	Returns the bundle of the entity. Overrides EntityInterface::bundle
Entity::defaultUri	protected	function	Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info().
Entity::delete	public	function	Permanently deletes the entity. Overrides EntityInterface::delete
Entity::entityInfo	public	function	Returns the info of the type of the entity. Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Returns the type of the entity. Overrides EntityInterface::entityType
Entity::export	public	function	Exports the entity. Overrides EntityInterface::export
Entity::getTranslation	public	function	Gets the raw, translated value of a property or field. Overrides EntityInterface::getTranslation
Entity::hasStatus	public	function	Checks if the entity has a certain exportable status. Overrides EntityInterface::hasStatus
Entity::identifier	public	function	Returns the entity identifier, i.e. the entities name or numeric id. Overrides EntityInterface::identifier
Entity::internalIdentifier	public	function	Returns the internal, numeric identifier. Overrides EntityInterface::internalIdentifier
Entity::isDefaultRevision	public	function	Checks whether the entity is the default revision. Overrides EntityInterface::isDefaultRevision
Entity::label	public	function	Returns the label of the entity. Overrides EntityInterface::label
Entity::save	public	function	Permanently saves the entity. Overrides EntityInterface::save
Entity::uri	public	function	Returns the uri of the entity just as entity_uri(). Overrides EntityInterface::uri
Entity::view	public	function	Generate an array for rendering the entity. Overrides EntityInterface::view
Entity::wrapper	public	function	Returns the EntityMetadataWrapper of the entity. Overrides EntityInterface::wrapper
Entity::__construct	public	function		1
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
SimplenewsSubscriber::$newsletter_ids	public	property	An array of newsletter ids this subscriber is subscribed to.
SimplenewsSubscriber::defaultLabel	protected	function	Overrides Entity::defaultLabel(). Overrides Entity::defaultLabel
SimplenewsSubscriber::setUp	protected	function	Overrides Entity::setUp(). Overrides Entity::setUp
SimplenewsSubscriber::__sleep	public	function	Overrides Entity::__sleep(). Overrides Entity::__sleep