123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825 |
- <?php
- /**
- * @file
- * Default implementation of the field storage API.
- */
- /**
- * Implements hook_help().
- */
- function field_sql_storage_help($path, $arg) {
- switch ($path) {
- case 'admin/help#field_sql_storage':
- $output = '';
- $output .= '<h3>' . t('About') . '</h3>';
- $output .= '<p>' . t('The Field SQL storage module stores field data in the database. It is the default field storage module; other field storage mechanisms may be available as contributed modules. See the <a href="@field-help">Field module help page</a> for more information about fields.', array('@field-help' => url('admin/help/field'))) . '</p>';
- return $output;
- }
- }
- /**
- * Implements hook_field_storage_info().
- */
- function field_sql_storage_field_storage_info() {
- return array(
- 'field_sql_storage' => array(
- 'label' => t('Default SQL storage'),
- 'description' => t('Stores fields in the local SQL database, using per-field tables.'),
- ),
- );
- }
- /**
- * Generate a table name for a field data table.
- *
- * @param $field
- * The field structure.
- * @return
- * A string containing the generated name for the database table
- */
- function _field_sql_storage_tablename($field) {
- if ($field['deleted']) {
- return "field_deleted_data_{$field['id']}";
- }
- else {
- return "field_data_{$field['field_name']}";
- }
- }
- /**
- * Generate a table name for a field revision archive table.
- *
- * @param $name
- * The field structure.
- * @return
- * A string containing the generated name for the database table
- */
- function _field_sql_storage_revision_tablename($field) {
- if ($field['deleted']) {
- return "field_deleted_revision_{$field['id']}";
- }
- else {
- return "field_revision_{$field['field_name']}";
- }
- }
- /**
- * Generates a table alias for a field data table.
- *
- * The table alias is unique for each unique combination of field name
- * (represented by $tablename), delta_group and language_group.
- *
- * @param $tablename
- * The name of the data table for this field.
- * @param $field_key
- * The numeric key of this field in this query.
- * @param $query
- * The EntityFieldQuery that is executed.
- *
- * @return
- * A string containing the generated table alias.
- */
- function _field_sql_storage_tablealias($tablename, $field_key, EntityFieldQuery $query) {
- // No conditions present: use a unique alias.
- if (empty($query->fieldConditions[$field_key])) {
- return $tablename . $field_key;
- }
- // Find the delta and language condition values and append them to the alias.
- $condition = $query->fieldConditions[$field_key];
- $alias = $tablename;
- $has_group_conditions = FALSE;
- foreach (array('delta', 'language') as $column) {
- if (isset($condition[$column . '_group'])) {
- $alias .= '_' . $column . '_' . $condition[$column . '_group'];
- $has_group_conditions = TRUE;
- }
- }
- // Return the alias when it has delta/language group conditions.
- if ($has_group_conditions) {
- return $alias;
- }
- // Return a unique alias in other cases.
- return $tablename . $field_key;
- }
- /**
- * Generate a column name for a field data table.
- *
- * @param $name
- * The name of the field
- * @param $column
- * The name of the column
- * @return
- * A string containing a generated column name for a field data
- * table that is unique among all other fields.
- */
- function _field_sql_storage_columnname($name, $column) {
- return $name . '_' . $column;
- }
- /**
- * Generate an index name for a field data table.
- *
- * @param $name
- * The name of the field
- * @param $column
- * The name of the index
- * @return
- * A string containing a generated index name for a field data
- * table that is unique among all other fields.
- */
- function _field_sql_storage_indexname($name, $index) {
- return $name . '_' . $index;
- }
- /**
- * Return the database schema for a field. This may contain one or
- * more tables. Each table will contain the columns relevant for the
- * specified field. Leave the $field's 'columns' and 'indexes' keys
- * empty to get only the base schema.
- *
- * @param $field
- * The field structure for which to generate a database schema.
- * @return
- * One or more tables representing the schema for the field.
- */
- function _field_sql_storage_schema($field) {
- $deleted = $field['deleted'] ? 'deleted ' : '';
- $current = array(
- 'description' => "Data storage for {$deleted}field {$field['id']} ({$field['field_name']})",
- 'fields' => array(
- 'entity_type' => array(
- 'type' => 'varchar',
- 'length' => 128,
- 'not null' => TRUE,
- 'default' => '',
- 'description' => 'The entity type this data is attached to',
- ),
- 'bundle' => array(
- 'type' => 'varchar',
- 'length' => 128,
- 'not null' => TRUE,
- 'default' => '',
- 'description' => 'The field instance bundle to which this row belongs, used when deleting a field instance',
- ),
- 'deleted' => array(
- 'type' => 'int',
- 'size' => 'tiny',
- 'not null' => TRUE,
- 'default' => 0,
- 'description' => 'A boolean indicating whether this data item has been deleted'
- ),
- 'entity_id' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'description' => 'The entity id this data is attached to',
- ),
- 'revision_id' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => FALSE,
- 'description' => 'The entity revision id this data is attached to, or NULL if the entity type is not versioned',
- ),
- // @todo Consider storing language as integer.
- 'language' => array(
- 'type' => 'varchar',
- 'length' => 32,
- 'not null' => TRUE,
- 'default' => '',
- 'description' => 'The language for this data item.',
- ),
- 'delta' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'description' => 'The sequence number for this data item, used for multi-value fields',
- ),
- ),
- 'primary key' => array('entity_type', 'entity_id', 'deleted', 'delta', 'language'),
- 'indexes' => array(
- 'entity_type' => array('entity_type'),
- 'bundle' => array('bundle'),
- 'deleted' => array('deleted'),
- 'entity_id' => array('entity_id'),
- 'revision_id' => array('revision_id'),
- 'language' => array('language'),
- ),
- );
- $field += array('columns' => array(), 'indexes' => array(), 'foreign keys' => array());
- // Add field columns.
- foreach ($field['columns'] as $column_name => $attributes) {
- $real_name = _field_sql_storage_columnname($field['field_name'], $column_name);
- $current['fields'][$real_name] = $attributes;
- }
- // Add indexes.
- foreach ($field['indexes'] as $index_name => $columns) {
- $real_name = _field_sql_storage_indexname($field['field_name'], $index_name);
- foreach ($columns as $column_name) {
- // Indexes can be specified as either a column name or an array with
- // column name and length. Allow for either case.
- if (is_array($column_name)) {
- $current['indexes'][$real_name][] = array(
- _field_sql_storage_columnname($field['field_name'], $column_name[0]),
- $column_name[1],
- );
- }
- else {
- $current['indexes'][$real_name][] = _field_sql_storage_columnname($field['field_name'], $column_name);
- }
- }
- }
- // Add foreign keys.
- foreach ($field['foreign keys'] as $specifier => $specification) {
- $real_name = _field_sql_storage_indexname($field['field_name'], $specifier);
- $current['foreign keys'][$real_name]['table'] = $specification['table'];
- foreach ($specification['columns'] as $column_name => $referenced) {
- $sql_storage_column = _field_sql_storage_columnname($field['field_name'], $column_name);
- $current['foreign keys'][$real_name]['columns'][$sql_storage_column] = $referenced;
- }
- }
- // Construct the revision table.
- $revision = $current;
- $revision['description'] = "Revision archive storage for {$deleted}field {$field['id']} ({$field['field_name']})";
- $revision['primary key'] = array('entity_type', 'entity_id', 'revision_id', 'deleted', 'delta', 'language');
- $revision['fields']['revision_id']['not null'] = TRUE;
- $revision['fields']['revision_id']['description'] = 'The entity revision id this data is attached to';
- return array(
- _field_sql_storage_tablename($field) => $current,
- _field_sql_storage_revision_tablename($field) => $revision,
- );
- }
- /**
- * Implements hook_field_storage_create_field().
- */
- function field_sql_storage_field_storage_create_field($field) {
- $schema = _field_sql_storage_schema($field);
- foreach ($schema as $name => $table) {
- db_create_table($name, $table);
- }
- drupal_get_schema(NULL, TRUE);
- }
- /**
- * Implements hook_field_update_forbid().
- *
- * Forbid any field update that changes column definitions if there is
- * any data.
- */
- function field_sql_storage_field_update_forbid($field, $prior_field, $has_data) {
- if ($has_data && $field['columns'] != $prior_field['columns']) {
- throw new FieldUpdateForbiddenException("field_sql_storage cannot change the schema for an existing field with data.");
- }
- }
- /**
- * Implements hook_field_storage_update_field().
- */
- function field_sql_storage_field_storage_update_field($field, $prior_field, $has_data) {
- if (! $has_data) {
- // There is no data. Re-create the tables completely.
- if (Database::getConnection()->supportsTransactionalDDL()) {
- // If the database supports transactional DDL, we can go ahead and rely
- // on it. If not, we will have to rollback manually if something fails.
- $transaction = db_transaction();
- }
- try {
- $prior_schema = _field_sql_storage_schema($prior_field);
- foreach ($prior_schema as $name => $table) {
- db_drop_table($name, $table);
- }
- $schema = _field_sql_storage_schema($field);
- foreach ($schema as $name => $table) {
- db_create_table($name, $table);
- }
- }
- catch (Exception $e) {
- if (Database::getConnection()->supportsTransactionalDDL()) {
- $transaction->rollback();
- }
- else {
- // Recreate tables.
- $prior_schema = _field_sql_storage_schema($prior_field);
- foreach ($prior_schema as $name => $table) {
- if (!db_table_exists($name)) {
- db_create_table($name, $table);
- }
- }
- }
- throw $e;
- }
- }
- else {
- // There is data, so there are no column changes. Drop all the
- // prior indexes and create all the new ones, except for all the
- // priors that exist unchanged.
- $table = _field_sql_storage_tablename($prior_field);
- $revision_table = _field_sql_storage_revision_tablename($prior_field);
- foreach ($prior_field['indexes'] as $name => $columns) {
- if (!isset($field['indexes'][$name]) || $columns != $field['indexes'][$name]) {
- $real_name = _field_sql_storage_indexname($field['field_name'], $name);
- db_drop_index($table, $real_name);
- db_drop_index($revision_table, $real_name);
- }
- }
- $table = _field_sql_storage_tablename($field);
- $revision_table = _field_sql_storage_revision_tablename($field);
- foreach ($field['indexes'] as $name => $columns) {
- if (!isset($prior_field['indexes'][$name]) || $columns != $prior_field['indexes'][$name]) {
- $real_name = _field_sql_storage_indexname($field['field_name'], $name);
- $real_columns = array();
- foreach ($columns as $column_name) {
- // Indexes can be specified as either a column name or an array with
- // column name and length. Allow for either case.
- if (is_array($column_name)) {
- $real_columns[] = array(
- _field_sql_storage_columnname($field['field_name'], $column_name[0]),
- $column_name[1],
- );
- }
- else {
- $real_columns[] = _field_sql_storage_columnname($field['field_name'], $column_name);
- }
- }
- db_add_index($table, $real_name, $real_columns);
- db_add_index($revision_table, $real_name, $real_columns);
- }
- }
- }
- drupal_get_schema(NULL, TRUE);
- }
- /**
- * Implements hook_field_storage_delete_field().
- */
- function field_sql_storage_field_storage_delete_field($field) {
- // Mark all data associated with the field for deletion.
- $field['deleted'] = 0;
- $table = _field_sql_storage_tablename($field);
- $revision_table = _field_sql_storage_revision_tablename($field);
- db_update($table)
- ->fields(array('deleted' => 1))
- ->execute();
- // Move the table to a unique name while the table contents are being deleted.
- $field['deleted'] = 1;
- $new_table = _field_sql_storage_tablename($field);
- $revision_new_table = _field_sql_storage_revision_tablename($field);
- db_rename_table($table, $new_table);
- db_rename_table($revision_table, $revision_new_table);
- drupal_get_schema(NULL, TRUE);
- }
- /**
- * Implements hook_field_storage_load().
- */
- function field_sql_storage_field_storage_load($entity_type, $entities, $age, $fields, $options) {
- $load_current = $age == FIELD_LOAD_CURRENT;
- foreach ($fields as $field_id => $ids) {
- // By the time this hook runs, the relevant field definitions have been
- // populated and cached in FieldInfo, so calling field_info_field_by_id()
- // on each field individually is more efficient than loading all fields in
- // memory upfront with field_info_field_by_ids().
- $field = field_info_field_by_id($field_id);
- $field_name = $field['field_name'];
- $table = $load_current ? _field_sql_storage_tablename($field) : _field_sql_storage_revision_tablename($field);
- $query = db_select($table, 't')
- ->fields('t')
- ->condition('entity_type', $entity_type)
- ->condition($load_current ? 'entity_id' : 'revision_id', $ids, 'IN')
- ->condition('language', field_available_languages($entity_type, $field), 'IN')
- ->orderBy('delta');
- if (empty($options['deleted'])) {
- $query->condition('deleted', 0);
- }
- $results = $query->execute();
- $delta_count = array();
- foreach ($results as $row) {
- if (!isset($delta_count[$row->entity_id][$row->language])) {
- $delta_count[$row->entity_id][$row->language] = 0;
- }
- if ($field['cardinality'] == FIELD_CARDINALITY_UNLIMITED || $delta_count[$row->entity_id][$row->language] < $field['cardinality']) {
- $item = array();
- // For each column declared by the field, populate the item
- // from the prefixed database column.
- foreach ($field['columns'] as $column => $attributes) {
- $column_name = _field_sql_storage_columnname($field_name, $column);
- $item[$column] = $row->$column_name;
- }
- // Add the item to the field values for the entity.
- $entities[$row->entity_id]->{$field_name}[$row->language][] = $item;
- $delta_count[$row->entity_id][$row->language]++;
- }
- }
- }
- }
- /**
- * Implements hook_field_storage_write().
- */
- function field_sql_storage_field_storage_write($entity_type, $entity, $op, $fields) {
- list($id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
- if (!isset($vid)) {
- $vid = $id;
- }
- foreach ($fields as $field_id) {
- $field = field_info_field_by_id($field_id);
- $field_name = $field['field_name'];
- $table_name = _field_sql_storage_tablename($field);
- $revision_name = _field_sql_storage_revision_tablename($field);
- $all_languages = field_available_languages($entity_type, $field);
- $field_languages = array_intersect($all_languages, array_keys((array) $entity->$field_name));
- // Delete and insert, rather than update, in case a value was added.
- if ($op == FIELD_STORAGE_UPDATE) {
- // Delete languages present in the incoming $entity->$field_name.
- // Delete all languages if $entity->$field_name is empty.
- $languages = !empty($entity->$field_name) ? $field_languages : $all_languages;
- if ($languages) {
- db_delete($table_name)
- ->condition('entity_type', $entity_type)
- ->condition('entity_id', $id)
- ->condition('language', $languages, 'IN')
- ->execute();
- db_delete($revision_name)
- ->condition('entity_type', $entity_type)
- ->condition('entity_id', $id)
- ->condition('revision_id', $vid)
- ->condition('language', $languages, 'IN')
- ->execute();
- }
- }
- // Prepare the multi-insert query.
- $do_insert = FALSE;
- $columns = array('entity_type', 'entity_id', 'revision_id', 'bundle', 'delta', 'language');
- foreach ($field['columns'] as $column => $attributes) {
- $columns[] = _field_sql_storage_columnname($field_name, $column);
- }
- $query = db_insert($table_name)->fields($columns);
- $revision_query = db_insert($revision_name)->fields($columns);
- foreach ($field_languages as $langcode) {
- $items = (array) $entity->{$field_name}[$langcode];
- $delta_count = 0;
- foreach ($items as $delta => $item) {
- // We now know we have something to insert.
- $do_insert = TRUE;
- $record = array(
- 'entity_type' => $entity_type,
- 'entity_id' => $id,
- 'revision_id' => $vid,
- 'bundle' => $bundle,
- 'delta' => $delta,
- 'language' => $langcode,
- );
- foreach ($field['columns'] as $column => $attributes) {
- $record[_field_sql_storage_columnname($field_name, $column)] = isset($item[$column]) ? $item[$column] : NULL;
- }
- $query->values($record);
- if (isset($vid)) {
- $revision_query->values($record);
- }
- if ($field['cardinality'] != FIELD_CARDINALITY_UNLIMITED && ++$delta_count == $field['cardinality']) {
- break;
- }
- }
- }
- // Execute the query if we have values to insert.
- if ($do_insert) {
- $query->execute();
- $revision_query->execute();
- }
- }
- }
- /**
- * Implements hook_field_storage_delete().
- *
- * This function deletes data for all fields for an entity from the database.
- */
- function field_sql_storage_field_storage_delete($entity_type, $entity, $fields) {
- list($id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
- foreach (field_info_instances($entity_type, $bundle) as $instance) {
- if (isset($fields[$instance['field_id']])) {
- $field = field_info_field_by_id($instance['field_id']);
- field_sql_storage_field_storage_purge($entity_type, $entity, $field, $instance);
- }
- }
- }
- /**
- * Implements hook_field_storage_purge().
- *
- * This function deletes data from the database for a single field on
- * an entity.
- */
- function field_sql_storage_field_storage_purge($entity_type, $entity, $field, $instance) {
- list($id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
- $table_name = _field_sql_storage_tablename($field);
- $revision_name = _field_sql_storage_revision_tablename($field);
- db_delete($table_name)
- ->condition('entity_type', $entity_type)
- ->condition('entity_id', $id)
- ->execute();
- db_delete($revision_name)
- ->condition('entity_type', $entity_type)
- ->condition('entity_id', $id)
- ->execute();
- }
- /**
- * Implements hook_field_storage_query().
- */
- function field_sql_storage_field_storage_query(EntityFieldQuery $query) {
- if ($query->age == FIELD_LOAD_CURRENT) {
- $tablename_function = '_field_sql_storage_tablename';
- $id_key = 'entity_id';
- }
- else {
- $tablename_function = '_field_sql_storage_revision_tablename';
- $id_key = 'revision_id';
- }
- $table_aliases = array();
- $query_tables = NULL;
- // Add tables for the fields used.
- foreach ($query->fields as $key => $field) {
- $tablename = $tablename_function($field);
- $table_alias = _field_sql_storage_tablealias($tablename, $key, $query);
- $table_aliases[$key] = $table_alias;
- if ($key) {
- if (!isset($query_tables[$table_alias])) {
- $select_query->join($tablename, $table_alias, "$table_alias.entity_type = $field_base_table.entity_type AND $table_alias.$id_key = $field_base_table.$id_key");
- }
- }
- else {
- $select_query = db_select($tablename, $table_alias);
- // Store a reference to the list of joined tables.
- $query_tables =& $select_query->getTables();
- // Allow queries internal to the Field API to opt out of the access
- // check, for situations where the query's results should not depend on
- // the access grants for the current user.
- if (!isset($query->tags['DANGEROUS_ACCESS_CHECK_OPT_OUT'])) {
- $select_query->addTag('entity_field_access');
- }
- $select_query->addMetaData('base_table', $tablename);
- $select_query->fields($table_alias, array('entity_type', 'entity_id', 'revision_id', 'bundle'));
- $field_base_table = $table_alias;
- }
- if ($field['cardinality'] != 1 || $field['translatable']) {
- $select_query->distinct();
- }
- }
- // Add field conditions. We need a fresh grouping cache.
- drupal_static_reset('_field_sql_storage_query_field_conditions');
- _field_sql_storage_query_field_conditions($query, $select_query, $query->fieldConditions, $table_aliases, '_field_sql_storage_columnname');
- // Add field meta conditions.
- _field_sql_storage_query_field_conditions($query, $select_query, $query->fieldMetaConditions, $table_aliases, '_field_sql_storage_query_columnname');
- if (isset($query->deleted)) {
- $select_query->condition("$field_base_table.deleted", (int) $query->deleted);
- }
- // Is there a need to sort the query by property?
- $has_property_order = FALSE;
- foreach ($query->order as $order) {
- if ($order['type'] == 'property') {
- $has_property_order = TRUE;
- }
- }
- if ($query->propertyConditions || $has_property_order) {
- if (empty($query->entityConditions['entity_type']['value'])) {
- throw new EntityFieldQueryException('Property conditions and orders must have an entity type defined.');
- }
- $entity_type = $query->entityConditions['entity_type']['value'];
- $entity_base_table = _field_sql_storage_query_join_entity($select_query, $entity_type, $field_base_table);
- $query->entityConditions['entity_type']['operator'] = '=';
- foreach ($query->propertyConditions as $property_condition) {
- $query->addCondition($select_query, "$entity_base_table." . $property_condition['column'], $property_condition);
- }
- }
- foreach ($query->entityConditions as $key => $condition) {
- $query->addCondition($select_query, "$field_base_table.$key", $condition);
- }
- // Order the query.
- foreach ($query->order as $order) {
- if ($order['type'] == 'entity') {
- $key = $order['specifier'];
- $select_query->orderBy("$field_base_table.$key", $order['direction']);
- }
- elseif ($order['type'] == 'field') {
- $specifier = $order['specifier'];
- $field = $specifier['field'];
- $table_alias = $table_aliases[$specifier['index']];
- $sql_field = "$table_alias." . _field_sql_storage_columnname($field['field_name'], $specifier['column']);
- $select_query->orderBy($sql_field, $order['direction']);
- }
- elseif ($order['type'] == 'property') {
- $select_query->orderBy("$entity_base_table." . $order['specifier'], $order['direction']);
- }
- }
- return $query->finishQuery($select_query, $id_key);
- }
- /**
- * Adds the base entity table to a field query object.
- *
- * @param SelectQuery $select_query
- * A SelectQuery containing at least one table as specified by
- * _field_sql_storage_tablename().
- * @param $entity_type
- * The entity type for which the base table should be joined.
- * @param $field_base_table
- * Name of a table in $select_query. As only INNER JOINs are used, it does
- * not matter which.
- *
- * @return
- * The name of the entity base table joined in.
- */
- function _field_sql_storage_query_join_entity(SelectQuery $select_query, $entity_type, $field_base_table) {
- $entity_info = entity_get_info($entity_type);
- $entity_base_table = $entity_info['base table'];
- $entity_field = $entity_info['entity keys']['id'];
- $select_query->join($entity_base_table, $entity_base_table, "$entity_base_table.$entity_field = $field_base_table.entity_id");
- return $entity_base_table;
- }
- /**
- * Adds field (meta) conditions to the given query objects respecting groupings.
- *
- * @param EntityFieldQuery $query
- * The field query object to be processed.
- * @param SelectQuery $select_query
- * The SelectQuery that should get grouping conditions.
- * @param condtions
- * The conditions to be added.
- * @param $table_aliases
- * An associative array of table aliases keyed by field index.
- * @param $column_callback
- * A callback that should return the column name to be used for the field
- * conditions. Accepts a field name and a field column name as parameters.
- */
- function _field_sql_storage_query_field_conditions(EntityFieldQuery $query, SelectQuery $select_query, $conditions, $table_aliases, $column_callback) {
- $groups = &drupal_static(__FUNCTION__, array());
- foreach ($conditions as $key => $condition) {
- $table_alias = $table_aliases[$key];
- $field = $condition['field'];
- // Add the specified condition.
- $sql_field = "$table_alias." . $column_callback($field['field_name'], $condition['column']);
- $query->addCondition($select_query, $sql_field, $condition);
- // Add delta / language group conditions.
- foreach (array('delta', 'language') as $column) {
- if (isset($condition[$column . '_group'])) {
- $group_name = $condition[$column . '_group'];
- if (!isset($groups[$column][$group_name])) {
- $groups[$column][$group_name] = $table_alias;
- }
- else {
- $select_query->where("$table_alias.$column = " . $groups[$column][$group_name] . ".$column");
- }
- }
- }
- }
- }
- /**
- * Field meta condition column callback.
- */
- function _field_sql_storage_query_columnname($field_name, $column) {
- return $column;
- }
- /**
- * Implements hook_field_storage_delete_revision().
- *
- * This function actually deletes the data from the database.
- */
- function field_sql_storage_field_storage_delete_revision($entity_type, $entity, $fields) {
- list($id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
- if (isset($vid)) {
- foreach ($fields as $field_id) {
- $field = field_info_field_by_id($field_id);
- $revision_name = _field_sql_storage_revision_tablename($field);
- db_delete($revision_name)
- ->condition('entity_type', $entity_type)
- ->condition('entity_id', $id)
- ->condition('revision_id', $vid)
- ->execute();
- }
- }
- }
- /**
- * Implements hook_field_storage_delete_instance().
- *
- * This function simply marks for deletion all data associated with the field.
- */
- function field_sql_storage_field_storage_delete_instance($instance) {
- $field = field_info_field($instance['field_name']);
- $table_name = _field_sql_storage_tablename($field);
- $revision_name = _field_sql_storage_revision_tablename($field);
- db_update($table_name)
- ->fields(array('deleted' => 1))
- ->condition('entity_type', $instance['entity_type'])
- ->condition('bundle', $instance['bundle'])
- ->execute();
- db_update($revision_name)
- ->fields(array('deleted' => 1))
- ->condition('entity_type', $instance['entity_type'])
- ->condition('bundle', $instance['bundle'])
- ->execute();
- }
- /**
- * Implements hook_field_attach_rename_bundle().
- */
- function field_sql_storage_field_attach_rename_bundle($entity_type, $bundle_old, $bundle_new) {
- // We need to account for deleted or inactive fields and instances.
- $instances = field_read_instances(array('entity_type' => $entity_type, 'bundle' => $bundle_new), array('include_deleted' => TRUE, 'include_inactive' => TRUE));
- foreach ($instances as $instance) {
- $field = field_info_field_by_id($instance['field_id']);
- if ($field['storage']['type'] == 'field_sql_storage') {
- $table_name = _field_sql_storage_tablename($field);
- $revision_name = _field_sql_storage_revision_tablename($field);
- db_update($table_name)
- ->fields(array('bundle' => $bundle_new))
- ->condition('entity_type', $entity_type)
- ->condition('bundle', $bundle_old)
- ->execute();
- db_update($revision_name)
- ->fields(array('bundle' => $bundle_new))
- ->condition('entity_type', $entity_type)
- ->condition('bundle', $bundle_old)
- ->execute();
- }
- }
- }
- /**
- * Implements hook_field_storage_purge_field().
- *
- * All field data items and instances have already been purged, so all
- * that is left is to delete the table.
- */
- function field_sql_storage_field_storage_purge_field($field) {
- $table_name = _field_sql_storage_tablename($field);
- $revision_name = _field_sql_storage_revision_tablename($field);
- db_drop_table($table_name);
- db_drop_table($revision_name);
- }
- /**
- * Implements hook_field_storage_details().
- */
- function field_sql_storage_field_storage_details($field) {
- $details = array();
- if (!empty($field['columns'])) {
- // Add field columns.
- foreach ($field['columns'] as $column_name => $attributes) {
- $real_name = _field_sql_storage_columnname($field['field_name'], $column_name);
- $columns[$column_name] = $real_name;
- }
- return array(
- 'sql' => array(
- FIELD_LOAD_CURRENT => array(
- _field_sql_storage_tablename($field) => $columns,
- ),
- FIELD_LOAD_REVISION => array(
- _field_sql_storage_revision_tablename($field) => $columns,
- ),
- ),
- );
- }
- }
|