annotate core/lib/Drupal/Core/Controller/ControllerResolverInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Controller;
Chris@0 4
Chris@0 5 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface as BaseControllerResolverInterface;
Chris@0 6
Chris@0 7 /**
Chris@0 8 * Extends the ControllerResolverInterface from symfony.
Chris@0 9 */
Chris@0 10 interface ControllerResolverInterface extends BaseControllerResolverInterface {
Chris@0 11
Chris@0 12 /**
Chris@0 13 * Returns the Controller instance with a given controller route definition.
Chris@0 14 *
Chris@0 15 * As several resolvers can exist for a single application, a resolver must
Chris@0 16 * return false when it is not able to determine the controller.
Chris@0 17 *
Chris@0 18 * @param mixed $controller
Chris@0 19 * The controller attribute like in $request->attributes->get('_controller')
Chris@0 20 *
Chris@0 21 * @return mixed|bool
Chris@0 22 * A PHP callable representing the Controller, or false if this resolver is
Chris@0 23 * not able to determine the controller
Chris@0 24 *
Chris@0 25 * @throws \InvalidArgumentException|\LogicException
Chris@0 26 * Thrown if the controller can't be found.
Chris@0 27 *
Chris@0 28 * @see \Symfony\Component\HttpKernel\Controller\ControllerResolverInterface::getController()
Chris@0 29 */
Chris@0 30 public function getControllerFromDefinition($controller);
Chris@0 31
Chris@0 32 }