Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/ContentEntityTypeInterface.php \Drupal\Core\Entity\ContentEntityTypeInterface
  2. 9 core/lib/Drupal/Core/Entity/ContentEntityTypeInterface.php \Drupal\Core\Entity\ContentEntityTypeInterface

Provides an interface for a content entity type and its metadata.

Hierarchy

Expanded class hierarchy of ContentEntityTypeInterface

All classes that implement ContentEntityTypeInterface

24 files declare their use of ContentEntityTypeInterface
CommentStorageSchema.php in core/modules/comment/src/CommentStorageSchema.php
ConfigImportAllTest.php in core/modules/config/tests/src/Functional/ConfigImportAllTest.php
ContentEntity.php in core/modules/migrate_drupal/src/Plugin/migrate/source/ContentEntity.php
ContentEntityDeriver.php in core/modules/migrate_drupal/src/Plugin/migrate/source/ContentEntityDeriver.php
ContentLanguageSettingsForm.php in core/modules/language/src/Form/ContentLanguageSettingsForm.php

... See full list

File

core/lib/Drupal/Core/Entity/ContentEntityTypeInterface.php, line 8

Namespace

Drupal\Core\Entity
View source
interface ContentEntityTypeInterface extends EntityTypeInterface {

  /**
   * Gets an array of entity revision metadata keys.
   *
   * @return array
   *   An array describing how the Field API can extract revision metadata
   *   information of this entity type:
   *   - revision_log_message: The name of the property that contains description
   *     of the changes that were made in the current revision.
   *   - revision_user: The name of the property that contains the user ID of
   *     the author of the current revision.
   *   - revision_created: The name of the property that contains the timestamp
   *     of the current revision.
   */
  public function getRevisionMetadataKeys();

  /**
   * Gets a specific entity revision metadata key.
   *
   * @param string $key
   *   The name of the entity revision metadata key to return.
   *
   * @return string|bool
   *   The entity revision metadata key, or FALSE if it does not exist.
   *
   * @see self::getRevisionMetadataKeys()
   */
  public function getRevisionMetadataKey($key);

  /**
   * Indicates if a given entity revision metadata key exists.
   *
   * @param string $key
   *   The name of the entity revision metadata key to check.
   *
   * @return bool
   *   TRUE if a given entity revision metadata key exists, FALSE otherwise.
   */
  public function hasRevisionMetadataKey($key);

  /**
   * Sets a revision metadata key.
   *
   * @param string $key
   *   The name of the entity revision metadata key to set.
   * @param string|null $field_name
   *   The name of the entity field key to use for the revision metadata key. If
   *   NULL is passed, the value of the revision metadata key is unset.
   *
   * @return $this
   */
  public function setRevisionMetadataKey($key, $field_name);

}

Members

