give / src / Log / LogModel.php

LogModel.php in GiveWP – Donation Plugin and Fundraising Platform 4.14.1, at src/Log/LogModel.php

290 lines 5.8 KB

Raw Download Zip

1	<?php
2
3	namespace Give\Log;
4
5	use DateTime;
6	use Give\Log\ValueObjects\LogType;
7
8	/**
9	* Class LogModel
10	* @package Give\Log
11	*
12	* @since 2.19.6 added debug
13	* @since 2.10.0
14	*
15	* @method error(string $message, string $source, array $context = [])
16	* @method warning(string $message, string $source, array $context = [])
17	* @method notice(string $message, string $source, array $context = [])
18	* @method success(string $message, string $source, array $context = [])
19	* @method info(string $message, string $source, array $context = [])
20	* @method http(string $message, string $source, array $context = [])
21	* @method debug(string $message, string $source, array $context = [])
22	*/
23	class LogModel
24	{
25	/**
26	* @var string
27	*/
28	private $type;
29
30	/**
31	* @var string
32	*/
33	private $message;
34
35	/**
36	* @var string
37	*/
38	private $category;
39
40	/**
41	* @var string
42	*/
43	private $source;
44
45	/**
46	* @var array
47	*/
48	private $context;
49
50	/**
51	* @var int\|null
52	*/
53	private $id;
54
55	/**
56	* @var string
57	*/
58	private $date;
59
60	/**
61	* LogModel constructor.
62	*
63	* @param string $type
64	* @param string $message
65	* @param string $category
66	* @param string $source
67	* @param array $context
68	* @param int\|null $logId
69	* @param string $date
70	*/
71	public function __construct($type, $message, $category, $source, $context, $logId, $date)
72	{
73	$this->setType($type);
74	$this->setDate($date);
75	$this->category = $category;
76	$this->source = $source;
77	$this->context = $context;
78	$this->message = $message;
79	$this->id = $logId;
80	}
81
82	/**
83	* Set log type
84	* If log type is not supported, it will fallback to NOTICE type
85	*
86	* @param string $type
87	*/
88	private function setType($type)
89	{
90	$this->type = in_array($type, LogType::getAll(), true)
91	? $type
92	: LogType::getDefault();
93	}
94
95	/**
96	* Set log message
97	* If not defined, fallback to default value
98	*
99	* @param string\|null $message
100	*/
101	private function setMessage($message)
102	{
103	$this->message = is_null($message)
104	? esc_html__('Something went wrong', 'give')
105	: $message;
106	}
107
108	/**
109	* Set log date
110	*
111	* @param string $date
112	*/
113	private function setDate($date)
114	{
115	$this->date = $this->isValidateDate($date)
116	? $date
117	: date('Y-m-d H:i:s');
118	}
119
120	/**
121	* Set log source
122	* If not defined, fallback to default value
123	*
124	* @param string\|null $source
125	*/
126	private function setSource($source)
127	{
128	$this->source = is_null($source)
129	? esc_html__('Give Core', 'give')
130	: $source;
131	}
132
133	/**
134	* Helper method to check if given string is a valid date
135	*
136	* @param string $date
137	* @param string $format
138	*
139	* @return bool
140	*/
141	public function isValidateDate($date, $format = 'Y-m-d H:i:s')
142	{
143	$dateTime = DateTime::createFromFormat($format, $date);
144
145	return $dateTime && $dateTime->format($format) === $date;
146	}
147
148	/**
149	* @return int
150	*/
151	public function getId()
152	{
153	return $this->id;
154	}
155
156	/**
157	* @return string
158	*/
159	public function getType()
160	{
161	return $this->type;
162	}
163
164	/**
165	* @return string
166	*/
167	public function getCategory()
168	{
169	return $this->category;
170	}
171
172	/**
173	* @return string
174	*/
175	public function getSource()
176	{
177	return $this->source;
178	}
179
180	/**
181	* @return string
182	*/
183	public function getMessage()
184	{
185	return $this->message;
186	}
187
188	/**
189	* @return array
190	*/
191	public function getContext()
192	{
193	return $this->context;
194	}
195
196	/**
197	* @return string
198	*/
199	public function getDate()
200	{
201	return $this->date;
202	}
203
204	/**
205	* Get context data
206	*
207	* @param bool $jsonEncode
208	*
209	* @return string\|array
210	*/
211	public function getData($jsonEncode = false)
212	{
213	$data = [
214	'message' => $this->getMessage(),
215	'context' => $this->getContext(),
216	];
217
218	if ($jsonEncode) {
219	return json_encode($data);
220	}
221
222	return $data;
223	}
224
225	/**
226	* @param string $key
227	* @param mixed $value
228	*/
229	private function addContext($key, $value)
230	{
231	if (is_array($value) \|\| is_object($value)) {
232	$value = print_r($value, true);
233	}
234	$this->context[$key] = $value;
235	}
236
237	/**
238	* Add supplemental information to existing log.
239	* Supplemental data will be added as a context with a key prefixed with the current timestamp.
240	*
241	* @param string $key
242	* @param string $value
243	*/
244	public function addSupplemental($key, $value)
245	{
246	$contextName = sprintf('[%s] %s', date('Y-m-d H:i:s'), $key);
247	$this->addContext($contextName, $value);
248	}
249
250	/**
251	* @param string $type
252	* @param array $args
253	*/
254	public function __call($type, $args)
255	{
256	list ($message, $source, $context) = array_pad($args, 3, null);
257
258	$this->setType($type);
259	$this->setMessage($message);
260	$this->setSource($source);
261
262	// Set additional context
263	if (is_array($context)) {
264	foreach ($context as $key => $value) {
265	$this->addContext($key, $value);
266	}
267	}
268
269	$this->save();
270	}
271
272	/**
273	* Save log record
274	*/
275	public function save()
276	{
277	/**
278	* var LogRepository $repository
279	*/
280	$repository = give(LogRepository::class);
281
282	if ($this->getId()) {
283	$this->date = date('Y-m-d H:i:s');
284	$repository->updateLog($this);
285	} else {
286	$this->id = $repository->insertLog($this);
287	}
288	}
289	}
290