history.install

Same filename and directory in other branches
  1. 9 core/modules/history/history.install
  2. 8.9.x core/modules/history/history.install
  3. 11.x core/modules/history/history.install

Installation functions for History module.

File

core/modules/history/history.install

View source
<?php


/**
 * @file
 * Installation functions for History module.
 */


/**
 * Implements hook_schema().
 */
function history_schema() {
  $schema['history'] = [
    'description' => 'A record of which {users} have read which {node}s.',
    'fields' => [
      'uid' => [
        'description' => 'The {users}.uid that read the {node} nid.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ],
      'nid' => [
        'description' => 'The {node}.nid that was read.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ],
      'timestamp' => [
        'description' => 'The Unix timestamp at which the read occurred.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'big',
      ],
    ],
    'primary key' => [
      'uid',
      'nid',
    ],
    'indexes' => [
      'nid' => [
        'nid',
      ],
    ],
  ];
  return $schema;
}

/**
 * Implements hook_update_last_removed().
 */
function history_update_last_removed() {
  return 8101;
}

/**
 * Remove the year 2038 date limitation.
 */
function history_update_10100(&$sandbox = NULL) {
  $connection = \Drupal::database();
  if ($connection->schema()
    ->tableExists('history') && $connection->databaseType() != 'sqlite') {
    $new = [
      'description' => 'The Unix timestamp at which the read occurred.',
      'type' => 'int',
      'not null' => TRUE,
      'default' => 0,
      'size' => 'big',
    ];
    $connection->schema()
      ->changeField('history', 'timestamp', 'timestamp', $new);
  }
}

Functions

Title Deprecated Summary
history_schema Implements hook_schema().
history_update_10100 Remove the year 2038 date limitation.
history_update_last_removed Implements hook_update_last_removed().

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