1	<?php
2	/**
3	* Pop PHP Framework (http://www.popphp.org/)
4	*
5	* @link       https://github.com/popphp/popphp-framework
6	* @author     Nick Sagona, III <dev@nolainteractive.com>
7	* @copyright  Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)
8	* @license    http://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@nolainteractive.com>
24	* @copyright  Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)
25	* @license    http://www.popphp.org/license     New BSD License
26	* @version    2.2.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 logger
55	*
56	* @param  Logger $logger
57	* @return HandlerInterface
58	*/
59	public function setLogger(Logger $logger): HandlerInterface;
60
61	/**
62	* Get logger
63	*
64	* @return ?Logger
65	*/
66	public function getLogger(): ?Logger;
67
68	/**
69	* Has logger
70	*
71	* @return bool
72	*/
73	public function hasLogger(): bool;
74
75	/**
76	* Set logger
77	*
78	* @param  array $loggingParams
79	* @return HandlerInterface
80	*/
81	public function setLoggingParams(array $loggingParams): HandlerInterface;
82
83	/**
84	* Get logging params
85	*
86	* @return array
87	*/
88	public function getLoggingParams(): array;
89
90	/**
91	* Has logging parameters
92	*
93	* @return bool
94	*/
95	public function hasLoggingParams(): bool;
96
97	/**
98	* Prepare handler data for storage
99	*
100	* @return array
101	*/
102	public function prepare(): array;
103
104	/**
105	* Prepare header string
106	*
107	* @return string
108	*/
109	public function prepareHeaderAsString(): string;
110
111	/**
112	* Prepare handler data as string
113	*
114	* @return string
115	*/
116	public function prepareAsString(): string;
117
118	/**
119	* Trigger handle logging
120	*
121	* @return void
122	*/
123	public function log(): void;
124
125	}