1	<?php
2	/**
3	* Pop PHP Framework (https://www.popphp.org/)
4	*
5	* @link       https://github.com/popphp/popphp-framework
6	* @author     Nick Sagona, III <dev@noladev.com>
7	* @copyright  Copyright (c) 2009-2026 NOLA Interactive, LLC.
8	* @license    https://www.popphp.org/license     New BSD License
9	*/
10
11	/**
12	* @namespace
13	*/
14	namespace Pop\Debug\Handler;
15
16	use Pop\Log\Logger;
17
18	/**
19	* Debug handler interface
20	*
21	* @category   Pop
22	* @package    Pop\Debug
23	* @author     Nick Sagona, III <dev@noladev.com>
24	* @copyright  Copyright (c) 2009-2026 NOLA Interactive, LLC.
25	* @license    https://www.popphp.org/license     New BSD License
26	* @version    3.0.0
27	*/
28	interface HandlerInterface
29	{
30
31	/**
32	* Set name
33	*
34	* @param  string $name
35	* @return HandlerInterface
36	*/
37	public function setName(string $name): HandlerInterface;
38
39	/**
40	* Get name
41	*
42	* @return ?string
43	*/
44	public function getName(): ?string;
45
46	/**
47	* Has name
48	*
49	* @return bool
50	*/
51	public function hasName(): bool;
52
53	/**
54	* Set data
55	*
56	* @param  array $data
57	* @return HandlerInterface
58	*/
59	public function setData(array $data = []): HandlerInterface;
60
61	/**
62	* Get data
63	*
64	* @return array
65	*/
66	public function getData(): array;
67
68	/**
69	* Has data
70	*
71	* @return bool
72	*/
73	public function hasData(): bool;
74
75	/**
76	* Start
77	*
78	* @return HandlerInterface
79	*/
80	public function start(): HandlerInterface;
81
82	/**
83	* Stop
84	*
85	* @return HandlerInterface
86	*/
87	public function stop(): HandlerInterface;
88
89	/**
90	* Set start
91	*
92	* @param  ?float $start
93	* @return HandlerInterface
94	*/
95	public function setStart(?float $start = null): HandlerInterface;
96
97	/**
98	* Get start
99	*
100	* @return ?float
101	*/
102	public function getStart(): ?float;
103
104	/**
105	* Has start
106	*
107	* @return bool
108	*/
109	public function hasStart(): bool;
110
111	/**
112	* Set end
113	*
114	* @param  ?float $end
115	* @return HandlerInterface
116	*/
117	public function setEnd(?float $end = null): HandlerInterface;
118
119	/**
120	* Get end
121	*
122	* @return ?float
123	*/
124	public function getEnd(): ?float;
125
126	/**
127	* Has end
128	*
129	* @return bool
130	*/
131	public function hasEnd(): bool;
132
133	/**
134	* Set elapsed
135	*
136	* @param  float $elapsed
137	* @return HandlerInterface
138	*/
139	public function setElapsed(float $elapsed): HandlerInterface;
140
141	/**
142	* Get elapsed
143	*
144	* @return ?float
145	*/
146	public function getElapsed(): ?float;
147
148	/**
149	* Has elapsed
150	*
151	* @return bool
152	*/
153	public function hasElapsed(): bool;
154
155	/**
156	* Set logger
157	*
158	* @param  Logger $logger
159	* @return HandlerInterface
160	*/
161	public function setLogger(Logger $logger): HandlerInterface;
162
163	/**
164	* Get logger
165	*
166	* @return ?Logger
167	*/
168	public function getLogger(): ?Logger;
169
170	/**
171	* Has logger
172	*
173	* @return bool
174	*/
175	public function hasLogger(): bool;
176
177	/**
178	* Set logger
179	*
180	* @param  array $loggingParams
181	* @return HandlerInterface
182	*/
183	public function setLoggingParams(array $loggingParams): HandlerInterface;
184
185	/**
186	* Get logging params
187	*
188	* @return array
189	*/
190	public function getLoggingParams(): array;
191
192	/**
193	* Has logging parameters
194	*
195	* @return bool
196	*/
197	public function hasLoggingParams(): bool;
198
199	/**
200	* Prepare handler data for storage
201	*
202	* @return array
203	*/
204	public function prepare(): array;
205
206	/**
207	* Prepare handler message
208	*
209	* @param  ?array $context
210	* @return string
211	*/
212	public function prepareMessage(?array $context = null): string;
213
214	/**
215	* Trigger handle logging
216	*
217	* @return void
218	*/
219	public function log(): void;
220
221	}