bat_event.admin.inc in Booking and Availability Management Tools for Drupal 7

Unit event editing UI.
We make very little use of the EntityAPI interface for this, preferring instead to use views. This offers more flexibility to change a UI that will, more often than not, be end-user facing.
File

modules/bat_event/bat_event.admin.inc
View source
<?php

/**
 * @file
 * Unit event editing UI.
 *
 * We make very little use of the EntityAPI interface for this, preferring
 * instead to use views. This offers more flexibility to change a UI that will,
 * more often than not, be end-user facing.
 */
use Roomify\Bat\Event\Event;
use Roomify\Bat\Calendar\Calendar;
use Roomify\Bat\Store\DrupalDBStore;
use Roomify\Bat\Unit\Unit;

/**
 * UI controller.
 */
class BatEventUIController extends EntityDefaultUIController {

  /**
   * Overrides hook_menu() defaults.
   *
   * The main reason for doing this is that the
   * parent class hook_menu() is optimized for entity type administration.
   */
  public function hook_menu() {
    $items = array();
    $id_count = count(explode('/', $this->path));
    $wildcard = isset($this->entityInfo['admin ui']['menu wildcard']) ? $this->entityInfo['admin ui']['menu wildcard'] : '%' . $this->entityType;
    $items[$this->path] = array(
      'title' => 'Events',
      'description' => 'Add edit and update events.',
      'page callback' => 'system_admin_menu_block_page',
      'access arguments' => array(
        'access administration pages',
      ),
      'file path' => drupal_get_path('module', 'system'),
      'file' => 'system.admin.inc',
      'weight' => 10,
    );

    // Change the add page menu to multiple types of entities.
    $items[$this->path . '/add'] = array(
      'title' => 'Add an Event',
      'description' => 'Add a new Event',
      'page callback' => 'bat_event_add_page',
      'access callback' => 'bat_event_add_access',
      'type' => MENU_NORMAL_ITEM,
      'weight' => 20,
      'file' => 'bat_event.admin.inc',
      'file path' => drupal_get_path('module', $this->entityInfo['module']),
    );

    // Add menu items to add each different type of unit.
    foreach (bat_event_get_types() as $type) {
      $items[$this->path . '/add/' . $type->type] = array(
        'title' => 'Add @event_type',
        'title arguments' => array(
          '@event_type' => $type->label,
        ),
        'page callback' => 'bat_event_create_form_wrapper',
        'page arguments' => array(
          $type->type,
        ),
        'access callback' => 'bat_event_access',
        'access arguments' => array(
          'create',
          bat_event_create(array(
            'type' => $type->type,
            'uid' => 0,
          )),
        ),
        'file' => 'bat_event.admin.inc',
        'file path' => drupal_get_path('module', $this->entityInfo['module']),
      );
    }

    // Menu items for loading and editing Unit entities.
    $items[$this->path . '/event/' . $wildcard] = array(
      'page callback' => 'bat_event_form_wrapper',
      'page arguments' => array(
        $id_count + 1,
      ),
      'access callback' => 'bat_event_access',
      'access arguments' => array(
        'update',
        $id_count + 1,
      ),
      'weight' => 0,
      'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
      'file' => 'bat_event.admin.inc',
      'file path' => drupal_get_path('module', $this->entityInfo['module']),
    );
    $items[$this->path . '/event/' . $wildcard . '/edit'] = array(
      'title' => 'Edit',
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10,
      'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
    );
    $items[$this->path . '/event/' . $wildcard . '/delete'] = array(
      'title' => 'Delete',
      'page callback' => 'bat_event_delete_form_wrapper',
      'page arguments' => array(
        $id_count + 1,
      ),
      'access callback' => 'bat_event_access',
      'access arguments' => array(
        'delete',
        $id_count + 1,
      ),
      'type' => MENU_LOCAL_TASK,
      'context' => MENU_CONTEXT_INLINE,
      'weight' => 10,
      'file' => 'bat_event.admin.inc',
      'file path' => drupal_get_path('module', $this->entityInfo['module']),
    );

    // Menu item for viewing units.
    $items['event/' . $wildcard] = array(
      'title callback' => 'bat_event_page_title',
      'title arguments' => array(
        1,
      ),
      'page callback' => 'bat_event_page_view',
      'page arguments' => array(
        1,
      ),
      'access callback' => 'bat_event_access',
      'access arguments' => array(
        'view',
        1,
      ),
      'type' => MENU_CALLBACK,
    );
    return $items;
  }

