class EntityTestController in Drupal 10
Same name and namespace in other branches
- 8 core/modules/system/tests/modules/entity_test/src/Controller/EntityTestController.php \Drupal\entity_test\Controller\EntityTestController
- 9 core/modules/system/tests/modules/entity_test/src/Controller/EntityTestController.php \Drupal\entity_test\Controller\EntityTestController
Controller routines for entity_test routes.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\entity_test\Controller\EntityTestController
Expanded class hierarchy of EntityTestController
File
- core/
modules/ system/ tests/ modules/ entity_test/ src/ Controller/ EntityTestController.php, line 11
Namespace
Drupal\entity_test\ControllerView source
class EntityTestController extends ControllerBase {
/**
* Returns an empty page.
*
* @see \Drupal\entity_test\Routing\EntityTestRoutes::routes()
*/
public function testAdmin() {
return [];
}
/**
* List entity_test entities referencing the given entity.
*
* @param string $entity_reference_field_name
* The name of the entity_reference field to use in the query.
* @param string $referenced_entity_type
* The type of the entity being referenced.
* @param int $referenced_entity_id
* The ID of the entity being referenced.
*
* @return array
* A renderable array.
*/
public function listReferencingEntities($entity_reference_field_name, $referenced_entity_type, $referenced_entity_id) {
// Early return if the referenced entity does not exist (or is deleted).
$referenced_entity = $this
->entityTypeManager()
->getStorage($referenced_entity_type)
->load($referenced_entity_id);
if ($referenced_entity === NULL) {
return [];
}
$query = $this
->entityTypeManager()
->getStorage('entity_test')
->getQuery()
->accessCheck(TRUE)
->condition($entity_reference_field_name . '.target_id', $referenced_entity_id);
$entities = $this
->entityTypeManager()
->getStorage('entity_test')
->loadMultiple($query
->execute());
return $this
->entityTypeManager()
->getViewBuilder('entity_test')
->viewMultiple($entities, 'full');
}
/**
* List entities of the given entity type labels, sorted alphabetically.
*
* @param string $entity_type_id
* The type of the entity being listed.
*
* @return array
* A renderable array.
*/
public function listEntitiesAlphabetically($entity_type_id) {
$entity_type_definition = $this
->entityTypeManager()
->getDefinition($entity_type_id);
$query = $this
->entityTypeManager()
->getStorage($entity_type_id)
->getQuery()
->accessCheck(TRUE);
// Sort by label field, if any.
if ($label_field = $entity_type_definition
->getKey('label')) {
$query
->sort($label_field);
}
$entities = $this
->entityTypeManager()
->getStorage($entity_type_id)
->loadMultiple($query
->execute());
$cache_tags = [];
$labels = [];
foreach ($entities as $entity) {
$labels[] = $entity
->label();
$cache_tags = Cache::mergeTags($cache_tags, $entity
->getCacheTags());
}
// Always associate the list cache tag, otherwise the cached empty result
// wouldn't be invalidated. This would continue to show nothing matches the
// query, even though a newly created entity might match the query.
$cache_tags = Cache::mergeTags($cache_tags, $entity_type_definition
->getListCacheTags());
return [
'#theme' => 'item_list',
'#items' => $labels,
'#title' => $entity_type_id . ' entities',
'#cache' => [
'contexts' => $entity_type_definition
->getListCacheContexts(),
'tags' => $cache_tags,
],
];
}
/**
* Empty list of entities of the given entity type.
*
* Empty because no entities match the query. That may seem contrived, but it
* is an excellent way for testing whether an entity's list cache tags are
* working as expected.
*
* @param string $entity_type_id
* The type of the entity being listed.
*
* @return array
* A renderable array.
*/
public function listEntitiesEmpty($entity_type_id) {
$entity_type_definition = $this
->entityTypeManager()
->getDefinition($entity_type_id);
return [
'#theme' => 'item_list',
'#items' => [],
'#cache' => [
'contexts' => $entity_type_definition
->getListCacheContexts(),
'tags' => $entity_type_definition
->getListCacheTags(),
],
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The current user service. | 2 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 1 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 1 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
45 |
ControllerBase:: |
protected | function | Returns the current user. | 2 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 1 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 1 |
ControllerBase:: |
protected | function | Returns a redirect response object for the specified route. | |
ControllerBase:: |
protected | function | Returns the state storage service. | |
EntityTestController:: |
public | function | List entities of the given entity type labels, sorted alphabetically. | |
EntityTestController:: |
public | function | Empty list of entities of the given entity type. | |
EntityTestController:: |
public | function | List entity_test entities referencing the given entity. | |
EntityTestController:: |
public | function | Returns an empty page. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |