Kirki_Modules_PostMessage::postmessage() - Code Metrics - Inspection of "see #1333" - aristath/kirki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#1334)

by Aristeides

created 2017-05-26 16:18 UTC

Kirki_Modules_PostMessage::postmessage() B

↳ Parent: Kirki_Modules_PostMessage

Complexity

Conditions	8
Paths	3

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	8
nc	3
nop	0
dl	0
loc	13
rs	7.7777
c	0
b	0
f	0

<?php
/**
 * Automatic postMessage scripts calculation for Kirki controls.
 *
 * @package     Kirki
 * @category    Modules
 * @author      Aristeides Stathopoulos
 * @copyright   Copyright (c) 2017, Aristeides Stathopoulos
 * @license     http://opensource.org/licenses/https://opensource.org/licenses/MIT
 * @since       3.0.0
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Adds styles to the customizer.
 */
class Kirki_Modules_PostMessage {

	/**
	 * The script.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @var string
	 */
	protected $script = '';

	/**
	 * Constructor.
	 *
	 * @access public
	 * @since 3.0.0
	 */
	public function __construct() {
		add_action( 'customize_preview_init', array( $this, 'postmessage' ) );
	}

	/**
	 * Enqueues the postMessage script
	 * and adds variables to it using the wp_localize_script function.
	 * The rest is handled via JS.
	 */
	public function postmessage() {

		wp_enqueue_script( 'kirki_auto_postmessage', trailingslashit( Kirki::$url ) . 'modules/postmessage/postmessage.js', array( 'jquery', 'customize-preview' ), false, true );
		$fields = Kirki::$fields;
		foreach ( $fields as $field ) {
			if ( isset( $field['transport'] ) && 'postMessage' === $field['transport'] && isset( $field['js_vars'] ) && ! empty( $field['js_vars'] ) && is_array( $field['js_vars'] ) && isset( $field['settings'] ) ) {
				$this->script .= $this->script( $field );
			}
		}
		$this->script = apply_filters( 'kirki/postmessage/script', $this->script );
		wp_add_inline_script( 'kirki_auto_postmessage', $this->script, 'after' );

	}

	/**
	 * Generates script for a single js_var.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param array $args  The arguments for this js_var.
	 * @param array $field The whole field arguments.
	 */
	protected function script_var( $args, $field ) {

		$script = '';
		$property_script = '';

		$value_key = 'newval' . $args['index_key'];
		$property_script .= $value_key . '=newval;';

		$args = $this->get_args( $args );

		// Apply callback to the value if a callback is defined.
		if ( ! empty( $args['js_callback'][0] ) ) {
			$script .= $value_key . '=' . $args['js_callback'][0] . '(' . $value_key . ',' . $args['js_callback'][1] . ');';
		}

		// Apply the value_pattern.
		if ( '' !== $args['value_pattern'] ) {
			$script .= $this->value_pattern_replacements( $value_key, $args );
		}

		// Apply prefix, units, suffix.
		$value = $value_key;
		if ( '' !== $args['prefix'] ) {
			$value = $args['prefix'] . '+' . $value_key;
		}
		return array(
			'script' => $property_script . $script,
			'css'    => $args['element'] . '{' . $args['property'] . ':\'+' . $value . '+\'' . $args['units'] . $args['suffix'] . ';}',
		);
	}

