class MailchimpSignup in Mailchimp 7.5

@file Mailchimp Signup entity class

Hierarchy

• class \Entity implements EntityInterface
  • class \MailchimpSignup

1 string reference to 'MailchimpSignup'

mailchimp_signup_entity_info in modules/mailchimp_signup/mailchimp_signup.module

Implements hook_entity_info().

File

modules/mailchimp_signup/includes/mailchimp_signup.entity.inc, line 8

Mailchimp Signup entity class

class MailchimpSignup extends Entity {
  public $mcs_id, $name, $mc_lists, $mode, $title, $settings;

  /**
   * Override parent constructor to set the entity type.
   */
  public function __construct(array $values = array()) {

    // The Features module calls the entity controller with all values cast to
    // an array. The mergefields and its settings are returned by the Mailchimp
    // API as objects. When constructing the entity from the Features import,
    // cast the mergefields back to objects for a consistent data model.
    if (!empty($values['settings']['mergefields'])) {
      foreach ($values['settings']['mergefields'] as $tag => $mergefield) {
        if (is_array($mergefield)) {
          if (isset($mergefield['options']) && is_array($mergefield['options'])) {
            $mergefield['options'] = (object) $mergefield['options'];
          }
          $values['settings']['mergefields'][$tag] = (object) $mergefield;
        }
      }
    }
    parent::__construct($values, 'mailchimp_signup');
  }

  /**
   * Return a label for a signup form.
   */
  public function label() {
    return $this->title;
  }

  /**
   * Overrides Entity\Entity::uri().
   */
  public function uri() {
    return array(
      'path' => 'admin/config/services/mailchimp/signup/manage/' . $this->name,
      'options' => array(
        'entity_type' => $this->entityType,
        'entity' => $this,
      ),
    );
  }

}

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::defaultLabel	protected	function	Defines the entity label if the 'entity_class_label' callback is used.	1
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::save	public	function	Permanently saves the entity. Overrides EntityInterface::save
Entity::setUp	protected	function	Set up the object instance on construction or unserializiation.
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::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
MailchimpSignup::$mcs_id	public	property
MailchimpSignup::label	public	function	Return a label for a signup form. Overrides Entity::label
MailchimpSignup::uri	public	function	Overrides Entity\Entity::uri(). Overrides Entity::uri
MailchimpSignup::__construct	public	function	Override parent constructor to set the entity type. Overrides Entity::__construct