class-admin-notice.php
10.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
<?php
class WooCommerce_Role_Based_Price_Admin_Notices {
protected static $instance;
protected $noticesArrayName;
protected $REQUESTID;
protected $notices;
/**
* Costructor (private since this is a singleton)
*/
private function __construct() {
self::$instance = NULL;
$this->noticesArrayName = WC_RBP_DB . 'AdminNotices';
$this->REQUESTID = WC_RBP_DB . 'MSG';
$this->notices = array();
$this->loadNotices();
$this->auto_remove_Notice();
add_action('admin_notices', array( $this, 'displayNotices' ));
}
/**
* Loads notices from DB
*/
private function loadNotices() {
$notices = get_option($this->noticesArrayName);
if( is_array($notices) ) {
$this->notices = $notices;
}
}
/**
* Removes Notice By Getting ID From GET / POST METHOD
*/
public function auto_remove_Notice() {
if( isset($_REQUEST[$this->REQUESTID]) ) {
$nonce = sanitize_text_field($_REQUEST['_wpnonce']);
$this->deleteNotice(sanitize_text_field($_REQUEST[$this->REQUESTID]));
if( wp_get_referer() ) {
wp_safe_redirect(wp_get_referer());
}
}
}
/**
* Deletes a notice
*
* @param int $notId The notice unique id
*/
public function deleteNotice($notId) {
foreach( $this->notices as $key => $notice ) {
if( $notice->getId() === $notId ) {
unset($this->notices[$key]);
break;
}
}
$this->storeNotices();
}
/**
* Stores notices in DB
*/
private function storeNotices() {
update_option($this->noticesArrayName, $this->notices);
}
/**
* Returns an instance of this class.
*
* @since 1.0.0
* @return WP_Admin_Notices
*/
public static function getInstance() {
if( NULL == self::$instance ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Action hook to display notices.
* Just echoes notices that should be displayed.
*/
public function displayNotices() {
foreach( $this->notices as $key => $notice ) {
if( $this->isTimeToDisplay($notice) ) {
echo $notice->getContentFormated($notice->getWrapper());
$notice->incrementDisplayedTimes();
}
if( $notice->getTimes() > 0 ) {
if( $notice->isTimeToDie() ) {
unset($this->notices[$key]);
}
}
}
$this->storeNotices();
}
/**
* Checks if is time to display a notice
*
* @param WooCommerce_Role_Based_Price_Admin_Notice $notice
*
* @return bool
*/
private function isTimeToDisplay(WooCommerce_Role_Based_Price_Admin_Notice $notice) {
$screens = $notice->getScreen();
if( ! empty($screens) ) {
$curScreen = get_current_screen();
if( ! is_array($screens) || ! in_array($curScreen->id, $screens) ) {
return FALSE;
}
}
$usersArray = $notice->getUsers();
if( ! empty($usersArray) ) {
$curUser = get_current_user_id();
if( ! is_array($usersArray) || ! in_array($curUser, $usersArray) || $usersArray[$curUser] >= $notice->getTimes() ) {
return FALSE;
}
} else if( $notice->getTimes() == 0 ) {
return TRUE;
} else if( $notice->getTimes() <= $notice->getDisplayedTimes() ) {
return FALSE;
}
return TRUE;
}
/**
* Adds a notice to be displayed
*
* @param erpAdminMessage $notice
*/
public function addNotice(WooCommerce_Role_Based_Price_Admin_Notice $notice) {
$this->notices[] = $notice;
$this->storeNotices();
}
}
/**
* Abstract class of a notice
*
* @author Panagiotis Vagenas <pan.vagenas@gmail.com>
*/
abstract class WooCommerce_Role_Based_Price_Admin_Notice {
protected $content;
protected $type;
protected $screen;
protected $id;
protected $times = 1;
protected $users = array();
protected $displayedTimes = 0;
protected $displayedToUsers = array();
protected $WithWraper = TRUE;
protected $is_dismissible = TRUE;
/**
*
* @param type $content Coantent to be displayed
* @param type $times How many times this notice will be displayed
* @param array $screen The admin screens this notice will be displayed into (empty for all screens)
* @param array $users Array of users this notice concernes (empty for all users)
*/
public function __construct($content, $id = '', $times = 1, $screen = array(), $users = array(), $WithWraper = TRUE) {
$this->content = $content;
$this->screen = $screen;
if( empty($id) ) {
$this->id = uniqid();
} else {
$this->id = $id;
}
$this->times = $times;
$this->users = $users;
$this->WithWraper = $WithWraper;
}
/**
* Get the content of the notice
*
* @param bool $wrapInParTag If the content should be wrapped in a paragraph tag
*
* @return string Formated content
*/
public function getContentFormated($wrapInParTag = TRUE) {
$class = $this->type;
$extrC = '';
if( $this->is_dismissible ) {
$class .= ' notice is-dismissible';
}
$before = '<div id="wc_pbp_notice_' . $this->id . '" class="' . $class . '">';
$before .= $wrapInParTag ? '<p>' : '';
$after = $wrapInParTag ? '</p>' : '';
$after .= '</div>';
return $before . $this->getContent() . $after . $extrC;
}
/**
* Get the notice string unformated
*
* @return string
*/
public function getContent() {
return $this->content;
}
/**
*
* @param string $content
*
* @return \WooCommerce_Role_Based_Price_Admin_Notice
*/
public function setContent($content) {
$this->content = $content;
return $this;
}
/**
* Increment displayed times of the notice
*
* @return \WooCommerce_Role_Based_Price_Admin_Notice
*/
public function incrementDisplayedTimes() {
$this->displayedTimes++;
if( array_key_exists(get_current_user_id(), $this->displayedToUsers) ) {
$this->displayedToUsers[get_current_user_id()]++;
} else {
$this->displayedToUsers[get_current_user_id()] = 1;
}
return $this;
}
/**
* Checks if the notice should me destroyed
*
* @return boolean True iff notice is deprecated
*/
public function isTimeToDie() {
if( empty($this->users) ) {
return $this->displayedTimes >= $this->times;
} else {
$i = 0;
foreach( $this->users as $key => $value ) {
if( isset($this->displayedToUsers[$value]) && $this->displayedToUsers[$value] >= $this->times ) {
$i++;
}
}
if( $i >= count($this->users) ) {
return TRUE;
}
}
return FALSE;
}
/**
* Get the $WithWraper Value
*/
public function getWrapper() {
return $this->WithWraper;
}
/**
* Set the $WithWraper Value
*
* @param boolean $screen
*/
public function setWrapper($wrapper = TRUE) {
$this->WithWraper = $wrapper;
return $this;
}
/**
* Get the current screen slug
*
* @return string Current screen slug
*/
public function getScreen() {
return $this->screen;
}
/**
* Set the screens the notice will be displayed
*
* @param array $screen
*
* @return \WooCommerce_Role_Based_Price_Admin_Notice
*/
public function setScreen($screen) {
$this->screen = $screen;
return $this;
}
/**
*
* @return string
*/
public function getId() {
return $this->id;
}
/**
*
* @return int
*/
public function getTimes() {
return $this->times;
}
/**
*
* @param int $times
*
* @return \WooCommerce_Role_Based_Price_Admin_Notice
*/
public function setTimes($times) {
$this->times = $times;
return $this;
}
/**
*
* @return array
*/
public function getUsers() {
return $this->users;
}
/**
*
* @param array $users
*
* @return \WooCommerce_Role_Based_Price_Admin_Notice
*/
public function setUsers(Array $users) {
$this->users = $users;
return $this;
}
/**
*
* @return int
*/
public function getDisplayedTimes() {
return $this->displayedTimes;
}
/**
*
* @param int $displayedTimes
*
* @return \WooCommerce_Role_Based_Price_Admin_Notice
*/
public function setDisplayedTimes($displayedTimes) {
$this->displayedTimes = $displayedTimes;
return $this;
}
/**
*
* @return array
*/
public function getDisplayedToUsers() {
return $this->displayedToUsers;
}
/**
*
* @param array $displayedToUsers
*
* @return \WooCommerce_Role_Based_Price_Admin_Notice
*/
public function setDisplayedToUsers(Array $displayedToUsers) {
$this->displayedToUsers = $displayedToUsers;
return $this;
}
}
/**
* Type of notices
*/
class WooCommerce_Role_Based_Price_Admin_Error_Notice extends WooCommerce_Role_Based_Price_Admin_Notice {
protected $type = 'error';
}
class WooCommerce_Role_Based_Price_Admin_Updated_Notice extends WooCommerce_Role_Based_Price_Admin_Notice {
protected $type = 'updated';
}
class WooCommerce_Role_Based_Price_Admin_UpdateNag_Notice extends WooCommerce_Role_Based_Price_Admin_Notice {
protected $type = 'update-nag';
}
/**
* Hook action to admin init
*/
if( ! has_action('init', array( 'WooCommerce_Role_Based_Price_Admin_Notices', 'getInstance' )) ) {
add_action('init', array( 'WooCommerce_Role_Based_Price_Admin_Notices', 'getInstance' ));
}