tablefield.install in TableField 7.2

Installation options for TableField.

File

tablefield.install

<?php

/**
 * @file
 * Installation options for TableField.
 */

/**
 * Implements hook_uninstall().
 */
function tablefield_uninstall() {
  variable_del('tablefield_csv_separator');
  variable_del('tablefield_detect_encodings');
}

/**
 * Implements hook_update_dependencies().
 */
function tablefield_update_dependencies() {

  // Ensure that format columns are only changed after Filter module has changed
  // the primary records.
  $dependencies['text'][7000] = array(
    'filter' => 7010,
  );
  return $dependencies;
}

/**
 * Implements hook_field_schema().
 */
function tablefield_field_schema($field) {
  return array(
    'columns' => array(
      'value' => array(
        'type' => 'text',
        'size' => 'big',
      ),
      'format' => array(
        'type' => 'varchar',
        'length' => 255,
        'default value' => '',
      ),
    ),
  );
}

/**
 * Helper function for updating/repairing the database schema.
 */
function tablefield_repair_schema() {
  $spec = array(
    'type' => 'varchar',
    'length' => 255,
    'not null' => FALSE,
  );
  $fields = _update_7000_field_read_fields(array(
    'module' => 'tablefield',
    'storage_type' => 'field_sql_storage',
  ));
  foreach ($fields as $field_name => $field) {
    if ($field['deleted']) {
      $table = "field_deleted_data_{$field['id']}";
      $revision_table = "field_deleted_revision_{$field['id']}";
    }
    else {
      $table = "field_data_{$field['field_name']}";
      $revision_table = "field_revision_{$field['field_name']}";
    }
    $column = $field['field_name'] . '_format';
    db_change_field($table, $column, $column, $spec);
    db_change_field($revision_table, $column, $column, $spec);
  }
}

/**
 * Update schema to handle machine names of input filter formats.
 */
function tablefield_update_7000() {
  tablefield_repair_schema();
}

/**
 * Fix columns created by versions prior to beta1.
 */
function tablefield_update_7001() {
  tablefield_repair_schema();
}

/**
 * Change default field_formatter name from 'default' to 'tablefield_default'.
 */
function tablefield_update_7002() {
  $fields = field_read_fields(array(
    'type' => 'tablefield',
  ));

  // Tablefield enabled but no tablefields.
  if (!is_array($fields) || !count($fields)) {
    return;
  }
  $instances = field_read_instances(array(
    'field_id' => array_keys($fields),
  ));
  foreach ($instances as $instance) {
    foreach ($instance['display'] as $d => $display) {
      if ($display['type'] == 'default') {
        $instance['display'][$d]['type'] = 'tablefield_default';
        field_update_instance($instance);
      }
    }
  }
}

/**
 * Re-save the default existing table fields and all entities containing them.
 */
