class EntityTest in Zircon Profile 8.0

Defines the test entity class.

Plugin annotation

@ContentEntityType(
  id = "entity_test",
  label = @Translation("Test entity"),
  handlers = {
    "list_builder" = "Drupal\entity_test\EntityTestListBuilder",
    "view_builder" = "Drupal\entity_test\EntityTestViewBuilder",
    "access" = "Drupal\entity_test\EntityTestAccessControlHandler",
    "form" = {
      "default" = "Drupal\entity_test\EntityTestForm",
      "delete" = "Drupal\entity_test\EntityTestDeleteForm"
    },
    "route_provider" = {
      "html" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
    },
    "translation" = "Drupal\content_translation\ContentTranslationHandler",
    "views_data" = "Drupal\entity_test\EntityTestViewsData"
  },
  base_table = "entity_test",
  admin_permission = "administer entity_test content",
  persistent_cache = FALSE,
  list_cache_contexts = { "entity_test_view_grants" },
  entity_keys = {
    "id" = "id",
    "uuid" = "uuid",
    "bundle" = "type",
    "label" = "name",
    "langcode" = "langcode",
  },
  links = {
    "canonical" = "/entity_test/{entity_test}",
    "edit-form" = "/entity_test/manage/{entity_test}/edit",
    "delete-form" = "/entity_test/delete/entity_test/{entity_test}",
  },
  field_ui_base_route = "entity.entity_test.admin_form",
)

Hierarchy

• class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
  • class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface
    • class \Drupal\entity_test\Entity\EntityTest implements EntityOwnerInterface

32 files declare their use of EntityTest

AreaEntityUITest.php in core/modules/views_ui/src/Tests/AreaEntityUITest.php

Contains \Drupal\views_ui\Tests\AreaEntityUITest.

BaseFieldAccessTest.php in core/modules/views/src/Tests/Entity/BaseFieldAccessTest.php

Contains \Drupal\views\Tests\Entity\BaseFieldAccessTest.

BooleanFormatterTest.php in core/modules/field/src/Tests/Boolean/BooleanFormatterTest.php

Contains \Drupal\field\Tests\Boolean\BooleanFormatterTest.

CommentFieldAccessTest.php in core/modules/comment/src/Tests/CommentFieldAccessTest.php

Contains \Drupal\comment\Tests\CommentFieldAccessTest.

CommentLinksTest.php in core/modules/comment/src/Tests/Views/CommentLinksTest.php

Contains \Drupal\comment\Tests\Views\CommentLinksTest.

... See full list

File

core/modules/system/tests/modules/entity_test/src/Entity/EntityTest.php, line 56

Contains \Drupal\entity_test\Entity\EntityTest.

Namespace

Drupal\entity_test\Entity

class EntityTest extends ContentEntityBase implements EntityOwnerInterface {

  /**
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage, array &$values) {
    parent::preCreate($storage, $values);
    if (empty($values['type'])) {
      $values['type'] = $storage
        ->getEntityTypeId();
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields['id'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('ID'))
      ->setDescription(t('The ID of the test entity.'))
      ->setReadOnly(TRUE)
      ->setSetting('unsigned', TRUE);
    $fields['uuid'] = BaseFieldDefinition::create('uuid')
      ->setLabel(t('UUID'))
      ->setDescription(t('The UUID of the test entity.'))
      ->setReadOnly(TRUE);
    $fields['langcode'] = BaseFieldDefinition::create('language')
      ->setLabel(t('Language code'))
      ->setDescription(t('The language code of the test entity.'))
      ->setTranslatable(TRUE);
    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Name'))
      ->setDescription(t('The name of the test entity.'))
      ->setTranslatable(TRUE)
      ->setSetting('max_length', 32)
      ->setDisplayOptions('view', array(
      'label' => 'hidden',
      'type' => 'string',
      'weight' => -5,
    ))
      ->setDisplayOptions('form', array(
      'type' => 'string_textfield',
      'weight' => -5,
    ));

    // @todo: Add allowed values validation.
    $fields['type'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Type'))
      ->setDescription(t('The bundle of the test entity.'))
      ->setRequired(TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Authored on'))
      ->setDescription(t('Time the entity was created'))
      ->setTranslatable(TRUE);
    $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('User ID'))
      ->setDescription(t('The ID of the associated user.'))
      ->setSetting('target_type', 'user')
      ->setSetting('handler', 'default')
      ->setDefaultValue(array(
      0 => array(
        'target_id' => 1,
      ),
    ))
      ->setTranslatable(TRUE)
      ->setDisplayOptions('form', array(
      'type' => 'entity_reference_autocomplete',
      'weight' => -1,
      'settings' => array(
        'match_operator' => 'CONTAINS',
        'size' => '60',
        'placeholder' => '',
      ),
    ));
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function getOwner() {
    return $this
      ->get('user_id')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getOwnerId() {
    return $this
      ->get('user_id')->target_id;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwnerId($uid) {
    $this
      ->set('user_id', $uid);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwner(UserInterface $account) {
    $this
      ->set('user_id', $account
      ->id());
    return $this;
  }

  /**
   * Sets the name.
   *
   * @param string $name
   *   Name of the entity.
   *
   * @return $this
   */
  public function setName($name) {
    $this
      ->set('name', $name);
    return $this;
  }

