registration.api.php in Entity Registration 8

API documentation for Relation module.

File

registration.api.php

<?php

/**
 * @file
 * API documentation for Relation module.
 */

/**
 * Override registration_access with custom access control logic.
 *
 * @param $op
 * @param Registration $registration
 * @param object $account
 *
 * @return bool
 */
function hook_registration_access($op, $registration, $account = NULL) {
  if ($registration->user_uid == $account->uid) {
    return TRUE;
  }
}

/**
 * Provide a form API element exposed as a Registration entity setting.
 *
 * @param array $settings
 *   Existing settings values.
 *
 * @return array
 *   A FAPI array for a registration setting.
 */
function hook_registration_entity_settings($settings) {
  return array(
    'registration_entity_access_roles' => array(
      '#type' => 'checkboxes',
      '#title' => t('Roles'),
      '#description' => t('Override default access control settings by selecting which roles can register for this event.'),
      '#options' => user_roles(),
      '#default_value' => isset($settings['settings']['registration_entity_access_roles']) ? $settings['settings']['registration_entity_access_roles'] : NULL,
    ),
  );
}

/**
 * Allow modules to override event count.
 *
 * This can impact access control and the ability for users to register.
 *
 * @param int $count
 *
 * @param array $context
 *   array(
 *     'entity_type' => $entity_type,
 *     'entity_id' => $entity_id,
 *     'registration_id' => $registration_id,
 *     'settings' => $settings,
 *   );
 */
function hook_registration_event_count_alter(&$count, $context) {
}

/**
 * Allow modules to alter registration entity settings prior to sending email
 * to all registrants.
 *
 * This could be used, for example, to allow users to opt-out of broadcast
 * emails.
 *
 * @param array $registrations
 *
 * @param array $context
 *   array(
 *     'entity_type' => $entity_type,
 *     'entity_id' => $entity_id,
 *   );
 */
function hook_registration_send_broadcast_alter(&$registrations, $context) {

  // Loop through each registration.
  foreach ($registrations as $reg_id => $registration) {

    // Only send broadcast email for registrations where
    // user registered themself; not other user or anonymous.
    if (!($registration->user_uid == $registration->author_uid) || !empty($registration->anon_mail)) {
      unset($registrations[$reg_id]);
    }
  }
}

/**
 * Allow modules to alter registration entity settings for a specific node type
 * prior to sending email to all registrants.
 *
 * This could be used, for example, to allow users to opt-out of broadcast
 * emails.
 *
 * @param array $registrations
 *
 * @param array $context
 *   array(
 *     'entity_type' => $entity_type,
 *     'entity_id' => $entity_id,
 *   );
 */
function hook_registration_send_broadcast_ENTITY_TYPE_alter(&$registrations, $context) {

  // Loop through each registration.
  foreach ($registrations as $reg_id => $registration) {

    // Only send broadcast email for registrations where
    // user registered themself; not other user or anonymous.
    if (!($registration->user_uid == $registration->author_uid) || !empty($registration->anon_mail)) {
      unset($registrations[$reg_id]);
    }
  }
}

/**
 * Allow modules to alter registration entity settings for a particular entity
 * type and entity ID prior to sending email to all registrants.
 *
 * This could be used, for example, to allow users to opt-out of broadcast
 * emails.
 *
 * @param array $registrations
 *
 * @param array $context
 *   array(
 *     'entity_type' => $entity_type,
 *     'entity_id' => $entity_id,
 *   );
 */
function hook_registration_send_broadcast_ENTITY_TYPE_ID_alter(&$registrations, $context) {

  // Loop through each registration.
  foreach ($registrations as $reg_id => $registration) {

    // Only send broadcast email for registrations where
    // user registered themself; not other user or anonymous.
    if (!($registration->user_uid == $registration->author_uid) || !empty($registration->anon_mail)) {
      unset($registrations[$reg_id]);
    }
  }
}

Functions

Name	Description
hook_registration_access	Override registration_access with custom access control logic.
hook_registration_entity_settings	Provide a form API element exposed as a Registration entity setting.
hook_registration_event_count_alter	Allow modules to override event count.
hook_registration_send_broadcast_alter	Allow modules to alter registration entity settings prior to sending email to all registrants.
hook_registration_send_broadcast_ENTITY_TYPE_alter	Allow modules to alter registration entity settings for a specific node type prior to sending email to all registrants.
hook_registration_send_broadcast_ENTITY_TYPE_ID_alter	Allow modules to alter registration entity settings for a particular entity type and entity ID prior to sending email to all registrants.