	/**
	 * Generates script for a single field.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param array $args The arguments.
	 */
	protected function script( $args ) {

		$script = 'wp.customize(\'' . $args['settings'] . '\',function(value){value.bind(function(newval){';
		// append unique style tag if not exist
		// The style ID.
		$style_id = 'kirki-postmessage-' . str_replace( array( '[', ']' ), '', $args['settings'] );
		$script .= 'if(!jQuery(\'' . $style_id . '\').size()){jQuery(\'head\').append(\'<style id="' . $style_id . '"></style>\');}';

		// Loop through the js_vars and generate the script.
		foreach ( $args['js_vars'] as $key => $js_var ) {
			$js_var['index_key'] = $key;
			$func_name = 'script_var_' . str_replace( array( 'kirki-', '-' ), array( '', '_' ), $args['type'] );
			if ( method_exists( $this, $func_name ) ) {
				$field['scripts'][ $key ] = call_user_func_array( array( $this, $func_name ), array( $js_var, $args ) );
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
				continue;
			}
			$field['scripts'][ $key ] = $this->script_var( $js_var, $args );
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
		}
		$combo_extra_script = '';
		$combo_css_script   = '';
		foreach ( $field['scripts'] as $script_array ) {
			$combo_extra_script .= $script_array['script'];
			$combo_css_script   .= $script_array['css'];
		}
		if ( 'css' === $combo_css_script ) {
			$script .= $combo_extra_script . 'jQuery(\'#' . $style_id . '\').text(css);';
		} else {
			$script .= $combo_extra_script . 'jQuery(\'#' . $style_id . '\').text(\'' . $combo_css_script . '\');';
		}
		$script .= '});});';
		return $script;
	}

	/**
	 * Processes values for dimensions fields.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param array $args  The arguments for this js_var.
	 * @param array $field The whole field arguments.
	 */
	protected function script_var_dimensions( $args, $field ) {
		return $this->script_var_array( $args, $field );
	}

	/**
	 * Processes script generation for fields that save an array.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param array $args  The arguments for this js_var.
	 * @param array $field The whole field arguments.
	 */
	protected function script_var_array( $args, $field ) {


		$script = 'css=\'\';';
		$property_script = '';
		$css = '';

		$value_key = 'newval' . $args['index_key'];
		$property_script .= $value_key . '=newval;';

		$args = $this->get_args( $args );

		// Apply callback to the value if a callback is defined.
		if ( ! empty( $args['js_callback'][0] ) ) {
			$script .= $value_key . '=' . $args['js_callback'][0] . '(' . $value_key . ',' . $args['js_callback'][1] . ');';
		}
		$script .= '_.each(' . $value_key . ', function(subValue,subKey){';
		// Apply the value_pattern.
		if ( '' !== $args['value_pattern'] ) {
			$script .= $this->value_pattern_replacements( 'subValue', $args );
		}
		// Apply prefix, units, suffix.
		$value = $value_key;
		if ( '' !== $args['prefix'] ) {
			$value = '\'' . $args['prefix'] . '\'+subValue';
		}
		$script .= 'if(!_.isUndefined(' . $value_key . '.choice)){if(' . $value_key . '.choice===subKey){';
		$script .= 'css+=\'' . $args['element'] . '{' . $args['property'] . ':\'+subValue+\';}\';';
		$script .= '}}else{';

		// Mostly used for padding, margin & position properties.
		$script .= 'if(_.contains([\'top\',\'bottom\',\'left\',\'right\'],subKey)){';
		$script .= 'css+=\'' . $args['element'] . '{' . $args['property'] . '-\'+subKey+\':\'+subValue+\'' . $args['units'] . $args['suffix'] . ';}\';';
		$script .= '}else{';

		// This is where most object-based fields will go.
		$script .= 'css+=\'' . $args['element'] . '{\'+subKey+\':\'+subValue+\'' . $args['units'] . $args['suffix'] . ';}\';';
		$script .= '}}';
		$script .= '});';

		return array(
			'script' => $property_script . $script,
			'css'    => 'css',
		);
	}

	/**
	 * Sanitizes the arguments and makes sure they are all there.
	 *
	 * @access private
	 * @since 3.0.0
	 * @param array $args The arguments.
	 * @return array
	 */
	private function get_args( $args ) {

		// Make sure everything is defined to avoid "undefined index" errors.
		$args = wp_parse_args( $args, array(
			'element'       => '',
			'property'      => '',
			'prefix'        => '',
			'suffix'        => '',
			'units'         => '',
			'js_callback'   => array( '', '' ),
			'value_pattern' => '',
		));

		// Element should be a string.
		if ( is_array( $args['element'] ) ) {
			$args['element'] = implode( ',', $args['element'] );
		}

		// Make sure arguments that are passed-on to callbacks are strings.
		if ( is_array( $args['js_callback'] ) && isset( $args['js_callback'][1] ) && is_array( $args['js_callback'][1] ) ) {
			$args['js_callback'][1] = wp_json_encode( $args['js_callback'][1] );
		}
		return $args;

	}

