function ConfigEntityMapperInterface::setEntity

Same name in other branches
  1. 11.x core/modules/config_translation/src/ConfigEntityMapperInterface.php \Drupal\config_translation\ConfigEntityMapperInterface::setEntity()

Sets the entity instance for this mapper.

This method can only be invoked when the concrete entity is known, that is in a request for an entity translation path. After this method is called, the mapper is fully populated with the proper display title and configuration names to use to check permissions or display a translation screen.

Parameters

\Drupal\Core\Config\Entity\ConfigEntityInterface $entity: The configuration entity to set.

Return value

bool TRUE, if the entity was set successfully; FALSE otherwise.

1 method overrides ConfigEntityMapperInterface::setEntity()
ConfigEntityMapper::setEntity in core/modules/config_translation/src/ConfigEntityMapper.php
Sets the entity instance for this mapper.

File

core/modules/config_translation/src/ConfigEntityMapperInterface.php, line 35

Class

ConfigEntityMapperInterface
Defines an interface for configuration entity mappers.

Namespace

Drupal\config_translation

Code

public function setEntity(ConfigEntityInterface $entity);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.