EntityType

Gets the unique identifier of the plugin.

Sets the class.

Gets the class.

Gets the plugin provider.

The provider is the name of the module that provides the plugin, or "core', or "component".

{@inheritdoc}

{@inheritdoc}

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Formats a string containing a count of items.

Returns the number of plurals supported by a given language.

Gets the string translation service.

Sets the string translation service to use.

Constructs a new EntityType.

Gets any arbitrary property.

Sets a value to an arbitrary property.

Indicates whether the entity data is internal.

This can be used in a scenario when it is not desirable to expose data of this entity type to an external system.

The implications of this method are left to the discretion of the caller. For example, a module providing an HTTP API may not expose entities of this type or a custom entity reference field settings form may deprioritize entities of this type in a select list.

Indicates whether entities should be statically cached.

Indicates whether the rendered output of entities should be cached.

Indicates if the persistent cache of field data should be used.

Gets an array of entity keys.

Gets a specific entity key.

Indicates if a given entity key exists.

Gets the name of the original entity type class.

In case the class name was changed with setClass(), this will return the initial value. Useful when trying to identify the entity type ID based on the class.

Indicates if the entity type class implements the given interface.

Indicates if the entity type is a subclass of the given class or interface.

Gets an array of handlers.

No description

Sets the handlers for a given type.

Determines if there is a handler for a given type.

Gets the storage class.

Sets the storage class.

Checks that the provided class is compatible with the current entity type.

Gets the form class for a specific operation.

Sets a form class for a specific operation.

Indicates if this entity type has any forms.

Indicates if this entity type has any route provider.

Gets the list class.

Sets the list class.

Indicates if this entity type has a list class.

Gets the view builder class.

Gets the view builder class.

Indicates if this entity type has a view builder.

Gets all the route provide handlers.

Much like forms you can define multiple route provider handlers.

Gets the access control class.

Sets the access control handler class.

Gets the name of the default administrative permission.

The default \Drupal\Core\Entity\EntityAccessControlHandler class checks this permission for all operations in its checkAccess() method. Entities with more complex permissions can extend this class to do their own access checks.

Gets the permission granularity level.

The allowed values are respectively "entity_type" or "bundle".

Gets the link templates using the URI template syntax.

Links are an array of standard link relations to the URI template that should be used for them. Where possible, link relationships should use established IANA relationships rather than custom relationships.

Every entity type should, at minimum, define "canonical", which is the pattern for URIs to that entity. Even if the entity will have no HTML page exposed to users it should still have a canonical URI in order to be compatible with web services. Entities that will be user-editable via an HTML page must also define an "edit-form" relationship.

By default, the following placeholders are supported:

• [entityType]: The entity type itself will also be a valid token for the ID of the entity. For instance, a placeholder of {node} used on the Node class.
• [bundleEntityType]: The bundle machine name itself. For instance, a placeholder of {node_type} used on the Node class.

Specific entity types may also expand upon this list by overriding the Entity::urlRouteParameters() method.

Gets the link template for a given key.

Indicates if a link template exists for a given key.

Sets a single link template.

Gets the callback for the label of the entity.

The function takes an entity and returns the label of the entity. Use language() on the entity to get information on the requested language. The entity label is the main string associated with an entity; for example, the title of a node or the subject of a comment. If there is an entity object property that defines the label, use the 'label' element of the 'entity_keys' return value component to provide this information. If more complex logic is needed to determine the label of an entity, you can instead specify a callback function here, which will be called to determine the entity label.

Sets the label callback.

Indicates if a label callback exists.

Gets the name of the entity type which provides bundles.

Gets the entity type for which this entity provides bundles.

It can be used by other modules to act accordingly; for example, the Field UI module uses it to add operation links to manage fields and displays.

Gets the label for the bundle.

Gets the name of the entity's base table.

Indicates whether the revision form fields should be added to the form.

Indicates whether entities of this type have multilingual support.

At an entity level, this indicates language support and at a bundle level this indicates translation support.

Indicates whether entities of this type have revision support.

Gets the name of the entity's revision data table.

Gets the name of the entity's revision table.

Gets the name of the entity's data table.

Gets the human-readable name of the entity type.

This label should be used to present a human-readable name of the entity type.

Gets the lowercase form of the human-readable entity type name.

Gets the uppercase plural form of the name of the entity type.

This should return a human-readable version of the name that can refer to all the entities of the given type, collectively. An example usage of this is the page title of a page devoted to a collection of entities such as "Workflows" (instead of "Workflow entities").

Gets the indefinite singular form of the name of the entity type.

This should return the human-readable name for a single instance of the entity type. For example: "opportunity" (with the plural as "opportunities"), "child" (with the plural as "children"), or "content item" (with the plural as "content items").

Think of it as an "in a full sentence, this is what we call this" label. As a consequence, the English version is lowercase.

Gets the indefinite plural form of the name of the entity type.

This should return the human-readable name for more than one instance of the entity type. For example: "opportunities" (with the singular as "opportunity"), "children" (with the singular as "child"), or "content items" (with the singular as "content item").

Gets the label's definite article form for use with a count of entities.

This label should be used when the quantity of entities is provided. The name should be returned in a form usable with a count of the entities. For example: "1 opportunity", "5 opportunities", "1 child", "6 children", "1 content item", "25 content items".

Gets a callable that can be used to provide the entity URI.

This is only called if there is no matching link template for the link relationship type, and there is no bundle-specific callback provided.

Sets a callable to use to provide the entity URI.

Gets the machine name of the entity type group.

Gets the human-readable name of the entity type group.

The list cache contexts associated with this entity type.

Enables code listing entities of this type to ensure that rendered listings are varied as necessary, typically to ensure users of role A see other entities listed than users of role B.

The list cache tags associated with this entity type.

Enables code listing entities of this type to ensure that newly created entities show up immediately.

Gets the key that is used to store configuration dependencies.

Indicates whether this entity type is commonly used as a reference target.

Gets an array of validation constraints.

See \Drupal\Core\TypedData\DataDefinitionInterface::getConstraints() for details on how constraints are defined.

Sets the array of validation constraints for the FieldItemList.

NOTE: This will overwrite any previously set constraints. In most cases ContentEntityTypeInterface::addConstraint() should be used instead. See \Drupal\Core\TypedData\DataDefinitionInterface::getConstraints() for details on how constraints are defined.

Adds a validation constraint.

See \Drupal\Core\TypedData\DataDefinitionInterface::getConstraints() for details on how constraints are defined.

Gets the config dependency info for this entity, if any exists.