function tablefield_update_7003() {

  // Change the default field for each content type.
  $instances = field_info_instances();
  $field_names = array();
  foreach ($instances as $entity_type => $entities) {
    foreach ($entities as $bundle => $fields) {
      foreach ($fields as $field_name => $instance) {
        if (in_array($instance['widget']['type'], array(
          'tablefield',
        ))) {

          // Uniquely store the field names in an array for later use.
          if (!in_array($instance['field_name'], $field_names)) {
            array_push($field_names, $instance['field_name']);
          }

          // Rationalize the table data.
          if (!empty($instance['default_value'][0]['tablefield'])) {

            // Remove extraneous data.
            $count_cols = $instance['default_value'][0]['tablefield']['rebuild']['count_cols'];
            $count_rows = $instance['default_value'][0]['tablefield']['rebuild']['count_rows'];
            $caption = $instance['default_value'][0]['tablefield']['caption'];
            $rebuild = $instance['default_value'][0]['tablefield']['rebuild'];
            $import = $instance['default_value'][0]['tablefield']['import'];
            $paste = $instance['default_value'][0]['tablefield']['paste'];
            unset($instance['default_value'][0]['tablefield']['caption']);
            unset($instance['default_value'][0]['tablefield']['rebuild']);
            unset($instance['default_value'][0]['tablefield']['import']);
            unset($instance['default_value'][0]['tablefield']['paste']);
            foreach ($instance['default_value'][0]['tablefield'] as $key => $value) {
              if (preg_match('/cell_(.*)_(.*)/', $key, $cell)) {

                // $cell[1] is row count $cell[2] is col count.
                if ((int) $cell[1] < $count_rows && (int) $cell[2] < $count_cols) {
                  $cel = explode('_', ltrim($key, 'cell_'));
                  if ($cel[1] === 'weight') {
                    $instance['default_value'][0]['tablefield']['tabledata']['row_' . $cel[0]]['weight'] = $value;
                  }
                  else {
                    $instance['default_value'][0]['tablefield']['tabledata']['row_' . $cel[0]]['col_' . $cel[1]] = $value;
                  }
                  unset($instance['default_value'][0]['tablefield'][$key]);
                }
              }
            }
          }

          // Recreate previous removed data.
          $instance['default_value'][0]['tablefield']['caption'] = $caption;
          $instance['default_value'][0]['tablefield']['rebuild'] = $rebuild;
          $instance['default_value'][0]['tablefield']['import'] = $import;
          $instance['default_value'][0]['tablefield']['paste'] = $paste;
          field_update_instance($instance);
        }
      }
    }
  }

  // Change all existing fields to store the data with the new format.
  foreach ($field_names as $field_name) {
    $tables = array(
      'field_data_' . $field_name,
      'field_revision_' . $field_name,
    );
    foreach ($tables as $table) {
      $field = $field_name . '_value';
      $query = db_select($table, 'n')
        ->fields('n')
        ->execute()
        ->fetchAll();
      foreach ($query as $record) {
        $instance = unserialize($record->{$field});

        // Rationalize the table data.
        if (!empty($instance)) {

          // Remove extraneous data.
          $count_cols = $instance['rebuild']['count_cols'];
          $count_rows = $instance['rebuild']['count_rows'];
          $caption = $instance['caption'];
          $rebuild = $instance['rebuild'];
          $import = $instance['import'];
          $paste = $instance['paste'];
          unset($instance['caption']);
          unset($instance['rebuild']);
          unset($instance['import']);
          unset($instance['paste']);
          foreach ($instance as $key => $value) {
            if (preg_match('/cell_(.*)_(.*)/', $key, $cell)) {

              // $cell[1] is row count $cell[2] is col count.
              if ((int) $cell[1] < $count_rows && (int) $cell[2] < $count_cols) {
                $cel = explode('_', ltrim($key, 'cell_'));
                if ($cel[1] === 'weight') {
                  $instance['tabledata']['row_' . $cel[0]]['weight'] = $value;
                }
                else {
                  $instance['tabledata']['row_' . $cel[0]]['col_' . $cel[1]] = $value;
                }
                unset($instance[$key]);
              }
            }
          }
        }

        // Recreate previous removed data.
        $instance['caption'] = $caption;
        $instance['rebuild'] = $rebuild;
        $instance['import'] = $import;
        $instance['paste'] = $paste;

        // Change the stored data by a per record unique column key combination.
        db_update($table)
          ->fields(array(
          $field => serialize($instance),
        ))
          ->condition('entity_id', $record->entity_id)
          ->condition('revision_id', $record->revision_id)
          ->condition('delta', $record->delta)
          ->condition('entity_type', $record->entity_type)
          ->condition('bundle', $record->bundle)
          ->execute();
      }
    }
  }
  field_cache_clear();
  drupal_set_message(t('All Table Field fields are now stored with a new data format.'), 'warning');
}

/**
 * Convert field settings to display settings.
 */
function tablefield_update_7004() {
  $instances = field_info_instances();
  $field_names = array();
  foreach ($instances as $entity_type => $entities) {
    foreach ($entities as $bundle => $fields) {
      foreach ($fields as $field_name => $instance) {
        $field_info = field_info_field($field_name);
        if (in_array($instance['widget']['type'], array(
          'tablefield',
        ))) {

          // Uniquely store the field names in an array for later use.
          if (!in_array($instance['field_name'], $field_names)) {
            array_push($field_names, $instance['field_name']);
          }

          // Convert the entity properties.
          foreach ($instance['display'] as $view_mode => $occurrence) {
            $instance['display'][$view_mode]['settings']['hide_header'] = $field_info['settings']['hide_headers'] ? 1 : 0;
            $instance['display'][$view_mode]['settings']['export_csv'] = $field_info['settings']['export'] ? 1 : 0;
          }
          field_update_instance($instance);
        }
      }
    }
  }
  field_cache_clear();
  drupal_set_message(t('All Table Field fields have their display related field settings converted to display settings.'), 'warning');
}

Functions

Name	Description
tablefield_field_schema	Implements hook_field_schema().
tablefield_repair_schema	Helper function for updating/repairing the database schema.
tablefield_uninstall	Implements hook_uninstall().
tablefield_update_7000	Update schema to handle machine names of input filter formats.
tablefield_update_7001	Fix columns created by versions prior to beta1.
tablefield_update_7002	Change default field_formatter name from 'default' to 'tablefield_default'.
tablefield_update_7003	Re-save the default existing table fields and all entities containing them.
tablefield_update_7004	Convert field settings to display settings.
tablefield_update_dependencies	Implements hook_update_dependencies().