  /**
   * Returns the name.
   *
   * @return string
   */
  public function getName() {
    return $this
      ->get('name')->value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::$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::$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::$newRevision	protected	property	Boolean indicating whether a new revision should be created on save.
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 Entity::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 Entity::bundle
ContentEntityBase::bundleFieldDefinitions	public static	function	Provides field definitions for a specific bundle. Overrides FieldableEntityInterface::bundleFieldDefinitions	3
ContentEntityBase::clearTranslationCache	protected	function	Clear entity translation object cache to remove stale references.
ContentEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides Entity::createDuplicate	1
ContentEntityBase::get	public	function	Gets a field item list. Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey	protected	function	Gets the value of the given entity key, if defined.
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::getIterator	public	function
ContentEntityBase::getLanguages	protected	function
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::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	Returns TRUE 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 ContentEntityInterface::hasTranslationChanges
ContentEntityBase::id	public	function	Gets the identifier. Overrides Entity::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::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 ContentEntityInterface::isRevisionTranslationAffected
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 Entity::label	3
ContentEntityBase::language	public	function	Gets the language of the entity. Overrides Entity::language
ContentEntityBase::onChange	public	function	Reacts to changes to a field. Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate	public	function	Acts on an entity after it is created but before hooks are invoked. Overrides Entity::postCreate
ContentEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides Entity::preSave	5
ContentEntityBase::preSaveRevision	public	function	Acts on a revision before it gets saved. Overrides RevisionableInterface::preSaveRevision	2
ContentEntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides Entity::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 ContentEntityInterface::setRevisionTranslationAffected
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 Entity::toArray
ContentEntityBase::TRANSLATION_CREATED		constant	Status code identifying a newly created translation.
ContentEntityBase::TRANSLATION_EXISTING		constant	Status code identifying an existing translation.
ContentEntityBase::TRANSLATION_REMOVED		constant	Status code identifying a removed translation.
ContentEntityBase::updateFieldLangcodes	protected	function	Updates language for already instantiated fields.
ContentEntityBase::updateOriginalValues	public	function	Updates the original values with the interim changes.
ContentEntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides Entity::uuid
ContentEntityBase::validate	public	function	Validates the currently set values. Overrides FieldableEntityInterface::validate
ContentEntityBase::__clone	public	function	Magic method: Implements a deep clone.
ContentEntityBase::__construct	public	function	Constructs an Entity object. Overrides Entity::__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 Entity::__sleep
ContentEntityBase::__unset	public	function	Implements the magic method for unset().
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
Entity::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
Entity::$entityTypeId	protected	property	The entity type.
Entity::$typedData	protected	property	A typed data object wrapping this entity.
Entity::create	public static	function	Overrides EntityInterface::create
Entity::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
Entity::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::entityManager Deprecated	protected	function	Gets the entity manager.
Entity::entityTypeManager	protected	function	Gets the entity type manager.
Entity::getCacheContexts	public	function	The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getCacheTags	public	function	The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate	3
Entity::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
Entity::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName	1
Entity::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget	1
Entity::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::getOriginalId	public	function	Gets the original ID. Overrides EntityInterface::getOriginalId	1
Entity::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
Entity::invalidateTagsOnDelete	protected static	function	Invalidates an entity's cache tags upon delete.	1
Entity::invalidateTagsOnSave	protected	function	Invalidates an entity's cache tags upon save.	1
Entity::isNew	public	function	Determines whether the entity is new. Overrides EntityInterface::isNew	2
Entity::languageManager	protected	function	Gets the language manager.
Entity::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link	1
Entity::linkTemplates	protected	function	Gets an array link templates.	1
Entity::load	public static	function	Overrides EntityInterface::load
Entity::loadMultiple	public static	function	Overrides EntityInterface::loadMultiple
Entity::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	14
Entity::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
Entity::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	20
Entity::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete	5
Entity::save	public	function	Saves an entity permanently. Overrides EntityInterface::save	2
Entity::setOriginalId	public	function	Sets the original ID. Overrides EntityInterface::setOriginalId	1
Entity::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::toUrl	public	function	Gets the URL object for the entity. Overrides EntityInterface::toUrl	1
Entity::uriRelationships	public	function	Returns a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::url	public	function	Gets the public URL for this entity. Overrides EntityInterface::url	2
Entity::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityInterface::urlInfo	1
Entity::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	1
Entity::uuidGenerator	protected	function	Gets the UUID generator.
EntityTest::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type. Overrides FieldableEntityInterface::baseFieldDefinitions	11
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 Entity::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::$cacheContexts	protected	property	Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function