availability_calendar.module in Availability Calendars 7.5

File

availability_calendar.module

<?php

/**
 * Availability Calendar module. Defines an availability calendar as a field
 * and as an entity.
 *
 * Originally based on the Availability Calendars Module and the availability
 * module. This file contains the hooks and other functions that must be
 * present in the .module file, except for the field hooks. These can be found
 * in availability_calendar.field.inc.
 *
 * @todo (This is just a list of features that came up while developing and
 * using this module. This is not a roadmap nor is it complete. More todo's can
 * be found in other places in the code.):
 * - decrease size of this module file by moving implementations of rarely
 *   called functions to a separate availability_calendar.cached_hooks.inc.
 * - Separate edit calendar page (reasons: permissions, ease of use)
 * - Add documentation using advanced help
 * - Orphaned calendars: what to do with them and when (cron or another hook)
 * - Changing css class of a state now looses the color style setting (store
 *   based on sid instead of css_class )
 * - Integrate with API's?:
 *   - search
 *   - rules
 * - New coding standards (about documenting param and return types) according
 *   to [#711918]
 * - Allow multiple blocks for the calendar key (each with a different set of
 *   states to show).
 * - Allow to define colors for "extra states" like pastdate.
 * - Check set of states on saving: not all available, not all not available.
 */

// Also defined in Availability Calendars, which can run in parallel.
if (!defined('AC_ISODATE')) {

  /**
   *
   * @const string The date formatter for the ISO 8601 format (date part only).
   */
  define('AC_ISODATE', 'Y-m-d');
}

/**
 * @const string Denotes that a calendar field is used for a full day rental
 *   or allocation use case.
 */
define('AC_ALLOCATION_TYPE_FULLDAY', 'day');

/**
 * @const string Denotes that a calendar field is used for an overnight rental
 *   or allocation use case.
 */
define('AC_ALLOCATION_TYPE_OVERNIGHT', 'night');

/**
 * @const string The default date formatter for displaying dates.
 */
define('AC_DATE_DISPLAY', 'l j F Y');

/**
 * @const string The default date formatter for entering dates.
 */
define('AC_DATE_ENTRY', 'Y-n-j');

/**
 * @const string The default date formatter for hte month caption.
 */
define('AC_DATE_MONTH_CAPTION', 'F Y');

// Load all Field module hooks for Availability Calendar.
module_load_include('inc', 'availability_calendar', 'availability_calendar.field');

// Load all Entity API related hooks for Availability Calendar.
module_load_include('inc', 'availability_calendar', 'availability_calendar.entity');

/**
 * Implements hook_views_api().
 */
function availability_calendar_views_api() {
  return array(
    'api' => '3.0',
    'path' => drupal_get_path('module', 'availability_calendar') . '/views',
  );
}

/**
 * Implements hook_init().
 * @link http://api.drupal.org/api/drupal/modules--system--system.api.php/function/hook_init/7
 *
 * Adds our css files to all pages.
 */
function availability_calendar_init() {

  // CSS is added to all pages to allow for aggregation.
  // Base css.
  drupal_add_css(drupal_get_path('module', 'availability_calendar') . '/availability_calendar.base.css', array(
    'every_page' => TRUE,
  ));

  // Generated CSS.
  $file = 'public://availability_calendar/availability_calendar.css';
  if (is_readable($file)) {
    drupal_add_css($file, array(
      'every_page' => TRUE,
    ));
  }
}

/**
 * Implements hook_permission().
 * @link http://api.drupal.org/api/drupal/modules--system--system.api.php/function/hook_permission/7
 */
function availability_calendar_permission() {
  return array(
    'administer availability calendar' => array(
      'title' => t('Administer the Availability Calendar field'),
      'description' => t('Define the site wide states that can be used by Availability Calendar fields.'),
    ),
    'style availability calendar' => array(
      'title' => t('Define styles for the Availability Calendar field'),
      'description' => t('Define a number of styles for Availability Calendar fields via the UI'),
    ),
  );
}

/**
 * Implements hook_menu().
 * @link http://api.drupal.org/api/drupal/modules--system--system.api.php/function/hook_menu/7
 */
