class RedhenContact in RedHen CRM 7

The class used for contact entities.

Hierarchy

class \Entity implements EntityInterface
- class \RedhenContact

Expanded class hierarchy of RedhenContact

1 string reference to 'RedhenContact'

redhen_contact_entity_info in modules/redhen_contact/redhen_contact.module: Implements hook_entity_info().

File

modules/redhen_contact/lib/redhen_contact.entity.inc, line 10: Redhen Contact entity classses.

View source

class RedhenContact extends Entity {

  // @codingStandardsIgnoreStart
  public $first_name, $middle_name, $last_name, $contact_id, $uid, $author_uid, $redhen_state = REDHEN_STATE_ACTIVE, $type, $created, $updated;

  // @codingStandardsIgnoreEnd

  /**
   * Override parent constructor with entity type.
   *
   * @param array $values
   *   Entity values to populate object.
   */
  public function __construct(array $values = array()) {
    parent::__construct($values, 'redhen_contact');
  }

  /**
   * Override buildContent() to add contact properties.
   */
  public function buildContent($view_mode = 'full', $langcode = NULL) {
    $wrapper = entity_metadata_wrapper('redhen_contact', $this);
    $user = $wrapper->user
      ->value();
    $name = check_plain($wrapper->full_name
      ->value());
    $content['redhen_state'] = array(
      '#theme' => 'redhen_property_field',
      '#label' => t('State'),
      '#items' => array(
        array(
          '#markup' => $this->redhen_state == REDHEN_STATE_ACTIVE ? t('Active') : t('Inactive'),
        ),
      ),
      '#classes' => 'field field-label-inline clearfix',
    );
    if (!empty($name)) {
      $content['name'] = array(
        '#theme' => 'redhen_property_field',
        '#label' => t('Name'),
        '#items' => array(
          array(
            '#markup' => $name,
          ),
        ),
        '#classes' => 'field field-label-inline clearfix',
        '#attributes' => '',
      );
    }
    if ($user) {
      $user_uri = entity_uri('user', $user);
      $content['user'] = array(
        '#theme' => 'redhen_property_field',
        '#label' => t('Drupal User'),
        '#items' => array(
          array(
            '#markup' => l($user->name, $user_uri['path']),
          ),
        ),
        '#classes' => 'field field-label-inline clearfix',
        '#attributes' => '',
      );
    }
    return entity_get_controller($this->entityType)
      ->buildContent($this, $view_mode, $langcode, $content);
  }

  /**
   * Specifies the default label, which is picked up by label() by default.
   */
  protected function defaultLabel() {
    $wrapper = entity_metadata_wrapper('redhen_contact', $this);
    return $wrapper->full_name
      ->value();
  }

  /**
   * Specify default URI.
   */
  protected function defaultUri() {
    return array(
      'path' => 'redhen/contact/' . $this
        ->identifier(),
    );
  }

  /**
   * Return a contacts primary email.
   *
   * @return array
   *   Email value as an array.
   */
  public function email() {
    $wrapper = entity_metadata_wrapper($this
      ->entityType(), $this);
    return $wrapper->email
      ->value();
  }

  /**
   * Return all emails and their properties in an array..
   *
   * @return array
   *   Array of email value arrays.
   */
  public function allEmail() {
    $emails = array();
    if (!empty($this->{REDHEN_CONTACT_EMAIL_FIELD})) {
      $emails = $this->{REDHEN_CONTACT_EMAIL_FIELD}[LANGUAGE_NONE];
    }
    return $emails;
  }

  /**
   * Determine if contact has a given email.
   *
   * @param string $email
   *   Email to look for.
   *
   * @return bool
   *   Whether or not an email exists for a contact.
   */
  public function hasEmail($email) {
    if (!empty($this->{REDHEN_CONTACT_EMAIL_FIELD})) {
      foreach ($this->{REDHEN_CONTACT_EMAIL_FIELD}[LANGUAGE_NONE] as $contact_email) {
        if ($contact_email['value'] === $email) {
          return TRUE;
        }
      }
    }
    return FALSE;
  }

  /**
   * Sets an email for a contact.
   *
   * @param string $email
   *   Email address.
   * @param bool $default
   *   If email is default.
   * @param bool $bulk
   *   If email is for bulk use.
   * @param bool $hold
   *   If email is on hold.
   * @param int $label_id
   *   Label id.
   */
  public function setEmail($email, $default = 1, $bulk = 1, $hold = 0, $label_id = 0) {
    $this->{REDHEN_CONTACT_EMAIL_FIELD}[LANGUAGE_NONE][] = array(
      'value' => $email,
      'default' => $default,
      'bulk' => $bulk,
      'hold' => $hold,
      'label_id' => $label_id,
    );
  }

  /**
   * Set a contact's Drupal user.
   *
   * @return bool
   *   True on success.
   */
  public function setUser() {
    return entity_get_controller($this->entityType)
      ->setUser($this);
  }

  /**
   * Delete or unlink the active user for a contact.
   *
   * @param bool $delete
   *   Flag if contact should unlinked or deleted.
   *
   * @return bool
   *   Trust on success.
   */
  public function deleteUser($delete) {
    return entity_get_controller($this->entityType)
      ->deleteUser($this, $delete);
  }