  /**
   * Create the markup for the add Event Entities page within the class
   * so it can easily be extended/overriden.
   */
  public function addPage() {
    $item = menu_get_item();
    $content = system_admin_menu_block($item);
    if (count($content) == 1) {
      $item = array_shift($content);
      drupal_goto($item['href']);
    }
    return array(
      '#theme' => 'bat_event_add_list',
      '#content' => $content,
    );
  }

}

/**
 * Form callback wrapper: edit a Event.
 *
 * @param BatEvent $event
 *   The BatEvent object being edited by this form.
 *
 * @see bat_event_edit_form()
 */
function bat_event_form_wrapper(BatEvent $event) {

  // Add the breadcrumb for the form's location.
  bat_event_set_breadcrumb();

  // Set the page title.
  $type = bat_event_get_types($event->type);
  drupal_set_title(t('#!event_id - !event_type', array(
    '!event_type' => $type->label,
    '!event_id' => $event->event_id,
  )));
  return drupal_get_form('bat_event_edit_form', $event);
}

/**
 * Form callback wrapper: create a Event.
 *
 * @param string $type
 */
function bat_event_create_form_wrapper($type) {
  global $user;

  // Add the breadcrumb for the form's location.
  bat_event_set_breadcrumb();

  // Create a event object.
  $event = bat_event_create(array(
    'type' => $type,
  ));
  $event->created = REQUEST_TIME;
  $event->uid = $user->uid;
  return drupal_get_form('bat_event_edit_form', $event);
}

/**
 * Form callback wrapper: delete a event.
 *
 * @param BatEvent $event
 *   The event object being edited by this form.
 *
 * @see bat_event_edit_form()
 */
function bat_event_delete_form_wrapper(BatEvent $event) {

  // Add the breadcrumb for the form's location.
  bat_event_set_breadcrumb();
  return drupal_get_form('bat_event_delete_form', $event);
}

/**
 * Form callback: create or edit a event.
 *
 * @param BatEvent $event
 *   The BatEvent object to edit, or for a new event form, an empty event object
 *     with only an event type defined.
 */