function availability_calendar_menu() {
  $items = array();
  $items['admin/config/content/availability-calendar'] = array(
    'title' => 'Availability Calendar',
    'description' => 'Configure site-wide settings for availability calendar fields.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'availability_calendar_admin_settings',
    ),
    'access arguments' => array(
      'administer availability calendar',
    ),
    'file' => 'availability_calendar.admin.inc',
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/config/content/availability-calendar/settings'] = array(
    'title' => 'Site-wide settings',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/config/content/availability-calendar/styling'] = array(
    'title' => 'Styling',
    'description' => 'Define CSS styles for availability calendar fields.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'availability_calendar_styles',
    ),
    'access arguments' => array(
      'style availability calendar',
    ),
    'file' => 'availability_calendar.styles.inc',
    'type' => MENU_LOCAL_TASK,
  );
  return $items;
}

/**
 * Implements hook_theme().
 * @link http://api.drupal.org/api/drupal/modules--system--system.api.php/function/hook_theme/7
 */
function availability_calendar_theme() {
  $module_path = drupal_get_path('module', 'availability_calendar');
  $theme_path = $module_path . '/theme';
  $file = 'availability_calendar.theme.inc';
  $iCalFile = 'availability_calendar.ical.inc';
  $variables = array(
    'cid' => NULL,
    'cvid' => NULL,
    'name' => '',
    'year' => 0,
    'month' => 0,
    'settings' => array(),
    'states' => array(),
    'availability' => array(),
  );
  $theme_hook_info = array(
    'file' => $file,
    'variables' => $variables,
  );
  return array(
    'availability_calendar' => $theme_hook_info,
    'availability_calendar_colorbox' => $theme_hook_info,
    'availability_calendar_viewport' => $theme_hook_info,
    'availability_calendar_ical' => array(
      'file' => $iCalFile,
      'variables' => array(
        'entity_type' => '',
        'entity' => NULL,
        'cid' => NULL,
        'name' => '',
        'langcode' => '',
        'settings' => array(),
        'from' => NULL,
        'to' => NULL,
        'events' => array(),
        'is_feed' => FALSE,
      ),
    ),
    'availability_calendar_ical_vcalendar' => array(
      'path' => $theme_path,
      'template' => 'availability-calendar-ical-vcalendar',
      'variables' => array(
        'entity_type' => '',
        'entity' => NULL,
        'cid' => NULL,
        'name' => '',
        'langcode' => '',
        'prodId' => '',
        'title' => '',
        'method' => '',
        'dtstamp' => '',
        'events' => array(),
      ),
    ),
    'availability_calendar_ical_vevent' => array(
      'path' => $theme_path,
      'template' => 'availability-calendar-ical-vevent',
      'variables' => array(
        'dtstamp' => '',
        'start' => '',
        'end' => '',
        'uid' => '',
        'summary' => '',
      ),
    ),
    'availability_calendar_months' => $theme_hook_info,
    'availability_calendar_month' => $theme_hook_info,
    'availability_calendar_viewport_button' => array(
      'file' => $file,
      'variables' => array(
        'direction' => 'forward',
        'scroll' => 6,
      ),
    ),
    'availability_calendar_key' => array(
      'file' => $file,
      'variables' => array(
        'states_to_show' => array(),
      ),
    ),
  );
}

/**
 * Implements hook_feeds_plugins().
 */
function availability_calendar_feeds_plugins() {
  $path = drupal_get_path('module', 'availability_calendar');
  $info = array();
  $info['AvailabilityCalendarICalFeedsParser'] = array(
    'name' => 'iCal parser',
    'description' => t('Parses iCal feeds.'),
    'handler' => array(
      'parent' => 'FeedsParser',
      'class' => 'AvailabilityCalendarICalFeedsParser',
      'file' => 'AvailabilityCalendarICalFeedsParser.inc',
      'path' => $path,
    ),
  );
  $info['AvailabilityCalendarICalFeedsProcessor'] = array(
    'name' => 'iCal processor',
    'description' => t('Processes iCal feeds.'),
    'handler' => array(
      'parent' => 'FeedsProcessor',
      'class' => 'AvailabilityCalendarICalFeedsProcessor',
      'file' => 'AvailabilityCalendarICalFeedsProcessor.inc',
      'path' => $path,
    ),
  );
  return $info;
}

