Kirki_Modules_PostMessage::script() - 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-25 17:26 UTC

Kirki_Modules_PostMessage::script() B

↳ Parent: Kirki_Modules_PostMessage

Complexity

Conditions	5
Paths	8

Size

Total Lines	29
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	18
nc	8
nop	1
dl	0
loc	29
rs	8.439
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 );
		$js_vars_fields = array();
		$fields = Kirki::$fields;
		foreach ( $fields as $id => $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 );
			}
		}
		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.
	 */
	protected function _script( $args ) {
		$script = '';
		$property_script = '';

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

		// 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'] ) ) {
			if ( isset( $args['js_callback'][1] ) && is_array( $args['js_callback'][1] ) ) {
				$args['js_callback'][1] = json_encode( $args['js_callback'][1] );
			}
		}

		// 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'] ) {
			$value_pattern = str_replace( '$', '\'+' . $value_key . '+\'', $value_key );
			$script .= $value_key . '=' . trim( $value_pattern, '\'+' ) . ';';
		}

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

		return $scripts_array;
	}

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

		$field_scripts = array();

		$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;
				$field['scripts'][ $key ] = $this->_script( $js_var );
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
			}
			$combo_extra_script = '';
			$combo_css_script   = '';
			foreach ( $field['scripts'] as $script_l1 ) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

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


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 ='';
			0 ignored issues – show introduced 2017-05-25 17:28 UTC by Report Bug Copy Issue Report Expected 1 space after "="; 0 found Loading history...
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			$js_vars_fields = array();
51			$fields = Kirki::$fields;
52			foreach ( $fields as $id => $field ) {
53			if ( isset( $field['transport'] ) && 'postMessage' === $field['transport'] && isset( $field['js_vars'] ) && ! empty( $field['js_vars'] ) && is_array( $field['js_vars'] ) && isset( $field['settings'] ) ) {
54			$this->script .= $this->script( $field );
55			}
56			}
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.
67			*/
68			protected function _script( $args ) {
69			$script = '';
70			$property_script = '';
71
72			$value_key = 'newval' . $args['index_key'];
73			$property_script .= $value_key . '=newval;';
74
75			// Make sure everything is defined to avoid "undefined index" errors.
76			$args = wp_parse_args( $args, array(
77			'element' => '',
78			'property' => '',
79			'prefix' => '',
80			'suffix' => '',
81			'units' => '',
82			'js_callback' => array( '', '' ),
83			'value_pattern' => '',
84			));
85
86			// Element should be a string.
87			if ( is_array( $args['element'] ) ) {
88			$args['element'] = implode( ',', $args['element'] );
89			}
90
91			// Make sure arguments that are passed-on to callbacks are strings.
92			if ( is_array( $args['js_callback'] ) ) {
93			if ( isset( $args['js_callback'][1] ) && is_array( $args['js_callback'][1] ) ) {
94			$args['js_callback'][1] = json_encode( $args['js_callback'][1] );
95			}
96			}
97
98			// Apply callback to the value if a callback is defined.
99			if ( ! empty( $args['js_callback'][0] ) ) {
100			$script .= $value_key . '=' . $args['js_callback'][0] . '(' . $value_key . ',' . $args['js_callback'][1] . ');';
101			}
102
103			// Apply the value_pattern.
104			if ( '' !== $args['value_pattern'] ) {
105			$value_pattern = str_replace( '$', '\'+' . $value_key . '+\'', $value_key );
106			$script .= $value_key . '=' . trim( $value_pattern, '\'+' ) . ';';
107			}
108
109			// Apply prefix, units, suffix.
110			$value = $value_key;
111			if ( '' !== $args['prefix'] ) {
112			$value = $args['prefix'] . '+' . $value_key;
113			}
114			if ( '' !== $args['units'] \|\| '' !== $args['suffix'] ) {
115			$value .= '+' . $args['units'] . $args['suffix'];
116			}
117			$scripts_array = array();
118			$scripts_array[ sanitize_key( $args['element'] ) ][ sanitize_key( $args['property'] ) ]['script'] = $property_script . $script;
119			$scripts_array[ sanitize_key( $args['element'] ) ][ sanitize_key( $args['property'] ) ]['css'] = $args['element'] . '{' . $args['property'] . ':\'+' . $value_key . '+\';}';
120
121			return $scripts_array;
122			}
123
124			/**
125			* Generates script for a single field.
126			*
127			* @access protected
128			* @since 3.0.0
129			* @param array $args The arguments.
130			*/
131			protected function script( $args ) {
132
133			$field_scripts = array();
134
135			$script = 'wp.customize(\'' . $args['settings'] . '\',function(value){value.bind(function(newval){';
136			// append unique style tag if not exist
137			// The style ID.
138			$style_id = 'kirki-postmessage-' . str_replace( array( '[', ']' ), '', $args['settings'] );
139			$script .= 'if(!jQuery(\'' . $style_id . '\').size()){jQuery(\'head\').append(\'<style id="' . $style_id . '"></style>\');}';
140
141			// Loop through the js_vars and generate the script.
142			foreach ( $args['js_vars'] as $key => $js_var ) {
143			$js_var['index_key'] = $key;
144			$field['scripts'][ $key ] = $this->_script( $js_var );
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-05-25 17:28 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...
145			}
146			$combo_extra_script = '';
147			$combo_css_script = '';
148			foreach ( $field['scripts'] as $script_l1 ) {
			0 ignored issues – show Bug introduced 2017-05-25 17:28 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...
149			foreach ( $script_l1 as $script_l2 ) {
150			foreach ( $script_l2 as $script_array ) {
151			$combo_extra_script .= $script_array['script'];
152			$combo_css_script .= $script_array['css'];
153			}
154			}
155			}
156			$script .= $combo_extra_script . 'jQuery(\'#' . $style_id . '\').text(\'' . $combo_css_script . '\');';
157			$script .= '});});';
158			return $script;
159			}
160			}
161

aristath / kirki

Pull Request — develop (#1334)

Kirki_Modules_PostMessage::script() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like