Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
<?php | |
declare(strict_types=1); | |
namespace Korobochkin\WPKit\AlmostControllers; | |
use Korobochkin\WPKit\AlmostControllers\Exceptions\ActionNotFoundException; | |
use Korobochkin\WPKit\AlmostControllers\Exceptions\UnauthorizedException; | |
use Symfony\Component\DependencyInjection\ContainerAwareInterface; | |
use Symfony\Component\HttpFoundation\Request; | |
use Symfony\Component\HttpFoundation\Response; | |
interface StackInterface extends ContainerAwareInterface | |
{ | |
/** | |
* Returns actions instances in array. | |
* | |
* @return ActionInterface[] | |
*/ | |
public function getActions(); | |
/** | |
* Sets actions instances array. | |
* | |
* @param ActionInterface[] $actions | |
* | |
* @return $this For chain calls. | |
*/ | |
public function setActions(array $actions); | |
/** | |
* Adds single action instance to the list. | |
* | |
* @param ActionInterface $action Action instance to add. | |
* | |
* @return $this For chain calls. | |
*/ | |
public function addAction(ActionInterface $action); | |
/** | |
* Returns WordPress action name. | |
* | |
* @return string WordPress action name. | |
*/ | |
public function getActionName(); | |
/** | |
* Sets WordPress action name. | |
* | |
* @param string $actionName | |
* | |
* @return $this For chain calls. | |
*/ | |
public function setActionName($actionName); | |
/** | |
* Returns the Request instance. | |
* | |
* @return Request HTTP request instance. | |
*/ | |
public function getRequest(); | |
/** | |
* Sets the Request instance. | |
* | |
* @param Request $request HTTP request instance. | |
* | |
* @return $this For chain calls. | |
*/ | |
public function setRequest(Request $request); | |
/** | |
* Returns Response instance. | |
* | |
* @return Response HTTP response instance. | |
*/ | |
public function getResponse(); | |
/** | |
* Sets Response instance. | |
* | |
* @param Response $response HTTP response instance. | |
* | |
* @return $this For chain calls. | |
*/ | |
public function setResponse(Response $response); | |
/** | |
* Register current actions from $this->actions variable. | |
* | |
* @return $this For chain calls. | |
*/ | |
public function register(); | |
/** | |
* Handling HTTP requests. | |
* | |
* @see $this->send() | |
*/ | |
public function handleRequest(); | |
/** | |
* Util for managing request. | |
* | |
* @see wp_magic_quotes | |
* | |
* @throws UnauthorizedException If user not allowed to use this action. | |
* @throws ActionNotFoundException If requested action not exists. | |
* | |
* @return $this For chain calls. | |
*/ | |
public function requestManager(); | |
/** | |
* Actually sends the headers and response body to the client. | |
*/ | |
public function send(); | |
/** | |
* Returns a container service by its id. | |
* | |
* @param string $id The service id. | |
* | |
* @return object The service. | |
*/ | |
public function get($id); | |
} |