diff --git a/core/modules/entity_reference/entity_reference.module b/core/modules/entity_reference/entity_reference.module index 6d4280b..ed1e2a3 100644 --- a/core/modules/entity_reference/entity_reference.module +++ b/core/modules/entity_reference/entity_reference.module @@ -69,7 +69,7 @@ function entity_reference_field_widget_info_alter(&$info) { * Reset the instance handler settings, when the target type is changed. */ function entity_reference_field_storage_config_update(FieldStorageConfigInterface $field_storage) { - if ($field_storage->type != 'entity_reference') { + if ($field_storage->getType() != 'entity_reference') { // Only act on entity reference fields. return; } diff --git a/core/modules/field/field.purge.inc b/core/modules/field/field.purge.inc index 73de63f..4af0f4e 100644 --- a/core/modules/field/field.purge.inc +++ b/core/modules/field/field.purge.inc @@ -84,7 +84,7 @@ function field_purge_batch($batch_size, $field_storage_uuid = NULL) { $info = \Drupal::entityManager()->getDefinitions(); foreach ($fields as $field) { - $entity_type = $field->entity_type; + $entity_type = $field->getTargetEntityTypeId(); // We cannot purge anything if the entity type is unknown (e.g. the // providing module was uninstalled). @@ -117,7 +117,7 @@ function field_purge_batch($batch_size, $field_storage_uuid = NULL) { // We cannot purge anything if the entity type is unknown (e.g. the // providing module was uninstalled). // @todo Revisit after https://drupal.org/node/2080823. - if (!isset($info[$field_storage->entity_type])) { + if (!isset($info[$field_storage->getTargetEntityTypeId()])) { continue; } @@ -170,7 +170,7 @@ function field_purge_field_storage(FieldStorageConfigInterface $field_storage) { $state->set('field.storage.deleted', $deleted_storages); // Notify the storage layer. - \Drupal::entityManager()->getStorage($field_storage->entity_type)->finalizePurge($field_storage); + \Drupal::entityManager()->getStorage($field_storage->getTargetEntityTypeId())->finalizePurge($field_storage); // Invoke external hooks after the cache is cleared for API consistency. \Drupal::moduleHandler()->invokeAll('field_purge_field_storage', array($field_storage)); diff --git a/core/modules/field/field.views.inc b/core/modules/field/field.views.inc index cc26366..467065f 100644 --- a/core/modules/field/field.views.inc +++ b/core/modules/field/field.views.inc @@ -23,7 +23,7 @@ function field_views_data() { foreach (\Drupal::entityManager()->getStorage('field_storage_config')->loadMultiple() as $field_storage) { if (_field_views_get_entity_type_storage($field_storage)) { - $result = (array) $module_handler->invoke($field_storage->module, 'field_views_data', array($field_storage)); + $result = (array) $module_handler->invoke($field_storage->getModule(), 'field_views_data', array($field_storage)); if (empty($result)) { $result = field_views_field_default_views_data($field_storage); } @@ -49,7 +49,7 @@ function field_views_data() { function field_views_data_alter(&$data) { foreach (\Drupal::entityManager()->getStorage('field_storage_config')->loadMultiple() as $field_storage) { if (_field_views_get_entity_type_storage($field_storage)) { - $function = $field_storage->module . '_field_views_data_views_data_alter'; + $function = $field_storage->getModule() . '_field_views_data_views_data_alter'; if (function_exists($function)) { $function($data, $field_storage); } diff --git a/core/modules/field/src/ConfigImporterFieldPurger.php b/core/modules/field/src/ConfigImporterFieldPurger.php index 55294b2..63bd3a0 100644 --- a/core/modules/field/src/ConfigImporterFieldPurger.php +++ b/core/modules/field/src/ConfigImporterFieldPurger.php @@ -40,7 +40,7 @@ public static function process(array &$context, ConfigImporter $config_importer) $context['sandbox']['field']['current_storage_id'] = $field_storage->id(); // If the storage has not been deleted yet we need to do that. This is the // case when the storage deletion is staged. - if (!$field_storage->deleted) { + if (!$field_storage->isDeleted()) { $field_storage->delete(); } } @@ -140,7 +140,7 @@ public static function getFieldStoragesToPurge(array $extensions, array $deletes // Gather deleted fields from modules that are being uninstalled. $field_storages = entity_load_multiple_by_properties('field_storage_config', array('deleted' => TRUE, 'include_deleted' => TRUE)); foreach ($field_storages as $field_storage) { - if (!in_array($field_storage->module, $providers)) { + if (!in_array($field_storage->getModule(), $providers)) { $storages_to_delete[$field_storage->id()] = $field_storage; } } diff --git a/core/modules/field/src/Entity/FieldConfig.php b/core/modules/field/src/Entity/FieldConfig.php index a8d9c0a..8bf5136 100644 --- a/core/modules/field/src/Entity/FieldConfig.php +++ b/core/modules/field/src/Entity/FieldConfig.php @@ -141,7 +141,7 @@ public function preSave(EntityStorageInterface $storage) { // Filter out unknown settings and make sure all settings are present, so // that a complete field definition is passed to the various hooks and // written to config. - $default_settings = $field_type_manager->getDefaultFieldSettings($storage_definition->type); + $default_settings = $field_type_manager->getDefaultFieldSettings($storage_definition->getType()); $this->settings = array_intersect_key($this->settings, $default_settings) + $default_settings; if ($this->isNew()) { diff --git a/core/modules/field/src/Entity/FieldStorageConfig.php b/core/modules/field/src/Entity/FieldStorageConfig.php index 9ae0fc4..4e1e2a0 100644 --- a/core/modules/field/src/Entity/FieldStorageConfig.php +++ b/core/modules/field/src/Entity/FieldStorageConfig.php @@ -51,7 +51,7 @@ class FieldStorageConfig extends ConfigEntityBase implements FieldStorageConfigI * * @var string */ - public $id; + protected $id; /** * The field name. @@ -87,7 +87,7 @@ class FieldStorageConfig extends ConfigEntityBase implements FieldStorageConfigI * * @var string */ - public $module; + protected $module; /** * Field-type specific settings. @@ -108,7 +108,7 @@ class FieldStorageConfig extends ConfigEntityBase implements FieldStorageConfigI * * @var int */ - public $cardinality = 1; + protected $cardinality = 1; /** * Flag indicating whether the field is translatable. @@ -117,7 +117,7 @@ class FieldStorageConfig extends ConfigEntityBase implements FieldStorageConfigI * * @var bool */ - public $translatable = TRUE; + protected $translatable = TRUE; /** * Flag indicating whether the field is available for editing. @@ -131,7 +131,7 @@ class FieldStorageConfig extends ConfigEntityBase implements FieldStorageConfigI * * @var bool */ - public $locked = FALSE; + protected $locked = FALSE; /** * Flag indicating whether the field storage should be deleted when orphaned. @@ -164,7 +164,7 @@ class FieldStorageConfig extends ConfigEntityBase implements FieldStorageConfigI * * @var array */ - public $indexes = array(); + protected $indexes = array(); /** * Flag indicating whether the field is deleted. @@ -179,7 +179,7 @@ class FieldStorageConfig extends ConfigEntityBase implements FieldStorageConfigI * * @var bool */ - public $deleted = FALSE; + protected $deleted = FALSE; /** * The field schema. @@ -238,7 +238,7 @@ public function __construct(array $values, $entity_type = 'field_storage_config' * {@inheritdoc} */ public function id() { - return $this->entity_type . '.' . $this->field_name; + return $this->getTargetEntityTypeId() . '.' . $this->getName(); } /** @@ -288,30 +288,36 @@ protected function preSaveNew(EntityStorageInterface $storage) { // Field name cannot be longer than FieldStorageConfig::NAME_MAX_LENGTH characters. // We use Unicode::strlen() because the DB layer assumes that column widths // are given in characters rather than bytes. - if (Unicode::strlen($this->field_name) > static::NAME_MAX_LENGTH) { + if (Unicode::strlen($this->getName()) > static::NAME_MAX_LENGTH) { throw new FieldException(String::format( 'Attempt to create a field storage with an name longer than @max characters: %name', array( '@max' => static::NAME_MAX_LENGTH, - '%name' => $this->field_name, + '%name' => $this->getName(), ) )); } // Disallow reserved field names. - $disallowed_field_names = array_keys($entity_manager->getBaseFieldDefinitions($this->entity_type)); - if (in_array($this->field_name, $disallowed_field_names)) { - throw new FieldException(String::format('Attempt to create field storage %name which is reserved by entity type %type.', array('%name' => $this->field_name, '%type' => $this->entity_type))); + $disallowed_field_names = array_keys($entity_manager->getBaseFieldDefinitions($this->getTargetEntityTypeId())); + if (in_array($this->getName(), $disallowed_field_names)) { + throw new FieldException(String::format('Attempt to create field storage %name which is reserved by entity type %type.', array('%name' => $this->getName(), '%type' => $this->getTargetEntityTypeId()))); } // Check that the field type is known. - $field_type = $field_type_manager->getDefinition($this->type, FALSE); + $field_type = $field_type_manager->getDefinition($this->getType(), FALSE); if (!$field_type) { - throw new FieldException(String::format('Attempt to create a field storage of unknown type %type.', array('%type' => $this->type))); + throw new FieldException(String::format('Attempt to create a field storage of unknown type %type.', array('%type' => $this->getType()))); } $this->module = $field_type['provider']; + // Make sure all settings are present, so that a complete field + // definition is passed to the various hooks and written to config. + $this->settings += $field_type_manager->getDefaultStorageSettings($this->getType()); + // Notify the entity manager. $entity_manager->onFieldStorageDefinitionCreate($this); + // @todo Or this? (taken from patch at https://www.drupal.org/node/2030633#comment-9015925) + // $entity_manager->getStorage($this->getTargetEntityTypeId())->onFieldStorageDefinitionCreate($this); } /** @@ -320,7 +326,7 @@ protected function preSaveNew(EntityStorageInterface $storage) { public function calculateDependencies() { parent::calculateDependencies(); // Ensure the field is dependent on the providing module. - $this->addDependency('module', $this->module); + $this->addDependency('module', $this->getModule()); // Ensure the field is dependent on the provider of the entity type. $entity_type = \Drupal::entityManager()->getDefinition($this->entity_type); $this->addDependency('module', $entity_type->getProvider()); @@ -338,10 +344,10 @@ protected function preSaveUpdated(EntityStorageInterface $storage) { $entity_manager = \Drupal::entityManager(); // Some updates are always disallowed. - if ($this->type != $this->original->type) { + if ($this->getType() != $this->original->getType()) { throw new FieldException("Cannot change the field type for an existing field storage."); } - if ($this->entity_type != $this->original->entity_type) { + if ($this->getTargetEntityTypeId() != $this->original->getTargetEntityTypeId()) { throw new FieldException("Cannot change the entity type for an existing field storage."); } @@ -353,6 +359,8 @@ protected function preSaveUpdated(EntityStorageInterface $storage) { // update as invalid by raising an exception, which stops execution before // the definition is written to config. $entity_manager->onFieldStorageDefinitionUpdate($this, $this->original); + // @todo Or this? (taken from patch at https://www.drupal.org/node/2030633#comment-9015925) + // $entity_manager->getStorage($this->getTargetEntityTypeId())->onFieldStorageDefinitionUpdate($this, $this->original); } /** @@ -481,10 +489,11 @@ public function getColumns() { * {@inheritdoc} */ public function getBundles() { - if (empty($this->deleted)) { + $deleted = $this->isDeleted(); + if (empty($deleted)) { $map = \Drupal::entityManager()->getFieldMap(); - if (isset($map[$this->entity_type][$this->field_name]['bundles'])) { - return $map[$this->entity_type][$this->field_name]['bundles']; + if (isset($map[$this->getTargetEntityTypeId()][$this->getName()]['bundles'])) { + return $map[$this->getTargetEntityTypeId()][$this->getName()]['bundles']; } } return array(); @@ -500,6 +509,20 @@ public function getName() { /** * {@inheritdoc} */ + public function isDeleted() { + return $this->deleted; + } + + /** + * {@inheritdoc} + */ + public function getModule() { + return $this->module; + } + + /** + * {@inheritdoc} + */ public function getType() { return $this->type; } @@ -514,7 +537,7 @@ public function getSettings() { // within $this. $field_type_manager = \Drupal::service('plugin.manager.field.field_type'); - $settings = $field_type_manager->getDefaultStorageSettings($this->type); + $settings = $field_type_manager->getDefaultStorageSettings($this->getType()); return $this->settings + $settings; } @@ -540,6 +563,22 @@ public function getSetting($setting_name) { /** * {@inheritdoc} */ + public function setSetting($setting_name, $value) { + $this->settings[$setting_name] = $value; + return $this; + } + + /** + * {@inheritdoc} + */ + public function setSettings($settings) { + $this->set('settings', $settings); + return $this; + } + + /** + * {@inheritdoc} + */ public function isTranslatable() { return $this->translatable; } @@ -591,6 +630,14 @@ public function getCardinality() { /** * {@inheritdoc} */ + public function setCardinality($cardinality) { + $this->set('cardinality', $cardinality); + return $this; + } + + /** + * {@inheritdoc} + */ public function isRequired() { return FALSE; } @@ -626,6 +673,14 @@ public function isLocked() { /** * {@inheritdoc} */ + public function setLocked($locked) { + $this->set('locked', $locked); + return $this; + } + + /** + * {@inheritdoc} + */ public function getTargetEntityTypeId() { return $this->entity_type; } diff --git a/core/modules/field/src/FieldStorageConfigInterface.php b/core/modules/field/src/FieldStorageConfigInterface.php index de0406b..84a73f3 100644 --- a/core/modules/field/src/FieldStorageConfigInterface.php +++ b/core/modules/field/src/FieldStorageConfigInterface.php @@ -39,4 +39,72 @@ public function isLocked(); */ public function isDeletable(); + /** + * Sets the locked flag. + * + * @param bool $locked + * Sets value of locked flag. + * + * @return $this + */ + public function setLocked($locked); + + /** + * Returns whether the field is deleted or not. + * + * @return bool + * The deleted property. + */ + public function isDeleted(); + + /** + * Sets the maximum number of items allowed for the field. + * + * @param int $cardinality + * The cardinality value. + * + * @return $this + */ + public function setCardinality($cardinality); + + /** + * Sets the value for a field setting by name. + * + * @param string $setting_name + * The name of the setting. + * @param mixed $value + * The value of the setting. + * + * @return $this + */ + public function setSetting($setting_name, $value); + + /** + * Sets field settings by overwriting the settings array. + * + * @param string $settings + * The array of field settings. + * + * @return $this + */ + public function setSettings($settings); + + /** + * Returns the name of the module providing the field type. + * + * @return string + * The name of the module that provides the field type. + */ + public function getModule(); + + /** + * Sets whether the field is translatable. + * + * @param bool $translatable + * Whether the field is translatable. + * + * @return $this + */ + public function setTranslatable($translatable); + } diff --git a/core/modules/field/src/FieldStorageConfigStorage.php b/core/modules/field/src/FieldStorageConfigStorage.php index d865d85..eacf7dc 100644 --- a/core/modules/field/src/FieldStorageConfigStorage.php +++ b/core/modules/field/src/FieldStorageConfigStorage.php @@ -135,13 +135,24 @@ public function loadByProperties(array $conditions = array()) { foreach ($conditions as $key => $value) { // Extract the actual value against which the condition is checked. switch ($key) { - case 'uuid'; + case 'uuid': $checked_value = $field->uuid(); break; + case 'deleted': + $checked_value = $field->isDeleted(); + break; + + case 'module': + $checked_value = $field->getModule(); + break; + + case 'type': + $checked_value = $field->getType(); + break; + default: $checked_value = $field->$key; - break; } // Skip to the next field as soon as one condition does not match. diff --git a/core/modules/field/src/Tests/BulkDeleteTest.php b/core/modules/field/src/Tests/BulkDeleteTest.php index 4ae227b..be306e5 100644 --- a/core/modules/field/src/Tests/BulkDeleteTest.php +++ b/core/modules/field/src/Tests/BulkDeleteTest.php @@ -314,7 +314,7 @@ function testPurgeFieldStorage() { $this->assertEqual(count($fields), 0, 'The field is purged.'); // The field storage still exists, not deleted. $storages = entity_load_multiple_by_properties('field_storage_config', array('uuid' => $field_storage->uuid(), 'include_deleted' => TRUE)); - $this->assertTrue(isset($storages[$field_storage->uuid()]) && !$storages[$field_storage->uuid()]->deleted, 'The field storage exists and is not deleted'); + $this->assertTrue(isset($storages[$field_storage->uuid()]) && !$storages[$field_storage->uuid()]->isDeleted(), 'The field storage exists and is not deleted'); // Delete the second field. $bundle = next($this->bundles); @@ -341,7 +341,7 @@ function testPurgeFieldStorage() { $fields = entity_load_multiple_by_properties('field_config', array('uuid' => $field->uuid(), 'include_deleted' => TRUE)); $this->assertTrue(isset($fields[$field->uuid()]) && $fields[$field->uuid()]->deleted, 'The field exists and is deleted'); $storages = entity_load_multiple_by_properties('field_storage_config', array('uuid' => $field_storage->uuid(), 'include_deleted' => TRUE)); - $this->assertTrue(isset($storages[$field_storage->uuid()]) && $storages[$field_storage->uuid()]->deleted, 'The field storage exists and is deleted'); + $this->assertTrue(isset($storages[$field_storage->uuid()]) && $storages[$field_storage->uuid()]->isDeleted(), 'The field storage exists and is deleted'); // Purge again to purge the field and the storage. field_purge_batch(0); diff --git a/core/modules/field/src/Tests/FieldStorageCrudTest.php b/core/modules/field/src/Tests/FieldStorageCrudTest.php index 94fb1d2..2e7e840 100644 --- a/core/modules/field/src/Tests/FieldStorageCrudTest.php +++ b/core/modules/field/src/Tests/FieldStorageCrudTest.php @@ -305,13 +305,13 @@ function testDelete() { // Test that the first field is not deleted, and then delete it. $field_storage = current(entity_load_multiple_by_properties('field_storage_config', array('field_name' => $field_storage_definition['field_name'], 'include_deleted' => TRUE))); - $this->assertTrue(!empty($field_storage) && empty($field_storage->deleted), 'A new storage is not marked for deletion.'); + $this->assertTrue(!empty($field_storage) && !$field_storage->isDeleted(), 'A new storage is not marked for deletion.'); FieldStorageConfig::loadByName('entity_test', $field_storage_definition['field_name'])->delete(); // Make sure that the field is marked as deleted when it is specifically // loaded. $field_storage = current(entity_load_multiple_by_properties('field_storage_config', array('field_name' => $field_storage_definition['field_name'], 'include_deleted' => TRUE))); - $this->assertTrue(!empty($field_storage->deleted), 'A deleted storage is marked for deletion.'); + $this->assertTrue($field_storage->isDeleted(), 'A deleted storage is marked for deletion.'); // Make sure that this field is marked as deleted when it is // specifically loaded. @@ -328,7 +328,7 @@ function testDelete() { // Make sure the other field and its storage are not deleted. $another_field_storage = entity_load('field_storage_config', 'entity_test.' . $another_field_storage_definition['field_name']); - $this->assertTrue(!empty($another_field_storage) && empty($another_field_storage->deleted), 'A non-deleted storage is not marked for deletion.'); + $this->assertTrue(!empty($another_field_storage) && !$another_field_storage->isDeleted(), 'A non-deleted storage is not marked for deletion.'); $another_field = FieldConfig::load('entity_test.' . $another_field_definition['bundle'] . '.' . $another_field_definition['field_name']); $this->assertTrue(!empty($another_field) && empty($another_field->deleted), 'A field whose storage was not deleted is not marked for deletion.'); @@ -337,7 +337,7 @@ function testDelete() { entity_create('field_storage_config', $field_storage_definition)->save(); entity_create('field_config', $field_definition)->save(); $field_storage = entity_load('field_storage_config', 'entity_test.' . $field_storage_definition['field_name']); - $this->assertTrue(!empty($field_storage) && empty($field_storage->deleted), 'A new storage with a previously used name is created.'); + $this->assertTrue(!empty($field_storage) && !$field_storage->isDeleted(), 'A new storage with a previously used name is created.'); $field = FieldConfig::load('entity_test.' . $field_definition['bundle'] . '.' . $field_definition['field_name'] ); $this->assertTrue(!empty($field) && empty($field->deleted), 'A new field for a previously used field name is created.'); @@ -363,7 +363,11 @@ function testUpdateFieldType() { $field_storage->save(); try { - $field_storage->type = 'integer'; + // Set the field storage type to 'integer.' Since $type is protected, + // we have to use reflection. + $ref_field_storage_type = new \ReflectionProperty($field_storage, 'type'); + $ref_field_storage_type->setAccessible(TRUE); + $ref_field_storage_type->setValue($field_storage, 'integer'); $field_storage->save(); $this->fail(t('Cannot update a field to a different type.')); } @@ -403,13 +407,13 @@ function testUpdate() { } // Load back and assert there are $cardinality number of values. $entity = $this->entitySaveReload($entity); - $this->assertEqual(count($entity->field_update), $field_storage->cardinality); + $this->assertEqual(count($entity->field_update), $field_storage->getCardinality()); // Now check the values themselves. for ($delta = 0; $delta < $cardinality; $delta++) { $this->assertEqual($entity->field_update[$delta]->value, $delta + 1); } // Increase $cardinality and set the field cardinality to the new value. - $field_storage->cardinality = ++$cardinality; + $field_storage->setCardinality(++$cardinality); $field_storage->save(); } while ($cardinality < 6); } diff --git a/core/modules/field/src/Tests/FieldValidationTest.php b/core/modules/field/src/Tests/FieldValidationTest.php index 4454c23..f4a4591 100644 --- a/core/modules/field/src/Tests/FieldValidationTest.php +++ b/core/modules/field/src/Tests/FieldValidationTest.php @@ -48,7 +48,7 @@ protected function setUp() { * Tests that the number of values is validated against the field cardinality. */ function testCardinalityConstraint() { - $cardinality = $this->fieldTestData->field_storage->cardinality; + $cardinality = $this->fieldTestData->field_storage->getCardinality(); $entity = $this->entity; for ($delta = 0; $delta < $cardinality + 1; $delta++) { diff --git a/core/modules/field_ui/src/Form/FieldStorageEditForm.php b/core/modules/field_ui/src/Form/FieldStorageEditForm.php index 5cd57b7..380bbe1 100644 --- a/core/modules/field_ui/src/Form/FieldStorageEditForm.php +++ b/core/modules/field_ui/src/Form/FieldStorageEditForm.php @@ -150,7 +150,7 @@ public function buildForm(array $form, FormStateInterface $form_state, FieldConf // Build the non-configurable field values. $form['field_storage']['field_name'] = array('#type' => 'value', '#value' => $field_storage->getName()); $form['field_storage']['type'] = array('#type' => 'value', '#value' => $field_storage->getType()); - $form['field_storage']['module'] = array('#type' => 'value', '#value' => $field_storage->module); + $form['field_storage']['module'] = array('#type' => 'value', '#value' => $field_storage->getModule()); $form['field_storage']['translatable'] = array('#type' => 'value', '#value' => $field_storage->isTranslatable()); $form['actions'] = array('#type' => 'actions'); diff --git a/core/modules/system/src/Tests/Entity/FieldSqlStorageTest.php b/core/modules/system/src/Tests/Entity/FieldSqlStorageTest.php index 8fdb484..5af29ac 100644 --- a/core/modules/system/src/Tests/Entity/FieldSqlStorageTest.php +++ b/core/modules/system/src/Tests/Entity/FieldSqlStorageTest.php @@ -411,15 +411,23 @@ function testFieldUpdateIndexesWithData() { $entity->enforceIsNew(); $entity->save(); - // Add an index. - $field_storage->indexes = array('value' => array(array('value', 255))); + // Add an index. Since $indexes is protected, we have to use reflection. + $ref_field_storage_indexes = new \ReflectionProperty($field_storage, 'indexes'); + $ref_field_storage_indexes->setAccessible(TRUE); + $ref_field_storage_indexes->setValue( + $field_storage, + array('value' => array(array('value', 255))) + ); $field_storage->save(); foreach ($tables as $table) { $this->assertTrue(Database::getConnection()->schema()->indexExists($table, "{$field_name}_value"), t("Index on value created in @table", array('@table' => $table))); } // Add a different index, removing the existing custom one. - $field_storage->indexes = array('value_format' => array(array('value', 127), array('format', 127))); + $ref_field_storage_indexes->setValue( + $field_storage, + array('value_format' => array(array('value', 127), array('format', 127))) + ); $field_storage->save(); foreach ($tables as $table) { $this->assertTrue(Database::getConnection()->schema()->indexExists($table, "{$field_name}_value_format"), t("Index on value_format created in @table", array('@table' => $table)));