registration.field.inc in Entity Registration 7.2
Same filename and directory in other branches
Field hooks.
File
includes/registration.field.incView source
<?php
/**
* @file
* Field hooks.
*/
/**
* Implements hook_field_info().
*/
function registration_field_info() {
return array(
'registration' => array(
'label' => t('Registration'),
'description' => t('Enables registrations of a selected type for an entity.'),
'settings' => array(),
'instance_settings' => array(
'default_registration_settings' => array(
'status' => 0,
'capacity' => 0,
'scheduling' => array(
'open' => NULL,
'open_date_token' => NULL,
'close' => NULL,
'close_date_token' => NULL,
),
'reminder' => array(
'send_reminder' => 0,
'reminder_settings' => array(
'reminder_date' => NULL,
'reminder_template' => NULL,
),
),
'settings' => array(
'maximum_spaces' => 1,
'multiple_registrations' => -1,
'from_address' => variable_get('site_mail', ini_get('sendmail_from')),
),
),
),
'property_type' => 'text',
'default_widget' => 'registration_select',
'default_formatter' => 'registration_default',
'no_ui' => FALSE,
),
);
}
/**
* Implements hook_field_instance_settings_form().
*
* Add default registration field instance settings.
*/
function registration_field_instance_settings_form($field, $instance) {
$form = $form_state = array();
$default_settings = isset($instance['settings']['default_registration_settings']) ? $instance['settings']['default_registration_settings'] : array();
// Flatten scheduling and reminder settings since this form is in tree mode.
foreach ($default_settings as $key => $val) {
if ($key != 'settings' and is_array($val)) {
foreach ($val as $key1 => $val1) {
if (is_array($val1)) {
foreach ($val1 as $key2 => $val2) {
$default_settings[$key2] = $val2;
}
}
else {
$default_settings[$key1] = $val1;
}
}
unset($default_settings[$key]);
}
}
$settings_form = registration_entity_settings_form($form, $form_state, $default_settings);
$form['default_registration_settings'] = array(
'#type' => 'fieldset',
'#title' => t('Default Registration settings'),
'#collapsible' => TRUE,
'#description' => t("These settings will be applied when an entity with this field is saved and does not yet have its own settings applied."),
);
// Unset the save button just in case.
unset($settings_form['save']);
$form['default_registration_settings'] += $settings_form;
$form['hide_register_tab'] = array(
'#type' => 'checkbox',
'#title' => t('Hide Register Tab'),
'#default_value' => isset($instance['settings']['hide_register_tab']) ? $instance['settings']['hide_register_tab'] : 0,
'#required' => FALSE,
'#description' => t('Hide the tab on the content displaying the registration form. The form can still be embedded or linked to by changing the field display settings.'),
);
// @todo: validation
return $form;
}
/**
* Implements hook_field_validate().
*/
function registration_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {
}
/**
* Implements hook_field_is_empty().
*/
function registration_field_is_empty($item, $field) {
if (empty($item['registration_type']) && (string) $item['registration_type'] !== '') {
return TRUE;
}
return FALSE;
}
/**
* Implements hook_field_widget_info().
*/
function registration_field_widget_info() {
return array(
'registration_select' => array(
'label' => t('Registration Type'),
'field types' => array(
'registration',
),
'settings' => array(),
'behaviors' => array(
'multiple values' => FIELD_BEHAVIOR_DEFAULT,
'default value' => FIELD_BEHAVIOR_DEFAULT,
),
),
);
}
/**
* Implements hook_field_widget_form().
*/
function registration_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
$options = array(
'' => t('-- Disable Registrations --'),
);
foreach (registration_get_types() as $type) {
$options[$type->name] = $type->label;
}
$element += array(
'#type' => 'select',
'#options' => $options,
'#default_value' => isset($items[$delta]) ? $items[$delta] : array(),
);
// force some help text into the field, appending anything the user added.
$element['#description'] .= ' ' . t('Select what type of registrations should be
enabled for this @type. Depending on the display settings, it will appear
as either string, registration link, or form.', array(
'@type' => $instance['bundle'],
));
return array(
'registration_type' => $element,
);
}
/**
* Implements hook_field_formatter_info().
*/
function registration_field_formatter_info() {
return array(
'registration_link' => array(
'label' => t('Registration Link'),
'field types' => array(
'registration',
),
'settings' => array(
'label' => NULL,
'i18n_string_key' => NULL,
),
),
'registration_form' => array(
'label' => t('Registration Form'),
'field types' => array(
'registration',
),
),
'registration_type' => array(
'label' => t('Registration Type'),
'field types' => array(
'registration',
),
),
);
}
/**
* Implements hook_field_formatter_settings_form().
*/
function registration_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
$display = $instance['display'][$view_mode];
$settings = $display['settings'];
$element = array();
if ($display['type'] == 'registration_link') {
$element['label'] = array(
'#title' => t('Label'),
'#type' => 'textfield',
'#size' => 20,
'#default_value' => $settings['label'],
'#required' => FALSE,
'#description' => t("Optional label to use when displaying the registration title or link. Leave blank to use the parent event's label."),
);
// Store a key so we can store/retrieve translated strings for this field
// formatter instance.
$element['i18n_string_key'] = array(
'#type' => 'value',
'#value' => implode(':', array(
$instance['entity_type'],
$instance['bundle'],
$view_mode,
$instance['field_name'],
)),
);
}
// Since we have translatable strings, we'll need to register them when the
// form is submitted.
$element['#process'][] = 'registration_field_formatter_settings_form_process';
return $element;
}
/**
* Form element process handler for registration_field_formatter_settings_form().
*/
function registration_field_formatter_settings_form_process($element, &$form_state, &$form) {
// For reasons I don't fully understand, when you click the gear button to
// open the settings, $form_state['submitted'] === TRUE; but after you set the
// settings and click the 'Update' button, $form_state['submitted'] === FALSE.
// Furthermore, it's impossible to add a submit handler to this sub-form or
// the 'Manage Display' form as a whole.
//
// Anyway, to avoid blowing away the string translation if the user just
// wants to look at the string without changing it.
if ($form_state['submitted'] === FALSE) {
_registration_translate_update($element['i18n_string_key']['#value'] . ':label', $element['label']['#default_value']);
}
return $element;
}
/**
* Implements hook_field_formatter_settings_summary().
*/
function registration_field_formatter_settings_summary($field, $instance, $view_mode) {
$display = $instance['display'][$view_mode];
$settings = $display['settings'];
$summary = '';
if ($display['type'] == 'registration_link') {
if (!empty($settings['label'])) {
$summary = t('Registration label: @label.', array(
'@label' => $settings['label'],
));
}
else {
$summary = t('Registration label: Parent label.');
}
}
return $summary;
}
/**
* Implements hook_field_formatter_view().
*/
function registration_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
$element = array();
// we know we should only have a single item
if (isset($items[0]['registration_type']) && !empty($items[0]['registration_type'])) {
$reg_type = registration_type_load($items[0]['registration_type']);
$settings = $display['settings'];
$label = !empty($settings['label']) ? _registration_translate($settings['i18n_string_key'] . ':label', $settings['label']) : $reg_type->label;
list($entity_id) = entity_extract_ids($entity_type, $entity);
switch ($display['type']) {
case 'registration_link':
// Enable registration link if accessible.
if (registration_register_page_access($entity_type, $entity) && registration_status($entity_type, $entity_id)) {
$uri = entity_uri($entity_type, $entity);
$element[0] = array(
'#markup' => theme('registration_link', array(
'label' => $label,
'path' => $uri['path'] . '/register',
'registration type' => $reg_type,
'entity_type' => $entity_type,
'entity' => $entity,
)),
);
}
break;
case 'registration_form':
// Enable registration form if accessible.
if (registration_register_page_access($entity_type, $entity) && registration_status($entity_type, $entity_id)) {
$registration = entity_get_controller('registration')
->create(array(
'entity_type' => $entity_type,
'entity_id' => $entity_id,
'type' => $reg_type->name,
));
$element[0] = drupal_get_form('registration_form', $registration);
}
break;
case 'registration_type':
$element[0] = array(
'#markup' => $label,
);
break;
}
}
return $element;
}
/**
* Implements hook_form_FORM_ID_alter().
*
* Hide the cardinality setting on the field settings for registration fields.
*/
function registration_form_field_ui_field_edit_form_alter(&$form, &$form_state, $form_id) {
if ($form['#field']['type'] == 'registration') {
$form['field']['cardinality']['#default_value'] = 1;
$form['field']['cardinality']['#access'] = FALSE;
$form['#validate'][] = 'registration_form_field_ui_field_edit_form_validate';
}
}
/**
* Validation handler for registration_form_field_ui_field_edit_form.
*
* Ensure cardinality is set to 1 on registration fields.
*
* @param $form
* @param $form_state
*/
function registration_form_field_ui_field_edit_form_validate(&$form, &$form_state) {
if ($form['#field']['type'] == 'registration') {
if ($form_state['values']['field']['cardinality'] !== 1) {
form_set_error('cardinality', t('Cardinality on registration fields must be set to one.'));
}
// Validate default registration settings.
$default_settings = $form_state['values']['instance']['settings']['default_registration_settings'];
$base_elem_key = 'instance][settings][default_registration_settings][';
// Ensure capacity is a positive integer.
$capacity = $default_settings['capacity'];
if (!is_numeric($capacity) || (int) $capacity != $capacity || $capacity < 0) {
form_set_error($base_elem_key . 'capacity', t('Capacity must be a positive integer.'));
}
// Validate from address.
if (!valid_email_address($default_settings['settings']['from_address'])) {
form_set_error($base_elem_key . 'settings][from_address', t('From email address is invalid.'));
}
// Validate open date.
if (!empty($default_settings['scheduling']['open']) && strtotime($default_settings['scheduling']['open']) === FALSE) {
form_set_error($base_elem_key . 'scheduling][open', t('Date is invalid.'));
}
// Validate close date.
if (!empty($default_settings['scheduling']['close']) && strtotime($default_settings['scheduling']['close']) === FALSE) {
form_set_error($base_elem_key . 'scheduling][close', t('Date is invalid.'));
}
// If sending a reminder, ensure date and template are set.
if ($default_settings['reminder']['send_reminder'] && (empty($default_settings['reminder']['reminder_settings']['reminder_date']) || empty($default_settings['reminder']['reminder_settings']['reminder_template']))) {
form_set_error($base_elem_key . 'reminder][send_reminder', t('If sending a reminder, provide a date and template.'));
}
// Validate reminder date.
if (!empty($default_settings['reminder']['reminder_settings']['reminder_date']) && strtotime($default_settings['reminder']['reminder_settings']['reminder_date']) === FALSE) {
form_set_error($base_elem_key . 'reminder][reminder_settings][reminder_date', t('Reminder date is invalid.'));
}
}
}
/**
* Implements hook_form_FORM_ID_alter().
*
* Add a validation handler for registration_form_field_ui_field_overview_form().
*
* @param $form
* @param $form_state
* @param $form_id
*/
function registration_form_field_ui_field_overview_form_alter(&$form, &$form_state, $form_id) {
$form['#validate'][] = 'registration_form_field_ui_field_overview_form_validate';
}
/**
* Validation callback for registration_form_field_ui_field_overview_form().
*
* Ensure only one registration field is added per entity.
*
* @param $form
* @param $form_state
*/
function registration_form_field_ui_field_overview_form_validate(&$form, &$form_state) {
$fields = $form_state['values']['fields'];
if ($fields['_add_new_field']['type'] == 'registration') {
foreach ($form['#fields'] as $field_name) {
$field = field_info_field($field_name);
if ($field['type'] == 'registration') {
form_set_error('_add_new_field', t('An entity can only have one registration field.'));
}
}
}
}
/**
* Implements hook_field_create_instance().
*/
function registration_field_create_instance($instance) {
// Rebuild menu to recognize registration paths.
_registration_menu_rebuild($instance);
}
/**
* Implements hook_field_delete_instance().
*/
function registration_field_delete_instance($instance) {
// Remove registration paths from menu router.
_registration_menu_rebuild($instance);
// @TODO: should we delete all registrations at this point?
}
/**
* Implements hook_field_update_instance().
*
* Rebuild the menu if the registration tab setting has changed.
*/
function registration_field_update_instance($instance, $prior_instance) {
$prev = isset($prior_instance['settings']['hide_register_tab']) ? $prior_instance['settings']['hide_register_tab'] : NULL;
$cur = isset($instance['settings']['hide_register_tab']) ? $instance['settings']['hide_register_tab'] : NULL;
if ($prev != $cur) {
_registration_menu_rebuild($instance);
}
}
/**
* Rebuild the menu for a given registraiton field instance.
*
* @param $instance
* Field instance being added or deleted.
*/
function _registration_menu_rebuild($instance) {
$registration_fields = field_read_fields(array(
'type' => 'registration',
));
if (in_array($instance['field_name'], array_keys($registration_fields))) {
menu_rebuild();
}
}