function bootstrap_tour_db_legacy_table in Bootstrap Tour 7.2

Returns the table definition for the legacy/deprecated table which held tours in 1.x.

Return value

array

1 call to bootstrap_tour_db_legacy_table()

bootstrap_tour_schema in ./bootstrap_tour.install

Implements hook_schema().

File

./bootstrap_tour.install, line 262

Code

function bootstrap_tour_db_legacy_table() {
  return array(
    'description' => t('Bootstrap tours courtesy of the Bootstrap Tours module'),
    'export' => array(
      'primary_key' => 'name',
      'api' => array(
        'owner' => 'bootstrap_tour',
        'api' => 'bootstrap_tour_tour',
        'minimum_version' => '1',
        'current_version' => '1',
      ),
      'default hook' => 'default_bootstrap_tour',
    ),
    'fields' => array(
      'name' => array(
        'type' => 'varchar',
        'length' => '255',
        'description' => 'Unique ID for tours used to identify them programmatically, generated from the name.',
      ),
      'title' => array(
        'type' => 'varchar',
        'length' => '255',
        'description' => 'Human readable name for the tour used for administrative purposes.',
      ),
      'roles' => array(
        'type' => 'varchar',
        'length' => '255',
        'description' => 'A comma separated list of roles that can access this tour.',
      ),
      'btid' => array(
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Primary ID field for the table. Not used for anything except internal lookups.',
        'no export' => TRUE,
      ),
      'autorun' => array(
        'description' => 'Boolean indicating whether the tour should automatically start when the path of the first step is loaded.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 1,
      ),
      'description' => array(
        'type' => 'varchar',
        'length' => '255',
        'description' => 'A description of the site tour, used for administrative purposes.',
      ),
      'steps' => array(
        'type' => 'blob',
        'description' => 'A serialized array of tour steps.',
        'serialize' => TRUE,
      ),
    ),
    'primary key' => array(
      'btid',
    ),
    'unique keys' => array(
      'name' => array(
        'name',
      ),
    ),
  );
}