12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010 |
- <?php
- function field_create_field($field) {
-
- if (empty($field['field_name'])) {
- throw new FieldException('Attempt to create an unnamed field.');
- }
-
- if (empty($field['type'])) {
- throw new FieldException(format_string('Attempt to create field @field_name with no type.', array('@field_name' => $field['field_name'])));
- }
-
- if (!preg_match('/^[_a-z]+[_a-z0-9]*$/', $field['field_name'])) {
- throw new FieldException(format_string('Attempt to create a field @field_name with invalid characters. Only lowercase alphanumeric characters and underscores are allowed, and only lowercase letters and underscore are allowed as the first character', array('@field_name' => $field['field_name'])));
- }
-
-
-
- if (drupal_strlen($field['field_name']) > 32) {
- throw new FieldException(t('Attempt to create a field with a name longer than 32 characters: %name',
- array('%name' => $field['field_name'])));
- }
-
-
- $prior_field = field_read_field($field['field_name'], array('include_inactive' => TRUE));
- if (!empty($prior_field)) {
- $message = $prior_field['active']?
- t('Attempt to create field name %name which already exists and is active.', array('%name' => $field['field_name'])):
- t('Attempt to create field name %name which already exists, although it is inactive.', array('%name' => $field['field_name']));
- throw new FieldException($message);
- }
-
-
-
- foreach (entity_get_info() as $type => $info) {
- if (in_array($field['field_name'], $info['entity keys'])) {
- throw new FieldException(t('Attempt to create field name %name which is reserved by entity type %type.', array('%name' => $field['field_name'], '%type' => $type)));
- }
- }
- $field += array(
- 'entity_types' => array(),
- 'cardinality' => 1,
- 'translatable' => FALSE,
- 'locked' => FALSE,
- 'settings' => array(),
- 'storage' => array(),
- 'deleted' => 0,
- );
-
- $field_type = field_info_field_types($field['type']);
- if (!$field_type) {
- throw new FieldException(t('Attempt to create a field of unknown type %type.', array('%type' => $field['type'])));
- }
-
-
- $field['settings'] += field_info_field_settings($field['type']);
- $field['module'] = $field_type['module'];
- $field['active'] = 1;
-
- $field['storage'] += array(
- 'type' => variable_get('field_storage_default', 'field_sql_storage'),
- 'settings' => array(),
- );
-
- $storage_type = field_info_storage_types($field['storage']['type']);
- if (!$storage_type) {
- throw new FieldException(t('Attempt to create a field with unknown storage type %type.', array('%type' => $field['storage']['type'])));
- }
-
- $field['storage']['settings'] += field_info_storage_settings($field['storage']['type']);
- $field['storage']['module'] = $storage_type['module'];
- $field['storage']['active'] = 1;
-
- module_load_install($field['module']);
- $schema = (array) module_invoke($field['module'], 'field_schema', $field);
- $schema += array('columns' => array(), 'indexes' => array(), 'foreign keys' => array());
-
- $field['columns'] = $schema['columns'];
-
- $field['foreign keys'] = $schema['foreign keys'];
-
-
- $field += array(
- 'indexes' => array(),
- );
- $field['indexes'] += $schema['indexes'];
-
-
-
- $data = $field;
- unset($data['columns'], $data['field_name'], $data['type'], $data['active'], $data['module'], $data['storage_type'], $data['storage_active'], $data['storage_module'], $data['locked'], $data['cardinality'], $data['deleted']);
-
-
- unset($data['bundles']);
- $record = array(
- 'field_name' => $field['field_name'],
- 'type' => $field['type'],
- 'module' => $field['module'],
- 'active' => $field['active'],
- 'storage_type' => $field['storage']['type'],
- 'storage_module' => $field['storage']['module'],
- 'storage_active' => $field['storage']['active'],
- 'locked' => $field['locked'],
- 'data' => $data,
- 'cardinality' => $field['cardinality'],
- 'translatable' => $field['translatable'],
- 'deleted' => $field['deleted'],
- );
-
- drupal_write_record('field_config', $record);
- $field['id'] = $record['id'];
-
-
- try {
-
-
- module_invoke($storage_type['module'], 'field_storage_create_field', $field);
- }
- catch (Exception $e) {
-
-
- db_delete('field_config')
- ->condition('id', $field['id'])
- ->execute();
- throw $e;
- }
-
- field_cache_clear();
-
- module_invoke_all('field_create_field', $field);
- return $field;
- }
- function field_update_field($field) {
-
- $prior_field = field_read_field($field['field_name']);
- if (empty($prior_field)) {
- throw new FieldException('Attempt to update a non-existent field.');
- }
-
-
- $field += $prior_field;
- $field['settings'] += $prior_field['settings'];
-
- if ($field['type'] != $prior_field['type']) {
- throw new FieldException("Cannot change an existing field's type.");
- }
- if ($field['entity_types'] != $prior_field['entity_types']) {
- throw new FieldException("Cannot change an existing field's entity_types property.");
- }
- if ($field['storage']['type'] != $prior_field['storage']['type']) {
- throw new FieldException("Cannot change an existing field's storage type.");
- }
-
-
- module_load_install($field['module']);
- $schema = (array) module_invoke($field['module'], 'field_schema', $field);
- $schema += array('columns' => array(), 'indexes' => array(), 'foreign keys' => array());
-
- $field['columns'] = $schema['columns'];
-
- $field['foreign keys'] = $schema['foreign keys'];
-
-
- $field += array(
- 'indexes' => array(),
- );
- $field['indexes'] += $schema['indexes'];
- $has_data = field_has_data($field);
-
- foreach (module_implements('field_update_forbid') as $module) {
- $function = $module . '_field_update_forbid';
- $function($field, $prior_field, $has_data);
- }
-
-
- $storage_type = field_info_storage_types($field['storage']['type']);
- module_invoke($storage_type['module'], 'field_storage_update_field', $field, $prior_field, $has_data);
-
-
-
-
-
- $data = $field;
- unset($data['columns'], $data['field_name'], $data['type'], $data['locked'], $data['module'], $data['cardinality'], $data['active'], $data['deleted']);
-
-
- unset($data['bundles']);
- $field['data'] = $data;
-
- $primary_key = array('id');
- drupal_write_record('field_config', $field, $primary_key);
-
- field_cache_clear();
-
- module_invoke_all('field_update_field', $field, $prior_field, $has_data);
- }
- function field_read_field($field_name, $include_additional = array()) {
- $fields = field_read_fields(array('field_name' => $field_name), $include_additional);
- return $fields ? current($fields) : FALSE;
- }
- function field_read_fields($params = array(), $include_additional = array()) {
- $query = db_select('field_config', 'fc', array('fetch' => PDO::FETCH_ASSOC));
- $query->fields('fc');
-
- foreach ($params as $key => $value) {
-
-
- if ($key == 'entity_type' || $key == 'bundle') {
- if (empty($fci_join)) {
- $fci_join = $query->join('field_config_instance', 'fci', 'fc.id = fci.field_id');
- }
- $key = 'fci.' . $key;
- }
- else {
- $key = 'fc.' . $key;
- }
- $query->condition($key, $value);
- }
- if (!isset($include_additional['include_inactive']) || !$include_additional['include_inactive']) {
- $query
- ->condition('fc.active', 1)
- ->condition('fc.storage_active', 1);
- }
- $include_deleted = (isset($include_additional['include_deleted']) && $include_additional['include_deleted']);
- if (!$include_deleted) {
- $query->condition('fc.deleted', 0);
- }
- $fields = array();
- $results = $query->execute();
- foreach ($results as $record) {
- $field = unserialize($record['data']);
- $field['id'] = $record['id'];
- $field['field_name'] = $record['field_name'];
- $field['type'] = $record['type'];
- $field['module'] = $record['module'];
- $field['active'] = $record['active'];
- $field['storage']['type'] = $record['storage_type'];
- $field['storage']['module'] = $record['storage_module'];
- $field['storage']['active'] = $record['storage_active'];
- $field['locked'] = $record['locked'];
- $field['cardinality'] = $record['cardinality'];
- $field['translatable'] = $record['translatable'];
- $field['deleted'] = $record['deleted'];
- module_invoke_all('field_read_field', $field);
-
- module_load_install($field['module']);
- $schema = (array) module_invoke($field['module'], 'field_schema', $field);
- $schema += array('columns' => array(), 'indexes' => array());
- $field['columns'] = $schema['columns'];
- $field_name = $field['field_name'];
- if ($include_deleted) {
- $field_name = $field['id'];
- }
- $fields[$field_name] = $field;
- }
- return $fields;
- }
- function field_delete_field($field_name) {
-
- $field = field_info_field($field_name);
- if (isset($field['bundles'])) {
- foreach ($field['bundles'] as $entity_type => $bundles) {
- foreach ($bundles as $bundle) {
- $instance = field_info_instance($entity_type, $field_name, $bundle);
- field_delete_instance($instance, FALSE);
- }
- }
- }
-
- module_invoke($field['storage']['module'], 'field_storage_delete_field', $field);
-
- db_update('field_config')
- ->fields(array('deleted' => 1))
- ->condition('field_name', $field_name)
- ->execute();
-
- field_cache_clear();
- module_invoke_all('field_delete_field', $field);
- }
- function field_create_instance($instance) {
- $field = field_read_field($instance['field_name']);
- if (empty($field)) {
- throw new FieldException(t("Attempt to create an instance of a field @field_name that doesn't exist or is currently inactive.", array('@field_name' => $instance['field_name'])));
- }
-
- if (empty($instance['entity_type'])) {
- throw new FieldException(t('Attempt to create an instance of field @field_name without an entity type.', array('@field_name' => $instance['field_name'])));
- }
- if (empty($instance['bundle'])) {
- throw new FieldException(t('Attempt to create an instance of field @field_name without a bundle.', array('@field_name' => $instance['field_name'])));
- }
-
- if (!empty($field['entity_types']) && !in_array($instance['entity_type'], $field['entity_types'])) {
- throw new FieldException(t('Attempt to create an instance of field @field_name on forbidden entity type @entity_type.', array('@field_name' => $instance['field_name'], '@entity_type' => $instance['entity_type'])));
- }
-
- $instance['field_id'] = $field['id'];
-
-
-
-
-
-
-
-
-
-
-
- $prior_instance = field_read_instance($instance['entity_type'], $instance['field_name'], $instance['bundle']);
- if (!empty($prior_instance)) {
- $message = t('Attempt to create an instance of field @field_name on bundle @bundle that already has an instance of that field.', array('@field_name' => $instance['field_name'], '@bundle' => $instance['bundle']));
- throw new FieldException($message);
- }
- _field_write_instance($instance);
-
- field_cache_clear();
-
- module_invoke_all('field_create_instance', $instance);
- return $instance;
- }
- function field_update_instance($instance) {
-
- $field = field_read_field($instance['field_name']);
- if (empty($field)) {
- throw new FieldException(t('Attempt to update an instance of a nonexistent field @field.', array('@field' => $instance['field_name'])));
- }
-
-
- $prior_instance = field_read_instance($instance['entity_type'], $instance['field_name'], $instance['bundle'], array('include_inactive' => TRUE));
- if (empty($prior_instance)) {
- throw new FieldException(t("Attempt to update an instance of field @field on bundle @bundle that doesn't exist.", array('@field' => $instance['field_name'], '@bundle' => $instance['bundle'])));
- }
- $instance['id'] = $prior_instance['id'];
- $instance['field_id'] = $prior_instance['field_id'];
- _field_write_instance($instance, TRUE);
-
- field_cache_clear();
- module_invoke_all('field_update_instance', $instance, $prior_instance);
- }
- function _field_write_instance($instance, $update = FALSE) {
- $field = field_read_field($instance['field_name']);
- $field_type = field_info_field_types($field['type']);
-
- $instance += array(
- 'settings' => array(),
- 'display' => array(),
- 'widget' => array(),
- 'required' => FALSE,
- 'label' => $instance['field_name'],
- 'description' => '',
- 'deleted' => 0,
- );
-
- $instance['settings'] += field_info_instance_settings($field['type']);
-
- $instance['widget'] += array(
-
- 'type' => $field_type['default_widget'],
- 'settings' => array(),
- );
-
- if (!isset($instance['widget']['weight'])) {
- $max_weight = field_info_max_weight($instance['entity_type'], $instance['bundle'], 'form');
- $instance['widget']['weight'] = isset($max_weight) ? $max_weight + 1 : 0;
- }
-
- $widget_type = field_info_widget_types($instance['widget']['type']);
- $instance['widget']['module'] = $widget_type['module'];
- $instance['widget']['settings'] += field_info_widget_settings($instance['widget']['type']);
-
-
- $instance['display'] += array(
- 'default' => array(),
- );
- foreach ($instance['display'] as $view_mode => $display) {
- $display += array(
- 'label' => 'above',
- 'type' => isset($field_type['default_formatter']) ? $field_type['default_formatter'] : 'hidden',
- 'settings' => array(),
- );
- if ($display['type'] != 'hidden') {
- $formatter_type = field_info_formatter_types($display['type']);
- $display['module'] = $formatter_type['module'];
- $display['settings'] += field_info_formatter_settings($display['type']);
- }
-
- if (!isset($display['weight'])) {
- $max_weight = field_info_max_weight($instance['entity_type'], $instance['bundle'], $view_mode);
- $display['weight'] = isset($max_weight) ? $max_weight + 1 : 0;
- }
- $instance['display'][$view_mode] = $display;
- }
-
-
-
- $data = $instance;
- unset($data['id'], $data['field_id'], $data['field_name'], $data['entity_type'], $data['bundle'], $data['deleted']);
- $record = array(
- 'field_id' => $instance['field_id'],
- 'field_name' => $instance['field_name'],
- 'entity_type' => $instance['entity_type'],
- 'bundle' => $instance['bundle'],
- 'data' => $data,
- 'deleted' => $instance['deleted'],
- );
-
-
- if ($update) {
- $record['id'] = $instance['id'];
- $primary_key = array('id');
- }
- else {
- $primary_key = array();
- }
- drupal_write_record('field_config_instance', $record, $primary_key);
- }
- function field_read_instance($entity_type, $field_name, $bundle, $include_additional = array()) {
- $instances = field_read_instances(array('entity_type' => $entity_type, 'field_name' => $field_name, 'bundle' => $bundle), $include_additional);
- return $instances ? current($instances) : FALSE;
- }
- function field_read_instances($params = array(), $include_additional = array()) {
- $include_inactive = isset($include_additional['include_inactive']) && $include_additional['include_inactive'];
- $include_deleted = isset($include_additional['include_deleted']) && $include_additional['include_deleted'];
- $query = db_select('field_config_instance', 'fci', array('fetch' => PDO::FETCH_ASSOC));
- $query->join('field_config', 'fc', 'fc.id = fci.field_id');
- $query->fields('fci');
-
- foreach ($params as $key => $value) {
- $query->condition('fci.' . $key, $value);
- }
- if (!$include_inactive) {
- $query
- ->condition('fc.active', 1)
- ->condition('fc.storage_active', 1);
- }
- if (!$include_deleted) {
- $query->condition('fc.deleted', 0);
- $query->condition('fci.deleted', 0);
- }
- $instances = array();
- $results = $query->execute();
- foreach ($results as $record) {
-
-
- $entity_info = entity_get_info($record['entity_type']);
- if ($include_inactive || $entity_info) {
- $instance = unserialize($record['data']);
- $instance['id'] = $record['id'];
- $instance['field_id'] = $record['field_id'];
- $instance['field_name'] = $record['field_name'];
- $instance['entity_type'] = $record['entity_type'];
- $instance['bundle'] = $record['bundle'];
- $instance['deleted'] = $record['deleted'];
- module_invoke_all('field_read_instance', $instance);
- $instances[] = $instance;
- }
- }
- return $instances;
- }
- function field_delete_instance($instance, $field_cleanup = TRUE) {
-
- db_update('field_config_instance')
- ->fields(array('deleted' => 1))
- ->condition('field_name', $instance['field_name'])
- ->condition('entity_type', $instance['entity_type'])
- ->condition('bundle', $instance['bundle'])
- ->execute();
-
- field_cache_clear();
-
- $field = field_info_field($instance['field_name']);
- module_invoke($field['storage']['module'], 'field_storage_delete_instance', $instance);
-
- module_invoke_all('field_delete_instance', $instance);
-
- if ($field_cleanup && count($field['bundles']) == 0) {
- field_delete_field($field['field_name']);
- }
- }
- function field_purge_batch($batch_size) {
-
-
- $instances = field_read_instances(array('deleted' => 1), array('include_deleted' => 1));
- foreach ($instances as $instance) {
-
- $field = field_info_field_by_id($instance['field_id']);
-
- $query = new EntityFieldQuery();
- $results = $query
- ->fieldCondition($field)
- ->entityCondition('bundle', $instance['bundle'])
- ->deleted(TRUE)
- ->range(0, $batch_size)
- ->execute();
- if ($results) {
- foreach ($results as $entity_type => $stub_entities) {
- field_attach_load($entity_type, $stub_entities, FIELD_LOAD_CURRENT, array('field_id' => $field['id'], 'deleted' => 1));
- foreach ($stub_entities as $stub_entity) {
-
- field_purge_data($entity_type, $stub_entity, $field, $instance);
- }
- }
- }
- else {
-
- field_purge_instance($instance);
- }
- }
-
- $fields = field_read_fields(array('deleted' => 1), array('include_deleted' => 1));
- foreach ($fields as $field) {
- $instances = field_read_instances(array('field_id' => $field['id']), array('include_deleted' => 1));
- if (empty($instances)) {
- field_purge_field($field);
- }
- }
- }
- function field_purge_data($entity_type, $entity, $field, $instance) {
-
-
- $options = array('field_id' => $instance['field_id'], 'deleted' => TRUE);
- _field_invoke('delete', $entity_type, $entity, $dummy, $dummy, $options);
-
- module_invoke($field['storage']['module'], 'field_storage_purge', $entity_type, $entity, $field, $instance);
-
- foreach (module_implements('field_attach_purge') as $module) {
- $function = $module . '_field_attach_purge';
- $function($entity_type, $entity, $field, $instance);
- }
- }
- function field_purge_instance($instance) {
- db_delete('field_config_instance')
- ->condition('id', $instance['id'])
- ->execute();
-
- $field = field_info_field_by_id($instance['field_id']);
- module_invoke($field['storage']['module'], 'field_storage_purge_instance', $instance);
-
- field_info_cache_clear();
-
- module_invoke_all('field_purge_instance', $instance);
- }
- function field_purge_field($field) {
- $instances = field_read_instances(array('field_id' => $field['id']), array('include_deleted' => 1));
- if (count($instances) > 0) {
- throw new FieldException(t('Attempt to purge a field @field_name that still has instances.', array('@field_name' => $field['field_name'])));
- }
- db_delete('field_config')
- ->condition('id', $field['id'])
- ->execute();
-
- module_invoke($field['storage']['module'], 'field_storage_purge_field', $field);
-
- field_info_cache_clear();
-
- module_invoke_all('field_purge_field', $field);
- }
|