/**
 * Implements hook_date_format_types().
 * @link http://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_date_format_types/7
 */
function availability_calendar_date_format_types() {
  return array(
    'availability_calendar_date_display' => t('Availability Calendar date display'),
    'availability_calendar_date_entry' => t('Availability Calendar date entry'),
    'availability_calendar_month_caption' => t('Availability Calendar month caption'),
  );
}

/**
 * Implements hook_date_formats().
 * @link http://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_date_formats/7
 */
function availability_calendar_date_formats() {
  $formats = array();

  // Some defaults for date display (booking formlet).
  // @todo: locale suggestions are welcome.
  $formats[] = array(
    'type' => 'availability_calendar_date_display',
    'format' => AC_DATE_DISPLAY,
    'locales' => array(),
  );
  $formats[] = array(
    'type' => 'availability_calendar_date_display',
    'format' => 'l F j, Y',
    'locales' => array(
      'en-us',
    ),
  );

  // Some defaults for user entry in date fields (Views).
  // Locales mostly copied from the short format in includes/date.inc.
  $formats[] = array(
    'type' => 'availability_calendar_date_entry',
    'format' => AC_DATE_ENTRY,
    'locales' => array(),
  );
  $formats[] = array(
    'type' => 'availability_calendar_date_entry',
    'format' => 'Y/n/j',
    'locales' => array(
      'en-ca',
      'fr-ca',
      'no-no',
      'sv-se',
    ),
  );
  $formats[] = array(
    'type' => 'availability_calendar_date_entry',
    'format' => 'j-n-Y',
    'locales' => array(
      'nl-nl',
    ),
  );
  $formats[] = array(
    'type' => 'availability_calendar_date_entry',
    'format' => 'j/n/Y',
    'locales' => array(
      'en-gb',
      'en-hk',
      'en-ie',
      'el-gr',
      'es-es',
      'fr-be',
      'fr-fr',
      'fr-lu',
      'it-it',
      'nl-be',
      'pt-pt',
    ),
  );
  $formats[] = array(
    'type' => 'availability_calendar_date_entry',
    'format' => 'j.n.Y',
    'locales' => array(
      'de-ch',
      'de-de',
      'de-lu',
      'fi-fi',
      'fr-ch',
      'is-is',
      'pl-pl',
      'ro-ro',
      'ru-ru',
    ),
  );
  $formats[] = array(
    'type' => 'availability_calendar_date_entry',
    'format' => 'n/j/Y',
    'locales' => array(
      'en-us',
    ),
  );

  // A default for the month caption when theming a calendar month.
  $formats[] = array(
    'type' => 'availability_calendar_month_caption',
    'format' => AC_DATE_MONTH_CAPTION,
    'locales' => array(),
  );
  return $formats;
}

/**
* Implements hook_block_info().
* @link http://api.drupal.org/api/drupal/modules--block--block.api.php/function/hook_block_info/7
*/
function availability_calendar_block_info() {
  $blocks = array(
    'key' => array(
      'info' => t('Availability Calendar Key'),
      'cache' => DRUPAL_CACHE_GLOBAL,
    ),
  );
  return $blocks;
}

/**
* Implements hook_block_configure().
* @link http://api.drupal.org/api/drupal/modules--block--block.api.php/function/hook_block_configure/7
*/
function availability_calendar_block_configure($delta = '') {
  module_load_include('inc', 'availability_calendar');
  $form = array();
  if ($delta == 'key') {
    $form['availability_calendar_block_states_to_show'] = array(
      '#type' => 'checkboxes',
      '#title' => t('States to show'),
      '#description' => t('Check the availability states that are to be shown in the key.') . ' ' . t('Checking no states at all will allow all states.'),
      '#default_value' => variable_get('availability_calendar_block_states_to_show', array()),
      '#options' => availability_calendar_get_states('label'),
    );
  }
  return $form;
}

/**
 * Implements hook_block_save().
 * @link http://api.drupal.org/api/drupal/modules--block--block.api.php/function/hook_block_save/7
 */
function availability_calendar_block_save($delta = '', $edit = array()) {

  // Save the settings from the configuration form.
  if ($delta == 'key') {
    variable_set('availability_calendar_block_states_to_show', $edit['availability_calendar_block_states_to_show']);
  }
}