  /**
   * Set the redhen_state for a contact.
   *
   * @param int $state
   *   The REDHEN_STATE_* value to use.
   */
  public function setState($state) {

    // Allow other modules to act on a state change.
    module_invoke_all('redhen_contact_set_state', $this->redhen_state, $state);
    $this->redhen_state = $state;
    return entity_get_controller($this->entityType)
      ->save($this);
  }

  /**
   * Override parent::save() to manage user association.
   */
  public function save() {
    $wrapper = entity_metadata_wrapper('redhen_contact', $this);
    $user = $wrapper->user
      ->value();
    $emails = $this
      ->allEmail();
    if (redhen_contact_user_email_setting(REDHEN_CONTACT_CONNECT_USERS, $this) && !$user) {
      foreach ($emails as $email) {

        // Ensure email value is not set to empty string because that matches
        // Drupal's anonymous user (uid=0). This can happen when creating a
        // contact programmatically where the email field is not guaranteed to
        // be populated.
        $user_by_mail = empty($email['value']) ? NULL : user_load_by_mail($email['value']);
        if ($user_by_mail) {
          $user = $user_by_mail;
          $wrapper->user
            ->set($user_by_mail);
          break;
        }
      }
    }

    // When there is only one email set, make sure it's marked 'default'.
    if (count($emails) === 1) {
      $this->{REDHEN_CONTACT_EMAIL_FIELD}[LANGUAGE_NONE][0]['default'] = 1;
    }
    $ret = parent::save();
    if ($ret && redhen_contact_user_email_setting(REDHEN_CONTACT_MIRROR_EMAIL, $this)) {
      $email = $wrapper->email
        ->value();

      // If we have a linked user and primary email, but they don't match, set
      // the user email.
      if ($user && $user->uid != 0 && !empty($email) && $email !== $user->mail) {
        user_save($user, array(
          'mail' => $email,
        ));
      }
    }
    return $ret;
  }

  /**
   * Saves a new contact unless a matching contact is found to update.
   *
   * Updates are performed if a single contact is found matching the email
   * address and bundle of the one being saved.
   */
  public function upsert() {
    if (isset($this->is_new) && $this->is_new && !isset($this->created)) {
      $this->updated = REQUEST_TIME;
      $contact_wrapper = entity_metadata_wrapper('redhen_contact', $this);
      $query = new EntityFieldQuery();
      $query
        ->entityCondition('entity_type', 'redhen_contact')
        ->entityCondition('bundle', $contact_wrapper
        ->getBundle())
        ->fieldCondition('redhen_contact_email', 'value', $contact_wrapper->email
        ->value(), '=');
      $result = $query
        ->execute();
      if (isset($result['redhen_contact']) && count($result['redhen_contact']) === 1) {
        list($contact_id) = array_keys($result['redhen_contact']);
        $existing_wrapper = entity_metadata_wrapper('redhen_contact', $contact_id);
        foreach ($existing_wrapper
          ->getPropertyInfo() as $property => $info) {
          if (isset($info['setter callback']) && $existing_wrapper->{$property}
            ->value() !== NULL && $contact_wrapper->{$property}
            ->value() === NULL) {

            // @todo consider a flag to avoid overriding with new values.
            $contact_wrapper->{$property}
              ->set($existing_wrapper->{$property}
              ->value());
          }
        }

        // We aren't creating a new contact, we are updating an old one, so:
        $this->contact_id = $existing_wrapper
          ->getIdentifier();
        unset($this->is_new);
        $this->is_new_revision = TRUE;
        $this->default_revision = TRUE;
      }
    }
    return $this
      ->save();
  }

}

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::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::setUp	protected	function	Set up the object instance on construction or unserializiation.
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::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
RedhenContact::$first_name	public	property
RedhenContact::allEmail	public	function	Return all emails and their properties in an array..
RedhenContact::buildContent	public	function	Override buildContent() to add contact properties. Overrides Entity::buildContent
RedhenContact::defaultLabel	protected	function	Specifies the default label, which is picked up by label() by default. Overrides Entity::defaultLabel
RedhenContact::defaultUri	protected	function	Specify default URI. Overrides Entity::defaultUri
RedhenContact::deleteUser	public	function	Delete or unlink the active user for a contact.
RedhenContact::email	public	function	Return a contacts primary email.
RedhenContact::hasEmail	public	function	Determine if contact has a given email.
RedhenContact::save	public	function	Override parent::save() to manage user association. Overrides Entity::save
RedhenContact::setEmail	public	function	Sets an email for a contact.
RedhenContact::setState	public	function	Set the redhen_state for a contact.
RedhenContact::setUser	public	function	Set a contact's Drupal user.
RedhenContact::upsert	public	function	Saves a new contact unless a matching contact is found to update.
RedhenContact::__construct	public	function	Override parent constructor with entity type. Overrides Entity::__construct

You are here

class RedhenContact in RedHen CRM 7

Hierarchy

File

Members

API Navigation