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-2023 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\Storage;
15
16	/**
17	* Debug storage interface
18	*
19	* @category   Pop
20	* @package    Pop\Debug
21	* @author     Nick Sagona, III <dev@nolainteractive.com>
22	* @copyright  Copyright (c) 2009-2023 NOLA Interactive, LLC. (http://www.nolainteractive.com)
23	* @license    http://www.popphp.org/license     New BSD License
24	* @version    1.3.0
25	*/
26	interface StorageInterface
27	{
28
29	/**
30	* Set the storage format
31	*
32	* @param  string $format
33	* @return StorageInterface
34	*/
35	public function setFormat($format);
36
37	/**
38	* Determine if the format is PHP
39	*
40	* @return boolean
41	*/
42	public function isPhp();
43
44	/**
45	* Determine if the format is JSON
46	*
47	* @return boolean
48	*/
49	public function isJson();
50
51	/**
52	* Get the storage format
53	*
54	* @return string
55	*/
56	public function getFormat();
57
58	/**
59	* Save debug data
60	*
61	* @param  string $id
62	* @param  mixed  $value
63	* @return void
64	*/
65	public function save($id, $value);
66
67	/**
68	* Get debug data
69	*
70	* @param  string $id
71	* @return mixed
72	*/
73	public function get($id);
74
75	/**
76	* Determine if debug data exists
77	*
78	* @param  string $id
79	* @return mixed
80	*/
81	public function has($id);
82
83	/**
84	* Delete debug data
85	*
86	* @param  string $id
87	* @return void
88	*/
89	public function delete($id);
90
91	/**
92	* Clear all debug data
93	*
94	* @return void
95	*/
96	public function clear();
97
98	/**
99	* Encode the value based on the format
100	*
101	* @param  mixed  $value
102	* @return string
103	*/
104	public function encodeValue($value);
105
106	/**
107	* Decode the value based on the format
108	*
109	* @param  mixed  $value
110	* @return mixed
111	*/
112	public function decodeValue($value);
113
114	}