Class ControllerFactory
Factory method for building controllers for request.
Property Summary
-
$container protected
Cake\Core\ContainerInterface -
$controller protected
Cake\Controller\Controller
Method Summary
-
__construct() public
Constructor
-
coerceStringToType() protected
Coerces string argument to primitive type.
-
create() public
Create a controller for a given request.
-
getActionArgs() protected
Get the arguments for the controller action invocation.
-
getControllerClass() public
Determine the controller class name based on current request and controller param
-
handle() public
Invoke the action.
-
invoke() public
Invoke a controller's action and wrapping methods.
-
missingController() protected
Throws an exception when a controller is missing.
Method Detail
__construct() ¶ public
__construct(Cake\Core\ContainerInterface $container)Constructor
Parameters
-
Cake\Core\ContainerInterface$container The container to build controllers with.
coerceStringToType() ¶ protected
coerceStringToType(string $argument, ReflectionNamedType $type): array|string|float|int|bool|nullCoerces string argument to primitive type.
Parameters
-
string$argument Argument to coerce
-
ReflectionNamedType$type Parameter type
Returns
array|string|float|int|bool|nullcreate() ¶ public
create(Psr\Http\Message\ServerRequestInterface $request): Cake\Controller\ControllerCreate a controller for a given request.
Parameters
-
Psr\Http\Message\ServerRequestInterface$request The request to build a controller for.
Returns
Cake\Controller\ControllerThrows
Cake\Http\Exception\MissingControllerExceptiongetActionArgs() ¶ protected
getActionArgs(Closure $action, array $passedParams): arrayGet the arguments for the controller action invocation.
Parameters
-
Closure$action Controller action.
-
array$passedParams Params passed by the router.
Returns
arraygetControllerClass() ¶ public
getControllerClass(Cake\Http\ServerRequest $request): class-string<Cake\Controller\Controller>|nullDetermine the controller class name based on current request and controller param
Parameters
-
Cake\Http\ServerRequest$request The request to build a controller for.
Returns
class-string<Cake\Controller\Controller>|nullhandle() ¶ public
handle(ServerRequestInterface $request): Psr\Http\Message\ResponseInterfaceInvoke the action.
May call other collaborating code to generate the response.
Parameters
-
ServerRequestInterface$request Request instance.
Returns
Psr\Http\Message\ResponseInterfaceinvoke() ¶ public
invoke(mixed $controller): Psr\Http\Message\ResponseInterfaceInvoke a controller's action and wrapping methods.
Parameters
-
mixed$controller The controller to invoke.
Returns
Psr\Http\Message\ResponseInterfaceThrows
Cake\Controller\Exception\MissingActionExceptionIf controller action is not found.
UnexpectedValueExceptionIf return value of action method is not null or ResponseInterface instance.
missingController() ¶ protected
missingController(Cake\Http\ServerRequest $request): Cake\Http\Exception\MissingControllerExceptionThrows an exception when a controller is missing.
Parameters
-
Cake\Http\ServerRequest$request The request.
Returns
Cake\Http\Exception\MissingControllerException