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

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

Hierarchy

Expanded class hierarchy of ConfigEntityTypeInterface

All classes that implement ConfigEntityTypeInterface

9 files declare their use of ConfigEntityTypeInterface
ConfigEntityNormalizerTest.php in core/modules/serialization/tests/src/Unit/Normalizer/ConfigEntityNormalizerTest.php
ConfigManager.php in core/lib/Drupal/Core/Config/ConfigManager.php
DefaultHtmlRouteProvider.php in core/lib/Drupal/Core/Entity/Routing/DefaultHtmlRouteProvider.php
DefaultHtmlRouteProviderTest.php in core/tests/Drupal/Tests/Core/Entity/Routing/DefaultHtmlRouteProviderTest.php
EntityFormDisplayAccessControlHandlerTest.php in core/tests/Drupal/Tests/Core/Entity/Access/EntityFormDisplayAccessControlHandlerTest.php

... See full list

File

core/lib/Drupal/Core/Config/Entity/ConfigEntityTypeInterface.php, line 10

Namespace

Drupal\Core\Config\Entity
View source
interface ConfigEntityTypeInterface extends EntityTypeInterface {

  /**
   * Length limit of the configuration entity prefix.
   *
   * Configuration entity names are composed of two parts:
   * - The config prefix, which is returned by getConfigPrefix() and is
   *   composed of:
   *   - The provider module name (limited to 50 characters by
   *     DRUPAL_EXTENSION_NAME_MAX_LENGTH).
   *   - The module-specific namespace identifier, which defaults to the
   *     configuration entity type ID. Entity type IDs are limited to 32
   *     characters by EntityTypeInterface::ID_MAX_LENGTH.
   * - The configuration entity ID.
   * So, a typical configuration entity filename will look something like:
   * provider_module_name.namespace_identifier.config_entity_id.yml
   *
   * Most file systems limit a file name's length to 255 characters, so
   * ConfigBase::MAX_NAME_LENGTH restricts the full configuration object name
   * to 250 characters (leaving 5 for the file extension). Therefore, in
   * order to leave sufficient characters to construct a configuration ID,
   * the configuration entity prefix is limited to 83 characters: up to 50
   * characters for the module name, 1 for the dot, and 32 for the namespace
   * identifier. This also allows modules with shorter names to define longer
   * namespace identifiers if desired.
   *
   * @see \Drupal\Core\Config\ConfigBase::MAX_NAME_LENGTH
   * @see \Drupal\Core\Config\Entity\ConfigEntityTypeInterface::getConfigPrefix()
   * @see DRUPAL_EXTENSION_NAME_MAX_LENGTH
   * @see \Drupal\Core\Config\Entity\ConfigEntityStorage::MAX_ID_LENGTH
   * @see \Drupal\Core\Entity\EntityTypeInterface::ID_MAX_LENGTH
   */
  const PREFIX_LENGTH = 83;

  /**
   * Gets the config prefix used by the configuration entity type.
   *
   * The config prefix is used to prefix configuration entity IDs when they are
   * stored in the configuration system. The default config prefix is
   * constructed from the name of the module that provides the entity type and
   * the ID of the entity type. If a config_prefix annotation is present it will
   * be used in place of the entity type ID.
   *
   * Prefixing with the module that provides the configuration entity type
   * ensures that configuration entities depend on the module that provides the
   * configuration entity type.
   *
   * @return string
   *   The config prefix.
   *
   * @throws \Drupal\Core\Config\ConfigPrefixLengthException
   *   Exception thrown when the length of the prefix exceeds PREFIX_LENGTH.
   */
  public function getConfigPrefix();

  /**
   * Gets the config entity properties to export if declared on the annotation.
   *
   * @param string $id
   *   The ID of the configuration entity.
   *
   * @return array|null
   *   The properties to export or NULL if they can not be determine from the
   *   config entity type annotation.
   */
  public function getPropertiesToExport($id = NULL);

  /**
   * Gets the keys that are available for fast lookup.
   *
   * @return string[]
   *   The list of lookup keys.
   */
  public function getLookupKeys();

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityTypeInterface::getConfigPrefix public function Gets the config prefix used by the configuration entity type. 1
ConfigEntityTypeInterface::getLookupKeys public function Gets the keys that are available for fast lookup. 1
ConfigEntityTypeInterface::getPropertiesToExport public function Gets the config entity properties to export if declared on the annotation. 1
ConfigEntityTypeInterface::PREFIX_LENGTH constant Length limit of the configuration entity prefix.
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