function bat_event_edit_form($form, &$form_state, BatEvent $event) {
  $event->date = format_date($event->created, 'custom', 'Y-m-d H:i:s O');
  $account = user_load($event->uid);
  $event->owner_name = $account->name;
  if ($event->end_date_object) {

    // We are about to display an event, so we to add a minute to then end date.
    $event->end_date_object
      ->add(new DateInterval('PT1M'));

    // Re-set the end date string to reflect the change.
    $event->end_date = $event->end_date_object
      ->format('Y-m-d H:i:s');
  }
  $form['#attributes']['class'][] = 'bat-management-form bat-event-form';
  $form['#attached'] = array(
    'js' => array(
      drupal_get_path('module', 'bat') . '/js/bat_date_popup.js',
    ),
  );
  $form['type'] = array(
    '#type' => 'value',
    '#value' => $event->type,
  );
  $form['data']['#tree'] = TRUE;

  // A fieldset to hold the date range fields.
  $form['bat_date_range'] = array(
    '#type' => 'fieldset',
    '#title' => t('Event dates'),
    '#attributes' => array(
      'class' => array(
        'bat-event-date-range-wrapper',
      ),
    ),
    '#weight' => -1,
  );
  $event_type = bat_event_type_load($event->type);
  $form['bat_date_range'] += bat_date_range_fields(NULL, NULL, $event_type->event_granularity);

  // Unset the default for max days away for events since we are on the admin.
  drupal_add_js(array(
    'bat' => array(
      'batEventStartDay' => 0,
    ),
  ), 'setting');

  // Set the default values for the dates.
  $form['bat_date_range']['bat_start_date']['#default_value'] = isset($event->start_date) ? $event->start_date : '';
  $form['bat_date_range']['bat_end_date']['#default_value'] = isset($event->end_date) ? $event->end_date : '';

  // Check the start and end dates to avoid damage from dirty input.
  $startdate = '';
  if (isset($_GET['startdate'])) {
    $startdate = is_numeric(check_plain($_GET['startdate'])) ? check_plain($_GET['startdate']) : '';
    if ($startdate != '') {
      $form['bat_date_range']['bat_start_date']['#default_value'] = gmdate('Y-m-d', $startdate);
    }
  }
  $enddate = '';
  if (isset($_GET['enddate'])) {
    $enddate = is_numeric(check_plain($_GET['enddate'])) ? check_plain($_GET['enddate']) : '';
    if ($enddate != '') {
      $form['bat_date_range']['bat_end_date']['#default_value'] = gmdate('Y-m-d', $enddate);
    }
  }

  // Add the field related form elements.
  $form_state['bat_event'] = $event;
  field_attach_form('bat_event', $event, $form, $form_state);

  // Construct target entity reference field name using this event type's target entity type.
  $target_field_name = 'event_' . $event_type->target_entity_type . '_reference';
  isset($form[$target_field_name]['#language']) ? $language = $form[$target_field_name]['#language'] : ($language = LANGUAGE_NONE);
  $targetid = '';
  if (isset($_GET['targetid'])) {
    $targetid = check_plain($_GET['targetid']);
    if ($target_entity = entity_load_single($event_type->target_entity_type, $targetid)) {
      $form[$target_field_name][$language][0]['target_id']['#default_value'] = $target_entity->name . ' (' . $targetid . ')';
    }
  }

  // The unit reference value should be mandatory.
  $form[$target_field_name][$language][0]['target_id']['#required'] = TRUE;
  if ($event_type->fixed_event_states && isset($form['event_state_reference'][$language][0]['state_id'])) {
    $form['event_state_reference'][$language][0]['state_id']['#required'] = TRUE;
  }
  else {
    $field_name = $event_type->default_event_value_field_ids[$event_type->type];
    if (isset($form[$field_name][$language][0]['amount']['#required'])) {
      $form[$field_name][$language][0]['amount']['#required'] = TRUE;
    }
    elseif (isset($form[$field_name][$language][0]['value']['#required'])) {
      $form[$field_name][$language][0]['value']['#required'] = TRUE;
    }
  }

  // Management vertical tabs.
  $form['additional_settings'] = array(
    '#type' => 'vertical_tabs',
    '#weight' => 99,
  );

  // Add the user account and e-mail fields.
  $form['user'] = array(
    '#type' => 'fieldset',
    '#title' => t('User information'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#access' => user_access('bypass bat_event entities access'),
    '#group' => 'additional_settings',
    '#attached' => array(
      'js' => array(
        drupal_get_path('module', 'bat_event') . '/js/bat_event.js',
        array(
          'type' => 'setting',
          'data' => array(
            'anonymous' => variable_get('anonymous', t('Anonymous')),
          ),
        ),
      ),
    ),
    '#weight' => 30,
  );
  $form['user']['owner_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Owned by'),
    '#description' => t('Leave blank for %anonymous.', array(
      '%anonymous' => variable_get('anonymous', t('Anonymous')),
    )),
    '#maxlength' => 60,
    '#autocomplete_path' => 'user/autocomplete',
    '#default_value' => !empty($event->owner_name) ? $event->owner_name : '',
    '#weight' => -1,
  );

  // Add a log checkbox and timestamp field to a history tab.
  $form['event_history'] = array(
    '#type' => 'fieldset',
    '#title' => t('Event history'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
    '#group' => 'additional_settings',
    '#attached' => array(
      'js' => array(
        drupal_get_path('module', 'bat_event') . '/js/bat_event.js',
      ),
    ),
    '#weight' => 40,
  );
  $form['event_history']['date'] = array(
    '#type' => 'textfield',
    '#title' => t('Created on'),
    '#description' => t('Format: %time. The date format is YYYY-MM-DD and %timezone is the time zone offset from UTC. Leave blank to use the time of form submission.', array(
      '%time' => !empty($event->date) ? date_format(date_create($event->date), 'Y-m-d H:i:s O') : format_date($event->created, 'custom', 'Y-m-d H:i:s O'),
      '%timezone' => !empty($event->date) ? date_format(date_create($event->date), 'O') : format_date($event->created, 'custom', 'O'),
    )),
    '#maxlength' => 25,
    '#default_value' => !empty($event->created) ? format_date($event->created, 'custom', 'Y-m-d H:i:s O') : '',
  );
  $form['event_history']['created'] = array(
    '#type' => 'hidden',
    '#value' => !empty($event->created) ? format_date($event->created, 'short') : '',
    '#attributes' => array(
      'id' => 'edit-created',
    ),
  );
  $form['event_history']['changed'] = array(
    '#type' => 'hidden',
    '#value' => !empty($event->changed) ? format_date($event->changed, 'short') : '',
    '#attributes' => array(
      'id' => 'edit-changed',
    ),
  );
  $form['actions'] = array(
    '#type' => 'container',
    '#attributes' => array(
      'class' => array(
        'form-actions',
      ),
    ),
    '#weight' => 400,
  );

  // We add the form's #submit array to this button along with the actual submit
  // handler to preserve any submit handlers added by a form callback_wrapper.
  $submit = array();
  if (!empty($form['#submit'])) {
    $submit += $form['#submit'];
  }
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save Event'),
    '#submit' => $submit + array(
      'bat_event_edit_form_submit',
    ),
  );
  if (!isset($event->is_new) && bat_event_access('delete', $event)) {
    $form['actions']['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete Event'),
      '#submit' => $submit + array(
        'bat_event_form_submit_delete',
      ),
      '#weight' => 45,
    );
  }

  // Depending on whether the form is in a popup or a normal page we need to change
  // the behavior of the cancel button.
  if (isset($form_state['ajax']) && $form_state['ajax'] == TRUE) {
    unset($form['actions']['cancel']);
  }
  else {
    $form['actions']['cancel'] = array(
      '#markup' => l(t('Cancel'), 'admin/bat/events'),
      '#weight' => 50,
    );
  }
  $event_type = bat_event_type_load($event->type);
  if ($event_type->event_granularity == 'bat_hourly') {
    $form['bat_date_range']['bat_start_date']['#date_format'] = variable_get('bat_date_format', 'Y-m-d H:i');
    $form['bat_date_range']['bat_end_date']['#date_format'] = variable_get('bat_date_format', 'Y-m-d H:i');
  }

  // We append the validate handler to #validate in case a form callback_wrapper
  // is used to add validate handlers earlier.
  $form['#validate'][] = 'bat_form_start_end_dates_validate';
  $form['#validate'][] = 'bat_event_edit_form_validate';
  module_load_include('inc', 'composer_manager', 'composer_manager.admin');
  $composer_manager_installed_packages = composer_manager_installed_packages();
  if (!isset($composer_manager_installed_packages['roomify/bat'])) {
    drupal_set_message(t('Please install the BAT PHP Library. For instructions click <a target="_blank" href="@link">here</a>.', array(
      '@link' => 'http://docs.roomify.us/bat/drupal/installation.html#install-bat-php-library',
    )), 'error');
    $form['actions']['submit']['#disabled'] = TRUE;
    if (isset($form['actions']['delete'])) {
      $form['actions']['delete']['#disabled'] = TRUE;
    }
  }
  return $form;
}

