flexslider.install in Flex Slider 7.2

Installation actions for FlexSlider

File

flexslider.install

<?php

/**
 * @file
 * Installation actions for FlexSlider
 */

/**
 * Implements hook_schema().
 */
function flexslider_schema() {
  $schema = array();
  $schema['flexslider_optionset'] = array(
    'description' => 'Store option sets for flexslider instances.',
    'export' => array(
      'key' => 'name',
      'identifier' => 'preset',
      'default hook' => 'flexslider_default_presets',
      'api' => array(
        'owner' => 'flexslider',
        'api' => 'flexslider_default_preset',
        'minimum_version' => 1,
        'current_version' => 1,
      ),
    ),
    'fields' => array(
      'name' => array(
        'description' => 'The machine-readable option set name.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
      ),
      'title' => array(
        'description' => 'The human-readable title for this option set.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
      ),
      'theme' => array(
        'description' => 'The flexslider theme.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => 'classic',
      ),
      'options' => array(
        'description' => 'The options array.',
        'type' => 'blob',
        'size' => 'big',
        'serialize' => TRUE,
      ),
    ),
    'primary key' => array(
      'name',
    ),
  );
  return $schema;
}

/**
 * Implements hook_install().
 *
 * Adds a 'default' option set for fresh installs.
 */
function flexslider_install() {

  // Do nothing for now
}

/**
 * Implements hook_uninstall().
 */
function flexslider_uninstall() {
  variable_del('flexslider_debug');
  variable_del('flexslider_version');
}

/**
 * Implements hook_requirements().
 */
function flexslider_requirements($phase) {
  $requirements = array();

  // Ensure translations don't break at install time
  $t = get_t();

  // Check to see if the flexslider library is available
  if ($phase == 'runtime') {
    $library = libraries_detect('flexslider');
    if ($library['installed']) {
      $version = explode('.', $library['version']);
      if ($version[0] == FLEXSLIDER_COMPATIBLE_MAJOR_VERSION) {
        $requirements['flexslider'] = array(
          'value' => $library['version'],
          'severity' => REQUIREMENT_OK,
        );
      }
      else {
        $requirements['flexslider'] = array(
          'value' => $library['version'],
          'description' => $t('Incompatible version detected. The FlexSlider library version must be from the %version.x branch.', array(
            '%version' => FLEXSLIDER_COMPATIBLE_MAJOR_VERSION,
          )),
          'severity' => REQUIREMENT_WARNING,
        );
      }
    }
    else {
      $requirements['flexslider'] = array(
        'value' => $t('FlexSlider library not found.'),
        'description' => $t('The FlexSlider library could not be detected. Please consult the README.md for installation instructions.'),
        'severity' => REQUIREMENT_ERROR,
      );
    }
    $requirements['flexslider']['title'] = $t('FlexSlider');
  }
  return $requirements;
}

/**
 * Remove/Update table fields to better suit FlexSlider
 */
function flexslider_update_7001(&$sandbox) {
  $field_new = array(
    'description' => 'The image style for normal images.',
    'type' => 'varchar',
    'length' => 255,
    'not null' => TRUE,
    'default' => 'flexslider_full',
  );

  // Change the default image style
  db_change_field('flexslider_optionset', 'imagestyle_normal', $field_new, array());

  // Drop the unused table column
  db_drop_field('flexslider_optionset', 'imagestyle_thumb');
}

/**
 * Enables the Image module since it is now explicitly listed as a
 * dependency.
 */
function flexslider_update_7002(&$sandbox) {
  module_enable(array(
    'image',
  ));
}

/**
 * Migrate settings from FlexSlider v1 to v2
 */
function flexslider_update_7200(&$sandbox) {
  $t = get_t();
  module_load_include('module', 'flexslider', 'flexslider');
  $optionsets = flexslider_optionset_load_all();
  foreach ($optionsets as $optionset) {

    // Map old options to new keys/values
    $optionset->options['animationSpeed'] = $optionset->options['animationDuration'];
    $optionset->options['direction'] = $optionset->options['slidedirection'];
    $optionset->options['keyboard'] = $optionset->options['keyboardnav'];
    $optionset->options['startAt'] = $optionset->options['slidetostart'];
    $optionset->options['start'] = $optionset->options['startCallback'];
    $optionset->options['before'] = $optionset->options['beforeCallback'];
    $optionset->options['after'] = $optionset->options['afterCallback'];
    $optionset->options['end'] = $optionset->options['endCallback'];

    // Delete any options which no longer exist
    unset($optionset->options['animationDuration']);
    unset($optionset->options['slidedirection']);
    unset($optionset->options['keyboardnav']);
    unset($optionset->options['startCallback']);
    unset($optionset->options['beforeCallback']);
    unset($optionset->options['afterCallback']);
    unset($optionset->options['endCallback']);
    unset($optionset->options['controlsContainer']);

    // This value changed in the new version. We have to reset it to the default value
    // Merge in defaults for new options
    $optionset->options += _flexslider_optionset_defaults();

    // Save the updated optionset
    flexslider_optionset_save($optionset);
  }
  drupal_set_message($t('Optionsets migrated. However it is recommended to go validate all your settings manually. Especially if you have callback functions defined. They may reference functions which no longer exist.'), 'warning');
}

/**
 * Add thumbnail image config.
 */
function flexslider_update_7201(&$sandbox) {
  $field_new = array(
    'description' => 'The image style for thumbnail images.',
    'type' => 'varchar',
    'length' => 255,
    'not null' => TRUE,
    'default' => 'flexslider_thumbnail',
  );

  // Change the default image style
  db_add_field('flexslider_optionset', 'imagestyle_thumbnail', $field_new, array());
}

/**
 * Remove the image style settings from the optionset
 */
function flexslider_update_7202(&$sandbox) {
  db_drop_field('flexslider_optionset', 'imagestyle_normal');
  db_drop_field('flexslider_optionset', 'imagestyle_thumbnail');
}

/**
 * Remove the flexslider_version variable.
 */
function flexslider_update_7203(&$sandbox) {
  variable_del('flexslider_version');
}

Functions

Name	Description
flexslider_install	Implements hook_install().
flexslider_requirements	Implements hook_requirements().
flexslider_schema	Implements hook_schema().
flexslider_uninstall	Implements hook_uninstall().
flexslider_update_7001	Remove/Update table fields to better suit FlexSlider
flexslider_update_7002	Enables the Image module since it is now explicitly listed as a dependency.
flexslider_update_7200	Migrate settings from FlexSlider v1 to v2
flexslider_update_7201	Add thumbnail image config.
flexslider_update_7202	Remove the image style settings from the optionset
flexslider_update_7203	Remove the flexslider_version variable.