-
Notifications
You must be signed in to change notification settings - Fork 4
/
class-bwp-framework.php
455 lines (402 loc) · 12.5 KB
/
class-bwp-framework.php
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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
<?php
/**
* Copyright (c) 2011 Khang Minh <betterwp.net>
* @license http://www.gnu.org/licenses/gpl.html GNU GENERAL PUBLIC LICENSE VERSION 3.0 OR LATER
*/
define('BWP_FRAMEWORK_VERSION', '1.0.0');
class BWP_FRAMEWORK {
/**
* Database related data
*/
var $options = array();
/**
* Default data
*/
var $options_default = array(), $site_options = array();
/**
* Hold db option keys
*/
var $option_keys = array();
/**
* Hold extra option keys
*/
var $extra_option_keys = array();
/**
* Hold old option pages
*/
var $option_pages = array();
/**
* Key to identify plugin
*/
var $plugin_key;
/**
* Constant Key to identify plugin
*/
var $plugin_ckey;
/**
* Domain Key to identify plugin
*/
var $plugin_dkey;
/**
* Title of the plugin
*/
var $plugin_title;
/**
* Homepage of the plugin
*/
var $plugin_url;
/**
* Plugin file
*/
var $plugin_file;
/**
* Version of the plugin
*/
var $plugin_ver = '';
/**
* Message shown to user (Warning, Notes, etc.)
*/
var $notices = array(), $notice_shown = false;
/**
* Capabilities to manage this plugin
*/
var $plugin_cap = 'manage_options';
/**
* Whether or not to create filter for media paths
*/
var $need_media_filters;
/**
* Form tabs to build
*/
var $form_tabs = array();
/**
* Other things
*/
var $wp_ver = '2.8';
var $php_ver = '5';
/**
* Build base properties
*/
function build_properties($key, $dkey, $options, $plugin_title = '', $plugin_file = '', $plugin_url = '', $need_media_filters = true)
{
$this->plugin_key = strtolower($key);
$this->plugin_ckey = strtoupper($key);
$this->plugin_dkey = $dkey;
$this->plugin_title = $plugin_title;
$this->plugin_url = $plugin_url;
// The default options
$this->options_default = $options;
$this->need_media_filters = (boolean) $need_media_filters;
$this->plugin_file = $plugin_file;
// Load locale
load_plugin_textdomain($dkey, false, basename(dirname($plugin_file)) . '/languages');
}
function add_option_key($key, $option, $title)
{
$this->option_keys[$key] = $option;
$this->option_pages[$key] = $title;
}
function add_extra_option_key($key, $option, $title)
{
$this->extra_option_keys[$key] = $option;
$this->option_pages[$key] = $title;
}
function add_icon()
{
return '<div class="icon32" id="icon-bwp-plugin" style=\'background-image: url("' . constant($this->plugin_ckey . '_IMAGES') . '/icon_menu_32.png");\'><br></div>' . "\n";
}
function set_version($ver = '', $type = '')
{
switch ($type)
{
case '': $this->plugin_ver = $ver;
break;
case 'php': $this->php_ver = $ver;
break;
case 'wp': $this->wp_ver = $ver;
break;
}
}
function get_version($type = '')
{
switch ($type)
{
case '': return $this->plugin_ver;
break;
case 'php': return $this->php_ver;
break;
case 'wp': return $this->wp_ver;
break;
}
}
function check_required_versions()
{
if (version_compare(PHP_VERSION, $this->php_ver, '<') || version_compare(get_bloginfo('version'), $this->wp_ver, '<'))
{
add_action('admin_notices', array($this, 'warn_required_versions'));
add_action('network_admin_notices', array($this, 'warn_required_versions'));
return false;
}
else
return true;
}
function warn_required_versions()
{
echo '<div class="error"><p>' . sprintf(__('%s requires WordPress <strong>%s</strong> or higher and PHP <strong>%s</strong> or higher. The plugin will not function until you update your software. Please deactivate this plugin.', $this->plugin_dkey), $this->plugin_title, $this->wp_ver, $this->php_ver) . '</p></div>';
}
function show_donation()
{
$showable = apply_filters('bwp_donation_showable', true);
?>
<div id="bwp-info-place">
<div id="bwp-donation" style="margin-bottom: 0px;">
<a href="<?php echo $this->plugin_url; ?>"><?php echo $this->plugin_title; ?></a> <small>v<?php echo $this->plugin_ver; ?></small><br />
<small>
<a href="<?php echo str_replace('/wordpress-plugins/', '/topic/', $this->plugin_url); ?>"><?php _e('Development Log', $this->plugin_dkey); ?></a> – <a href="<?php echo $this->plugin_url . 'faq/'; ?>" title="<?php _e('Frequently Asked Questions', $this->plugin_dkey) ?>"><?php _e('FAQ', $this->plugin_dkey); ?></a> – <a href="http://betterwp.net/contact/" title="<?php _e('Got a problem? Send me a feedback!', $this->plugin_dkey) ?>"><?php _e('Contact', $this->plugin_dkey); ?></a>
</small>
<br />
<?php
if (true == $showable || ($this->is_multisite() && is_super_admin()))
{
?>
<small><?php _e('You can buy me some special coffees if you appreciate my work, thank you!', $this->plugin_dkey); ?></small>
<form class="paypal-form" action="https://www.paypal.com/cgi-bin/webscr" method="post">
<p>
<input type="hidden" name="cmd" value="_xclick">
<input type="hidden" name="business" value="NWBB8JUDW5VSY">
<input type="hidden" name="lc" value="VN">
<input type="hidden" name="button_subtype" value="services">
<input type="hidden" name="no_note" value="0">
<input type="hidden" name="cn" value="Would you like to say anything to me?">
<input type="hidden" name="no_shipping" value="1">
<input type="hidden" name="rm" value="1">
<input type="hidden" name="return" value="http://betterwp.net">
<input type="hidden" name="currency_code" value="USD">
<input type="hidden" name="bn" value="PP-BuyNowBF:icon-paypal.gif:NonHosted">
<input type="hidden" name="item_name" value="<?php echo __('Donate to ' . $this->plugin_title, $this->plugin_dkey); ?>" />
<select name="amount">
<option value="5.00"><?php _e('One cup $5.00', $this->plugin_dkey); ?></option>
<option value="10.00"><?php _e('Two cups $10.00', $this->plugin_dkey); ?></option>
<option value="25.00"><?php _e('Five cups! $25.00', $this->plugin_dkey); ?></option>
<option value="50.00"><?php _e('One LL-cup!!! $50.00', $this->plugin_dkey); ?></option>
<option value="100.00"><?php _e('... or any amount!', $this->plugin_dkey); ?></option>
</select>
<span class="paypal-alternate-input" style="display: none;"><!-- --></span>
<input class="paypal-submit" type="image" src="<?php echo plugin_dir_url($this->plugin_file) . 'includes/bwp-option-page/images/icon-paypal.gif'; ?>" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!" />
<img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
</p>
</form>
<?php
}
?>
</div>
<div id="bwp-seperator">
<div style="height: 10px; width: 5px; background-color: #cccccc; margin: 0 auto;"><!-- --></div>
</div>
<div id="bwp-contact">
<a class="bwp-rss" href="http://feeds.feedburner.com/BetterWPnet"><?php _e('Latest updates from BetterWP.net!', $this->plugin_dkey); ?></a>
<a class="bwp-twitter" href="http://twitter.com/0dd0ne0ut"><?php _e('Follow me on Twitter!', $this->plugin_dkey); ?></a>
</div>
</div>
<?php
}
function show_version()
{
if (empty($this->plugin_ver)) return '';
return '<a class="nav-tab version" title="' . sprintf(esc_attr(__('You are using version %s!', $this->plugin_dkey)), $this->plugin_ver) . '">' . $this->plugin_ver . '</a>';
}
function init()
{
// Build constants
$this->build_constants();
// Build tabs
$this->build_tabs();
// Build options
$this->build_options();
// Load libraries
$this->load_libraries();
// Add actions and filters
$this->add_hooks();
// Enqueue needed media, conditionally
$this->enqueue_media();
// Load other properties
$this->init_properties();
// Loaded everything for this plugin, now you can add other things to it, such as stylesheet, etc.
do_action($this->plugin_key . '_loaded');
// Support installation and uninstallation
register_activation_hook($this->plugin_file, array($this, 'install'));
register_deactivation_hook($this->plugin_file, array($this, 'uninstall'));
// icon 32px
if ($this->is_admin_page())
{
add_filter('bwp-admin-form-icon', array($this, 'add_icon'));
add_filter('bwp-admin-plugin-version', array($this, 'show_version'));
add_action('bwp_option_action_before_form', array($this, 'show_donation'), 12);
}
}
function add_cap($cap)
{
$this->plugin_cap = $cap;
}
function build_constants()
{
define($this->plugin_ckey . '_PLUGIN_URL', $this->plugin_url);
// Path
if (true == $this->need_media_filters)
{
define($this->plugin_ckey . '_IMAGES', apply_filters($this->plugin_key . '_image_path', plugin_dir_url($this->plugin_file) . 'images'));
define($this->plugin_ckey . '_CSS', apply_filters($this->plugin_key . '_css_path', plugin_dir_url($this->plugin_file) . 'css'));
define($this->plugin_ckey . '_JS', apply_filters($this->plugin_key . '_js_path', plugin_dir_url($this->plugin_file) . 'js'));
}
else
{
define($this->plugin_ckey . '_IMAGES', plugin_dir_url($this->plugin_file) . 'images');
define($this->plugin_ckey . '_CSS', plugin_dir_url($this->plugin_file) . 'css');
define($this->plugin_ckey . '_JS', plugin_dir_url($this->plugin_file) . 'js');
}
// Option page related
define($this->plugin_ckey . '_CAPABILITY', $this->plugin_cap); // the capability needed to configure this plugin
foreach ($this->option_keys as $key => $option)
{
define(strtoupper($key), $option);
}
foreach ($this->extra_option_keys as $key => $option)
{
define(strtoupper($key), $option);
}
}
function build_options()
{
// Get all options and merge them
$options = $this->options_default;
foreach ($this->option_keys as $option)
{
$db_option = get_option($option);
if ($db_option && is_array($db_option))
$options = array_merge($options, $db_option);
unset($db_option);
// Also check for global options if in Multi-site
if ($this->is_multisite())
{
$db_option = get_site_option($option);
if ($db_option && is_array($db_option))
{
$temp = array();
foreach ($db_option as $k => $o)
{
if (in_array($k, $this->site_options))
$temp[$k] = $o;
}
$options = array_merge($options, $temp);
}
}
}
$this->options = $options;
}
function init_properties()
{
/* intentionally left blank */
}
function load_libraries()
{
/* intentionally left blank */
}
function add_hooks()
{
/* intentionally left blank */
}
function enqueue_media()
{
/* intentionally left blank */
}
function install()
{
/* intentionally left blank */
}
function uninstall()
{
/* intentionally left blank */
}
function is_admin_page()
{
if (is_admin() && !empty($_GET['page']) && (in_array($_GET['page'], $this->option_keys) || in_array($_GET['page'], $this->extra_option_keys)))
return true;
}
function plugin_action_links($links, $file)
{
$option_keys = array_values($this->option_keys);
if ($file == plugin_basename($this->plugin_file))
$links[] = '<a href="admin.php?page=' . $option_keys[0] . '">' . __('Settings') . '</a>';
return $links;
}
function init_admin()
{
add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2);
if ($this->is_admin_page())
{
// Load option page builder
if (!class_exists('BWP_OPTION_PAGE'))
require_once(dirname(__FILE__) . '/bwp-option-page/bwp-option-page.php');
// Enqueue style sheets and scripts for the option page
wp_enqueue_style('bwp-option-page', plugin_dir_url($this->plugin_file) . 'includes/bwp-option-page/css/bwp-option-page.css', array(), '1.0.1');
wp_enqueue_script('bwp-paypal-js', plugin_dir_url($this->plugin_file) . 'includes/bwp-option-page/js/paypal.js', array('jquery'));
}
$this->build_menus();
}
/**
* Build the Menus
*/
function build_menus()
{
/* intentionally left blank */
}
function build_tabs()
{
foreach ($this->option_pages as $key => $page)
{
$pagelink = (!empty($this->option_keys[$key])) ? $this->option_keys[$key] : $this->extra_option_keys[$key];
$this->form_tabs[$page] = get_option('siteurl') . '/wp-admin/admin.php?page=' . $pagelink;
}
}
/**
* Build the option pages
*
* Utilizes BWP Option Page Builder (@see BWP_OPTION_PAGE)
*/
function build_option_pages()
{
/* intentionally left blank */
}
function add_notice($notice)
{
if (!in_array($notice, $this->notices))
{
$this->notices[] = $notice;
add_action('bwp_option_action_before_form', array($this, 'show_notices'));
}
}
function show_notices()
{
if (false == $this->notice_shown)
{
foreach ($this->notices as $notice)
{
echo '<div class="updated fade"><p>' . $notice . '</p></div>';
}
$this->notice_shown = true;
}
}
function is_multisite()
{
if (function_exists('is_multisite') && is_multisite())
return true;
return false;
}
function is_normal_admin()
{
if ($this->is_multisite() && !is_super_admin())
return true;
return false;
}
}
?>