class SimplenewsNewsletter in Simplenews 7.2

Class for simplenews_newsletter entity.

@incroup newsletter

Hierarchy

• class \Entity implements EntityInterface
  • class \SimplenewsNewsletter

1 string reference to 'SimplenewsNewsletter'

simplenews_entity_info in ./simplenews.module

Implements hook_entity_info().

File

includes/simplenews.entity.inc, line 13

Simplenews entities definitions.

class SimplenewsNewsletter extends Entity {

  /**
   * The primary key.
   *
   * @var integer
   */
  public $newsletter_id;

  /**
   * Name of the newsletter.
   *
   * @var string
   */
  public $name;

  /**
   * Description of the newsletter.
   *
   * @var string
   */
  public $description;

  /**
   * HTML or plaintext newsletter indicator.
   *
   * @var integer
   */
  public $format;

  /**
   * Priority indicator.
   *
   * @var integer
   */
  public $priority;

  /**
   * TRUE if a read receipt should be requested.
   *
   * @var boolean
   */
  public $receipt;

  /**
   * Name of the e-mail author.
   *
   * @var string
   */
  public $from_name;

  /**
   * Newsletter subject.
   *
   * @var string
   */
  public $email_subject;

  /**
   * E-mail author address.
   *
   * @var string
   */
  public $from_address;

  /**
   * Indicates if hyperlinks should be kept inline or extracted.
   *
   * @var boolean
   */
  public $hyperlinks;

  /**
   * Indicates how to integrate with the register form.
   *
   * @var integer
   */
  public $new_account;

  /**
   * Defines the Opt-In/out options.
   *
   * @var integer.
   */
  public $opt_inout;

  /**
   * TRUE if a block should be provided for this newsletter.
   *
   * @var boolean
   */
  public $block;

  /**
   * Weight of the newsletter when displayed in listings.
   *
   * @var integer
   */
  public $weight;

  /**
   * 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::defaultUri().
   */
  protected function defaultUri() {
    return array(
      'path' => 'newsletter/' . $this
        ->identifier(),
    );
  }

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

}

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::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.
SimplenewsNewsletter::$block	public	property	TRUE if a block should be provided for this newsletter.
SimplenewsNewsletter::$description	public	property	Description of the newsletter.
SimplenewsNewsletter::$email_subject	public	property	Newsletter subject.
SimplenewsNewsletter::$format	public	property	HTML or plaintext newsletter indicator.
SimplenewsNewsletter::$from_address	public	property	E-mail author address.
SimplenewsNewsletter::$from_name	public	property	Name of the e-mail author.
SimplenewsNewsletter::$hyperlinks	public	property	Indicates if hyperlinks should be kept inline or extracted.
SimplenewsNewsletter::$name	public	property	Name of the newsletter.
SimplenewsNewsletter::$newsletter_id	public	property	The primary key.
SimplenewsNewsletter::$new_account	public	property	Indicates how to integrate with the register form.
SimplenewsNewsletter::$opt_inout	public	property	Defines the Opt-In/out options.
SimplenewsNewsletter::$priority	public	property	Priority indicator.
SimplenewsNewsletter::$receipt	public	property	TRUE if a read receipt should be requested.
SimplenewsNewsletter::$weight	public	property	Weight of the newsletter when displayed in listings.
SimplenewsNewsletter::defaultLabel	protected	function	Overrides Entity::defaultLabel(). Overrides Entity::defaultLabel
SimplenewsNewsletter::defaultUri	protected	function	Overrides Entity::defaultUri(). Overrides Entity::defaultUri
SimplenewsNewsletter::setUp	protected	function	Overrides Entity::setUp(). Overrides Entity::setUp
SimplenewsNewsletter::__sleep	public	function	Overrides Entity::__sleep(). Overrides Entity::__sleep