function block_schema

Implements hook_schema().

File

modules/block/block.install, line 11

Code

function block_schema() {
    $schema['block'] = array(
        'description' => 'Stores block settings, such as region and visibility settings.',
        'fields' => array(
            'bid' => array(
                'type' => 'serial',
                'not null' => TRUE,
                'description' => 'Primary Key: Unique block ID.',
            ),
            'module' => array(
                'type' => 'varchar',
                'length' => 64,
                'not null' => TRUE,
                'default' => '',
                'description' => "The module from which the block originates; for example, 'user' for the Who's Online block, and 'block' for any custom blocks.",
            ),
            'delta' => array(
                'type' => 'varchar',
                'length' => 32,
                'not null' => TRUE,
                'default' => '0',
                'description' => 'Unique ID for block within a module.',
            ),
            'theme' => array(
                'type' => 'varchar',
                'length' => 64,
                'not null' => TRUE,
                'default' => '',
                'description' => 'The theme under which the block settings apply.',
            ),
            'status' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
                'size' => 'tiny',
                'description' => 'Block enabled status. (1 = enabled, 0 = disabled)',
            ),
            'weight' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
                'description' => 'Block weight within region.',
            ),
            'region' => array(
                'type' => 'varchar',
                'length' => 64,
                'not null' => TRUE,
                'default' => '',
                'description' => 'Theme region within which the block is set.',
            ),
            'custom' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
                'size' => 'tiny',
                'description' => 'Flag to indicate how users may control visibility of the block. (0 = Users cannot control, 1 = On by default, but can be hidden, 2 = Hidden by default, but can be shown)',
            ),
            'visibility' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
                'size' => 'tiny',
                'description' => 'Flag to indicate how to show blocks on pages. (0 = Show on all pages except listed pages, 1 = Show only on listed pages, 2 = Use custom PHP code to determine visibility)',
            ),
            'pages' => array(
                'type' => 'text',
                'not null' => TRUE,
                'description' => 'Contents of the "Pages" block; contains either a list of paths on which to include/exclude the block or PHP code, depending on "visibility" setting.',
            ),
            'title' => array(
                'type' => 'varchar',
                'length' => 255,
                'not null' => TRUE,
                'default' => '',
                'description' => 'Custom title for the block. (Empty string will use block default title, <none> will remove the title, text will cause block to use specified title.)',
                'translatable' => TRUE,
            ),
            'cache' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 1,
                'size' => 'tiny',
                'description' => 'Binary flag to indicate block cache mode. (-2: Custom cache, -1: Do not cache, 1: Cache per role, 2: Cache per user, 4: Cache per page, 8: Block cache global) See DRUPAL_CACHE_* constants in ../includes/common.inc for more detailed information.',
            ),
        ),
        'primary key' => array(
            'bid',
        ),
        'unique keys' => array(
            'tmd' => array(
                'theme',
                'module',
                'delta',
            ),
        ),
        'indexes' => array(
            'list' => array(
                'theme',
                'status',
                'region',
                'weight',
                'module',
            ),
        ),
    );
    $schema['block_role'] = array(
        'description' => 'Sets up access permissions for blocks based on user roles',
        'fields' => array(
            'module' => array(
                'type' => 'varchar',
                'length' => 64,
                'not null' => TRUE,
                'description' => "The block's origin module, from {block}.module.",
            ),
            'delta' => array(
                'type' => 'varchar',
                'length' => 32,
                'not null' => TRUE,
                'description' => "The block's unique delta within module, from {block}.delta.",
            ),
            'rid' => array(
                'type' => 'int',
                'unsigned' => TRUE,
                'not null' => TRUE,
                'description' => "The user's role ID from {users_roles}.rid.",
            ),
        ),
        'primary key' => array(
            'module',
            'delta',
            'rid',
        ),
        'indexes' => array(
            'rid' => array(
                'rid',
            ),
        ),
    );
    $schema['block_custom'] = array(
        'description' => 'Stores contents of custom-made blocks.',
        'fields' => array(
            'bid' => array(
                'type' => 'serial',
                'unsigned' => TRUE,
                'not null' => TRUE,
                'description' => "The block's {block}.bid.",
            ),
            'body' => array(
                'type' => 'text',
                'not null' => FALSE,
                'size' => 'big',
                'description' => 'Block contents.',
                'translatable' => TRUE,
            ),
            'info' => array(
                'type' => 'varchar',
                'length' => 128,
                'not null' => TRUE,
                'default' => '',
                'description' => 'Block description.',
            ),
            'format' => array(
                'type' => 'varchar',
                'length' => 255,
                'not null' => FALSE,
                'description' => 'The {filter_format}.format of the block body.',
            ),
        ),
        'unique keys' => array(
            'info' => array(
                'info',
            ),
        ),
        'primary key' => array(
            'bid',
        ),
    );
    $schema['cache_block'] = drupal_get_schema_unprocessed('system', 'cache');
    $schema['cache_block']['description'] = 'Cache table for the Block module to store already built blocks, identified by module, delta, and various contexts which may change the block, such as theme, locale, and caching mode defined for the block.';
    return $schema;
}