View source
<?php
namespace Drupal\system\Tests\Entity;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\entity_test\FieldStorageDefinition;
@trigger_error(__NAMESPACE__ . '\\EntityDefinitionTestTrait is deprecated in Drupal 8.6.x and will be removed before Drupal 9.0.0. Instead, use \\Drupal\\Tests\\system\\Functional\\Entity\\Traits\\EntityDefinitionTestTrait. See https://www.drupal.org/node/2946549.', E_USER_DEPRECATED);
trait EntityDefinitionTestTrait {
protected function enableNewEntityType() {
$this->state
->set('entity_test_new', TRUE);
$this->entityManager
->clearCachedDefinitions();
$this->entityDefinitionUpdateManager
->applyUpdates();
}
protected function resetEntityType() {
$this->state
->set('entity_test_update.entity_type', NULL);
$this->entityManager
->clearCachedDefinitions();
$this->entityDefinitionUpdateManager
->applyUpdates();
}
protected function updateEntityTypeToRevisionable() {
$entity_type = clone $this->entityManager
->getDefinition('entity_test_update');
$keys = $entity_type
->getKeys();
$keys['revision'] = 'revision_id';
$entity_type
->set('entity_keys', $keys);
$entity_type
->set('revision_table', 'entity_test_update_revision');
$this->state
->set('entity_test_update.entity_type', $entity_type);
}
protected function updateEntityTypeToNotRevisionable() {
$entity_type = clone $this->entityManager
->getDefinition('entity_test_update');
$keys = $entity_type
->getKeys();
unset($keys['revision']);
$entity_type
->set('entity_keys', $keys);
$entity_type
->set('revision_table', NULL);
$this->state
->set('entity_test_update.entity_type', $entity_type);
}
protected function updateEntityTypeToTranslatable() {
$entity_type = clone $this->entityManager
->getDefinition('entity_test_update');
$entity_type
->set('translatable', TRUE);
$entity_type
->set('data_table', 'entity_test_update_data');
if ($entity_type
->isRevisionable()) {
$entity_type
->set('revision_data_table', 'entity_test_update_revision_data');
}
$this->state
->set('entity_test_update.entity_type', $entity_type);
}
protected function updateEntityTypeToNotTranslatable() {
$entity_type = clone $this->entityManager
->getDefinition('entity_test_update');
$entity_type
->set('translatable', FALSE);
$entity_type
->set('data_table', NULL);
if ($entity_type
->isRevisionable()) {
$entity_type
->set('revision_data_table', NULL);
}
$this->state
->set('entity_test_update.entity_type', $entity_type);
}
protected function updateEntityTypeToRevisionableAndTranslatable() {
$entity_type = clone $this->entityManager
->getDefinition('entity_test_update');
$keys = $entity_type
->getKeys();
$keys['revision'] = 'revision_id';
$entity_type
->set('entity_keys', $keys);
$entity_type
->set('translatable', TRUE);
$entity_type
->set('data_table', 'entity_test_update_data');
$entity_type
->set('revision_table', 'entity_test_update_revision');
$entity_type
->set('revision_data_table', 'entity_test_update_revision_data');
$this->state
->set('entity_test_update.entity_type', $entity_type);
}
protected function addBaseField($type = 'string', $entity_type_id = 'entity_test_update', $is_revisionable = FALSE) {
$definitions['new_base_field'] = BaseFieldDefinition::create($type)
->setName('new_base_field')
->setRevisionable($is_revisionable)
->setLabel(t('A new base field'));
$this->state
->set($entity_type_id . '.additional_base_field_definitions', $definitions);
}
protected function addLongNameBaseField() {
$key = 'entity_test_update.additional_base_field_definitions';
$definitions = $this->state
->get($key, []);
$definitions['new_long_named_entity_reference_base_field'] = BaseFieldDefinition::create('entity_reference')
->setName('new_long_named_entity_reference_base_field')
->setLabel(t('A new long-named base field'))
->setSetting('target_type', 'user')
->setSetting('handler', 'default');
$this->state
->set($key, $definitions);
}
protected function addRevisionableBaseField($type = 'string') {
$definitions['new_base_field'] = BaseFieldDefinition::create($type)
->setName('new_base_field')
->setLabel(t('A new revisionable base field'))
->setRevisionable(TRUE);
$this->state
->set('entity_test_update.additional_base_field_definitions', $definitions);
}
protected function modifyBaseField() {
$this
->addBaseField('text');
}
protected function makeBaseFieldEntityKey() {
$entity_type = clone $this->entityManager
->getDefinition('entity_test_update');
$entity_keys = $entity_type
->getKeys();
$entity_keys['new_base_field'] = 'new_base_field';
$entity_type
->set('entity_keys', $entity_keys);
$this->state
->set('entity_test_update.entity_type', $entity_type);
}
protected function removeBaseField($entity_type_id = 'entity_test_update') {
$this->state
->delete($entity_type_id . '.additional_base_field_definitions');
}
protected function addBaseFieldIndex() {
$this->state
->set('entity_test_update.additional_field_index.entity_test_update.new_base_field', TRUE);
}
protected function removeBaseFieldIndex() {
$this->state
->delete('entity_test_update.additional_field_index.entity_test_update.new_base_field');
}
protected function addBundleField($type = 'string') {
$definitions['new_bundle_field'] = FieldStorageDefinition::create($type)
->setName('new_bundle_field')
->setLabel(t('A new bundle field'))
->setTargetEntityTypeId('entity_test_update');
$this->state
->set('entity_test_update.additional_field_storage_definitions', $definitions);
$this->state
->set('entity_test_update.additional_bundle_field_definitions.test_bundle', $definitions);
}
protected function modifyBundleField() {
$this
->addBundleField('text');
}
protected function removeBundleField() {
$this->state
->delete('entity_test_update.additional_field_storage_definitions');
$this->state
->delete('entity_test_update.additional_bundle_field_definitions.test_bundle');
}
protected function addEntityIndex() {
$indexes = [
'entity_test_update__new_index' => [
'name',
'test_single_property',
],
];
$this->state
->set('entity_test_update.additional_entity_indexes', $indexes);
}
protected function removeEntityIndex() {
$this->state
->delete('entity_test_update.additional_entity_indexes');
}
protected function renameBaseTable() {
$entity_type = clone $this->entityManager
->getDefinition('entity_test_update');
$entity_type
->set('base_table', 'entity_test_update_new');
$this->state
->set('entity_test_update.entity_type', $entity_type);
}
protected function renameDataTable() {
$entity_type = clone $this->entityManager
->getDefinition('entity_test_update');
$entity_type
->set('data_table', 'entity_test_update_data_new');
$this->state
->set('entity_test_update.entity_type', $entity_type);
}
protected function renameRevisionBaseTable() {
$entity_type = clone $this->entityManager
->getDefinition('entity_test_update');
$entity_type
->set('revision_table', 'entity_test_update_revision_new');
$this->state
->set('entity_test_update.entity_type', $entity_type);
}
protected function renameRevisionDataTable() {
$entity_type = clone $this->entityManager
->getDefinition('entity_test_update');
$entity_type
->set('revision_data_table', 'entity_test_update_revision_data_new');
$this->state
->set('entity_test_update.entity_type', $entity_type);
}
protected function deleteEntityType() {
$this->state
->set('entity_test_update.entity_type', 'null');
}
}