1	<?php
2	declare(strict_types=1);
3
4	namespace Korobochkin\WPKit\AlmostControllers;
5
6	use Symfony\Component\DependencyInjection\ContainerAwareInterface;
7	use Symfony\Component\HttpFoundation\Request;
8	use Symfony\Component\HttpFoundation\Response;
9	use Symfony\Component\Validator\ConstraintViolationList;
10
11	/**
12	* Interface ActionInterface
13	*/
14	interface ActionInterface extends ContainerAwareInterface
15	{
16	/**
17	* Returns the flag which indicate availability of this action for user.
18	*
19	* @return bool True if enabled for logged in users.
20	*/
21	public function isEnabledForLoggedIn();
22
23	/**
24	* Sets the flag which indicate availability of this action for user.
25	*
26	* @param $enabledForLoggedIn bool True if enabled.
27	*
28	* @return $this For chain calls.
29	*/
30	public function setEnabledForLoggedIn($enabledForLoggedIn);
31
32	/**
33	* Returns the flag which indicate availability of this action for user.
34	*
35	* @return bool True if enabled for NOT logged in users.
36	*/
37	public function isEnabledForNotLoggedIn();
38
39	/**
40	* Sets the flag which indicate availability of this action for user.
41	*
42	* @param $enabledForNotLoggedIn bool True if enabled.
43	*
44	* @return $this For chain calls.
45	*/
46	public function setEnabledForNotLoggedIn($enabledForNotLoggedIn);
47
48	/**
49	* Returns the current action name.
50	*
51	* @return string Name of action.
52	*/
53	public function getName();
54
55	/**
56	* Sets the current action name.
57	*
58	* @param $name string Action name.
59	*
60	* @return $this For chain calls.
61	*/
62	public function setName($name);
63
64	/**
65	* Returns the parent stack service.
66	*
67	* @return StackInterface
68	*/
69	public function getStack();
70
71	/**
72	* Sets the parent stack service.
73	*
74	* @param StackInterface $stack Parent stack.
75	*
76	* @return $this For chain calls.
77	*/
78	public function setStack(StackInterface $stack);
79
80	/**
81	* Returns a list of errors.
82	*
83	* @return ConstraintViolationList
84	*/
85	public function getViolationsList();
86
87	/**
88	* Sets a list of errors.
89	*
90	* @param ConstraintViolationList $violationsList A list of errors during this action execute.
91	*
92	* @return $this For chain calls.
93	*/
94	public function setViolationsList(ConstraintViolationList $violationsList);
95
96	/**
97	* Returns HTTP Request.
98	*
99	* @return Request HTTP request.
100	*/
101	public function getRequest();
102
103	/**
104	* Sets HTTP Request.
105	*
106	* @param Request $request HTTP request.
107	*
108	* @return $this For chain calls.
109	*/
110	public function setRequest(Request $request);
111
112	/**
113	* Returns HTTP Response.
114	*
115	* @return Response HTTP response.
116	*/
117	public function getResponse();
118
119	/**
120	* Sets HTTP Response.
121	*
122	* @param Response $response HTTP response.
123	*
124	* @return $this For chain calls.
125	*/
126	public function setResponse(Response $response);
127
128	/**
129	* Handling HTTP requests.
130	*
131	* @return $this For chain calls.
132	*/
133	public function handleRequest();
134
135	/**
136	* Returns a container service by its id.
137	*
138	* @param string $id The service id
139	*
140	* @return object The service
141	*/
142	public function get($id);
143	}