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-27 10:50 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 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'] );
			$callback = $this->get_callback( $args );
			if ( is_callable( $callback ) ) {
				$field['scripts'][ $key ] = call_user_func_array( $callback, 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'];
		}
		$text = ( 'css' === $combo_css_script ) ? 'css' : '\'' . $combo_css_script . '\'';
		$script .= $combo_extra_script . 'jQuery(\'#' . $style_id . '\').text(' . $text . ');';
		$script .= '});});';
		return $script;
	}

	/**
	 * Generates script for a single js_var.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param array $args  The arguments for this js_var.
	 */
	protected function script_var( $args ) {
		$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 );
		}

		// Tweak to add url() for background-images.
		if ( 'background-image' === $args['property'] ) {
			$script .= 'if(-1===' . $value_key . '.indexOf(\'url(\')){' . $value_key . '=\'url("\'+' . $value_key . '+\'");}';
		}

		// Apply prefix.
		$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'] . ';}',
		);
	}

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

		$script = 'css=\'\';';
		$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] . ');';
		}
		$script .= '_.each(' . $value_key . ', function(subValue,subKey){';

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

		// Tweak to add url() for background-images.
		$script .= 'if(\'background-image\'===\'' . $args['property'] . '\'||\'background-image\'===subKey){';
		$script .= 'if(-1===subValue.indexOf(\'url(\')){subValue=\'url("\'+subValue+\'")\';}';
		$script .= '}';

		// Apply prefix.
		$value = $value_key;
		if ( '' !== $args['prefix'] ) {
			$value = '\'' . $args['prefix'] . '\'+subValue';
		}

		// Allows us to apply this just for a specific choice in the array of the values.
		$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',
		);
	}

	/**
	 * Processes script generation for typography fields.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param array $args  The arguments for this js_var.
	 */
	protected function script_var_typography( $args ) {

		$args['choice'] = ( ! isset( $args['choice'] ) ) ? '' : $args['choice'];

		$script = '';
		$css    = '';

		// Make sure variants and subsets are defined.
		$script .= 'fontFamily=(_.isUndefined(newval[\'font-family\']))?\'\':newval[\'font-family\'];';
		$script .= 'variant=(_.isUndefined(newval.variant))?400:newval.variant;';
		$script .= 'subsets=(_.isUndefined(newval.subsets))?[]:newval.subsets;';
		$script .= 'subsetsString=(_.isObject(newval.subsets))?\':\'+newval.subsets.join(\',\'):\'\';';
		$script .= 'fontSize=(_.isUndefined(newval[\'font-size\']))?\'\':newval[\'font-size\'];';
		$script .= 'lineHeight=(_.isUndefined(newval[\'line-height\']))?\'\':newval[\'line-height\'];';
		$script .= 'letterSpacing=(_.isUndefined(newval[\'letter-spacing\']))?\'\':newval[\'letter-spacing\'];';
		$script .= 'wordSpacing=(_.isUndefined(newval[\'word-spacing\']))?\'\':newval[\'word-spacing\'];';
		$script .= 'textAlign=(_.isUndefined(newval[\'text-align\']))?\'\':newval[\'text-align\'];';
		$script .= 'textTransform=(_.isUndefined(newval[\'text-transform\']))?\'\':newval[\'text-transform\'];';
		$script .= 'color=(_.isUndefined(newval.color))?\'\':newval.color;';
		$script .= 'fontWeight=(!_.isObject(variant.match(/\d/g)))?400:variant.match(/\d/g).join(\'\');';
		$script .= 'fontStyle=(-1!==newval.variant.indexOf(\'italic\'))?\'italic\':\'normal\';';

		// Load the font using WenFontloader.
		// This is a bit ugly because wp_add_inline_script doesn't allow adding <script> directly.
		$script .= 'sc=\'a\';jQuery(\'head\').append(sc.replace(\'a\',\'<\')+\'script>if(!_.isUndefined(WebFont)){WebFont.load({google:{families:["\'+fontFamily+\':\'+variant+subsetsString+\'"]}});}\'+sc.replace(\'a\',\'<\')+\'/script>\');';

		// Add the css.
		$script .= 'element=\'' . $args['element'] . '\';';
		$css .= 'choice=\'' . $args['choice'] . '\';';
		$css .= 'css=\'\';';
		$css .= 'if(\'\'!==choice&&\'font-family\'===choice){css+=(\'\'!==fontFamily)?element+\'{font-family:\'+fontFamily+\'}\':\'\';}';
		$css .= 'if(\'\'!==choice&&\'font-size\'===choice){css+=(\'\'!==fontSize)?element+\'{font-size:\'+fontSize+\'}\':\'\';}';
		$css .= 'if(\'\'!==choice&&\'line-height\'===choice){css+=(\'\'!==lineHeight)?element+\'{line-height:\'+lineHeight+\'}\':\'\';}';
		$css .= 'if(\'\'!==choice&&\'letter-spacing\'===choice){css+=(\'\'!==letterSpacing)?element+\'{letter-spacing:\'+letterSpacing+\'}\':\'\';}';
		$css .= 'if(\'\'!==choice&&\'word-spacing\'===choice){css+=(\'\'!==wordSpacing)?element+\'{word-spacing:\'+wordSpacing+\'}\':\'\';}';
		$css .= 'if(\'\'!==choice&&\'text-align\'===choice){css+=(\'\'!==textAlign)?element+\'{text-align:\'+textAlign+\'}\':\'\';}';
		$css .= 'if(\'\'!==choice&&\'text-transform\'===choice){css+=(\'\'!==textTransform)?element+\'{text-transform:\'+textTransform+\'}\':\'\';}';
		$css .= 'if(\'\'!==choice&&\'color\'===choice){css+=(\'\'!==color)?element+\'{color:\'+color+\'}\':\'\';}';
		$css .= 'if(\'\'!==choice&&\'font-weight\'===choice){css+=(\'\'!==fontWeight)?element+\'{font-weight:\'+fontWeight+\'}\':\'\';}';
		$css .= 'if(\'\'!==choice&&\'font-style\'===choice){css+=(\'\'!==fontStyle)?element+\'{font-style:\'+fontStyle+\'}\':\'\';}';

		$from_script_var_array = $this->script_var_array( $args );
		$script .= $css;
		return array(
			'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 . '\';';
	}

	/**
	 * Get the callback function/method we're going to use for this field.
	 *
	 * @access private
	 * @since 3.0.0
	 * @param array $args The field args.
	 * @return string|array A callable function or method.
	 */
	protected function get_callback( $args ) {

		switch ( $args['type'] ) {
			case 'kirki-background':
			case 'kirki-dimensions':
				$callback = array( $this, 'script_var_array' );
				break;
			case 'kirki-typography':
				$callback = array( $this, 'script_var_typography' );
				break;
			default:
				$callback = array( $this, 'script_var' );
		}
		return $callback;
	}
}


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 field.
63			*
64			* @access protected
65			* @since 3.0.0
66			* @param array $args The arguments.
67			*/
68			protected function script( $args ) {
69
70			$script = 'wp.customize(\'' . $args['settings'] . '\',function(value){value.bind(function(newval){';
71			// append unique style tag if not exist
72			// The style ID.
73			$style_id = 'kirki-postmessage-' . str_replace( array( '[', ']' ), '', $args['settings'] );
74			$script .= 'if(!jQuery(\'' . $style_id . '\').size()){jQuery(\'head\').append(\'<style id="' . $style_id . '"></style>\');}';
75
76			// Loop through the js_vars and generate the script.
77			foreach ( $args['js_vars'] as $key => $js_var ) {
78			$js_var['index_key'] = $key;
79			$func_name = 'script_var_' . str_replace( array( 'kirki-', '-' ), array( '', '_' ), $args['type'] );
80			$callback = $this->get_callback( $args );
81			if ( is_callable( $callback ) ) {
82			$field['scripts'][ $key ] = call_user_func_array( $callback, array( $js_var, $args ) );
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-05-27 08:47 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...
83			continue;
84			}
85			$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... Unused Code introduced 2017-05-26 16:54 UTC by Report Bug Copy Issue Report The call to `Kirki_Modules_PostMessage::script_var()` has too many arguments starting with `$args`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
86			}
87			$combo_extra_script = '';
88			$combo_css_script = '';
89			foreach ( $field['scripts'] as $script_array ) {
90			$combo_extra_script .= $script_array['script'];
91			$combo_css_script .= $script_array['css'];
92			}
93			$text = ( 'css' === $combo_css_script ) ? 'css' : '\'' . $combo_css_script . '\'';
94			$script .= $combo_extra_script . 'jQuery(\'#' . $style_id . '\').text(' . $text . ');';
95			$script .= '});});';
96			return $script;
97			}
98
99			/**
100			* Generates script for a single js_var.
101			*
102			* @access protected
103			* @since 3.0.0
104			* @param array $args The arguments for this js_var.
105			*/
106			protected function script_var( $args ) {
107			$script = '';
108			$property_script = '';
109
110			$value_key = 'newval' . $args['index_key'];
111			$property_script .= $value_key . '=newval;';
112
113			$args = $this->get_args( $args );
114
115			// Apply callback to the value if a callback is defined.
116			if ( ! empty( $args['js_callback'][0] ) ) {
117			$script .= $value_key . '=' . $args['js_callback'][0] . '(' . $value_key . ',' . $args['js_callback'][1] . ');';
118			}
119
120			// Apply the value_pattern.
121			if ( '' !== $args['value_pattern'] ) {
122			$script .= $this->value_pattern_replacements( $value_key, $args );
123			}
124
125			// Tweak to add url() for background-images.
126			if ( 'background-image' === $args['property'] ) {
127			$script .= 'if(-1===' . $value_key . '.indexOf(\'url(\')){' . $value_key . '=\'url("\'+' . $value_key . '+\'");}';
128			}
129
130			// Apply prefix.
131			$value = $value_key;
132			if ( '' !== $args['prefix'] ) {
133			$value = $args['prefix'] . '+' . $value_key;
134			}
135
136			return array(
137			'script' => $property_script . $script,
138			'css' => $args['element'] . '{' . $args['property'] . ':\'+' . $value . '+\'' . $args['units'] . $args['suffix'] . ';}',
139			);
140			}
141
142			/**
143			* Processes script generation for fields that save an array.
144			*
145			* @access protected
146			* @since 3.0.0
147			* @param array $args The arguments for this js_var.
148			*/
149			protected function script_var_array( $args ) {
150
151			$script = 'css=\'\';';
152			$property_script = '';
153
154			$value_key = 'newval' . $args['index_key'];
155			$property_script .= $value_key . '=newval;';
156
157			$args = $this->get_args( $args );
158
159			// Apply callback to the value if a callback is defined.
160			if ( ! empty( $args['js_callback'][0] ) ) {
161			$script .= $value_key . '=' . $args['js_callback'][0] . '(' . $value_key . ',' . $args['js_callback'][1] . ');';
162			}
163			$script .= '_.each(' . $value_key . ', function(subValue,subKey){';
164
165			// Apply the value_pattern.
166			if ( '' !== $args['value_pattern'] ) {
167			$script .= $this->value_pattern_replacements( 'subValue', $args );
168			}
169
170			// Tweak to add url() for background-images.
171			$script .= 'if(\'background-image\'===\'' . $args['property'] . '\'\|\|\'background-image\'===subKey){';
172			$script .= 'if(-1===subValue.indexOf(\'url(\')){subValue=\'url("\'+subValue+\'")\';}';
173			$script .= '}';
174
175			// Apply prefix.
176			$value = $value_key;
177			if ( '' !== $args['prefix'] ) {
178			$value = '\'' . $args['prefix'] . '\'+subValue';
179			}
180
181			// Allows us to apply this just for a specific choice in the array of the values.
182			$script .= 'if(!_.isUndefined(' . $value_key . '.choice)){if(' . $value_key . '.choice===subKey){';
183			$script .= 'css+=\'' . $args['element'] . '{' . $args['property'] . ':\'+subValue+\';}\';';
184			$script .= '}}else{';
185
186			// Mostly used for padding, margin & position properties.
187			$script .= 'if(_.contains([\'top\',\'bottom\',\'left\',\'right\'],subKey)){';
188			$script .= 'css+=\'' . $args['element'] . '{' . $args['property'] . '-\'+subKey+\':\'+subValue+\'' . $args['units'] . $args['suffix'] . ';}\';';
189			$script .= '}else{';
190
191			// This is where most object-based fields will go.
192			$script .= 'css+=\'' . $args['element'] . '{\'+subKey+\':\'+subValue+\'' . $args['units'] . $args['suffix'] . ';}\';';
193			$script .= '}}';
194			$script .= '});';
195
196			return array(
197			'script' => $property_script . $script,
198			'css' => 'css',
199			);
200			}
201
202			/**
203			* Processes script generation for typography fields.
204			*
205			* @access protected
206			* @since 3.0.0
207			* @param array $args The arguments for this js_var.
208			*/
209			protected function script_var_typography( $args ) {
210
211			$args['choice'] = ( ! isset( $args['choice'] ) ) ? '' : $args['choice'];
212
213			$script = '';
214			$css = '';
215
216			// Make sure variants and subsets are defined.
217			$script .= 'fontFamily=(_.isUndefined(newval[\'font-family\']))?\'\':newval[\'font-family\'];';
218			$script .= 'variant=(_.isUndefined(newval.variant))?400:newval.variant;';
219			$script .= 'subsets=(_.isUndefined(newval.subsets))?[]:newval.subsets;';
220			$script .= 'subsetsString=(_.isObject(newval.subsets))?\':\'+newval.subsets.join(\',\'):\'\';';
221			$script .= 'fontSize=(_.isUndefined(newval[\'font-size\']))?\'\':newval[\'font-size\'];';
222			$script .= 'lineHeight=(_.isUndefined(newval[\'line-height\']))?\'\':newval[\'line-height\'];';
223			$script .= 'letterSpacing=(_.isUndefined(newval[\'letter-spacing\']))?\'\':newval[\'letter-spacing\'];';
224			$script .= 'wordSpacing=(_.isUndefined(newval[\'word-spacing\']))?\'\':newval[\'word-spacing\'];';
225			$script .= 'textAlign=(_.isUndefined(newval[\'text-align\']))?\'\':newval[\'text-align\'];';
226			$script .= 'textTransform=(_.isUndefined(newval[\'text-transform\']))?\'\':newval[\'text-transform\'];';
227			$script .= 'color=(_.isUndefined(newval.color))?\'\':newval.color;';
228			$script .= 'fontWeight=(!_.isObject(variant.match(/\d/g)))?400:variant.match(/\d/g).join(\'\');';
229			$script .= 'fontStyle=(-1!==newval.variant.indexOf(\'italic\'))?\'italic\':\'normal\';';
230
231			// Load the font using WenFontloader.
232			// This is a bit ugly because wp_add_inline_script doesn't allow adding <script> directly.
233			$script .= 'sc=\'a\';jQuery(\'head\').append(sc.replace(\'a\',\'<\')+\'script>if(!_.isUndefined(WebFont)){WebFont.load({google:{families:["\'+fontFamily+\':\'+variant+subsetsString+\'"]}});}\'+sc.replace(\'a\',\'<\')+\'/script>\');';
234
235			// Add the css.
236			$script .= 'element=\'' . $args['element'] . '\';';
237			$css .= 'choice=\'' . $args['choice'] . '\';';
238			$css .= 'css=\'\';';
239			$css .= 'if(\'\'!==choice&&\'font-family\'===choice){css+=(\'\'!==fontFamily)?element+\'{font-family:\'+fontFamily+\'}\':\'\';}';
240			$css .= 'if(\'\'!==choice&&\'font-size\'===choice){css+=(\'\'!==fontSize)?element+\'{font-size:\'+fontSize+\'}\':\'\';}';
241			$css .= 'if(\'\'!==choice&&\'line-height\'===choice){css+=(\'\'!==lineHeight)?element+\'{line-height:\'+lineHeight+\'}\':\'\';}';
242			$css .= 'if(\'\'!==choice&&\'letter-spacing\'===choice){css+=(\'\'!==letterSpacing)?element+\'{letter-spacing:\'+letterSpacing+\'}\':\'\';}';
243			$css .= 'if(\'\'!==choice&&\'word-spacing\'===choice){css+=(\'\'!==wordSpacing)?element+\'{word-spacing:\'+wordSpacing+\'}\':\'\';}';
244			$css .= 'if(\'\'!==choice&&\'text-align\'===choice){css+=(\'\'!==textAlign)?element+\'{text-align:\'+textAlign+\'}\':\'\';}';
245			$css .= 'if(\'\'!==choice&&\'text-transform\'===choice){css+=(\'\'!==textTransform)?element+\'{text-transform:\'+textTransform+\'}\':\'\';}';
246			$css .= 'if(\'\'!==choice&&\'color\'===choice){css+=(\'\'!==color)?element+\'{color:\'+color+\'}\':\'\';}';
247			$css .= 'if(\'\'!==choice&&\'font-weight\'===choice){css+=(\'\'!==fontWeight)?element+\'{font-weight:\'+fontWeight+\'}\':\'\';}';
248			$css .= 'if(\'\'!==choice&&\'font-style\'===choice){css+=(\'\'!==fontStyle)?element+\'{font-style:\'+fontStyle+\'}\':\'\';}';
249
250			$from_script_var_array = $this->script_var_array( $args );
251			$script .= $css;
252			return array(
253			'script' => $script,
254			'css' => 'css',
255			);
256			}
257
258			/**
259			* Sanitizes the arguments and makes sure they are all there.
260			*
261			* @access private
262			* @since 3.0.0
263			* @param array $args The arguments.
264			* @return array
265			*/
266			private function get_args( $args ) {
267
268			// Make sure everything is defined to avoid "undefined index" errors.
269			$args = wp_parse_args( $args, array(
270			'element' => '',
271			'property' => '',
272			'prefix' => '',
273			'suffix' => '',
274			'units' => '',
275			'js_callback' => array( '', '' ),
276			'value_pattern' => '',
277			));
278
279			// Element should be a string.
280			if ( is_array( $args['element'] ) ) {
281			$args['element'] = implode( ',', $args['element'] );
282			}
283
284			// Make sure arguments that are passed-on to callbacks are strings.
285			if ( is_array( $args['js_callback'] ) && isset( $args['js_callback'][1] ) && is_array( $args['js_callback'][1] ) ) {
286			$args['js_callback'][1] = wp_json_encode( $args['js_callback'][1] );
287			}
288			return $args;
289
290			}
291
292			/**
293			* Returns script for value_pattern & replacements.
294			*
295			* @access private
296			* @since 3.0.0
297			* @param string $value The value placeholder.
298			* @param array $js_vars The js_vars argument.
299			* @return string The script.
300			*/
301			private function value_pattern_replacements( $value, $js_vars ) {
302			$script = '';
303			$alias = $value;
304			if ( isset( $js_vars['replacements'] ) ) {
305			$script .= 'settings=window.wp.customize.get();';
306			foreach ( $js_vars['replacements'] as $search => $replace ) {
307			$replace = '\'+settings["' . $replace . '"]+\'';
308			$value = str_replace( $search, $replace, $js_vars['value_pattern'] );
309			$value = trim( $value, '+' );
310			}
311			}
312			$value_compiled = str_replace( '$', '\'+' . $alias . '+\'', $value );
313			$value_compiled = trim( $value_compiled, '+' );
314			return $script . $alias . '=\'' . $value_compiled . '\';';
315			}
316
317			/**
318			* Get the callback function/method we're going to use for this field.
319			*
320			* @access private
321			* @since 3.0.0
322			* @param array $args The field args.
323			* @return string\|array A callable function or method.
324			*/
325			protected function get_callback( $args ) {
326
327			switch ( $args['type'] ) {
328			case 'kirki-background':
329			case 'kirki-dimensions':
330			$callback = array( $this, 'script_var_array' );
331			break;
332			case 'kirki-typography':
333			$callback = array( $this, 'script_var_typography' );
334			break;
335			default:
336			$callback = array( $this, 'script_var' );
337			}
338			return $callback;
339			}
340			}
341

aristath / kirki

Pull Request — develop (#1334)

Kirki_Modules_PostMessage::postmessage() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like