redhen.api.php in RedHen CRM 7

Hooks provided by the RedHen contact module.

File

redhen.api.php

<?php

/**
 * @file
 * Hooks provided by the RedHen contact module.
 */

/**
 * All RedHen custom entities, including contacts, organizations, memberships,
 * notes, and engagements are based on Entity API Entity controller class and
 * inherit all of it's CRUD hooks. It also provides the following additional
 * hooks.
 */

/**
 * Prevent a contact record from being deleted.
 *
 * @param string $contact
 *
 * @return bool
 */
function hook_redhen_contact_can_delete(RedhenContact $contact) {

  // prevent the deletion of active contacts
  if ($contact->redhen_state == REDHEN_STATE_ACTIVE) {
    return FALSE;
  }
}

/**
 * Act on the contact when the link to a drupal user account is modified
 *
 * @param string $op ( insert | update | delete )
 * @param $contact
 *  The RedhenContact object with the new user drupal user info
 * @param $old_contact
 *  The RedhenContact object with the old user info
 *
 * @return void
 */
function hook_redhen_contact_user_update($op, RedhenContact $contact, $old_contact = NULL) {

  // Send "Welcome (no approval required)" email to new user.
  if ($op == 'insert') {
    $wrapper = entity_metadata_wrapper('redhen_contact', $contact);

    // Set _user_mail_notify specific operation.
    $op = 'register_no_approval_required';

    // Send an email.
    _user_mail_notify($op, $wrapper->user
      ->value());
  }
}

/**
 * Prevent an organization record from being deleted.
 *
 * @param RedhenOrg $org
 *
 * @return void
 */
function hook_redhen_org_can_delete(RedhenOrg $org) {
}

/**
 * Alter the display name for a contact.
 *
 * @param string $name
 * @param RedhenContact $contact
 *
 * @return string
 */
function hook_redhen_contact_name_alter(&$name, RedhenContact $contact) {
  return $contact->last_name . ', ' . $contact->last_name;
}

/**
 * Act on a state change for a contact.
 *
 * @param $old_state
 * @param $new_state
 */
function hook_redhen_contact_set_state($old_state, $new_state) {
}

/**
 * Allow modules to act before an entity is deleted.
 *
 * @param string $entity_type ( redhen_org | redhen_contact )
 * @param Entity $entity
 */
function hook_redhen_entity_predelete($entity_type, $entity) {
}

/**
 * Provide a form API element exposed as a RedHen setting.
 *
 * @return array
 */
function hook_redhen_settings() {
  return array(
    'redhen_contact_connect_users' => array(
      '#type' => 'checkbox',
      '#title' => t('Connect users to Redhen contacts'),
      '#description' => t('If checked, Redhen will attempt to connect Drupal users to Redhen contacts by matching email addresses when a contact is updated.'),
      '#default_value' => variable_get('redhen_contact_connect_users', FALSE),
    ),
  );
}

/**
 * Alter the list of excluded filter field types.
 *
 * @param array $blacklist
 */
function hook_redhen_filter_form_blacklist_alter(array &$blacklist) {
  $blacklist[] = 'image';
}

Functions

Name	Description
hook_redhen_contact_can_delete	Prevent a contact record from being deleted.
hook_redhen_contact_name_alter	Alter the display name for a contact.
hook_redhen_contact_set_state	Act on a state change for a contact.
hook_redhen_contact_user_update	Act on the contact when the link to a drupal user account is modified
hook_redhen_entity_predelete	Allow modules to act before an entity is deleted.
hook_redhen_filter_form_blacklist_alter	Alter the list of excluded filter field types.
hook_redhen_org_can_delete	Prevent an organization record from being deleted.
hook_redhen_settings	Provide a form API element exposed as a RedHen setting.