agenda.install in Agenda 7.2

Install, uninstall and scheme functions for the agenda module.

File

agenda.install

<?php

/**
 * @file
 * Install, uninstall and scheme functions for the agenda module.
 */

/**
 * Implements hook_requirements().
 */
function agenda_requirements($phase) {
  $requirements = array();
  $t = get_t();
  if ($phase == 'runtime') {
    $library = libraries_detect('google-api-php-client');
    $error_type = isset($library['error']) ? drupal_ucfirst($library['error']) : '';
    $error_message = isset($library['error message']) ? $library['error message'] : '';
    if (empty($library['installed'])) {
      $requirements['agenda_google_api'] = array(
        'title' => $t('Agenda module: Google API Client Library for PHP'),
        'value' => $t('@e: At least @a', array(
          '@e' => $error_type,
          '@a' => AGENDA_MIN_API_VERSION,
        )),
        'severity' => REQUIREMENT_ERROR,
        'description' => $t('!error You need to download the !google_api,
          extract the archive and place the google-api-php-client directory in
          the %path directory on your server.', array(
          '!error' => $error_message,
          '!google_api' => l($t('Google API PHP Client'), $library['download url']),
          '%path' => 'sites/all/libraries',
        )),
      );
    }
    elseif (version_compare($library['version'], AGENDA_MIN_API_VERSION, '>=')) {
      $requirements['agenda_google_api'] = array(
        'title' => $t('Agenda module: Google API Client Library for PHP'),
        'severity' => REQUIREMENT_OK,
        'value' => $library['version'],
        'description' => $t('Read the Agenda module\'s README for additional
          steps needed to configure the Google Calendar API.'),
      );
    }
    else {
      $requirements['agenda_google_api'] = array(
        'title' => $t('Agenda module: Google API Client Library for PHP'),
        'value' => $t('At least @a', array(
          '@a' => AGENDA_MIN_API_VERSION,
        )),
        'severity' => REQUIREMENT_ERROR,
        'description' => $t('You need to download a later version of the
          !google_api and replace the old version located in the %path directory
          on your server.', array(
          '!google_api' => l($t('Google API PHP Client'), $library['download url']),
          '%path' => $library['library path'],
        )),
      );
    }
  }
  return $requirements;
}

/**
 * Implements hook_install().
 */
function agenda_install() {
  agenda_install_fixtures();
}

/**
 * Implements hook_uninstall().
 */
function agenda_uninstall() {
  variable_del('agenda_googleapi');
}

/**
 * Install an example block
 */
function agenda_install_fixtures() {
  $records = array(
    array(
      1,
      'noeventstext',
      '<p>No upcoming events</p>',
    ),
    array(
      1,
      'timeformat',
      'h:ia',
    ),
    array(
      1,
      'dateformat',
      'l, F jS',
    ),
    array(
      1,
      'maxevents',
      '60',
    ),
    array(
      1,
      'datelimit',
      '60',
    ),
    array(
      1,
      'start',
      'Jan 1st, 2009',
    ),
    array(
      1,
      'end',
      'April 1st, 2009',
    ),
    array(
      1,
      'title',
      'Example agenda block',
    ),
    array(
      1,
      'linktext',
      'View this event in Google Calendar',
    ),
    array(
      1,
      'hangoutlinktext',
      'Join Google Calendar Event Hangout',
    ),
    array(
      1,
      'cachetime',
      '3600',
    ),
    array(
      1,
      'display_keys',
      'start time, end date, end time, published, description, link',
    ),
    array(
      1,
      'hide_labels',
      'description, link',
    ),
    array(
      1,
      'calendars',
      '[e-mail]',
    ),
    array(
      1,
      'timezone',
      'UTC',
    ),
  );
  $query = db_insert('agenda')
    ->fields(array(
    'bid',
    'name',
    'value',
  ));
  foreach ($records as $record) {
    $query
      ->values($record);
  }
  $query
    ->execute();
}

/**
 * Implements hook_schema().
 */
function agenda_schema() {
  $schema['agenda'] = array(
    'description' => t('Hold agenda settings'),
    'fields' => array(
      'id' => array(
        'description' => t('ID'),
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'disp-width' => '11',
      ),
      'bid' => array(
        'description' => t('Block ID'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'disp-width' => '11',
      ),
      'name' => array(
        'description' => t('Name of the setting'),
        'type' => 'varchar',
        'length' => 50,
        'not null' => TRUE,
      ),
      'value' => array(
        'description' => t('Value of the setting'),
        'type' => 'varchar',
        'length' => 1024,
        'not null' => FALSE,
      ),
    ),
    'primary key' => array(
      'id',
    ),
    'unique keys' => array(
      'kvp' => array(
        'bid',
        'name',
      ),
    ),
    'indexes' => array(
      'bid' => array(
        'bid',
      ),
    ),
  );
  return $schema;
}

Functions

Name	Description
agenda_install	Implements hook_install().
agenda_install_fixtures	Install an example block
agenda_requirements	Implements hook_requirements().
agenda_schema	Implements hook_schema().
agenda_uninstall	Implements hook_uninstall().