1. trait
  2. Drupal
  3. \
  4. system
  5. \
  6. Tests
  7. \
  8. Entity
  9. \
  10. EntityDefinitionTestTrait

EntityDefinitionTestTrait deprecated

trait EntityDefinitionTestTrait (View source)

deprecated in drupal:8.6.0 and is removed from drupal:9.0.0. Use \Drupal\Tests\system\Functional\Entity\Traits\EntityDefinitionTestTrait.

Provides some test methods used to update existing entity definitions.

Methods

enableNewEntityType()

Enables a new entity type definition.

resetEntityType()

Resets the entity type definition.

updateEntityTypeToRevisionable()

Updates the 'entity_test_update' entity type to revisionable.

updateEntityTypeToNotRevisionable()

Updates the 'entity_test_update' entity type not revisionable.

updateEntityTypeToTranslatable()

Updates the 'entity_test_update' entity type to translatable.

updateEntityTypeToNotTranslatable()

Updates the 'entity_test_update' entity type to not translatable.

updateEntityTypeToRevisionableAndTranslatable()

Updates the 'entity_test_update' entity type to revisionable and translatable.

addBaseField(string $type = 'string', string $entity_type_id = 'entity_test_update', bool $is_revisionable = FALSE)

Adds a new base field to the 'entity_test_update' entity type.

addLongNameBaseField()

Adds a long-named base field to the 'entity_test_update' entity type.

addRevisionableBaseField(string $type = 'string')

Adds a new revisionable base field to the 'entity_test_update' entity type.

modifyBaseField()

Modifies the new base field from 'string' to 'text'.

makeBaseFieldEntityKey()

Promotes a field to an entity key.

removeBaseField(string $entity_type_id = 'entity_test_update')

Removes the new base field from the 'entity_test_update' entity type.

addBaseFieldIndex()

Adds a single-field index to the base field.

removeBaseFieldIndex()

Removes the index added in addBaseFieldIndex().

addBundleField(string $type = 'string')

Adds a new bundle field to the 'entity_test_update' entity type.

modifyBundleField()

Modifies the new bundle field from 'string' to 'text'.

removeBundleField()

Removes the new bundle field from the 'entity_test_update' entity type.

addEntityIndex()

Adds an index to the 'entity_test_update' entity type's base table.

removeEntityIndex()

Removes the index added in addEntityIndex().

renameBaseTable()

Renames the base table to 'entity_test_update_new'.

renameDataTable()

Renames the data table to 'entity_test_update_data_new'.

renameRevisionBaseTable()

Renames the revision table to 'entity_test_update_revision_new'.

renameRevisionDataTable()

Renames the revision data table to 'entity_test_update_revision_data_new'.

deleteEntityType()

Removes the entity type.

Details

at line 23
protected enableNewEntityType()

Enables a new entity type definition.

at line 32
protected resetEntityType()

Resets the entity type definition.

at line 41
protected updateEntityTypeToRevisionable()

Updates the 'entity_test_update' entity type to revisionable.

at line 55
protected updateEntityTypeToNotRevisionable()

Updates the 'entity_test_update' entity type not revisionable.

at line 69
protected updateEntityTypeToTranslatable()

Updates the 'entity_test_update' entity type to translatable.

at line 85
protected updateEntityTypeToNotTranslatable()

Updates the 'entity_test_update' entity type to not translatable.

at line 102
protected updateEntityTypeToRevisionableAndTranslatable()

Updates the 'entity_test_update' entity type to revisionable and translatable.

at line 128
protected addBaseField(string $type = 'string', string $entity_type_id = 'entity_test_update', bool $is_revisionable = FALSE)

Adds a new base field to the 'entity_test_update' entity type.

Parameters

string $type

(optional) The field type for the new field. Defaults to 'string'.
string $entity_type_id

(optional) The entity type ID the base field should be attached to. Defaults to 'entity_test_update'.
bool $is_revisionable

(optional) If the base field should be revisionable or not. Defaults to FALSE.

at line 139
protected addLongNameBaseField()

Adds a long-named base field to the 'entity_test_update' entity type.

at line 156
protected addRevisionableBaseField(string $type = 'string')

Adds a new revisionable base field to the 'entity_test_update' entity type.

Parameters

string $type

(optional) The field type for the new field. Defaults to 'string'.

at line 167
protected modifyBaseField()

Modifies the new base field from 'string' to 'text'.

at line 174
protected makeBaseFieldEntityKey()

Promotes a field to an entity key.

at line 188
protected removeBaseField(string $entity_type_id = 'entity_test_update')

Removes the new base field from the 'entity_test_update' entity type.

Parameters

string $entity_type_id

(optional) The entity type ID the base field should be attached to.

at line 195
protected addBaseFieldIndex()

Adds a single-field index to the base field.

at line 202
protected removeBaseFieldIndex()

Removes the index added in addBaseFieldIndex().

at line 212
protected addBundleField(string $type = 'string')

Adds a new bundle field to the 'entity_test_update' entity type.

Parameters

string $type

(optional) The field type for the new field. Defaults to 'string'.

at line 224
protected modifyBundleField()

Modifies the new bundle field from 'string' to 'text'.

at line 231
protected removeBundleField()

Removes the new bundle field from the 'entity_test_update' entity type.

at line 241
protected addEntityIndex()

Adds an index to the 'entity_test_update' entity type's base table.

See also

\Drupal\entity_test\EntityTestStorageSchema::getEntitySchema()

at line 251
protected removeEntityIndex()

Removes the index added in addEntityIndex().

at line 258
protected renameBaseTable()

Renames the base table to 'entity_test_update_new'.

at line 269
protected renameDataTable()

Renames the data table to 'entity_test_update_data_new'.

at line 280
protected renameRevisionBaseTable()

Renames the revision table to 'entity_test_update_revision_new'.

at line 291
protected renameRevisionDataTable()

Renames the revision data table to 'entity_test_update_revision_data_new'.

at line 302
protected deleteEntityType()

Removes the entity type.