function bootstrap_tour_db_tour_table in Bootstrap Tour 7.2

Returns the table definition for the table which holds the tours.

Return value

array

2 calls to bootstrap_tour_db_tour_table()

bootstrap_tour_schema in ./bootstrap_tour.install

Implements hook_schema().

bootstrap_tour_update_7200 in ./bootstrap_tour.install

Upgrade old 1.x tours to the new 2.x Entity format, then delete the old DB table.

File

./bootstrap_tour.install, line 150

Code

function bootstrap_tour_db_tour_table() {
  return array(
    'description' => t('Bootstrap tours courtesy of the Bootstrap Tours module'),
    'fields' => array(
      'bootstrap_tour_id' => array(
        'description' => 'Primary ID field for the table. Not used for anything except internal lookups.',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'no export' => TRUE,
      ),
      'title' => array(
        'description' => 'Human readable name for the tour used for administrative purposes.',
        'type' => 'varchar',
        'length' => '255',
      ),
      'name' => array(
        'description' => 'Unique ID for tours used to identify them programmatically, generated from the name.',
        'type' => 'varchar',
        'length' => '255',
      ),
      'description' => array(
        'description' => 'A description of the site tour, used for administrative purposes.',
        'type' => 'varchar',
        'length' => '255',
      ),
      'roles' => array(
        'description' => 'A comma separated list of roles that can access this tour.',
        'type' => 'varchar',
        'length' => '255',
      ),
      'autorun' => array(
        'description' => 'Boolean indicating whether the tour should automatically start when the start path is visited.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 1,
      ),
      'start_path' => array(
        'description' => 'The path at which the tour should begin.',
        'type' => 'varchar',
        'length' => '255',
      ),
      'enabled' => array(
        'description' => 'Boolean indicating whether the tour is enabled or disabled.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 1,
      ),
    ) + entity_exportable_schema_fields(),
    'primary key' => array(
      'bootstrap_tour_id',
    ),
    'unique keys' => array(
      'name' => array(
        'name',
      ),
    ),
  );
}