PluginProbe
Boxzilla – WordPress Popup Builder / 3.2.18
Boxzilla – WordPress Popup Builder v3.2.18
3.4.11 3.4.10 3.4.9 3.4.3 3.4.4 3.4.5 3.4.6 3.4.7 3.4.8 trunk 3.0 3.0.1 3.0.2 3.0.3 3.1 3.1.1 3.1.10 3.1.11 3.1.12 3.1.13 3.1.14 3.1.15 3.1.16 3.1.17 3.1.18 All 72 releases
← All changes | src/class-loader.php +337 -293 3.03.2.18 View file →
@@ -1,293 +1,337 @@
1 -<?php
2 -
3 -namespace Boxzilla;
4 -
5 -class BoxLoader {
6 -
7 - /**
8 - * @var Plugin
9 - */
10 - private $plugin;
11 -
12 - /**
13 - * @var array
14 - */
15 - private $box_ids_to_load = array();
16 -
17 - /**
18 - * @var array
19 - */
20 - protected $options;
21 -
22 - /**
23 - * Constructor
24 - *
25 - * @param Plugin $plugin
26 - * @param array $options
27 - */
28 - public function __construct( Plugin $plugin, array $options ) {
29 - $this->plugin = $plugin;
30 - $this->options = $options;
31 - }
32 -
33 - /**
34 - * Initializes the plugin, runs on `wp` hook.
35 - */
36 - public function init() {
37 -
38 - $this->box_ids_to_load = $this->filter_boxes();
39 -
40 - // Only add other hooks if necessary
41 - if( count( $this->box_ids_to_load ) > 0 ) {
42 - add_action( 'wp_enqueue_scripts', array( $this, 'load_assets' ), 90 );
43 - }
44 - }
45 -
46 - /**
47 - * Get global rules for all boxes
48 - *
49 - * @return array
50 - */
51 - protected function get_filter_rules() {
52 - $rules = get_option( 'boxzilla_rules', array() );
53 -
54 - if( ! is_array( $rules ) ) {
55 - return array();
56 - }
57 -
58 - return $rules;
59 - }
60 -
61 -
62 - /**
63 - * Match a string against an array of patterns, glob-style.
64 - *
65 - * @param string $string
66 - * @param array $patterns
67 - *
68 - * @return boolean
69 - */
70 - protected function match_patterns( $string, $patterns ) {
71 - $string = strtolower( $string );
72 -
73 - foreach( $patterns as $pattern ) {
74 -
75 - $pattern = strtolower( $pattern );
76 -
77 - if( function_exists( 'fnmatch' ) ) {
78 - $match = fnmatch( $pattern, $string );
79 - } else {
80 - $match = ( $pattern === $string );
81 - }
82 -
83 - if( $match ) {
84 - return true;
85 - }
86 - }
87 -
88 - return false;
89 - }
90 -
91 - /**
92 - * Check if this rule passes (conditional matches expected value)
93 - *
94 - * @param string $condition
95 - * @param string $value
96 - * @param boolean $qualifier
97 - *
98 - * @return bool
99 - */
100 - protected function match_rule( $condition, $value, $qualifier = true ) {
101 -
102 - $matched = false;
103 -
104 - // cast value to array & trim whitespace or excess comma's
105 - $value = array_map( 'trim', explode( ',', rtrim( trim( $value ), ',' ) ) );
106 -
107 - switch ( $condition ) {
108 - case 'everywhere';
109 - $matched = true;
110 - break;
111 -
112 - case 'is_url':
113 - $matched = $this->match_patterns( $_SERVER['REQUEST_URI'], $value );
114 - break;
115 -
116 - case 'is_referer':
117 - if( ! empty( $_SERVER['HTTP_REFERER'] ) ) {
118 - $referer = $_SERVER['HTTP_REFERER'];
119 - $matched = $this->match_patterns( $referer, $value );
120 - }
121 - break;
122 -
123 - case 'is_post_type':
124 - $post_type = (string) get_post_type();
125 - $matched = in_array( $post_type, (array) $value );
126 - break;
127 -
128 - case 'is_single':
129 - case 'is_post':
130 - $matched = is_single( $value );
131 - break;
132 -
133 - case 'is_post_in_category':
134 - $matched = is_singular( 'post' ) && has_category( $value );
135 - break;
136 -
137 -
138 - case 'is_page':
139 - $matched = is_page( $value );
140 - break;
141 -
142 - }
143 -
144 - // if qualifier is set to false, we need to reverse this value here.
145 - if( ! $qualifier ) {
146 - $matched = ! $matched;
147 - }
148 -
149 - return $matched;
150 - }
151 -
152 - /**
153 - * Checks which boxes should be loaded for this request.
154 - *
155 - * @return array
156 - */
157 - private function filter_boxes() {
158 -
159 - $box_ids_to_load = array();
160 - $rules = $this->get_filter_rules();
161 -
162 - foreach( $rules as $box_id => $box_rules ) {
163 -
164 - $matched = false;
165 - $comparision = isset( $box_rules['comparision'] ) ? $box_rules['comparision'] : 'any';
166 -
167 - // loop through all rules for all boxes
168 - foreach ( $box_rules as $rule ) {
169 -
170 - // skip faulty values (and comparision rule)
171 - if( empty( $rule['condition'] ) ) {
172 - continue;
173 - }
174 -
175 - $qualifier = isset( $rule['qualifier'] ) ? $rule['qualifier'] : true;
176 - $matched = $this->match_rule( $rule['condition'], $rule['value'], $qualifier );
177 -
178 - // break out of loop if we've already matched
179 - if( $comparision === 'any' && $matched ) {
180 - break;
181 - }
182 -
183 - // no need to continue if this rule didn't match
184 - if( $comparision === 'all' && ! $matched ) {
185 - break;
186 - }
187 - }
188 -
189 - // value of $matched at this point determines whether box should be loaded
190 - $load_box = $matched;
191 -
192 - /**
193 - * Filters whether a box should be loaded into the page HTML.
194 - *
195 - * The dynamic portion of the hook, `$box_id`, refers to the ID of the box. Return true if you want to output the box.
196 - *
197 - * @param boolean $load_box
198 - */
199 - $load_box = apply_filters( 'boxzilla_load_box_' . $box_id, $load_box );
200 -
201 - /**
202 - * Filters whether a box should be loaded into the page HTML.
203 - *
204 - * @param boolean $load_box
205 - * @param int $box_id
206 - */
207 - $load_box = apply_filters( 'boxzilla_load_box', $load_box, $box_id );
208 -
209 - // if matched, box should be loaded on this page
210 - if ( $load_box ) {
211 - $box_ids_to_load[] = $box_id;
212 - }
213 -
214 - }
215 -
216 - return $box_ids_to_load;
217 - }
218 -
219 - /**
220 - * Load plugin styles
221 - */
222 - public function load_assets() {
223 - $pre_suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
224 -
225 - // stylesheets
226 - wp_register_style( 'boxzilla', $this->plugin->url( '/assets/css/styles' . $pre_suffix . '.css' ), array(), $this->plugin->version() );
227 -
228 - // scripts
229 - wp_register_script( 'boxzilla',$this->plugin->url( '/assets/js/script' . $pre_suffix . '.js' ), array( 'jquery' ), $this->plugin->version(), true );
230 -
231 - // Finally, enqueue style.
232 - wp_enqueue_style( 'boxzilla' );
233 - wp_enqueue_script( 'boxzilla' );
234 -
235 - $this->pass_box_options();
236 -
237 - do_action( 'boxzilla_load_assets', $this );
238 - }
239 -
240 - /**
241 - * Get an array of Box objects. These are the boxes that will be loaded for the current request.
242 - *
243 - * @return Box[]
244 - */
245 - public function get_matched_boxes() {
246 - static $boxes;
247 -
248 - if( is_null( $boxes ) ) {
249 -
250 - if( count( $this->box_ids_to_load ) === 0 ) {
251 - $boxes = array();
252 - return $boxes;
253 - }
254 -
255 - // query Box posts
256 - $boxes = get_posts(
257 - array(
258 - 'post_type' => 'boxzilla-box',
259 - 'post_status' => 'publish',
260 - 'post__in' => $this->box_ids_to_load,
261 - 'numberposts' => -1
262 - )
263 - );
264 -
265 - // create `Box` instances out of \WP_Post instances
266 - foreach ( $boxes as $key => $box ) {
267 - $boxes[ $key ] = new Box( $box );
268 - }
269 - }
270 -
271 - return $boxes;
272 - }
273 -
274 - /**
275 - * Create array of Box options and pass it to JavaScript script.
276 - */
277 - public function pass_box_options() {
278 -
279 - // create boxzilla_Global_Options object
280 - $plugin_options = $this->options;
281 - $boxes = $this->get_matched_boxes();
282 -
283 - $data = array(
284 - 'testMode' => (boolean) $plugin_options['test_mode'],
285 - 'boxes' => array_map( function(Box $box) { return $box->get_client_options(); }, $boxes ),
286 - );
287 -
288 - wp_localize_script( 'boxzilla', 'boxzilla_options', $data );
289 - }
290 -
291 -}
292 -
293 -
1 +<?php
2 +
3 +namespace Boxzilla;
4 +
5 +class BoxLoader {
6 +
7 +
8 + /**
9 + * @var Plugin
10 + */
11 + private $plugin;
12 +
13 + /**
14 + * @var array
15 + */
16 + private $box_ids_to_load = array();
17 +
18 + /**
19 + * @var array
20 + */
21 + protected $options;
22 +
23 + /**
24 + * Constructor
25 + *
26 + * @param Plugin $plugin
27 + * @param array $options
28 + */
29 + public function __construct( Plugin $plugin, array $options ) {
30 + $this->plugin = $plugin;
31 + $this->options = $options;
32 + }
33 +
34 + /**
35 + * Initializes the plugin, runs on `wp` hook.
36 + */
37 + public function init() {
38 + $this->box_ids_to_load = $this->filter_boxes();
39 +
40 + // Only add other hooks if necessary
41 + if ( count( $this->box_ids_to_load ) > 0 ) {
42 + add_action( 'wp_footer', array( $this, 'print_boxes_content' ), 1 );
43 + add_action( 'wp_enqueue_scripts', array( $this, 'load_assets' ), 90 );
44 + }
45 + }
46 +
47 + /**
48 + * Get global rules for all boxes
49 + *
50 + * @return array
51 + */
52 + protected function get_filter_rules() {
53 + $rules = get_option( 'boxzilla_rules', array() );
54 +
55 + if ( ! is_array( $rules ) ) {
56 + return array();
57 + }
58 +
59 + return $rules;
60 + }
61 +
62 +
63 + /**
64 + * Match a string against an array of patterns, glob-style.
65 + *
66 + * @param string $string
67 + * @param array $patterns
68 + *
69 + * @return boolean
70 + */
71 + protected function match_patterns( $string, $patterns, $contains = false ) {
72 + $string = strtolower( $string );
73 +
74 + foreach ( $patterns as $pattern ) {
75 + $pattern = rtrim( $pattern, '/' );
76 + $pattern = strtolower( $pattern );
77 +
78 + // contains means we should do a simple occurrence check
79 + // does not support wildcards
80 + if ( $contains ) {
81 + return strpos( $string, $pattern ) !== false;
82 + }
83 +
84 + if ( function_exists( 'fnmatch' ) ) {
85 + $match = fnmatch( $pattern, $string );
86 + } else {
87 + $match = ( $pattern === $string );
88 + }
89 +
90 + if ( $match ) {
91 + return true;
92 + }
93 + }
94 +
95 + return false;
96 + }
97 +
98 + /**
99 + * @return string
100 + */
101 + protected function get_request_url() {
102 + // strip trailing slashes
103 + $request_uri = rtrim( $_SERVER['REQUEST_URI'], '/' );
104 + return $request_uri;
105 + }
106 +
107 + /**
108 + * Check if this rule passes (conditional matches expected value)
109 + *
110 + * @param string $condition
111 + * @param string $value
112 + * @param boolean $qualifier
113 + *
114 + * @return bool
115 + */
116 + protected function match_rule( $condition, $value, $qualifier = true ) {
117 + $matched = false;
118 +
119 + // cast value to array & trim whitespace or excess comma's
120 + $value = array_map( 'trim', explode( ',', rtrim( trim( $value ), ',' ) ) );
121 +
122 + switch ( $condition ) {
123 + case 'everywhere':
124 + $matched = true;
125 + break;
126 +
127 + case 'is_url':
128 + $url = $this->get_request_url();
129 + $matched = $this->match_patterns( $url, $value, $qualifier === 'contains' || $qualifier === 'not_contains' );
130 + break;
131 +
132 + case 'is_referer':
133 + if ( ! empty( $_SERVER['HTTP_REFERER'] ) ) {
134 + $referer = $_SERVER['HTTP_REFERER'];
135 + $matched = $this->match_patterns( $referer, $value, $qualifier === 'contains' || $qualifier === 'not_contains' );
136 + }
137 + break;
138 +
139 + case 'is_post_type':
140 + $post_type = (string) get_post_type();
141 + $matched = in_array( $post_type, (array) $value, true );
142 + break;
143 +
144 + case 'is_single':
145 + case 'is_post':
146 + // convert to empty string if array with just empty string in it
147 + $value = ( $value === array( '' ) ) ? '' : $value;
148 + $matched = is_single( $value );
149 + break;
150 +
151 + case 'is_post_in_category':
152 + $matched = is_singular( 'post' ) && has_category( $value );
153 + break;
154 +
155 + case 'is_page':
156 + $matched = is_page( $value );
157 + break;
158 +
159 + case 'is_post_with_tag':
160 + $matched = is_singular( 'post' ) && has_tag( $value );
161 + break;
162 +
163 + case 'is_user_logged_in':
164 + $matched = is_user_logged_in();
165 + break;
166 + }
167 +
168 + /**
169 + * Filters whether a given box rule matches the condition and expected value.
170 + *
171 + * The dynamic portion of the hook, `$condition`, refers to the condition being matched.
172 + *
173 + * @param boolean $matched
174 + * @param array $value
175 + */
176 + $matched = apply_filters( 'boxzilla_box_rule_matches_' . $condition, $matched, $value );
177 +
178 + // if qualifier is set to false, we need to reverse this value here.
179 + if ( ! $qualifier || $qualifier === 'not_contains' ) {
180 + $matched = ! $matched;
181 + }
182 +
183 + return $matched;
184 + }
185 +
186 + /**
187 + * Checks which boxes should be loaded for this request.
188 + *
189 + * @return array
190 + */
191 + private function filter_boxes() {
192 + $box_ids_to_load = array();
193 + $rules = $this->get_filter_rules();
194 +
195 + foreach ( $rules as $box_id => $box_rules ) {
196 + $matched = false;
197 + $comparision = isset( $box_rules['comparision'] ) ? $box_rules['comparision'] : 'any';
198 +
199 + // loop through all rules for all boxes
200 + foreach ( $box_rules as $rule ) {
201 +
202 + // skip faulty values (and comparision rule)
203 + if ( empty( $rule['condition'] ) ) {
204 + continue;
205 + }
206 +
207 + $qualifier = isset( $rule['qualifier'] ) ? $rule['qualifier'] : true;
208 + $matched = $this->match_rule( $rule['condition'], $rule['value'], $qualifier );
209 +
210 + // break out of loop if we've already matched
211 + if ( $comparision === 'any' && $matched ) {
212 + break;
213 + }
214 +
215 + // no need to continue if this rule didn't match
216 + if ( $comparision === 'all' && ! $matched ) {
217 + break;
218 + }
219 + }
220 +
221 + // value of $matched at this point determines whether box should be loaded
222 + $load_box = $matched;
223 +
224 + /**
225 + * Filters whether a box should be loaded into the page HTML.
226 + *
227 + * The dynamic portion of the hook, `$box_id`, refers to the ID of the box. Return true if you want to output the box.
228 + *
229 + * @param boolean $load_box
230 + */
231 + $load_box = apply_filters( 'boxzilla_load_box_' . $box_id, $load_box );
232 +
233 + /**
234 + * Filters whether a box should be loaded into the page HTML.
235 + *
236 + * @param boolean $load_box
237 + * @param int $box_id
238 + */
239 + $load_box = apply_filters( 'boxzilla_load_box', $load_box, $box_id );
240 +
241 + // if matched, box should be loaded on this page
242 + if ( $load_box ) {
243 + $box_ids_to_load[] = $box_id;
244 + }
245 + }
246 +
247 + /**
248 + * Filters which boxes should be loaded on this page, expects an array of post ID's.
249 + *
250 + * @param array $box_ids_to_load
251 + */
252 + return apply_filters( 'boxzilla_load_boxes', $box_ids_to_load );
253 + }
254 +
255 + /**
256 + * Load plugin styles
257 + */
258 + public function load_assets() {
259 + $pre_suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
260 + wp_enqueue_script( 'boxzilla', $this->plugin->url( '/assets/js/script' . $pre_suffix . '.js' ), array(), $this->plugin->version(), true );
261 +
262 + // create boxzilla_Global_Options object
263 + $plugin_options = $this->options;
264 + $boxes = $this->get_matched_boxes();
265 +
266 + $data = array(
267 + 'testMode' => (bool) $plugin_options['test_mode'],
268 + 'boxes' => (array) array_map(
269 + function ( Box $box ) {
270 + return $box->get_client_options();
271 + },
272 + $boxes
273 + ),
274 + );
275 +
276 + wp_localize_script( 'boxzilla', 'boxzilla_options', $data );
277 +
278 + do_action( 'boxzilla_load_assets', $this );
279 + }
280 +
281 + public function print_boxes_content() {
282 + $boxes = $this->get_matched_boxes();
283 + if ( empty( $boxes ) ) {
284 + return;
285 + }
286 +
287 + echo '<div style="display: none;">';
288 + foreach ( $boxes as $box ) {
289 + echo sprintf( '<div id="boxzilla-box-%d-content">', $box->ID ) . $box->get_content() . '</div>';
290 + }
291 + echo '</div>';
292 + }
293 +
294 + /**
295 + * Get an array of Box objects. These are the boxes that will be loaded for the current request.
296 + *
297 + * @return Box[]
298 + */
299 + public function get_matched_boxes() {
300 + static $boxes;
301 +
302 + if ( is_null( $boxes ) ) {
303 + if ( count( $this->box_ids_to_load ) === 0 ) {
304 + $boxes = array();
305 + return $boxes;
306 + }
307 +
308 + // query Box posts
309 + $q = new \WP_Query();
310 + $posts = $q->query(
311 + array(
312 + 'post_type' => 'boxzilla-box',
313 + 'post_status' => 'publish',
314 + 'post__in' => $this->box_ids_to_load,
315 + 'posts_per_page' => count( $this->box_ids_to_load ),
316 + 'ignore_sticky_posts' => true,
317 + 'no_found_rows' => true,
318 + )
319 + );
320 +
321 + // create `Box` instances out of \WP_Post instances
322 + $boxes = array();
323 + foreach ( $posts as $key => $post ) {
324 + $box = new Box( $post );
325 +
326 + // skip boxes without any content
327 + if ( $box->get_content() === '' ) {
328 + continue;
329 + }
330 +
331 + $boxes[ $key ] = $box;
332 + }
333 + }
334 +
335 + return $boxes;
336 + }
337 +}