class EntityFormDisplay

Configuration entity that contains widget options for all components of a entity form in a given form mode.

Plugin annotation

@ConfigEntityType(
  id = "entity_form_display",
  label = @Translation("Entity form display"),
  entity_keys = {
    "id" = "id",
    "status" = "status"
  },
  config_export = {
    "id",
    "targetEntityType",
    "bundle",
    "mode",
    "content",
    "hidden",
  }
)

Hierarchy

• class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
  • class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses PluginDependencyTrait
    • class \Drupal\Core\Entity\EntityDisplayBase implements EntityDisplayInterface
      • class \Drupal\Core\Entity\Entity\EntityFormDisplay implements EntityFormDisplayInterface

File

core/lib/Drupal/Core/Entity/Entity/EntityFormDisplay.php, line 36

Namespace

Drupal\Core\Entity\Entity

Members

Name	Modifiers	Type	Description
ConfigEntityBase::$isSyncing	private	property	Whether the config is being created, updated or deleted through the import process.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides Entity::createDuplicate
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides Entity::getCacheTagsToInvalidate
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides Entity::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides Entity::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides Entity::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides Entity::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides Entity::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::isSyncing	public	function	Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface::isSyncing
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides Entity::link
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides Entity::preDelete
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides Entity::save
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides Entity::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setSyncing	public	function	Sets the status of the isSyncing flag. Overrides ConfigEntityInterface::setSyncing
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides Entity::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides Entity::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides Entity::urlInfo
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
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::access	public	function	Checks data value access. Overrides AccessibleInterface::access
Entity::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle
Entity::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
Entity::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete
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::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
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::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::label	public	function	Gets the label of the entity. Overrides EntityInterface::label
Entity::language	public	function	Gets the language of the entity. Overrides EntityInterface::language
Entity::languageManager	protected	function	Gets the language manager.
Entity::linkTemplates	protected	function	Gets an array link templates.
Entity::load	public static	function	Loads an entity. Overrides EntityInterface::load
Entity::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
Entity::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate
Entity::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete
Entity::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad
Entity::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave
Entity::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate
Entity::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities
Entity::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.
Entity::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid
Entity::uuidGenerator	protected	function	Gets the UUID generator.
EntityDisplayBase::$bundle	protected	property	Bundle to be displayed.
EntityDisplayBase::$content	protected	property	List of component display options, keyed by component name.
EntityDisplayBase::$fieldDefinitions	protected	property	A list of field definitions eligible for configuration in this display.
EntityDisplayBase::$hidden	protected	property	List of components that are set to be hidden.
EntityDisplayBase::$id	protected	property	Unique ID for the config entity.
EntityDisplayBase::$mode	protected	property	View or form mode to be displayed.
EntityDisplayBase::$originalMode	protected	property	The original view or form mode that was requested (case of view/form modes being configured to fall back to the 'default' display).
EntityDisplayBase::$pluginManager	protected	property	The plugin manager used by this entity type.
EntityDisplayBase::$plugins	protected	property	The plugin objects used for this display, keyed by field name.
EntityDisplayBase::$renderer	protected	property	The renderer.
EntityDisplayBase::$status	protected	property	Whether this display is enabled or not. If the entity (form) display is disabled, we'll fall back to the 'default' display. Overrides ConfigEntityBase::$status
EntityDisplayBase::$targetEntityType	protected	property	Entity type to be displayed.
EntityDisplayBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
EntityDisplayBase::createCopy	public	function	Creates a duplicate of the entity display object on a different view mode. Overrides EntityDisplayInterface::createCopy
EntityDisplayBase::CUSTOM_MODE		constant	The 'mode' for runtime EntityDisplay objects used to render entities with arbitrary display options rather than a configured view mode or form mode.
EntityDisplayBase::fieldHasDisplayOptions	private	function	Determines if a field has options for a given display.
EntityDisplayBase::getComponent	public	function	Gets the display options set for a component. Overrides EntityDisplayInterface::getComponent
EntityDisplayBase::getComponents	public	function	Gets the display options for all components. Overrides EntityDisplayInterface::getComponents
EntityDisplayBase::getFieldDefinition	protected	function	Gets the field definition of a field.
EntityDisplayBase::getFieldDefinitions	protected	function	Gets the definitions of the fields that are candidate for display.
EntityDisplayBase::getHighestWeight	public	function	Gets the highest weight of the components in the display. Overrides EntityDisplayInterface::getHighestWeight
EntityDisplayBase::getLogger	protected	function	Provides the 'system' channel logger service.
EntityDisplayBase::getMode	public	function	Gets the view or form mode to be displayed. Overrides EntityDisplayInterface::getMode
EntityDisplayBase::getOriginalMode	public	function	Gets the original view or form mode that was requested. Overrides EntityDisplayInterface::getOriginalMode
EntityDisplayBase::getPluginRemovedDependencies	protected	function	Returns the plugin dependencies being removed.
EntityDisplayBase::getTargetBundle	public	function	Gets the bundle to be displayed. Overrides EntityDisplayInterface::getTargetBundle
EntityDisplayBase::getTargetEntityTypeId	public	function	Gets the entity type for which this display is used. Overrides EntityDisplayInterface::getTargetEntityTypeId
EntityDisplayBase::id	public	function	Gets the identifier. Overrides Entity::id
EntityDisplayBase::init	protected	function	Initializes the display.
EntityDisplayBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityBase::onDependencyRemoval
EntityDisplayBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
EntityDisplayBase::removeComponent	public	function	Sets a component to be hidden. Overrides EntityDisplayInterface::removeComponent
EntityDisplayBase::setComponent	public	function	Sets the display options for a component. Overrides EntityDisplayInterface::setComponent
EntityDisplayBase::setTargetBundle	public	function	Sets the bundle to be displayed. Overrides EntityDisplayInterface::setTargetBundle
EntityDisplayBase::toArray	public	function	Gets an array of all property values. Overrides ConfigEntityBase::toArray
EntityDisplayBase::__sleep	public	function	Overrides ConfigEntityBase::__sleep
EntityDisplayBase::__wakeup	public	function	Overrides DependencySerializationTrait::__wakeup
EntityFormDisplay::$displayContext	protected	property	Context in which this entity will be used (e.g. 'display', 'form'). Overrides EntityDisplayBase::$displayContext
EntityFormDisplay::buildForm	public	function	Adds field widgets to an entity form. Overrides EntityFormDisplayInterface::buildForm
EntityFormDisplay::collectRenderDisplay	public static	function	Returns the entity_form_display object used to build an entity form.
EntityFormDisplay::extractFormValues	public	function	Extracts field values from the submitted widget values into the entity. Overrides EntityFormDisplayInterface::extractFormValues
EntityFormDisplay::flagWidgetsErrorsFromViolations	public	function	Flags entity validation violations as form errors. Overrides EntityFormDisplayInterface::flagWidgetsErrorsFromViolations
EntityFormDisplay::getPluginCollections	public	function	Gets the plugin collections used by this entity. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
EntityFormDisplay::getRenderer	public	function	Gets the renderer plugin for a field (e.g. widget, formatter). Overrides EntityDisplayInterface::getRenderer
EntityFormDisplay::movePropertyPathViolationsRelativeToField	protected	function	Moves the property path to be relative to field level.
EntityFormDisplay::processForm	public	function	Process callback: assigns weights and hides extra fields.
EntityFormDisplay::validateFormValues	public	function	Validates submitted widget values and sets the corresponding form errors. Overrides EntityFormDisplayInterface::validateFormValues
EntityFormDisplay::__construct	public	function	Constructs an Entity object. Overrides EntityDisplayBase::__construct
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.
RefinableCacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency
RefinableCacheableDependencyTrait::addCacheContexts	public	function	Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts
RefinableCacheableDependencyTrait::addCacheTags	public	function	Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge