function locale_schema

Same name in other branches
  1. 9 core/modules/locale/locale.install \locale_schema()
  2. 8.9.x core/modules/locale/locale.install \locale_schema()
  3. 10 core/modules/locale/locale.install \locale_schema()
  4. 11.x core/modules/locale/locale.install \locale_schema()

Implements hook_schema().

File

modules/locale/locale.install, line 274

Code

function locale_schema() {
    $schema['languages'] = array(
        'description' => 'List of all available languages in the system.',
        'fields' => array(
            'language' => array(
                'type' => 'varchar',
                'length' => 12,
                'not null' => TRUE,
                'default' => '',
                'description' => "Language code, e.g. 'de' or 'en-US'.",
            ),
            'name' => array(
                'type' => 'varchar',
                'length' => 64,
                'not null' => TRUE,
                'default' => '',
                'description' => 'Language name in English.',
            ),
            'native' => array(
                'type' => 'varchar',
                'length' => 64,
                'not null' => TRUE,
                'default' => '',
                'description' => 'Native language name.',
            ),
            'direction' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
                'description' => 'Direction of language (Left-to-Right = 0, Right-to-Left = 1).',
            ),
            'enabled' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
                'description' => 'Enabled flag (1 = Enabled, 0 = Disabled).',
            ),
            'plurals' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
                'description' => 'Number of plural indexes in this language.',
            ),
            'formula' => array(
                'type' => 'varchar',
                'length' => 255,
                'not null' => TRUE,
                'default' => '',
                'description' => 'Plural formula in PHP code to evaluate to get plural indexes.',
            ),
            'domain' => array(
                'type' => 'varchar',
                'length' => 128,
                'not null' => TRUE,
                'default' => '',
                'description' => 'Domain to use for this language.',
            ),
            'prefix' => array(
                'type' => 'varchar',
                'length' => 128,
                'not null' => TRUE,
                'default' => '',
                'description' => 'Path prefix to use for this language.',
            ),
            'weight' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
                'description' => 'Weight, used in lists of languages.',
            ),
            'javascript' => array(
                'type' => 'varchar',
                'length' => 64,
                'not null' => TRUE,
                'default' => '',
                'description' => 'Location of JavaScript translation file.',
            ),
        ),
        'primary key' => array(
            'language',
        ),
        'indexes' => array(
            'list' => array(
                'weight',
                'name',
            ),
        ),
    );
    $schema['locales_source'] = array(
        'description' => 'List of English source strings.',
        'fields' => array(
            'lid' => array(
                'type' => 'serial',
                'not null' => TRUE,
                'description' => 'Unique identifier of this string.',
            ),
            'location' => array(
                'type' => 'text',
                'not null' => FALSE,
                'size' => 'big',
                'description' => 'Drupal path in case of online discovered translations or file path in case of imported strings.',
            ),
            'textgroup' => array(
                'type' => 'varchar',
                'length' => 255,
                'not null' => TRUE,
                'default' => 'default',
                'description' => 'A module defined group of translations, see hook_locale().',
            ),
            'source' => array(
                'type' => 'text',
                'mysql_type' => 'blob',
                'not null' => TRUE,
                'description' => 'The original string in English.',
            ),
            'context' => array(
                'type' => 'varchar',
                'length' => 255,
                'not null' => TRUE,
                'default' => '',
                'description' => 'The context this string applies to.',
            ),
            'version' => array(
                'type' => 'varchar',
                'length' => 20,
                'not null' => TRUE,
                'default' => 'none',
                'description' => 'Version of Drupal, where the string was last used (for locales optimization).',
            ),
        ),
        'primary key' => array(
            'lid',
        ),
        'indexes' => array(
            'source_context' => array(
                array(
                    'source',
                    30,
                ),
                'context',
            ),
        ),
    );
    $schema['locales_target'] = array(
        'description' => 'Stores translated versions of strings.',
        'fields' => array(
            'lid' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
                'description' => 'Source string ID. References {locales_source}.lid.',
            ),
            'translation' => array(
                'type' => 'text',
                'mysql_type' => 'blob',
                'not null' => TRUE,
                'description' => 'Translation string value in this language.',
            ),
            'language' => array(
                'type' => 'varchar',
                'length' => 12,
                'not null' => TRUE,
                'default' => '',
                'description' => 'Language code. References {languages}.language.',
            ),
            'plid' => array(
                'type' => 'int',
                'not null' => TRUE,
                // This should be NULL for no referenced string, not zero.
'default' => 0,
                'description' => 'Parent lid (lid of the previous string in the plural chain) in case of plural strings. References {locales_source}.lid.',
            ),
            'plural' => array(
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
                'description' => 'Plural index number in case of plural strings.',
            ),
        ),
        'primary key' => array(
            'language',
            'lid',
            'plural',
        ),
        'foreign keys' => array(
            'locales_source' => array(
                'table' => 'locales_source',
                'columns' => array(
                    'lid' => 'lid',
                ),
            ),
        ),
        'indexes' => array(
            'lid' => array(
                'lid',
            ),
            'plid' => array(
                'plid',
            ),
            'plural' => array(
                'plural',
            ),
        ),
    );
    return $schema;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.