1	<?php
2	declare(strict_types=1);
3
4	namespace Korobochkin\WPKit\MetaBoxes;
5
6	use Symfony\Component\Form\FormFactoryInterface;
7	use Symfony\Component\Form\FormInterface;
8	use Symfony\Component\HttpFoundation\Request;
9
10	/**
11	* Interface MetaBoxInterface
12	*/
13	interface MetaBoxInterface
14	{
15	/**
16	* Register Meta Box in WordPress.
17	*
18	* WARNING: In WordPress bellow 4.4 you cannot register one Meta Box instance
19	* for multiple screens. This means that you cannot pass array in setScreen() method.
20	*
21	* @see add_meta_box
22	*
23	* @return $this For chain calls.
24	*/
25	public function register();
26
27	/**
28	* Prepare Meta Box for rendering.
29	*
30	* @see render().
31	*
32	* @return $this For chain calls.
33	*/
34	public function lateConstruct();
35
36	/**
37	* Returns Meta Box Id.
38	*
39	* @return string Meta Box unique Id.
40	*/
41	public function getId();
42
43	/**
44	* Sets Meta Box Id.
45	*
46	* @param string $id Meta Box unique Id.
47	*
48	* @return $this For chain calls.
49	*/
50	public function setId($id);
51
52	/**
53	* Returns Meta Box title for WordPress.
54	*
55	* @return string Meta Box title.
56	*/
57	public function getTitle();
58
59	/**
60	* Sets Meta Box title for WordPress.
61	*
62	* @param string $title Meta Box title.
63	*
64	* @return $this For chain calls.
65	*/
66	public function setTitle($title);
67
68	/**
69	* Returns view instance of Meta Box.
70	*
71	* @return MetaBoxViewInterface View instance.
72	*/
73	public function getView();
74
75	/**
76	* Sets view instance of Meta Box.
77	*
78	* @param MetaBoxViewInterface $view View instance.
79	*
80	* @return $this For chain calls.
81	*/
82	public function setView($view);
83
84	/**
85	* Returns list of screens where Meta Box should shown.
86	*
87	* @return string|string[] List of screens.
88	*/
89	public function getScreen();
90
91	/**
92	* Sets list of screens where Meta Box should shown.
93	*
94	* WARNING: In WordPress bellow 4.4 you cannot register one Meta Box instance
95	* for multiple screens. This means that you cannot pass array in setScreen() method.
96	*
97	* @see add_meta_box
98	*
99	* @param string|string[] $screen List of screens.
100	*
101	* @return $this For chain calls.
102	*/
103	public function setScreen($screen);
104
105	/**
106	* Returns WordPress context.
107	*
108	* @return string Context for WordPress.
109	*/
110	public function getContext();
111
112	/**
113	* Sets WordPress context.
114	*
115	* @param string $context Context for WordPress.
116	*
117	* @return $this For chain calls.
118	*/
119	public function setContext($context);
120
121	/**
122	* Returns WordPress priority used for build order.
123	*
124	* @return string WordPress priority.
125	*/
126	public function getPriority();
127
128	/**
129	* Sets WordPress priority used for build order.
130	*
131	* @param string $priority WordPress priority.
132	*
133	* @return $this For chain calls.
134	*/
135	public function setPriority($priority);
136
137	/**
138	* Returns form factory.
139	*
140	* @return FormFactoryInterface Form factory.
141	*/
142	public function getFormFactory();
143
144	/**
145	* Sets the form factory to build forms.
146	*
147	* @param $formFactory FormFactoryInterface Form factory.
148	*
149	* @return $this For chain calls.
150	*/
151	public function setFormFactory(FormFactoryInterface $formFactory);
152
153	/**
154	* Returns the form for this page.
155	*
156	* @return FormInterface HTML form.
157	*/
158	public function getForm();
159
160	/**
161	* Sets the form for this page.
162	*
163	* @param FormInterface $form HTML form.
164	*
165	* @return $this For chain calls.
166	*/
167	public function setForm(FormInterface $form);
168
169	/**
170	* Returns the form data entity.
171	*
172	* @return object Form entity.
173	*/
174	public function getFormEntity();
175
176	/**
177	* Sets the form entity.
178	*
179	* @param object $formEntity form data-entity.
180	*
181	* @return $this For chain calls.
182	*/
183	public function setFormEntity($formEntity);
184
185	/**
186	* Call method only from $this->lateConstruct()
187	* to prevent illegal access.
188	*/
189	public function handleRequest();
190
191	/**
192	* Returns HTTP request.
193	*
194	* @return Request HTTP Request.
195	*/
196	public function getRequest();
197
198	/**
199	* Sets HTTP request.
200	*
201	* @param Request $request HTTP request.
202	*
203	* @return $this For chain calls.
204	*/
205	public function setRequest(Request $request);
206
207	/**
208	* Render (output) the Meta Box markup.
209	*/
210	public function render();
211	}