/**
 * Form API validate callback for the event form.
 */
function bat_event_edit_form_validate(&$form, &$form_state) {

  // Notify field widgets to validate their data.
  entity_form_field_validate('bat_event', $form, $form_state);
  $event_type = bat_event_type_load($form_state['values']['type']);
  $target_field_name = 'event_' . $event_type->target_entity_type . '_reference';
  if ($event_type->fixed_event_states) {
    if ($form_state['values']['bat_start_date'] != '' && $form_state['values']['bat_end_date'] != '' && $form_state['values'][$target_field_name][LANGUAGE_NONE][0]['target_id'] != '') {
      $event_store = new DrupalDBStore($event_type->type, DrupalDBStore::BAT_EVENT, bat_get_db_prefix());
      $start_date = new DateTime($form_state['values']['bat_start_date']);
      $end_date = new DateTime($form_state['values']['bat_end_date']);
      $end_date
        ->sub(new DateInterval('PT1M'));
      $unit = bat_unit_load($form_state['values'][$target_field_name][LANGUAGE_NONE][0]['target_id']);
      $bat_units = array(
        new Unit($unit->unit_id, 0),
      );
      $calendar = new Calendar($bat_units, $event_store);
      $events = $calendar
        ->getEvents($start_date, $end_date);
      foreach ($events[$unit->unit_id] as $event) {
        $event_id = $event
          ->getValue();
        if ($event_id != $form_state['bat_event']->event_id) {
          if ($event = bat_event_load($event_id)) {
            $state = bat_event_load_state($event->event_state_reference[LANGUAGE_NONE][0]['state_id']);
            if ($state['blocking']) {
              form_set_error('', t('Cannot save this event as an event in a blocking state exists within the same timeframe.'));
              break;
            }
          }
        }
      }
    }
  }
}

