Interface ActionInterface

Direct known implementers

Charcoal\App\Action\AbstractAction

Namespace: Charcoal\App\Action
Located at Charcoal/App/Action/ActionInterface.php

Methods summary
`public Psr\Http\Message\ResponseInterface`	# `__invoke( Psr\Http\Message\RequestInterface $request, Psr\Http\Message\ResponseInterface $response )` Actions are callable, with http request and response as parameters. Actions are callable, with http request and response as parameters. Parameters `$request` A PSR-7 compatible Request instance. `$response` A PSR-7 compatible Response instance. Returns Psr\Http\Message\ResponseInterface
`public`	# `setDependencies( Pimple\Container $container )` Give an opportunity to children classes to inject dependencies from a Pimple Container. Give an opportunity to children classes to inject dependencies from a Pimple Container. Does nothing by default, reimplement in children classes. The `$container` DI-container (from `Pimple`) should not be saved or passed around, only to be used to inject dependencies (typically via setters). Parameters `$container` A dependencies container instance.
`public Charcoal\App\Action\ActionInterface`	# `setData( array $data )` Parameters `$data` The data to set. Returns `Charcoal\App\Action\ActionInterface` Chainable
`public Charcoal\App\Action\ActionInterface`	# `setMode( string $mode )` Parameters `$mode` The action mode. Returns `Charcoal\App\Action\ActionInterface` Chainable
`public string`	# `mode( )` Returns string
`public Charcoal\App\Action\ActionInterface`	# `setSuccess( boolean $success )` Parameters `$success` Success flag (true / false). Returns `Charcoal\App\Action\ActionInterface` Chainable
`public boolean`	# `success( )` Returns boolean
`public Charcoal\App\Action\ActionInterface`	# `setSuccessUrl( string $url )` Parameters `$url` The success URL. Returns `Charcoal\App\Action\ActionInterface` Chainable
`public string`	# `successUrl( )` Returns string
`public Charcoal\App\Action\ActionInterface`	# `setFailureUrl( string $url )` Parameters `$url` The success URL. Returns `Charcoal\App\Action\ActionInterface` Chainable
`public string`	# `failureUrl( )` Returns string
`public string`	# `redirectUrl( )` Returns string
`public array`	# `results( )` Returns array
`public Psr\Http\Message\ResponseInterface`	# `run( Psr\Http\Message\RequestInterface $request, Psr\Http\Message\ResponseInterface $response )` Parameters `$request` A PSR-7 compatible Request instance. `$response` A PSR-7 compatible Response instance. Returns Psr\Http\Message\ResponseInterface
`public boolean`	# `init( Psr\Http\Message\RequestInterface $request )` Initialize the action with a request. Initialize the action with a request. Parameters `$request` The request to initialize. Returns boolean Success / Failure.