Index: modules/field/field.test
===================================================================
RCS file: modules/field/field.test
diff -N modules/field/field.test
--- modules/field/field.test 20 Nov 2009 04:51:27 -0000 1.68
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,2783 +0,0 @@
-default_storage);
- }
-
- /**
- * Generate random values for a field_test field.
- *
- * @param $cardinality
- * Number of values to generate.
- * @return
- * An array of random values, in the format expected for field values.
- */
- function _generateTestFieldValues($cardinality) {
- $values = array();
- for ($i = 0; $i < $cardinality; $i++) {
- // field_test fields treat 0 as 'empty value'.
- $values[$i]['value'] = mt_rand(1, 127);
- }
- return $values;
- }
-}
-
-class FieldAttachTestCase extends FieldTestCase {
- function setUp() {
- parent::setUp('field_test');
-
- $this->field_name = drupal_strtolower($this->randomName() . '_field_name');
- $this->field = array('field_name' => $this->field_name, 'type' => 'test_field', 'cardinality' => 4);
- $this->field = field_create_field($this->field);
- $this->field_id = $this->field['id'];
- $this->instance = array(
- 'field_name' => $this->field_name,
- 'object_type' => 'test_entity',
- 'bundle' => 'test_bundle',
- 'label' => $this->randomName() . '_label',
- 'description' => $this->randomName() . '_description',
- 'weight' => mt_rand(0, 127),
- 'settings' => array(
- 'test_instance_setting' => $this->randomName(),
- ),
- 'widget' => array(
- 'type' => 'test_field_widget',
- 'label' => 'Test Field',
- 'settings' => array(
- 'test_widget_setting' => $this->randomName(),
- )
- )
- );
- field_create_instance($this->instance);
- }
-}
-
-/**
- * Unit test class for storage-related field_attach_* functions.
- *
- * All field_attach_* test work with all field_storage plugins and
- * all hook_field_attach_pre_{load,insert,update}() hooks.
- */
-class FieldAttachStorageTestCase extends FieldAttachTestCase {
- public static function getInfo() {
- return array(
- 'name' => 'Field attach tests (storage-related)',
- 'description' => 'Test storage-related Field Attach API functions.',
- 'group' => 'Field',
- );
- }
-
- /**
- * Check field values insert, update and load.
- *
- * Works independently of the underlying field storage backend. Inserts or
- * updates random field data and then loads and verifies the data.
- */
- function testFieldAttachSaveLoad() {
- // Configure the instance so that we test hook_field_load() (see
- // field_test_field_load() in field_test.module).
- $this->instance['settings']['test_hook_field_load'] = TRUE;
- field_update_instance($this->instance);
- $langcode = FIELD_LANGUAGE_NONE;
-
- $entity_type = 'test_entity';
- $values = array();
-
- // TODO : test empty values filtering and "compression" (store consecutive deltas).
-
- // Preparation: create three revisions and store them in $revision array.
- for ($revision_id = 0; $revision_id < 3; $revision_id++) {
- $revision[$revision_id] = field_test_create_stub_entity(0, $revision_id, $this->instance['bundle']);
- // Note: we try to insert one extra value.
- $values[$revision_id] = $this->_generateTestFieldValues($this->field['cardinality'] + 1);
- $current_revision = $revision_id;
- // If this is the first revision do an insert.
- if (!$revision_id) {
- $revision[$revision_id]->{$this->field_name}[$langcode] = $values[$revision_id];
- field_attach_insert($entity_type, $revision[$revision_id]);
- }
- else {
- // Otherwise do an update.
- $revision[$revision_id]->{$this->field_name}[$langcode] = $values[$revision_id];
- field_attach_update($entity_type, $revision[$revision_id]);
- }
- }
-
- // Confirm current revision loads the correct data.
- $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
- field_attach_load($entity_type, array(0 => $entity));
- // Number of values per field loaded equals the field cardinality.
- $this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], t('Current revision: expected number of values'));
- for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
- // The field value loaded matches the one inserted or updated.
- $this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['value'] , $values[$current_revision][$delta]['value'], t('Current revision: expected value %delta was found.', array('%delta' => $delta)));
- // The value added in hook_field_load() is found.
- $this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['additional_key'], 'additional_value', t('Current revision: extra information for value %delta was found', array('%delta' => $delta)));
- }
-
- // Confirm each revision loads the correct data.
- foreach (array_keys($revision) as $revision_id) {
- $entity = field_test_create_stub_entity(0, $revision_id, $this->instance['bundle']);
- field_attach_load_revision($entity_type, array(0 => $entity));
- // Number of values per field loaded equals the field cardinality.
- $this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], t('Revision %revision_id: expected number of values.', array('%revision_id' => $revision_id)));
- for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
- // The field value loaded matches the one inserted or updated.
- $this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['value'], $values[$revision_id][$delta]['value'], t('Revision %revision_id: expected value %delta was found.', array('%revision_id' => $revision_id, '%delta' => $delta)));
- // The value added in hook_field_load() is found.
- $this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['additional_key'], 'additional_value', t('Revision %revision_id: extra information for value %delta was found', array('%revision_id' => $revision_id, '%delta' => $delta)));
- }
- }
- }
-
- /**
- * Test the 'multiple' load feature.
- */
- function testFieldAttachLoadMultiple() {
- $entity_type = 'test_entity';
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Define 2 bundles.
- $bundles = array(
- 1 => 'test_bundle_1',
- 2 => 'test_bundle_2',
- );
- field_test_create_bundle($bundles[1]);
- field_test_create_bundle($bundles[2]);
- // Define 3 fields:
- // - field_1 is in bundle_1 and bundle_2,
- // - field_2 is in bundle_1,
- // - field_3 is in bundle_2.
- $field_bundles_map = array(
- 1 => array(1, 2),
- 2 => array(1),
- 3 => array(2),
- );
- for ($i = 1; $i <= 3; $i++) {
- $field_names[$i] = 'field_' . $i;
- $field = array('field_name' => $field_names[$i], 'type' => 'test_field');
- $field = field_create_field($field);
- $field_ids[$i] = $field['id'];
- foreach ($field_bundles_map[$i] as $bundle) {
- $instance = array(
- 'field_name' => $field_names[$i],
- 'object_type' => 'test_entity',
- 'bundle' => $bundles[$bundle],
- 'settings' => array(
- // Configure the instance so that we test hook_field_load()
- // (see field_test_field_load() in field_test.module).
- 'test_hook_field_load' => TRUE,
- ),
- );
- field_create_instance($instance);
- }
- }
-
- // Create one test entity per bundle, with random values.
- foreach ($bundles as $index => $bundle) {
- $entities[$index] = field_test_create_stub_entity($index, $index, $bundle);
- $entity = clone($entities[$index]);
- $instances = field_info_instances('test_entity', $bundle);
- foreach ($instances as $field_name => $instance) {
- $values[$index][$field_name] = mt_rand(1, 127);
- $entity->$field_name = array($langcode => array(array('value' => $values[$index][$field_name])));
- }
- field_attach_insert($entity_type, $entity);
- }
-
- // Check that a single load correctly loads field values for both entities.
- field_attach_load($entity_type, $entities);
- foreach ($entities as $index => $entity) {
- $instances = field_info_instances($entity_type, $bundles[$index]);
- foreach ($instances as $field_name => $instance) {
- // The field value loaded matches the one inserted.
- $this->assertEqual($entity->{$field_name}[$langcode][0]['value'], $values[$index][$field_name], t('Entity %index: expected value was found.', array('%index' => $index)));
- // The value added in hook_field_load() is found.
- $this->assertEqual($entity->{$field_name}[$langcode][0]['additional_key'], 'additional_value', t('Entity %index: extra information was found', array('%index' => $index)));
- }
- }
-
- // Check that the single-field load option works.
- $entity = field_test_create_stub_entity(1, 1, $bundles[1]);
- field_attach_load($entity_type, array(1 => $entity), FIELD_LOAD_CURRENT, array('field_id' => $field_ids[1]));
- $this->assertEqual($entity->{$field_names[1]}[$langcode][0]['value'], $values[1][$field_names[1]], t('Entity %index: expected value was found.', array('%index' => 1)));
- $this->assertEqual($entity->{$field_names[1]}[$langcode][0]['additional_key'], 'additional_value', t('Entity %index: extra information was found', array('%index' => 1)));
- $this->assert(!isset($entity->{$field_names[2]}), t('Entity %index: field %field_name is not loaded.', array('%index' => 2, '%field_name' => $field_names[2])));
- $this->assert(!isset($entity->{$field_names[3]}), t('Entity %index: field %field_name is not loaded.', array('%index' => 3, '%field_name' => $field_names[3])));
- }
-
- /**
- * Test saving and loading fields using different storage backends.
- */
- function testFieldAttachSaveLoadDifferentStorage() {
- $entity_type = 'test_entity';
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Create two fields using different storage backends, and their instances.
- $fields = array(
- array(
- 'field_name' => 'field_1',
- 'type' => 'test_field',
- 'cardinality' => 4,
- 'storage' => array('type' => 'field_sql_storage')
- ),
- array(
- 'field_name' => 'field_2',
- 'type' => 'test_field',
- 'cardinality' => 4,
- 'storage' => array('type' => 'field_test_storage')
- ),
- );
- foreach ($fields as $field) {
- field_create_field($field);
- $instance = array(
- 'field_name' => $field['field_name'],
- 'object_type' => 'test_entity',
- 'bundle' => 'test_bundle',
- );
- field_create_instance($instance);
- }
-
- $entity_init = field_test_create_stub_entity();
-
- // Create entity and insert random values.
- $entity = clone($entity_init);
- $values = array();
- foreach ($fields as $field) {
- $values[$field['field_name']] = $this->_generateTestFieldValues($this->field['cardinality']);
- $entity->{$field['field_name']}[$langcode] = $values[$field['field_name']];
- }
- field_attach_insert($entity_type, $entity);
-
- // Check that values are loaded as expected.
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- foreach ($fields as $field) {
- $this->assertEqual($values[$field['field_name']], $entity->{$field['field_name']}[$langcode], t('%storage storage: expected values were found.', array('%storage' => $field['storage']['type'])));
- }
- }
-
- /**
- * Test storage details alteration.
- *
- * @see field_test_storage_details_alter()
- */
- function testFieldStorageDetailsAlter() {
- $field_name = 'field_test_change_my_details';
- $field = array(
- 'field_name' => $field_name,
- 'type' => 'test_field',
- 'cardinality' => 4,
- 'storage' => array('type' => 'field_test_storage'),
- );
- $field = field_create_field($field);
- $instance = array(
- 'field_name' => $field_name,
- 'object_type' => 'test_entity',
- 'bundle' => 'test_bundle',
- );
- field_create_instance($instance);
-
- $field = field_info_field($instance['field_name']);
- $instance = field_info_instance($instance['object_type'], $instance['field_name'], $instance['bundle']);
-
- // The storage details are indexed by a storage engine type.
- $this->assertTrue(array_key_exists('drupal_variables', $instance['storage_details']), t('The storage type is Drupal variables.'));
-
- $details = $instance['storage_details']['drupal_variables'];
-
- // The field_test storage details are indexed by variable name. The details
- // are altered, so moon and mars are correct for this test.
- $this->assertTrue(array_key_exists('moon', $details[FIELD_LOAD_CURRENT]), t('Moon is available in the instance array.'));
- $this->assertTrue(array_key_exists('mars', $details[FIELD_LOAD_REVISION]), t('Mars is available in the instance array.'));
-
- // Test current and revision storage details together because the columns
- // are the same.
- foreach ((array) $field['columns'] as $column_name => $attributes) {
- $this->assertEqual($details[FIELD_LOAD_CURRENT]['moon'][$column_name], $column_name, t('Column name %value matches the definition in %bin.', array('%value' => $column_name, '%bin' => 'moon[FIELD_LOAD_CURRENT]')));
- $this->assertEqual($details[FIELD_LOAD_REVISION]['mars'][$column_name], $column_name, t('Column name %value matches the definition in %bin.', array('%value' => $column_name, '%bin' => 'mars[FIELD_LOAD_REVISION]')));
- }
- }
-
- /**
- * Tests insert and update with missing or NULL fields.
- */
- function testFieldAttachSaveMissingData() {
- $entity_type = 'test_entity';
- $entity_init = field_test_create_stub_entity();
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Insert: Field is missing.
- $entity = clone($entity_init);
- field_attach_insert($entity_type, $entity);
-
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $this->assertTrue(empty($entity->{$this->field_name}), t('Insert: missing field results in no value saved'));
-
- // Insert: Field is NULL.
- field_cache_clear();
- $entity = clone($entity_init);
- $entity->{$this->field_name} = NULL;
- field_attach_insert($entity_type, $entity);
-
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $this->assertTrue(empty($entity->{$this->field_name}), t('Insert: NULL field results in no value saved'));
-
- // Add some real data.
- field_cache_clear();
- $entity = clone($entity_init);
- $values = $this->_generateTestFieldValues(1);
- $entity->{$this->field_name}[$langcode] = $values;
- field_attach_insert($entity_type, $entity);
-
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $this->assertEqual($entity->{$this->field_name}[$langcode], $values, t('Field data saved'));
-
- // Update: Field is missing. Data should survive.
- field_cache_clear();
- $entity = clone($entity_init);
- field_attach_update($entity_type, $entity);
-
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $this->assertEqual($entity->{$this->field_name}[$langcode], $values, t('Update: missing field leaves existing values in place'));
-
- // Update: Field is NULL. Data should be wiped.
- field_cache_clear();
- $entity = clone($entity_init);
- $entity->{$this->field_name} = NULL;
- field_attach_update($entity_type, $entity);
-
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $this->assertTrue(empty($entity->{$this->field_name}), t('Update: NULL field removes existing values'));
-
- // Re-add some data.
- field_cache_clear();
- $entity = clone($entity_init);
- $values = $this->_generateTestFieldValues(1);
- $entity->{$this->field_name}[$langcode] = $values;
- field_attach_update($entity_type, $entity);
-
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $this->assertEqual($entity->{$this->field_name}[$langcode], $values, t('Field data saved'));
-
- // Update: Field is empty array. Data should be wiped.
- field_cache_clear();
- $entity = clone($entity_init);
- $entity->{$this->field_name} = array();
- field_attach_update($entity_type, $entity);
-
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $this->assertTrue(empty($entity->{$this->field_name}), t('Update: empty array removes existing values'));
- }
-
- /**
- * Test insert with missing or NULL fields, with default value.
- */
- function testFieldAttachSaveMissingDataDefaultValue() {
- // Add a default value.
- $this->instance['default_value_function'] = 'field_test_default_value';
- field_update_instance($this->instance);
-
- $entity_type = 'test_entity';
- $entity_init = field_test_create_stub_entity();
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Insert: Field is NULL.
- $entity = clone($entity_init);
- $entity->{$this->field_name}[$langcode] = NULL;
- field_attach_insert($entity_type, $entity);
-
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $this->assertTrue(empty($entity->{$this->field_name}[$langcode]), t('Insert: NULL field results in no value saved'));
-
- // Insert: Field is missing.
- field_cache_clear();
- $entity = clone($entity_init);
- field_attach_insert($entity_type, $entity);
-
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $values = field_test_default_value($entity_type, $entity, $this->field, $this->instance);
- $this->assertEqual($entity->{$this->field_name}[$langcode], $values, t('Insert: missing field results in default value saved'));
- }
-
- /**
- * Test field_attach_delete().
- */
- function testFieldAttachDelete() {
- $entity_type = 'test_entity';
- $langcode = FIELD_LANGUAGE_NONE;
- $rev[0] = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
-
- // Create revision 0
- $values = $this->_generateTestFieldValues($this->field['cardinality']);
- $rev[0]->{$this->field_name}[$langcode] = $values;
- field_attach_insert($entity_type, $rev[0]);
-
- // Create revision 1
- $rev[1] = field_test_create_stub_entity(0, 1, $this->instance['bundle']);
- $rev[1]->{$this->field_name}[$langcode] = $values;
- field_attach_update($entity_type, $rev[1]);
-
- // Create revision 2
- $rev[2] = field_test_create_stub_entity(0, 2, $this->instance['bundle']);
- $rev[2]->{$this->field_name}[$langcode] = $values;
- field_attach_update($entity_type, $rev[2]);
-
- // Confirm each revision loads
- foreach (array_keys($rev) as $vid) {
- $read = field_test_create_stub_entity(0, $vid, $this->instance['bundle']);
- field_attach_load_revision($entity_type, array(0 => $read));
- $this->assertEqual(count($read->{$this->field_name}[$langcode]), $this->field['cardinality'], "The test object revision $vid has {$this->field['cardinality']} values.");
- }
-
- // Delete revision 1, confirm the other two still load.
- field_attach_delete_revision($entity_type, $rev[1]);
- foreach (array(0, 2) as $vid) {
- $read = field_test_create_stub_entity(0, $vid, $this->instance['bundle']);
- field_attach_load_revision($entity_type, array(0 => $read));
- $this->assertEqual(count($read->{$this->field_name}[$langcode]), $this->field['cardinality'], "The test object revision $vid has {$this->field['cardinality']} values.");
- }
-
- // Confirm the current revision still loads
- $read = field_test_create_stub_entity(0, 2, $this->instance['bundle']);
- field_attach_load($entity_type, array(0 => $read));
- $this->assertEqual(count($read->{$this->field_name}[$langcode]), $this->field['cardinality'], "The test object current revision has {$this->field['cardinality']} values.");
-
- // Delete all field data, confirm nothing loads
- field_attach_delete($entity_type, $rev[2]);
- foreach (array(0, 1, 2) as $vid) {
- $read = field_test_create_stub_entity(0, $vid, $this->instance['bundle']);
- field_attach_load_revision($entity_type, array(0 => $read));
- $this->assertIdentical($read->{$this->field_name}, array(), "The test object revision $vid is deleted.");
- }
- $read = field_test_create_stub_entity(0, 2, $this->instance['bundle']);
- field_attach_load($entity_type, array(0 => $read));
- $this->assertIdentical($read->{$this->field_name}, array(), t('The test object current revision is deleted.'));
- }
-
- /**
- * Test field_attach_create_bundle() and field_attach_rename_bundle().
- */
- function testFieldAttachCreateRenameBundle() {
- // Create a new bundle. This has to be initiated by the module so that its
- // hook_entity_info() is consistent.
- $new_bundle = 'test_bundle_' . drupal_strtolower($this->randomName());
- field_test_create_bundle($new_bundle);
-
- // Add an instance to that bundle.
- $this->instance['bundle'] = $new_bundle;
- field_create_instance($this->instance);
-
- // Save an object with data in the field.
- $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
- $langcode = FIELD_LANGUAGE_NONE;
- $values = $this->_generateTestFieldValues($this->field['cardinality']);
- $entity->{$this->field_name}[$langcode] = $values;
- $entity_type = 'test_entity';
- field_attach_insert($entity_type, $entity);
-
- // Verify the field data is present on load.
- $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
- field_attach_load($entity_type, array(0 => $entity));
- $this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], "Data is retrieved for the new bundle");
-
- // Rename the bundle. This has to be initiated by the module so that its
- // hook_entity_info() is consistent.
- $new_bundle = 'test_bundle_' . drupal_strtolower($this->randomName());
- field_test_rename_bundle($this->instance['bundle'], $new_bundle);
-
- // Check that the instance definition has been updated.
- $this->instance = field_info_instance($entity_type, $this->field_name, $new_bundle);
- $this->assertIdentical($this->instance['bundle'], $new_bundle, "Bundle name has been updated in the instance.");
-
- // Verify the field data is present on load.
- $entity = field_test_create_stub_entity(0, 0, $new_bundle);
- field_attach_load($entity_type, array(0 => $entity));
- $this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], "Bundle name has been updated in the field storage");
- }
-
- /**
- * Test field_attach_delete_bundle().
- */
- function testFieldAttachDeleteBundle() {
- // Create a new bundle. This has to be initiated by the module so that its
- // hook_entity_info() is consistent.
- $new_bundle = 'test_bundle_' . drupal_strtolower($this->randomName());
- field_test_create_bundle($new_bundle);
-
- // Add an instance to that bundle.
- $this->instance['bundle'] = $new_bundle;
- field_create_instance($this->instance);
-
- // Create a second field for the test bundle
- $field_name = drupal_strtolower($this->randomName() . '_field_name');
- $field = array('field_name' => $field_name, 'type' => 'test_field', 'cardinality' => 1);
- field_create_field($field);
- $instance = array(
- 'field_name' => $field_name,
- 'object_type' => 'test_entity',
- 'bundle' => $this->instance['bundle'],
- 'label' => $this->randomName() . '_label',
- 'description' => $this->randomName() . '_description',
- 'weight' => mt_rand(0, 127),
- // test_field has no instance settings
- 'widget' => array(
- 'type' => 'test_field_widget',
- 'settings' => array(
- 'size' => mt_rand(0, 255))));
- field_create_instance($instance);
-
- // Save an object with data for both fields
- $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
- $langcode = FIELD_LANGUAGE_NONE;
- $values = $this->_generateTestFieldValues($this->field['cardinality']);
- $entity->{$this->field_name}[$langcode] = $values;
- $entity->{$field_name}[$langcode] = $this->_generateTestFieldValues(1);
- field_attach_insert('test_entity', $entity);
-
- // Verify the fields are present on load
- $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
- field_attach_load('test_entity', array(0 => $entity));
- $this->assertEqual(count($entity->{$this->field_name}[$langcode]), 4, 'First field got loaded');
- $this->assertEqual(count($entity->{$field_name}[$langcode]), 1, 'Second field got loaded');
-
- // Delete the bundle. This has to be initiated by the module so that its
- // hook_entity_info() is consistent.
- field_test_delete_bundle($this->instance['bundle']);
-
- // Verify no data gets loaded
- $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
- field_attach_load('test_entity', array(0 => $entity));
- $this->assertFalse(isset($entity->{$this->field_name}[$langcode]), 'No data for first field');
- $this->assertFalse(isset($entity->{$field_name}[$langcode]), 'No data for second field');
-
- // Verify that the instances are gone
- $this->assertFalse(field_read_instance('test_entity', $this->field_name, $this->instance['bundle']), "First field is deleted");
- $this->assertFalse(field_read_instance('test_entity', $field_name, $instance['bundle']), "Second field is deleted");
- }
-
- /**
- * Test field_attach_query().
- */
- function testFieldAttachQuery() {
- $cardinality = $this->field['cardinality'];
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Create an additional bundle with an instance of the field.
- field_test_create_bundle('test_bundle_1', 'Test Bundle 1');
- $this->instance2 = $this->instance;
- $this->instance2['bundle'] = 'test_bundle_1';
- field_create_instance($this->instance2);
-
- // Create instances of both fields on the second entity type.
- $instance = $this->instance;
- $instance['object_type'] = 'test_cacheable_entity';
- field_create_instance($instance);
- $instance2 = $this->instance2;
- $instance2['object_type'] = 'test_cacheable_entity';
- field_create_instance($instance2);
-
- // Unconditional count query returns 0.
- $count = field_attach_query($this->field_id, array(), array('count' => TRUE));
- $this->assertEqual($count, 0, t('With no objects, count query returns 0.'));
-
- // Create two test objects, using two different types and bundles.
- $entity_types = array(1 => 'test_entity', 2 => 'test_cacheable_entity');
- $entities = array(1 => field_test_create_stub_entity(1, 1, 'test_bundle'), 2 => field_test_create_stub_entity(2, 2, 'test_bundle_1'));
-
- // Create first test object with random (distinct) values.
- $values = array();
- for ($delta = 0; $delta < $cardinality; $delta++) {
- do {
- $value = mt_rand(1, 127);
- } while (in_array($value, $values));
- $values[$delta] = $value;
- $entities[1]->{$this->field_name}[$langcode][$delta] = array('value' => $values[$delta]);
- }
- field_attach_insert($entity_types[1], $entities[1]);
-
- // Unconditional count query returns 1.
- $count = field_attach_query($this->field_id, array(), array('count' => TRUE));
- $this->assertEqual($count, 1, t('With one object, count query returns @count.', array('@count' => $count)));
-
- // Create second test object, sharing a value with the first one.
- $common_value = $values[$cardinality - 1];
- $entities[2]->{$this->field_name} = array($langcode => array(array('value' => $common_value)));
- field_attach_insert($entity_types[2], $entities[2]);
-
- // Query on the object's values.
- for ($delta = 0; $delta < $cardinality; $delta++) {
- $conditions = array(array('value', $values[$delta]));
- $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertTrue(isset($result[$entity_types[1]][1]), t('Query on value %delta returns the object', array('%delta' => $delta)));
-
- $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
- $this->assertEqual($count, ($values[$delta] == $common_value) ? 2 : 1, t('Count query on value %delta counts %count objects', array('%delta' => $delta, '%count' => $count)));
- }
-
- // Query on a value that is not in the object.
- do {
- $different_value = mt_rand(1, 127);
- } while (in_array($different_value, $values));
- $conditions = array(array('value', $different_value));
- $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertFalse(isset($result[$entity_types[1]][1]), t("Query on a value that is not in the object doesn't return the object"));
- $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
- $this->assertEqual($count, 0, t("Count query on a value that is not in the object doesn't count the object"));
-
- // Query on the value shared by both objects, and discriminate using
- // additional conditions.
-
- $conditions = array(array('value', $common_value));
- $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertTrue(isset($result[$entity_types[1]][1]) && isset($result[$entity_types[2]][2]), t('Query on a value common to both objects returns both objects'));
- $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
- $this->assertEqual($count, 2, t('Count query on a value common to both objects counts both objects'));
-
- $conditions = array(array('type', $entity_types[1]), array('value', $common_value));
- $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertTrue(isset($result[$entity_types[1]][1]) && !isset($result[$entity_types[2]][2]), t("Query on a value common to both objects and a 'type' condition only returns the relevant object"));
- $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
- $this->assertEqual($count, 1, t("Count query on a value common to both objects and a 'type' condition only returns the relevant object"));
-
- $conditions = array(array('bundle', $entities[1]->fttype), array('value', $common_value));
- $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertTrue(isset($result[$entity_types[1]][1]) && !isset($result[$entity_types[2]][2]), t("Query on a value common to both objects and a 'bundle' condition only returns the relevant object"));
- $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
- $this->assertEqual($count, 1, t("Count query on a value common to both objects and a 'bundle' condition only counts the relevant object"));
-
- $conditions = array(array('entity_id', $entities[1]->ftid), array('value', $common_value));
- $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertTrue(isset($result[$entity_types[1]][1]) && !isset($result[$entity_types[2]][2]), t("Query on a value common to both objects and an 'entity_id' condition only returns the relevant object"));
- $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
- $this->assertEqual($count, 1, t("Count query on a value common to both objects and an 'entity_id' condition only counts the relevant object"));
-
- // Test result format.
- $conditions = array(array('value', $values[0]));
- $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $expected = array(
- $entity_types[1] => array(
- $entities[1]->ftid => field_test_create_stub_entity($entities[1]->ftid, $entities[1]->ftvid),
- )
- );
- $this->assertEqual($result, $expected, t('Result format is correct.'));
-
- // Now test the count/offset paging capability.
-
- // Create a new bundle with an instance of the field.
- field_test_create_bundle('offset_bundle', 'Offset Test Bundle');
- $this->instance2 = $this->instance;
- $this->instance2['bundle'] = 'offset_bundle';
- field_create_instance($this->instance2);
-
- // Create 20 test objects, using the new bundle, but with
- // non-sequential ids so we can tell we are getting the right ones
- // back. We do not need unique values since field_attach_query()
- // won't return them anyway.
- $offset_entities = array();
- $offset_id = mt_rand(1, 3);
- for ($i = 0; $i < 20; ++$i) {
- $offset_id += mt_rand(2, 5);
- $offset_entities[$offset_id] = field_test_create_stub_entity($offset_id, $offset_id, 'offset_bundle');
- $offset_entities[$offset_id]->{$this->field_name}[$langcode][0] = array('value' => $offset_id);
- field_attach_insert('test_entity', $offset_entities[$offset_id]);
- }
-
- // Query for the offset entities in batches, making sure we get
- // back the right ones.
- $cursor = 0;
- foreach (array(1 => 1, 3 => 3, 5 => 5, 8 => 8, 13 => 3) as $count => $expect) {
- $found = field_attach_query($this->field_id, array(array('bundle', 'offset_bundle')), array('limit' => $count, 'cursor' => &$cursor));
- if (isset($found['test_entity'])) {
- $this->assertEqual(count($found['test_entity']), $expect, t('Requested @count, expected @expect, got @found, cursor @cursor', array('@count' => $count, '@expect' => $expect, '@found' => count($found['test_entity']), '@cursor' => $cursor)));
- foreach ($found['test_entity'] as $id => $entity) {
- $this->assert(isset($offset_entities[$id]), "Entity $id found");
- unset($offset_entities[$id]);
- }
- }
- else {
- $this->assertEqual(0, $expect, t('Requested @count, expected @expect, got @found, cursor @cursor', array('@count' => $count, '@expect' => $expect, '@found' => 0, '@cursor' => $cursor)));
- }
- }
- $this->assertEqual(count($offset_entities), 0, "All entities found");
- $this->assertEqual($cursor, FIELD_QUERY_COMPLETE, "Cursor is FIELD_QUERY_COMPLETE");
- }
-
- /**
- * Test field_attach_query_revisions().
- */
- function testFieldAttachQueryRevisions() {
- $cardinality = $this->field['cardinality'];
-
- // Create first object revision with random (distinct) values.
- $entity_type = 'test_entity';
- $entities = array(1 => field_test_create_stub_entity(1, 1), 2 => field_test_create_stub_entity(1, 2));
- $langcode = FIELD_LANGUAGE_NONE;
- $values = array();
- for ($delta = 0; $delta < $cardinality; $delta++) {
- do {
- $value = mt_rand(1, 127);
- } while (in_array($value, $values));
- $values[$delta] = $value;
- $entities[1]->{$this->field_name}[$langcode][$delta] = array('value' => $values[$delta]);
- }
- field_attach_insert($entity_type, $entities[1]);
-
- // Create second object revision, sharing a value with the first one.
- $common_value = $values[$cardinality - 1];
- $entities[2]->{$this->field_name}[$langcode][0] = array('value' => $common_value);
- field_attach_update($entity_type, $entities[2]);
-
- // Query on the object's values.
- for ($delta = 0; $delta < $cardinality; $delta++) {
- $conditions = array(array('value', $values[$delta]));
- $result = field_attach_query_revisions($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertTrue(isset($result[$entity_type][1]), t('Query on value %delta returns the object', array('%delta' => $delta)));
- }
-
- // Query on a value that is not in the object.
- do {
- $different_value = mt_rand(1, 127);
- } while (in_array($different_value, $values));
- $conditions = array(array('value', $different_value));
- $result = field_attach_query_revisions($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertFalse(isset($result[$entity_type][1]), t("Query on a value that is not in the object doesn't return the object"));
-
- // Query on the value shared by both objects, and discriminate using
- // additional conditions.
-
- $conditions = array(array('value', $common_value));
- $result = field_attach_query_revisions($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertTrue(isset($result[$entity_type][1]) && isset($result[$entity_type][2]), t('Query on a value common to both objects returns both objects'));
-
- $conditions = array(array('revision_id', $entities[1]->ftvid), array('value', $common_value));
- $result = field_attach_query_revisions($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertTrue(isset($result[$entity_type][1]) && !isset($result[$entity_type][2]), t("Query on a value common to both objects and a 'revision_id' condition only returns the relevant object"));
-
- // Test FIELD_QUERY_RETURN_IDS result format.
- $conditions = array(array('value', $values[0]));
- $result = field_attach_query_revisions($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
- $expected = array(
- $entity_type => array(
- $entities[1]->ftid => field_test_create_stub_entity($entities[1]->ftid, $entities[1]->ftvid),
- )
- );
- $this->assertEqual($result, $expected, t('FIELD_QUERY_RETURN_IDS result format returns the expect result'));
- }
-}
-
-/**
- * Unit test class for non-storage related field_attach_* functions.
- */
-class FieldAttachOtherTestCase extends FieldAttachTestCase {
- public static function getInfo() {
- return array(
- 'name' => 'Field attach tests (other)',
- 'description' => 'Test other Field Attach API functions.',
- 'group' => 'Field',
- );
- }
-
- /**
- * Test field_attach_view() and field_atach_prepare_view().
- */
- function testFieldAttachView() {
- $entity_type = 'test_entity';
- $entity_init = field_test_create_stub_entity();
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Populate values to be displayed.
- $values = $this->_generateTestFieldValues($this->field['cardinality']);
- $entity_init->{$this->field_name}[$langcode] = $values;
-
- // Simple formatter, label displayed.
- $entity = clone($entity_init);
- $formatter_setting = $this->randomName();
- $this->instance['display'] = array(
- 'full' => array(
- 'label' => 'above',
- 'type' => 'field_test_default',
- 'settings' => array(
- 'test_formatter_setting' => $formatter_setting,
- )
- ),
- );
- field_update_instance($this->instance);
- field_attach_prepare_view($entity_type, array($entity->ftid => $entity));
- $entity->content = field_attach_view($entity_type, $entity);
- $output = drupal_render($entity->content);
- $this->content = $output;
- $this->assertRaw($this->instance['label'], "Label is displayed.");
- foreach ($values as $delta => $value) {
- $this->content = $output;
- $this->assertRaw("$formatter_setting|{$value['value']}", "Value $delta is displayed, formatter settings are applied.");
- }
-
- // Label hidden.
- $entity = clone($entity_init);
- $this->instance['display']['full']['label'] = 'hidden';
- field_update_instance($this->instance);
- field_attach_prepare_view($entity_type, array($entity->ftid => $entity));
- $entity->content = field_attach_view($entity_type, $entity);
- $output = drupal_render($entity->content);
- $this->content = $output;
- $this->assertNoRaw($this->instance['label'], "Hidden label: label is not displayed.");
-
- // Field hidden.
- $entity = clone($entity_init);
- $this->instance['display'] = array(
- 'full' => array(
- 'label' => 'above',
- 'type' => 'hidden',
- ),
- );
- field_update_instance($this->instance);
- field_attach_prepare_view($entity_type, array($entity->ftid => $entity));
- $entity->content = field_attach_view($entity_type, $entity);
- $output = drupal_render($entity->content);
- $this->content = $output;
- $this->assertNoRaw($this->instance['label'], "Hidden field: label is not displayed.");
- foreach ($values as $delta => $value) {
- $this->assertNoRaw($value['value'], "Hidden field: value $delta is not displayed.");
- }
-
- // Multiple formatter.
- $entity = clone($entity_init);
- $formatter_setting = $this->randomName();
- $this->instance['display'] = array(
- 'full' => array(
- 'label' => 'above',
- 'type' => 'field_test_multiple',
- 'settings' => array(
- 'test_formatter_setting_multiple' => $formatter_setting,
- )
- ),
- );
- field_update_instance($this->instance);
- field_attach_prepare_view($entity_type, array($entity->ftid => $entity));
- $entity->content = field_attach_view($entity_type, $entity);
- $output = drupal_render($entity->content);
- $display = $formatter_setting;
- foreach ($values as $delta => $value) {
- $display .= "|$delta:{$value['value']}";
- }
- $this->content = $output;
- $this->assertRaw($display, "Multiple formatter: all values are displayed, formatter settings are applied.");
-
- // Test a formatter that uses hook_field_formatter_prepare_view()..
- $entity = clone($entity_init);
- $formatter_setting = $this->randomName();
- $this->instance['display'] = array(
- 'full' => array(
- 'label' => 'above',
- 'type' => 'field_test_needs_additional_data',
- 'settings' => array(
- 'test_formatter_setting_additional' => $formatter_setting,
- )
- ),
- );
- field_update_instance($this->instance);
- field_attach_prepare_view($entity_type, array($entity->ftid => $entity));
- $entity->content = field_attach_view($entity_type, $entity);
- $output = drupal_render($entity->content);
- $this->content = $output;
- foreach ($values as $delta => $value) {
- $this->content = $output;
- $expected = $formatter_setting . '|' . $value['value'] . '|' . ($value['value'] + 1);
- $this->assertRaw($expected, "Value $delta is displayed, formatter settings are applied.");
- }
-
- // TODO:
- // - check display order with several fields
-
- // Preprocess template.
- $variables = array();
- field_attach_preprocess($entity_type, $entity, $entity->content, $variables);
- $result = TRUE;
- foreach ($values as $delta => $item) {
- if ($variables[$this->field_name][$delta]['value'] !== $item['value']) {
- $result = FALSE;
- break;
- }
- }
- $this->assertTrue($result, t('Variable $@field_name correctly populated.', array('@field_name' => $this->field_name)));
- }
-
- /**
- * Test field cache.
- */
- function testFieldAttachCache() {
- // Initialize random values and a test entity.
- $entity_init = field_test_create_stub_entity(1, 1, $this->instance['bundle']);
- $langcode = FIELD_LANGUAGE_NONE;
- $values = $this->_generateTestFieldValues($this->field['cardinality']);
-
- // Non-cacheable entity type.
- $entity_type = 'test_entity';
- $cid = "field:$entity_type:{$entity_init->ftid}";
-
- // Check that no initial cache entry is present.
- $this->assertFalse(cache_get($cid, 'cache_field'), t('Non-cached: no initial cache entry'));
-
- // Save, and check that no cache entry is present.
- $entity = clone($entity_init);
- $entity->{$this->field_name}[$langcode] = $values;
- field_attach_insert($entity_type, $entity);
- $this->assertFalse(cache_get($cid, 'cache_field'), t('Non-cached: no cache entry on insert'));
-
- // Load, and check that no cache entry is present.
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $this->assertFalse(cache_get($cid, 'cache_field'), t('Non-cached: no cache entry on load'));
-
-
- // Cacheable entity type.
- $entity_type = 'test_cacheable_entity';
- $cid = "field:$entity_type:{$entity_init->ftid}";
- $instance = $this->instance;
- $instance['object_type'] = $entity_type;
- field_create_instance($instance);
-
- // Check that no initial cache entry is present.
- $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no initial cache entry'));
-
- // Save, and check that no cache entry is present.
- $entity = clone($entity_init);
- $entity->{$this->field_name}[$langcode] = $values;
- field_attach_insert($entity_type, $entity);
- $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no cache entry on insert'));
-
- // Load a single field, and check that no cache entry is present.
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity), FIELD_LOAD_CURRENT, array('field_id' => $this->field_id));
- $cache = cache_get($cid, 'cache_field');
- $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no cache entry on loading a single field'));
-
- // Load, and check that a cache entry is present with the expected values.
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $cache = cache_get($cid, 'cache_field');
- $this->assertEqual($cache->data[$this->field_name][$langcode], $values, t('Cached: correct cache entry on load'));
-
- // Update with different values, and check that the cache entry is wiped.
- $values = $this->_generateTestFieldValues($this->field['cardinality']);
- $entity = clone($entity_init);
- $entity->{$this->field_name}[$langcode] = $values;
- field_attach_update($entity_type, $entity);
- $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no cache entry on update'));
-
- // Load, and check that a cache entry is present with the expected values.
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $cache = cache_get($cid, 'cache_field');
- $this->assertEqual($cache->data[$this->field_name][$langcode], $values, t('Cached: correct cache entry on load'));
-
- // Create a new revision, and check that the cache entry is wiped.
- $entity_init = field_test_create_stub_entity(1, 2, $this->instance['bundle']);
- $values = $this->_generateTestFieldValues($this->field['cardinality']);
- $entity = clone($entity_init);
- $entity->{$this->field_name}[$langcode] = $values;
- field_attach_update($entity_type, $entity);
- $cache = cache_get($cid, 'cache_field');
- $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no cache entry on new revision creation'));
-
- // Load, and check that a cache entry is present with the expected values.
- $entity = clone($entity_init);
- field_attach_load($entity_type, array($entity->ftid => $entity));
- $cache = cache_get($cid, 'cache_field');
- $this->assertEqual($cache->data[$this->field_name][$langcode], $values, t('Cached: correct cache entry on load'));
-
- // Delete, and check that the cache entry is wiped.
- field_attach_delete($entity_type, $entity);
- $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no cache entry after delete'));
- }
-
- /**
- * Test field_attach_validate().
- *
- * Verify that field_attach_validate() invokes the correct
- * hook_field_validate.
- */
- function testFieldAttachValidate() {
- $entity_type = 'test_entity';
- $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Set up values to generate errors
- $values = array();
- for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
- $values[$delta]['value'] = -1;
- $values[$delta]['_error_element'] = 'field_error_' . $delta;
- }
- // Arrange for item 1 not to generate an error
- $values[1]['value'] = 1;
- $entity->{$this->field_name}[$langcode] = $values;
-
- try {
- field_attach_validate($entity_type, $entity);
- }
- catch (FieldValidationException $e) {
- $errors = $e->errors;
- }
-
- foreach ($values as $delta => $value) {
- if ($value['value'] != 1) {
- $this->assertIdentical($errors[$this->field_name][$langcode][$delta][0]['error'], 'field_test_invalid', "Error set on value $delta");
- $this->assertEqual(count($errors[$this->field_name][$langcode][$delta]), 1, "Only one error set on value $delta");
- unset($errors[$this->field_name][$langcode][$delta]);
- }
- else {
- $this->assertFalse(isset($errors[$this->field_name][$langcode][$delta]), "No error set on value $delta");
- }
- }
- $this->assertEqual(count($errors[$this->field_name][$langcode]), 0, 'No extraneous errors set');
- }
-
- /**
- * Test field_attach_form().
- *
- * This could be much more thorough, but it does verify that the correct
- * widgets show up.
- */
- function testFieldAttachForm() {
- $entity_type = 'test_entity';
- $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
-
- $form = $form_state = array();
- field_attach_form($entity_type, $entity, $form, $form_state);
-
- $langcode = FIELD_LANGUAGE_NONE;
- $this->assertEqual($form[$this->field_name][$langcode]['#title'], $this->instance['label'], "Form title is {$this->instance['label']}");
- for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
- // field_test_widget uses 'textfield'
- $this->assertEqual($form[$this->field_name][$langcode][$delta]['value']['#type'], 'textfield', "Form delta $delta widget is textfield");
- }
- }
-
- /**
- * Test field_attach_submit().
- */
- function testFieldAttachSubmit() {
- $entity_type = 'test_entity';
- $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
-
- // Build the form.
- $form = $form_state = array();
- field_attach_form($entity_type, $entity, $form, $form_state);
-
- // Simulate incoming values.
- $values = array();
- $weights = array();
- for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
- $values[$delta]['value'] = mt_rand(1, 127);
- // Assign random weight.
- do {
- $weight = mt_rand(0, $this->field['cardinality']);
- } while (in_array($weight, $weights));
- $weights[$delta] = $weight;
- $values[$delta]['_weight'] = $weight;
- }
- // Leave an empty value. 'field_test' fields are empty if empty().
- $values[1]['value'] = 0;
-
- $langcode = FIELD_LANGUAGE_NONE;
- $form_state['values'] = array($this->field_name => array($langcode => $values));
- field_attach_submit($entity_type, $entity, $form, $form_state);
-
- asort($weights);
- $expected_values = array();
- foreach ($weights as $key => $value) {
- if ($key != 1) {
- $expected_values[] = array('value' => $values[$key]['value']);
- }
- }
- $this->assertIdentical($entity->{$this->field_name}[$langcode], $expected_values, 'Submit filters empty values');
- }
-}
-
-class FieldInfoTestCase extends FieldTestCase {
-
- public static function getInfo() {
- return array(
- 'name' => 'Field info tests',
- 'description' => 'Get information about existing fields, instances and bundles.',
- 'group' => 'Field',
- );
- }
-
- function setUp() {
- parent::setUp('field_test');
- }
-
- /**
- * Test that field types and field definitions are correcly cached.
- */
- function testFieldInfo() {
- // Test that field_test module's fields, widgets, and formatters show up.
- $field_test_info = field_test_field_info();
- $formatter_info = field_test_field_formatter_info();
- $widget_info = field_test_field_widget_info();
- $storage_info = field_test_field_storage_info();
-
- $info = field_info_field_types();
- foreach ($field_test_info as $t_key => $field_type) {
- foreach ($field_type as $key => $val) {
- $this->assertEqual($info[$t_key][$key], $val, t("Field type $t_key key $key is $val"));
- }
- $this->assertEqual($info[$t_key]['module'], 'field_test', t("Field type field_test module appears"));
- }
-
- $info = field_info_formatter_types();
- foreach ($formatter_info as $f_key => $formatter) {
- foreach ($formatter as $key => $val) {
- $this->assertEqual($info[$f_key][$key], $val, t("Formatter type $f_key key $key is $val"));
- }
- $this->assertEqual($info[$f_key]['module'], 'field_test', t("Formatter type field_test module appears"));
- }
-
- $info = field_info_widget_types();
- foreach ($widget_info as $w_key => $widget) {
- foreach ($widget as $key => $val) {
- $this->assertEqual($info[$w_key][$key], $val, t("Widget type $w_key key $key is $val"));
- }
- $this->assertEqual($info[$w_key]['module'], 'field_test', t("Widget type field_test module appears"));
- }
-
- $info = field_info_storage_types();
- foreach ($storage_info as $s_key => $storage) {
- foreach ($storage as $key => $val) {
- $this->assertEqual($info[$s_key][$key], $val, t("Storage type $s_key key $key is $val"));
- }
- $this->assertEqual($info[$s_key]['module'], 'field_test', t("Storage type field_test module appears"));
- }
-
- // Verify that no unexpected instances exist.
- $core_fields = field_info_fields();
- $instances = field_info_instances('test_entity', FIELD_TEST_BUNDLE);
- $this->assertTrue(empty($instances), t('With no instances, info bundles is empty.'));
-
- // Create a field, verify it shows up.
- $field = array(
- 'field_name' => drupal_strtolower($this->randomName()),
- 'type' => 'test_field',
- );
- field_create_field($field);
- $fields = field_info_fields();
- $this->assertEqual(count($fields), count($core_fields) + 1, t('One new field exists'));
- $this->assertEqual($fields[$field['field_name']]['field_name'], $field['field_name'], t('info fields contains field name'));
- $this->assertEqual($fields[$field['field_name']]['type'], $field['type'], t('info fields contains field type'));
- $this->assertEqual($fields[$field['field_name']]['module'], 'field_test', t('info fields contains field module'));
- $settings = array('test_field_setting' => 'dummy test string');
- foreach ($settings as $key => $val) {
- $this->assertEqual($fields[$field['field_name']]['settings'][$key], $val, t("Field setting $key has correct default value $val"));
- }
- $this->assertEqual($fields[$field['field_name']]['cardinality'], 1, t('info fields contains cardinality 1'));
- $this->assertEqual($fields[$field['field_name']]['active'], 1, t('info fields contains active 1'));
-
- // Create an instance, verify that it shows up
- $instance = array(
- 'field_name' => $field['field_name'],
- 'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
- 'label' => $this->randomName(),
- 'description' => $this->randomName(),
- 'weight' => mt_rand(0, 127),
- // test_field has no instance settings
- 'widget' => array(
- 'type' => 'test_field_widget',
- 'settings' => array(
- 'test_setting' => 999)));
- field_create_instance($instance);
-
- $instances = field_info_instances('test_entity', $instance['bundle']);
- $this->assertEqual(count($instances), 1, t('One instance shows up in info when attached to a bundle.'));
- $this->assertTrue($instance < $instances[$instance['field_name']], t('Instance appears in info correctly'));
- }
-
- /**
- * Test that cached field definitions are ready for current runtime context.
- */
- function testFieldPrepare() {
- $field_definition = array(
- 'field_name' => 'field',
- 'type' => 'test_field',
- );
- field_create_field($field_definition);
-
- // Simulate a stored field definition missing a field setting (e.g. a
- // third-party module adding a new field setting has been enabled, and
- // existing fields do not know the setting yet).
- $data = db_query('SELECT data FROM {field_config} WHERE field_name = :field_name', array(':field_name' => $field_definition['field_name']))->fetchField();
- $data = unserialize($data);
- $data['settings'] = array();
- db_update('field_config')
- ->fields(array('data' => serialize($data)))
- ->condition('field_name', $field_definition['field_name'])
- ->execute();
-
- field_cache_clear();
-
- // Read the field back.
- $field = field_info_field($field_definition['field_name']);
-
- // Check that all expected settings are in place.
- $field_type = field_info_field_types($field_definition['type']);
- $this->assertIdentical($field['settings'], $field_type['settings'], t('All expected default field settings are present.'));
- }
-
- /**
- * Test that cached instance definitions are ready for current runtime context.
- */
- function testInstancePrepare() {
- $field_definition = array(
- 'field_name' => 'field',
- 'type' => 'test_field',
- );
- field_create_field($field_definition);
- $instance_definition = array(
- 'field_name' => $field_definition['field_name'],
- 'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
- );
- field_create_instance($instance_definition);
-
- // Simulate a stored instance definition missing various settings (e.g. a
- // third-party module adding instance, widget or display settings has been
- // enabled, but existing instances do not know the new settings).
- $data = db_query('SELECT data FROM {field_config_instance} WHERE field_name = :field_name AND bundle = :bundle', array(':field_name' => $instance_definition['field_name'], ':bundle' => $instance_definition['bundle']))->fetchField();
- $data = unserialize($data);
- $data['settings'] = array();
- $data['widget']['settings'] = 'unavailable_widget';
- $data['widget']['settings'] = array();
- $data['display']['full']['type'] = 'unavailable_formatter';
- $data['display']['full']['settings'] = array();
- db_update('field_config_instance')
- ->fields(array('data' => serialize($data)))
- ->condition('field_name', $instance_definition['field_name'])
- ->condition('bundle', $instance_definition['bundle'])
- ->execute();
-
- field_cache_clear();
-
- // Read the instance back.
- $instance = field_info_instance($instance_definition['object_type'], $instance_definition['field_name'], $instance_definition['bundle']);
-
- // Check that all expected instance settings are in place.
- $field_type = field_info_field_types($field_definition['type']);
- $this->assertIdentical($instance['settings'], $field_type['instance_settings'] , t('All expected instance settings are present.'));
-
- // Check that the default widget is used and expected settings are in place.
- $this->assertIdentical($instance['widget']['type'], $field_type['default_widget'], t('Unavailable widget replaced with default widget.'));
- $widget_type = field_info_widget_types($instance['widget']['type']);
- $this->assertIdentical($instance['widget']['settings'], $widget_type['settings'] , t('All expected widget settings are present.'));
-
- // Check that the default formatter is used and expected settings are in place.
- foreach (field_build_modes('test_entity') as $build_mode => $label) {
- $this->assertIdentical($instance['display'][$build_mode]['type'], $field_type['default_formatter'], t('Unavailable formatter replaced with default formatter in build_mode %build_mode', array('%build_mode' => $build_mode)));
- $formatter_type = field_info_formatter_types($instance['display'][$build_mode]['type']);
- $this->assertIdentical($instance['display'][$build_mode]['settings'], $formatter_type['settings'] , t('All expected formatter settings are present in build_mode %build_mode', array('%build_mode' => $build_mode)));
- }
- }
-
- /**
- * Test that the field_info settings convenience functions work.
- */
- function testSettingsInfo() {
- $info = field_test_field_info();
- foreach ($info as $type => $data) {
- $this->assertIdentical(field_info_field_settings($type), $data['settings'], "field_info_field_settings returns {$type}'s field settings");
- $this->assertIdentical(field_info_instance_settings($type), $data['instance_settings'], "field_info_field_settings returns {$type}'s field instance settings");
- }
-
- $info = field_test_field_widget_info();
- foreach ($info as $type => $data) {
- $this->assertIdentical(field_info_widget_settings($type), $data['settings'], "field_info_widget_settings returns {$type}'s widget settings");
- }
-
- $info = field_test_field_formatter_info();
- foreach ($info as $type => $data) {
- $this->assertIdentical(field_info_formatter_settings($type), $data['settings'], "field_info_formatter_settings returns {$type}'s formatter settings");
- }
- }
-}
-
-class FieldFormTestCase extends FieldTestCase {
- public static function getInfo() {
- return array(
- 'name' => 'Field form tests',
- 'description' => 'Test Field form handling.',
- 'group' => 'Field',
- );
- }
-
- function setUp() {
- parent::setUp('field_test');
-
- $web_user = $this->drupalCreateUser(array('access field_test content', 'administer field_test content'));
- $this->drupalLogin($web_user);
-
- $this->field_single = array('field_name' => drupal_strtolower($this->randomName()), 'type' => 'test_field');
- $this->field_multiple = array('field_name' => drupal_strtolower($this->randomName()), 'type' => 'test_field', 'cardinality' => 4);
- $this->field_unlimited = array('field_name' => drupal_strtolower($this->randomName()), 'type' => 'test_field', 'cardinality' => FIELD_CARDINALITY_UNLIMITED);
-
- $this->instance = array(
- 'object_type' => 'test_entity',
- 'bundle' => 'test_bundle',
- 'label' => $this->randomName() . '_label',
- 'description' => $this->randomName() . '_description',
- 'weight' => mt_rand(0, 127),
- 'settings' => array(
- 'test_instance_setting' => $this->randomName(),
- ),
- 'widget' => array(
- 'type' => 'test_field_widget',
- 'label' => 'Test Field',
- 'settings' => array(
- 'test_widget_setting' => $this->randomName(),
- )
- )
- );
- }
-
- function testFieldFormSingle() {
- $this->field = $this->field_single;
- $this->field_name = $this->field['field_name'];
- $this->instance['field_name'] = $this->field_name;
- field_create_field($this->field);
- field_create_instance($this->instance);
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Display creation form.
- $this->drupalGet('test-entity/add/test-bundle');
- $this->assertFieldByName("{$this->field_name}[$langcode][0][value]", '', 'Widget is displayed');
- $this->assertNoField("{$this->field_name}[$langcode][1][value]", 'No extraneous widget is displayed');
- // TODO : check that the widget is populated with default value ?
-
- // Submit with invalid value (field-level validation).
- $edit = array("{$this->field_name}[$langcode][0][value]" => -1);
- $this->drupalPost(NULL, $edit, t('Save'));
- $this->assertRaw(t('%name does not accept the value -1.', array('%name' => $this->instance['label'])), 'Field validation fails with invalid input.');
- // TODO : check that the correct field is flagged for error.
-
- // Create an entity
- $value = mt_rand(1, 127);
- $edit = array("{$this->field_name}[$langcode][0][value]" => $value);
- $this->drupalPost(NULL, $edit, t('Save'));
- preg_match('|test-entity/(\d+)/edit|', $this->url, $match);
- $id = $match[1];
- $this->assertRaw(t('test_entity @id has been created.', array('@id' => $id)), 'Entity was created');
- $entity = field_test_entity_test_load($id);
- $this->assertEqual($entity->{$this->field_name}[$langcode][0]['value'], $value, 'Field value was saved');
-
- // Display edit form.
- $this->drupalGet('test-entity/' . $id . '/edit');
- $this->assertFieldByName("{$this->field_name}[$langcode][0][value]", $value, 'Widget is displayed with the correct default value');
- $this->assertNoField("{$this->field_name}[$langcode][1][value]", 'No extraneous widget is displayed');
-
- // Update the entity.
- $value = mt_rand(1, 127);
- $edit = array("{$this->field_name}[$langcode][0][value]" => $value);
- $this->drupalPost(NULL, $edit, t('Save'));
- $this->assertRaw(t('test_entity @id has been updated.', array('@id' => $id)), 'Entity was updated');
- $entity = field_test_entity_test_load($id);
- $this->assertEqual($entity->{$this->field_name}[$langcode][0]['value'], $value, 'Field value was updated');
-
- // Empty the field.
- $value = '';
- $edit = array("{$this->field_name}[$langcode][0][value]" => $value);
- $this->drupalPost('test-entity/' . $id . '/edit', $edit, t('Save'));
- $this->assertRaw(t('test_entity @id has been updated.', array('@id' => $id)), 'Entity was updated');
- $entity = field_test_entity_test_load($id);
- $this->assertIdentical($entity->{$this->field_name}, array(), 'Field was emptied');
-
- }
-
- function testFieldFormSingleRequired() {
- $this->field = $this->field_single;
- $this->field_name = $this->field['field_name'];
- $this->instance['field_name'] = $this->field_name;
- $this->instance['required'] = TRUE;
- field_create_field($this->field);
- field_create_instance($this->instance);
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Submit with missing required value.
- $edit = array();
- $this->drupalPost('test-entity/add/test-bundle', $edit, t('Save'));
- $this->assertRaw(t('!name field is required.', array('!name' => $this->instance['label'])), 'Required field with no value fails validation');
-
- // Create an entity
- $value = mt_rand(1, 127);
- $edit = array("{$this->field_name}[$langcode][0][value]" => $value);
- $this->drupalPost(NULL, $edit, t('Save'));
- preg_match('|test-entity/(\d+)/edit|', $this->url, $match);
- $id = $match[1];
- $this->assertRaw(t('test_entity @id has been created.', array('@id' => $id)), 'Entity was created');
- $entity = field_test_entity_test_load($id);
- $this->assertEqual($entity->{$this->field_name}[$langcode][0]['value'], $value, 'Field value was saved');
-
- // Edit with missing required value.
- $value = '';
- $edit = array("{$this->field_name}[$langcode][0][value]" => $value);
- $this->drupalPost('test-entity/' . $id . '/edit', $edit, t('Save'));
- $this->assertRaw(t('!name field is required.', array('!name' => $this->instance['label'])), 'Required field with no value fails validation');
- }
-
-// function testFieldFormMultiple() {
-// $this->field = $this->field_multiple;
-// $this->field_name = $this->field['field_name'];
-// $this->instance['field_name'] = $this->field_name;
-// field_create_field($this->field);
-// field_create_instance($this->instance);
-// }
-
- function testFieldFormUnlimited() {
- $this->field = $this->field_unlimited;
- $this->field_name = $this->field['field_name'];
- $this->instance['field_name'] = $this->field_name;
- field_create_field($this->field);
- field_create_instance($this->instance);
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Display creation form -> 1 widget.
- $this->drupalGet('test-entity/add/test-bundle');
- $this->assertFieldByName("{$this->field_name}[$langcode][0][value]", '', 'Widget 1 is displayed');
- $this->assertNoField("{$this->field_name}[$langcode][1][value]", 'No extraneous widget is displayed');
-
- // Press 'add more' button -> 2 widgets.
- $this->drupalPost(NULL, array(), t('Add another item'));
- $this->assertFieldByName("{$this->field_name}[$langcode][0][value]", '', 'Widget 1 is displayed');
- $this->assertFieldByName("{$this->field_name}[$langcode][1][value]", '', 'New widget is displayed');
- $this->assertNoField("{$this->field_name}[$langcode][2][value]", 'No extraneous widget is displayed');
- // TODO : check that non-field inpurs are preserved ('title')...
-
- // Yet another time so that we can play with more values -> 3 widgets.
- $this->drupalPost(NULL, array(), t('Add another item'));
-
- // Prepare values and weights.
- $count = 3;
- $delta_range = $count - 1;
- $values = $weights = $pattern = $expected_values = $edit = array();
- for ($delta = 0; $delta <= $delta_range; $delta++) {
- // Assign unique random weights.
- do {
- $weight = mt_rand(-$delta_range, $delta_range);
- } while (in_array($weight, $weights));
- $weights[] = $weight;
- $value = mt_rand(1, 127);
- $edit["$this->field_name[$langcode][$delta][value]"] = $value;
- $edit["$this->field_name[$langcode][$delta][_weight]"] = $weight;
- // We'll need three slightly different formats to check the values.
- $values[$weight] = $value;
- $field_values[$weight]['value'] = (string)$value;
- $pattern[$weight] = "]*value=\"$value\" [^>]*";
- }
-
- // Press 'add more' button -> 4 widgets
- $this->drupalPost(NULL, $edit, t('Add another item'));
- ksort($values);
- $values = array_values($values);
- for ($delta = 0; $delta <= $delta_range; $delta++) {
- $this->assertFieldByName("$this->field_name[$langcode][$delta][value]", $values[$delta], "Widget $delta is displayed and has the right value");
- $this->assertFieldByName("$this->field_name[$langcode][$delta][_weight]", $delta, "Widget $delta has the right weight");
- }
- ksort($pattern);
- $pattern = implode('.*', array_values($pattern));
- $this->assertPattern("|$pattern|s", 'Widgets are displayed in the correct order');
- $this->assertFieldByName("$this->field_name[$langcode][$delta][value]", '', "New widget is displayed");
- $this->assertFieldByName("$this->field_name[$langcode][$delta][_weight]", $delta, "New widget has the right weight");
- $this->assertNoField("$this->field_name[$langcode][" . ($delta + 1) . '][value]', 'No extraneous widget is displayed');
-
- // Submit the form and create the entity.
- $this->drupalPost(NULL, $edit, t('Save'));
- preg_match('|test-entity/(\d+)/edit|', $this->url, $match);
- $id = $match[1];
- $this->assertRaw(t('test_entity @id has been created.', array('@id' => $id)), 'Entity was created');
- $entity = field_test_entity_test_load($id);
- ksort($field_values);
- $field_values = array_values($field_values);
- $this->assertIdentical($entity->{$this->field_name}[$langcode], $field_values, 'Field values were saved in the correct order');
-
- // Display edit form: check that the expected number of widgets is
- // displayed, with correct values change values, reorder, leave an empty
- // value in the middle.
- // Submit: check that the entity is updated with correct values
- // Re-submit: check that the field can be emptied.
-
- // Test with several multiple fields in a form
- }
-
- // Check with a multiple widget (implement a textfield with comma separated values).
-
- // Check inaccessible fields are preserved on update.
- // Check inaccessible fields get default value on insert (not implemented yet).
-
- function testFieldFormJSAddMore() {
- $this->field = $this->field_unlimited;
- $this->field_name = $this->field['field_name'];
- $this->instance['field_name'] = $this->field_name;
- field_create_field($this->field);
- field_create_instance($this->instance);
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Display creation form -> 1 widget.
- $this->drupalGet('test-entity/add/test-bundle');
-
- // Press 'add more' button a couple times -> 3 widgets.
- // The drupalPostAhah() helper will not work iteratively, so we add those.
- // through non-'JS' submission.
- $this->drupalPost(NULL, array(), t('Add another item'));
- $this->drupalPost(NULL, array(), t('Add another item'));
-
- // Prepare values and weights.
- $count = 3;
- $delta_range = $count - 1;
- $values = $weights = $pattern = $expected_values = $edit = array();
- for ($delta = 0; $delta <= $delta_range; $delta++) {
- // Assign unique random weights.
- do {
- $weight = mt_rand(-$delta_range, $delta_range);
- } while (in_array($weight, $weights));
- $weights[] = $weight;
- $value = mt_rand(1, 127);
- $edit["$this->field_name[$langcode][$delta][value]"] = $value;
- $edit["$this->field_name[$langcode][$delta][_weight]"] = $weight;
- // We'll need three slightly different formats to check the values.
- $values[$weight] = $value;
- $field_values[$weight]['value'] = (string)$value;
- $pattern[$weight] = "]*value=\"$value\" [^>]*";
- }
- // Press 'add more' button through AHAH.
- $this->_fieldPostAhah($edit, t('Add another item'));
-
- ksort($values);
- $values = array_values($values);
- for ($delta = 0; $delta <= $delta_range; $delta++) {
- $this->assertFieldByName("$this->field_name[$langcode][$delta][value]", $values[$delta], "Widget $delta is displayed and has the right value");
- $this->assertFieldByName("$this->field_name[$langcode][$delta][_weight]", $delta, "Widget $delta has the right weight");
- }
- ksort($pattern);
- $pattern = implode('.*', array_values($pattern));
- $this->assertPattern("|$pattern|s", 'Widgets are displayed in the correct order');
- $this->assertFieldByName("$this->field_name[$langcode][$delta][value]", '', "New widget is displayed");
- $this->assertFieldByName("$this->field_name[$langcode][$delta][_weight]", $delta, "New widget has the right weight");
- $this->assertNoField("$this->field_name[$langcode][" . ($delta + 1) . '][value]', 'No extraneous widget is displayed');
- }
-
- /**
- * Tests fields with no 'edit' access.
- */
- function testFieldFormAccess() {
- // Create a "regular" field.
- $field = $this->field_single;
- $field_name = $field['field_name'];
- $instance = $this->instance;
- $instance['field_name'] = $field_name;
- field_create_field($field);
- field_create_instance($instance);
-
- // Create a field with no edit access - see field_test_field_access().
- $field_no_access = array(
- 'field_name' => 'field_no_edit_access',
- 'type' => 'test_field',
- );
- $field_name_no_access = $field_no_access['field_name'];
- $instance_no_access = array(
- 'field_name' => $field_name_no_access,
- 'object_type' => 'test_entity',
- 'bundle' => 'test_bundle',
- 'default_value' => array(0 => array('value' => 99)),
- );
- field_create_field($field_no_access);
- field_create_instance($instance_no_access);
-
- $langcode = FIELD_LANGUAGE_NONE;
-
- // Display creation form.
- $this->drupalGet('test-entity/add/test-bundle');
- $this->assertNoFieldByName("{$field_name_no_access}[$langcode][0][value]", '', t('Widget is not displayed if field access is denied.'));
-
- // Create entity.
- $edit = array("{$field_name}[$langcode][0][value]" => 1);
- $this->drupalPost(NULL, $edit, t('Save'));
- preg_match('|test-entity/(\d+)/edit|', $this->url, $match);
- $id = $match[1];
-
- // Check that the default value was saved.
- $entity = field_test_entity_test_load($id);
- $this->assertEqual($entity->{$field_name_no_access}[$langcode][0]['value'], 99, t('Default value was saved for the field with no edit access.'));
- $this->assertEqual($entity->{$field_name}[$langcode][0]['value'], 1, t('Entered value vas saved for the field with edit access.'));
-
- // Create a new revision.
- $edit = array("{$field_name}[$langcode][0][value]" => 2, 'revision' => TRUE);
- $this->drupalPost('test-entity/' . $id . '/edit', $edit, t('Save'));
-
- // Check that the new revision has the expected values.
- $entity = field_test_entity_test_load($id);
- $this->assertEqual($entity->{$field_name_no_access}[$langcode][0]['value'], 99, t('New revision has the expected value for the field with no edit access.'));
- $this->assertEqual($entity->{$field_name}[$langcode][0]['value'], 2, t('New revision has the expected value for the field with edit access.'));
-
- // Check that the revision is also saved in the revisions table.
- $entity = field_test_entity_test_load($id, $entity->ftvid);
- $this->assertEqual($entity->{$field_name_no_access}[$langcode][0]['value'], 99, t('New revision has the expected value for the field with no edit access.'));
- $this->assertEqual($entity->{$field_name}[$langcode][0]['value'], 2, t('New revision has the expected value for the field with edit access.'));
- }
-
- /**
- * Execute a POST request on a AHAH callback.
- *
- * Stolen from poll.test. The JSON result is parsed into HTML and placed in
- * $this->content, so that regular asserts can be performed.
- *
- * Since the result is generally not a full-fledged form, this cannot be
- * called iteratively.
- */
- function _fieldPostAhah($edit, $submit, array $options = array(), array $headers = array()) {
- $this->additionalCurlOptions[CURLOPT_URL] = url('system/ajax', array('absolute' => TRUE));
- $this->drupalPost(NULL, $edit, $submit);
- unset($this->additionalCurlOptions[CURLOPT_URL]);
-
- // The response is drupal_json_output, so we need to undo some escaping.
- $commands = json_decode(str_replace(array('\x3c', '\x3e', '\x26'), array("<", ">", "&"), $this->drupalGetContent()));
-
- // The JSON response will be two AJAX commands. The first is a settings
- // command and the second is the replace command.
- $settings = reset($commands);
- $replace = next($commands);
-
- $this->assertTrue(is_object($settings), t('The response settings command is an object'));
- $this->assertTrue(is_object($replace), t('The response replace command is an object'));
-
- // This response data is valid HTML so we will can reuse everything we have
- // for HTML pages.
- $this->content = $replace->data;
-
- // Needs to be emptied out so the new content will be parsed.
- $this->elements = '';
- }
-}
-
-class FieldCrudTestCase extends FieldTestCase {
- public static function getInfo() {
- return array(
- 'name' => 'Field CRUD tests',
- 'description' => 'Test field create, read, update, and delete.',
- 'group' => 'Field',
- );
- }
-
- function setUp() {
- // field_update_field() tests use number.module
- parent::setUp('field_test', 'number');
- }
-
- // TODO : test creation with
- // - a full fledged $field structure, check that all the values are there
- // - a minimal $field structure, check all default values are set
- // defer actual $field comparison to a helper function, used for the two cases above
-
- /**
- * Test the creation of a field.
- */
- function testCreateField() {
- $field_definition = array(
- 'field_name' => 'field_2',
- 'type' => 'test_field',
- );
- field_test_memorize();
- $field_definition = field_create_field($field_definition);
- $mem = field_test_memorize();
- $this->assertIdentical($mem['field_test_field_create_field'][0][0], $field_definition, 'hook_field_create_field() called with correct arguments.');
-
- // Read the raw record from the {field_config_instance} table.
- $result = db_query('SELECT * FROM {field_config} WHERE field_name = :field_name', array(':field_name' => $field_definition['field_name']));
- $record = $result->fetchAssoc();
- $record['data'] = unserialize($record['data']);
-
- // Ensure that basic properties are preserved.
- $this->assertEqual($record['field_name'], $field_definition['field_name'], t('The field name is properly saved.'));
- $this->assertEqual($record['type'], $field_definition['type'], t('The field type is properly saved.'));
-
- // Ensure that cardinality defaults to 1.
- $this->assertEqual($record['cardinality'], 1, t('Cardinality defaults to 1.'));
-
- // Ensure that default settings are present.
- $field_type = field_info_field_types($field_definition['type']);
- $this->assertIdentical($record['data']['settings'], $field_type['settings'], t('Default field settings have been written.'));
-
- // Ensure that default storage was set.
- $this->assertEqual($record['storage_type'], variable_get('field_storage_default'), t('The field type is properly saved.'));
-
- // Guarantee that the name is unique.
- try {
- field_create_field($field_definition);
- $this->fail(t('Cannot create two fields with the same name.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot create two fields with the same name.'));
- }
-
- // Check that field type is required.
- try {
- $field_definition = array(
- 'field_name' => 'field_1',
- );
- field_create_field($field_definition);
- $this->fail(t('Cannot create a field with no type.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot create a field with no type.'));
- }
-
- // Check that field name is required.
- try {
- $field_definition = array(
- 'type' => 'test_field'
- );
- field_create_field($field_definition);
- $this->fail(t('Cannot create an unnamed field.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot create an unnamed field.'));
- }
-
- // Check that field name must start with a letter or _.
- try {
- $field_definition = array(
- 'field_name' => '2field_2',
- 'type' => 'test_field',
- );
- field_create_field($field_definition);
- $this->fail(t('Cannot create a field with a name starting with a digit.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot create a field with a name starting with a digit.'));
- }
-
- // Check that field name must only contain lowercase alphanumeric or _.
- try {
- $field_definition = array(
- 'field_name' => 'field#_3',
- 'type' => 'test_field',
- );
- field_create_field($field_definition);
- $this->fail(t('Cannot create a field with a name containing an illegal character.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot create a field with a name containing an illegal character.'));
- }
-
- // Check that field name cannot be longer than 32 characters long.
- try {
- $field_definition = array(
- 'field_name' => '_12345678901234567890123456789012',
- 'type' => 'test_field',
- );
- field_create_field($field_definition);
- $this->fail(t('Cannot create a field with a name longer than 32 characters.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot create a field with a name longer than 32 characters.'));
- }
-
- // Check that field name can not be an object key.
- // "ftvid" is known as an object key from the "test_entity" type.
- try {
- $field_definition = array(
- 'type' => 'test_field',
- 'field_name' => 'ftvid',
- );
- $field = field_create_field($field_definition);
- $this->fail(t('Cannot create a field bearing the name of an object key.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot create a field bearing the name of an object key.'));
- }
- }
-
- /**
- * Test failure to create a field.
- */
- function testCreateFieldFail() {
- $field_name = 'duplicate';
- $field_definition = array('field_name' => $field_name, 'type' => 'test_field', 'storage' => array('type' => 'field_test_storage_failure'));
- $query = db_select('field_config')->condition('field_name', $field_name)->countQuery();
-
- // The field does not appear in field_config.
- $count = $query->execute()->fetchField();
- $this->assertEqual($count, 0, 'A field_config row for the field does not exist.');
-
- // Try to create the field.
- try {
- $field = field_create_field($field_definition);
- $this->assertTrue(FALSE, 'Field creation (correctly) fails.');
- }
- catch (Exception $e) {
- $this->assertTrue(TRUE, 'Field creation (correctly) fails.');
- }
-
- // The field does not appear in field_config.
- $count = $query->execute()->fetchField();
- $this->assertEqual($count, 0, 'A field_config row for the field does not exist.');
- }
-
- /**
- * Test reading back a field definition.
- */
- function testReadField() {
- $field_definition = array(
- 'field_name' => 'field_1',
- 'type' => 'test_field',
- );
- field_create_field($field_definition);
-
- // Read the field back.
- $field = field_read_field($field_definition['field_name']);
- $this->assertTrue($field_definition < $field, t('The field was properly read.'));
- }
-
- /**
- * Test creation of indexes on data column.
- */
- function testFieldIndexes() {
- // Check that indexes specified by the field type are used by default.
- $field_definition = array(
- 'field_name' => 'field_1',
- 'type' => 'test_field',
- );
- field_create_field($field_definition);
- $field = field_read_field($field_definition['field_name']);
- $expected_indexes = array('value' => array('value'));
- $this->assertEqual($field['indexes'], $expected_indexes, t('Field type indexes saved by default'));
-
- // Check that indexes specified by the field definition override the field
- // type indexes.
- $field_definition = array(
- 'field_name' => 'field_2',
- 'type' => 'test_field',
- 'indexes' => array(
- 'value' => array(),
- ),
- );
- field_create_field($field_definition);
- $field = field_read_field($field_definition['field_name']);
- $expected_indexes = array('value' => array());
- $this->assertEqual($field['indexes'], $expected_indexes, t('Field definition indexes override field type indexes'));
-
- // Check that indexes specified by the field definition add to the field
- // type indexes.
- $field_definition = array(
- 'field_name' => 'field_3',
- 'type' => 'test_field',
- 'indexes' => array(
- 'value_2' => array('value'),
- ),
- );
- field_create_field($field_definition);
- $field = field_read_field($field_definition['field_name']);
- $expected_indexes = array('value' => array('value'), 'value_2' => array('value'));
- $this->assertEqual($field['indexes'], $expected_indexes, t('Field definition indexes are merged with field type indexes'));
- }
-
- /**
- * Test the deletion of a field.
- */
- function testDeleteField() {
- // TODO: Also test deletion of the data stored in the field ?
-
- // Create two fields (so we can test that only one is deleted).
- $this->field = array('field_name' => 'field_1', 'type' => 'test_field');
- field_create_field($this->field);
- $this->another_field = array('field_name' => 'field_2', 'type' => 'test_field');
- field_create_field($this->another_field);
-
- // Create instances for each.
- $this->instance_definition = array(
- 'field_name' => $this->field['field_name'],
- 'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
- 'widget' => array(
- 'type' => 'test_field_widget',
- ),
- );
- field_create_instance($this->instance_definition);
- $this->another_instance_definition = $this->instance_definition;
- $this->another_instance_definition['field_name'] = $this->another_field['field_name'];
- field_create_instance($this->another_instance_definition);
-
- // Test that the first field is not deleted, and then delete it.
- $field = field_read_field($this->field['field_name'], array('include_deleted' => TRUE));
- $this->assertTrue(!empty($field) && empty($field['deleted']), t('A new field is not marked for deletion.'));
- field_delete_field($this->field['field_name']);
-
- // Make sure that the field is marked as deleted when it is specifically
- // loaded.
- $field = field_read_field($this->field['field_name'], array('include_deleted' => TRUE));
- $this->assertTrue(!empty($field['deleted']), t('A deleted field is marked for deletion.'));
-
- // Make sure that this field's instance is marked as deleted when it is
- // specifically loaded.
- $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle'], array('include_deleted' => TRUE));
- $this->assertTrue(!empty($instance['deleted']), t('An instance for a deleted field is marked for deletion.'));
-
- // Try to load the field normally and make sure it does not show up.
- $field = field_read_field($this->field['field_name']);
- $this->assertTrue(empty($field), t('A deleted field is not loaded by default.'));
-
- // Try to load the instance normally and make sure it does not show up.
- $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
- $this->assertTrue(empty($instance), t('An instance for a deleted field is not loaded by default.'));
-
- // Make sure the other field (and its field instance) are not deleted.
- $another_field = field_read_field($this->another_field['field_name']);
- $this->assertTrue(!empty($another_field) && empty($another_field['deleted']), t('A non-deleted field is not marked for deletion.'));
- $another_instance = field_read_instance('test_entity', $this->another_instance_definition['field_name'], $this->another_instance_definition['bundle']);
- $this->assertTrue(!empty($another_instance) && empty($another_instance['deleted']), t('An instance of a non-deleted field is not marked for deletion.'));
-
- // Try to create a new field the same name as a deleted field and
- // write data into it.
- field_create_field($this->field);
- field_create_instance($this->instance_definition);
- $field = field_read_field($this->field['field_name']);
- $this->assertTrue(!empty($field) && empty($field['deleted']), t('A new field with a previously used name is created.'));
- $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
- $this->assertTrue(!empty($instance) && empty($instance['deleted']), t('A new instance for a previously used field name is created.'));
-
- // Save an object with data for the field
- $entity = field_test_create_stub_entity(0, 0, $instance['bundle']);
- $langcode = FIELD_LANGUAGE_NONE;
- $values[0]['value'] = mt_rand(1, 127);
- $entity->{$field['field_name']}[$langcode] = $values;
- $entity_type = 'test_entity';
- field_attach_insert('test_entity', $entity);
-
- // Verify the field is present on load
- $entity = field_test_create_stub_entity(0, 0, $this->instance_definition['bundle']);
- field_attach_load($entity_type, array(0 => $entity));
- $this->assertIdentical(count($entity->{$field['field_name']}[$langcode]), count($values), "Data in previously deleted field saves and loads correctly");
- foreach ($values as $delta => $value) {
- $this->assertEqual($entity->{$field['field_name']}[$langcode][$delta]['value'], $values[$delta]['value'], "Data in previously deleted field saves and loads correctly");
- }
- }
-
- function testUpdateNonExistentField() {
- $test_field = array('field_name' => 'does_not_exist', 'type' => 'number_decimal');
- try {
- field_update_field($test_field);
- $this->fail(t('Cannot update a field that does not exist.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot update a field that does not exist.'));
- }
- }
-
- function testUpdateFieldType() {
- $field = array('field_name' => 'field_type', 'type' => 'number_decimal');
- $field = field_create_field($field);
-
- $test_field = array('field_name' => 'field_type', 'type' => 'number_integer');
- try {
- field_update_field($test_field);
- $this->fail(t('Cannot update a field to a different type.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot update a field to a different type.'));
- }
- }
-
- /**
- * Test updating a field.
- */
- function testUpdateField() {
- // Create a decimal 5.2 field.
- $field = array('field_name' => 'decimal53', 'type' => 'number_decimal', 'cardinality' => 3, 'settings' => array('precision' => 5, 'scale' => 2));
- $field = field_create_field($field);
- $instance = array('field_name' => 'decimal53', 'object_type' => 'test_entity', 'bundle' => FIELD_TEST_BUNDLE);
- $instance = field_create_instance($instance);
-
- // Update it to a deciaml 5.3 field.
- $field['settings']['scale'] = 3;
- field_update_field($field);
-
- // Save values with 2, 3, and 4 decimal places.
- $entity = field_test_create_stub_entity(0, 0, $instance['bundle']);
- $entity->decimal53[FIELD_LANGUAGE_NONE][0]['value'] = '1.23';
- $entity->decimal53[FIELD_LANGUAGE_NONE][1]['value'] = '1.235';
- $entity->decimal53[FIELD_LANGUAGE_NONE][2]['value'] = '1.2355';
- field_attach_insert('test_entity', $entity);
- $entity = field_test_create_stub_entity(0, 0, $instance['bundle']);
-
- // Verify that the updated 5.3 field rounds to 3 decimal places.
- field_attach_load('test_entity', array(0 => $entity));
- $this->assertEqual($entity->decimal53[FIELD_LANGUAGE_NONE][0]['value'], '1.23', t('2 decimal places are left alone'));
- $this->assertEqual($entity->decimal53[FIELD_LANGUAGE_NONE][1]['value'], '1.235', t('3 decimal places are left alone'));
- $this->assertEqual($entity->decimal53[FIELD_LANGUAGE_NONE][2]['value'], '1.236', t('4 decimal places are rounded to 3'));
- }
-
- /**
- * Test field type modules forbidding an update.
- */
- function testUpdateFieldForbid() {
- $field = array('field_name' => 'forbidden', 'type' => 'test_field', 'settings' => array('changeable' => 0, 'unchangeable' => 0));
- $field = field_create_field($field);
- $field['settings']['changeable']++;
- try {
- field_update_field($field);
- $this->pass(t("A changeable setting can be updated."));
- }
- catch (FieldException $e) {
- $this->fail(t("An unchangeable setting cannot be updated."));
- }
- $field['settings']['unchangeable']++;
- try {
- field_update_field($field);
- $this->fail(t("An unchangeable setting can be updated."));
- }
- catch (FieldException $e) {
- $this->pass(t("An unchangeable setting cannot be updated."));
- }
- }
-
- /**
- * Test that fields are properly marked active or inactive.
- */
- function testActive() {
- $field_definition = array(
- 'field_name' => 'field_1',
- 'type' => 'test_field',
- // For this test, we need a storage backend provided by a different
- // module than field_test.module.
- 'storage' => array(
- 'type' => 'field_sql_storage',
- ),
- );
- field_create_field($field_definition);
-
- // Test disabling and enabling:
- // - the field type module,
- // - the storage module,
- // - both.
- $this->_testActiveHelper($field_definition, array('field_test'));
- $this->_testActiveHelper($field_definition, array('field_sql_storage'));
- $this->_testActiveHelper($field_definition, array('field_test', 'field_sql_storage'));
- }
-
- /**
- * Helper function for testActive().
- *
- * Test dependency between a field and a set of modules.
- *
- * @param $field_definition
- * A field definition.
- * @param $modules
- * An aray of module names. The field will be tested to be inactive as long
- * as any of those modules is disabled.
- */
- function _testActiveHelper($field_definition, $modules) {
- $field_name = $field_definition['field_name'];
-
- // Read the field.
- $field = field_read_field($field_name);
- $this->assertTrue($field_definition <= $field, t('The field was properly read.'));
-
- module_disable($modules);
-
- $fields = field_read_fields(array('field_name' => $field_name), array('include_inactive' => TRUE));
- $this->assertTrue(isset($fields[$field_name]) && $field_definition < $field, t('The field is properly read when explicitly fetching inactive fields.'));
-
- // Re-enable modules one by one, and check that the field is still inactive
- // while some modules remain disabled.
- while ($modules) {
- $field = field_read_field($field_name);
- $this->assertTrue(empty($field), t('%modules disabled. The field is marked inactive.', array('%modules' => implode(', ', $modules))));
-
- $module = array_shift($modules);
- module_enable(array($module));
- }
-
- // Check that the field is active again after all modules have been
- // enabled.
- $field = field_read_field($field_name);
- $this->assertTrue($field_definition <= $field, t('The field was was marked active.'));
- }
-}
-
-class FieldInstanceCrudTestCase extends FieldTestCase {
- protected $field;
-
- public static function getInfo() {
- return array(
- 'name' => 'Field instance CRUD tests',
- 'description' => 'Create field entities by attaching fields to entities.',
- 'group' => 'Field',
- );
- }
-
- function setUp() {
- parent::setUp('field_test');
-
- $this->field = array(
- 'field_name' => drupal_strtolower($this->randomName()),
- 'type' => 'test_field',
- );
- field_create_field($this->field);
- $this->instance_definition = array(
- 'field_name' => $this->field['field_name'],
- 'object_type' => 'test_entity',
- 'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
- );
- }
-
- // TODO : test creation with
- // - a full fledged $instance structure, check that all the values are there
- // - a minimal $instance structure, check all default values are set
- // defer actual $instance comparison to a helper function, used for the two cases above,
- // and for testUpdateFieldInstance
-
- /**
- * Test the creation of a field instance.
- */
- function testCreateFieldInstance() {
- field_create_instance($this->instance_definition);
-
- // Read the raw record from the {field_config_instance} table.
- $result = db_query('SELECT * FROM {field_config_instance} WHERE field_name = :field_name AND bundle = :bundle', array(':field_name' => $this->instance_definition['field_name'], ':bundle' => $this->instance_definition['bundle']));
- $record = $result->fetchAssoc();
- $record['data'] = unserialize($record['data']);
-
- $field_type = field_info_field_types($this->field['type']);
- $widget_type = field_info_widget_types($field_type['default_widget']);
- $formatter_type = field_info_formatter_types($field_type['default_formatter']);
-
- // Check that default values are set.
- $this->assertIdentical($record['data']['required'], FALSE, t('Required defaults to false.'));
- $this->assertIdentical($record['data']['label'], $this->instance_definition['field_name'], t('Label defaults to field name.'));
- $this->assertIdentical($record['data']['description'], '', t('Description defaults to empty string.'));
- $this->assertIdentical($record['data']['widget']['type'], $field_type['default_widget'], t('Default widget has been written.'));
- $this->assertTrue(isset($record['data']['display']['full']), t('Display for "full" build_mode has been written.'));
- $this->assertIdentical($record['data']['display']['full']['type'], $field_type['default_formatter'], t('Default formatter for "full" build_mode has been written.'));
-
- // Check that default settings are set.
- $this->assertIdentical($record['data']['settings'], $field_type['instance_settings'] , t('Default instance settings have been written.'));
- $this->assertIdentical($record['data']['widget']['settings'], $widget_type['settings'] , t('Default widget settings have been written.'));
- $this->assertIdentical($record['data']['display']['full']['settings'], $formatter_type['settings'], t('Default formatter settings for "full" build_mode have been written.'));
-
- // Guarantee that the field/bundle combination is unique.
- try {
- field_create_instance($this->instance_definition);
- $this->fail(t('Cannot create two instances with the same field / bundle combination.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot create two instances with the same field / bundle combination.'));
- }
-
- // Check that the specified field exists.
- try {
- $this->instance_definition['field_name'] = $this->randomName();
- field_create_instance($this->instance_definition);
- $this->fail(t('Cannot create an instance of a non-existing field.'));
- }
- catch (FieldException $e) {
- $this->pass(t('Cannot create an instance of a non-existing field.'));
- }
-
- // TODO: test other failures.
- }
-
- /**
- * Test reading back an instance definition.
- */
- function testReadFieldInstance() {
- field_create_instance($this->instance_definition);
-
- // Read the instance back.
- $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
- $this->assertTrue($this->instance_definition < $instance, t('The field was properly read.'));
- }
-
- /**
- * Test the update of a field instance.
- */
- function testUpdateFieldInstance() {
- field_create_instance($this->instance_definition);
- $field_type = field_info_field_types($this->field['type']);
-
- // Check that basic changes are saved.
- $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
- $instance['required'] = !$instance['required'];
- $instance['label'] = $this->randomName();
- $instance['description'] = $this->randomName();
- $instance['settings']['test_instance_setting'] = $this->randomName();
- $instance['widget']['settings']['test_widget_setting'] =$this->randomName();
- $instance['widget']['weight']++;
- $instance['display']['full']['settings']['test_formatter_setting'] = $this->randomName();
- $instance['display']['full']['weight']++;
- field_update_instance($instance);
-
- $instance_new = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
- $this->assertEqual($instance['required'], $instance_new['required'], t('"required" change is saved'));
- $this->assertEqual($instance['label'], $instance_new['label'], t('"label" change is saved'));
- $this->assertEqual($instance['description'], $instance_new['description'], t('"description" change is saved'));
- $this->assertEqual($instance['widget']['settings']['test_widget_setting'], $instance_new['widget']['settings']['test_widget_setting'], t('Widget setting change is saved'));
- $this->assertEqual($instance['widget']['weight'], $instance_new['widget']['weight'], t('Widget weight change is saved'));
- $this->assertEqual($instance['display']['full']['settings']['test_formatter_setting'], $instance_new['display']['full']['settings']['test_formatter_setting'], t('Formatter setting change is saved'));
- $this->assertEqual($instance['display']['full']['weight'], $instance_new['display']['full']['weight'], t('Widget weight change is saved'));
-
- // Check that changing widget and formatter types updates the default settings.
- $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
- $instance['widget']['type'] = 'test_field_widget_multiple';
- $instance['display']['full']['type'] = 'field_test_multiple';
- field_update_instance($instance);
-
- $instance_new = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
- $this->assertEqual($instance['widget']['type'], $instance_new['widget']['type'] , t('Widget type change is saved.'));
- $settings = field_info_widget_settings($instance_new['widget']['type']);
- $this->assertIdentical($settings, array_intersect_key($instance_new['widget']['settings'], $settings) , t('Widget type change updates default settings.'));
- $this->assertEqual($instance['display']['full']['type'], $instance_new['display']['full']['type'] , t('Formatter type change is saved.'));
- $info = field_info_formatter_types($instance_new['display']['full']['type']);
- $settings = $info['settings'];
- $this->assertIdentical($settings, array_intersect_key($instance_new['display']['full']['settings'], $settings) , t('Changing formatter type updates default settings.'));
-
- // Check that adding a new build mode is saved and gets default settings.
- $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
- $instance['display']['teaser'] = array();
- field_update_instance($instance);
-
- $instance_new = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
- $this->assertTrue(isset($instance_new['display']['teaser']), t('Display for the new build_mode has been written.'));
- $this->assertIdentical($instance_new['display']['teaser']['type'], $field_type['default_formatter'], t('Default formatter for the new build_mode has been written.'));
- $info = field_info_formatter_types($instance_new['display']['teaser']['type']);
- $settings = $info['settings'];
- $this->assertIdentical($settings, $instance_new['display']['teaser']['settings'] , t('Default formatter settings for the new build_mode have been written.'));
-
- // TODO: test failures.
- }
-
- /**
- * Test the deletion of a field instance.
- */
- function testDeleteFieldInstance() {
- // TODO: Test deletion of the data stored in the field also.
- // Need to check that data for a 'deleted' field / instance doesn't get loaded
- // Need to check data marked deleted is cleaned on cron (not implemented yet...)
-
- // Create two instances for the same field so we can test that only one
- // is deleted.
- field_create_instance($this->instance_definition);
- $this->another_instance_definition = $this->instance_definition;
- $this->another_instance_definition['bundle'] .= '_another_bundle';
- $instance = field_create_instance($this->another_instance_definition);
-
- // Test that the first instance is not deleted, and then delete it.
- $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle'], array('include_deleted' => TRUE));
- $this->assertTrue(!empty($instance) && empty($instance['deleted']), t('A new field instance is not marked for deletion.'));
- field_delete_instance($instance);
-
- // Make sure the instance is marked as deleted when the instance is
- // specifically loaded.
- $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle'], array('include_deleted' => TRUE));
- $this->assertTrue(!empty($instance['deleted']), t('A deleted field instance is marked for deletion.'));
-
- // Try to load the instance normally and make sure it does not show up.
- $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
- $this->assertTrue(empty($instance), t('A deleted field instance is not loaded by default.'));
-
- // Make sure the other field instance is not deleted.
- $another_instance = field_read_instance('test_entity', $this->another_instance_definition['field_name'], $this->another_instance_definition['bundle']);
- $this->assertTrue(!empty($another_instance) && empty($another_instance['deleted']), t('A non-deleted field instance is not marked for deletion.'));
- }
-}
-
-/**
- * Unit test class for the multilanguage fields logic.
- *
- * The following tests will check the multilanguage logic of _field_invoke() and
- * that only the correct values are returned by
- * field_multilingual_available_languages().
- */
-class FieldTranslationsTestCase extends FieldTestCase {
- public static function getInfo() {
- return array(
- 'name' => 'Field translations tests',
- 'description' => 'Test multilanguage fields logic.',
- 'group' => 'Field',
- );
- }
-
- function setUp() {
- parent::setUp('locale', 'field_test');
-
- $this->field_name = drupal_strtolower($this->randomName() . '_field_name');
-
- $this->obj_type = 'test_entity';
-
- $field = array(
- 'field_name' => $this->field_name,
- 'type' => 'test_field',
- 'cardinality' => 4,
- 'translatable' => TRUE,
- 'settings' => array(
- 'test_hook_in' => FALSE,
- ),
- );
- field_create_field($field);
- $this->field = field_read_field($this->field_name);
-
- $instance = array(
- 'field_name' => $this->field_name,
- 'object_type' => $this->obj_type,
- 'bundle' => 'test_bundle',
- 'label' => $this->randomName() . '_label',
- 'description' => $this->randomName() . '_description',
- 'weight' => mt_rand(0, 127),
- 'settings' => array(
- 'test_instance_setting' => $this->randomName(),
- ),
- 'widget' => array(
- 'type' => 'test_field_widget',
- 'label' => 'Test Field',
- 'settings' => array(
- 'test_widget_setting' => $this->randomName(),
- ),
- ),
- );
- field_create_instance($instance);
- $this->instance = field_read_instance('test_entity', $this->field_name, 'test_bundle');
-
- for ($i = 0; $i < 3; ++$i) {
- locale_inc_callback('locale_add_language', 'l' . $i, $this->randomString(), $this->randomString());
- }
- }
-
- /**
- * Ensure that only valid values are returned by field_multilingual_available_languages().
- */
- function testFieldAvailableLanguages() {
- // Test 'translatable' fieldable info.
- field_test_entity_info_translatable('test_entity', FALSE);
- $field = $this->field;
- $field['field_name'] .= '_untranslatable';
- $langcode = language_default();
- $suggested_languages = array($langcode->language);
- $available_languages = field_multilingual_available_languages($this->obj_type, $field, $suggested_languages);
- $this->assertTrue(count($available_languages) == 1 && $available_languages[0] === FIELD_LANGUAGE_NONE, t('Untranslatable entity: suggested language ignored.'));
-
- // Enable field translations for the entity.
- field_test_entity_info_translatable('test_entity', TRUE);
-
- // Test hook_field_languages() invocation on a translatable field.
- $this->field['settings']['test_hook_in'] = TRUE;
- $enabled_languages = array_keys(language_list());
- $available_languages = field_multilingual_available_languages($this->obj_type, $this->field);
- $this->assertTrue(in_array(FIELD_LANGUAGE_NONE, $available_languages), t('%language is an available language.', array('%language' => FIELD_LANGUAGE_NONE)));
- foreach ($available_languages as $delta => $langcode) {
- if ($langcode != FIELD_LANGUAGE_NONE) {
- $this->assertTrue(in_array($langcode, $enabled_languages), t('%language is an enabled language.', array('%language' => $langcode)));
- }
- }
- $this->assertFalse(in_array('xx', $available_languages), t('No invalid language was made available.'));
- $this->assertTrue(count($available_languages) == count($enabled_languages), t('An enabled language was successfully made unavailable.'));
-
- // Test field_multilingual_available_languages() behavior for untranslatable fields.
- $this->field['translatable'] = FALSE;
- $this->field_name = $this->field['field_name'] = $this->instance['field_name'] = drupal_strtolower($this->randomName() . '_field_name');
- $available_languages = field_multilingual_available_languages($this->obj_type, $this->field);
- $this->assertTrue(count($available_languages) == 1 && $available_languages[0] === FIELD_LANGUAGE_NONE, t('For untranslatable fields only neutral language is available.'));
-
- // Test language suggestions.
- $this->field['settings']['test_hook_in'] = FALSE;
- $this->field['translatable'] = TRUE;
- $this->field_name = $this->field['field_name'] = $this->instance['field_name'] = drupal_strtolower($this->randomName() . '_field_name');
- $suggested_languages = array();
- $lang_count = mt_rand(1, count($enabled_languages) - 1);
- for ($i = 0; $i < $lang_count; ++$i) {
- do {
- $langcode = $enabled_languages[mt_rand(0, $lang_count)];
- }
- while (in_array($langcode, $suggested_languages));
- $suggested_languages[] = $langcode;
- }
-
- $available_languages = field_multilingual_available_languages($this->obj_type, $this->field, $suggested_languages);
- $this->assertEqual(count($available_languages), count($suggested_languages), t('Suggested languages were successfully made available.'));
- foreach ($available_languages as $langcode) {
- $this->assertTrue(in_array($langcode, $available_languages), t('Suggested language %language is available.', array('%language' => $langcode)));
- }
-
- $this->field_name = $this->field['field_name'] = $this->instance['field_name'] = drupal_strtolower($this->randomName() . '_field_name');
- $suggested_languages = array('xx');
- $available_languages = field_multilingual_available_languages($this->obj_type, $this->field, $suggested_languages);
- $this->assertTrue(empty($available_languages), t('An invalid suggested language was not made available.'));
- }
-
- /**
- * Test the multilanguage logic of _field_invoke().
- */
- function testFieldInvoke() {
- $entity_type = 'test_entity';
- $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
-
- // Populate some extra languages to check if _field_invoke() correctly uses
- // the result of field_multilingual_available_languages().
- $values = array();
- $extra_languages = mt_rand(1, 4);
- $languages = $available_languages = field_multilingual_available_languages($this->obj_type, $this->field);
- for ($i = 0; $i < $extra_languages; ++$i) {
- $languages[] = $this->randomString(2);
- }
-
- // For each given language provide some random values.
- foreach ($languages as $langcode) {
- for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
- $values[$langcode][$delta]['value'] = mt_rand(1, 127);
- }
- }
- $entity->{$this->field_name} = $values;
-
- $results = _field_invoke('test_op', $entity_type, $entity);
- foreach ($results as $langcode => $result) {
- $hash = md5(serialize(array($entity_type, $entity, $this->field_name, $langcode, $values[$langcode])));
- // Check whether the parameters passed to _field_invoke() were correctly
- // forwarded to the callback function.
- $this->assertEqual($hash, $result, t('The result for %language is correctly stored.', array('%language' => $langcode)));
- }
- $this->assertEqual(count($results), count($available_languages), t('No unavailable language has been processed.'));
- }
-
- /**
- * Test the multilanguage logic of _field_invoke_multiple().
- */
- function testFieldInvokeMultiple() {
- $values = array();
- $entities = array();
- $entity_type = 'test_entity';
- $entity_count = mt_rand(1, 5);
- $available_languages = field_multilingual_available_languages($this->obj_type, $this->field);
-
- for ($id = 1; $id <= $entity_count; ++$id) {
- $entity = field_test_create_stub_entity($id, $id, $this->instance['bundle']);
- $languages = $available_languages;
-
- // Populate some extra languages to check whether _field_invoke()
- // correctly uses the result of field_multilingual_available_languages().
- $extra_languages = mt_rand(1, 4);
- for ($i = 0; $i < $extra_languages; ++$i) {
- $languages[] = $this->randomString(2);
- }
-
- // For each given language provide some random values.
- foreach ($languages as $langcode) {
- for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
- $values[$id][$langcode][$delta]['value'] = mt_rand(1, 127);
- }
- }
- $entity->{$this->field_name} = $values[$id];
- $entities[$id] = $entity;
- }
-
- $grouped_results = _field_invoke_multiple('test_op_multiple', $entity_type, $entities);
- foreach ($grouped_results as $id => $results) {
- foreach ($results as $langcode => $result) {
- $hash = md5(serialize(array($entity_type, $entities[$id], $this->field_name, $langcode, $values[$id][$langcode])));
- // Check whether the parameters passed to _field_invoke() were correctly
- // forwarded to the callback function.
- $this->assertEqual($hash, $result, t('The result for object %id/%language is correctly stored.', array('%id' => $id, '%language' => $langcode)));
- }
- $this->assertEqual(count($results), count($available_languages), t('No unavailable language has been processed for object %id.', array('%id' => $id)));
- }
- }
-
- /**
- * Test translatable fields storage/retrieval.
- */
- function testTranslatableFieldSaveLoad() {
- // Enable field translations for nodes.
- field_test_entity_info_translatable('node', TRUE);
- $obj_info = entity_get_info('node');
- $this->assertTrue(count($obj_info['translation']), t('Nodes are translatable.'));
-
- // Prepare the field translations.
- $eid = $evid = 1;
- $obj_type = 'test_entity';
- $object = field_test_create_stub_entity($eid, $evid, $this->instance['bundle']);
- $field_translations = array();
- $available_languages = field_multilingual_available_languages($obj_type, $this->field);
- $this->assertTrue(count($available_languages) > 1, t('Field is translatable.'));
- foreach ($available_languages as $langcode) {
- $field_translations[$langcode] = $this->_generateTestFieldValues($this->field['cardinality']);
- }
-
- // Save and reload the field translations.
- $object->{$this->field_name} = $field_translations;
- field_attach_insert($obj_type, $object);
- unset($object->{$this->field_name});
- field_attach_load($obj_type, array($eid => $object));
-
- // Check if the correct values were saved/loaded.
- foreach ($field_translations as $langcode => $items) {
- $result = TRUE;
- foreach ($items as $delta => $item) {
- $result = $result && $item['value'] == $object->{$this->field_name}[$langcode][$delta]['value'];
- }
- $this->assertTrue($result, t('%language translation correctly handled.', array('%language' => $langcode)));
- }
- }
-}
-
-/**
- * Unit test class for field bulk delete and batch purge functionality.
- */
-class FieldBulkDeleteTestCase extends FieldTestCase {
- protected $field;
-
- public static function getInfo() {
- return array(
- 'name' => 'Field bulk delete tests',
- 'description'=> 'Bulk delete fields and instances, and clean up afterwards.',
- 'group' => 'Field',
- );
- }
-
- /**
- * Convenience function for Field API tests.
- *
- * Given an array of potentially fully-populated objects and an
- * optional field name, generate an array of stub objects of the
- * same fieldable type which contains the data for the field name
- * (if given).
- *
- * @param $obj_type
- * The entity type of $objects.
- * @param $objects
- * An array of objects of type $obj_type.
- * @param $field_name
- * Optional; a field name whose data should be copied from
- * $objects into the returned stub objects.
- * @return
- * An array of stub objects corresponding to $objects.
- */
- function _generateStubObjects($obj_type, $objects, $field_name = NULL) {
- $stubs = array();
- foreach ($objects as $obj) {
- $stub = entity_create_stub_entity($obj_type, entity_extract_ids($obj_type, $obj));
- if (isset($field_name)) {
- $stub->{$field_name} = $obj->{$field_name};
- }
- $stubs[] = $stub;
- }
- return $stubs;
- }
-
- function setUp() {
- parent::setUp('field_test');
-
- // Clean up data from previous test cases.
- $this->fields = array();
- $this->instances = array();
-
- // Create two bundles.
- $this->bundles = array('bb_1' => 'bb_1', 'bb_2' => 'bb_2');
- foreach ($this->bundles as $name => $desc) {
- field_test_create_bundle($name, $desc);
- }
-
- // Create two fields.
- $field = array('field_name' => 'bf_1', 'type' => 'test_field', 'cardinality' => 1);
- $this->fields[] = field_create_field($field);
- $field = array('field_name' => 'bf_2', 'type' => 'test_field', 'cardinality' => 4);
- $this->fields[] = field_create_field($field);
-
- // For each bundle, create an instance of each field, and 10
- // objects with values for each field.
- $id = 0;
- $this->entity_type = 'test_entity';
- foreach ($this->bundles as $bundle) {
- foreach ($this->fields as $field) {
- $instance = array(
- 'field_name' => $field['field_name'],
- 'object_type' => $this->entity_type,
- 'bundle' => $bundle,
- 'widget' => array(
- 'type' => 'test_field_widget',
- )
- );
- $this->instances[] = field_create_instance($instance);
- }
-
- for ($i = 0; $i < 10; $i++) {
- $entity = field_test_create_stub_entity($id, $id, $bundle);
- foreach ($this->fields as $field) {
- $entity->{$field['field_name']}[FIELD_LANGUAGE_NONE] = $this->_generateTestFieldValues($field['cardinality']);
- }
- $this->entities[$id] = $entity;
- field_attach_insert($this->entity_type, $entity);
- $id++;
- }
- }
- }
-
- /**
- * Verify that deleting an instance leaves the field data items in
- * the database and that the appropriate Field API functions can
- * operate on the deleted data and instance.
- *
- * This tests how field_attach_query() interacts with
- * field_delete_instance() and could be moved to FieldCrudTestCase,
- * but depends on this class's setUp().
- */
- function testDeleteFieldInstance() {
- $bundle = reset($this->bundles);
- $field = reset($this->fields);
-
- // There are 10 objects of this bundle.
- $found = field_attach_query($field['id'], array(array('bundle', $bundle)), array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertEqual(count($found['test_entity']), 10, 'Correct number of objects found before deleting');
-
- // Delete the instance.
- $instance = field_info_instance($this->entity_type, $field['field_name'], $bundle);
- field_delete_instance($instance);
-
- // The instance still exists, deleted.
- $instances = field_read_instances(array('field_id' => $field['id'], 'deleted' => 1), array('include_deleted' => 1, 'include_inactive' => 1));
- $this->assertEqual(count($instances), 1, 'There is one deleted instance');
- $this->assertEqual($instances[0]['bundle'], $bundle, 'The deleted instance is for the correct bundle');
-
- // There are 0 objects of this bundle with non-deleted data.
- $found = field_attach_query($field['id'], array(array('bundle', $bundle)), array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertTrue(!isset($found['test_entity']), 'No objects found after deleting');
-
- // There are 10 objects of this bundle when deleted fields are allowed, and
- // their values are correct.
- $found = field_attach_query($field['id'], array(array('bundle', $bundle), array('deleted', 1)), array('limit' => FIELD_QUERY_NO_LIMIT));
- field_attach_load($this->entity_type, $found[$this->entity_type], FIELD_LOAD_CURRENT, array('field_id' => $field['id'], 'deleted' => 1));
- $this->assertEqual(count($found['test_entity']), 10, 'Correct number of objects found after deleting');
- foreach ($found['test_entity'] as $id => $obj) {
- $this->assertEqual($this->entities[$id]->{$field['field_name']}, $obj->{$field['field_name']}, "Object $id with deleted data loaded correctly");
- }
- }
-
- /**
- * Verify that field data items and instances are purged when an
- * instance is deleted.
- */
- function testPurgeInstance() {
- field_test_memorize();
-
- $bundle = reset($this->bundles);
- $field = reset($this->fields);
-
- // Delete the instance.
- $instance = field_info_instance($this->entity_type, $field['field_name'], $bundle);
- field_delete_instance($instance);
-
- // No field hooks were called.
- $mem = field_test_memorize();
- $this->assertEqual(count($mem), 0, 'No field hooks were called');
-
- $batch_size = 2;
- for ($count = 8; $count >= 0; $count -= 2) {
- // Purge two objects.
- field_purge_batch($batch_size);
-
- // There are $count deleted objects left.
- $found = field_attach_query($field['id'], array(array('bundle', $bundle), array('deleted', 1)), array('limit' => FIELD_QUERY_NO_LIMIT));
- $this->assertEqual($count ? count($found['test_entity']) : count($found), $count, 'Correct number of objects found after purging 2');
- }
-
- // hook_field_delete() was called on a pseudo-object for each object. Each
- // pseudo object has a $field property that matches the original object,
- // but no others.
- $mem = field_test_memorize();
- $this->assertEqual(count($mem['field_test_field_delete']), 10, 'hook_field_delete was called for the right number of objects');
- $stubs = $this->_generateStubObjects($this->entity_type, $this->entities, $field['field_name']);
- $count = count($stubs);
- foreach ($mem['field_test_field_delete'] as $args) {
- $obj = $args[1];
- $this->assertEqual($stubs[$obj->ftid], $obj, 'hook_field_delete() called with the correct stub');
- unset($stubs[$obj->ftid]);
- }
- $this->assertEqual(count($stubs), $count-10, 'hook_field_delete was called with each object once');
-
- // The instance still exists, deleted.
- $instances = field_read_instances(array('field_id' => $field['id'], 'deleted' => 1), array('include_deleted' => 1, 'include_inactive' => 1));
- $this->assertEqual(count($instances), 1, 'There is one deleted instance');
-
- // Purge the instance.
- field_purge_batch($batch_size);
-
- // The instance is gone.
- $instances = field_read_instances(array('field_id' => $field['id'], 'deleted' => 1), array('include_deleted' => 1, 'include_inactive' => 1));
- $this->assertEqual(count($instances), 0, 'The instance is gone');
-
- // The field still exists, not deleted, because it has a second instance.
- $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1, 'include_inactive' => 1));
- $this->assertTrue(isset($fields[$field['id']]), 'The field exists and is not deleted');
- }
-
- /**
- * Verify that fields are preserved and purged correctly as multiple
- * instances are deleted and purged.
- */
- function testPurgeField() {
- $field = reset($this->fields);
-
- foreach ($this->bundles as $bundle) {
- // Delete the instance.
- $instance = field_info_instance($this->entity_type, $field['field_name'], $bundle);
- field_delete_instance($instance);
-
- // Purge the data.
- field_purge_batch(10);
-
- // Purge again to purge the instance.
- field_purge_batch(0);
-
- // The field still exists, not deleted, because it was never deleted.
- $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1, 'include_inactive' => 1));
- $this->assertTrue(isset($fields[$field['id']]), 'The field exists and is not deleted');
- }
-
- // Delete the field.
- field_delete_field($field['field_name']);
-
- // The field still exists, deleted.
- $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1, 'include_inactive' => 1));
- $this->assertEqual($fields[$field['id']]['deleted'], 1, 'The field exists and is deleted');
-
- // Purge the field.
- field_purge_batch(0);
-
- // The field is gone.
- $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1, 'include_inactive' => 1));
- $this->assertEqual(count($fields), 0, 'The field is purged.');
- }
-}
Index: modules/field/modules/options/options.test
===================================================================
RCS file: /cvs/drupal/drupal/modules/field/modules/options/options.test,v
retrieving revision 1.4
diff -u -r1.4 options.test
--- modules/field/modules/options/options.test 20 Nov 2009 05:14:13 -0000 1.4
+++ modules/field/modules/options/options.test 20 Nov 2009 13:39:50 -0000
@@ -62,7 +62,7 @@
$instance = array(
'field_name' => $this->card_1['field_name'],
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'widget' => array(
'type' => 'options_buttons',
),
@@ -118,7 +118,7 @@
$instance = array(
'field_name' => $this->card_2['field_name'],
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'widget' => array(
'type' => 'options_buttons',
),
@@ -204,7 +204,7 @@
$instance = array(
'field_name' => $this->card_1['field_name'],
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'widget' => array(
'type' => 'options_select',
),
@@ -258,7 +258,7 @@
$instance = array(
'field_name' => $this->card_2['field_name'],
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'widget' => array(
'type' => 'options_select',
),
@@ -341,7 +341,7 @@
$instance = array(
'field_name' => $this->bool['field_name'],
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'widget' => array(
'type' => 'options_onoff',
),
Index: modules/simpletest/tests/field_test.install
===================================================================
RCS file: modules/simpletest/tests/field_test.install
diff -N modules/simpletest/tests/field_test.install
--- modules/simpletest/tests/field_test.install 16 Oct 2009 02:04:44 -0000 1.6
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,77 +0,0 @@
-fields(array('weight' => 1))
- ->condition('name', 'field_test')
- ->execute();
-}
-
-/**
- * Implement hook_schema().
- */
-function field_test_schema() {
- $schema['test_entity'] = array(
- 'description' => 'The base table for test_entities.',
- 'fields' => array(
- 'ftid' => array(
- 'description' => 'The primary identifier for a test_entity.',
- 'type' => 'serial',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- ),
- 'ftvid' => array(
- 'description' => 'The current {test_entity_revision}.ftvid version identifier.',
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- ),
- 'fttype' => array(
- 'description' => 'The type of this test_entity.',
- 'type' => 'varchar',
- 'length' => 32,
- 'not null' => TRUE,
- 'default' => '',
- ),
- ),
- 'unique keys' => array(
- 'ftvid' => array('ftvid'),
- ),
- 'primary key' => array('ftid'),
- );
- $schema['test_entity_revision'] = array(
- 'description' => 'Stores information about each saved version of a {test_entity}.',
- 'fields' => array(
- 'ftid' => array(
- 'description' => 'The {test_entity} this version belongs to.',
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- ),
- 'ftvid' => array(
- 'description' => 'The primary identifier for this version.',
- 'type' => 'serial',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- ),
- ),
- 'indexes' => array(
- 'nid' => array('ftid'),
- ),
- 'primary key' => array('ftvid'),
- );
-
- return $schema;
-}
Index: modules/simpletest/tests/field_test.info
===================================================================
RCS file: modules/simpletest/tests/field_test.info
diff -N modules/simpletest/tests/field_test.info
--- modules/simpletest/tests/field_test.info 8 Feb 2009 21:22:59 -0000 1.2
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,9 +0,0 @@
-;$Id: field_test.info,v 1.2 2009/02/08 21:22:59 webchick Exp $
-name = "Field API Test"
-description = "Support module for the Field API tests."
-core = 7.x
-package = Testing
-files[] = field_test.module
-files[] = field_test.install
-version = VERSION
-hidden = TRUE
Index: modules/simpletest/tests/field_test.module
===================================================================
RCS file: modules/simpletest/tests/field_test.module
diff -N modules/simpletest/tests/field_test.module
--- modules/simpletest/tests/field_test.module 20 Nov 2009 04:51:27 -0000 1.39
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,1278 +0,0 @@
- array(
- 'title' => t('Access field_test content'),
- 'description' => t('View published field_test content.'),
- ),
- 'administer field_test content' => array(
- 'title' => t('Administer field_test content'),
- 'description' => t('Manage field_test content'),
- ),
- );
- return $perms;
-}
-
-/**
- * Implement hook_menu().
- */
-function field_test_menu() {
- $items = array();
- $bundles = field_info_bundles('test_entity');
-
- foreach ($bundles as $bundle_name => $bundle_info) {
- $bundle_url_str = str_replace('_', '-', $bundle_name);
- $items['test-entity/add/' . $bundle_url_str] = array(
- 'title' => t('Add %bundle test_entity', array('%bundle' => $bundle_info['label'])),
- 'page callback' => 'field_test_entity_add',
- 'page arguments' => array(2),
- 'access arguments' => array('administer field_test content'),
- 'type' => MENU_NORMAL_ITEM,
- );
- }
- $items['test-entity/%field_test_entity_test/edit'] = array(
- 'title' => 'Edit test entity',
- 'page callback' => 'field_test_entity_edit',
- 'page arguments' => array(1),
- 'access arguments' => array('administer field_test content'),
- 'type' => MENU_NORMAL_ITEM,
- );
-
- return $items;
-}
-
-/**
- * Implements hook_field_access().
- */
-function field_test_field_access($op, $field, $obj_type, $object, $account) {
- if ($field['field_name'] == "field_no_{$op}_access") {
- return FALSE;
- }
- return TRUE;
-}
-
-/**
- *
- * 'Field attach' API.
- *
- */
-
-
-/**
- * Define a test fieldable entity.
- */
-function field_test_entity_info() {
- $bundles = variable_get('field_test_bundles', array('test_bundle' => array('label' => 'Test Bundle')));
- return array(
- 'test_entity' => array(
- 'name' => t('Test Entity'),
- 'object keys' => array(
- 'id' => 'ftid',
- 'revision' => 'ftvid',
- 'bundle' => 'fttype',
- ),
- 'cacheable' => FALSE,
- 'bundles' => $bundles,
- 'fieldable' => TRUE,
- ),
- // This entity type doesn't get form handling for now...
- 'test_cacheable_entity' => array(
- 'name' => t('Test Entity, cacheable'),
- 'object keys' => array(
- 'id' => 'ftid',
- 'revision' => 'ftvid',
- 'bundle' => 'fttype',
- ),
- 'fieldable' => TRUE,
- 'cacheable' => TRUE,
- 'bundles' => $bundles,
- ),
- );
-}
-
-/**
- * Implement hook_entity_info_alter().
- */
-function field_test_entity_info_alter(&$entity_info) {
- // Enable/disable field_test as a translation handler.
- foreach (field_test_entity_info_translatable() as $obj_type => $translatable) {
- $entity_info[$obj_type]['translation']['field_test'] = $translatable;
- }
- // Disable locale as a translation handler.
- foreach ($entity_info as $obj_type => $info) {
- $entity_info[$obj_type]['translation']['locale'] = FALSE;
- }
-}
-
-/**
- * Implement hook_field_widget_settings_form().
- */
-function field_test_field_widget_settings_form($field, $instance) {
- $widget = $instance['widget'];
- $settings = $widget['settings'];
-
- $form['test_widget_setting'] = array(
- '#type' => 'textfield',
- '#title' => t('Field test field widget setting'),
- '#default_value' => $settings['test_widget_setting'],
- '#required' => FALSE,
- '#description' => t('A dummy form element to simulate field widget setting.'),
- );
-
- return $form;
-}
-
-/**
- * Implement hook_field_instance_settings_form().
- */
-function field_test_field_instance_settings_form($field, $instance) {
- $settings = $instance['settings'];
-
- $form['test_instance_setting'] = array(
- '#type' => 'textfield',
- '#title' => t('Field test field instance setting'),
- '#default_value' => $settings['test_instance_setting'],
- '#required' => FALSE,
- '#description' => t('A dummy form element to simulate field instance setting.'),
- );
-
- return $form;
-}
-
-/**
- * Implement hook_field_settings_form().
- */
-function field_test_field_settings_form($field, $instance, $has_data) {
- $settings = $field['settings'];
-
- $form['test_field_setting'] = array(
- '#type' => 'textfield',
- '#title' => t('Field test field setting'),
- '#default_value' => $settings['test_field_setting'],
- '#required' => FALSE,
- '#description' => t('A dummy form element to simulate field setting.'),
- );
-
- return $form;
-}
-
-
-/**
- * Create a new bundle for test_entity objects.
- *
- * @param $bundle
- * The machine-readable name of the bundle.
- * @param $text
- * The human-readable name of the bundle. If none is provided, the machine
- * name will be used.
- */
-function field_test_create_bundle($bundle, $text = NULL) {
- $bundles = variable_get('field_test_bundles', array('test_bundle' => array('label' => 'Test Bundle')));
- $bundles += array($bundle => array('label' => $text ? $text : $bundle));
- variable_set('field_test_bundles', $bundles);
-
- $info = field_test_entity_info();
- foreach ($info as $type => $type_info) {
- field_attach_create_bundle($type, $bundle);
- }
-}
-
-/**
- * Rename a bundle for test_entity objects.
- *
- * @param $bundle_old
- * The machine-readable name of the bundle to rename.
- * @param $bundle_new
- * The new machine-readable name of the bundle.
- */
-function field_test_rename_bundle($bundle_old, $bundle_new) {
- $bundles = variable_get('field_test_bundles', array('test_bundle' => array('label' => 'Test Bundle')));
- $bundles[$bundle_new] = $bundles[$bundle_old];
- unset($bundles[$bundle_old]);
- variable_set('field_test_bundles', $bundles);
-
- $info = field_test_entity_info();
- foreach ($info as $type => $type_info) {
- field_attach_rename_bundle($type, $bundle_old, $bundle_new);
- }
-}
-
-/**
- * Delete a bundle for test_entity objects.
- *
- * @param $bundle
- * The machine-readable name of the bundle to delete.
- */
-function field_test_delete_bundle($bundle) {
- $bundles = variable_get('field_test_bundles', array('test_bundle' => array('label' => 'Test Bundle')));
- unset($bundles[$bundle]);
- variable_set('field_test_bundles', $bundles);
-
- $info = field_test_entity_info();
- foreach ($info as $type => $type_info) {
- field_attach_delete_bundle($type, $bundle);
- }
-}
-
-/**
- * Implement hook_field_build_modes().
- */
-function field_test_field_build_modes($obj_type) {
- $modes = array();
- if ($obj_type == 'test_entity' || $obj_type == 'test_cacheable_entity') {
- $modes = array(
- 'full' => t('Full node'),
- 'teaser' => t('Teaser'),
- );
- }
- return $modes;
-}
-
-/**
- * Helper function to create a basic 'test entity' structure.
- *
- * TODO : do we stil need this now that we can actualy load and save test_entities ?
- */
-function field_test_create_stub_entity($id = 1, $vid = 1, $bundle = FIELD_TEST_BUNDLE) {
- $entity = new stdClass();
- // Only set id and vid properties if they don't come as NULL (creation form).
- if (isset($id)) {
- $entity->ftid = $id;
- }
- if (isset($vid)) {
- $entity->ftvid = $vid;
- }
- $entity->fttype = $bundle;
-
- return $entity;
-}
-
-function field_test_entity_test_load($ftid, $ftvid = NULL) {
- // Load basic strucure.
- $query = db_select('test_entity', 'fte', array())
- ->fields('fte')
- ->condition('ftid', $ftid);
- if ($ftvid) {
- $query->condition('ftvid', $ftvid);
- }
- $entities = $query->execute()->fetchAllAssoc('ftid');
-
- // Attach fields.
- if ($ftvid) {
- field_attach_load_revision('test_entity', $entities);
- }
- else {
- field_attach_load('test_entity', $entities);
- }
-
- return $entities[$ftid];
-}
-
-function field_test_entity_save(&$entity) {
- field_attach_presave('test_entity', $entity);
-
- if (!isset($entity->is_new)) {
- $entity->is_new = empty($entity->ftid);
- }
-
- if (!$entity->is_new && !empty($entity->revision)) {
- $entity->old_ftvid = $entity->ftvid;
- unset($entity->ftvid);
- }
-
- $update_entity = TRUE;
- if ($entity->is_new) {
- drupal_write_record('test_entity', $entity);
- drupal_write_record('test_entity_revision', $entity);
- $op = 'insert';
- }
- else {
- drupal_write_record('test_entity', $entity, 'ftid');
- if (!empty($entity->revision)) {
- drupal_write_record('test_entity_revision', $entity);
- }
- else {
- drupal_write_record('test_entity_revision', $entity, 'ftvid');
- $update_entity = FALSE;
- }
- $op = 'update';
- }
- if ($update_entity) {
- db_update('test_entity')
- ->fields(array('ftvid' => $entity->ftvid))
- ->condition('ftid', $entity->ftid)
- ->execute();
- }
-
- // Save fields.
- $function = "field_attach_$op";
- $function('test_entity', $entity);
-}
-
-function field_test_entity_add($fttype) {
- $fttype = str_replace('-', '_', $fttype);
- $entity = (object)array('fttype' => $fttype);
- drupal_set_title(t('Create test_entity @bundle', array('@bundle' => $fttype)), PASS_THROUGH);
- return drupal_get_form('field_test_entity_form', $entity, TRUE);
-}
-
-function field_test_entity_edit($entity) {
- drupal_set_title(t('test_entity @ftid revision @ftvid', array('@ftid' => $entity->ftid, '@ftvid' => $entity->ftvid)), PASS_THROUGH);
- return drupal_get_form('field_test_entity_form', $entity);
-}
-
-/**
- * Form to set the value of fields attached to our entity.
- */
-function field_test_entity_form($form, &$form_state, $entity, $add = FALSE) {
- if (isset($form_state['test_entity'])) {
- $entity = $form_state['test_entity'] + (array)$entity;
- }
- $entity = (object)$entity;
-
- foreach (array('ftid', 'ftvid', 'fttype') as $key) {
- $form[$key] = array(
- '#type' => 'value',
- '#value' => isset($entity->$key) ? $entity->$key : NULL,
- );
- }
-
- // Add field widgets.
- $form['#builder_function'] = 'field_test_entity_form_submit_builder';
- field_attach_form('test_entity', $entity, $form, $form_state);
-
- if (!$add) {
- $form['revision'] = array(
- '#access' => user_access('administer field_test content'),
- '#type' => 'checkbox',
- '#title' => t('Create new revision'),
- '#default_value' => FALSE,
- '#weight' => 100,
- );
- }
- $form['submit'] = array(
- '#type' => 'submit',
- '#value' => t('Save'),
- '#weight' => 101,
- );
-
- return $form;
-}
-
-/**
- * Validate handler for field_test_set_field_values().
- */
-function field_test_entity_form_validate($form, &$form_state) {
- $entity = field_test_create_stub_entity($form_state['values']['ftid'], $form_state['values']['ftvid'], $form_state['values']['fttype']);
- field_attach_form_validate('test_entity', $entity, $form, $form_state);
-}
-
-/**
- * Submit handler for field_test_set_field_values().
- */
-function field_test_entity_form_submit($form, &$form_state) {
- $entity = field_test_entity_form_submit_builder($form, $form_state);
- $insert = empty($entity->ftid);
- field_test_entity_save($entity);
-
- $message = $insert ? t('test_entity @id has been created.', array('@id' => $entity->ftid)) : t('test_entity @id has been updated.', array('@id' => $entity->ftid));
- drupal_set_message($message);
-
- if ($entity->ftid) {
- unset($form_state['rebuild']);
- $form_state['redirect'] = 'test-entity/' . $entity->ftid . '/edit';
- }
- else {
- // Error on save.
- drupal_set_message(t('The entity could not be saved.'), 'error');
- }
-
-}
-
-/**
- * Build a test_entity by processing submitted form values and prepare for a form rebuild.
- */
-function field_test_entity_form_submit_builder($form, &$form_state) {
- $entity = field_test_create_stub_entity($form_state['values']['ftid'], $form_state['values']['ftvid'], $form_state['values']['fttype']);
- $entity->revision = !empty($form_state['values']['revision']);
- field_attach_submit('test_entity', $entity, $form, $form_state);
-
- $form_state['test_entity'] = (array)$entity;
- $form_state['rebuild'] = TRUE;
-
- return $entity;
-}
-
-/**
- *
- * 'Field type' API.
- *
- */
-
-/**
- * Implement hook_field_info().
- */
-function field_test_field_info() {
- return array(
- 'test_field' => array(
- 'label' => t('Test Field'),
- 'description' => t('Dummy field type used for tests.'),
- 'settings' => array(
- 'test_field_setting' => 'dummy test string',
- 'changeable' => 'a changeable field setting',
- 'unchangeable' => 'an unchangeable field setting',
- ),
- 'instance_settings' => array(
- 'test_instance_setting' => 'dummy test string',
- 'test_hook_field_load' => FALSE,
- ),
- 'default_widget' => 'test_field_widget',
- 'default_formatter' => 'field_test_default',
- ),
- );
-}
-
-/**
- * Implement hook_field_update_forbid().
- */
-function field_test_field_update_forbid($field, $prior_field, $has_data) {
- if ($field['type'] == 'test_field' && $field['settings']['unchangeable'] != $prior_field['settings']['unchangeable']) {
- throw new FieldException("field_test 'unchangeable' setting cannot be changed'");
- }
-}
-
-/**
- * Implement hook_field_schema().
- */
-function field_test_field_schema($field) {
- return array(
- 'columns' => array(
- 'value' => array(
- 'type' => 'int',
- 'size' => 'tiny',
- 'not null' => FALSE,
- ),
- ),
- 'indexes' => array(
- 'value' => array('value'),
- ),
- );
-}
-
-/**
- * Implement hook_field_load().
- */
-function field_test_field_load($obj_type, $objects, $field, $instances, $langcode, &$items, $age) {
- foreach ($items as $id => $item) {
- // To keep the test non-intrusive, only act for instances with the
- // test_hook_field_load setting explicitly set to TRUE.
- if ($instances[$id]['settings']['test_hook_field_load']) {
- foreach ($item as $delta => $value) {
- // Don't add anything on empty values.
- if ($value) {
- $items[$id][$delta]['additional_key'] = 'additional_value';
- }
- }
- }
- }
-}
-
-/**
- * Implement hook_field_validate().
- *
- * Possible error codes:
- * - 'field_test_invalid': The value is invalid.
- */
-function field_test_field_validate($obj_type, $object, $field, $instance, $langcode, $items, &$errors) {
- foreach ($items as $delta => $item) {
- if ($item['value'] == -1) {
- $errors[$field['field_name']][$langcode][$delta][] = array(
- 'error' => 'field_test_invalid',
- 'message' => t('%name does not accept the value -1.', array('%name' => $instance['label'])),
- );
- }
- }
-}
-
-/**
- * Implement hook_field_sanitize().
- */
-function field_test_field_sanitize($obj_type, $object, $field, $instance, $langcode, &$items) {
- foreach ($items as $delta => $item) {
- $value = check_plain($item['value']);
- $items[$delta]['safe'] = $value;
- }
-}
-
-/**
- * Implement hook_field_is_empty().
- */
-function field_test_field_is_empty($item, $field) {
- return empty($item['value']);
-}
-
-/**
- * Implement hook_field_widget_info().
- *
- * Here we indicate that the field module will handle
- * the default value and multiple values for these widgets.
- *
- * Callbacks can be omitted if default handing is used.
- * They're included here just so this module can be used
- * as an example for custom modules that might do things
- * differently.
- */
-function field_test_field_widget_info() {
- return array(
- 'test_field_widget' => array(
- 'label' => t('Test field'),
- 'field types' => array('test_field'),
- 'settings' => array('test_widget_setting' => 'dummy test string'),
- 'behaviors' => array(
- 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
- 'default value' => FIELD_BEHAVIOR_DEFAULT,
- ),
- ),
- 'test_field_widget_multiple' => array(
- 'label' => t('Test field 1'),
- 'field types' => array('test_field'),
- 'settings' => array('test_widget_setting_multiple' => 'dummy test string'),
- 'behaviors' => array(
- 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
- 'default value' => FIELD_BEHAVIOR_DEFAULT,
- ),
- ),
- );
-}
-
-/**
- * Implement hook_field_widget().
- */
-function field_test_field_widget(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
- $element = array(
- 'value' => $element + array(
- '#type' => 'textfield',
- '#default_value' => isset($items[$delta]['value']) ? $items[$delta]['value'] : '',
- ),
- );
- return $element;
-}
-
-/**
- * Implement hook_field_widget_error().
- */
-function field_test_field_widget_error($element, $error) {
- form_error($element['value'], $error['message']);
-}
-
-/**
- * Implement hook_field_formatter_info().
- */
-function field_test_field_formatter_info() {
- return array(
- 'field_test_default' => array(
- 'label' => t('Default'),
- 'description' => t('Default formatter'),
- 'field types' => array('test_field'),
- 'settings' => array(
- 'test_formatter_setting' => 'dummy test string',
- ),
- 'behaviors' => array(
- 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
- ),
- ),
- 'field_test_multiple' => array(
- 'label' => t('Multiple'),
- 'description' => t('Multiple formatter'),
- 'field types' => array('test_field'),
- 'settings' => array(
- 'test_formatter_setting_multiple' => 'dummy test string',
- ),
- 'behaviors' => array(
- 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
- ),
- ),
- 'field_test_needs_additional_data' => array(
- 'label' => t('Tests hook_field_formatter_prepare_view()'),
- 'field types' => array('test_field'),
- 'settings' => array(
- 'test_formatter_setting_additional' => 'dummy test string',
- ),
- ),
- );
-}
-
-/**
- * Implement hook_field_formatter_prepare_view().
- */
-function field_test_field_formatter_prepare_view($obj_type, $objects, $field, $instances, $langcode, &$items, $build_mode) {
- foreach ($items as $id => $item) {
- // To keep the test non-intrusive, only act on the
- // 'field_test_needs_additional_data' formatter.
- if ($instances[$id]['display'][$build_mode]['type'] == 'field_test_needs_additional_data') {
- foreach ($item as $delta => $value) {
- // Don't add anything on empty values.
- if ($value) {
- $items[$id][$delta]['additional_formatter_value'] = $value['value'] + 1;
- }
- }
- }
- }
-}
-
-/**
- * Theme function for 'field_test_default' formatter.
- */
-function theme_field_formatter_field_test_default($variables) {
- $element = $variables['element'];
-
- $value = $element['#item']['value'];
- $settings = $element['#settings'];
-
- return $settings['test_formatter_setting'] . '|' . $value;
-}
-
-/**
- * Theme function for 'field_test_multiple' formatter.
- */
-function theme_field_formatter_field_test_multiple($variables) {
- $element = $variables['element'];
-
- $settings = $element['#settings'];
-
- $items = array();
- foreach (element_children($element) as $key) {
- $items[$key] = $key .':'. $element[$key]['#item']['value'];
- }
- $output = implode('|', $items);
- return $settings['test_formatter_setting_multiple'] . '|' . $output;
-}
-
-/**
- * Theme function for 'field_test_needs_additional_data' formatter.
- */
-function theme_field_formatter_field_test_needs_additional_data($variables) {
- $element = $variables['element'];
- $value = $element['#item']['value'];
- $additional = $element['#item']['additional_formatter_value'];
- $settings = $element['#settings'];
-
- return $settings['test_formatter_setting_additional'] . '|' . $value . '|' . $additional;
-}
-
-/**
- * Sample function to test default value assignment.
- */
-function field_test_default_value($obj_type, $object, $field, $instance) {
- return array(array('value' => 99));
-}
-
-/**
- * Generic op to test _field_invoke behavior.
- */
-function field_test_field_test_op($obj_type, $object, $field, $instance, $langcode, &$items) {
- return array($langcode => md5(serialize(array($obj_type, $object, $field['field_name'], $langcode, $items))));
-}
-
-/**
- * Generic op to test _field_invoke_multiple behavior.
- */
-function field_test_field_test_op_multiple($obj_type, $objects, $field, $instances, $langcode, &$items) {
- $result = array();
- foreach ($objects as $id => $object) {
- $result[$id] = array($langcode => md5(serialize(array($obj_type, $object, $field['field_name'], $langcode, $items[$id]))));
- }
- return $result;
-}
-
-/**
- * Implement hook_field_languages().
- */
-function field_test_field_languages($obj_type, $field, &$languages) {
- if ($field['settings']['test_hook_in']) {
- // Add an unavailable language.
- $languages[] = 'xx';
- // Remove an available language.
- unset($languages[0]);
- }
-}
-
-/**
- * Helper function to enable entity translations.
- */
-function field_test_entity_info_translatable($obj_type = NULL, $translatable = NULL) {
- $stored_value = &drupal_static(__FUNCTION__, array());
- if (isset($obj_type)) {
- $stored_value[$obj_type] = $translatable;
- drupal_static_reset('entity_get_info');
- cache_clear_all('entity_info', 'cache');
- }
- return $stored_value;
-}
-
-/**
- *
- * 'Field storage' API.
- *
- */
-
-/**
- * Implement hook_field_storage_info().
- */
-function field_test_field_storage_info() {
- return array(
- 'field_test_storage' => array(
- 'label' => t('Test storage'),
- 'description' => t('Dummy test storage backend. Stores field values in the variable table.'),
- ),
- 'field_test_storage_failure' => array(
- 'label' => t('Test storage failure'),
- 'description' => t('Dummy test storage backend. Always fails to create fields.'),
- ),
- );
-}
-
-/**
- * Implement hook_field_storage_details().
- */
-function field_test_field_storage_details($field, $instance) {
- $details = array();
-
- // Add field columns.
- $columns = array();
- foreach ((array) $field['columns'] as $column_name => $attributes) {
- $columns[$column_name] = $column_name;
- }
- return array(
- 'drupal_variables' => array(
- 'field_test_storage_data[FIELD_LOAD_CURRENT]' => $columns,
- 'field_test_storage_data[FIELD_LOAD_REVISION]' => $columns,
- ),
- );
-}
-
-/**
- * Implement hook_field_storage_details_alter().
- *
- * @see FieldAttachStorageTestCase::testFieldStorageDetailsAlter()
- */
-function field_test_field_storage_details_alter(&$details, $field, $instance) {
-
- // For testing, storage details are changed only because of the field name.
- if ($field['field_name'] == 'field_test_change_my_details') {
- $columns = array();
- foreach ((array) $field['columns'] as $column_name => $attributes) {
- $columns[$column_name] = $column_name;
- }
- $details['drupal_variables'] = array(
- FIELD_LOAD_CURRENT => array(
- 'moon' => $columns,
- ),
- FIELD_LOAD_REVISION => array(
- 'mars' => $columns,
- ),
- );
- }
-}
-
-/**
- * Helper function: store or retrieve data from the 'storage backend'.
- */
-function _field_test_storage_data($data = NULL) {
- if (is_null($data)) {
- return variable_get('field_test_storage_data', array());
- }
- else {
- variable_set('field_test_storage_data', $data);
- }
-}
-
-/**
- * Implement hook_field_storage_load().
- */
-function field_test_field_storage_load($obj_type, $objects, $age, $fields, $options) {
- $data = _field_test_storage_data();
-
- $load_current = $age == FIELD_LOAD_CURRENT;
-
- foreach ($fields as $field_id => $ids) {
- $field = field_info_field_by_id($field_id);
- $field_name = $field['field_name'];
- $field_data = $data[$field['id']];
- $sub_table = $load_current ? 'current' : 'revisions';
- $delta_count = array();
- foreach ($field_data[$sub_table] as $row) {
- if ($row->type == $obj_type && (!$row->deleted || $options['deleted'])) {
- if (($load_current && in_array($row->entity_id, $ids)) || (!$load_current && in_array($row->revision_id, $ids))) {
- if (in_array($row->language, field_multilingual_available_languages($obj_type, $field))) {
- 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();
- foreach ($field['columns'] as $column => $attributes) {
- $item[$column] = $row->{$column};
- }
- $objects[$row->entity_id]->{$field_name}[$row->language][] = $item;
- $delta_count[$row->entity_id][$row->language]++;
- }
- }
- }
- }
- }
- }
-}
-
-/**
- * Implement hook_field_storage_write().
- */
-function field_test_field_storage_write($obj_type, $object, $op, $fields) {
- $data = _field_test_storage_data();
-
- list($id, $vid, $bundle) = entity_extract_ids($obj_type, $object);
-
- foreach ($fields as $field_id) {
- $field = field_info_field_by_id($field_id);
- $field_name = $field['field_name'];
- $field_data = &$data[$field_id];
-
- $all_languages = field_multilingual_available_languages($obj_type, $field);
- $field_languages = array_intersect($all_languages, array_keys((array) $object->$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 $object->$field_name.
- // Delete all languages if $object->$field_name is empty.
- $languages = !empty($object->$field_name) ? $field_languages : $all_languages;
- if ($languages) {
- foreach ($field_data['current'] as $key => $row) {
- if ($row->type == $obj_type && $row->entity_id == $id && in_array($row->language, $languages)) {
- unset($field_data['current'][$key]);
- }
- }
- if (isset($vid)) {
- foreach ($field_data['revisions'] as $key => $row) {
- if ($row->type == $obj_type && $row->revision_id == $vid) {
- unset($field_data['revisions'][$key]);
- }
- }
- }
- }
- }
-
- foreach ($field_languages as $langcode) {
- $items = (array) $object->{$field_name}[$langcode];
- $delta_count = 0;
- foreach ($items as $delta => $item) {
- $row = (object) array(
- 'field_id' => $field_id,
- 'type' => $obj_type,
- 'entity_id' => $id,
- 'revision_id' => $vid,
- 'bundle' => $bundle,
- 'delta' => $delta,
- 'deleted' => FALSE,
- 'language' => $langcode,
- );
- foreach ($field['columns'] as $column => $attributes) {
- $row->{$column} = isset($item[$column]) ? $item[$column] : NULL;
- }
-
- $field_data['current'][] = $row;
- if (isset($vid)) {
- $field_data['revisions'][] = $row;
- }
-
- if ($field['cardinality'] != FIELD_CARDINALITY_UNLIMITED && ++$delta_count == $field['cardinality']) {
- break;
- }
- }
- }
- }
-
- _field_test_storage_data($data);
-}
-
-/**
- * Implement hook_field_storage_delete().
- */
-function field_test_field_storage_delete($obj_type, $object, $fields) {
- list($id, $vid, $bundle) = entity_extract_ids($obj_type, $object);
-
- // Note: reusing field_test_storage_purge(), like field_sql_storage.module
- // does, is highly inefficient in our case...
- foreach (field_info_instances($bundle) as $instance) {
- if (isset($fields[$instance['field_id']])) {
- $field = field_info_field_by_id($instance['field_id']);
- field_test_field_storage_purge($obj_type, $object, $field, $instance);
- }
- }
-}
-
-/**
- * Implement hook_field_storage_purge().
- */
-function field_test_field_storage_purge($obj_type, $object, $field, $instance) {
- $data = _field_test_storage_data();
-
- list($id, $vid, $bundle) = entity_extract_ids($obj_type, $object);
-
- $field_data = &$data[$field['id']];
- foreach (array('current', 'revisions') as $sub_table) {
- foreach ($field_data[$sub_table] as $key => $row) {
- if ($row->type == $obj_type && $row->entity_id == $id) {
- unset($field_data[$sub_table][$key]);
- }
- }
- }
-
- _field_test_storage_data($data);
-}
-
-/**
- * Implement hook_field_storage_delete_revision().
- */
-function field_test_field_storage_delete_revision($obj_type, $object, $fields) {
- $data = _field_test_storage_data();
-
- list($id, $vid, $bundle) = entity_extract_ids($obj_type, $object);
- foreach ($fields as $field_id) {
- $field_data = &$data[$field_id];
- foreach (array('current', 'revisions') as $sub_table) {
- foreach ($field_data[$sub_table] as $key => $row) {
- if ($row->type == $obj_type && $row->entity_id == $id && $row->revision_id == $vid) {
- unset($field_data[$sub_table][$key]);
- }
- }
- }
- }
-
- _field_test_storage_data($data);
-}
-
-/**
- * Implement hook_field_storage_query().
- */
-function field_test_field_storage_query($field_id, $conditions, $count, &$cursor = NULL, $age) {
- $data = _field_test_storage_data();
-
- $load_current = $age == FIELD_LOAD_CURRENT;
-
- $field = field_info_field_by_id($field_id);
- $field_columns = array_keys($field['columns']);
-
- $field_data = $data[$field['id']];
- $sub_table = $load_current ? 'current' : 'revisions';
- // We need to sort records by object type and object id.
- usort($field_data[$sub_table], '_field_test_field_storage_query_sort_helper');
-
- // Initialize results array.
- $return = array();
- $obj_count = 0;
- $rows_count = 0;
- $rows_total = count($field_data[$sub_table]);
- $skip = $cursor;
- $skipped = 0;
-
- foreach ($field_data[$sub_table] as $row) {
- if ($count != FIELD_QUERY_NO_LIMIT && $obj_count >= $count) {
- break;
- }
-
- if ($row->field_id == $field['id']) {
- $match = TRUE;
- $condition_deleted = FALSE;
- // Add conditions.
- foreach ($conditions as $condition) {
- @list($column, $value, $operator) = $condition;
- if (empty($operator)) {
- $operator = is_array($value) ? 'IN' : '=';
- }
- switch ($operator) {
- case '=':
- $match = $match && $row->{$column} == $value;
- break;
- case '!=':
- case '<':
- case '<=':
- case '>':
- case '>=':
- eval('$match = $match && '. $row->{$column} . ' ' . $operator . ' '. $value);
- break;
- case 'IN':
- $match = $match && in_array($row->{$column}, $value);
- break;
- case 'NOT IN':
- $match = $match && !in_array($row->{$column}, $value);
- break;
- case 'BETWEEN':
- $match = $match && $row->{$column} >= $value[0] && $row->{$column} <= $value[1];
- break;
- case 'STARTS_WITH':
- case 'ENDS_WITH':
- case 'CONTAINS':
- // Not supported.
- $match = FALSE;
- break;
- }
- // Track condition on 'deleted'.
- if ($column == 'deleted') {
- $condition_deleted = TRUE;
- }
- }
-
- // Exclude deleted data unless we have a condition on it.
- if (!$condition_deleted && $row->deleted) {
- $match = FALSE;
- }
-
- if ($match) {
- if (is_null($skip) || $skipped >= $skip) {
- $cursor++;
- // If querying all revisions and the entity type has revisions, we need
- // to key the results by revision_ids.
- $entity_type = entity_get_info($row->type);
- $id = ($load_current || empty($entity_type['object keys']['revision'])) ? $row->entity_id : $row->revision_id;
-
- if (!isset($return[$row->type][$id])) {
- $return[$row->type][$id] = entity_create_stub_entity($row->type, array($row->entity_id, $row->revision_id, $row->bundle));
- $obj_count++;
- }
- }
- else {
- $skipped++;
- }
- }
- }
- $rows_count++;
-
- // The query is complete if we walked the whole array.
- if ($count != FIELD_QUERY_NO_LIMIT && $rows_count >= $rows_total) {
- $cursor = FIELD_QUERY_COMPLETE;
- }
- }
-
- return $return;
-}
-
-/**
- * Sort helper for field_test_field_storage_query().
- *
- * Sort by object type and object id.
- */
-function _field_test_field_storage_query_sort_helper($a, $b) {
- if ($a->type == $b->type) {
- if ($a->entity_id == $b->entity_id) {
- return 0;
- }
- else {
- return $a->entity_id < $b->entity_id ? -1 : 1;
- }
- }
- else {
- return $a->type < $b->type ? -1 : 1;
- }
-}
-
-/**
- * Implement hook_field_storage_create_field().
- */
-function field_test_field_storage_create_field($field) {
- if ($field['storage']['type'] == 'field_test_storage_failure') {
- throw new Exception('field_test_storage_failure engine always fails to create fields');
- }
-
- $data = _field_test_storage_data();
-
- $data[$field['id']] = array(
- 'current' => array(),
- 'revisions' => array(),
- );
-
- _field_test_storage_data($data);
-}
-
-/**
- * Implement hook_field_storage_delete_field().
- */
-function field_test_field_storage_delete_field($field) {
- $data = _field_test_storage_data();
-
- $field_data = &$data[$field['id']];
- foreach (array('current', 'revisions') as $sub_table) {
- foreach ($field_data[$sub_table] as &$row) {
- $row->deleted = TRUE;
- }
- }
-
- _field_test_storage_data($data);
-}
-
-/**
- * Implement hook_field_storage_delete_instance().
- */
-function field_test_field_storage_delete_instance($instance) {
- $data = _field_test_storage_data();
-
- $field = field_info_field($instance['field_name']);
- $field_data = &$data[$field['id']];
- foreach (array('current', 'revisions') as $sub_table) {
- foreach ($field_data[$sub_table] as &$row) {
- if ($row->bundle == $instance['bundle']) {
- $row->deleted = TRUE;
- }
- }
- }
-
- _field_test_storage_data($data);
-}
-
-/**
- * Implement hook_field_attach_create_bundle().
- */
-function field_test_field_attach_create_bundle($bundle) {
- // We don't need to do anything here.
-}
-
-/**
- * Implement hook_field_attach_rename_bundle().
- */
-function field_test_field_attach_rename_bundle($bundle_old, $bundle_new) {
- $data = _field_test_storage_data();
-
- // We need to account for deleted or inactive fields and instances.
- $instances = field_read_instances(array('bundle' => $bundle_new), array('include_deleted' => TRUE, 'include_inactive' => TRUE));
- foreach ($instances as $field_name => $instance) {
- $field = field_info_field_by_id($instance['field_id']);
- if ($field['storage']['type'] == 'field_test_storage') {
- $field_data = &$data[$field['id']];
- foreach (array('current', 'revisions') as $sub_table) {
- foreach ($field_data[$sub_table] as &$row) {
- if ($row->bundle == $bundle_old) {
- $row->bundle = $bundle_new;
- }
- }
- }
- }
- }
-
- _field_test_storage_data($data);
-}
-
-/**
- * Implement hook_field_attach_delete_bundle().
- */
-function field_test_field_attach_delete_bundle($bundle, $instances) {
- $data = _field_test_storage_data();
-
- $instances = field_info_instances($bundle);
- foreach ($instances as $field_name => $instance) {
- $field = field_info_field($field_name);
- if ($field['storage']['type'] == 'field_test_storage') {
- $field_data = &$data[$field['id']];
- foreach (array('current', 'revisions') as $sub_table) {
- foreach ($field_data[$sub_table] as &$row) {
- if ($row->bundle == $bundle_old) {
- $row->deleted = TRUE;
- }
- }
- }
- }
- }
-
- _field_test_storage_data($data);
-}
-
-/**
- * Store and retrieve keyed data for later verification by unit tests.
- *
- * This function is a simple in-memory key-value store with the
- * distinction that it stores all values for a given key instead of
- * just the most recently set value. field_test module hooks call
- * this function to record their arguments, keyed by hook name. The
- * unit tests later call this function to verify that the correct
- * hooks were called and were passed the correct arguments.
- *
- * This function ignores all calls until the first time it is called
- * with $key of NULL. Each time it is called with $key of NULL, it
- * erases all previously stored data from its internal cache, but also
- * returns the previously stored data to the caller. A typical usage
- * scenario is:
- *
- * @code
- * // calls to field_test_memorize() here are ignored
- *
- * // turn on memorization
- * field_test_memorize();
- *
- * // call some Field API functions that invoke field_test hooks
- * $field = field_create_field(...);
- *
- * // retrieve and reset the memorized hook call data
- * $mem = field_test_memorize();
- *
- * // make sure hook_field_create_field() is invoked correctly
- * assertEqual(count($mem['field_test_field_create_field']), 1);
- * assertEqual($mem['field_test_field_create_field'][0], array($field));
- * @endcode
- *
- * @param $key
- * The key under which to store to $value, or NULL as described above.
- * @param $value
- * A value to store for $key.
- * @return
- * An array mapping each $key to an array of each $value passed in
- * for that key.
- */
-function field_test_memorize($key = NULL, $value = NULL) {
- $memorize = &drupal_static(__FUNCTION__, NULL);
-
- if (is_null($key)) {
- $return = $memorize;
- $memorize = array();
- return $return;
- }
- if (is_array($memorize)) {
- $memorize[$key][] = $value;
- }
-}
-
-/**
- * Memorize calls to hook_field_create_field().
- */
-function field_test_field_create_field($field) {
- $args = func_get_args();
- field_test_memorize(__FUNCTION__, $args);
-}
-
-/**
- * Memorize calls to hook_field_insert().
- */
-function field_test_field_insert($obj_type, $object, $field, $instance, $items) {
- $args = func_get_args();
- field_test_memorize(__FUNCTION__, $args);
-}
-
-/**
- * Memorize calls to hook_field_update().
- */
-function field_test_field_update($obj_type, $object, $field, $instance, $items) {
- $args = func_get_args();
- field_test_memorize(__FUNCTION__, $args);
-}
-
-/**
- * Memorize calls to hook_field_delete().
- */
-function field_test_field_delete($obj_type, $object, $field, $instance, $items) {
- $args = func_get_args();
- field_test_memorize(__FUNCTION__, $args);
-}
Index: modules/field/modules/list/list.test
===================================================================
RCS file: /cvs/drupal/drupal/modules/field/modules/list/list.test,v
retrieving revision 1.2
diff -u -r1.2 list.test
--- modules/field/modules/list/list.test 20 Nov 2009 05:14:13 -0000 1.2
+++ modules/field/modules/list/list.test 20 Nov 2009 13:39:50 -0000
@@ -26,7 +26,7 @@
$this->instance_1 = array(
'field_name' => $this->card_1['field_name'],
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'widget' => array(
'type' => 'options_buttons',
),
@@ -40,7 +40,7 @@
*/
function testUpdateAllowedValues() {
// All three options appear.
- $entity = field_test_create_stub_entity(0, 0, FIELD_TEST_BUNDLE);
+ $entity = field_test_create_stub_entity();
$form = drupal_get_form('field_test_entity_form', $entity);
$this->assertTrue(!empty($form['card_1'][FIELD_LANGUAGE_NONE][1]), t('Option 1 exists'));
$this->assertTrue(!empty($form['card_1'][FIELD_LANGUAGE_NONE][2]), t('Option 2 exists'));
@@ -49,7 +49,7 @@
// Removed options do not appear.
$this->card_1['settings']['allowed_values'] = "2|Two";
field_update_field($this->card_1);
- $entity = field_test_create_stub_entity(0, 0, FIELD_TEST_BUNDLE);
+ $entity = field_test_create_stub_entity();
$form = drupal_get_form('field_test_entity_form', $entity);
$this->assertTrue(empty($form['card_1'][FIELD_LANGUAGE_NONE][1]), t('Option 1 does not exist'));
$this->assertTrue(!empty($form['card_1'][FIELD_LANGUAGE_NONE][2]), t('Option 2 exists'));
@@ -73,13 +73,13 @@
$this->instance_1 = array(
'field_name' => $this->card_1['field_name'],
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'widget' => array(
'type' => 'options_buttons',
),
);
$this->instance_1 = field_create_instance($this->instance_1);
- $entity = field_test_create_stub_entity(0, 0, FIELD_TEST_BUNDLE);
+ $entity = field_test_create_stub_entity();
$form = drupal_get_form('field_test_entity_form', $entity);
$this->assertTrue(!empty($form['card_1'][FIELD_LANGUAGE_NONE][1]), t('Option 1 exists'));
$this->assertTrue(!empty($form['card_1'][FIELD_LANGUAGE_NONE][2]), t('Option 2 exists'));
Index: modules/field/modules/text/text.test
===================================================================
RCS file: /cvs/drupal/drupal/modules/field/modules/text/text.test,v
retrieving revision 1.14
diff -u -r1.14 text.test
--- modules/field/modules/text/text.test 16 Oct 2009 03:47:14 -0000 1.14
+++ modules/field/modules/text/text.test 20 Nov 2009 13:39:50 -0000
@@ -41,7 +41,7 @@
$this->instance = array(
'field_name' => $this->field['field_name'],
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'widget' => array(
'type' => 'text_textfield',
),
@@ -53,7 +53,7 @@
);
field_create_instance($this->instance);
// Test valid and invalid values with field_attach_validate().
- $entity = field_test_create_stub_entity(0, 0, FIELD_TEST_BUNDLE);
+ $entity = field_test_create_stub_entity();
$langcode = FIELD_LANGUAGE_NONE;
for ($i = 0; $i <= $max_length + 2; $i++) {
$entity->{$this->field['field_name']}[$langcode][0]['value'] = str_repeat('x', $i);
@@ -87,7 +87,7 @@
$this->instance = array(
'field_name' => $this->field_name,
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'label' => $this->randomName() . '_label',
'settings' => array(
'text_processing' => TRUE,
@@ -141,7 +141,7 @@
$this->instance = array(
'field_name' => $this->field_name,
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'label' => $this->randomName() . '_label',
'settings' => array(
'text_processing' => TRUE,
Index: modules/taxonomy/taxonomy.test
===================================================================
RCS file: /cvs/drupal/drupal/modules/taxonomy/taxonomy.test,v
retrieving revision 1.60
diff -u -r1.60 taxonomy.test
--- modules/taxonomy/taxonomy.test 20 Nov 2009 05:14:13 -0000 1.60
+++ modules/taxonomy/taxonomy.test 20 Nov 2009 13:39:51 -0000
@@ -738,7 +738,7 @@
$this->instance = array(
'field_name' => $this->field_name,
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'widget' => array(
'type' => 'options_select',
),
@@ -752,7 +752,7 @@
// Test valid and invalid values with field_attach_validate().
$langcode = FIELD_LANGUAGE_NONE;
- $entity = field_test_create_stub_entity(0, 0, FIELD_TEST_BUNDLE);
+ $entity = field_test_create_stub_entity();
$term = $this->createTerm($this->vocabulary);
$entity->{$this->field_name}[$langcode][0]['value'] = $term->tid;
field_attach_validate('test_entity', $entity);
@@ -763,7 +763,7 @@
$this->assertTrue($entity->{$this->field_name}[$langcode][0]['value'] != $term->tid, t('Term from wrong vocabulary does not cause validation error'));
}
- $entity = field_test_create_stub_entity(0, 0, FIELD_TEST_BUNDLE);
+ $entity = field_test_create_stub_entity();
$bad_term = $this->createTerm($this->createVocabulary());
$entity->{$this->field_name}[$langcode][0]['value'] = $bad_term->tid;
try {
@@ -797,7 +797,7 @@
$this->instance = array(
'field_name' => $this->field_name,
'object_type' => 'test_entity',
- 'bundle' => FIELD_TEST_BUNDLE,
+ 'bundle' => 'test_bundle',
'label' => $this->randomName() . '_label',
'widget' => array(
'type' => 'options_select',
Index: modules/field/modules/field_sql_storage/field_sql_storage.test
===================================================================
RCS file: /cvs/drupal/drupal/modules/field/modules/field_sql_storage/field_sql_storage.test,v
retrieving revision 1.13
diff -u -r1.13 field_sql_storage.test
--- modules/field/modules/field_sql_storage/field_sql_storage.test 10 Nov 2009 17:27:53 -0000 1.13
+++ modules/field/modules/field_sql_storage/field_sql_storage.test 20 Nov 2009 13:39:50 -0000
@@ -303,7 +303,7 @@
// Create a decimal 5.2 field and add some data.
$field = array('field_name' => 'decimal52', 'type' => 'number_decimal', 'settings' => array('precision' => 5, 'scale' => 2));
$field = field_create_field($field);
- $instance = array('field_name' => 'decimal52', 'object_type' => 'test_entity', 'bundle' => FIELD_TEST_BUNDLE);
+ $instance = array('field_name' => 'decimal52', 'object_type' => 'test_entity', 'bundle' => 'test_bundle');
$instance = field_create_instance($instance);
$entity = field_test_create_stub_entity(0, 0, $instance['bundle']);
$entity->decimal52[FIELD_LANGUAGE_NONE][0]['value'] = '1.235';
@@ -331,7 +331,7 @@
$field_name = 'testfield';
$field = array('field_name' => $field_name, 'type' => 'text');
$field = field_create_field($field);
- $instance = array('field_name' => $field_name, 'object_type' => 'test_entity', 'bundle' => FIELD_TEST_BUNDLE);
+ $instance = array('field_name' => $field_name, 'object_type' => 'test_entity', 'bundle' => 'test_bundle');
$instance = field_create_instance($instance);
$tables = array(_field_sql_storage_tablename($field), _field_sql_storage_revision_tablename($field));
Index: modules/field/tests/field_test.install
===================================================================
RCS file: modules/field/tests/field_test.install
diff -N modules/field/tests/field_test.install
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ modules/field/tests/field_test.install 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,77 @@
+fields(array('weight' => 1))
+ ->condition('name', 'field_test')
+ ->execute();
+}
+
+/**
+ * Implement hook_schema().
+ */
+function field_test_schema() {
+ $schema['test_entity'] = array(
+ 'description' => 'The base table for test_entities.',
+ 'fields' => array(
+ 'ftid' => array(
+ 'description' => 'The primary identifier for a test_entity.',
+ 'type' => 'serial',
+ 'unsigned' => TRUE,
+ 'not null' => TRUE,
+ ),
+ 'ftvid' => array(
+ 'description' => 'The current {test_entity_revision}.ftvid version identifier.',
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'fttype' => array(
+ 'description' => 'The type of this test_entity.',
+ 'type' => 'varchar',
+ 'length' => 32,
+ 'not null' => TRUE,
+ 'default' => '',
+ ),
+ ),
+ 'unique keys' => array(
+ 'ftvid' => array('ftvid'),
+ ),
+ 'primary key' => array('ftid'),
+ );
+ $schema['test_entity_revision'] = array(
+ 'description' => 'Stores information about each saved version of a {test_entity}.',
+ 'fields' => array(
+ 'ftid' => array(
+ 'description' => 'The {test_entity} this version belongs to.',
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'ftvid' => array(
+ 'description' => 'The primary identifier for this version.',
+ 'type' => 'serial',
+ 'unsigned' => TRUE,
+ 'not null' => TRUE,
+ ),
+ ),
+ 'indexes' => array(
+ 'nid' => array('ftid'),
+ ),
+ 'primary key' => array('ftvid'),
+ );
+
+ return $schema;
+}
Index: modules/field/tests/field_test.module
===================================================================
RCS file: modules/field/tests/field_test.module
diff -N modules/field/tests/field_test.module
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ modules/field/tests/field_test.module 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,198 @@
+ array(
+ 'title' => t('Access field_test content'),
+ 'description' => t('View published field_test content.'),
+ ),
+ 'administer field_test content' => array(
+ 'title' => t('Administer field_test content'),
+ 'description' => t('Manage field_test content'),
+ ),
+ );
+ return $perms;
+}
+
+/**
+ * Implements hook_menu().
+ */
+function field_test_menu() {
+ $items = array();
+ $bundles = field_info_bundles('test_entity');
+
+ foreach ($bundles as $bundle_name => $bundle_info) {
+ $bundle_url_str = str_replace('_', '-', $bundle_name);
+ $items['test-entity/add/' . $bundle_url_str] = array(
+ 'title' => t('Add %bundle test_entity', array('%bundle' => $bundle_info['label'])),
+ 'page callback' => 'field_test_entity_add',
+ 'page arguments' => array(2),
+ 'access arguments' => array('administer field_test content'),
+ 'type' => MENU_NORMAL_ITEM,
+ );
+ }
+ $items['test-entity/%field_test_entity_test/edit'] = array(
+ 'title' => 'Edit test entity',
+ 'page callback' => 'field_test_entity_edit',
+ 'page arguments' => array(1),
+ 'access arguments' => array('administer field_test content'),
+ 'type' => MENU_NORMAL_ITEM,
+ );
+
+ return $items;
+}
+
+/**
+ * Generic op to test _field_invoke behavior.
+ *
+ * This simulates a field operation callback to be invoked by _field_invoke().
+ */
+function field_test_field_test_op($obj_type, $object, $field, $instance, $langcode, &$items) {
+ return array($langcode => md5(serialize(array($obj_type, $object, $field['field_name'], $langcode, $items))));
+}
+
+/**
+ * Generic op to test _field_invoke_multiple behavior.
+ *
+ * This simulates a multiple field operation callback to be invoked by
+ * _field_invoke_multiple().
+ */
+function field_test_field_test_op_multiple($obj_type, $objects, $field, $instances, $langcode, &$items) {
+ $result = array();
+ foreach ($objects as $id => $object) {
+ $result[$id] = array($langcode => md5(serialize(array($obj_type, $object, $field['field_name'], $langcode, $items[$id]))));
+ }
+ return $result;
+}
+
+/**
+ * Implement hook_field_languages().
+ */
+function field_test_field_languages($obj_type, $field, &$languages) {
+ if ($field['settings']['test_hook_in']) {
+ // Add an unavailable language.
+ $languages[] = 'xx';
+ // Remove an available language.
+ unset($languages[0]);
+ }
+}
+
+/**
+ * Helper function to enable entity translations.
+ */
+function field_test_entity_info_translatable($obj_type = NULL, $translatable = NULL) {
+ $stored_value = &drupal_static(__FUNCTION__, array());
+ if (isset($obj_type)) {
+ $stored_value[$obj_type] = $translatable;
+ drupal_static_reset('entity_get_info');
+ cache_clear_all('entity_info', 'cache');
+ }
+ return $stored_value;
+}
+
+/**
+ * Store and retrieve keyed data for later verification by unit tests.
+ *
+ * This function is a simple in-memory key-value store with the
+ * distinction that it stores all values for a given key instead of
+ * just the most recently set value. field_test module hooks call
+ * this function to record their arguments, keyed by hook name. The
+ * unit tests later call this function to verify that the correct
+ * hooks were called and were passed the correct arguments.
+ *
+ * This function ignores all calls until the first time it is called
+ * with $key of NULL. Each time it is called with $key of NULL, it
+ * erases all previously stored data from its internal cache, but also
+ * returns the previously stored data to the caller. A typical usage
+ * scenario is:
+ *
+ * @code
+ * // calls to field_test_memorize() here are ignored
+ *
+ * // turn on memorization
+ * field_test_memorize();
+ *
+ * // call some Field API functions that invoke field_test hooks
+ * $field = field_create_field(...);
+ *
+ * // retrieve and reset the memorized hook call data
+ * $mem = field_test_memorize();
+ *
+ * // make sure hook_field_create_field() is invoked correctly
+ * assertEqual(count($mem['field_test_field_create_field']), 1);
+ * assertEqual($mem['field_test_field_create_field'][0], array($field));
+ * @endcode
+ *
+ * @param $key
+ * The key under which to store to $value, or NULL as described above.
+ * @param $value
+ * A value to store for $key.
+ * @return
+ * An array mapping each $key to an array of each $value passed in
+ * for that key.
+ */
+function field_test_memorize($key = NULL, $value = NULL) {
+ $memorize = &drupal_static(__FUNCTION__, NULL);
+
+ if (is_null($key)) {
+ $return = $memorize;
+ $memorize = array();
+ return $return;
+ }
+ if (is_array($memorize)) {
+ $memorize[$key][] = $value;
+ }
+}
+
+/**
+ * Memorize calls to hook_field_create_field().
+ */
+function field_test_field_create_field($field) {
+ $args = func_get_args();
+ field_test_memorize(__FUNCTION__, $args);
+}
+
+/**
+ * Memorize calls to hook_field_insert().
+ */
+function field_test_field_insert($obj_type, $object, $field, $instance, $items) {
+ $args = func_get_args();
+ field_test_memorize(__FUNCTION__, $args);
+}
+
+/**
+ * Memorize calls to hook_field_update().
+ */
+function field_test_field_update($obj_type, $object, $field, $instance, $items) {
+ $args = func_get_args();
+ field_test_memorize(__FUNCTION__, $args);
+}
+
+/**
+ * Memorize calls to hook_field_delete().
+ */
+function field_test_field_delete($obj_type, $object, $field, $instance, $items) {
+ $args = func_get_args();
+ field_test_memorize(__FUNCTION__, $args);
+}
Index: modules/field/tests/field_test.info
===================================================================
RCS file: modules/field/tests/field_test.info
diff -N modules/field/tests/field_test.info
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ modules/field/tests/field_test.info 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,12 @@
+;$Id: field_test.info,v 1.2 2009/02/08 21:22:59 webchick Exp $
+name = "Field API Test"
+description = "Support module for the Field API tests."
+core = 7.x
+package = Testing
+files[] = field_test.module
+files[] = field_test.entity.inc
+files[] = field_test.field.inc
+files[] = field_test.storage.inc
+files[] = field_test.install
+version = VERSION
+hidden = TRUE
Index: modules/field/tests/field.test
===================================================================
RCS file: modules/field/tests/field.test
diff -N modules/field/tests/field.test
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ modules/field/tests/field.test 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,2783 @@
+default_storage);
+ }
+
+ /**
+ * Generate random values for a field_test field.
+ *
+ * @param $cardinality
+ * Number of values to generate.
+ * @return
+ * An array of random values, in the format expected for field values.
+ */
+ function _generateTestFieldValues($cardinality) {
+ $values = array();
+ for ($i = 0; $i < $cardinality; $i++) {
+ // field_test fields treat 0 as 'empty value'.
+ $values[$i]['value'] = mt_rand(1, 127);
+ }
+ return $values;
+ }
+}
+
+class FieldAttachTestCase extends FieldTestCase {
+ function setUp() {
+ parent::setUp('field_test');
+
+ $this->field_name = drupal_strtolower($this->randomName() . '_field_name');
+ $this->field = array('field_name' => $this->field_name, 'type' => 'test_field', 'cardinality' => 4);
+ $this->field = field_create_field($this->field);
+ $this->field_id = $this->field['id'];
+ $this->instance = array(
+ 'field_name' => $this->field_name,
+ 'object_type' => 'test_entity',
+ 'bundle' => 'test_bundle',
+ 'label' => $this->randomName() . '_label',
+ 'description' => $this->randomName() . '_description',
+ 'weight' => mt_rand(0, 127),
+ 'settings' => array(
+ 'test_instance_setting' => $this->randomName(),
+ ),
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ 'label' => 'Test Field',
+ 'settings' => array(
+ 'test_widget_setting' => $this->randomName(),
+ )
+ )
+ );
+ field_create_instance($this->instance);
+ }
+}
+
+/**
+ * Unit test class for storage-related field_attach_* functions.
+ *
+ * All field_attach_* test work with all field_storage plugins and
+ * all hook_field_attach_pre_{load,insert,update}() hooks.
+ */
+class FieldAttachStorageTestCase extends FieldAttachTestCase {
+ public static function getInfo() {
+ return array(
+ 'name' => 'Field attach tests (storage-related)',
+ 'description' => 'Test storage-related Field Attach API functions.',
+ 'group' => 'Field',
+ );
+ }
+
+ /**
+ * Check field values insert, update and load.
+ *
+ * Works independently of the underlying field storage backend. Inserts or
+ * updates random field data and then loads and verifies the data.
+ */
+ function testFieldAttachSaveLoad() {
+ // Configure the instance so that we test hook_field_load() (see
+ // field_test_field_load() in field_test.module).
+ $this->instance['settings']['test_hook_field_load'] = TRUE;
+ field_update_instance($this->instance);
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ $entity_type = 'test_entity';
+ $values = array();
+
+ // TODO : test empty values filtering and "compression" (store consecutive deltas).
+
+ // Preparation: create three revisions and store them in $revision array.
+ for ($revision_id = 0; $revision_id < 3; $revision_id++) {
+ $revision[$revision_id] = field_test_create_stub_entity(0, $revision_id, $this->instance['bundle']);
+ // Note: we try to insert one extra value.
+ $values[$revision_id] = $this->_generateTestFieldValues($this->field['cardinality'] + 1);
+ $current_revision = $revision_id;
+ // If this is the first revision do an insert.
+ if (!$revision_id) {
+ $revision[$revision_id]->{$this->field_name}[$langcode] = $values[$revision_id];
+ field_attach_insert($entity_type, $revision[$revision_id]);
+ }
+ else {
+ // Otherwise do an update.
+ $revision[$revision_id]->{$this->field_name}[$langcode] = $values[$revision_id];
+ field_attach_update($entity_type, $revision[$revision_id]);
+ }
+ }
+
+ // Confirm current revision loads the correct data.
+ $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+ field_attach_load($entity_type, array(0 => $entity));
+ // Number of values per field loaded equals the field cardinality.
+ $this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], t('Current revision: expected number of values'));
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ // The field value loaded matches the one inserted or updated.
+ $this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['value'] , $values[$current_revision][$delta]['value'], t('Current revision: expected value %delta was found.', array('%delta' => $delta)));
+ // The value added in hook_field_load() is found.
+ $this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['additional_key'], 'additional_value', t('Current revision: extra information for value %delta was found', array('%delta' => $delta)));
+ }
+
+ // Confirm each revision loads the correct data.
+ foreach (array_keys($revision) as $revision_id) {
+ $entity = field_test_create_stub_entity(0, $revision_id, $this->instance['bundle']);
+ field_attach_load_revision($entity_type, array(0 => $entity));
+ // Number of values per field loaded equals the field cardinality.
+ $this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], t('Revision %revision_id: expected number of values.', array('%revision_id' => $revision_id)));
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ // The field value loaded matches the one inserted or updated.
+ $this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['value'], $values[$revision_id][$delta]['value'], t('Revision %revision_id: expected value %delta was found.', array('%revision_id' => $revision_id, '%delta' => $delta)));
+ // The value added in hook_field_load() is found.
+ $this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['additional_key'], 'additional_value', t('Revision %revision_id: extra information for value %delta was found', array('%revision_id' => $revision_id, '%delta' => $delta)));
+ }
+ }
+ }
+
+ /**
+ * Test the 'multiple' load feature.
+ */
+ function testFieldAttachLoadMultiple() {
+ $entity_type = 'test_entity';
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Define 2 bundles.
+ $bundles = array(
+ 1 => 'test_bundle_1',
+ 2 => 'test_bundle_2',
+ );
+ field_test_create_bundle($bundles[1]);
+ field_test_create_bundle($bundles[2]);
+ // Define 3 fields:
+ // - field_1 is in bundle_1 and bundle_2,
+ // - field_2 is in bundle_1,
+ // - field_3 is in bundle_2.
+ $field_bundles_map = array(
+ 1 => array(1, 2),
+ 2 => array(1),
+ 3 => array(2),
+ );
+ for ($i = 1; $i <= 3; $i++) {
+ $field_names[$i] = 'field_' . $i;
+ $field = array('field_name' => $field_names[$i], 'type' => 'test_field');
+ $field = field_create_field($field);
+ $field_ids[$i] = $field['id'];
+ foreach ($field_bundles_map[$i] as $bundle) {
+ $instance = array(
+ 'field_name' => $field_names[$i],
+ 'object_type' => 'test_entity',
+ 'bundle' => $bundles[$bundle],
+ 'settings' => array(
+ // Configure the instance so that we test hook_field_load()
+ // (see field_test_field_load() in field_test.module).
+ 'test_hook_field_load' => TRUE,
+ ),
+ );
+ field_create_instance($instance);
+ }
+ }
+
+ // Create one test entity per bundle, with random values.
+ foreach ($bundles as $index => $bundle) {
+ $entities[$index] = field_test_create_stub_entity($index, $index, $bundle);
+ $entity = clone($entities[$index]);
+ $instances = field_info_instances('test_entity', $bundle);
+ foreach ($instances as $field_name => $instance) {
+ $values[$index][$field_name] = mt_rand(1, 127);
+ $entity->$field_name = array($langcode => array(array('value' => $values[$index][$field_name])));
+ }
+ field_attach_insert($entity_type, $entity);
+ }
+
+ // Check that a single load correctly loads field values for both entities.
+ field_attach_load($entity_type, $entities);
+ foreach ($entities as $index => $entity) {
+ $instances = field_info_instances($entity_type, $bundles[$index]);
+ foreach ($instances as $field_name => $instance) {
+ // The field value loaded matches the one inserted.
+ $this->assertEqual($entity->{$field_name}[$langcode][0]['value'], $values[$index][$field_name], t('Entity %index: expected value was found.', array('%index' => $index)));
+ // The value added in hook_field_load() is found.
+ $this->assertEqual($entity->{$field_name}[$langcode][0]['additional_key'], 'additional_value', t('Entity %index: extra information was found', array('%index' => $index)));
+ }
+ }
+
+ // Check that the single-field load option works.
+ $entity = field_test_create_stub_entity(1, 1, $bundles[1]);
+ field_attach_load($entity_type, array(1 => $entity), FIELD_LOAD_CURRENT, array('field_id' => $field_ids[1]));
+ $this->assertEqual($entity->{$field_names[1]}[$langcode][0]['value'], $values[1][$field_names[1]], t('Entity %index: expected value was found.', array('%index' => 1)));
+ $this->assertEqual($entity->{$field_names[1]}[$langcode][0]['additional_key'], 'additional_value', t('Entity %index: extra information was found', array('%index' => 1)));
+ $this->assert(!isset($entity->{$field_names[2]}), t('Entity %index: field %field_name is not loaded.', array('%index' => 2, '%field_name' => $field_names[2])));
+ $this->assert(!isset($entity->{$field_names[3]}), t('Entity %index: field %field_name is not loaded.', array('%index' => 3, '%field_name' => $field_names[3])));
+ }
+
+ /**
+ * Test saving and loading fields using different storage backends.
+ */
+ function testFieldAttachSaveLoadDifferentStorage() {
+ $entity_type = 'test_entity';
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Create two fields using different storage backends, and their instances.
+ $fields = array(
+ array(
+ 'field_name' => 'field_1',
+ 'type' => 'test_field',
+ 'cardinality' => 4,
+ 'storage' => array('type' => 'field_sql_storage')
+ ),
+ array(
+ 'field_name' => 'field_2',
+ 'type' => 'test_field',
+ 'cardinality' => 4,
+ 'storage' => array('type' => 'field_test_storage')
+ ),
+ );
+ foreach ($fields as $field) {
+ field_create_field($field);
+ $instance = array(
+ 'field_name' => $field['field_name'],
+ 'object_type' => 'test_entity',
+ 'bundle' => 'test_bundle',
+ );
+ field_create_instance($instance);
+ }
+
+ $entity_init = field_test_create_stub_entity();
+
+ // Create entity and insert random values.
+ $entity = clone($entity_init);
+ $values = array();
+ foreach ($fields as $field) {
+ $values[$field['field_name']] = $this->_generateTestFieldValues($this->field['cardinality']);
+ $entity->{$field['field_name']}[$langcode] = $values[$field['field_name']];
+ }
+ field_attach_insert($entity_type, $entity);
+
+ // Check that values are loaded as expected.
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ foreach ($fields as $field) {
+ $this->assertEqual($values[$field['field_name']], $entity->{$field['field_name']}[$langcode], t('%storage storage: expected values were found.', array('%storage' => $field['storage']['type'])));
+ }
+ }
+
+ /**
+ * Test storage details alteration.
+ *
+ * @see field_test_storage_details_alter()
+ */
+ function testFieldStorageDetailsAlter() {
+ $field_name = 'field_test_change_my_details';
+ $field = array(
+ 'field_name' => $field_name,
+ 'type' => 'test_field',
+ 'cardinality' => 4,
+ 'storage' => array('type' => 'field_test_storage'),
+ );
+ $field = field_create_field($field);
+ $instance = array(
+ 'field_name' => $field_name,
+ 'object_type' => 'test_entity',
+ 'bundle' => 'test_bundle',
+ );
+ field_create_instance($instance);
+
+ $field = field_info_field($instance['field_name']);
+ $instance = field_info_instance($instance['object_type'], $instance['field_name'], $instance['bundle']);
+
+ // The storage details are indexed by a storage engine type.
+ $this->assertTrue(array_key_exists('drupal_variables', $instance['storage_details']), t('The storage type is Drupal variables.'));
+
+ $details = $instance['storage_details']['drupal_variables'];
+
+ // The field_test storage details are indexed by variable name. The details
+ // are altered, so moon and mars are correct for this test.
+ $this->assertTrue(array_key_exists('moon', $details[FIELD_LOAD_CURRENT]), t('Moon is available in the instance array.'));
+ $this->assertTrue(array_key_exists('mars', $details[FIELD_LOAD_REVISION]), t('Mars is available in the instance array.'));
+
+ // Test current and revision storage details together because the columns
+ // are the same.
+ foreach ((array) $field['columns'] as $column_name => $attributes) {
+ $this->assertEqual($details[FIELD_LOAD_CURRENT]['moon'][$column_name], $column_name, t('Column name %value matches the definition in %bin.', array('%value' => $column_name, '%bin' => 'moon[FIELD_LOAD_CURRENT]')));
+ $this->assertEqual($details[FIELD_LOAD_REVISION]['mars'][$column_name], $column_name, t('Column name %value matches the definition in %bin.', array('%value' => $column_name, '%bin' => 'mars[FIELD_LOAD_REVISION]')));
+ }
+ }
+
+ /**
+ * Tests insert and update with missing or NULL fields.
+ */
+ function testFieldAttachSaveMissingData() {
+ $entity_type = 'test_entity';
+ $entity_init = field_test_create_stub_entity();
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Insert: Field is missing.
+ $entity = clone($entity_init);
+ field_attach_insert($entity_type, $entity);
+
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $this->assertTrue(empty($entity->{$this->field_name}), t('Insert: missing field results in no value saved'));
+
+ // Insert: Field is NULL.
+ field_cache_clear();
+ $entity = clone($entity_init);
+ $entity->{$this->field_name} = NULL;
+ field_attach_insert($entity_type, $entity);
+
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $this->assertTrue(empty($entity->{$this->field_name}), t('Insert: NULL field results in no value saved'));
+
+ // Add some real data.
+ field_cache_clear();
+ $entity = clone($entity_init);
+ $values = $this->_generateTestFieldValues(1);
+ $entity->{$this->field_name}[$langcode] = $values;
+ field_attach_insert($entity_type, $entity);
+
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $this->assertEqual($entity->{$this->field_name}[$langcode], $values, t('Field data saved'));
+
+ // Update: Field is missing. Data should survive.
+ field_cache_clear();
+ $entity = clone($entity_init);
+ field_attach_update($entity_type, $entity);
+
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $this->assertEqual($entity->{$this->field_name}[$langcode], $values, t('Update: missing field leaves existing values in place'));
+
+ // Update: Field is NULL. Data should be wiped.
+ field_cache_clear();
+ $entity = clone($entity_init);
+ $entity->{$this->field_name} = NULL;
+ field_attach_update($entity_type, $entity);
+
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $this->assertTrue(empty($entity->{$this->field_name}), t('Update: NULL field removes existing values'));
+
+ // Re-add some data.
+ field_cache_clear();
+ $entity = clone($entity_init);
+ $values = $this->_generateTestFieldValues(1);
+ $entity->{$this->field_name}[$langcode] = $values;
+ field_attach_update($entity_type, $entity);
+
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $this->assertEqual($entity->{$this->field_name}[$langcode], $values, t('Field data saved'));
+
+ // Update: Field is empty array. Data should be wiped.
+ field_cache_clear();
+ $entity = clone($entity_init);
+ $entity->{$this->field_name} = array();
+ field_attach_update($entity_type, $entity);
+
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $this->assertTrue(empty($entity->{$this->field_name}), t('Update: empty array removes existing values'));
+ }
+
+ /**
+ * Test insert with missing or NULL fields, with default value.
+ */
+ function testFieldAttachSaveMissingDataDefaultValue() {
+ // Add a default value function.
+ $this->instance['default_value_function'] = 'field_test_default_value';
+ field_update_instance($this->instance);
+
+ $entity_type = 'test_entity';
+ $entity_init = field_test_create_stub_entity();
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Insert: Field is NULL.
+ $entity = clone($entity_init);
+ $entity->{$this->field_name}[$langcode] = NULL;
+ field_attach_insert($entity_type, $entity);
+
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $this->assertTrue(empty($entity->{$this->field_name}[$langcode]), t('Insert: NULL field results in no value saved'));
+
+ // Insert: Field is missing.
+ field_cache_clear();
+ $entity = clone($entity_init);
+ field_attach_insert($entity_type, $entity);
+
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $values = field_test_default_value($entity_type, $entity, $this->field, $this->instance);
+ $this->assertEqual($entity->{$this->field_name}[$langcode], $values, t('Insert: missing field results in default value saved'));
+ }
+
+ /**
+ * Test field_attach_delete().
+ */
+ function testFieldAttachDelete() {
+ $entity_type = 'test_entity';
+ $langcode = FIELD_LANGUAGE_NONE;
+ $rev[0] = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+
+ // Create revision 0
+ $values = $this->_generateTestFieldValues($this->field['cardinality']);
+ $rev[0]->{$this->field_name}[$langcode] = $values;
+ field_attach_insert($entity_type, $rev[0]);
+
+ // Create revision 1
+ $rev[1] = field_test_create_stub_entity(0, 1, $this->instance['bundle']);
+ $rev[1]->{$this->field_name}[$langcode] = $values;
+ field_attach_update($entity_type, $rev[1]);
+
+ // Create revision 2
+ $rev[2] = field_test_create_stub_entity(0, 2, $this->instance['bundle']);
+ $rev[2]->{$this->field_name}[$langcode] = $values;
+ field_attach_update($entity_type, $rev[2]);
+
+ // Confirm each revision loads
+ foreach (array_keys($rev) as $vid) {
+ $read = field_test_create_stub_entity(0, $vid, $this->instance['bundle']);
+ field_attach_load_revision($entity_type, array(0 => $read));
+ $this->assertEqual(count($read->{$this->field_name}[$langcode]), $this->field['cardinality'], "The test object revision $vid has {$this->field['cardinality']} values.");
+ }
+
+ // Delete revision 1, confirm the other two still load.
+ field_attach_delete_revision($entity_type, $rev[1]);
+ foreach (array(0, 2) as $vid) {
+ $read = field_test_create_stub_entity(0, $vid, $this->instance['bundle']);
+ field_attach_load_revision($entity_type, array(0 => $read));
+ $this->assertEqual(count($read->{$this->field_name}[$langcode]), $this->field['cardinality'], "The test object revision $vid has {$this->field['cardinality']} values.");
+ }
+
+ // Confirm the current revision still loads
+ $read = field_test_create_stub_entity(0, 2, $this->instance['bundle']);
+ field_attach_load($entity_type, array(0 => $read));
+ $this->assertEqual(count($read->{$this->field_name}[$langcode]), $this->field['cardinality'], "The test object current revision has {$this->field['cardinality']} values.");
+
+ // Delete all field data, confirm nothing loads
+ field_attach_delete($entity_type, $rev[2]);
+ foreach (array(0, 1, 2) as $vid) {
+ $read = field_test_create_stub_entity(0, $vid, $this->instance['bundle']);
+ field_attach_load_revision($entity_type, array(0 => $read));
+ $this->assertIdentical($read->{$this->field_name}, array(), "The test object revision $vid is deleted.");
+ }
+ $read = field_test_create_stub_entity(0, 2, $this->instance['bundle']);
+ field_attach_load($entity_type, array(0 => $read));
+ $this->assertIdentical($read->{$this->field_name}, array(), t('The test object current revision is deleted.'));
+ }
+
+ /**
+ * Test field_attach_create_bundle() and field_attach_rename_bundle().
+ */
+ function testFieldAttachCreateRenameBundle() {
+ // Create a new bundle. This has to be initiated by the module so that its
+ // hook_entity_info() is consistent.
+ $new_bundle = 'test_bundle_' . drupal_strtolower($this->randomName());
+ field_test_create_bundle($new_bundle);
+
+ // Add an instance to that bundle.
+ $this->instance['bundle'] = $new_bundle;
+ field_create_instance($this->instance);
+
+ // Save an object with data in the field.
+ $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+ $langcode = FIELD_LANGUAGE_NONE;
+ $values = $this->_generateTestFieldValues($this->field['cardinality']);
+ $entity->{$this->field_name}[$langcode] = $values;
+ $entity_type = 'test_entity';
+ field_attach_insert($entity_type, $entity);
+
+ // Verify the field data is present on load.
+ $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+ field_attach_load($entity_type, array(0 => $entity));
+ $this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], "Data is retrieved for the new bundle");
+
+ // Rename the bundle. This has to be initiated by the module so that its
+ // hook_entity_info() is consistent.
+ $new_bundle = 'test_bundle_' . drupal_strtolower($this->randomName());
+ field_test_rename_bundle($this->instance['bundle'], $new_bundle);
+
+ // Check that the instance definition has been updated.
+ $this->instance = field_info_instance($entity_type, $this->field_name, $new_bundle);
+ $this->assertIdentical($this->instance['bundle'], $new_bundle, "Bundle name has been updated in the instance.");
+
+ // Verify the field data is present on load.
+ $entity = field_test_create_stub_entity(0, 0, $new_bundle);
+ field_attach_load($entity_type, array(0 => $entity));
+ $this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], "Bundle name has been updated in the field storage");
+ }
+
+ /**
+ * Test field_attach_delete_bundle().
+ */
+ function testFieldAttachDeleteBundle() {
+ // Create a new bundle. This has to be initiated by the module so that its
+ // hook_entity_info() is consistent.
+ $new_bundle = 'test_bundle_' . drupal_strtolower($this->randomName());
+ field_test_create_bundle($new_bundle);
+
+ // Add an instance to that bundle.
+ $this->instance['bundle'] = $new_bundle;
+ field_create_instance($this->instance);
+
+ // Create a second field for the test bundle
+ $field_name = drupal_strtolower($this->randomName() . '_field_name');
+ $field = array('field_name' => $field_name, 'type' => 'test_field', 'cardinality' => 1);
+ field_create_field($field);
+ $instance = array(
+ 'field_name' => $field_name,
+ 'object_type' => 'test_entity',
+ 'bundle' => $this->instance['bundle'],
+ 'label' => $this->randomName() . '_label',
+ 'description' => $this->randomName() . '_description',
+ 'weight' => mt_rand(0, 127),
+ // test_field has no instance settings
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ 'settings' => array(
+ 'size' => mt_rand(0, 255))));
+ field_create_instance($instance);
+
+ // Save an object with data for both fields
+ $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+ $langcode = FIELD_LANGUAGE_NONE;
+ $values = $this->_generateTestFieldValues($this->field['cardinality']);
+ $entity->{$this->field_name}[$langcode] = $values;
+ $entity->{$field_name}[$langcode] = $this->_generateTestFieldValues(1);
+ field_attach_insert('test_entity', $entity);
+
+ // Verify the fields are present on load
+ $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+ field_attach_load('test_entity', array(0 => $entity));
+ $this->assertEqual(count($entity->{$this->field_name}[$langcode]), 4, 'First field got loaded');
+ $this->assertEqual(count($entity->{$field_name}[$langcode]), 1, 'Second field got loaded');
+
+ // Delete the bundle. This has to be initiated by the module so that its
+ // hook_entity_info() is consistent.
+ field_test_delete_bundle($this->instance['bundle']);
+
+ // Verify no data gets loaded
+ $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+ field_attach_load('test_entity', array(0 => $entity));
+ $this->assertFalse(isset($entity->{$this->field_name}[$langcode]), 'No data for first field');
+ $this->assertFalse(isset($entity->{$field_name}[$langcode]), 'No data for second field');
+
+ // Verify that the instances are gone
+ $this->assertFalse(field_read_instance('test_entity', $this->field_name, $this->instance['bundle']), "First field is deleted");
+ $this->assertFalse(field_read_instance('test_entity', $field_name, $instance['bundle']), "Second field is deleted");
+ }
+
+ /**
+ * Test field_attach_query().
+ */
+ function testFieldAttachQuery() {
+ $cardinality = $this->field['cardinality'];
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Create an additional bundle with an instance of the field.
+ field_test_create_bundle('test_bundle_1', 'Test Bundle 1');
+ $this->instance2 = $this->instance;
+ $this->instance2['bundle'] = 'test_bundle_1';
+ field_create_instance($this->instance2);
+
+ // Create instances of both fields on the second entity type.
+ $instance = $this->instance;
+ $instance['object_type'] = 'test_cacheable_entity';
+ field_create_instance($instance);
+ $instance2 = $this->instance2;
+ $instance2['object_type'] = 'test_cacheable_entity';
+ field_create_instance($instance2);
+
+ // Unconditional count query returns 0.
+ $count = field_attach_query($this->field_id, array(), array('count' => TRUE));
+ $this->assertEqual($count, 0, t('With no objects, count query returns 0.'));
+
+ // Create two test objects, using two different types and bundles.
+ $entity_types = array(1 => 'test_entity', 2 => 'test_cacheable_entity');
+ $entities = array(1 => field_test_create_stub_entity(1, 1, 'test_bundle'), 2 => field_test_create_stub_entity(2, 2, 'test_bundle_1'));
+
+ // Create first test object with random (distinct) values.
+ $values = array();
+ for ($delta = 0; $delta < $cardinality; $delta++) {
+ do {
+ $value = mt_rand(1, 127);
+ } while (in_array($value, $values));
+ $values[$delta] = $value;
+ $entities[1]->{$this->field_name}[$langcode][$delta] = array('value' => $values[$delta]);
+ }
+ field_attach_insert($entity_types[1], $entities[1]);
+
+ // Unconditional count query returns 1.
+ $count = field_attach_query($this->field_id, array(), array('count' => TRUE));
+ $this->assertEqual($count, 1, t('With one object, count query returns @count.', array('@count' => $count)));
+
+ // Create second test object, sharing a value with the first one.
+ $common_value = $values[$cardinality - 1];
+ $entities[2]->{$this->field_name} = array($langcode => array(array('value' => $common_value)));
+ field_attach_insert($entity_types[2], $entities[2]);
+
+ // Query on the object's values.
+ for ($delta = 0; $delta < $cardinality; $delta++) {
+ $conditions = array(array('value', $values[$delta]));
+ $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertTrue(isset($result[$entity_types[1]][1]), t('Query on value %delta returns the object', array('%delta' => $delta)));
+
+ $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
+ $this->assertEqual($count, ($values[$delta] == $common_value) ? 2 : 1, t('Count query on value %delta counts %count objects', array('%delta' => $delta, '%count' => $count)));
+ }
+
+ // Query on a value that is not in the object.
+ do {
+ $different_value = mt_rand(1, 127);
+ } while (in_array($different_value, $values));
+ $conditions = array(array('value', $different_value));
+ $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertFalse(isset($result[$entity_types[1]][1]), t("Query on a value that is not in the object doesn't return the object"));
+ $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
+ $this->assertEqual($count, 0, t("Count query on a value that is not in the object doesn't count the object"));
+
+ // Query on the value shared by both objects, and discriminate using
+ // additional conditions.
+
+ $conditions = array(array('value', $common_value));
+ $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertTrue(isset($result[$entity_types[1]][1]) && isset($result[$entity_types[2]][2]), t('Query on a value common to both objects returns both objects'));
+ $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
+ $this->assertEqual($count, 2, t('Count query on a value common to both objects counts both objects'));
+
+ $conditions = array(array('type', $entity_types[1]), array('value', $common_value));
+ $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertTrue(isset($result[$entity_types[1]][1]) && !isset($result[$entity_types[2]][2]), t("Query on a value common to both objects and a 'type' condition only returns the relevant object"));
+ $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
+ $this->assertEqual($count, 1, t("Count query on a value common to both objects and a 'type' condition only returns the relevant object"));
+
+ $conditions = array(array('bundle', $entities[1]->fttype), array('value', $common_value));
+ $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertTrue(isset($result[$entity_types[1]][1]) && !isset($result[$entity_types[2]][2]), t("Query on a value common to both objects and a 'bundle' condition only returns the relevant object"));
+ $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
+ $this->assertEqual($count, 1, t("Count query on a value common to both objects and a 'bundle' condition only counts the relevant object"));
+
+ $conditions = array(array('entity_id', $entities[1]->ftid), array('value', $common_value));
+ $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertTrue(isset($result[$entity_types[1]][1]) && !isset($result[$entity_types[2]][2]), t("Query on a value common to both objects and an 'entity_id' condition only returns the relevant object"));
+ $count = field_attach_query($this->field_id, $conditions, array('count' => TRUE));
+ $this->assertEqual($count, 1, t("Count query on a value common to both objects and an 'entity_id' condition only counts the relevant object"));
+
+ // Test result format.
+ $conditions = array(array('value', $values[0]));
+ $result = field_attach_query($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $expected = array(
+ $entity_types[1] => array(
+ $entities[1]->ftid => field_test_create_stub_entity($entities[1]->ftid, $entities[1]->ftvid),
+ )
+ );
+ $this->assertEqual($result, $expected, t('Result format is correct.'));
+
+ // Now test the count/offset paging capability.
+
+ // Create a new bundle with an instance of the field.
+ field_test_create_bundle('offset_bundle', 'Offset Test Bundle');
+ $this->instance2 = $this->instance;
+ $this->instance2['bundle'] = 'offset_bundle';
+ field_create_instance($this->instance2);
+
+ // Create 20 test objects, using the new bundle, but with
+ // non-sequential ids so we can tell we are getting the right ones
+ // back. We do not need unique values since field_attach_query()
+ // won't return them anyway.
+ $offset_entities = array();
+ $offset_id = mt_rand(1, 3);
+ for ($i = 0; $i < 20; ++$i) {
+ $offset_id += mt_rand(2, 5);
+ $offset_entities[$offset_id] = field_test_create_stub_entity($offset_id, $offset_id, 'offset_bundle');
+ $offset_entities[$offset_id]->{$this->field_name}[$langcode][0] = array('value' => $offset_id);
+ field_attach_insert('test_entity', $offset_entities[$offset_id]);
+ }
+
+ // Query for the offset entities in batches, making sure we get
+ // back the right ones.
+ $cursor = 0;
+ foreach (array(1 => 1, 3 => 3, 5 => 5, 8 => 8, 13 => 3) as $count => $expect) {
+ $found = field_attach_query($this->field_id, array(array('bundle', 'offset_bundle')), array('limit' => $count, 'cursor' => &$cursor));
+ if (isset($found['test_entity'])) {
+ $this->assertEqual(count($found['test_entity']), $expect, t('Requested @count, expected @expect, got @found, cursor @cursor', array('@count' => $count, '@expect' => $expect, '@found' => count($found['test_entity']), '@cursor' => $cursor)));
+ foreach ($found['test_entity'] as $id => $entity) {
+ $this->assert(isset($offset_entities[$id]), "Entity $id found");
+ unset($offset_entities[$id]);
+ }
+ }
+ else {
+ $this->assertEqual(0, $expect, t('Requested @count, expected @expect, got @found, cursor @cursor', array('@count' => $count, '@expect' => $expect, '@found' => 0, '@cursor' => $cursor)));
+ }
+ }
+ $this->assertEqual(count($offset_entities), 0, "All entities found");
+ $this->assertEqual($cursor, FIELD_QUERY_COMPLETE, "Cursor is FIELD_QUERY_COMPLETE");
+ }
+
+ /**
+ * Test field_attach_query_revisions().
+ */
+ function testFieldAttachQueryRevisions() {
+ $cardinality = $this->field['cardinality'];
+
+ // Create first object revision with random (distinct) values.
+ $entity_type = 'test_entity';
+ $entities = array(1 => field_test_create_stub_entity(1, 1), 2 => field_test_create_stub_entity(1, 2));
+ $langcode = FIELD_LANGUAGE_NONE;
+ $values = array();
+ for ($delta = 0; $delta < $cardinality; $delta++) {
+ do {
+ $value = mt_rand(1, 127);
+ } while (in_array($value, $values));
+ $values[$delta] = $value;
+ $entities[1]->{$this->field_name}[$langcode][$delta] = array('value' => $values[$delta]);
+ }
+ field_attach_insert($entity_type, $entities[1]);
+
+ // Create second object revision, sharing a value with the first one.
+ $common_value = $values[$cardinality - 1];
+ $entities[2]->{$this->field_name}[$langcode][0] = array('value' => $common_value);
+ field_attach_update($entity_type, $entities[2]);
+
+ // Query on the object's values.
+ for ($delta = 0; $delta < $cardinality; $delta++) {
+ $conditions = array(array('value', $values[$delta]));
+ $result = field_attach_query_revisions($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertTrue(isset($result[$entity_type][1]), t('Query on value %delta returns the object', array('%delta' => $delta)));
+ }
+
+ // Query on a value that is not in the object.
+ do {
+ $different_value = mt_rand(1, 127);
+ } while (in_array($different_value, $values));
+ $conditions = array(array('value', $different_value));
+ $result = field_attach_query_revisions($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertFalse(isset($result[$entity_type][1]), t("Query on a value that is not in the object doesn't return the object"));
+
+ // Query on the value shared by both objects, and discriminate using
+ // additional conditions.
+
+ $conditions = array(array('value', $common_value));
+ $result = field_attach_query_revisions($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertTrue(isset($result[$entity_type][1]) && isset($result[$entity_type][2]), t('Query on a value common to both objects returns both objects'));
+
+ $conditions = array(array('revision_id', $entities[1]->ftvid), array('value', $common_value));
+ $result = field_attach_query_revisions($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertTrue(isset($result[$entity_type][1]) && !isset($result[$entity_type][2]), t("Query on a value common to both objects and a 'revision_id' condition only returns the relevant object"));
+
+ // Test FIELD_QUERY_RETURN_IDS result format.
+ $conditions = array(array('value', $values[0]));
+ $result = field_attach_query_revisions($this->field_id, $conditions, array('limit' => FIELD_QUERY_NO_LIMIT));
+ $expected = array(
+ $entity_type => array(
+ $entities[1]->ftid => field_test_create_stub_entity($entities[1]->ftid, $entities[1]->ftvid),
+ )
+ );
+ $this->assertEqual($result, $expected, t('FIELD_QUERY_RETURN_IDS result format returns the expect result'));
+ }
+}
+
+/**
+ * Unit test class for non-storage related field_attach_* functions.
+ */
+class FieldAttachOtherTestCase extends FieldAttachTestCase {
+ public static function getInfo() {
+ return array(
+ 'name' => 'Field attach tests (other)',
+ 'description' => 'Test other Field Attach API functions.',
+ 'group' => 'Field',
+ );
+ }
+
+ /**
+ * Test field_attach_view() and field_atach_prepare_view().
+ */
+ function testFieldAttachView() {
+ $entity_type = 'test_entity';
+ $entity_init = field_test_create_stub_entity();
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Populate values to be displayed.
+ $values = $this->_generateTestFieldValues($this->field['cardinality']);
+ $entity_init->{$this->field_name}[$langcode] = $values;
+
+ // Simple formatter, label displayed.
+ $entity = clone($entity_init);
+ $formatter_setting = $this->randomName();
+ $this->instance['display'] = array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'field_test_default',
+ 'settings' => array(
+ 'test_formatter_setting' => $formatter_setting,
+ )
+ ),
+ );
+ field_update_instance($this->instance);
+ field_attach_prepare_view($entity_type, array($entity->ftid => $entity));
+ $entity->content = field_attach_view($entity_type, $entity);
+ $output = drupal_render($entity->content);
+ $this->content = $output;
+ $this->assertRaw($this->instance['label'], "Label is displayed.");
+ foreach ($values as $delta => $value) {
+ $this->content = $output;
+ $this->assertRaw("$formatter_setting|{$value['value']}", "Value $delta is displayed, formatter settings are applied.");
+ }
+
+ // Label hidden.
+ $entity = clone($entity_init);
+ $this->instance['display']['full']['label'] = 'hidden';
+ field_update_instance($this->instance);
+ field_attach_prepare_view($entity_type, array($entity->ftid => $entity));
+ $entity->content = field_attach_view($entity_type, $entity);
+ $output = drupal_render($entity->content);
+ $this->content = $output;
+ $this->assertNoRaw($this->instance['label'], "Hidden label: label is not displayed.");
+
+ // Field hidden.
+ $entity = clone($entity_init);
+ $this->instance['display'] = array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'hidden',
+ ),
+ );
+ field_update_instance($this->instance);
+ field_attach_prepare_view($entity_type, array($entity->ftid => $entity));
+ $entity->content = field_attach_view($entity_type, $entity);
+ $output = drupal_render($entity->content);
+ $this->content = $output;
+ $this->assertNoRaw($this->instance['label'], "Hidden field: label is not displayed.");
+ foreach ($values as $delta => $value) {
+ $this->assertNoRaw($value['value'], "Hidden field: value $delta is not displayed.");
+ }
+
+ // Multiple formatter.
+ $entity = clone($entity_init);
+ $formatter_setting = $this->randomName();
+ $this->instance['display'] = array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'field_test_multiple',
+ 'settings' => array(
+ 'test_formatter_setting_multiple' => $formatter_setting,
+ )
+ ),
+ );
+ field_update_instance($this->instance);
+ field_attach_prepare_view($entity_type, array($entity->ftid => $entity));
+ $entity->content = field_attach_view($entity_type, $entity);
+ $output = drupal_render($entity->content);
+ $display = $formatter_setting;
+ foreach ($values as $delta => $value) {
+ $display .= "|$delta:{$value['value']}";
+ }
+ $this->content = $output;
+ $this->assertRaw($display, "Multiple formatter: all values are displayed, formatter settings are applied.");
+
+ // Test a formatter that uses hook_field_formatter_prepare_view()..
+ $entity = clone($entity_init);
+ $formatter_setting = $this->randomName();
+ $this->instance['display'] = array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'field_test_needs_additional_data',
+ 'settings' => array(
+ 'test_formatter_setting_additional' => $formatter_setting,
+ )
+ ),
+ );
+ field_update_instance($this->instance);
+ field_attach_prepare_view($entity_type, array($entity->ftid => $entity));
+ $entity->content = field_attach_view($entity_type, $entity);
+ $output = drupal_render($entity->content);
+ $this->content = $output;
+ foreach ($values as $delta => $value) {
+ $this->content = $output;
+ $expected = $formatter_setting . '|' . $value['value'] . '|' . ($value['value'] + 1);
+ $this->assertRaw($expected, "Value $delta is displayed, formatter settings are applied.");
+ }
+
+ // TODO:
+ // - check display order with several fields
+
+ // Preprocess template.
+ $variables = array();
+ field_attach_preprocess($entity_type, $entity, $entity->content, $variables);
+ $result = TRUE;
+ foreach ($values as $delta => $item) {
+ if ($variables[$this->field_name][$delta]['value'] !== $item['value']) {
+ $result = FALSE;
+ break;
+ }
+ }
+ $this->assertTrue($result, t('Variable $@field_name correctly populated.', array('@field_name' => $this->field_name)));
+ }
+
+ /**
+ * Test field cache.
+ */
+ function testFieldAttachCache() {
+ // Initialize random values and a test entity.
+ $entity_init = field_test_create_stub_entity(1, 1, $this->instance['bundle']);
+ $langcode = FIELD_LANGUAGE_NONE;
+ $values = $this->_generateTestFieldValues($this->field['cardinality']);
+
+ // Non-cacheable entity type.
+ $entity_type = 'test_entity';
+ $cid = "field:$entity_type:{$entity_init->ftid}";
+
+ // Check that no initial cache entry is present.
+ $this->assertFalse(cache_get($cid, 'cache_field'), t('Non-cached: no initial cache entry'));
+
+ // Save, and check that no cache entry is present.
+ $entity = clone($entity_init);
+ $entity->{$this->field_name}[$langcode] = $values;
+ field_attach_insert($entity_type, $entity);
+ $this->assertFalse(cache_get($cid, 'cache_field'), t('Non-cached: no cache entry on insert'));
+
+ // Load, and check that no cache entry is present.
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $this->assertFalse(cache_get($cid, 'cache_field'), t('Non-cached: no cache entry on load'));
+
+
+ // Cacheable entity type.
+ $entity_type = 'test_cacheable_entity';
+ $cid = "field:$entity_type:{$entity_init->ftid}";
+ $instance = $this->instance;
+ $instance['object_type'] = $entity_type;
+ field_create_instance($instance);
+
+ // Check that no initial cache entry is present.
+ $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no initial cache entry'));
+
+ // Save, and check that no cache entry is present.
+ $entity = clone($entity_init);
+ $entity->{$this->field_name}[$langcode] = $values;
+ field_attach_insert($entity_type, $entity);
+ $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no cache entry on insert'));
+
+ // Load a single field, and check that no cache entry is present.
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity), FIELD_LOAD_CURRENT, array('field_id' => $this->field_id));
+ $cache = cache_get($cid, 'cache_field');
+ $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no cache entry on loading a single field'));
+
+ // Load, and check that a cache entry is present with the expected values.
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $cache = cache_get($cid, 'cache_field');
+ $this->assertEqual($cache->data[$this->field_name][$langcode], $values, t('Cached: correct cache entry on load'));
+
+ // Update with different values, and check that the cache entry is wiped.
+ $values = $this->_generateTestFieldValues($this->field['cardinality']);
+ $entity = clone($entity_init);
+ $entity->{$this->field_name}[$langcode] = $values;
+ field_attach_update($entity_type, $entity);
+ $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no cache entry on update'));
+
+ // Load, and check that a cache entry is present with the expected values.
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $cache = cache_get($cid, 'cache_field');
+ $this->assertEqual($cache->data[$this->field_name][$langcode], $values, t('Cached: correct cache entry on load'));
+
+ // Create a new revision, and check that the cache entry is wiped.
+ $entity_init = field_test_create_stub_entity(1, 2, $this->instance['bundle']);
+ $values = $this->_generateTestFieldValues($this->field['cardinality']);
+ $entity = clone($entity_init);
+ $entity->{$this->field_name}[$langcode] = $values;
+ field_attach_update($entity_type, $entity);
+ $cache = cache_get($cid, 'cache_field');
+ $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no cache entry on new revision creation'));
+
+ // Load, and check that a cache entry is present with the expected values.
+ $entity = clone($entity_init);
+ field_attach_load($entity_type, array($entity->ftid => $entity));
+ $cache = cache_get($cid, 'cache_field');
+ $this->assertEqual($cache->data[$this->field_name][$langcode], $values, t('Cached: correct cache entry on load'));
+
+ // Delete, and check that the cache entry is wiped.
+ field_attach_delete($entity_type, $entity);
+ $this->assertFalse(cache_get($cid, 'cache_field'), t('Cached: no cache entry after delete'));
+ }
+
+ /**
+ * Test field_attach_validate().
+ *
+ * Verify that field_attach_validate() invokes the correct
+ * hook_field_validate.
+ */
+ function testFieldAttachValidate() {
+ $entity_type = 'test_entity';
+ $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Set up values to generate errors
+ $values = array();
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = -1;
+ $values[$delta]['_error_element'] = 'field_error_' . $delta;
+ }
+ // Arrange for item 1 not to generate an error
+ $values[1]['value'] = 1;
+ $entity->{$this->field_name}[$langcode] = $values;
+
+ try {
+ field_attach_validate($entity_type, $entity);
+ }
+ catch (FieldValidationException $e) {
+ $errors = $e->errors;
+ }
+
+ foreach ($values as $delta => $value) {
+ if ($value['value'] != 1) {
+ $this->assertIdentical($errors[$this->field_name][$langcode][$delta][0]['error'], 'field_test_invalid', "Error set on value $delta");
+ $this->assertEqual(count($errors[$this->field_name][$langcode][$delta]), 1, "Only one error set on value $delta");
+ unset($errors[$this->field_name][$langcode][$delta]);
+ }
+ else {
+ $this->assertFalse(isset($errors[$this->field_name][$langcode][$delta]), "No error set on value $delta");
+ }
+ }
+ $this->assertEqual(count($errors[$this->field_name][$langcode]), 0, 'No extraneous errors set');
+ }
+
+ /**
+ * Test field_attach_form().
+ *
+ * This could be much more thorough, but it does verify that the correct
+ * widgets show up.
+ */
+ function testFieldAttachForm() {
+ $entity_type = 'test_entity';
+ $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+
+ $form = $form_state = array();
+ field_attach_form($entity_type, $entity, $form, $form_state);
+
+ $langcode = FIELD_LANGUAGE_NONE;
+ $this->assertEqual($form[$this->field_name][$langcode]['#title'], $this->instance['label'], "Form title is {$this->instance['label']}");
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ // field_test_widget uses 'textfield'
+ $this->assertEqual($form[$this->field_name][$langcode][$delta]['value']['#type'], 'textfield', "Form delta $delta widget is textfield");
+ }
+ }
+
+ /**
+ * Test field_attach_submit().
+ */
+ function testFieldAttachSubmit() {
+ $entity_type = 'test_entity';
+ $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+
+ // Build the form.
+ $form = $form_state = array();
+ field_attach_form($entity_type, $entity, $form, $form_state);
+
+ // Simulate incoming values.
+ $values = array();
+ $weights = array();
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = mt_rand(1, 127);
+ // Assign random weight.
+ do {
+ $weight = mt_rand(0, $this->field['cardinality']);
+ } while (in_array($weight, $weights));
+ $weights[$delta] = $weight;
+ $values[$delta]['_weight'] = $weight;
+ }
+ // Leave an empty value. 'field_test' fields are empty if empty().
+ $values[1]['value'] = 0;
+
+ $langcode = FIELD_LANGUAGE_NONE;
+ $form_state['values'] = array($this->field_name => array($langcode => $values));
+ field_attach_submit($entity_type, $entity, $form, $form_state);
+
+ asort($weights);
+ $expected_values = array();
+ foreach ($weights as $key => $value) {
+ if ($key != 1) {
+ $expected_values[] = array('value' => $values[$key]['value']);
+ }
+ }
+ $this->assertIdentical($entity->{$this->field_name}[$langcode], $expected_values, 'Submit filters empty values');
+ }
+}
+
+class FieldInfoTestCase extends FieldTestCase {
+
+ public static function getInfo() {
+ return array(
+ 'name' => 'Field info tests',
+ 'description' => 'Get information about existing fields, instances and bundles.',
+ 'group' => 'Field',
+ );
+ }
+
+ function setUp() {
+ parent::setUp('field_test');
+ }
+
+ /**
+ * Test that field types and field definitions are correcly cached.
+ */
+ function testFieldInfo() {
+ // Test that field_test module's fields, widgets, and formatters show up.
+ $field_test_info = field_test_field_info();
+ $formatter_info = field_test_field_formatter_info();
+ $widget_info = field_test_field_widget_info();
+ $storage_info = field_test_field_storage_info();
+
+ $info = field_info_field_types();
+ foreach ($field_test_info as $t_key => $field_type) {
+ foreach ($field_type as $key => $val) {
+ $this->assertEqual($info[$t_key][$key], $val, t("Field type $t_key key $key is $val"));
+ }
+ $this->assertEqual($info[$t_key]['module'], 'field_test', t("Field type field_test module appears"));
+ }
+
+ $info = field_info_formatter_types();
+ foreach ($formatter_info as $f_key => $formatter) {
+ foreach ($formatter as $key => $val) {
+ $this->assertEqual($info[$f_key][$key], $val, t("Formatter type $f_key key $key is $val"));
+ }
+ $this->assertEqual($info[$f_key]['module'], 'field_test', t("Formatter type field_test module appears"));
+ }
+
+ $info = field_info_widget_types();
+ foreach ($widget_info as $w_key => $widget) {
+ foreach ($widget as $key => $val) {
+ $this->assertEqual($info[$w_key][$key], $val, t("Widget type $w_key key $key is $val"));
+ }
+ $this->assertEqual($info[$w_key]['module'], 'field_test', t("Widget type field_test module appears"));
+ }
+
+ $info = field_info_storage_types();
+ foreach ($storage_info as $s_key => $storage) {
+ foreach ($storage as $key => $val) {
+ $this->assertEqual($info[$s_key][$key], $val, t("Storage type $s_key key $key is $val"));
+ }
+ $this->assertEqual($info[$s_key]['module'], 'field_test', t("Storage type field_test module appears"));
+ }
+
+ // Verify that no unexpected instances exist.
+ $core_fields = field_info_fields();
+ $instances = field_info_instances('test_entity', 'test_bundle');
+ $this->assertTrue(empty($instances), t('With no instances, info bundles is empty.'));
+
+ // Create a field, verify it shows up.
+ $field = array(
+ 'field_name' => drupal_strtolower($this->randomName()),
+ 'type' => 'test_field',
+ );
+ field_create_field($field);
+ $fields = field_info_fields();
+ $this->assertEqual(count($fields), count($core_fields) + 1, t('One new field exists'));
+ $this->assertEqual($fields[$field['field_name']]['field_name'], $field['field_name'], t('info fields contains field name'));
+ $this->assertEqual($fields[$field['field_name']]['type'], $field['type'], t('info fields contains field type'));
+ $this->assertEqual($fields[$field['field_name']]['module'], 'field_test', t('info fields contains field module'));
+ $settings = array('test_field_setting' => 'dummy test string');
+ foreach ($settings as $key => $val) {
+ $this->assertEqual($fields[$field['field_name']]['settings'][$key], $val, t("Field setting $key has correct default value $val"));
+ }
+ $this->assertEqual($fields[$field['field_name']]['cardinality'], 1, t('info fields contains cardinality 1'));
+ $this->assertEqual($fields[$field['field_name']]['active'], 1, t('info fields contains active 1'));
+
+ // Create an instance, verify that it shows up
+ $instance = array(
+ 'field_name' => $field['field_name'],
+ 'object_type' => 'test_entity',
+ 'bundle' => 'test_bundle',
+ 'label' => $this->randomName(),
+ 'description' => $this->randomName(),
+ 'weight' => mt_rand(0, 127),
+ // test_field has no instance settings
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ 'settings' => array(
+ 'test_setting' => 999)));
+ field_create_instance($instance);
+
+ $instances = field_info_instances('test_entity', $instance['bundle']);
+ $this->assertEqual(count($instances), 1, t('One instance shows up in info when attached to a bundle.'));
+ $this->assertTrue($instance < $instances[$instance['field_name']], t('Instance appears in info correctly'));
+ }
+
+ /**
+ * Test that cached field definitions are ready for current runtime context.
+ */
+ function testFieldPrepare() {
+ $field_definition = array(
+ 'field_name' => 'field',
+ 'type' => 'test_field',
+ );
+ field_create_field($field_definition);
+
+ // Simulate a stored field definition missing a field setting (e.g. a
+ // third-party module adding a new field setting has been enabled, and
+ // existing fields do not know the setting yet).
+ $data = db_query('SELECT data FROM {field_config} WHERE field_name = :field_name', array(':field_name' => $field_definition['field_name']))->fetchField();
+ $data = unserialize($data);
+ $data['settings'] = array();
+ db_update('field_config')
+ ->fields(array('data' => serialize($data)))
+ ->condition('field_name', $field_definition['field_name'])
+ ->execute();
+
+ field_cache_clear();
+
+ // Read the field back.
+ $field = field_info_field($field_definition['field_name']);
+
+ // Check that all expected settings are in place.
+ $field_type = field_info_field_types($field_definition['type']);
+ $this->assertIdentical($field['settings'], $field_type['settings'], t('All expected default field settings are present.'));
+ }
+
+ /**
+ * Test that cached instance definitions are ready for current runtime context.
+ */
+ function testInstancePrepare() {
+ $field_definition = array(
+ 'field_name' => 'field',
+ 'type' => 'test_field',
+ );
+ field_create_field($field_definition);
+ $instance_definition = array(
+ 'field_name' => $field_definition['field_name'],
+ 'object_type' => 'test_entity',
+ 'bundle' => 'test_bundle',
+ );
+ field_create_instance($instance_definition);
+
+ // Simulate a stored instance definition missing various settings (e.g. a
+ // third-party module adding instance, widget or display settings has been
+ // enabled, but existing instances do not know the new settings).
+ $data = db_query('SELECT data FROM {field_config_instance} WHERE field_name = :field_name AND bundle = :bundle', array(':field_name' => $instance_definition['field_name'], ':bundle' => $instance_definition['bundle']))->fetchField();
+ $data = unserialize($data);
+ $data['settings'] = array();
+ $data['widget']['settings'] = 'unavailable_widget';
+ $data['widget']['settings'] = array();
+ $data['display']['full']['type'] = 'unavailable_formatter';
+ $data['display']['full']['settings'] = array();
+ db_update('field_config_instance')
+ ->fields(array('data' => serialize($data)))
+ ->condition('field_name', $instance_definition['field_name'])
+ ->condition('bundle', $instance_definition['bundle'])
+ ->execute();
+
+ field_cache_clear();
+
+ // Read the instance back.
+ $instance = field_info_instance($instance_definition['object_type'], $instance_definition['field_name'], $instance_definition['bundle']);
+
+ // Check that all expected instance settings are in place.
+ $field_type = field_info_field_types($field_definition['type']);
+ $this->assertIdentical($instance['settings'], $field_type['instance_settings'] , t('All expected instance settings are present.'));
+
+ // Check that the default widget is used and expected settings are in place.
+ $this->assertIdentical($instance['widget']['type'], $field_type['default_widget'], t('Unavailable widget replaced with default widget.'));
+ $widget_type = field_info_widget_types($instance['widget']['type']);
+ $this->assertIdentical($instance['widget']['settings'], $widget_type['settings'] , t('All expected widget settings are present.'));
+
+ // Check that the default formatter is used and expected settings are in place.
+ foreach (field_build_modes('test_entity') as $build_mode => $label) {
+ $this->assertIdentical($instance['display'][$build_mode]['type'], $field_type['default_formatter'], t('Unavailable formatter replaced with default formatter in build_mode %build_mode', array('%build_mode' => $build_mode)));
+ $formatter_type = field_info_formatter_types($instance['display'][$build_mode]['type']);
+ $this->assertIdentical($instance['display'][$build_mode]['settings'], $formatter_type['settings'] , t('All expected formatter settings are present in build_mode %build_mode', array('%build_mode' => $build_mode)));
+ }
+ }
+
+ /**
+ * Test that the field_info settings convenience functions work.
+ */
+ function testSettingsInfo() {
+ $info = field_test_field_info();
+ foreach ($info as $type => $data) {
+ $this->assertIdentical(field_info_field_settings($type), $data['settings'], "field_info_field_settings returns {$type}'s field settings");
+ $this->assertIdentical(field_info_instance_settings($type), $data['instance_settings'], "field_info_field_settings returns {$type}'s field instance settings");
+ }
+
+ $info = field_test_field_widget_info();
+ foreach ($info as $type => $data) {
+ $this->assertIdentical(field_info_widget_settings($type), $data['settings'], "field_info_widget_settings returns {$type}'s widget settings");
+ }
+
+ $info = field_test_field_formatter_info();
+ foreach ($info as $type => $data) {
+ $this->assertIdentical(field_info_formatter_settings($type), $data['settings'], "field_info_formatter_settings returns {$type}'s formatter settings");
+ }
+ }
+}
+
+class FieldFormTestCase extends FieldTestCase {
+ public static function getInfo() {
+ return array(
+ 'name' => 'Field form tests',
+ 'description' => 'Test Field form handling.',
+ 'group' => 'Field',
+ );
+ }
+
+ function setUp() {
+ parent::setUp('field_test');
+
+ $web_user = $this->drupalCreateUser(array('access field_test content', 'administer field_test content'));
+ $this->drupalLogin($web_user);
+
+ $this->field_single = array('field_name' => drupal_strtolower($this->randomName()), 'type' => 'test_field');
+ $this->field_multiple = array('field_name' => drupal_strtolower($this->randomName()), 'type' => 'test_field', 'cardinality' => 4);
+ $this->field_unlimited = array('field_name' => drupal_strtolower($this->randomName()), 'type' => 'test_field', 'cardinality' => FIELD_CARDINALITY_UNLIMITED);
+
+ $this->instance = array(
+ 'object_type' => 'test_entity',
+ 'bundle' => 'test_bundle',
+ 'label' => $this->randomName() . '_label',
+ 'description' => $this->randomName() . '_description',
+ 'weight' => mt_rand(0, 127),
+ 'settings' => array(
+ 'test_instance_setting' => $this->randomName(),
+ ),
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ 'label' => 'Test Field',
+ 'settings' => array(
+ 'test_widget_setting' => $this->randomName(),
+ )
+ )
+ );
+ }
+
+ function testFieldFormSingle() {
+ $this->field = $this->field_single;
+ $this->field_name = $this->field['field_name'];
+ $this->instance['field_name'] = $this->field_name;
+ field_create_field($this->field);
+ field_create_instance($this->instance);
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Display creation form.
+ $this->drupalGet('test-entity/add/test-bundle');
+ $this->assertFieldByName("{$this->field_name}[$langcode][0][value]", '', 'Widget is displayed');
+ $this->assertNoField("{$this->field_name}[$langcode][1][value]", 'No extraneous widget is displayed');
+ // TODO : check that the widget is populated with default value ?
+
+ // Submit with invalid value (field-level validation).
+ $edit = array("{$this->field_name}[$langcode][0][value]" => -1);
+ $this->drupalPost(NULL, $edit, t('Save'));
+ $this->assertRaw(t('%name does not accept the value -1.', array('%name' => $this->instance['label'])), 'Field validation fails with invalid input.');
+ // TODO : check that the correct field is flagged for error.
+
+ // Create an entity
+ $value = mt_rand(1, 127);
+ $edit = array("{$this->field_name}[$langcode][0][value]" => $value);
+ $this->drupalPost(NULL, $edit, t('Save'));
+ preg_match('|test-entity/(\d+)/edit|', $this->url, $match);
+ $id = $match[1];
+ $this->assertRaw(t('test_entity @id has been created.', array('@id' => $id)), 'Entity was created');
+ $entity = field_test_entity_test_load($id);
+ $this->assertEqual($entity->{$this->field_name}[$langcode][0]['value'], $value, 'Field value was saved');
+
+ // Display edit form.
+ $this->drupalGet('test-entity/' . $id . '/edit');
+ $this->assertFieldByName("{$this->field_name}[$langcode][0][value]", $value, 'Widget is displayed with the correct default value');
+ $this->assertNoField("{$this->field_name}[$langcode][1][value]", 'No extraneous widget is displayed');
+
+ // Update the entity.
+ $value = mt_rand(1, 127);
+ $edit = array("{$this->field_name}[$langcode][0][value]" => $value);
+ $this->drupalPost(NULL, $edit, t('Save'));
+ $this->assertRaw(t('test_entity @id has been updated.', array('@id' => $id)), 'Entity was updated');
+ $entity = field_test_entity_test_load($id);
+ $this->assertEqual($entity->{$this->field_name}[$langcode][0]['value'], $value, 'Field value was updated');
+
+ // Empty the field.
+ $value = '';
+ $edit = array("{$this->field_name}[$langcode][0][value]" => $value);
+ $this->drupalPost('test-entity/' . $id . '/edit', $edit, t('Save'));
+ $this->assertRaw(t('test_entity @id has been updated.', array('@id' => $id)), 'Entity was updated');
+ $entity = field_test_entity_test_load($id);
+ $this->assertIdentical($entity->{$this->field_name}, array(), 'Field was emptied');
+
+ }
+
+ function testFieldFormSingleRequired() {
+ $this->field = $this->field_single;
+ $this->field_name = $this->field['field_name'];
+ $this->instance['field_name'] = $this->field_name;
+ $this->instance['required'] = TRUE;
+ field_create_field($this->field);
+ field_create_instance($this->instance);
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Submit with missing required value.
+ $edit = array();
+ $this->drupalPost('test-entity/add/test-bundle', $edit, t('Save'));
+ $this->assertRaw(t('!name field is required.', array('!name' => $this->instance['label'])), 'Required field with no value fails validation');
+
+ // Create an entity
+ $value = mt_rand(1, 127);
+ $edit = array("{$this->field_name}[$langcode][0][value]" => $value);
+ $this->drupalPost(NULL, $edit, t('Save'));
+ preg_match('|test-entity/(\d+)/edit|', $this->url, $match);
+ $id = $match[1];
+ $this->assertRaw(t('test_entity @id has been created.', array('@id' => $id)), 'Entity was created');
+ $entity = field_test_entity_test_load($id);
+ $this->assertEqual($entity->{$this->field_name}[$langcode][0]['value'], $value, 'Field value was saved');
+
+ // Edit with missing required value.
+ $value = '';
+ $edit = array("{$this->field_name}[$langcode][0][value]" => $value);
+ $this->drupalPost('test-entity/' . $id . '/edit', $edit, t('Save'));
+ $this->assertRaw(t('!name field is required.', array('!name' => $this->instance['label'])), 'Required field with no value fails validation');
+ }
+
+// function testFieldFormMultiple() {
+// $this->field = $this->field_multiple;
+// $this->field_name = $this->field['field_name'];
+// $this->instance['field_name'] = $this->field_name;
+// field_create_field($this->field);
+// field_create_instance($this->instance);
+// }
+
+ function testFieldFormUnlimited() {
+ $this->field = $this->field_unlimited;
+ $this->field_name = $this->field['field_name'];
+ $this->instance['field_name'] = $this->field_name;
+ field_create_field($this->field);
+ field_create_instance($this->instance);
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Display creation form -> 1 widget.
+ $this->drupalGet('test-entity/add/test-bundle');
+ $this->assertFieldByName("{$this->field_name}[$langcode][0][value]", '', 'Widget 1 is displayed');
+ $this->assertNoField("{$this->field_name}[$langcode][1][value]", 'No extraneous widget is displayed');
+
+ // Press 'add more' button -> 2 widgets.
+ $this->drupalPost(NULL, array(), t('Add another item'));
+ $this->assertFieldByName("{$this->field_name}[$langcode][0][value]", '', 'Widget 1 is displayed');
+ $this->assertFieldByName("{$this->field_name}[$langcode][1][value]", '', 'New widget is displayed');
+ $this->assertNoField("{$this->field_name}[$langcode][2][value]", 'No extraneous widget is displayed');
+ // TODO : check that non-field inpurs are preserved ('title')...
+
+ // Yet another time so that we can play with more values -> 3 widgets.
+ $this->drupalPost(NULL, array(), t('Add another item'));
+
+ // Prepare values and weights.
+ $count = 3;
+ $delta_range = $count - 1;
+ $values = $weights = $pattern = $expected_values = $edit = array();
+ for ($delta = 0; $delta <= $delta_range; $delta++) {
+ // Assign unique random weights.
+ do {
+ $weight = mt_rand(-$delta_range, $delta_range);
+ } while (in_array($weight, $weights));
+ $weights[] = $weight;
+ $value = mt_rand(1, 127);
+ $edit["$this->field_name[$langcode][$delta][value]"] = $value;
+ $edit["$this->field_name[$langcode][$delta][_weight]"] = $weight;
+ // We'll need three slightly different formats to check the values.
+ $values[$weight] = $value;
+ $field_values[$weight]['value'] = (string)$value;
+ $pattern[$weight] = "]*value=\"$value\" [^>]*";
+ }
+
+ // Press 'add more' button -> 4 widgets
+ $this->drupalPost(NULL, $edit, t('Add another item'));
+ ksort($values);
+ $values = array_values($values);
+ for ($delta = 0; $delta <= $delta_range; $delta++) {
+ $this->assertFieldByName("$this->field_name[$langcode][$delta][value]", $values[$delta], "Widget $delta is displayed and has the right value");
+ $this->assertFieldByName("$this->field_name[$langcode][$delta][_weight]", $delta, "Widget $delta has the right weight");
+ }
+ ksort($pattern);
+ $pattern = implode('.*', array_values($pattern));
+ $this->assertPattern("|$pattern|s", 'Widgets are displayed in the correct order');
+ $this->assertFieldByName("$this->field_name[$langcode][$delta][value]", '', "New widget is displayed");
+ $this->assertFieldByName("$this->field_name[$langcode][$delta][_weight]", $delta, "New widget has the right weight");
+ $this->assertNoField("$this->field_name[$langcode][" . ($delta + 1) . '][value]', 'No extraneous widget is displayed');
+
+ // Submit the form and create the entity.
+ $this->drupalPost(NULL, $edit, t('Save'));
+ preg_match('|test-entity/(\d+)/edit|', $this->url, $match);
+ $id = $match[1];
+ $this->assertRaw(t('test_entity @id has been created.', array('@id' => $id)), 'Entity was created');
+ $entity = field_test_entity_test_load($id);
+ ksort($field_values);
+ $field_values = array_values($field_values);
+ $this->assertIdentical($entity->{$this->field_name}[$langcode], $field_values, 'Field values were saved in the correct order');
+
+ // Display edit form: check that the expected number of widgets is
+ // displayed, with correct values change values, reorder, leave an empty
+ // value in the middle.
+ // Submit: check that the entity is updated with correct values
+ // Re-submit: check that the field can be emptied.
+
+ // Test with several multiple fields in a form
+ }
+
+ // Check with a multiple widget (implement a textfield with comma separated values).
+
+ // Check inaccessible fields are preserved on update.
+ // Check inaccessible fields get default value on insert (not implemented yet).
+
+ function testFieldFormJSAddMore() {
+ $this->field = $this->field_unlimited;
+ $this->field_name = $this->field['field_name'];
+ $this->instance['field_name'] = $this->field_name;
+ field_create_field($this->field);
+ field_create_instance($this->instance);
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Display creation form -> 1 widget.
+ $this->drupalGet('test-entity/add/test-bundle');
+
+ // Press 'add more' button a couple times -> 3 widgets.
+ // The drupalPostAhah() helper will not work iteratively, so we add those.
+ // through non-'JS' submission.
+ $this->drupalPost(NULL, array(), t('Add another item'));
+ $this->drupalPost(NULL, array(), t('Add another item'));
+
+ // Prepare values and weights.
+ $count = 3;
+ $delta_range = $count - 1;
+ $values = $weights = $pattern = $expected_values = $edit = array();
+ for ($delta = 0; $delta <= $delta_range; $delta++) {
+ // Assign unique random weights.
+ do {
+ $weight = mt_rand(-$delta_range, $delta_range);
+ } while (in_array($weight, $weights));
+ $weights[] = $weight;
+ $value = mt_rand(1, 127);
+ $edit["$this->field_name[$langcode][$delta][value]"] = $value;
+ $edit["$this->field_name[$langcode][$delta][_weight]"] = $weight;
+ // We'll need three slightly different formats to check the values.
+ $values[$weight] = $value;
+ $field_values[$weight]['value'] = (string)$value;
+ $pattern[$weight] = "]*value=\"$value\" [^>]*";
+ }
+ // Press 'add more' button through AHAH.
+ $this->_fieldPostAhah($edit, t('Add another item'));
+
+ ksort($values);
+ $values = array_values($values);
+ for ($delta = 0; $delta <= $delta_range; $delta++) {
+ $this->assertFieldByName("$this->field_name[$langcode][$delta][value]", $values[$delta], "Widget $delta is displayed and has the right value");
+ $this->assertFieldByName("$this->field_name[$langcode][$delta][_weight]", $delta, "Widget $delta has the right weight");
+ }
+ ksort($pattern);
+ $pattern = implode('.*', array_values($pattern));
+ $this->assertPattern("|$pattern|s", 'Widgets are displayed in the correct order');
+ $this->assertFieldByName("$this->field_name[$langcode][$delta][value]", '', "New widget is displayed");
+ $this->assertFieldByName("$this->field_name[$langcode][$delta][_weight]", $delta, "New widget has the right weight");
+ $this->assertNoField("$this->field_name[$langcode][" . ($delta + 1) . '][value]', 'No extraneous widget is displayed');
+ }
+
+ /**
+ * Tests fields with no 'edit' access.
+ */
+ function testFieldFormAccess() {
+ // Create a "regular" field.
+ $field = $this->field_single;
+ $field_name = $field['field_name'];
+ $instance = $this->instance;
+ $instance['field_name'] = $field_name;
+ field_create_field($field);
+ field_create_instance($instance);
+
+ // Create a field with no edit access - see field_test_field_access().
+ $field_no_access = array(
+ 'field_name' => 'field_no_edit_access',
+ 'type' => 'test_field',
+ );
+ $field_name_no_access = $field_no_access['field_name'];
+ $instance_no_access = array(
+ 'field_name' => $field_name_no_access,
+ 'object_type' => 'test_entity',
+ 'bundle' => 'test_bundle',
+ 'default_value' => array(0 => array('value' => 99)),
+ );
+ field_create_field($field_no_access);
+ field_create_instance($instance_no_access);
+
+ $langcode = FIELD_LANGUAGE_NONE;
+
+ // Display creation form.
+ $this->drupalGet('test-entity/add/test-bundle');
+ $this->assertNoFieldByName("{$field_name_no_access}[$langcode][0][value]", '', t('Widget is not displayed if field access is denied.'));
+
+ // Create entity.
+ $edit = array("{$field_name}[$langcode][0][value]" => 1);
+ $this->drupalPost(NULL, $edit, t('Save'));
+ preg_match('|test-entity/(\d+)/edit|', $this->url, $match);
+ $id = $match[1];
+
+ // Check that the default value was saved.
+ $entity = field_test_entity_test_load($id);
+ $this->assertEqual($entity->{$field_name_no_access}[$langcode][0]['value'], 99, t('Default value was saved for the field with no edit access.'));
+ $this->assertEqual($entity->{$field_name}[$langcode][0]['value'], 1, t('Entered value vas saved for the field with edit access.'));
+
+ // Create a new revision.
+ $edit = array("{$field_name}[$langcode][0][value]" => 2, 'revision' => TRUE);
+ $this->drupalPost('test-entity/' . $id . '/edit', $edit, t('Save'));
+
+ // Check that the new revision has the expected values.
+ $entity = field_test_entity_test_load($id);
+ $this->assertEqual($entity->{$field_name_no_access}[$langcode][0]['value'], 99, t('New revision has the expected value for the field with no edit access.'));
+ $this->assertEqual($entity->{$field_name}[$langcode][0]['value'], 2, t('New revision has the expected value for the field with edit access.'));
+
+ // Check that the revision is also saved in the revisions table.
+ $entity = field_test_entity_test_load($id, $entity->ftvid);
+ $this->assertEqual($entity->{$field_name_no_access}[$langcode][0]['value'], 99, t('New revision has the expected value for the field with no edit access.'));
+ $this->assertEqual($entity->{$field_name}[$langcode][0]['value'], 2, t('New revision has the expected value for the field with edit access.'));
+ }
+
+ /**
+ * Execute a POST request on a AHAH callback.
+ *
+ * Stolen from poll.test. The JSON result is parsed into HTML and placed in
+ * $this->content, so that regular asserts can be performed.
+ *
+ * Since the result is generally not a full-fledged form, this cannot be
+ * called iteratively.
+ */
+ function _fieldPostAhah($edit, $submit, array $options = array(), array $headers = array()) {
+ $this->additionalCurlOptions[CURLOPT_URL] = url('system/ajax', array('absolute' => TRUE));
+ $this->drupalPost(NULL, $edit, $submit);
+ unset($this->additionalCurlOptions[CURLOPT_URL]);
+
+ // The response is drupal_json_output, so we need to undo some escaping.
+ $commands = json_decode(str_replace(array('\x3c', '\x3e', '\x26'), array("<", ">", "&"), $this->drupalGetContent()));
+
+ // The JSON response will be two AJAX commands. The first is a settings
+ // command and the second is the replace command.
+ $settings = reset($commands);
+ $replace = next($commands);
+
+ $this->assertTrue(is_object($settings), t('The response settings command is an object'));
+ $this->assertTrue(is_object($replace), t('The response replace command is an object'));
+
+ // This response data is valid HTML so we will can reuse everything we have
+ // for HTML pages.
+ $this->content = $replace->data;
+
+ // Needs to be emptied out so the new content will be parsed.
+ $this->elements = '';
+ }
+}
+
+class FieldCrudTestCase extends FieldTestCase {
+ public static function getInfo() {
+ return array(
+ 'name' => 'Field CRUD tests',
+ 'description' => 'Test field create, read, update, and delete.',
+ 'group' => 'Field',
+ );
+ }
+
+ function setUp() {
+ // field_update_field() tests use number.module
+ parent::setUp('field_test', 'number');
+ }
+
+ // TODO : test creation with
+ // - a full fledged $field structure, check that all the values are there
+ // - a minimal $field structure, check all default values are set
+ // defer actual $field comparison to a helper function, used for the two cases above
+
+ /**
+ * Test the creation of a field.
+ */
+ function testCreateField() {
+ $field_definition = array(
+ 'field_name' => 'field_2',
+ 'type' => 'test_field',
+ );
+ field_test_memorize();
+ $field_definition = field_create_field($field_definition);
+ $mem = field_test_memorize();
+ $this->assertIdentical($mem['field_test_field_create_field'][0][0], $field_definition, 'hook_field_create_field() called with correct arguments.');
+
+ // Read the raw record from the {field_config_instance} table.
+ $result = db_query('SELECT * FROM {field_config} WHERE field_name = :field_name', array(':field_name' => $field_definition['field_name']));
+ $record = $result->fetchAssoc();
+ $record['data'] = unserialize($record['data']);
+
+ // Ensure that basic properties are preserved.
+ $this->assertEqual($record['field_name'], $field_definition['field_name'], t('The field name is properly saved.'));
+ $this->assertEqual($record['type'], $field_definition['type'], t('The field type is properly saved.'));
+
+ // Ensure that cardinality defaults to 1.
+ $this->assertEqual($record['cardinality'], 1, t('Cardinality defaults to 1.'));
+
+ // Ensure that default settings are present.
+ $field_type = field_info_field_types($field_definition['type']);
+ $this->assertIdentical($record['data']['settings'], $field_type['settings'], t('Default field settings have been written.'));
+
+ // Ensure that default storage was set.
+ $this->assertEqual($record['storage_type'], variable_get('field_storage_default'), t('The field type is properly saved.'));
+
+ // Guarantee that the name is unique.
+ try {
+ field_create_field($field_definition);
+ $this->fail(t('Cannot create two fields with the same name.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create two fields with the same name.'));
+ }
+
+ // Check that field type is required.
+ try {
+ $field_definition = array(
+ 'field_name' => 'field_1',
+ );
+ field_create_field($field_definition);
+ $this->fail(t('Cannot create a field with no type.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create a field with no type.'));
+ }
+
+ // Check that field name is required.
+ try {
+ $field_definition = array(
+ 'type' => 'test_field'
+ );
+ field_create_field($field_definition);
+ $this->fail(t('Cannot create an unnamed field.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create an unnamed field.'));
+ }
+
+ // Check that field name must start with a letter or _.
+ try {
+ $field_definition = array(
+ 'field_name' => '2field_2',
+ 'type' => 'test_field',
+ );
+ field_create_field($field_definition);
+ $this->fail(t('Cannot create a field with a name starting with a digit.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create a field with a name starting with a digit.'));
+ }
+
+ // Check that field name must only contain lowercase alphanumeric or _.
+ try {
+ $field_definition = array(
+ 'field_name' => 'field#_3',
+ 'type' => 'test_field',
+ );
+ field_create_field($field_definition);
+ $this->fail(t('Cannot create a field with a name containing an illegal character.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create a field with a name containing an illegal character.'));
+ }
+
+ // Check that field name cannot be longer than 32 characters long.
+ try {
+ $field_definition = array(
+ 'field_name' => '_12345678901234567890123456789012',
+ 'type' => 'test_field',
+ );
+ field_create_field($field_definition);
+ $this->fail(t('Cannot create a field with a name longer than 32 characters.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create a field with a name longer than 32 characters.'));
+ }
+
+ // Check that field name can not be an object key.
+ // "ftvid" is known as an object key from the "test_entity" type.
+ try {
+ $field_definition = array(
+ 'type' => 'test_field',
+ 'field_name' => 'ftvid',
+ );
+ $field = field_create_field($field_definition);
+ $this->fail(t('Cannot create a field bearing the name of an object key.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create a field bearing the name of an object key.'));
+ }
+ }
+
+ /**
+ * Test failure to create a field.
+ */
+ function testCreateFieldFail() {
+ $field_name = 'duplicate';
+ $field_definition = array('field_name' => $field_name, 'type' => 'test_field', 'storage' => array('type' => 'field_test_storage_failure'));
+ $query = db_select('field_config')->condition('field_name', $field_name)->countQuery();
+
+ // The field does not appear in field_config.
+ $count = $query->execute()->fetchField();
+ $this->assertEqual($count, 0, 'A field_config row for the field does not exist.');
+
+ // Try to create the field.
+ try {
+ $field = field_create_field($field_definition);
+ $this->assertTrue(FALSE, 'Field creation (correctly) fails.');
+ }
+ catch (Exception $e) {
+ $this->assertTrue(TRUE, 'Field creation (correctly) fails.');
+ }
+
+ // The field does not appear in field_config.
+ $count = $query->execute()->fetchField();
+ $this->assertEqual($count, 0, 'A field_config row for the field does not exist.');
+ }
+
+ /**
+ * Test reading back a field definition.
+ */
+ function testReadField() {
+ $field_definition = array(
+ 'field_name' => 'field_1',
+ 'type' => 'test_field',
+ );
+ field_create_field($field_definition);
+
+ // Read the field back.
+ $field = field_read_field($field_definition['field_name']);
+ $this->assertTrue($field_definition < $field, t('The field was properly read.'));
+ }
+
+ /**
+ * Test creation of indexes on data column.
+ */
+ function testFieldIndexes() {
+ // Check that indexes specified by the field type are used by default.
+ $field_definition = array(
+ 'field_name' => 'field_1',
+ 'type' => 'test_field',
+ );
+ field_create_field($field_definition);
+ $field = field_read_field($field_definition['field_name']);
+ $expected_indexes = array('value' => array('value'));
+ $this->assertEqual($field['indexes'], $expected_indexes, t('Field type indexes saved by default'));
+
+ // Check that indexes specified by the field definition override the field
+ // type indexes.
+ $field_definition = array(
+ 'field_name' => 'field_2',
+ 'type' => 'test_field',
+ 'indexes' => array(
+ 'value' => array(),
+ ),
+ );
+ field_create_field($field_definition);
+ $field = field_read_field($field_definition['field_name']);
+ $expected_indexes = array('value' => array());
+ $this->assertEqual($field['indexes'], $expected_indexes, t('Field definition indexes override field type indexes'));
+
+ // Check that indexes specified by the field definition add to the field
+ // type indexes.
+ $field_definition = array(
+ 'field_name' => 'field_3',
+ 'type' => 'test_field',
+ 'indexes' => array(
+ 'value_2' => array('value'),
+ ),
+ );
+ field_create_field($field_definition);
+ $field = field_read_field($field_definition['field_name']);
+ $expected_indexes = array('value' => array('value'), 'value_2' => array('value'));
+ $this->assertEqual($field['indexes'], $expected_indexes, t('Field definition indexes are merged with field type indexes'));
+ }
+
+ /**
+ * Test the deletion of a field.
+ */
+ function testDeleteField() {
+ // TODO: Also test deletion of the data stored in the field ?
+
+ // Create two fields (so we can test that only one is deleted).
+ $this->field = array('field_name' => 'field_1', 'type' => 'test_field');
+ field_create_field($this->field);
+ $this->another_field = array('field_name' => 'field_2', 'type' => 'test_field');
+ field_create_field($this->another_field);
+
+ // Create instances for each.
+ $this->instance_definition = array(
+ 'field_name' => $this->field['field_name'],
+ 'object_type' => 'test_entity',
+ 'bundle' => 'test_bundle',
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ ),
+ );
+ field_create_instance($this->instance_definition);
+ $this->another_instance_definition = $this->instance_definition;
+ $this->another_instance_definition['field_name'] = $this->another_field['field_name'];
+ field_create_instance($this->another_instance_definition);
+
+ // Test that the first field is not deleted, and then delete it.
+ $field = field_read_field($this->field['field_name'], array('include_deleted' => TRUE));
+ $this->assertTrue(!empty($field) && empty($field['deleted']), t('A new field is not marked for deletion.'));
+ field_delete_field($this->field['field_name']);
+
+ // Make sure that the field is marked as deleted when it is specifically
+ // loaded.
+ $field = field_read_field($this->field['field_name'], array('include_deleted' => TRUE));
+ $this->assertTrue(!empty($field['deleted']), t('A deleted field is marked for deletion.'));
+
+ // Make sure that this field's instance is marked as deleted when it is
+ // specifically loaded.
+ $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle'], array('include_deleted' => TRUE));
+ $this->assertTrue(!empty($instance['deleted']), t('An instance for a deleted field is marked for deletion.'));
+
+ // Try to load the field normally and make sure it does not show up.
+ $field = field_read_field($this->field['field_name']);
+ $this->assertTrue(empty($field), t('A deleted field is not loaded by default.'));
+
+ // Try to load the instance normally and make sure it does not show up.
+ $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertTrue(empty($instance), t('An instance for a deleted field is not loaded by default.'));
+
+ // Make sure the other field (and its field instance) are not deleted.
+ $another_field = field_read_field($this->another_field['field_name']);
+ $this->assertTrue(!empty($another_field) && empty($another_field['deleted']), t('A non-deleted field is not marked for deletion.'));
+ $another_instance = field_read_instance('test_entity', $this->another_instance_definition['field_name'], $this->another_instance_definition['bundle']);
+ $this->assertTrue(!empty($another_instance) && empty($another_instance['deleted']), t('An instance of a non-deleted field is not marked for deletion.'));
+
+ // Try to create a new field the same name as a deleted field and
+ // write data into it.
+ field_create_field($this->field);
+ field_create_instance($this->instance_definition);
+ $field = field_read_field($this->field['field_name']);
+ $this->assertTrue(!empty($field) && empty($field['deleted']), t('A new field with a previously used name is created.'));
+ $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertTrue(!empty($instance) && empty($instance['deleted']), t('A new instance for a previously used field name is created.'));
+
+ // Save an object with data for the field
+ $entity = field_test_create_stub_entity(0, 0, $instance['bundle']);
+ $langcode = FIELD_LANGUAGE_NONE;
+ $values[0]['value'] = mt_rand(1, 127);
+ $entity->{$field['field_name']}[$langcode] = $values;
+ $entity_type = 'test_entity';
+ field_attach_insert('test_entity', $entity);
+
+ // Verify the field is present on load
+ $entity = field_test_create_stub_entity(0, 0, $this->instance_definition['bundle']);
+ field_attach_load($entity_type, array(0 => $entity));
+ $this->assertIdentical(count($entity->{$field['field_name']}[$langcode]), count($values), "Data in previously deleted field saves and loads correctly");
+ foreach ($values as $delta => $value) {
+ $this->assertEqual($entity->{$field['field_name']}[$langcode][$delta]['value'], $values[$delta]['value'], "Data in previously deleted field saves and loads correctly");
+ }
+ }
+
+ function testUpdateNonExistentField() {
+ $test_field = array('field_name' => 'does_not_exist', 'type' => 'number_decimal');
+ try {
+ field_update_field($test_field);
+ $this->fail(t('Cannot update a field that does not exist.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot update a field that does not exist.'));
+ }
+ }
+
+ function testUpdateFieldType() {
+ $field = array('field_name' => 'field_type', 'type' => 'number_decimal');
+ $field = field_create_field($field);
+
+ $test_field = array('field_name' => 'field_type', 'type' => 'number_integer');
+ try {
+ field_update_field($test_field);
+ $this->fail(t('Cannot update a field to a different type.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot update a field to a different type.'));
+ }
+ }
+
+ /**
+ * Test updating a field.
+ */
+ function testUpdateField() {
+ // Create a decimal 5.2 field.
+ $field = array('field_name' => 'decimal53', 'type' => 'number_decimal', 'cardinality' => 3, 'settings' => array('precision' => 5, 'scale' => 2));
+ $field = field_create_field($field);
+ $instance = array('field_name' => 'decimal53', 'object_type' => 'test_entity', 'bundle' => 'test_bundle');
+ $instance = field_create_instance($instance);
+
+ // Update it to a deciaml 5.3 field.
+ $field['settings']['scale'] = 3;
+ field_update_field($field);
+
+ // Save values with 2, 3, and 4 decimal places.
+ $entity = field_test_create_stub_entity(0, 0, $instance['bundle']);
+ $entity->decimal53[FIELD_LANGUAGE_NONE][0]['value'] = '1.23';
+ $entity->decimal53[FIELD_LANGUAGE_NONE][1]['value'] = '1.235';
+ $entity->decimal53[FIELD_LANGUAGE_NONE][2]['value'] = '1.2355';
+ field_attach_insert('test_entity', $entity);
+ $entity = field_test_create_stub_entity(0, 0, $instance['bundle']);
+
+ // Verify that the updated 5.3 field rounds to 3 decimal places.
+ field_attach_load('test_entity', array(0 => $entity));
+ $this->assertEqual($entity->decimal53[FIELD_LANGUAGE_NONE][0]['value'], '1.23', t('2 decimal places are left alone'));
+ $this->assertEqual($entity->decimal53[FIELD_LANGUAGE_NONE][1]['value'], '1.235', t('3 decimal places are left alone'));
+ $this->assertEqual($entity->decimal53[FIELD_LANGUAGE_NONE][2]['value'], '1.236', t('4 decimal places are rounded to 3'));
+ }
+
+ /**
+ * Test field type modules forbidding an update.
+ */
+ function testUpdateFieldForbid() {
+ $field = array('field_name' => 'forbidden', 'type' => 'test_field', 'settings' => array('changeable' => 0, 'unchangeable' => 0));
+ $field = field_create_field($field);
+ $field['settings']['changeable']++;
+ try {
+ field_update_field($field);
+ $this->pass(t("A changeable setting can be updated."));
+ }
+ catch (FieldException $e) {
+ $this->fail(t("An unchangeable setting cannot be updated."));
+ }
+ $field['settings']['unchangeable']++;
+ try {
+ field_update_field($field);
+ $this->fail(t("An unchangeable setting can be updated."));
+ }
+ catch (FieldException $e) {
+ $this->pass(t("An unchangeable setting cannot be updated."));
+ }
+ }
+
+ /**
+ * Test that fields are properly marked active or inactive.
+ */
+ function testActive() {
+ $field_definition = array(
+ 'field_name' => 'field_1',
+ 'type' => 'test_field',
+ // For this test, we need a storage backend provided by a different
+ // module than field_test.module.
+ 'storage' => array(
+ 'type' => 'field_sql_storage',
+ ),
+ );
+ field_create_field($field_definition);
+
+ // Test disabling and enabling:
+ // - the field type module,
+ // - the storage module,
+ // - both.
+ $this->_testActiveHelper($field_definition, array('field_test'));
+ $this->_testActiveHelper($field_definition, array('field_sql_storage'));
+ $this->_testActiveHelper($field_definition, array('field_test', 'field_sql_storage'));
+ }
+
+ /**
+ * Helper function for testActive().
+ *
+ * Test dependency between a field and a set of modules.
+ *
+ * @param $field_definition
+ * A field definition.
+ * @param $modules
+ * An aray of module names. The field will be tested to be inactive as long
+ * as any of those modules is disabled.
+ */
+ function _testActiveHelper($field_definition, $modules) {
+ $field_name = $field_definition['field_name'];
+
+ // Read the field.
+ $field = field_read_field($field_name);
+ $this->assertTrue($field_definition <= $field, t('The field was properly read.'));
+
+ module_disable($modules);
+
+ $fields = field_read_fields(array('field_name' => $field_name), array('include_inactive' => TRUE));
+ $this->assertTrue(isset($fields[$field_name]) && $field_definition < $field, t('The field is properly read when explicitly fetching inactive fields.'));
+
+ // Re-enable modules one by one, and check that the field is still inactive
+ // while some modules remain disabled.
+ while ($modules) {
+ $field = field_read_field($field_name);
+ $this->assertTrue(empty($field), t('%modules disabled. The field is marked inactive.', array('%modules' => implode(', ', $modules))));
+
+ $module = array_shift($modules);
+ module_enable(array($module));
+ }
+
+ // Check that the field is active again after all modules have been
+ // enabled.
+ $field = field_read_field($field_name);
+ $this->assertTrue($field_definition <= $field, t('The field was was marked active.'));
+ }
+}
+
+class FieldInstanceCrudTestCase extends FieldTestCase {
+ protected $field;
+
+ public static function getInfo() {
+ return array(
+ 'name' => 'Field instance CRUD tests',
+ 'description' => 'Create field entities by attaching fields to entities.',
+ 'group' => 'Field',
+ );
+ }
+
+ function setUp() {
+ parent::setUp('field_test');
+
+ $this->field = array(
+ 'field_name' => drupal_strtolower($this->randomName()),
+ 'type' => 'test_field',
+ );
+ field_create_field($this->field);
+ $this->instance_definition = array(
+ 'field_name' => $this->field['field_name'],
+ 'object_type' => 'test_entity',
+ 'object_type' => 'test_entity',
+ 'bundle' => 'test_bundle',
+ );
+ }
+
+ // TODO : test creation with
+ // - a full fledged $instance structure, check that all the values are there
+ // - a minimal $instance structure, check all default values are set
+ // defer actual $instance comparison to a helper function, used for the two cases above,
+ // and for testUpdateFieldInstance
+
+ /**
+ * Test the creation of a field instance.
+ */
+ function testCreateFieldInstance() {
+ field_create_instance($this->instance_definition);
+
+ // Read the raw record from the {field_config_instance} table.
+ $result = db_query('SELECT * FROM {field_config_instance} WHERE field_name = :field_name AND bundle = :bundle', array(':field_name' => $this->instance_definition['field_name'], ':bundle' => $this->instance_definition['bundle']));
+ $record = $result->fetchAssoc();
+ $record['data'] = unserialize($record['data']);
+
+ $field_type = field_info_field_types($this->field['type']);
+ $widget_type = field_info_widget_types($field_type['default_widget']);
+ $formatter_type = field_info_formatter_types($field_type['default_formatter']);
+
+ // Check that default values are set.
+ $this->assertIdentical($record['data']['required'], FALSE, t('Required defaults to false.'));
+ $this->assertIdentical($record['data']['label'], $this->instance_definition['field_name'], t('Label defaults to field name.'));
+ $this->assertIdentical($record['data']['description'], '', t('Description defaults to empty string.'));
+ $this->assertIdentical($record['data']['widget']['type'], $field_type['default_widget'], t('Default widget has been written.'));
+ $this->assertTrue(isset($record['data']['display']['full']), t('Display for "full" build_mode has been written.'));
+ $this->assertIdentical($record['data']['display']['full']['type'], $field_type['default_formatter'], t('Default formatter for "full" build_mode has been written.'));
+
+ // Check that default settings are set.
+ $this->assertIdentical($record['data']['settings'], $field_type['instance_settings'] , t('Default instance settings have been written.'));
+ $this->assertIdentical($record['data']['widget']['settings'], $widget_type['settings'] , t('Default widget settings have been written.'));
+ $this->assertIdentical($record['data']['display']['full']['settings'], $formatter_type['settings'], t('Default formatter settings for "full" build_mode have been written.'));
+
+ // Guarantee that the field/bundle combination is unique.
+ try {
+ field_create_instance($this->instance_definition);
+ $this->fail(t('Cannot create two instances with the same field / bundle combination.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create two instances with the same field / bundle combination.'));
+ }
+
+ // Check that the specified field exists.
+ try {
+ $this->instance_definition['field_name'] = $this->randomName();
+ field_create_instance($this->instance_definition);
+ $this->fail(t('Cannot create an instance of a non-existing field.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create an instance of a non-existing field.'));
+ }
+
+ // TODO: test other failures.
+ }
+
+ /**
+ * Test reading back an instance definition.
+ */
+ function testReadFieldInstance() {
+ field_create_instance($this->instance_definition);
+
+ // Read the instance back.
+ $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertTrue($this->instance_definition < $instance, t('The field was properly read.'));
+ }
+
+ /**
+ * Test the update of a field instance.
+ */
+ function testUpdateFieldInstance() {
+ field_create_instance($this->instance_definition);
+ $field_type = field_info_field_types($this->field['type']);
+
+ // Check that basic changes are saved.
+ $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $instance['required'] = !$instance['required'];
+ $instance['label'] = $this->randomName();
+ $instance['description'] = $this->randomName();
+ $instance['settings']['test_instance_setting'] = $this->randomName();
+ $instance['widget']['settings']['test_widget_setting'] =$this->randomName();
+ $instance['widget']['weight']++;
+ $instance['display']['full']['settings']['test_formatter_setting'] = $this->randomName();
+ $instance['display']['full']['weight']++;
+ field_update_instance($instance);
+
+ $instance_new = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertEqual($instance['required'], $instance_new['required'], t('"required" change is saved'));
+ $this->assertEqual($instance['label'], $instance_new['label'], t('"label" change is saved'));
+ $this->assertEqual($instance['description'], $instance_new['description'], t('"description" change is saved'));
+ $this->assertEqual($instance['widget']['settings']['test_widget_setting'], $instance_new['widget']['settings']['test_widget_setting'], t('Widget setting change is saved'));
+ $this->assertEqual($instance['widget']['weight'], $instance_new['widget']['weight'], t('Widget weight change is saved'));
+ $this->assertEqual($instance['display']['full']['settings']['test_formatter_setting'], $instance_new['display']['full']['settings']['test_formatter_setting'], t('Formatter setting change is saved'));
+ $this->assertEqual($instance['display']['full']['weight'], $instance_new['display']['full']['weight'], t('Widget weight change is saved'));
+
+ // Check that changing widget and formatter types updates the default settings.
+ $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $instance['widget']['type'] = 'test_field_widget_multiple';
+ $instance['display']['full']['type'] = 'field_test_multiple';
+ field_update_instance($instance);
+
+ $instance_new = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertEqual($instance['widget']['type'], $instance_new['widget']['type'] , t('Widget type change is saved.'));
+ $settings = field_info_widget_settings($instance_new['widget']['type']);
+ $this->assertIdentical($settings, array_intersect_key($instance_new['widget']['settings'], $settings) , t('Widget type change updates default settings.'));
+ $this->assertEqual($instance['display']['full']['type'], $instance_new['display']['full']['type'] , t('Formatter type change is saved.'));
+ $info = field_info_formatter_types($instance_new['display']['full']['type']);
+ $settings = $info['settings'];
+ $this->assertIdentical($settings, array_intersect_key($instance_new['display']['full']['settings'], $settings) , t('Changing formatter type updates default settings.'));
+
+ // Check that adding a new build mode is saved and gets default settings.
+ $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $instance['display']['teaser'] = array();
+ field_update_instance($instance);
+
+ $instance_new = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertTrue(isset($instance_new['display']['teaser']), t('Display for the new build_mode has been written.'));
+ $this->assertIdentical($instance_new['display']['teaser']['type'], $field_type['default_formatter'], t('Default formatter for the new build_mode has been written.'));
+ $info = field_info_formatter_types($instance_new['display']['teaser']['type']);
+ $settings = $info['settings'];
+ $this->assertIdentical($settings, $instance_new['display']['teaser']['settings'] , t('Default formatter settings for the new build_mode have been written.'));
+
+ // TODO: test failures.
+ }
+
+ /**
+ * Test the deletion of a field instance.
+ */
+ function testDeleteFieldInstance() {
+ // TODO: Test deletion of the data stored in the field also.
+ // Need to check that data for a 'deleted' field / instance doesn't get loaded
+ // Need to check data marked deleted is cleaned on cron (not implemented yet...)
+
+ // Create two instances for the same field so we can test that only one
+ // is deleted.
+ field_create_instance($this->instance_definition);
+ $this->another_instance_definition = $this->instance_definition;
+ $this->another_instance_definition['bundle'] .= '_another_bundle';
+ $instance = field_create_instance($this->another_instance_definition);
+
+ // Test that the first instance is not deleted, and then delete it.
+ $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle'], array('include_deleted' => TRUE));
+ $this->assertTrue(!empty($instance) && empty($instance['deleted']), t('A new field instance is not marked for deletion.'));
+ field_delete_instance($instance);
+
+ // Make sure the instance is marked as deleted when the instance is
+ // specifically loaded.
+ $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle'], array('include_deleted' => TRUE));
+ $this->assertTrue(!empty($instance['deleted']), t('A deleted field instance is marked for deletion.'));
+
+ // Try to load the instance normally and make sure it does not show up.
+ $instance = field_read_instance('test_entity', $this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertTrue(empty($instance), t('A deleted field instance is not loaded by default.'));
+
+ // Make sure the other field instance is not deleted.
+ $another_instance = field_read_instance('test_entity', $this->another_instance_definition['field_name'], $this->another_instance_definition['bundle']);
+ $this->assertTrue(!empty($another_instance) && empty($another_instance['deleted']), t('A non-deleted field instance is not marked for deletion.'));
+ }
+}
+
+/**
+ * Unit test class for the multilanguage fields logic.
+ *
+ * The following tests will check the multilanguage logic of _field_invoke() and
+ * that only the correct values are returned by
+ * field_multilingual_available_languages().
+ */
+class FieldTranslationsTestCase extends FieldTestCase {
+ public static function getInfo() {
+ return array(
+ 'name' => 'Field translations tests',
+ 'description' => 'Test multilanguage fields logic.',
+ 'group' => 'Field',
+ );
+ }
+
+ function setUp() {
+ parent::setUp('locale', 'field_test');
+
+ $this->field_name = drupal_strtolower($this->randomName() . '_field_name');
+
+ $this->obj_type = 'test_entity';
+
+ $field = array(
+ 'field_name' => $this->field_name,
+ 'type' => 'test_field',
+ 'cardinality' => 4,
+ 'translatable' => TRUE,
+ 'settings' => array(
+ 'test_hook_in' => FALSE,
+ ),
+ );
+ field_create_field($field);
+ $this->field = field_read_field($this->field_name);
+
+ $instance = array(
+ 'field_name' => $this->field_name,
+ 'object_type' => $this->obj_type,
+ 'bundle' => 'test_bundle',
+ 'label' => $this->randomName() . '_label',
+ 'description' => $this->randomName() . '_description',
+ 'weight' => mt_rand(0, 127),
+ 'settings' => array(
+ 'test_instance_setting' => $this->randomName(),
+ ),
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ 'label' => 'Test Field',
+ 'settings' => array(
+ 'test_widget_setting' => $this->randomName(),
+ ),
+ ),
+ );
+ field_create_instance($instance);
+ $this->instance = field_read_instance('test_entity', $this->field_name, 'test_bundle');
+
+ for ($i = 0; $i < 3; ++$i) {
+ locale_inc_callback('locale_add_language', 'l' . $i, $this->randomString(), $this->randomString());
+ }
+ }
+
+ /**
+ * Ensure that only valid values are returned by field_multilingual_available_languages().
+ */
+ function testFieldAvailableLanguages() {
+ // Test 'translatable' fieldable info.
+ field_test_entity_info_translatable('test_entity', FALSE);
+ $field = $this->field;
+ $field['field_name'] .= '_untranslatable';
+ $langcode = language_default();
+ $suggested_languages = array($langcode->language);
+ $available_languages = field_multilingual_available_languages($this->obj_type, $field, $suggested_languages);
+ $this->assertTrue(count($available_languages) == 1 && $available_languages[0] === FIELD_LANGUAGE_NONE, t('Untranslatable entity: suggested language ignored.'));
+
+ // Enable field translations for the entity.
+ field_test_entity_info_translatable('test_entity', TRUE);
+
+ // Test hook_field_languages() invocation on a translatable field.
+ $this->field['settings']['test_hook_in'] = TRUE;
+ $enabled_languages = array_keys(language_list());
+ $available_languages = field_multilingual_available_languages($this->obj_type, $this->field);
+ $this->assertTrue(in_array(FIELD_LANGUAGE_NONE, $available_languages), t('%language is an available language.', array('%language' => FIELD_LANGUAGE_NONE)));
+ foreach ($available_languages as $delta => $langcode) {
+ if ($langcode != FIELD_LANGUAGE_NONE) {
+ $this->assertTrue(in_array($langcode, $enabled_languages), t('%language is an enabled language.', array('%language' => $langcode)));
+ }
+ }
+ $this->assertFalse(in_array('xx', $available_languages), t('No invalid language was made available.'));
+ $this->assertTrue(count($available_languages) == count($enabled_languages), t('An enabled language was successfully made unavailable.'));
+
+ // Test field_multilingual_available_languages() behavior for untranslatable fields.
+ $this->field['translatable'] = FALSE;
+ $this->field_name = $this->field['field_name'] = $this->instance['field_name'] = drupal_strtolower($this->randomName() . '_field_name');
+ $available_languages = field_multilingual_available_languages($this->obj_type, $this->field);
+ $this->assertTrue(count($available_languages) == 1 && $available_languages[0] === FIELD_LANGUAGE_NONE, t('For untranslatable fields only neutral language is available.'));
+
+ // Test language suggestions.
+ $this->field['settings']['test_hook_in'] = FALSE;
+ $this->field['translatable'] = TRUE;
+ $this->field_name = $this->field['field_name'] = $this->instance['field_name'] = drupal_strtolower($this->randomName() . '_field_name');
+ $suggested_languages = array();
+ $lang_count = mt_rand(1, count($enabled_languages) - 1);
+ for ($i = 0; $i < $lang_count; ++$i) {
+ do {
+ $langcode = $enabled_languages[mt_rand(0, $lang_count)];
+ }
+ while (in_array($langcode, $suggested_languages));
+ $suggested_languages[] = $langcode;
+ }
+
+ $available_languages = field_multilingual_available_languages($this->obj_type, $this->field, $suggested_languages);
+ $this->assertEqual(count($available_languages), count($suggested_languages), t('Suggested languages were successfully made available.'));
+ foreach ($available_languages as $langcode) {
+ $this->assertTrue(in_array($langcode, $available_languages), t('Suggested language %language is available.', array('%language' => $langcode)));
+ }
+
+ $this->field_name = $this->field['field_name'] = $this->instance['field_name'] = drupal_strtolower($this->randomName() . '_field_name');
+ $suggested_languages = array('xx');
+ $available_languages = field_multilingual_available_languages($this->obj_type, $this->field, $suggested_languages);
+ $this->assertTrue(empty($available_languages), t('An invalid suggested language was not made available.'));
+ }
+
+ /**
+ * Test the multilanguage logic of _field_invoke().
+ */
+ function testFieldInvoke() {
+ $entity_type = 'test_entity';
+ $entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
+
+ // Populate some extra languages to check if _field_invoke() correctly uses
+ // the result of field_multilingual_available_languages().
+ $values = array();
+ $extra_languages = mt_rand(1, 4);
+ $languages = $available_languages = field_multilingual_available_languages($this->obj_type, $this->field);
+ for ($i = 0; $i < $extra_languages; ++$i) {
+ $languages[] = $this->randomString(2);
+ }
+
+ // For each given language provide some random values.
+ foreach ($languages as $langcode) {
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$langcode][$delta]['value'] = mt_rand(1, 127);
+ }
+ }
+ $entity->{$this->field_name} = $values;
+
+ $results = _field_invoke('test_op', $entity_type, $entity);
+ foreach ($results as $langcode => $result) {
+ $hash = md5(serialize(array($entity_type, $entity, $this->field_name, $langcode, $values[$langcode])));
+ // Check whether the parameters passed to _field_invoke() were correctly
+ // forwarded to the callback function.
+ $this->assertEqual($hash, $result, t('The result for %language is correctly stored.', array('%language' => $langcode)));
+ }
+ $this->assertEqual(count($results), count($available_languages), t('No unavailable language has been processed.'));
+ }
+
+ /**
+ * Test the multilanguage logic of _field_invoke_multiple().
+ */
+ function testFieldInvokeMultiple() {
+ $values = array();
+ $entities = array();
+ $entity_type = 'test_entity';
+ $entity_count = mt_rand(1, 5);
+ $available_languages = field_multilingual_available_languages($this->obj_type, $this->field);
+
+ for ($id = 1; $id <= $entity_count; ++$id) {
+ $entity = field_test_create_stub_entity($id, $id, $this->instance['bundle']);
+ $languages = $available_languages;
+
+ // Populate some extra languages to check whether _field_invoke()
+ // correctly uses the result of field_multilingual_available_languages().
+ $extra_languages = mt_rand(1, 4);
+ for ($i = 0; $i < $extra_languages; ++$i) {
+ $languages[] = $this->randomString(2);
+ }
+
+ // For each given language provide some random values.
+ foreach ($languages as $langcode) {
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$id][$langcode][$delta]['value'] = mt_rand(1, 127);
+ }
+ }
+ $entity->{$this->field_name} = $values[$id];
+ $entities[$id] = $entity;
+ }
+
+ $grouped_results = _field_invoke_multiple('test_op_multiple', $entity_type, $entities);
+ foreach ($grouped_results as $id => $results) {
+ foreach ($results as $langcode => $result) {
+ $hash = md5(serialize(array($entity_type, $entities[$id], $this->field_name, $langcode, $values[$id][$langcode])));
+ // Check whether the parameters passed to _field_invoke() were correctly
+ // forwarded to the callback function.
+ $this->assertEqual($hash, $result, t('The result for object %id/%language is correctly stored.', array('%id' => $id, '%language' => $langcode)));
+ }
+ $this->assertEqual(count($results), count($available_languages), t('No unavailable language has been processed for object %id.', array('%id' => $id)));
+ }
+ }
+
+ /**
+ * Test translatable fields storage/retrieval.
+ */
+ function testTranslatableFieldSaveLoad() {
+ // Enable field translations for nodes.
+ field_test_entity_info_translatable('node', TRUE);
+ $obj_info = entity_get_info('node');
+ $this->assertTrue(count($obj_info['translation']), t('Nodes are translatable.'));
+
+ // Prepare the field translations.
+ $eid = $evid = 1;
+ $obj_type = 'test_entity';
+ $object = field_test_create_stub_entity($eid, $evid, $this->instance['bundle']);
+ $field_translations = array();
+ $available_languages = field_multilingual_available_languages($obj_type, $this->field);
+ $this->assertTrue(count($available_languages) > 1, t('Field is translatable.'));
+ foreach ($available_languages as $langcode) {
+ $field_translations[$langcode] = $this->_generateTestFieldValues($this->field['cardinality']);
+ }
+
+ // Save and reload the field translations.
+ $object->{$this->field_name} = $field_translations;
+ field_attach_insert($obj_type, $object);
+ unset($object->{$this->field_name});
+ field_attach_load($obj_type, array($eid => $object));
+
+ // Check if the correct values were saved/loaded.
+ foreach ($field_translations as $langcode => $items) {
+ $result = TRUE;
+ foreach ($items as $delta => $item) {
+ $result = $result && $item['value'] == $object->{$this->field_name}[$langcode][$delta]['value'];
+ }
+ $this->assertTrue($result, t('%language translation correctly handled.', array('%language' => $langcode)));
+ }
+ }
+}
+
+/**
+ * Unit test class for field bulk delete and batch purge functionality.
+ */
+class FieldBulkDeleteTestCase extends FieldTestCase {
+ protected $field;
+
+ public static function getInfo() {
+ return array(
+ 'name' => 'Field bulk delete tests',
+ 'description'=> 'Bulk delete fields and instances, and clean up afterwards.',
+ 'group' => 'Field',
+ );
+ }
+
+ /**
+ * Convenience function for Field API tests.
+ *
+ * Given an array of potentially fully-populated objects and an
+ * optional field name, generate an array of stub objects of the
+ * same fieldable type which contains the data for the field name
+ * (if given).
+ *
+ * @param $obj_type
+ * The entity type of $objects.
+ * @param $objects
+ * An array of objects of type $obj_type.
+ * @param $field_name
+ * Optional; a field name whose data should be copied from
+ * $objects into the returned stub objects.
+ * @return
+ * An array of stub objects corresponding to $objects.
+ */
+ function _generateStubObjects($obj_type, $objects, $field_name = NULL) {
+ $stubs = array();
+ foreach ($objects as $obj) {
+ $stub = entity_create_stub_entity($obj_type, entity_extract_ids($obj_type, $obj));
+ if (isset($field_name)) {
+ $stub->{$field_name} = $obj->{$field_name};
+ }
+ $stubs[] = $stub;
+ }
+ return $stubs;
+ }
+
+ function setUp() {
+ parent::setUp('field_test');
+
+ // Clean up data from previous test cases.
+ $this->fields = array();
+ $this->instances = array();
+
+ // Create two bundles.
+ $this->bundles = array('bb_1' => 'bb_1', 'bb_2' => 'bb_2');
+ foreach ($this->bundles as $name => $desc) {
+ field_test_create_bundle($name, $desc);
+ }
+
+ // Create two fields.
+ $field = array('field_name' => 'bf_1', 'type' => 'test_field', 'cardinality' => 1);
+ $this->fields[] = field_create_field($field);
+ $field = array('field_name' => 'bf_2', 'type' => 'test_field', 'cardinality' => 4);
+ $this->fields[] = field_create_field($field);
+
+ // For each bundle, create an instance of each field, and 10
+ // objects with values for each field.
+ $id = 0;
+ $this->entity_type = 'test_entity';
+ foreach ($this->bundles as $bundle) {
+ foreach ($this->fields as $field) {
+ $instance = array(
+ 'field_name' => $field['field_name'],
+ 'object_type' => $this->entity_type,
+ 'bundle' => $bundle,
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ )
+ );
+ $this->instances[] = field_create_instance($instance);
+ }
+
+ for ($i = 0; $i < 10; $i++) {
+ $entity = field_test_create_stub_entity($id, $id, $bundle);
+ foreach ($this->fields as $field) {
+ $entity->{$field['field_name']}[FIELD_LANGUAGE_NONE] = $this->_generateTestFieldValues($field['cardinality']);
+ }
+ $this->entities[$id] = $entity;
+ field_attach_insert($this->entity_type, $entity);
+ $id++;
+ }
+ }
+ }
+
+ /**
+ * Verify that deleting an instance leaves the field data items in
+ * the database and that the appropriate Field API functions can
+ * operate on the deleted data and instance.
+ *
+ * This tests how field_attach_query() interacts with
+ * field_delete_instance() and could be moved to FieldCrudTestCase,
+ * but depends on this class's setUp().
+ */
+ function testDeleteFieldInstance() {
+ $bundle = reset($this->bundles);
+ $field = reset($this->fields);
+
+ // There are 10 objects of this bundle.
+ $found = field_attach_query($field['id'], array(array('bundle', $bundle)), array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertEqual(count($found['test_entity']), 10, 'Correct number of objects found before deleting');
+
+ // Delete the instance.
+ $instance = field_info_instance($this->entity_type, $field['field_name'], $bundle);
+ field_delete_instance($instance);
+
+ // The instance still exists, deleted.
+ $instances = field_read_instances(array('field_id' => $field['id'], 'deleted' => 1), array('include_deleted' => 1, 'include_inactive' => 1));
+ $this->assertEqual(count($instances), 1, 'There is one deleted instance');
+ $this->assertEqual($instances[0]['bundle'], $bundle, 'The deleted instance is for the correct bundle');
+
+ // There are 0 objects of this bundle with non-deleted data.
+ $found = field_attach_query($field['id'], array(array('bundle', $bundle)), array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertTrue(!isset($found['test_entity']), 'No objects found after deleting');
+
+ // There are 10 objects of this bundle when deleted fields are allowed, and
+ // their values are correct.
+ $found = field_attach_query($field['id'], array(array('bundle', $bundle), array('deleted', 1)), array('limit' => FIELD_QUERY_NO_LIMIT));
+ field_attach_load($this->entity_type, $found[$this->entity_type], FIELD_LOAD_CURRENT, array('field_id' => $field['id'], 'deleted' => 1));
+ $this->assertEqual(count($found['test_entity']), 10, 'Correct number of objects found after deleting');
+ foreach ($found['test_entity'] as $id => $obj) {
+ $this->assertEqual($this->entities[$id]->{$field['field_name']}, $obj->{$field['field_name']}, "Object $id with deleted data loaded correctly");
+ }
+ }
+
+ /**
+ * Verify that field data items and instances are purged when an
+ * instance is deleted.
+ */
+ function testPurgeInstance() {
+ field_test_memorize();
+
+ $bundle = reset($this->bundles);
+ $field = reset($this->fields);
+
+ // Delete the instance.
+ $instance = field_info_instance($this->entity_type, $field['field_name'], $bundle);
+ field_delete_instance($instance);
+
+ // No field hooks were called.
+ $mem = field_test_memorize();
+ $this->assertEqual(count($mem), 0, 'No field hooks were called');
+
+ $batch_size = 2;
+ for ($count = 8; $count >= 0; $count -= 2) {
+ // Purge two objects.
+ field_purge_batch($batch_size);
+
+ // There are $count deleted objects left.
+ $found = field_attach_query($field['id'], array(array('bundle', $bundle), array('deleted', 1)), array('limit' => FIELD_QUERY_NO_LIMIT));
+ $this->assertEqual($count ? count($found['test_entity']) : count($found), $count, 'Correct number of objects found after purging 2');
+ }
+
+ // hook_field_delete() was called on a pseudo-object for each object. Each
+ // pseudo object has a $field property that matches the original object,
+ // but no others.
+ $mem = field_test_memorize();
+ $this->assertEqual(count($mem['field_test_field_delete']), 10, 'hook_field_delete was called for the right number of objects');
+ $stubs = $this->_generateStubObjects($this->entity_type, $this->entities, $field['field_name']);
+ $count = count($stubs);
+ foreach ($mem['field_test_field_delete'] as $args) {
+ $obj = $args[1];
+ $this->assertEqual($stubs[$obj->ftid], $obj, 'hook_field_delete() called with the correct stub');
+ unset($stubs[$obj->ftid]);
+ }
+ $this->assertEqual(count($stubs), $count-10, 'hook_field_delete was called with each object once');
+
+ // The instance still exists, deleted.
+ $instances = field_read_instances(array('field_id' => $field['id'], 'deleted' => 1), array('include_deleted' => 1, 'include_inactive' => 1));
+ $this->assertEqual(count($instances), 1, 'There is one deleted instance');
+
+ // Purge the instance.
+ field_purge_batch($batch_size);
+
+ // The instance is gone.
+ $instances = field_read_instances(array('field_id' => $field['id'], 'deleted' => 1), array('include_deleted' => 1, 'include_inactive' => 1));
+ $this->assertEqual(count($instances), 0, 'The instance is gone');
+
+ // The field still exists, not deleted, because it has a second instance.
+ $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1, 'include_inactive' => 1));
+ $this->assertTrue(isset($fields[$field['id']]), 'The field exists and is not deleted');
+ }
+
+ /**
+ * Verify that fields are preserved and purged correctly as multiple
+ * instances are deleted and purged.
+ */
+ function testPurgeField() {
+ $field = reset($this->fields);
+
+ foreach ($this->bundles as $bundle) {
+ // Delete the instance.
+ $instance = field_info_instance($this->entity_type, $field['field_name'], $bundle);
+ field_delete_instance($instance);
+
+ // Purge the data.
+ field_purge_batch(10);
+
+ // Purge again to purge the instance.
+ field_purge_batch(0);
+
+ // The field still exists, not deleted, because it was never deleted.
+ $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1, 'include_inactive' => 1));
+ $this->assertTrue(isset($fields[$field['id']]), 'The field exists and is not deleted');
+ }
+
+ // Delete the field.
+ field_delete_field($field['field_name']);
+
+ // The field still exists, deleted.
+ $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1, 'include_inactive' => 1));
+ $this->assertEqual($fields[$field['id']]['deleted'], 1, 'The field exists and is deleted');
+
+ // Purge the field.
+ field_purge_batch(0);
+
+ // The field is gone.
+ $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1, 'include_inactive' => 1));
+ $this->assertEqual(count($fields), 0, 'The field is purged.');
+ }
+}
Index: modules/field/tests/field_test.storage.inc
===================================================================
RCS file: modules/field/tests/field_test.storage.inc
diff -N modules/field/tests/field_test.storage.inc
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ modules/field/tests/field_test.storage.inc 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,475 @@
+ array(
+ 'label' => t('Test storage'),
+ 'description' => t('Dummy test storage backend. Stores field values in the variable table.'),
+ ),
+ 'field_test_storage_failure' => array(
+ 'label' => t('Test storage failure'),
+ 'description' => t('Dummy test storage backend. Always fails to create fields.'),
+ ),
+ );
+}
+
+/**
+ * Implements hook_field_storage_details().
+ */
+function field_test_field_storage_details($field, $instance) {
+ $details = array();
+
+ // Add field columns.
+ $columns = array();
+ foreach ((array) $field['columns'] as $column_name => $attributes) {
+ $columns[$column_name] = $column_name;
+ }
+ return array(
+ 'drupal_variables' => array(
+ 'field_test_storage_data[FIELD_LOAD_CURRENT]' => $columns,
+ 'field_test_storage_data[FIELD_LOAD_REVISION]' => $columns,
+ ),
+ );
+}
+
+/**
+ * Implements hook_field_storage_details_alter().
+ *
+ * @see FieldAttachStorageTestCase::testFieldStorageDetailsAlter()
+ */
+function field_test_field_storage_details_alter(&$details, $field, $instance) {
+
+ // For testing, storage details are changed only because of the field name.
+ if ($field['field_name'] == 'field_test_change_my_details') {
+ $columns = array();
+ foreach ((array) $field['columns'] as $column_name => $attributes) {
+ $columns[$column_name] = $column_name;
+ }
+ $details['drupal_variables'] = array(
+ FIELD_LOAD_CURRENT => array(
+ 'moon' => $columns,
+ ),
+ FIELD_LOAD_REVISION => array(
+ 'mars' => $columns,
+ ),
+ );
+ }
+}
+
+/**
+ * Helper function: stores or retrieves data from the 'storage backend'.
+ */
+function _field_test_storage_data($data = NULL) {
+ if (is_null($data)) {
+ return variable_get('field_test_storage_data', array());
+ }
+ else {
+ variable_set('field_test_storage_data', $data);
+ }
+}
+
+/**
+ * Implements hook_field_storage_load().
+ */
+function field_test_field_storage_load($obj_type, $objects, $age, $fields, $options) {
+ $data = _field_test_storage_data();
+
+ $load_current = $age == FIELD_LOAD_CURRENT;
+
+ foreach ($fields as $field_id => $ids) {
+ $field = field_info_field_by_id($field_id);
+ $field_name = $field['field_name'];
+ $field_data = $data[$field['id']];
+ $sub_table = $load_current ? 'current' : 'revisions';
+ $delta_count = array();
+ foreach ($field_data[$sub_table] as $row) {
+ if ($row->type == $obj_type && (!$row->deleted || $options['deleted'])) {
+ if (($load_current && in_array($row->entity_id, $ids)) || (!$load_current && in_array($row->revision_id, $ids))) {
+ if (in_array($row->language, field_multilingual_available_languages($obj_type, $field))) {
+ 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();
+ foreach ($field['columns'] as $column => $attributes) {
+ $item[$column] = $row->{$column};
+ }
+ $objects[$row->entity_id]->{$field_name}[$row->language][] = $item;
+ $delta_count[$row->entity_id][$row->language]++;
+ }
+ }
+ }
+ }
+ }
+ }
+}
+
+/**
+ * Implements hook_field_storage_write().
+ */
+function field_test_field_storage_write($obj_type, $object, $op, $fields) {
+ $data = _field_test_storage_data();
+
+ list($id, $vid, $bundle) = entity_extract_ids($obj_type, $object);
+
+ foreach ($fields as $field_id) {
+ $field = field_info_field_by_id($field_id);
+ $field_name = $field['field_name'];
+ $field_data = &$data[$field_id];
+
+ $all_languages = field_multilingual_available_languages($obj_type, $field);
+ $field_languages = array_intersect($all_languages, array_keys((array) $object->$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 $object->$field_name.
+ // Delete all languages if $object->$field_name is empty.
+ $languages = !empty($object->$field_name) ? $field_languages : $all_languages;
+ if ($languages) {
+ foreach ($field_data['current'] as $key => $row) {
+ if ($row->type == $obj_type && $row->entity_id == $id && in_array($row->language, $languages)) {
+ unset($field_data['current'][$key]);
+ }
+ }
+ if (isset($vid)) {
+ foreach ($field_data['revisions'] as $key => $row) {
+ if ($row->type == $obj_type && $row->revision_id == $vid) {
+ unset($field_data['revisions'][$key]);
+ }
+ }
+ }
+ }
+ }
+
+ foreach ($field_languages as $langcode) {
+ $items = (array) $object->{$field_name}[$langcode];
+ $delta_count = 0;
+ foreach ($items as $delta => $item) {
+ $row = (object) array(
+ 'field_id' => $field_id,
+ 'type' => $obj_type,
+ 'entity_id' => $id,
+ 'revision_id' => $vid,
+ 'bundle' => $bundle,
+ 'delta' => $delta,
+ 'deleted' => FALSE,
+ 'language' => $langcode,
+ );
+ foreach ($field['columns'] as $column => $attributes) {
+ $row->{$column} = isset($item[$column]) ? $item[$column] : NULL;
+ }
+
+ $field_data['current'][] = $row;
+ if (isset($vid)) {
+ $field_data['revisions'][] = $row;
+ }
+
+ if ($field['cardinality'] != FIELD_CARDINALITY_UNLIMITED && ++$delta_count == $field['cardinality']) {
+ break;
+ }
+ }
+ }
+ }
+
+ _field_test_storage_data($data);
+}
+
+/**
+ * Implements hook_field_storage_delete().
+ */
+function field_test_field_storage_delete($obj_type, $object, $fields) {
+ list($id, $vid, $bundle) = entity_extract_ids($obj_type, $object);
+
+ // Note: reusing field_test_storage_purge(), like field_sql_storage.module
+ // does, is highly inefficient in our case...
+ foreach (field_info_instances($bundle) as $instance) {
+ if (isset($fields[$instance['field_id']])) {
+ $field = field_info_field_by_id($instance['field_id']);
+ field_test_field_storage_purge($obj_type, $object, $field, $instance);
+ }
+ }
+}
+
+/**
+ * Implements hook_field_storage_purge().
+ */
+function field_test_field_storage_purge($obj_type, $object, $field, $instance) {
+ $data = _field_test_storage_data();
+
+ list($id, $vid, $bundle) = entity_extract_ids($obj_type, $object);
+
+ $field_data = &$data[$field['id']];
+ foreach (array('current', 'revisions') as $sub_table) {
+ foreach ($field_data[$sub_table] as $key => $row) {
+ if ($row->type == $obj_type && $row->entity_id == $id) {
+ unset($field_data[$sub_table][$key]);
+ }
+ }
+ }
+
+ _field_test_storage_data($data);
+}
+
+/**
+ * Implements hook_field_storage_delete_revision().
+ */
+function field_test_field_storage_delete_revision($obj_type, $object, $fields) {
+ $data = _field_test_storage_data();
+
+ list($id, $vid, $bundle) = entity_extract_ids($obj_type, $object);
+ foreach ($fields as $field_id) {
+ $field_data = &$data[$field_id];
+ foreach (array('current', 'revisions') as $sub_table) {
+ foreach ($field_data[$sub_table] as $key => $row) {
+ if ($row->type == $obj_type && $row->entity_id == $id && $row->revision_id == $vid) {
+ unset($field_data[$sub_table][$key]);
+ }
+ }
+ }
+ }
+
+ _field_test_storage_data($data);
+}
+
+/**
+ * Implements hook_field_storage_query().
+ */
+function field_test_field_storage_query($field_id, $conditions, $count, &$cursor = NULL, $age) {
+ $data = _field_test_storage_data();
+
+ $load_current = $age == FIELD_LOAD_CURRENT;
+
+ $field = field_info_field_by_id($field_id);
+ $field_columns = array_keys($field['columns']);
+
+ $field_data = $data[$field['id']];
+ $sub_table = $load_current ? 'current' : 'revisions';
+ // We need to sort records by object type and object id.
+ usort($field_data[$sub_table], '_field_test_field_storage_query_sort_helper');
+
+ // Initialize results array.
+ $return = array();
+ $obj_count = 0;
+ $rows_count = 0;
+ $rows_total = count($field_data[$sub_table]);
+ $skip = $cursor;
+ $skipped = 0;
+
+ foreach ($field_data[$sub_table] as $row) {
+ if ($count != FIELD_QUERY_NO_LIMIT && $obj_count >= $count) {
+ break;
+ }
+
+ if ($row->field_id == $field['id']) {
+ $match = TRUE;
+ $condition_deleted = FALSE;
+ // Add conditions.
+ foreach ($conditions as $condition) {
+ @list($column, $value, $operator) = $condition;
+ if (empty($operator)) {
+ $operator = is_array($value) ? 'IN' : '=';
+ }
+ switch ($operator) {
+ case '=':
+ $match = $match && $row->{$column} == $value;
+ break;
+ case '!=':
+ case '<':
+ case '<=':
+ case '>':
+ case '>=':
+ eval('$match = $match && '. $row->{$column} . ' ' . $operator . ' '. $value);
+ break;
+ case 'IN':
+ $match = $match && in_array($row->{$column}, $value);
+ break;
+ case 'NOT IN':
+ $match = $match && !in_array($row->{$column}, $value);
+ break;
+ case 'BETWEEN':
+ $match = $match && $row->{$column} >= $value[0] && $row->{$column} <= $value[1];
+ break;
+ case 'STARTS_WITH':
+ case 'ENDS_WITH':
+ case 'CONTAINS':
+ // Not supported.
+ $match = FALSE;
+ break;
+ }
+ // Track condition on 'deleted'.
+ if ($column == 'deleted') {
+ $condition_deleted = TRUE;
+ }
+ }
+
+ // Exclude deleted data unless we have a condition on it.
+ if (!$condition_deleted && $row->deleted) {
+ $match = FALSE;
+ }
+
+ if ($match) {
+ if (is_null($skip) || $skipped >= $skip) {
+ $cursor++;
+ // If querying all revisions and the entity type has revisions, we need
+ // to key the results by revision_ids.
+ $entity_type = entity_get_info($row->type);
+ $id = ($load_current || empty($entity_type['object keys']['revision'])) ? $row->entity_id : $row->revision_id;
+
+ if (!isset($return[$row->type][$id])) {
+ $return[$row->type][$id] = entity_create_stub_entity($row->type, array($row->entity_id, $row->revision_id, $row->bundle));
+ $obj_count++;
+ }
+ }
+ else {
+ $skipped++;
+ }
+ }
+ }
+ $rows_count++;
+
+ // The query is complete if we walked the whole array.
+ if ($count != FIELD_QUERY_NO_LIMIT && $rows_count >= $rows_total) {
+ $cursor = FIELD_QUERY_COMPLETE;
+ }
+ }
+
+ return $return;
+}
+
+/**
+ * Sort helper for field_test_field_storage_query().
+ *
+ * Sorts by object type and object id.
+ */
+function _field_test_field_storage_query_sort_helper($a, $b) {
+ if ($a->type == $b->type) {
+ if ($a->entity_id == $b->entity_id) {
+ return 0;
+ }
+ else {
+ return $a->entity_id < $b->entity_id ? -1 : 1;
+ }
+ }
+ else {
+ return $a->type < $b->type ? -1 : 1;
+ }
+}
+
+/**
+ * Implements hook_field_storage_create_field().
+ */
+function field_test_field_storage_create_field($field) {
+ if ($field['storage']['type'] == 'field_test_storage_failure') {
+ throw new Exception('field_test_storage_failure engine always fails to create fields');
+ }
+
+ $data = _field_test_storage_data();
+
+ $data[$field['id']] = array(
+ 'current' => array(),
+ 'revisions' => array(),
+ );
+
+ _field_test_storage_data($data);
+}
+
+/**
+ * Implements hook_field_storage_delete_field().
+ */
+function field_test_field_storage_delete_field($field) {
+ $data = _field_test_storage_data();
+
+ $field_data = &$data[$field['id']];
+ foreach (array('current', 'revisions') as $sub_table) {
+ foreach ($field_data[$sub_table] as &$row) {
+ $row->deleted = TRUE;
+ }
+ }
+
+ _field_test_storage_data($data);
+}
+
+/**
+ * Implements hook_field_storage_delete_instance().
+ */
+function field_test_field_storage_delete_instance($instance) {
+ $data = _field_test_storage_data();
+
+ $field = field_info_field($instance['field_name']);
+ $field_data = &$data[$field['id']];
+ foreach (array('current', 'revisions') as $sub_table) {
+ foreach ($field_data[$sub_table] as &$row) {
+ if ($row->bundle == $instance['bundle']) {
+ $row->deleted = TRUE;
+ }
+ }
+ }
+
+ _field_test_storage_data($data);
+}
+
+/**
+ * Implements hook_field_attach_create_bundle().
+ */
+function field_test_field_attach_create_bundle($bundle) {
+ // We don't need to do anything here.
+}
+
+/**
+ * Implements hook_field_attach_rename_bundle().
+ */
+function field_test_field_attach_rename_bundle($bundle_old, $bundle_new) {
+ $data = _field_test_storage_data();
+
+ // We need to account for deleted or inactive fields and instances.
+ $instances = field_read_instances(array('bundle' => $bundle_new), array('include_deleted' => TRUE, 'include_inactive' => TRUE));
+ foreach ($instances as $field_name => $instance) {
+ $field = field_info_field_by_id($instance['field_id']);
+ if ($field['storage']['type'] == 'field_test_storage') {
+ $field_data = &$data[$field['id']];
+ foreach (array('current', 'revisions') as $sub_table) {
+ foreach ($field_data[$sub_table] as &$row) {
+ if ($row->bundle == $bundle_old) {
+ $row->bundle = $bundle_new;
+ }
+ }
+ }
+ }
+ }
+
+ _field_test_storage_data($data);
+}
+
+/**
+ * Implements hook_field_attach_delete_bundle().
+ */
+function field_test_field_attach_delete_bundle($bundle, $instances) {
+ $data = _field_test_storage_data();
+
+ $instances = field_info_instances($bundle);
+ foreach ($instances as $field_name => $instance) {
+ $field = field_info_field($field_name);
+ if ($field['storage']['type'] == 'field_test_storage') {
+ $field_data = &$data[$field['id']];
+ foreach (array('current', 'revisions') as $sub_table) {
+ foreach ($field_data[$sub_table] as &$row) {
+ if ($row->bundle == $bundle_old) {
+ $row->deleted = TRUE;
+ }
+ }
+ }
+ }
+ }
+
+ _field_test_storage_data($data);
+}
Index: modules/field/tests/field_test.field.inc
===================================================================
RCS file: modules/field/tests/field_test.field.inc
diff -N modules/field/tests/field_test.field.inc
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ modules/field/tests/field_test.field.inc 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,311 @@
+ array(
+ 'label' => t('Test Field'),
+ 'description' => t('Dummy field type used for tests.'),
+ 'settings' => array(
+ 'test_field_setting' => 'dummy test string',
+ 'changeable' => 'a changeable field setting',
+ 'unchangeable' => 'an unchangeable field setting',
+ ),
+ 'instance_settings' => array(
+ 'test_instance_setting' => 'dummy test string',
+ 'test_hook_field_load' => FALSE,
+ ),
+ 'default_widget' => 'test_field_widget',
+ 'default_formatter' => 'field_test_default',
+ ),
+ );
+}
+
+/**
+ * Implements hook_field_schema().
+ */
+function field_test_field_schema($field) {
+ return array(
+ 'columns' => array(
+ 'value' => array(
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => FALSE,
+ ),
+ ),
+ 'indexes' => array(
+ 'value' => array('value'),
+ ),
+ );
+}
+
+/**
+ * Implements hook_field_update_forbid().
+ */
+function field_test_field_update_forbid($field, $prior_field, $has_data) {
+ if ($field['type'] == 'test_field' && $field['settings']['unchangeable'] != $prior_field['settings']['unchangeable']) {
+ throw new FieldException("field_test 'unchangeable' setting cannot be changed'");
+ }
+}
+
+/**
+ * Implements hook_field_load().
+ */
+function field_test_field_load($obj_type, $objects, $field, $instances, $langcode, &$items, $age) {
+ foreach ($items as $id => $item) {
+ // To keep the test non-intrusive, only act for instances with the
+ // test_hook_field_load setting explicitly set to TRUE.
+ if ($instances[$id]['settings']['test_hook_field_load']) {
+ foreach ($item as $delta => $value) {
+ // Don't add anything on empty values.
+ if ($value) {
+ $items[$id][$delta]['additional_key'] = 'additional_value';
+ }
+ }
+ }
+ }
+}
+
+/**
+ * Implements hook_field_validate().
+ *
+ * Possible error codes:
+ * - 'field_test_invalid': The value is invalid.
+ */
+function field_test_field_validate($obj_type, $object, $field, $instance, $langcode, $items, &$errors) {
+ foreach ($items as $delta => $item) {
+ if ($item['value'] == -1) {
+ $errors[$field['field_name']][$langcode][$delta][] = array(
+ 'error' => 'field_test_invalid',
+ 'message' => t('%name does not accept the value -1.', array('%name' => $instance['label'])),
+ );
+ }
+ }
+}
+
+/**
+ * Implements hook_field_sanitize().
+ */
+function field_test_field_sanitize($obj_type, $object, $field, $instance, $langcode, &$items) {
+ foreach ($items as $delta => $item) {
+ $value = check_plain($item['value']);
+ $items[$delta]['safe'] = $value;
+ }
+}
+
+/**
+ * Implements hook_field_is_empty().
+ */
+function field_test_field_is_empty($item, $field) {
+ return empty($item['value']);
+}
+
+/**
+ * Implements hook_field_settings_form().
+ */
+function field_test_field_settings_form($field, $instance, $has_data) {
+ $settings = $field['settings'];
+
+ $form['test_field_setting'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Field test field setting'),
+ '#default_value' => $settings['test_field_setting'],
+ '#required' => FALSE,
+ '#description' => t('A dummy form element to simulate field setting.'),
+ );
+
+ return $form;
+}
+
+/**
+ * Implements hook_field_instance_settings_form().
+ */
+function field_test_field_instance_settings_form($field, $instance) {
+ $settings = $instance['settings'];
+
+ $form['test_instance_setting'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Field test field instance setting'),
+ '#default_value' => $settings['test_instance_setting'],
+ '#required' => FALSE,
+ '#description' => t('A dummy form element to simulate field instance setting.'),
+ );
+
+ return $form;
+}
+
+/**
+ * Implements hook_field_widget_info().
+ */
+function field_test_field_widget_info() {
+ return array(
+ 'test_field_widget' => array(
+ 'label' => t('Test field'),
+ 'field types' => array('test_field'),
+ 'settings' => array('test_widget_setting' => 'dummy test string'),
+ ),
+ 'test_field_widget_multiple' => array(
+ 'label' => t('Test field 1'),
+ 'field types' => array('test_field'),
+ 'settings' => array('test_widget_setting_multiple' => 'dummy test string'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
+ ),
+ ),
+ );
+}
+
+/**
+ * Implements hook_field_widget().
+ */
+function field_test_field_widget(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
+ $element = array(
+ 'value' => $element + array(
+ '#type' => 'textfield',
+ '#default_value' => isset($items[$delta]['value']) ? $items[$delta]['value'] : '',
+ ),
+ );
+ return $element;
+}
+
+/**
+ * Implements hook_field_widget_error().
+ */
+function field_test_field_widget_error($element, $error) {
+ form_error($element['value'], $error['message']);
+}
+
+/**
+ * Implements hook_field_widget_settings_form().
+ */
+function field_test_field_widget_settings_form($field, $instance) {
+ $widget = $instance['widget'];
+ $settings = $widget['settings'];
+
+ $form['test_widget_setting'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Field test field widget setting'),
+ '#default_value' => $settings['test_widget_setting'],
+ '#required' => FALSE,
+ '#description' => t('A dummy form element to simulate field widget setting.'),
+ );
+
+ return $form;
+}
+
+/**
+ * Implements hook_field_formatter_info().
+ */
+function field_test_field_formatter_info() {
+ return array(
+ 'field_test_default' => array(
+ 'label' => t('Default'),
+ 'description' => t('Default formatter'),
+ 'field types' => array('test_field'),
+ 'settings' => array(
+ 'test_formatter_setting' => 'dummy test string',
+ ),
+ ),
+ 'field_test_multiple' => array(
+ 'label' => t('Multiple'),
+ 'description' => t('Multiple formatter'),
+ 'field types' => array('test_field'),
+ 'settings' => array(
+ 'test_formatter_setting_multiple' => 'dummy test string',
+ ),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
+ ),
+ ),
+ 'field_test_needs_additional_data' => array(
+ 'label' => t('Tests hook_field_formatter_prepare_view()'),
+ 'field types' => array('test_field'),
+ 'settings' => array(
+ 'test_formatter_setting_additional' => 'dummy test string',
+ ),
+ ),
+ );
+}
+
+/**
+ * Implement hook_field_formatter_prepare_view().
+ */
+function field_test_field_formatter_prepare_view($obj_type, $objects, $field, $instances, $langcode, &$items, $build_mode) {
+ foreach ($items as $id => $item) {
+ // To keep the test non-intrusive, only act on the
+ // 'field_test_needs_additional_data' formatter.
+ if ($instances[$id]['display'][$build_mode]['type'] == 'field_test_needs_additional_data') {
+ foreach ($item as $delta => $value) {
+ // Don't add anything on empty values.
+ if ($value) {
+ $items[$id][$delta]['additional_formatter_value'] = $value['value'] + 1;
+ }
+ }
+ }
+ }
+}
+
+/**
+ * Theme function for 'field_test_default' formatter.
+ */
+function theme_field_formatter_field_test_default($variables) {
+ $element = $variables['element'];
+
+ $value = $element['#item']['value'];
+ $settings = $element['#settings'];
+
+ return $settings['test_formatter_setting'] . '|' . $value;
+}
+
+/**
+ * Theme function for 'field_test_multiple' formatter.
+ */
+function theme_field_formatter_field_test_multiple($variables) {
+ $element = $variables['element'];
+
+ $settings = $element['#settings'];
+
+ $items = array();
+ foreach (element_children($element) as $key) {
+ $items[$key] = $key .':'. $element[$key]['#item']['value'];
+ }
+ $output = implode('|', $items);
+ return $settings['test_formatter_setting_multiple'] . '|' . $output;
+}
+
+/**
+ * Theme function for 'field_test_needs_additional_data' formatter.
+ */
+function theme_field_formatter_field_test_needs_additional_data($variables) {
+ $element = $variables['element'];
+ $value = $element['#item']['value'];
+ $additional = $element['#item']['additional_formatter_value'];
+ $settings = $element['#settings'];
+
+ return $settings['test_formatter_setting_additional'] . '|' . $value . '|' . $additional;
+}
+
+/**
+ * Sample 'default vale' callback.
+ */
+function field_test_default_value($obj_type, $object, $field, $instance) {
+ return array(array('value' => 99));
+}
+
+/**
+ * Implements hook_field_access().
+ */
+function field_test_field_access($op, $field, $obj_type, $object, $account) {
+ if ($field['field_name'] == "field_no_{$op}_access") {
+ return FALSE;
+ }
+ return TRUE;
+}
Index: modules/field/tests/field_test.entity.inc
===================================================================
RCS file: modules/field/tests/field_test.entity.inc
diff -N modules/field/tests/field_test.entity.inc
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ modules/field/tests/field_test.entity.inc 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,322 @@
+ array('label' => 'Test Bundle')));
+ return array(
+ 'test_entity' => array(
+ 'name' => t('Test Entity'),
+ 'object keys' => array(
+ 'id' => 'ftid',
+ 'revision' => 'ftvid',
+ 'bundle' => 'fttype',
+ ),
+ 'cacheable' => FALSE,
+ 'bundles' => $bundles,
+ 'fieldable' => TRUE,
+ ),
+ // This entity type doesn't get form handling for now...
+ 'test_cacheable_entity' => array(
+ 'name' => t('Test Entity, cacheable'),
+ 'object keys' => array(
+ 'id' => 'ftid',
+ 'revision' => 'ftvid',
+ 'bundle' => 'fttype',
+ ),
+ 'fieldable' => TRUE,
+ 'cacheable' => TRUE,
+ 'bundles' => $bundles,
+ ),
+ );
+}
+
+/**
+ * Implements hook_entity_info_alter().
+ */
+function field_test_entity_info_alter(&$entity_info) {
+ // Enable/disable field_test as a translation handler.
+ foreach (field_test_entity_info_translatable() as $obj_type => $translatable) {
+ $entity_info[$obj_type]['translation']['field_test'] = $translatable;
+ }
+ // Disable locale as a translation handler.
+ foreach ($entity_info as $obj_type => $info) {
+ $entity_info[$obj_type]['translation']['locale'] = FALSE;
+ }
+}
+
+/**
+ * Creates a new bundle for test_entity objects.
+ *
+ * @param $bundle
+ * The machine-readable name of the bundle.
+ * @param $text
+ * The human-readable name of the bundle. If none is provided, the machine
+ * name will be used.
+ */
+function field_test_create_bundle($bundle, $text = NULL) {
+ $bundles = variable_get('field_test_bundles', array('test_bundle' => array('label' => 'Test Bundle')));
+ $bundles += array($bundle => array('label' => $text ? $text : $bundle));
+ variable_set('field_test_bundles', $bundles);
+
+ $info = field_test_entity_info();
+ foreach ($info as $type => $type_info) {
+ field_attach_create_bundle($type, $bundle);
+ }
+}
+
+/**
+ * Renames a bundle for test_entity objects.
+ *
+ * @param $bundle_old
+ * The machine-readable name of the bundle to rename.
+ * @param $bundle_new
+ * The new machine-readable name of the bundle.
+ */
+function field_test_rename_bundle($bundle_old, $bundle_new) {
+ $bundles = variable_get('field_test_bundles', array('test_bundle' => array('label' => 'Test Bundle')));
+ $bundles[$bundle_new] = $bundles[$bundle_old];
+ unset($bundles[$bundle_old]);
+ variable_set('field_test_bundles', $bundles);
+
+ $info = field_test_entity_info();
+ foreach ($info as $type => $type_info) {
+ field_attach_rename_bundle($type, $bundle_old, $bundle_new);
+ }
+}
+
+/**
+ * Deletes a bundle for test_entity objects.
+ *
+ * @param $bundle
+ * The machine-readable name of the bundle to delete.
+ */
+function field_test_delete_bundle($bundle) {
+ $bundles = variable_get('field_test_bundles', array('test_bundle' => array('label' => 'Test Bundle')));
+ unset($bundles[$bundle]);
+ variable_set('field_test_bundles', $bundles);
+
+ $info = field_test_entity_info();
+ foreach ($info as $type => $type_info) {
+ field_attach_delete_bundle($type, $bundle);
+ }
+}
+
+/**
+ * Implements hook_field_build_modes().
+ */
+function field_test_field_build_modes($obj_type) {
+ $modes = array();
+ if ($obj_type == 'test_entity' || $obj_type == 'test_cacheable_entity') {
+ $modes = array(
+ 'full' => t('Full node'),
+ 'teaser' => t('Teaser'),
+ );
+ }
+ return $modes;
+}
+
+/**
+ * Creates a basic test_entity object.
+ */
+function field_test_create_stub_entity($id = 1, $vid = 1, $bundle = 'test_bundle') {
+ $entity = new stdClass();
+ // Only set id and vid properties if they don't come as NULL (creation form).
+ if (isset($id)) {
+ $entity->ftid = $id;
+ }
+ if (isset($vid)) {
+ $entity->ftvid = $vid;
+ }
+ $entity->fttype = $bundle;
+
+ return $entity;
+}
+
+/**
+ * Loads a test_entity.
+ *
+ * @param $ftid
+ * The id of the entity to load.
+ * @param $ftvid
+ * (Optional) The revision id of the entity to load. If not specified, the
+ * current revision will be used.
+ * @return
+ * The loaded entity.
+ */
+function field_test_entity_test_load($ftid, $ftvid = NULL) {
+ // Load basic strucure.
+ $query = db_select('test_entity', 'fte', array())
+ ->fields('fte')
+ ->condition('ftid', $ftid);
+ if ($ftvid) {
+ $query->condition('ftvid', $ftvid);
+ }
+ $entities = $query->execute()->fetchAllAssoc('ftid');
+
+ // Attach fields.
+ if ($ftvid) {
+ field_attach_load_revision('test_entity', $entities);
+ }
+ else {
+ field_attach_load('test_entity', $entities);
+ }
+
+ return $entities[$ftid];
+}
+
+/**
+ * Saves a test_entity.
+ *
+ * A new entity is created if $entity->ftid and $entity->is_new are both empty.
+ * A new revision is created if $entity->revision is not empty.
+ *
+ * @param $entity
+ * The entity to save.
+ */
+function field_test_entity_save(&$entity) {
+ field_attach_presave('test_entity', $entity);
+
+ if (!isset($entity->is_new)) {
+ $entity->is_new = empty($entity->ftid);
+ }
+
+ if (!$entity->is_new && !empty($entity->revision)) {
+ $entity->old_ftvid = $entity->ftvid;
+ unset($entity->ftvid);
+ }
+
+ $update_entity = TRUE;
+ if ($entity->is_new) {
+ drupal_write_record('test_entity', $entity);
+ drupal_write_record('test_entity_revision', $entity);
+ $op = 'insert';
+ }
+ else {
+ drupal_write_record('test_entity', $entity, 'ftid');
+ if (!empty($entity->revision)) {
+ drupal_write_record('test_entity_revision', $entity);
+ }
+ else {
+ drupal_write_record('test_entity_revision', $entity, 'ftvid');
+ $update_entity = FALSE;
+ }
+ $op = 'update';
+ }
+ if ($update_entity) {
+ db_update('test_entity')
+ ->fields(array('ftvid' => $entity->ftvid))
+ ->condition('ftid', $entity->ftid)
+ ->execute();
+ }
+
+ // Save fields.
+ $function = "field_attach_$op";
+ $function('test_entity', $entity);
+}
+
+/**
+ * Menu callback: displays the 'Add new test_entity' form.
+ */
+function field_test_entity_add($fttype) {
+ $fttype = str_replace('-', '_', $fttype);
+ $entity = (object)array('fttype' => $fttype);
+ drupal_set_title(t('Create test_entity @bundle', array('@bundle' => $fttype)), PASS_THROUGH);
+ return drupal_get_form('field_test_entity_form', $entity, TRUE);
+}
+
+/**
+ * Menu callback: displays the 'Edit exiisting test_entity' form.
+ */
+function field_test_entity_edit($entity) {
+ drupal_set_title(t('test_entity @ftid revision @ftvid', array('@ftid' => $entity->ftid, '@ftvid' => $entity->ftvid)), PASS_THROUGH);
+ return drupal_get_form('field_test_entity_form', $entity);
+}
+
+/**
+ * Test_entity form.
+ */
+function field_test_entity_form($form, &$form_state, $entity, $add = FALSE) {
+ if (isset($form_state['test_entity'])) {
+ $entity = $form_state['test_entity'] + (array)$entity;
+ }
+ $entity = (object)$entity;
+
+ foreach (array('ftid', 'ftvid', 'fttype') as $key) {
+ $form[$key] = array(
+ '#type' => 'value',
+ '#value' => isset($entity->$key) ? $entity->$key : NULL,
+ );
+ }
+
+ // Add field widgets.
+ $form['#builder_function'] = 'field_test_entity_form_submit_builder';
+ field_attach_form('test_entity', $entity, $form, $form_state);
+
+ if (!$add) {
+ $form['revision'] = array(
+ '#access' => user_access('administer field_test content'),
+ '#type' => 'checkbox',
+ '#title' => t('Create new revision'),
+ '#default_value' => FALSE,
+ '#weight' => 100,
+ );
+ }
+ $form['submit'] = array(
+ '#type' => 'submit',
+ '#value' => t('Save'),
+ '#weight' => 101,
+ );
+
+ return $form;
+}
+
+/**
+ * Validate handler for field_test_entity_form().
+ */
+function field_test_entity_form_validate($form, &$form_state) {
+ $entity = field_test_create_stub_entity($form_state['values']['ftid'], $form_state['values']['ftvid'], $form_state['values']['fttype']);
+ field_attach_form_validate('test_entity', $entity, $form, $form_state);
+}
+
+/**
+ * Submit handler for field_test_entity_form().
+ */
+function field_test_entity_form_submit($form, &$form_state) {
+ $entity = field_test_entity_form_submit_builder($form, $form_state);
+ $insert = empty($entity->ftid);
+ field_test_entity_save($entity);
+
+ $message = $insert ? t('test_entity @id has been created.', array('@id' => $entity->ftid)) : t('test_entity @id has been updated.', array('@id' => $entity->ftid));
+ drupal_set_message($message);
+
+ if ($entity->ftid) {
+ unset($form_state['rebuild']);
+ $form_state['redirect'] = 'test-entity/' . $entity->ftid . '/edit';
+ }
+ else {
+ // Error on save.
+ drupal_set_message(t('The entity could not be saved.'), 'error');
+ }
+}
+
+/**
+ * Builds a test_entity from submitted form values.
+ */
+function field_test_entity_form_submit_builder($form, &$form_state) {
+ $entity = field_test_create_stub_entity($form_state['values']['ftid'], $form_state['values']['ftvid'], $form_state['values']['fttype']);
+ $entity->revision = !empty($form_state['values']['revision']);
+ field_attach_submit('test_entity', $entity, $form, $form_state);
+
+ $form_state['test_entity'] = (array)$entity;
+ $form_state['rebuild'] = TRUE;
+
+ return $entity;
+}