/**
 * Implements hook_block_view().
 * @link http://api.drupal.org/api/drupal/modules--block--block.api.php/function/hook_block_view/7
 */
function availability_calendar_block_view($delta = '') {
  $block = array();
  if ($delta == 'key') {
    $block['subject'] = t('Availability Key');
    $block['content'] = array(
      '#theme' => 'availability_calendar_key',
      '#states_to_show' => variable_get('availability_calendar_block_states_to_show', array()),
    );
  }
  return $block;
}

/**
* Callback to sync a calendar field:
* - Calendar-id (cid) is synced.
* - Enabled is synced.
* - Order of cid's is synced.
* - Name is kept if already existing, copied otherwise.
*
* @param string $entity_type
* @param object $entity
*   The target entity.
* @param array $field
*   field_info_field() info array.
* @param array $instance
*   field_info_instance() info array.
* @param string $langcode
*   Target language code.
* @param array $items
*   The items to sync. in: source language items; out: target language items
* @param object $source_entity
*   The source entity.
* @param string $source_language
*   The source language code
*/
function availability_calendar_i18n_sync_availability_calendar_field($entity_type, $entity, $field, $instance, $langcode, &$items, $source_entity, $source_language) {
  $field_name = $instance['field_name'];

  // Build a copy of the existing calendars in the translation node indexed by
  // cid for easy retrieval in the copy loop below.
  $existing_items = field_get_items($entity_type, $entity, $instance['field_name'], $langcode);
  $existing_calendars = array();
  if ($existing_items !== FALSE) {
    foreach ($existing_items as $calendar) {
      $existing_calendars[$calendar['cid']] = $calendar;
    }
  }

  // Start creating the translated copy.
  $property = 'name';
  foreach ($items as &$calendar) {

    // keep name if it already exists.
    if (array_key_exists($calendar['cid'], $existing_calendars)) {
      if (!empty($existing_calendars[$calendar['cid']][$property])) {
        $calendar[$property] = $existing_calendars[$calendar['cid']][$property];
      }
    }
  }
}

Functions

Name	Description
availability_calendar_block_configure	Implements hook_block_configure(). @link http://api.drupal.org/api/drupal/modules--block--block.api.php/function/...
availability_calendar_block_info	Implements hook_block_info(). @link http://api.drupal.org/api/drupal/modules--block--block.api.php/function/...
availability_calendar_block_save	Implements hook_block_save(). @link http://api.drupal.org/api/drupal/modules--block--block.api.php/function/...
availability_calendar_block_view	Implements hook_block_view(). @link http://api.drupal.org/api/drupal/modules--block--block.api.php/function/...
availability_calendar_date_formats	Implements hook_date_formats(). @link http://api.drupal.org/api/drupal/modules%21system%21system.api.php/funct...
availability_calendar_date_format_types	Implements hook_date_format_types(). @link http://api.drupal.org/api/drupal/modules%21system%21system.api.php/funct...
availability_calendar_feeds_plugins	Implements hook_feeds_plugins().
availability_calendar_i18n_sync_availability_calendar_field	Callback to sync a calendar field:
availability_calendar_init	Implements hook_init(). @link http://api.drupal.org/api/drupal/modules--system--system.api.php/functio...
availability_calendar_menu	Implements hook_menu(). @link http://api.drupal.org/api/drupal/modules--system--system.api.php/functio...
availability_calendar_permission	Implements hook_permission(). @link http://api.drupal.org/api/drupal/modules--system--system.api.php/functio...
availability_calendar_theme	Implements hook_theme(). @link http://api.drupal.org/api/drupal/modules--system--system.api.php/functio...
availability_calendar_views_api	Implements hook_views_api().

Constants

Name	Description
AC_ALLOCATION_TYPE_FULLDAY	@const string Denotes that a calendar field is used for a full day rental or allocation use case.
AC_ALLOCATION_TYPE_OVERNIGHT	@const string Denotes that a calendar field is used for an overnight rental or allocation use case.
AC_DATE_DISPLAY	@const string The default date formatter for displaying dates.
AC_DATE_ENTRY	@const string The default date formatter for entering dates.
AC_DATE_MONTH_CAPTION	@const string The default date formatter for hte month caption.