/**
 * Form API submit callback for the Event form.
 */
function bat_event_edit_form_submit(&$form, &$form_state) {

  // We also need appropriate named variables for start and end date.
  // It's simpler to do this than change all the other code for now.
  $form_state['values']['start_date'] = $form_state['values']['bat_start_date'];
  $form_state['values']['end_date'] = $form_state['values']['bat_end_date'];

  // If we are dealing with a new event.
  if ($form_state['bat_event']->event_id == '') {
    $event = bat_event_create(array(
      'type' => $form_state['bat_event']->type,
      'start_date' => $form_state['values']['start_date'],
      'end_date' => $form_state['values']['end_date'],
    ));
    $form_state['bat_event'] = $event;
    $event = entity_ui_controller('bat_event')
      ->entityFormSubmitBuildEntity($form, $form_state);
    $event->is_new = isset($event->is_new) ? $event->is_new : 0;
  }
  else {
    $event = entity_ui_controller('bat_event')
      ->entityFormSubmitBuildEntity($form, $form_state);
  }

  // Subtract one minute from the end date since BAT considers the last minute of an event included.
  $end_date = new DateTime($event->end_date);
  $end_date
    ->sub(new DateInterval('PT1M'));
  $event->end_date = $end_date
    ->format('Y-m-d H:i');

  // Add in created and changed times.
  $event->created = !empty($event->date) ? strtotime($event->date) : REQUEST_TIME;
  $event->changed = time();

  // Add in the event owner.
  if ($account = user_load_by_name($event->owner_name)) {
    $event->uid = $account->uid;
  }
  else {
    $event->uid = 0;
  }

  // Save event.
  $event
    ->save();

  // Add the event to $form_state to be altered by other submit handlers.
  $form_state['event'] = $event;
  $form_state['redirect'] = 'admin/bat/events';
}

/**
 * Form API submit callback for the delete button.
 */
function bat_event_form_submit_delete($form, &$form_state) {
  if (isset($form_state['ajax'])) {
    $event = bat_event_load($form_state['bat_event']->event_id, TRUE);
    bat_event_delete($event);
    drupal_set_message(t('The event has been removed'));
    $form_state['event_deleted'] = TRUE;
  }
  else {
    $destination = array();
    if (isset($_GET['destination'])) {
      $destination = drupal_get_destination();
      unset($_GET['destination']);
    }
    $form_state['redirect'] = array(
      'admin/bat/events/event/' . $form_state['bat_event']->event_id . '/delete',
      array(
        'query' => $destination,
      ),
    );
  }
}

