serial.inc in Serial Field 6

Internal functions for the Serial module.

Note: This module uses php in SQL to support dynamic table names. (required because each serial field needs a dedicated dynamic table). However, all table names are safe (passed through db_escape_table).

It seems that this is better than using table names as arguments, e.g. $query = 'INSERT INTO %s (nid) VALUES(%d)'; db_query($query, db_prefix_tables('{'. $table .'}'), $nid);

File

serial.inc

<?php

/**
 * @file
 * Internal functions for the Serial module.
 *
 * Note: This module uses php in SQL to support dynamic table names.
 * (required because each serial field needs a dedicated dynamic table).
 * However, all table names are safe (passed through db_escape_table).
 *
 * It seems that this is better than using table names as arguments, e.g.
 *   $query = 'INSERT INTO %s (nid) VALUES(%d)';
 *   db_query($query, db_prefix_tables('{'. $table .'}'), $nid);
 */

/**
 * Creates an assistant serial table for a new created field.
 *
 * @param $field a new serial field
 */
function _serial_create_table($field) {
  $table = _serial_get_field_table_name($field);
  $schema = _serial_get_table_schema();
  db_create_table($ret, $table, $schema);
}

/**
 * Drops an assistant serial table for a deleted field.
 *
 * @param $field a deleted serial field
 */
function _serial_drop_table($field) {
  $table = _serial_get_field_table_name($field);
  db_drop_table($ret, $table);
}

/**
 * Renames serial table(s) when a content type us renamed.
 *
 * @param $old_type_name
 *   an old node type machine name
 * @param $new_type_name
 *   a new node type machine name
 */
function _serial_rename_tables($old_type_name, $new_type_name) {
  $sql = "SELECT f.field_name FROM {content_node_field} f, {content_node_field_instance} i " . "WHERE f.field_name = i.field_name AND f.type = 'serial' AND i.type_name = '%s'";
  $result = db_query(db_rewrite_sql($sql), $new_type_name);
  while ($data = db_fetch_object($result)) {
    $old_table = _serial_get_table_name($old_type_name, $data->field_name);
    $new_table = _serial_get_table_name($new_type_name, $data->field_name);
    db_rename_table($ret, $old_table, $new_table);
  }
}

/**
 * Gets the name of the assistant table for a specific field.
 *
 * @param $field
 *   a serial field instance
 * @return
 *   the name of the assistant table of the specified field instance.
 */
function _serial_get_field_table_name($field) {
  return _serial_get_table_name($field['type_name'], $field['field_name']);
}

/**
 * Gets the name of the assistant table for a specific field.
 *
 * @param $type_name
 *   the name of the type that contains the field
 * @param $field_name
 *   the name of the field
 * @return
 *   the name of the assistant table of the specified field.
 */
function _serial_get_table_name($type_name, $field_name) {
  return db_escape_table('serial_' . $type_name . '_' . $field_name);
}

/**
 * Gets the schema of the assistant tables for generating serial values.
 *
 * @return
 *   the assistant table schema.
 */
function _serial_get_table_schema() {
  return array(
    'fields' => array(
      'sid' => array(
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'The atomic serial field.',
      ),
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Id of the owner node.',
      ),
    ),
    'primary key' => array(
      'sid',
    ),
    'unique keys' => array(
      'nid' => array(
        'nid',
      ),
    ),
  );
}

/**
 * Generates a unique serial value (unique per node type).
 *
 * @param $nid
 *   id of the node for which to generate a serial value
 * @param $field
 *   the serial field
 *
 * @return
 *   the unique serial value number.
 */
function _serial_generate_value($nid, $field, $delete = TRUE) {

  // Insert a temporary record to get a new unique serial value:
  $table = _serial_get_field_table_name($field);
  $query = 'INSERT INTO {' . $table . '} (nid) VALUES(%d)';
  db_query($query, $nid);

  // Retrieve the new unique serial value:
  $query = 'SELECT sid FROM {' . $table . '} WHERE nid = %d';
  $result = db_result(db_query($query, $nid));
  $sid = $result ? $result : 0;

  // Delete old temporary records:
  if ($delete && $sid % 10 == 0) {
    $query = 'DELETE FROM {' . $table . '} WHERE nid < %d';
    db_query($query, $nid);
  }

  // Return the new unique serial value:
  return $sid;
}

/**
 * Initializes the value of a new serial field in existing nodes.
 *
 * @return the number of existing nodes that have been initialized.
 */
function _serial_init_old_nodes($field) {

  // Retrieve all the node ids of that type:
  $query = "SELECT DISTINCT nid FROM {node} WHERE type = '%s' ORDER BY nid";
  $result = db_query($query, $field['type_name']);

  // Allocate a serial number for every old node:
  $count = 0;
  $field_name = $field['field_name'];
  while ($nid = db_result($result)) {
    $node = node_load($nid);
    $node->{$field_name}[0]['value'] = _serial_generate_value($nid, $field, FALSE);
    node_save($node);
    $last_nid = $nid;
    $count++;
  }

  // Delete temporary records (except the last):
  if (isset($last_nid)) {
    $serial_table = _serial_get_field_table_name($field);
    $query = "DELETE FROM {$serial_table} WHERE nid < %d";
    db_query($query, $last_nid);
  }

  // Return the number of existing nodes that have been initialized:
  return $count;
}

Functions

Name	Description
_serial_create_table	Creates an assistant serial table for a new created field.
_serial_drop_table	Drops an assistant serial table for a deleted field.
_serial_generate_value	Generates a unique serial value (unique per node type).
_serial_get_field_table_name	Gets the name of the assistant table for a specific field.
_serial_get_table_name	Gets the name of the assistant table for a specific field.
_serial_get_table_schema	Gets the schema of the assistant tables for generating serial values.
_serial_init_old_nodes	Initializes the value of a new serial field in existing nodes.
_serial_rename_tables	Renames serial table(s) when a content type us renamed.