	/**
	 * Returns script for value_pattern & replacements.
	 *
	 * @access private
	 * @since 3.0.0
	 * @param string $value   The value placeholder.
	 * @param array  $js_vars The js_vars argument.
	 * @return string         The script.
	 */
	private function value_pattern_replacements( $value, $js_vars ) {
		$script = '';
		$alias  = $value;
		if ( isset( $js_vars['replacements'] ) ) {
			$script .= 'settings=window.wp.customize.get();';
			foreach ( $js_vars['replacements'] as $search => $replace ) {
				$replace = '\'+settings["' . $replace . '"]+\'';
				$value = str_replace( $search, $replace, $js_vars['value_pattern'] );
				$value = trim( $value, '+' );
			}
		}
		$value_compiled = str_replace( '$', '\'+' . $alias . '+\'', $value );
		$value_compiled = trim( $value_compiled, '+' );
		return $script . $alias . '=\''. $value_compiled . '\';';
	}
}


1			<?php
2			/**
3			* Automatic postMessage scripts calculation for Kirki controls.
4			*
5			* @package Kirki
6			* @category Modules
7			* @author Aristeides Stathopoulos
8			* @copyright Copyright (c) 2017, Aristeides Stathopoulos
9			* @license http://opensource.org/licenses/https://opensource.org/licenses/MIT
10			* @since 3.0.0
11			*/
12
13			// Exit if accessed directly.
14			if ( ! defined( 'ABSPATH' ) ) {
15			exit;
16			}
17
18			/**
19			* Adds styles to the customizer.
20			*/
21			class Kirki_Modules_PostMessage {
22
23			/**
24			* The script.
25			*
26			* @access protected
27			* @since 3.0.0
28			* @var string
29			*/
30			protected $script = '';
31
32			/**
33			* Constructor.
34			*
35			* @access public
36			* @since 3.0.0
37			*/
38			public function __construct() {
39			add_action( 'customize_preview_init', array( $this, 'postmessage' ) );
40			}
41
42			/**
43			* Enqueues the postMessage script
44			* and adds variables to it using the wp_localize_script function.
45			* The rest is handled via JS.
46			*/
47			public function postmessage() {
48
49			wp_enqueue_script( 'kirki_auto_postmessage', trailingslashit( Kirki::$url ) . 'modules/postmessage/postmessage.js', array( 'jquery', 'customize-preview' ), false, true );
50			$fields = Kirki::$fields;
51			foreach ( $fields as $field ) {
52			if ( isset( $field['transport'] ) && 'postMessage' === $field['transport'] && isset( $field['js_vars'] ) && ! empty( $field['js_vars'] ) && is_array( $field['js_vars'] ) && isset( $field['settings'] ) ) {
53			$this->script .= $this->script( $field );
54			}
55			}
56			$this->script = apply_filters( 'kirki/postmessage/script', $this->script );
57			wp_add_inline_script( 'kirki_auto_postmessage', $this->script, 'after' );
58
59			}
60
61			/**
62			* Generates script for a single js_var.
63			*
64			* @access protected
65			* @since 3.0.0
66			* @param array $args The arguments for this js_var.
67			* @param array $field The whole field arguments.
68			*/
69			protected function script_var( $args, $field ) {
			0 ignored issues – show Unused Code introduced 2017-05-26 07:08 UTC by Report Bug Copy Issue Report The parameter `$field` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
70			$script = '';
71			$property_script = '';
72
73			$value_key = 'newval' . $args['index_key'];
74			$property_script .= $value_key . '=newval;';
75
76			$args = $this->get_args( $args );
77
78			// Apply callback to the value if a callback is defined.
79			if ( ! empty( $args['js_callback'][0] ) ) {
80			$script .= $value_key . '=' . $args['js_callback'][0] . '(' . $value_key . ',' . $args['js_callback'][1] . ');';
81			}
82
83			// Apply the value_pattern.
84			if ( '' !== $args['value_pattern'] ) {
85			$script .= $this->value_pattern_replacements( $value_key, $args );
86			}
87
88			// Apply prefix, units, suffix.
89			$value = $value_key;
90			if ( '' !== $args['prefix'] ) {
91			$value = $args['prefix'] . '+' . $value_key;
92			}
93			return array(
94			'script' => $property_script . $script,
95			'css' => $args['element'] . '{' . $args['property'] . ':\'+' . $value . '+\'' . $args['units'] . $args['suffix'] . ';}',
96			);
97			}
98
99			/**
100			* Generates script for a single field.
101			*
102			* @access protected
103			* @since 3.0.0
104			* @param array $args The arguments.
105			*/
106			protected function script( $args ) {
107
108			$script = 'wp.customize(\'' . $args['settings'] . '\',function(value){value.bind(function(newval){';
109			// append unique style tag if not exist
110			// The style ID.
111			$style_id = 'kirki-postmessage-' . str_replace( array( '[', ']' ), '', $args['settings'] );
112			$script .= 'if(!jQuery(\'' . $style_id . '\').size()){jQuery(\'head\').append(\'<style id="' . $style_id . '"></style>\');}';
113
114			// Loop through the js_vars and generate the script.
115			foreach ( $args['js_vars'] as $key => $js_var ) {
116			$js_var['index_key'] = $key;
117			$func_name = 'script_var_' . str_replace( array( 'kirki-', '-' ), array( '', '_' ), $args['type'] );
118			if ( method_exists( $this, $func_name ) ) {
119			$field['scripts'][ $key ] = call_user_func_array( array( $this, $func_name ), array( $js_var, $args ) );
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-05-26 07:08 UTC by Report Bug Copy Issue Report `$field` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$field = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
120			continue;
121			}
122			$field['scripts'][ $key ] = $this->script_var( $js_var, $args );
			0 ignored issues – show Bug introduced 2017-05-26 07:08 UTC by Report Bug Copy Issue Report The variable `$field` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
123			}
124			$combo_extra_script = '';
125			$combo_css_script = '';
126			foreach ( $field['scripts'] as $script_array ) {
127			$combo_extra_script .= $script_array['script'];
128			$combo_css_script .= $script_array['css'];
129			}
130			if ( 'css' === $combo_css_script ) {
131			$script .= $combo_extra_script . 'jQuery(\'#' . $style_id . '\').text(css);';
132			} else {
133			$script .= $combo_extra_script . 'jQuery(\'#' . $style_id . '\').text(\'' . $combo_css_script . '\');';
134			}
135			$script .= '});});';
136			return $script;
137			}
138
139			/**
140			* Processes values for dimensions fields.
141			*
142			* @access protected
143			* @since 3.0.0
144			* @param array $args The arguments for this js_var.
145			* @param array $field The whole field arguments.
146			*/
147			protected function script_var_dimensions( $args, $field ) {
148			return $this->script_var_array( $args, $field );
149			}
150
151			/**
152			* Processes script generation for fields that save an array.
153			*
154			* @access protected
155			* @since 3.0.0
156			* @param array $args The arguments for this js_var.
157			* @param array $field The whole field arguments.
158			*/
159			protected function script_var_array( $args, $field ) {
			0 ignored issues – show Unused Code introduced 2017-05-26 07:08 UTC by Report Bug Copy Issue Report The parameter `$field` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
160
161			$script = 'css=\'\';';
162			$property_script = '';
163			$css = '';
164
165			$value_key = 'newval' . $args['index_key'];
166			$property_script .= $value_key . '=newval;';
167
168			$args = $this->get_args( $args );
169
170			// Apply callback to the value if a callback is defined.
171			if ( ! empty( $args['js_callback'][0] ) ) {
172			$script .= $value_key . '=' . $args['js_callback'][0] . '(' . $value_key . ',' . $args['js_callback'][1] . ');';
173			}
174			$script .= '_.each(' . $value_key . ', function(subValue,subKey){';
175			// Apply the value_pattern.
176			if ( '' !== $args['value_pattern'] ) {
177			$script .= $this->value_pattern_replacements( 'subValue', $args );
178			}
179			// Apply prefix, units, suffix.
180			$value = $value_key;
181			if ( '' !== $args['prefix'] ) {
182			$value = '\'' . $args['prefix'] . '\'+subValue';
183			}
184			$script .= 'if(!_.isUndefined(' . $value_key . '.choice)){if(' . $value_key . '.choice===subKey){';
185			$script .= 'css+=\'' . $args['element'] . '{' . $args['property'] . ':\'+subValue+\';}\';';
186			$script .= '}}else{';
187
188			// Mostly used for padding, margin & position properties.
189			$script .= 'if(_.contains([\'top\',\'bottom\',\'left\',\'right\'],subKey)){';
190			$script .= 'css+=\'' . $args['element'] . '{' . $args['property'] . '-\'+subKey+\':\'+subValue+\'' . $args['units'] . $args['suffix'] . ';}\';';
191			$script .= '}else{';
192
193			// This is where most object-based fields will go.
194			$script .= 'css+=\'' . $args['element'] . '{\'+subKey+\':\'+subValue+\'' . $args['units'] . $args['suffix'] . ';}\';';
195			$script .= '}}';
196			$script .= '});';
197
198			return array(
199			'script' => $property_script . $script,
200			'css' => 'css',
201			);
202			}
203
204			/**
205			* Sanitizes the arguments and makes sure they are all there.
206			*
207			* @access private
208			* @since 3.0.0
209			* @param array $args The arguments.
210			* @return array
211			*/
212			private function get_args( $args ) {
213
214			// Make sure everything is defined to avoid "undefined index" errors.
215			$args = wp_parse_args( $args, array(
216			'element' => '',
217			'property' => '',
218			'prefix' => '',
219			'suffix' => '',
220			'units' => '',
221			'js_callback' => array( '', '' ),
222			'value_pattern' => '',
223			));
224
225			// Element should be a string.
226			if ( is_array( $args['element'] ) ) {
227			$args['element'] = implode( ',', $args['element'] );
228			}
229
230			// Make sure arguments that are passed-on to callbacks are strings.
231			if ( is_array( $args['js_callback'] ) && isset( $args['js_callback'][1] ) && is_array( $args['js_callback'][1] ) ) {
232			$args['js_callback'][1] = wp_json_encode( $args['js_callback'][1] );
233			}
234			return $args;
235
236			}
237
238			/**
239			* Returns script for value_pattern & replacements.
240			*
241			* @access private
242			* @since 3.0.0
243			* @param string $value The value placeholder.
244			* @param array $js_vars The js_vars argument.
245			* @return string The script.
246			*/
247			private function value_pattern_replacements( $value, $js_vars ) {
248			$script = '';
249			$alias = $value;
250			if ( isset( $js_vars['replacements'] ) ) {
251			$script .= 'settings=window.wp.customize.get();';
252			foreach ( $js_vars['replacements'] as $search => $replace ) {
253			$replace = '\'+settings["' . $replace . '"]+\'';
254			$value = str_replace( $search, $replace, $js_vars['value_pattern'] );
255			$value = trim( $value, '+' );
256			}
257			}
258			$value_compiled = str_replace( '$', '\'+' . $alias . '+\'', $value );
259			$value_compiled = trim( $value_compiled, '+' );
260			return $script . $alias . '=\''. $value_compiled . '\';';
261			}
262			}
263

aristath / kirki

Pull Request — develop (#1334)

Kirki_Modules_PostMessage::postmessage() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like