class EntitySerializedField
Same name in other branches
- 9 core/modules/system/tests/modules/entity_test/src/Entity/EntitySerializedField.php \Drupal\entity_test\Entity\EntitySerializedField
- 10 core/modules/system/tests/modules/entity_test/src/Entity/EntitySerializedField.php \Drupal\entity_test\Entity\EntitySerializedField
- 11.x core/modules/system/tests/modules/entity_test/src/Entity/EntitySerializedField.php \Drupal\entity_test\Entity\EntitySerializedField
Defines a test class for testing fields with a serialized column.
Plugin annotation
@ContentEntityType(
id = "entity_test_serialized_field",
label = @Translation("Test serialized fields"),
entity_keys = {
"id" = "id",
"uuid" = "uuid",
"bundle" = "type",
"label" = "name"
},
base_table = "entity_test_serialized_fields",
persistent_cache = FALSE,
serialized_field_property_names = {
"serialized_long" = {
"value"
}
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
- class \Drupal\entity_test\Entity\EntityTest extends \Drupal\Core\Entity\ContentEntityBase implements \Drupal\user\EntityOwnerInterface
- class \Drupal\entity_test\Entity\EntitySerializedField extends \Drupal\entity_test\Entity\EntityTest
- class \Drupal\entity_test\Entity\EntityTest extends \Drupal\Core\Entity\ContentEntityBase implements \Drupal\user\EntityOwnerInterface
- class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
Expanded class hierarchy of EntitySerializedField
2 files declare their use of EntitySerializedField
- DenormalizeTest.php in core/
modules/ hal/ tests/ src/ Kernel/ DenormalizeTest.php - EntitySerializationTest.php in core/
modules/ serialization/ tests/ src/ Kernel/ EntitySerializationTest.php
File
-
core/
modules/ system/ tests/ modules/ entity_test/ src/ Entity/ EntitySerializedField.php, line 29
Namespace
Drupal\entity_test\EntityView source
class EntitySerializedField extends EntityTest {
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields['serialized'] = BaseFieldDefinition::create('serialized_item_test')->setLabel(t('Serialized'));
$fields['serialized_text'] = BaseFieldDefinition::create('serialized_property_item_test')->setLabel(t('Serialized text'));
$fields['serialized_long'] = BaseFieldDefinition::create('string_long')->setLabel(t('Serialized long string'));
return $fields;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | ||||
CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | ||||
CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | ||||
CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | ||||
ContentEntityBase::$activeLangcode | protected | property | Language code identifying the entity active language. | ||||
ContentEntityBase::$defaultLangcode | protected | property | Local cache for the default language code. | ||||
ContentEntityBase::$defaultLangcodeKey | protected | property | The default langcode entity key. | ||||
ContentEntityBase::$enforceRevisionTranslationAffected | protected | property | Whether the revision translation affected flag has been enforced. | ||||
ContentEntityBase::$entityKeys | protected | property | Holds untranslatable entity keys such as the ID, bundle, and revision ID. | ||||
ContentEntityBase::$fieldDefinitions | protected | property | Local cache for field definitions. | ||||
ContentEntityBase::$fields | protected | property | The array of fields, each being an instance of FieldItemListInterface. | ||||
ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck | protected static | property | Local cache for fields to skip from the checking for translation changes. | ||||
ContentEntityBase::$isDefaultRevision | protected | property | Indicates whether this is the default revision. | ||||
ContentEntityBase::$langcodeKey | protected | property | The language entity key. | ||||
ContentEntityBase::$languages | protected | property | Local cache for the available language objects. | ||||
ContentEntityBase::$loadedRevisionId | protected | property | The loaded revision ID before the new revision was set. | ||||
ContentEntityBase::$newRevision | protected | property | Boolean indicating whether a new revision should be created on save. | ||||
ContentEntityBase::$revisionTranslationAffectedKey | protected | property | The revision translation affected entity key. | ||||
ContentEntityBase::$translatableEntityKeys | protected | property | Holds translatable entity keys such as the label. | ||||
ContentEntityBase::$translationInitialize | protected | property | A flag indicating whether a translation object is being initialized. | ||||
ContentEntityBase::$translations | protected | property | An array of entity translation metadata. | ||||
ContentEntityBase::$validated | protected | property | Whether entity validation was performed. | ||||
ContentEntityBase::$validationRequired | protected | property | Whether entity validation is required before saving the entity. | ||||
ContentEntityBase::$values | protected | property | The plain data values of the contained fields. | ||||
ContentEntityBase::access | public | function | Checks data value access. | Overrides EntityBase::access | 1 | ||
ContentEntityBase::addTranslation | public | function | |||||
ContentEntityBase::bundle | public | function | Gets the bundle of the entity. | Overrides EntityBase::bundle | |||
ContentEntityBase::bundleFieldDefinitions | public static | function | 4 | ||||
ContentEntityBase::clearTranslationCache | protected | function | Clear entity translation object cache to remove stale references. | ||||
ContentEntityBase::createDuplicate | public | function | Creates a duplicate of the entity. | Overrides EntityBase::createDuplicate | 1 | ||
ContentEntityBase::get | public | function | |||||
ContentEntityBase::getFieldDefinition | public | function | |||||
ContentEntityBase::getFieldDefinitions | public | function | |||||
ContentEntityBase::getFields | public | function | |||||
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck | protected | function | Returns an array of field names to skip in ::hasTranslationChanges. | 1 | |||
ContentEntityBase::getIterator | public | function | |||||
ContentEntityBase::getLanguages | protected | function | |||||
ContentEntityBase::getLoadedRevisionId | public | function | |||||
ContentEntityBase::getRevisionId | public | function | |||||
ContentEntityBase::getTranslatableFields | public | function | |||||
ContentEntityBase::getTranslatedField | protected | function | Gets a translated field. | ||||
ContentEntityBase::getTranslation | public | function | |||||
ContentEntityBase::getTranslationLanguages | public | function | |||||
ContentEntityBase::getTranslationStatus | public | function | Returns the translation status. | Overrides TranslationStatusInterface::getTranslationStatus | |||
ContentEntityBase::getUntranslated | public | function | |||||
ContentEntityBase::hasField | public | function | |||||
ContentEntityBase::hasTranslation | public | function | |||||
ContentEntityBase::hasTranslationChanges | public | function | |||||
ContentEntityBase::id | public | function | Gets the identifier. | Overrides EntityBase::id | |||
ContentEntityBase::initializeTranslation | protected | function | Instantiates a translation object for an existing translation. | ||||
ContentEntityBase::isDefaultRevision | public | function | |||||
ContentEntityBase::isDefaultTranslation | public | function | |||||
ContentEntityBase::isDefaultTranslationAffectedOnly | public | function | |||||
ContentEntityBase::isLatestRevision | public | function | |||||
ContentEntityBase::isLatestTranslationAffectedRevision | public | function | |||||
ContentEntityBase::isNewRevision | public | function | |||||
ContentEntityBase::isNewTranslation | public | function | |||||
ContentEntityBase::isRevisionTranslationAffected | public | function | |||||
ContentEntityBase::isRevisionTranslationAffectedEnforced | public | function | |||||
ContentEntityBase::isTranslatable | public | function | |||||
ContentEntityBase::isValidationRequired | public | function | |||||
ContentEntityBase::label | public | function | Gets the label of the entity. | Overrides EntityBase::label | 6 | ||
ContentEntityBase::language | public | function | Gets the language of the entity. | Overrides EntityBase::language | |||
ContentEntityBase::onChange | public | function | |||||
ContentEntityBase::postCreate | public | function | Acts on a created entity before hooks are invoked. | Overrides EntityBase::postCreate | |||
ContentEntityBase::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides EntityBase::postSave | 9 | ||
ContentEntityBase::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides EntityBase::preSave | 8 | ||
ContentEntityBase::preSaveRevision | public | function | 3 | ||||
ContentEntityBase::referencedEntities | public | function | Gets a list of entities referenced by this entity. | Overrides EntityBase::referencedEntities | 1 | ||
ContentEntityBase::removeTranslation | public | function | |||||
ContentEntityBase::set | public | function | |||||
ContentEntityBase::setDefaultLangcode | protected | function | Populates the local cache for the default language code. | ||||
ContentEntityBase::setNewRevision | public | function | |||||
ContentEntityBase::setRevisionTranslationAffected | public | function | |||||
ContentEntityBase::setRevisionTranslationAffectedEnforced | public | function | |||||
ContentEntityBase::setValidationRequired | public | function | |||||
ContentEntityBase::toArray | public | function | Gets an array of all property values. | Overrides EntityBase::toArray | |||
ContentEntityBase::updateFieldLangcodes | protected | function | Updates language for already instantiated fields. | ||||
ContentEntityBase::updateLoadedRevisionId | public | function | |||||
ContentEntityBase::updateOriginalValues | public | function | Updates the original values with the interim changes. | ||||
ContentEntityBase::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | Overrides EntityBase::uuid | |||
ContentEntityBase::validate | public | function | 1 | ||||
ContentEntityBase::wasDefaultRevision | public | function | |||||
ContentEntityBase::__clone | public | function | Magic method: Implements a deep clone. | ||||
ContentEntityBase::__construct | public | function | Constructs an Entity object. | Overrides EntityBase::__construct | |||
ContentEntityBase::__get | public | function | Implements the magic method for getting object properties. | ||||
ContentEntityBase::__isset | public | function | Implements the magic method for isset(). | ||||
ContentEntityBase::__set | public | function | Implements the magic method for setting object properties. | ||||
ContentEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | ||||
ContentEntityBase::__unset | public | function | Implements the magic method for unset(). | ||||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||||
DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep | 1 | |||
DependencySerializationTrait::__wakeup | public | function | 2 | ||||
EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | ||||
EntityBase::$entityTypeId | protected | property | The entity type. | ||||
EntityBase::$typedData | protected | property | A typed data object wrapping this entity. | ||||
EntityBase::create | public static | function | Constructs a new entity object, without permanently saving it. | Overrides EntityInterface::create | |||
EntityBase::delete | public | function | Deletes an entity permanently. | Overrides EntityInterface::delete | 2 | ||
EntityBase::enforceIsNew | public | function | Enforces an entity to be new. | Overrides EntityInterface::enforceIsNew | |||
EntityBase::entityManager | Deprecated | protected | function | Gets the entity manager. | |||
EntityBase::entityTypeBundleInfo | protected | function | Gets the entity type bundle info service. | ||||
EntityBase::entityTypeManager | protected | function | Gets the entity type manager. | ||||
EntityBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyTrait::getCacheContexts | |||
EntityBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyTrait::getCacheMaxAge | |||
EntityBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyTrait::getCacheTags | |||
EntityBase::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | Overrides EntityInterface::getCacheTagsToInvalidate | 4 | ||
EntityBase::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | Overrides EntityInterface::getConfigDependencyKey | |||
EntityBase::getConfigDependencyName | public | function | Gets the configuration dependency name. | Overrides EntityInterface::getConfigDependencyName | 1 | ||
EntityBase::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | Overrides EntityInterface::getConfigTarget | 1 | ||
EntityBase::getEntityType | public | function | Gets the entity type definition. | Overrides EntityInterface::getEntityType | |||
EntityBase::getEntityTypeId | public | function | Gets the ID of the type of the entity. | Overrides EntityInterface::getEntityTypeId | |||
EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | ||||
EntityBase::getOriginalId | public | function | Gets the original ID. | Overrides EntityInterface::getOriginalId | 1 | ||
EntityBase::getTypedData | public | function | Gets a typed data object for this entity object. | Overrides EntityInterface::getTypedData | |||
EntityBase::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | Overrides EntityInterface::hasLinkTemplate | |||
EntityBase::invalidateTagsOnDelete | protected static | function | Invalidates an entity's cache tags upon delete. | 1 | |||
EntityBase::invalidateTagsOnSave | protected | function | Invalidates an entity's cache tags upon save. | 1 | |||
EntityBase::isNew | public | function | Determines whether the entity is new. | Overrides EntityInterface::isNew | 2 | ||
EntityBase::languageManager | protected | function | Gets the language manager. | ||||
EntityBase::link | public | function | Deprecated way of generating a link to the entity. See toLink(). | Overrides EntityInterface::link | 1 | ||
EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | |||
EntityBase::load | public static | function | Loads an entity. | Overrides EntityInterface::load | |||
EntityBase::loadMultiple | public static | function | Loads one or more entities. | Overrides EntityInterface::loadMultiple | |||
EntityBase::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides EntityInterface::postDelete | 18 | ||
EntityBase::postLoad | public static | function | Acts on loaded entities. | Overrides EntityInterface::postLoad | 2 | ||
EntityBase::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityInterface::preDelete | 6 | ||
EntityBase::save | public | function | Saves an entity permanently. | Overrides EntityInterface::save | 3 | ||
EntityBase::setOriginalId | public | function | Sets the original ID. | Overrides EntityInterface::setOriginalId | 1 | ||
EntityBase::toLink | public | function | Generates the HTML for a link to this entity. | Overrides EntityInterface::toLink | |||
EntityBase::toUrl | public | function | Gets the URL object for the entity. | Overrides EntityInterface::toUrl | 2 | ||
EntityBase::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | Overrides EntityInterface::uriRelationships | |||
EntityBase::url | public | function | Gets the public URL for this entity. | Overrides EntityInterface::url | 2 | ||
EntityBase::urlInfo | public | function | Gets the URL object for the entity. | Overrides EntityInterface::urlInfo | 1 | ||
EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 2 | |||
EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | ||||
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck | protected | function | Returns an array of field names to skip when checking for changes. | Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck | |||
EntitySerializedField::baseFieldDefinitions | public static | function | Overrides EntityTest::baseFieldDefinitions | ||||
EntityTest::getEntityKey | public | function | Gets the value of the given entity key, if defined. | Overrides ContentEntityBase::getEntityKey | |||
EntityTest::getName | public | function | Returns the name. | ||||
EntityTest::getOwner | public | function | Returns the entity owner's user entity. | Overrides EntityOwnerInterface::getOwner | |||
EntityTest::getOwnerId | public | function | Returns the entity owner's user ID. | Overrides EntityOwnerInterface::getOwnerId | |||
EntityTest::preCreate | public static | function | Changes the values of an entity before it is created. | Overrides EntityBase::preCreate | |||
EntityTest::setName | public | function | Sets the name. | ||||
EntityTest::setOwner | public | function | Sets the entity owner's user entity. | Overrides EntityOwnerInterface::setOwner | |||
EntityTest::setOwnerId | public | function | Sets the entity owner's user ID. | Overrides EntityOwnerInterface::setOwnerId | |||
RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | ||||
RefinableCacheableDependencyTrait::addCacheContexts | public | function | |||||
RefinableCacheableDependencyTrait::addCacheTags | public | function | |||||
RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | |||||
SynchronizableEntityTrait::$isSyncing | protected | property | Whether this entity is being created, updated or deleted through a synchronization process. |
||||
SynchronizableEntityTrait::isSyncing | public | function | |||||
SynchronizableEntityTrait::setSyncing | public | function | |||||
TranslationStatusInterface::TRANSLATION_CREATED | constant | Status code identifying a newly created translation. | |||||
TranslationStatusInterface::TRANSLATION_EXISTING | constant | Status code identifying an existing translation. | |||||
TranslationStatusInterface::TRANSLATION_REMOVED | constant | Status code identifying a removed translation. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.