/**
 * Form callback: confirmation form for deleting a event.
 *
 * @param BatEvent $event
 *   The event to delete.
 *
 * @see confirm_form()
 */
function bat_event_delete_form($form, &$form_state, BatEvent $event) {
  $form_state['bat_event'] = $event;
  $form['#submit'][] = 'bat_event_delete_form_submit';
  $form = confirm_form($form, t('Are you sure you want to delete Event ?'), 'admin/bat/events/event', '<p>' . t('This action cannot be undone.') . '</p>', t('Delete'), t('Cancel'), 'confirm');
  return $form;
}

/**
 * Submit callback for event_delete_form.
 */
function bat_event_delete_form_submit($form, &$form_state) {
  $event = $form_state['bat_event'];
  bat_event_delete($event);
  drupal_set_message(t('The event has been deleted.'));
  watchdog('bat', 'Deleted event %event_id.', array(
    '%event_id' => $event->event_id,
  ));
  $form_state['redirect'] = 'admin/bat/events';
}

/**
 * Page to add Units.
 *
 * @todo Pass this through a proper theme function
 */
function bat_event_add_page() {
  $controller = entity_ui_controller('bat_event');
  return $controller
    ->addPage();
}

/**
 * Displays the list of available unit bundles for unit creation.
 *
 * @ingroup themeable
 */
function theme_bat_event_add_list($variables) {
  $content = $variables['content'];
  if ($content) {
    $output = '<dl class="event-type-list">';
    foreach ($content as $item) {
      $output .= '<dt>' . l($item['title'], $item['href']) . '</dt>';
      $output .= '<dd>' . filter_xss_admin($item['description']) . '</dd>';
    }
    $output .= '</dl>';
  }
  else {
    if (user_access('administer event types')) {
      $output = '<p>' . t('Events cannot be added because you have not created any event types yet. Go to the <a href="@create-event-type">event type creation page</a> to add a new event type.', array(
        '@create-event-type' => url('admin/bat/events/event-types/add'),
      )) . '</p>';
    }
    else {
      $output = '<p>' . t('No event types have been created yet for you to use.') . '</p>';
    }
  }
  return $output;
}

/**
 * Sets the breadcrumb for administrative BAT pages.
 */
function bat_event_set_breadcrumb() {
  $breadcrumb = array(
    l(t('Home'), '<front>'),
    drupal_valid_path('admin') ? l(t('Administration'), 'admin') : '',
    drupal_valid_path('admin/bat') ? l(t('BAT'), 'admin/bat') : '',
    drupal_valid_path('admin/bat/events') ? l(t('Events'), 'admin/bat/events') : '',
  );
  drupal_set_breadcrumb(array_filter($breadcrumb));
}
Functions

Name	Description
bat_event_add_page	Page to add Units.
bat_event_create_form_wrapper	Form callback wrapper: create a Event.
bat_event_delete_form	Form callback: confirmation form for deleting a event.
bat_event_delete_form_submit	Submit callback for event_delete_form.
bat_event_delete_form_wrapper	Form callback wrapper: delete a event.
bat_event_edit_form	Form callback: create or edit a event.
bat_event_edit_form_submit	Form API submit callback for the Event form.
bat_event_edit_form_validate	Form API validate callback for the event form.
bat_event_form_submit_delete	Form API submit callback for the delete button.
bat_event_form_wrapper	Form callback wrapper: edit a Event.
bat_event_set_breadcrumb	Sets the breadcrumb for administrative BAT pages.
theme_bat_event_add_list	Displays the list of available unit bundles for unit creation.
Classes

Name	Description
BatEventUIController	UI controller.
You are here

bat_event.admin.inc in Booking and Availability Management Tools for Drupal 7

File

Functions

Classes

API Navigation