Namesort descending Modifiers Type Description Overrides
ContentEntityTypeInterface::getRevisionMetadataKey public function Gets a specific entity revision metadata key. 1
ContentEntityTypeInterface::getRevisionMetadataKeys public function Gets an array of entity revision metadata keys. 1
ContentEntityTypeInterface::hasRevisionMetadataKey public function Indicates if a given entity revision metadata key exists. 1
ContentEntityTypeInterface::setRevisionMetadataKey public function Sets a revision metadata key. 1
EntityTypeInterface::addConstraint public function Adds a validation constraint. 1
EntityTypeInterface::BUNDLE_MAX_LENGTH constant The maximum length of bundle name, in characters.
EntityTypeInterface::entityClassImplements public function Indicates if the entity type class implements the given interface. 1
EntityTypeInterface::get public function Gets any arbitrary property. 1
EntityTypeInterface::getAccessControlClass public function Gets the access control class. 1
EntityTypeInterface::getAdminPermission public function Gets the name of the default administrative permission. 1
EntityTypeInterface::getBaseTable public function Gets the name of the entity's base table. 1
EntityTypeInterface::getBundleConfigDependency public function Gets the config dependency info for this entity, if any exists. 1
EntityTypeInterface::getBundleEntityType public function Gets the name of the entity type which provides bundles. 1
EntityTypeInterface::getBundleLabel public function Gets the label for the bundle. 1
EntityTypeInterface::getBundleOf public function Gets the entity type for which this entity provides bundles. 1
EntityTypeInterface::getCollectionLabel public function Gets the uppercase plural form of the name of the entity type. 1
EntityTypeInterface::getCollectionPermission public function Gets the name of the default collection permission. 1
EntityTypeInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 1
EntityTypeInterface::getConstraints public function Gets an array of validation constraints. 1
EntityTypeInterface::getCountLabel public function Gets the label's definite article form for use with a count of entities. 1
EntityTypeInterface::getDataTable public function Gets the name of the entity's data table. 1
EntityTypeInterface::getFormClass public function Gets the form class for a specific operation. 1
EntityTypeInterface::getGroup public function Gets the machine name of the entity type group. 1
EntityTypeInterface::getGroupLabel public function Gets the human-readable name of the entity type group. 1
EntityTypeInterface::getHandlerClass public function 1
EntityTypeInterface::getHandlerClasses public function Gets an array of handlers. 1
EntityTypeInterface::getKey public function Gets a specific entity key. 1
EntityTypeInterface::getKeys public function Gets an array of entity keys. 1
EntityTypeInterface::getLabel public function Gets the human-readable name of the entity type. 1
EntityTypeInterface::getLinkTemplate public function Gets the link template for a given key. 1
EntityTypeInterface::getLinkTemplates public function Gets the link templates using the URI template syntax. 1
EntityTypeInterface::getListBuilderClass public function Gets the list class. 1
EntityTypeInterface::getListCacheContexts public function The list cache contexts associated with this entity type. 1
EntityTypeInterface::getListCacheTags public function The list cache tags associated with this entity type. 1
EntityTypeInterface::getOriginalClass public function Gets the name of the original entity type class. 1
EntityTypeInterface::getPermissionGranularity public function Gets the permission granularity level. 1
EntityTypeInterface::getPluralLabel public function Gets the indefinite plural form of the name of the entity type. 1
EntityTypeInterface::getRevisionDataTable public function Gets the name of the entity's revision data table. 1
EntityTypeInterface::getRevisionTable public function Gets the name of the entity's revision table. 1
EntityTypeInterface::getRouteProviderClasses public function Gets all the route provide handlers. 1
EntityTypeInterface::getSingularLabel public function Gets the indefinite singular form of the name of the entity type. 1
EntityTypeInterface::getStorageClass public function Gets the storage class. 1
EntityTypeInterface::getUriCallback public function Gets a callable that can be used to provide the entity URI. 1
EntityTypeInterface::getViewBuilderClass public function Gets the view builder class. 1
EntityTypeInterface::hasFormClasses public function Indicates if this entity type has any forms. 1
EntityTypeInterface::hasHandlerClass public function Determines if there is a handler for a given type. 1
EntityTypeInterface::hasKey public function Indicates if a given entity key exists. 1
EntityTypeInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 1
EntityTypeInterface::hasListBuilderClass public function Indicates if this entity type has a list class. 1
EntityTypeInterface::hasRouteProviders public function Indicates if this entity type has any route provider. 1
EntityTypeInterface::hasViewBuilderClass public function Indicates if this entity type has a view builder. 1
EntityTypeInterface::ID_MAX_LENGTH constant The maximum length of ID, in characters.
EntityTypeInterface::isCommonReferenceTarget public function Indicates whether this entity type is commonly used as a reference target. 1
EntityTypeInterface::isInternal public function Indicates whether the entity data is internal. 1
EntityTypeInterface::isPersistentlyCacheable public function Indicates if the persistent cache of field data should be used. 1
EntityTypeInterface::isRenderCacheable public function Indicates whether the rendered output of entities should be cached. 1
EntityTypeInterface::isRevisionable public function Indicates whether entities of this type have revision support. 1
EntityTypeInterface::isStaticallyCacheable public function Indicates whether entities should be statically cached. 1
EntityTypeInterface::isTranslatable public function Indicates whether entities of this type have multilingual support. 1
EntityTypeInterface::set public function Sets a value to an arbitrary property. 1
EntityTypeInterface::setAccessClass public function Sets the access control handler class. 1
EntityTypeInterface::setConstraints public function Sets the array of validation constraints for the FieldItemList. 1
EntityTypeInterface::setFormClass public function Sets a form class for a specific operation. 1
EntityTypeInterface::setHandlerClass public function Sets the handlers for a given type. 1
EntityTypeInterface::setLinkTemplate public function Sets a single link template. 1
EntityTypeInterface::setListBuilderClass public function Sets the list class. 1
EntityTypeInterface::setStorageClass public function Sets the storage class. 1
EntityTypeInterface::setUriCallback public function Sets a callable to use to provide the entity URI. 1
EntityTypeInterface::setViewBuilderClass public function Gets the view builder class. 1
EntityTypeInterface::showRevisionUi public function Indicates whether the revision form fields should be added to the form. 1
PluginDefinitionInterface::getClass public function Gets the class. 1
PluginDefinitionInterface::getProvider public function Gets the plugin provider. 1
PluginDefinitionInterface::id public function Gets the unique identifier of the plugin. 1
PluginDefinitionInterface::setClass public function Sets the class. 1