class LocalTaskUsageController in Entity Usage 8.4

Controller for our local tasks.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\entity_usage\Controller\ListUsageController
    • class \Drupal\entity_usage\Controller\LocalTaskUsageController

File

src/Controller/LocalTaskUsageController.php, line 10

Namespace

Drupal\entity_usage\Controller

class LocalTaskUsageController extends ListUsageController {

  /**
   * Checks access based on whether the user can view the current entity.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   A RouteMatch object.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function checkAccessLocalTask(RouteMatchInterface $route_match) {
    $entity = $this
      ->getEntityFromRouteMatch($route_match);
    return parent::checkAccess($entity
      ->getEntityTypeId(), $entity
      ->id());
  }

  /**
   * Title page callback.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   A RouteMatch object.
   *
   * @return string
   *   The title to be used on this page.
   */
  public function getTitleLocalTask(RouteMatchInterface $route_match) {
    $entity = $this
      ->getEntityFromRouteMatch($route_match);
    return parent::getTitle($entity
      ->getEntityTypeId(), $entity
      ->id());
  }

  /**
   * Lists the usage of a given entity.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   A RouteMatch object.
   *
   * @return array
   *   The page build to be rendered.
   */
  public function listUsageLocalTask(RouteMatchInterface $route_match) {
    $entity = $this
      ->getEntityFromRouteMatch($route_match);
    return parent::listUsagePage($entity
      ->getEntityTypeId(), $entity
      ->id());
  }

  /**
   * Retrieves entity from route match.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The entity object as determined from the passed-in route match.
   */
  protected function getEntityFromRouteMatch(RouteMatchInterface $route_match) {
    $parameter_name = $route_match
      ->getRouteObject()
      ->getOption('_entity_usage_entity_type_id');
    return $route_match
      ->getParameter($parameter_name);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
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.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
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.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
ListUsageController::$allRows	protected	property	All source rows for this target entity.
ListUsageController::$entityFieldManager	protected	property	The entity field manager.
ListUsageController::$entityUsage	protected	property	The EntityUsage service.
ListUsageController::$entityUsageConfig	protected	property	The Entity Usage settings config object.
ListUsageController::$itemsPerPage	protected	property	The number of records per page this controller should output.
ListUsageController::$pagerManager	protected	property	The pager manager.
ListUsageController::checkAccess	public	function	Checks access based on whether the user can view the current entity.
ListUsageController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ListUsageController::getPageRows	protected	function	Get rows for a given page.
ListUsageController::getRows	protected	function	Retrieve all usage rows for this target entity.
ListUsageController::getSourceEntityLink	protected	function	Retrieve a link to the source entity.
ListUsageController::getSourceEntityStatus	protected	function	Retrieve the source entity's status.
ListUsageController::getTitle	public	function	Title page callback.
ListUsageController::ITEMS_PER_PAGE_DEFAULT		constant	Number of items per page to use when nothing was configured.
ListUsageController::listUsagePage	public	function	Lists the usage of a given entity.
ListUsageController::__construct	public	function	ListUsageController constructor.
LocalTaskUsageController::checkAccessLocalTask	public	function	Checks access based on whether the user can view the current entity.
LocalTaskUsageController::getEntityFromRouteMatch	protected	function	Retrieves entity from route match.
LocalTaskUsageController::getTitleLocalTask	public	function	Title page callback.
LocalTaskUsageController::listUsageLocalTask	public	function	Lists the usage of a given entity.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
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.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.