commerce_recurring.install in Commerce Recurring Framework 7.2

File

commerce_recurring.install

<?php

/**
 * Performs database updates and uninstallation cleanup for the Commerce Recurring module.
 */

/**
 * Implements hook_schema().
 */
function commerce_recurring_schema() {
  $schema = array();
  $schema['commerce_recurring'] = array(
    'description' => 'The base table for commerce recurring entities.',
    'fields' => array(
      'id' => array(
        'description' => 'The primary identifier for a recurring entity, used internally only.',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'type' => array(
        'description' => 'The type (bundle) of this recurring entity.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'uid' => array(
        'description' => 'The {users}.uid that owns the recurring entity.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
      'status' => array(
        'description' => 'Boolean indicating whether or not the recurring entity is active.',
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 1,
      ),
      'start_date' => array(
        'description' => 'The Unix timestamp when the recurring entity was created.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
      'due_date' => array(
        'description' => 'The Unix timestamp when the recurring entity has is next due date.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
      'end_date' => array(
        'description' => 'The Unix timestamp when the recurring entity ends being active.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
      'quantity' => array(
        'type' => 'numeric',
        'size' => 'normal',
        'not null' => TRUE,
        'default' => 0,
        'precision' => 10,
        'scale' => 2,
      ),
      'data' => array(
        'type' => 'blob',
        'not null' => FALSE,
        'size' => 'big',
        'serialize' => TRUE,
        'description' => 'A serialized array of additional data.',
      ),
    ),
    'primary key' => array(
      'id',
    ),
    'indexes' => array(
      'commerce_recurring_type' => array(
        'type',
      ),
      'uid' => array(
        'uid',
      ),
    ),
    'foreign keys' => array(
      'creator' => array(
        'table' => 'users',
        'columns' => array(
          'uid' => 'uid',
        ),
      ),
    ),
  );
  return $schema;
}

/**
 * Implements hook_install().
 */
function commerce_recurring_install() {

  // Create the recurring product type.
  $product_type = array(
    'type' => 'recurring',
    'name' => t('Recurring product'),
    'description' => t('A recurring purchase product type'),
    'help' => '',
    'revision' => 1,
    'is_new' => TRUE,
  );
  commerce_product_ui_product_type_save($product_type, FALSE);
}

/**
 * Implements hook_enable().
 */
function commerce_recurring_enable() {

  // Make sure we're in a non cached environment.
  entity_info_cache_clear();
  field_cache_clear();

  // Create and configure the recurring product type fields.
  commerce_recurring_configure_product_type();

  // Create and configure the recurring entity.
  commerce_recurring_configure_recurring_entity_type();
}

/**
 * Implements hook_uninstall().
 */
function commerce_recurring_uninstall() {
  module_load_include('module', 'commerce');
  module_load_include('module', 'commerce_product_ui');

  // Delete recurring product type and field instances.
  commerce_product_ui_product_type_delete('recurring');
  commerce_delete_instances('commerce_product', 'recurring');

  // Delete field instances from commerce recurring entity.
  commerce_delete_instances('commerce_recurring');

  // Delete all fields created by this module.
  $fields = array(
    'commerce_recurring_ini_price',
    'commerce_recurring_rec_price',
    'commerce_recurring_ini_period',
    'commerce_recurring_rec_period',
    'commerce_recurring_end_period',
    'commerce_recurring_ref_product',
    'commerce_recurring_order',
    'commerce_recurring_fixed_price',
  );
  foreach ($fields as $field_name) {
    commerce_delete_field($field_name);
  }
}

Functions

Name	Description
commerce_recurring_enable	Implements hook_enable().
commerce_recurring_install	Implements hook_install().
commerce_recurring_schema	Implements hook_schema().
commerce_recurring_uninstall	Implements hook_uninstall().