1	<?php
2	declare(strict_types=1);
3
4	namespace Korobochkin\WPKit\AlmostControllers;
5
6	use Korobochkin\WPKit\AlmostControllers\Exceptions\ActionNotFoundException;
7	use Korobochkin\WPKit\AlmostControllers\Exceptions\UnauthorizedException;
8	use Symfony\Component\DependencyInjection\ContainerAwareInterface;
9	use Symfony\Component\HttpFoundation\Request;
10	use Symfony\Component\HttpFoundation\Response;
11
12	interface StackInterface extends ContainerAwareInterface
13	{
14	/**
15	* Returns actions instances in array.
16	*
17	* @return ActionInterface[]
18	*/
19	public function getActions();
20
21	/**
22	* Sets actions instances array.
23	*
24	* @param ActionInterface[] $actions
25	*
26	* @return $this For chain calls.
27	*/
28	public function setActions(array $actions);
29
30	/**
31	* Adds single action instance to the list.
32	*
33	* @param ActionInterface $action Action instance to add.
34	*
35	* @return $this For chain calls.
36	*/
37	public function addAction(ActionInterface $action);
38
39	/**
40	* Returns WordPress action name.
41	*
42	* @return string WordPress action name.
43	*/
44	public function getActionName();
45
46	/**
47	* Sets WordPress action name.
48	*
49	* @param string $actionName
50	*
51	* @return $this For chain calls.
52	*/
53	public function setActionName($actionName);
54
55	/**
56	* Returns the Request instance.
57	*
58	* @return Request HTTP request instance.
59	*/
60	public function getRequest();
61
62	/**
63	* Sets the Request instance.
64	*
65	* @param Request $request HTTP request instance.
66	*
67	* @return $this For chain calls.
68	*/
69	public function setRequest(Request $request);
70
71	/**
72	* Returns Response instance.
73	*
74	* @return Response HTTP response instance.
75	*/
76	public function getResponse();
77
78	/**
79	* Sets Response instance.
80	*
81	* @param Response $response HTTP response instance.
82	*
83	* @return $this For chain calls.
84	*/
85	public function setResponse(Response $response);
86
87	/**
88	* Register current actions from $this->actions variable.
89	*
90	* @return $this For chain calls.
91	*/
92	public function register();
93
94	/**
95	* Handling HTTP requests.
96	*
97	* @see $this->send()
98	*/
99	public function handleRequest();
100
101	/**
102	* Util for managing request.
103	*
104	* @see wp_magic_quotes
105	*
106	* @throws UnauthorizedException If user not allowed to use this action.
107	* @throws ActionNotFoundException If requested action not exists.
108	*
109	* @return $this For chain calls.
110	*/
111	public function requestManager();
112
113	/**
114	* Actually sends the headers and response body to the client.
115	*/
116	public function send();
117
118	/**
119	* Returns a container service by its id.
120	*
121	* @param string $id The service id.
122	*
123	* @return object The service.
124	*/
125	public function get($id);
126	}