invite.api.php in Invite 7.4

Hooks provided by the Invite.

File

invite.api.php

<?php

/**
 * @file
 * Hooks provided by the Invite.
 */

/**
 * Allow other modules to act on invite's withdrawn.
 *
 * @param Invite $invite
 *   Invite object.
 */
function hook_invite_withdraw($invite) {

  // Delete notifications when user withdrawn invitation.
  db_delete('invite_notifications')
    ->condition('iid', $invite->iid)
    ->execute();
}

/**
 * Allow other modules to act when invite accepted.
 *
 * @param Invite $invite
 *   Invite object.
 */
function hook_invite_accept($invite) {
  global $user;

  // Add message, when user accepts invite.
  $message = array(
    'iid' => $invite->iid,
    'uid' => $invite->uid,
    'inviter' => $invite->uid,
    'invitee' => $invite->invitee,
    'message_type' => 'inviter_notification',
  );
  drupal_write_record('invite_notifications', $message);
}

/**
 * Alters target roles for user.
 *
 * Used when needed to add/change resulting roles for user.
 *
 * @param array $targets
 *   Array of roles which will be added to invited user account.
 * @param Invite $invite
 *   Invite object.
 * @param object $account
 *   Invited user account object.
 */
function hook_invite_target_roles_alter($targets, $invite, $account) {

  // Add 'friday invited' role if user registering on Friday.
  if (date("N", time()) == 5) {
    $targets[ROLE_FRIDAY_INVITED] = ROLE_FRIDAY_INVITED;
  }
}

/**
 * Defines the module as being an invite sending controller.
 *
 * @return array
 *   An array of settings containing the keys:
 *   - label: A human readable, translated label for the controller.
 */
function hook_invite_sending_controller() {
  return array(
    'label' => t('My module invitation controller'),
  );
}

/**
 * Sends the invitation.
 *
 * Called by the Invite::sendInvite() method.
 *
 * @param Invite $invite
 *   The invitation to send.
 */
function hook_invite_send($invite) {
  if (!empty($invite
    ->type_details()->invite_sending_controller['my_module'])) {
    global $language;
    $entity = entity_metadata_wrapper('invite', $invite);
    $params = array(
      'invite' => $invite,
      'wrapper' => $entity,
    );
    $from = $entity->inviter->mail
      ->value();
    drupal_mail('my_module', 'invite', $entity->invitee->mail
      ->value(), $language, $params, $from, TRUE);
  }
}

/**
 * Alter invite_accept message, type and redirect.
 */
function hook_invite_accept_alter($data) {
  $invite = $data['invite'];
  if (!empty($invite->data['gid']) && INVITE_VALID === $invite
    ->status()) {
    $data['redirect'] = 'node/' . $invite->data['gid'];
    $data['message'] = t('Please login or register for an account to begin working on this item.');
    $data['type'] = 'error';
  }
}

Functions

Name	Description
hook_invite_accept	Allow other modules to act when invite accepted.
hook_invite_accept_alter	Alter invite_accept message, type and redirect.
hook_invite_send	Sends the invitation.
hook_invite_sending_controller	Defines the module as being an invite sending controller.
hook_invite_target_roles_alter	Alters target roles for user.
hook_invite_withdraw	Allow other modules to act on invite's withdrawn.