W3cubDocs

/Drupal 8

class EntityType

Provides an implementation of an entity type and its metadata.

Hierarchy

Related topics

Entity API
Describes how to define and manipulate content and configuration entities.

File

core/lib/Drupal/Core/Entity/EntityType.php, line 15

Namespace

Drupal\Core\Entity

Members

Name Modifiers Type Description
EntityType::$additional protected property Any additional properties and values.
EntityType::$admin_permission protected property The name of the default administrative permission.
EntityType::$base_table protected property The name of the entity type's base table.
EntityType::$bundle_entity_type protected property The name of the entity type which provides bundles.
EntityType::$bundle_label protected property The human-readable name of the entity bundles, e.g. Vocabulary.
EntityType::$bundle_of protected property The name of the entity type for which bundles are provided.
EntityType::$class protected property The name of the entity type class.
EntityType::$common_reference_target protected property Indicates whether this entity type is commonly used as a reference target.
EntityType::$constraints protected property Entity constraint definitions.
EntityType::$data_table protected property The name of the entity type's data table.
EntityType::$entity_keys protected property An array of entity keys.
EntityType::$field_ui_base_route protected property The route name used by field UI to attach its management pages.
EntityType::$group protected property The machine name of the entity type group.
EntityType::$group_label protected property The human-readable name of the entity type group.
EntityType::$handlers protected property An array of handlers.
EntityType::$id protected property The unique identifier of this entity type.
EntityType::$label protected property The human-readable name of the type.
EntityType::$label_callback Deprecated protected property The name of a callback that returns the label of the entity.
EntityType::$label_count protected property A definite singular/plural name of the type.
EntityType::$label_plural protected property The indefinite plural name of the type.
EntityType::$label_singular protected property The indefinite singular name of the type.
EntityType::$links protected property Link templates using the URI template syntax.
EntityType::$list_cache_contexts protected property The list cache contexts for this entity type.
EntityType::$list_cache_tags protected property The list cache tags for this entity type.
EntityType::$originalClass protected property The name of the original entity type class.
EntityType::$permission_granularity protected property The permission granularity level.
EntityType::$persistent_cache protected property Indicates if the persistent cache of field data should be used.
EntityType::$provider protected property The name of the provider of this entity type.
EntityType::$render_cache protected property Indicates whether the rendered output of entities should be cached.
EntityType::$revision_data_table protected property The name of the entity type's revision data table.
EntityType::$revision_table protected property The name of the entity type's revision table.
EntityType::$static_cache protected property Indicates whether entities should be statically cached.
EntityType::$translatable protected property Indicates whether entities of this type have multilingual support.
EntityType::$uri_callback protected property A callable that can be used to provide the entity URI.
EntityType::addConstraint public function Adds a validation constraint. Overrides EntityTypeInterface::addConstraint
EntityType::checkStorageClass protected function Checks that the provided class is compatible with the current entity type.
EntityType::get public function Gets any arbitrary property. Overrides EntityTypeInterface::get
EntityType::getAccessControlClass public function Gets the access control class. Overrides EntityTypeInterface::getAccessControlClass
EntityType::getAdminPermission public function Gets the name of the default administrative permission. Overrides EntityTypeInterface::getAdminPermission
EntityType::getBaseTable public function Gets the name of the entity's base table. Overrides EntityTypeInterface::getBaseTable
EntityType::getBundleConfigDependency public function Gets the config dependency info for this entity, if any exists. Overrides EntityTypeInterface::getBundleConfigDependency
EntityType::getBundleEntityType public function Gets the name of the entity type which provides bundles. Overrides EntityTypeInterface::getBundleEntityType
EntityType::getBundleLabel public function Gets the label for the bundle. Overrides EntityTypeInterface::getBundleLabel
EntityType::getBundleOf public function Gets the entity type for which this entity provides bundles. Overrides EntityTypeInterface::getBundleOf
EntityType::getClass public function Gets the class. Overrides PluginDefinitionInterface::getClass
EntityType::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityTypeInterface::getConfigDependencyKey
EntityType::getConstraints public function Gets an array of validation constraints. Overrides EntityTypeInterface::getConstraints
EntityType::getCountLabel public function Gets the count label of the entity type Overrides EntityTypeInterface::getCountLabel
EntityType::getDataTable public function Gets the name of the entity's data table. Overrides EntityTypeInterface::getDataTable
EntityType::getFormClass public function Gets the form class for a specific operation. Overrides EntityTypeInterface::getFormClass
EntityType::getGroup public function Gets the machine name of the entity type group. Overrides EntityTypeInterface::getGroup
EntityType::getGroupLabel public function Gets the human-readable name of the entity type group. Overrides EntityTypeInterface::getGroupLabel
EntityType::getHandlerClass public function Overrides EntityTypeInterface::getHandlerClass
EntityType::getHandlerClasses public function Gets an array of handlers. Overrides EntityTypeInterface::getHandlerClasses
EntityType::getKey public function Gets a specific entity key. Overrides EntityTypeInterface::getKey
EntityType::getKeys public function Gets an array of entity keys. Overrides EntityTypeInterface::getKeys
EntityType::getLabel public function Gets the human-readable name of the entity type. Overrides EntityTypeInterface::getLabel
EntityType::getLabelCallback public function Gets the callback for the label of the entity. Overrides EntityTypeInterface::getLabelCallback
EntityType::getLinkTemplate public function Gets the link template for a given key. Overrides EntityTypeInterface::getLinkTemplate
EntityType::getLinkTemplates public function Gets the link templates using the URI template syntax. Overrides EntityTypeInterface::getLinkTemplates
EntityType::getListBuilderClass public function Gets the list class. Overrides EntityTypeInterface::getListBuilderClass
EntityType::getListCacheContexts public function The list cache contexts associated with this entity type. Overrides EntityTypeInterface::getListCacheContexts
EntityType::getListCacheTags public function The list cache tags associated with this entity type. Overrides EntityTypeInterface::getListCacheTags
EntityType::getLowercaseLabel public function Gets the lowercase form of the human-readable entity type name. Overrides EntityTypeInterface::getLowercaseLabel
EntityType::getOriginalClass public function Gets the name of the original entity type class. Overrides EntityTypeInterface::getOriginalClass
EntityType::getPermissionGranularity public function Gets the permission granularity level. Overrides EntityTypeInterface::getPermissionGranularity
EntityType::getPluralLabel public function Gets the plural label of the entity type. Overrides EntityTypeInterface::getPluralLabel
EntityType::getProvider public function Gets the name of the provider of this entity type. Overrides EntityTypeInterface::getProvider
EntityType::getRevisionDataTable public function Gets the name of the entity's revision data table. Overrides EntityTypeInterface::getRevisionDataTable
EntityType::getRevisionTable public function Gets the name of the entity's revision table. Overrides EntityTypeInterface::getRevisionTable
EntityType::getRouteProviderClasses public function Gets all the route provide handlers. Overrides EntityTypeInterface::getRouteProviderClasses
EntityType::getSingularLabel public function Gets the singular label of the entity type. Overrides EntityTypeInterface::getSingularLabel
EntityType::getStorageClass public function Gets the storage class. Overrides EntityTypeInterface::getStorageClass
EntityType::getUriCallback public function Gets a callable that can be used to provide the entity URI. Overrides EntityTypeInterface::getUriCallback
EntityType::getViewBuilderClass public function Gets the view builder class. Overrides EntityTypeInterface::getViewBuilderClass
EntityType::hasFormClasses public function Indicates if this entity type has any forms. Overrides EntityTypeInterface::hasFormClasses
EntityType::hasHandlerClass public function Determines if there is a handler for a given type. Overrides EntityTypeInterface::hasHandlerClass
EntityType::hasKey public function Indicates if a given entity key exists. Overrides EntityTypeInterface::hasKey
EntityType::hasLabelCallback public function Indicates if a label callback exists. Overrides EntityTypeInterface::hasLabelCallback
EntityType::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityTypeInterface::hasLinkTemplate
EntityType::hasListBuilderClass public function Indicates if this entity type has a list class. Overrides EntityTypeInterface::hasListBuilderClass
EntityType::hasRouteProviders public function Indicates if this entity type has any route provider. Overrides EntityTypeInterface::hasRouteProviders
EntityType::hasViewBuilderClass public function Indicates if this entity type has a view builder. Overrides EntityTypeInterface::hasViewBuilderClass
EntityType::id public function Gets the unique identifier of the entity type. Overrides EntityTypeInterface::id
EntityType::isCommonReferenceTarget public function Indicates whether this entity type is commonly used as a reference target. Overrides EntityTypeInterface::isCommonReferenceTarget
EntityType::isPersistentlyCacheable public function Indicates if the persistent cache of field data should be used. Overrides EntityTypeInterface::isPersistentlyCacheable
EntityType::isRenderCacheable public function Indicates whether the rendered output of entities should be cached. Overrides EntityTypeInterface::isRenderCacheable
EntityType::isRevisionable public function Indicates whether entities of this type have revision support. Overrides EntityTypeInterface::isRevisionable
EntityType::isStaticallyCacheable public function Indicates whether entities should be statically cached. Overrides EntityTypeInterface::isStaticallyCacheable
EntityType::isSubclassOf public function Indicates if the entity type is a subclass of the given class or interface. Overrides EntityTypeInterface::isSubclassOf
EntityType::isTranslatable public function Indicates whether entities of this type have multilingual support. Overrides EntityTypeInterface::isTranslatable
EntityType::set public function Sets a value to an arbitrary property. Overrides EntityTypeInterface::set
EntityType::setAccessClass public function Gets the access class. Overrides EntityTypeInterface::setAccessClass
EntityType::setClass public function Sets the class. Overrides PluginDefinitionInterface::setClass
EntityType::setConstraints public function Sets the array of validation constraints for the FieldItemList. Overrides EntityTypeInterface::setConstraints
EntityType::setFormClass public function Sets a form class for a specific operation. Overrides EntityTypeInterface::setFormClass
EntityType::setHandlerClass public function Sets the handlers for a given type. Overrides EntityTypeInterface::setHandlerClass
EntityType::setLabelCallback public function Sets the label callback. Overrides EntityTypeInterface::setLabelCallback
EntityType::setLinkTemplate public function Sets a single link template. Overrides EntityTypeInterface::setLinkTemplate
EntityType::setListBuilderClass public function Sets the list class. Overrides EntityTypeInterface::setListBuilderClass
EntityType::setStorageClass public function Sets the storage class. Overrides EntityTypeInterface::setStorageClass
EntityType::setUriCallback public function Sets a callable to use to provide the entity URI. Overrides EntityTypeInterface::setUriCallback
EntityType::setViewBuilderClass public function Gets the view builder class. Overrides EntityTypeInterface::setViewBuilderClass
EntityType::__construct public function Constructs a new EntityType.
EntityTypeInterface::BUNDLE_MAX_LENGTH constant The maximum length of bundle name, in characters. Overrides EntityTypeInterface::BUNDLE_MAX_LENGTH
EntityTypeInterface::ID_MAX_LENGTH constant The maximum length of ID, in characters. Overrides EntityTypeInterface::ID_MAX_LENGTH
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Entity!EntityType.php/class/EntityType/8.1.x