class EntityTestExternal
Test entity class.
Plugin annotation
@ContentEntityType(
id = "entity_test_external",
label = @Translation("Entity test external"),
base_table = "entity_test_external",
entity_keys = {
"id" = "id",
"uuid" = "uuid",
"bundle" = "type",
},
links = {
"canonical" = "/entity_test_external/{entity_test_external}"
},
)
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 implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
- class \Drupal\entity_test\Entity\EntityTest implements \Drupal\user\EntityOwnerInterface extends \Drupal\Core\Entity\ContentEntityBase
- class \Drupal\entity_test\Entity\EntityTestExternal extends \Drupal\entity_test\Entity\EntityTest
- class \Drupal\entity_test\Entity\EntityTest implements \Drupal\user\EntityOwnerInterface extends \Drupal\Core\Entity\ContentEntityBase
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
Expanded class hierarchy of EntityTestExternal
1 file declares its use of EntityTestExternal
- MenuLinksTest.php in core/
modules/ menu_link_content/ tests/ src/ Kernel/ MenuLinksTest.php
File
-
core/
modules/ system/ tests/ modules/ entity_test/ src/ Entity/ EntityTestExternal.php, line 24
Namespace
Drupal\entity_test\EntityView source
class EntityTestExternal extends EntityTest {
/**
* {@inheritdoc}
*/
public function toUrl($rel = 'canonical', array $options = []) {
if ($rel === 'canonical') {
return Url::fromUri('http://example.com', $options);
}
return parent::toUrl($rel, $options);
}
}
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 | Adds a new translation to the translatable object. | Overrides TranslatableInterface::addTranslation | |||
| ContentEntityBase::bundle | public | function | Gets the bundle of the entity. | Overrides EntityBase::bundle | |||
| ContentEntityBase::bundleFieldDefinitions | public static | function | Provides field definitions for a specific bundle. | Overrides FieldableEntityInterface::bundleFieldDefinitions | 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 | Gets a field item list. | Overrides FieldableEntityInterface::get | |||
| ContentEntityBase::getFieldDefinition | public | function | Gets the definition of a contained field. | Overrides FieldableEntityInterface::getFieldDefinition | |||
| ContentEntityBase::getFieldDefinitions | public | function | Gets an array of field definitions of all contained fields. | Overrides FieldableEntityInterface::getFieldDefinitions | |||
| ContentEntityBase::getFields | public | function | Gets an array of all field item lists. | Overrides FieldableEntityInterface::getFields | |||
| 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 | Gets the loaded Revision ID of the entity. | Overrides RevisionableInterface::getLoadedRevisionId | |||
| ContentEntityBase::getRevisionId | public | function | Gets the revision identifier of the entity. | Overrides RevisionableInterface::getRevisionId | |||
| ContentEntityBase::getTranslatableFields | public | function | Gets an array of field item lists for translatable fields. | Overrides FieldableEntityInterface::getTranslatableFields | |||
| ContentEntityBase::getTranslatedField | protected | function | Gets a translated field. | ||||
| ContentEntityBase::getTranslation | public | function | Gets a translation of the data. | Overrides TranslatableInterface::getTranslation | |||
| ContentEntityBase::getTranslationLanguages | public | function | Returns the languages the data is translated to. | Overrides TranslatableInterface::getTranslationLanguages | |||
| ContentEntityBase::getTranslationStatus | public | function | Returns the translation status. | Overrides TranslationStatusInterface::getTranslationStatus | |||
| ContentEntityBase::getUntranslated | public | function | Returns the translatable object referring to the original language. | Overrides TranslatableInterface::getUntranslated | |||
| ContentEntityBase::hasField | public | function | Determines whether the entity has a field with the given name. | Overrides FieldableEntityInterface::hasField | |||
| ContentEntityBase::hasTranslation | public | function | Checks there is a translation for the given language code. | Overrides TranslatableInterface::hasTranslation | |||
| ContentEntityBase::hasTranslationChanges | public | function | Determines if the current translation of the entity has unsaved changes. | Overrides TranslatableInterface::hasTranslationChanges | |||
| 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 | Checks if this entity is the default revision. | Overrides RevisionableInterface::isDefaultRevision | |||
| ContentEntityBase::isDefaultTranslation | public | function | Checks whether the translation is the default one. | Overrides TranslatableInterface::isDefaultTranslation | |||
| ContentEntityBase::isDefaultTranslationAffectedOnly | public | function | Checks if untranslatable fields should affect only the default translation. | Overrides TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly | |||
| ContentEntityBase::isLatestRevision | public | function | Checks if this entity is the latest revision. | Overrides RevisionableInterface::isLatestRevision | |||
| ContentEntityBase::isLatestTranslationAffectedRevision | public | function | Checks whether this is the latest revision affecting this translation. | Overrides TranslatableRevisionableInterface::isLatestTranslationAffectedRevision | |||
| ContentEntityBase::isNewRevision | public | function | Determines whether a new revision should be created on save. | Overrides RevisionableInterface::isNewRevision | |||
| ContentEntityBase::isNewTranslation | public | function | Checks whether the translation is new. | Overrides TranslatableInterface::isNewTranslation | |||
| ContentEntityBase::isRevisionTranslationAffected | public | function | Checks whether the current translation is affected by the current revision. | Overrides TranslatableRevisionableInterface::isRevisionTranslationAffected | |||
| ContentEntityBase::isRevisionTranslationAffectedEnforced | public | function | Checks if the revision translation affected flag value has been enforced. | Overrides TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced | |||
| ContentEntityBase::isTranslatable | public | function | Returns the translation support status. | Overrides TranslatableInterface::isTranslatable | |||
| ContentEntityBase::isValidationRequired | public | function | Checks whether entity validation is required before saving the entity. | Overrides FieldableEntityInterface::isValidationRequired | |||
| 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 | Reacts to changes to a field. | Overrides FieldableEntityInterface::onChange | |||
| 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 | Acts on a revision before it gets saved. | Overrides RevisionableInterface::preSaveRevision | 3 | ||
| ContentEntityBase::referencedEntities | public | function | Gets a list of entities referenced by this entity. | Overrides EntityBase::referencedEntities | 1 | ||
| ContentEntityBase::removeTranslation | public | function | Removes the translation identified by the given language code. | Overrides TranslatableInterface::removeTranslation | |||
| ContentEntityBase::set | public | function | Sets a field value. | Overrides FieldableEntityInterface::set | |||
| ContentEntityBase::setDefaultLangcode | protected | function | Populates the local cache for the default language code. | ||||
| ContentEntityBase::setNewRevision | public | function | Enforces an entity to be saved as a new revision. | Overrides RevisionableInterface::setNewRevision | |||
| ContentEntityBase::setRevisionTranslationAffected | public | function | Marks the current revision translation as affected. | Overrides TranslatableRevisionableInterface::setRevisionTranslationAffected | |||
| ContentEntityBase::setRevisionTranslationAffectedEnforced | public | function | Enforces the revision translation affected flag value. | Overrides TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced | |||
| ContentEntityBase::setValidationRequired | public | function | Sets whether entity validation is required before saving the entity. | Overrides FieldableEntityInterface::setValidationRequired | |||
| 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 | Updates the loaded Revision ID with the revision ID. | Overrides RevisionableInterface::updateLoadedRevisionId | |||
| 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 | Validates the currently set values. | Overrides FieldableEntityInterface::validate | 1 | ||
| ContentEntityBase::wasDefaultRevision | public | function | Checks whether the entity object was a default revision when it was saved. | Overrides RevisionableInterface::wasDefaultRevision | |||
| 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::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 | |||
| EntityTest::baseFieldDefinitions | public static | function | Provides base field definitions for an entity type. | Overrides ContentEntityBase::baseFieldDefinitions | 14 | ||
| 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 | |||
| EntityTestExternal::toUrl | public | function | Gets the URL object for the entity. | Overrides EntityBase::toUrl | |||
| 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.