class EntityTestController

Same name in other branches
  1. 9 core/modules/system/tests/modules/entity_test/src/Controller/EntityTestController.php \Drupal\entity_test\Controller\EntityTestController
  2. 8.9.x core/modules/system/tests/modules/entity_test/src/Controller/EntityTestController.php \Drupal\entity_test\Controller\EntityTestController
  3. 11.x core/modules/system/tests/modules/entity_test/src/Controller/EntityTestController.php \Drupal\entity_test\Controller\EntityTestController

Controller routines for entity_test routes.

Hierarchy

Expanded class hierarchy of EntityTestController

File

core/modules/system/tests/modules/entity_test/src/Controller/EntityTestController.php, line 11

Namespace

Drupal\entity_test\Controller
View 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

Title Sort descending Modifiers Object type Summary Overrides
AutowireTrait::create public static function Instantiates a new instance of the implementing class using autowiring. 33
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 2
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 2
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
EntityTestController::listEntitiesAlphabetically public function List entities of the given entity type labels, sorted alphabetically.
EntityTestController::listEntitiesEmpty public function Empty list of entities of the given entity type.
EntityTestController::listReferencingEntities public function List entity_test entities referencing the given entity.
EntityTestController::testAdmin public function Returns an empty page.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

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