statistics.install

Same filename in other branches
  1. 7.x modules/statistics/statistics.install
  2. 9 core/modules/statistics/statistics.install
  3. 10 core/modules/statistics/statistics.install
  4. 11.x core/modules/statistics/statistics.install

Install and update functions for the Statistics module.

File

core/modules/statistics/statistics.install

View source
<?php


/**
 * @file
 * Install and update functions for the Statistics module.
 */

/**
 * Implements hook_uninstall().
 */
function statistics_uninstall() {
    // Remove states.
    \Drupal::state()->delete('statistics.node_counter_scale');
    \Drupal::state()->delete('statistics.day_timestamp');
}

/**
 * Implements hook_schema().
 */
function statistics_schema() {
    $schema['node_counter'] = [
        'description' => 'Access statistics for {node}s.',
        'fields' => [
            'nid' => [
                'description' => 'The {node}.nid for these statistics.',
                'type' => 'int',
                'unsigned' => TRUE,
                'not null' => TRUE,
                'default' => 0,
            ],
            'totalcount' => [
                'description' => 'The total number of times the {node} has been viewed.',
                'type' => 'int',
                'unsigned' => TRUE,
                'not null' => TRUE,
                'default' => 0,
                'size' => 'big',
            ],
            'daycount' => [
                'description' => 'The total number of times the {node} has been viewed today.',
                'type' => 'int',
                'unsigned' => TRUE,
                'not null' => TRUE,
                'default' => 0,
                'size' => 'medium',
            ],
            'timestamp' => [
                'description' => 'The most recent time the {node} has been viewed.',
                'type' => 'int',
                'unsigned' => TRUE,
                'not null' => TRUE,
                'default' => 0,
            ],
        ],
        'primary key' => [
            'nid',
        ],
    ];
    return $schema;
}

/**
 * Disable the Statistics module if the node module is not enabled.
 */
function statistics_update_8001() {
    if (!\Drupal::moduleHandler()->moduleExists('node')) {
        if (\Drupal::service('module_installer')->uninstall([
            'statistics',
        ], TRUE)) {
            return 'The statistics module depends on the node module and has therefore been uninstalled.';
        }
        else {
            return 'There was an error uninstalling the statistcs module.';
        }
    }
}

/**
 * Disable the Statistics module if the node module is not enabled.
 */
function statistics_update_8002() {
    // Set the new configuration setting for max age to the initial value.
    \Drupal::configFactory()->getEditable('statistics.settings')
        ->set('display_max_age', 3600)
        ->save();
}

/**
 * Remove access_log settings.
 */
function statistics_update_8300() {
    \Drupal::configFactory()->getEditable('statistics.settings')
        ->clear('access_log')
        ->save();
}

Functions

Title Deprecated Summary
statistics_schema Implements hook_schema().
statistics_uninstall Implements hook_uninstall().
statistics_update_8001 Disable the Statistics module if the node module is not enabled.
statistics_update_8002 Disable the Statistics module if the node module is not enabled.
statistics_update_8300 Remove access_log settings.

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