Kirki_Modules_PostMessage::__construct() - Code Metrics - Inspection of "fixes $1436" - aristath/kirki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 0e4d5d...d3e799 )

by Aristeides

created 2017-06-27 15:45 UTC

Kirki_Modules_PostMessage::__construct() A

↳ Parent: Kirki_Modules_PostMessage

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	3
rs	10
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 object instance.
	 *
	 * @static
	 * @access private
	 * @since 3.0.0
	 * @var object
	 */
	private static $instance;

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

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

	/**
	 * Gets an instance of this object.
	 * Prevents duplicate instances which avoid artefacts and improves performance.
	 *
	 * @static
	 * @access public
	 * @since 3.0.0
	 * @return object
	 */
	public static function get_instance() {
		if ( ! self::$instance ) {
			self::$instance = new self();
		}
		return self::$instance;
	}

	/**
	 * 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(null===document.getElementById(\'' . $style_id . '\')||\'undefined\'===typeof document.getElementById(\'' . $style_id . '\')){jQuery(\'head\').append(\'<style id="' . $style_id . '"></style>\');}';

		// Add anything we need before the main script.
		$script .= $this->before_script( $args );

		$field = array(
			'scripts' => array(),
		);
		// Loop through the js_vars and generate the script.
		foreach ( $args['js_vars'] as $key => $js_var ) {

			if ( isset( $js_var['element'] ) ) {
				// Array to string.
				if ( is_array( $js_var['element'] ) ) {
					$js_var['element'] = array_unique( $js_var['element'] );
					$js_var['element'] = implode( ',', $js_var['element'] );
				}
				// Replace single quotes with double quotes to avoid issues with the compiled JS.
				$js_var['element'] = str_replace( '\'', '"', $js_var['element'] );
			}
			if ( isset( $js_var['function'] ) && 'html' === $js_var['function'] ) {
				$script .= $this->script_html_var( $js_var );
				continue;
			}
			$js_var['index_key'] = $key;
			$callback = $this->get_callback( $args );
			if ( is_callable( $callback ) ) {
				$field['scripts'][ $key ] = call_user_func_array( $callback, array( $js_var, $args ) );
				continue;
			}
			$field['scripts'][ $key ] = $this->script_var( $js_var );
		}
		$combo_extra_script = '';
		$combo_css_script   = '';
		foreach ( $field['scripts'] as $script_array ) {
			$combo_extra_script .= $script_array['script'];
			$combo_css_script   .= ( 'css' !== $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 .= 'jQuery(\'#' . $style_id . '\').appendTo(\'head\');';
		$script .= '});});';
		return $script;
	}

	/**
	 * Generates script for a single js_var when using "html" as function.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param array $args  The arguments for this js_var.
	 */
	protected function script_html_var( $args ) {

		$script  = ( isset( $args['choice'] ) ) ? 'newval=newval[\'' . $args['choice'] . '\'];' : '';
		$script .= 'jQuery(\'' . $args['element'] . '\').html(newval);';
		if ( isset( $args['attr'] ) ) {
			$script = 'jQuery(\'' . $args['element'] . '\').attr(\'' . $args['attr'] . '\',newval);';
		}
		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'] ) && is_array( $args['js_callback'] ) && isset( $args['js_callback'][0] ) && ! 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'] && ( ! isset( $args['value_pattern'] ) || false === strpos( $args['value_pattern'], 'gradient' ) ) ) {
			$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;
		}
		$css = $args['element'] . '{' . $args['property'] . ':\'+' . $value . '+\'' . $args['units'] . $args['suffix'] . ';}';
		if ( isset( $args['media_query'] ) ) {
			$css = $args['media_query'] . '{' . $css . '}';
		}
		return array(
			'script' => $property_script . $script,
			'css'    => $css,
		);
	}

	/**
	 * 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 = ( 0 === $args['index_key'] ) ? 'css=\'\';' : '';
		$property_script = '';

		// Define choice.
		$choice  = ( isset( $args['choice'] ) && '' !== $args['choice'] ) ? $args['choice'] : '';

		$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'] ) && is_array( $args['js_callback'] ) && isset( $args['js_callback'][0] ) && ! 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.
		if ( '' === $choice || 'background-image' === $choice ) {
			$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';
		}

		// Mostly used for padding, margin & position properties.
		$direction_script  = 'if(_.contains([\'top\',\'bottom\',\'left\',\'right\'],subKey)){';
		$direction_script .= 'css+=\'' . $args['element'] . '{' . $args['property'] . '-\'+subKey+\':\'+subValue+\'' . $args['units'] . $args['suffix'] . ';}\';}';
		// Allows us to apply this just for a specific choice in the array of the values.
		if ( '' !== $choice ) {
			$choice_is_direction = ( false !== strpos( $choice, 'top' ) || false !== strpos( $choice, 'bottom' ) || false !== strpos( $choice, 'left' ) || false !== strpos( $choice, 'right' ) );
			$script .= 'if(\'' . $choice . '\'===subKey){';
			$script .= ( $choice_is_direction ) ? $direction_script . 'else{' : '';
			$script .= 'css+=\'' . $args['element'] . '{' . $args['property'] . ':\'+subValue+\';}\';';
			$script .= ( $choice_is_direction ) ? '}' : '';
			$script .= '}';
		} else {
			$script .= $direction_script . 'else{';

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

		if ( isset( $args['media_query'] ) ) {
			$script .= 'css=\'' . $args['media_query'] . '{\'+css+\'}\';';
		}

		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.
	 * @param array $field The field arguments.
	 */
	protected function script_var_typography( $args, $field ) {

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

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

		// Add the css.
		$css_build_array = array(
			'font-family'    => 'fontFamily',
			'font-size'      => 'fontSize',
			'line-height'    => 'lineHeight',
			'letter-spacing' => 'letterSpacing',
			'word-spacing'   => 'wordSpacing',
			'text-align'     => 'textAlign',
			'text-transform' => 'textTransform',
			'color'          => 'color',
			'font-weight'    => 'fontWeight',
			'font-style'     => 'fontStyle',
		);
		$choice_condition = ( isset( $args['choice'] ) && '' !== $args['choice'] && isset( $css_build_array[ $args['choice'] ] ) );
		$script .= ( ! $choice_condition ) ? $webfont_loader : '';
		foreach ( $css_build_array as $property => $var ) {
			if ( $choice_condition && $property !== $args['choice'] ) {
				continue;
			}
			// Fixes https://github.com/aristath/kirki/issues/1436.
			if ( ! isset( $field['default'] ) || (
				( 'font-family' === $property && ! isset( $field['default']['font-family'] ) ) ||
				( 'font-size' === $property && ! isset( $field['default']['font-size'] ) ) ||
				( 'line-height' === $property && ! isset( $field['default']['line-height'] ) ) ||
				( 'letter-spacing' === $property && ! isset( $field['default']['letter-spacing'] ) ) ||
				( 'word-spacing' === $property && ! isset( $field['default']['word-spacing'] ) ) ||
				( 'text-align' === $property && ! isset( $field['default']['text-align'] ) ) ||
				( 'text-transform' === $property && ! isset( $field['default']['text-transform'] ) ) ||
				( 'color' === $property && ! isset( $field['default']['color'] ) ) ||
				( 'font-weight' === $property && ( ! isset( $field['default']['variant'] ) || ! isset( $field['default']['font-weight'] ) ) ) ||
				( 'font-style' === $property && ( ! isset( $field['default']['variant'] ) || ! isset( $field['default']['font-style'] ) ) )
				) ) {
				continue;
			}
			$script .= ( $choice_condition && 'font-family' === $args['choice'] ) ? $webfont_loader : '';

			if ( 'font-family' === $property || ( isset( $args['choice'] ) && 'font-family' === $args['choice'] ) ) {
				$css .= 'fontFamilyCSS=fontFamily;if(0<fontFamily.indexOf(\' \')&&-1===fontFamily.indexOf(\'"\')){fontFamilyCSS=\'"\'+fontFamily+\'"\';}';
				$var = 'fontFamilyCSS';
			}
			$css .= 'css+=(\'\'!==' . $var . ')?\'' . $args['element'] . '\'+\'{' . $property . ':\'+' . $var . '+\';}\':\'\';';
		}

		$script .= $css;
		if ( isset( $args['media_query'] ) ) {
			$script .= 'css=\'' . $args['media_query'] . '{\'+css+\'}\';';
		}
		return array(
			'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_image( $args ) {
		$return = $this->script_var( $args );
		return array(
			'script' => 'newval=(!_.isUndefined(newval.url))?newval.url:newval;' . $return['script'],
			'css'    => $return['css'],
		);
	}

	/**
	 * Adds anything we need before the main script.
	 *
	 * @access private
	 * @since 3.0.0
	 * @param array $args The field args.
	 * @return string;

	 */
	private function before_script( $args ) {

		$script = '';

		if ( isset( $args['type'] ) ) {
			switch ( $args['type'] ) {
				case 'kirki-typography':
					$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 .= 'fw=(!_.isString(newval.variant))?\'400\':newval.variant.match(/\d/g);';
					$script .= 'fontWeight=(!_.isObject(fw))?400:fw.join(\'\');';
					$script .= 'fontStyle=(-1!==variant.indexOf(\'italic\'))?\'italic\':\'normal\';';
					$script .= 'css=\'\';';
					break;
			}
		}
		return $script;
	}

	/**
	 * 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['value_pattern'] ) ) {
			return $value;
		}
		$value = $js_vars['value_pattern'];
		if ( isset( $js_vars['pattern_replace'] ) ) {
			$script .= 'settings=window.wp.customize.get();';
			foreach ( $js_vars['pattern_replace'] 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':
			case 'kirki-multicolor':
			case 'kirki-sortable':
				$callback = array( $this, 'script_var_array' );
				break;
			case 'kirki-typography':
				$callback = array( $this, 'script_var_typography' );
				break;
			case 'kirki-image':
				$callback = array( $this, 'script_var_image' );
				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			* The object instance.
24			*
25			* @static
26			* @access private
27			* @since 3.0.0
28			* @var object
29			*/
30			private static $instance;
31
32			/**
33			* The script.
34			*
35			* @access protected
36			* @since 3.0.0
37			* @var string
38			*/
39			protected $script = '';
40
41			/**
42			* Constructor.
43			*
44			* @access protected
45			* @since 3.0.0
46			*/
47			protected function __construct() {
48			add_action( 'customize_preview_init', array( $this, 'postmessage' ) );
49			}
50
51			/**
52			* Gets an instance of this object.
53			* Prevents duplicate instances which avoid artefacts and improves performance.
54			*
55			* @static
56			* @access public
57			* @since 3.0.0
58			* @return object
59			*/
60			public static function get_instance() {
61			if ( ! self::$instance ) {
62			self::$instance = new self();
63			}
64			return self::$instance;
65			}
66
67			/**
68			* Enqueues the postMessage script
69			* and adds variables to it using the wp_localize_script function.
70			* The rest is handled via JS.
71			*/
72			public function postmessage() {
73
74			wp_enqueue_script( 'kirki_auto_postmessage', trailingslashit( Kirki::$url ) . 'modules/postmessage/postmessage.js', array( 'jquery', 'customize-preview' ), false, true );
75			$fields = Kirki::$fields;
76			foreach ( $fields as $field ) {
77			if ( isset( $field['transport'] ) && 'postMessage' === $field['transport'] && isset( $field['js_vars'] ) && ! empty( $field['js_vars'] ) && is_array( $field['js_vars'] ) && isset( $field['settings'] ) ) {
78			$this->script .= $this->script( $field );
79			}
80			}
81			$this->script = apply_filters( 'kirki/postmessage/script', $this->script );
82			wp_add_inline_script( 'kirki_auto_postmessage', $this->script, 'after' );
83
84			}
85
86			/**
87			* Generates script for a single field.
88			*
89			* @access protected
90			* @since 3.0.0
91			* @param array $args The arguments.
92			*/
93			protected function script( $args ) {
94
95			$script = 'wp.customize(\'' . $args['settings'] . '\',function(value){value.bind(function(newval){';
96			// append unique style tag if not exist
97			// The style ID.
98			$style_id = 'kirki-postmessage-' . str_replace( array( '[', ']' ), '', $args['settings'] );
99			$script .= 'if(null===document.getElementById(\'' . $style_id . '\')\|\|\'undefined\'===typeof document.getElementById(\'' . $style_id . '\')){jQuery(\'head\').append(\'<style id="' . $style_id . '"></style>\');}';
100
101			// Add anything we need before the main script.
102			$script .= $this->before_script( $args );
103
104			$field = array(
105			'scripts' => array(),
106			);
107			// Loop through the js_vars and generate the script.
108			foreach ( $args['js_vars'] as $key => $js_var ) {
109
110			if ( isset( $js_var['element'] ) ) {
111			// Array to string.
112			if ( is_array( $js_var['element'] ) ) {
113			$js_var['element'] = array_unique( $js_var['element'] );
114			$js_var['element'] = implode( ',', $js_var['element'] );
115			}
116			// Replace single quotes with double quotes to avoid issues with the compiled JS.
117			$js_var['element'] = str_replace( '\'', '"', $js_var['element'] );
118			}
119			if ( isset( $js_var['function'] ) && 'html' === $js_var['function'] ) {
120			$script .= $this->script_html_var( $js_var );
121			continue;
122			}
123			$js_var['index_key'] = $key;
124			$callback = $this->get_callback( $args );
125			if ( is_callable( $callback ) ) {
126			$field['scripts'][ $key ] = call_user_func_array( $callback, array( $js_var, $args ) );
127			continue;
128			}
129			$field['scripts'][ $key ] = $this->script_var( $js_var );
130			}
131			$combo_extra_script = '';
132			$combo_css_script = '';
133			foreach ( $field['scripts'] as $script_array ) {
134			$combo_extra_script .= $script_array['script'];
135			$combo_css_script .= ( 'css' !== $combo_css_script ) ? $script_array['css'] : '';
136			}
137			$text = ( 'css' === $combo_css_script ) ? 'css' : '\'' . $combo_css_script . '\'';
138			$script .= $combo_extra_script . 'jQuery(\'#' . $style_id . '\').text(' . $text . ');';
139			$script .= 'jQuery(\'#' . $style_id . '\').appendTo(\'head\');';
140			$script .= '});});';
141			return $script;
142			}
143
144			/**
145			* Generates script for a single js_var when using "html" as function.
146			*
147			* @access protected
148			* @since 3.0.0
149			* @param array $args The arguments for this js_var.
150			*/
151			protected function script_html_var( $args ) {
152
153			$script = ( isset( $args['choice'] ) ) ? 'newval=newval[\'' . $args['choice'] . '\'];' : '';
154			$script .= 'jQuery(\'' . $args['element'] . '\').html(newval);';
155			if ( isset( $args['attr'] ) ) {
156			$script = 'jQuery(\'' . $args['element'] . '\').attr(\'' . $args['attr'] . '\',newval);';
157			}
158			return $script;
159			}
160
161			/**
162			* Generates script for a single js_var.
163			*
164			* @access protected
165			* @since 3.0.0
166			* @param array $args The arguments for this js_var.
167			*/
168			protected function script_var( $args ) {
169			$script = '';
170			$property_script = '';
171
172			$value_key = 'newval' . $args['index_key'];
173			$property_script .= $value_key . '=newval;';
174
175			$args = $this->get_args( $args );
176
177			// Apply callback to the value if a callback is defined.
178			if ( ! empty( $args['js_callback'] ) && is_array( $args['js_callback'] ) && isset( $args['js_callback'][0] ) && ! empty( $args['js_callback'][0] ) ) {
179			$script .= $value_key . '=' . $args['js_callback'][0] . '(' . $value_key . ',' . $args['js_callback'][1] . ');';
180			}
181
182			// Apply the value_pattern.
183			if ( '' !== $args['value_pattern'] ) {
184			$script .= $this->value_pattern_replacements( $value_key, $args );
185			}
186
187			// Tweak to add url() for background-images.
188			if ( 'background-image' === $args['property'] && ( ! isset( $args['value_pattern'] ) \|\| false === strpos( $args['value_pattern'], 'gradient' ) ) ) {
189			$script .= 'if(-1===' . $value_key . '.indexOf(\'url(\')){' . $value_key . '=\'url("\'+' . $value_key . '+\'")\';}';
190			}
191
192			// Apply prefix.
193			$value = $value_key;
194			if ( '' !== $args['prefix'] ) {
195			$value = $args['prefix'] . '+' . $value_key;
196			}
197			$css = $args['element'] . '{' . $args['property'] . ':\'+' . $value . '+\'' . $args['units'] . $args['suffix'] . ';}';
198			if ( isset( $args['media_query'] ) ) {
199			$css = $args['media_query'] . '{' . $css . '}';
200			}
201			return array(
202			'script' => $property_script . $script,
203			'css' => $css,
204			);
205			}
206
207			/**
208			* Processes script generation for fields that save an array.
209			*
210			* @access protected
211			* @since 3.0.0
212			* @param array $args The arguments for this js_var.
213			*/
214			protected function script_var_array( $args ) {
215
216			$script = ( 0 === $args['index_key'] ) ? 'css=\'\';' : '';
217			$property_script = '';
218
219			// Define choice.
220			$choice = ( isset( $args['choice'] ) && '' !== $args['choice'] ) ? $args['choice'] : '';
221
222			$value_key = 'newval' . $args['index_key'];
223			$property_script .= $value_key . '=newval;';
224
225			$args = $this->get_args( $args );
226
227			// Apply callback to the value if a callback is defined.
228			if ( ! empty( $args['js_callback'] ) && is_array( $args['js_callback'] ) && isset( $args['js_callback'][0] ) && ! empty( $args['js_callback'][0] ) ) {
229			$script .= $value_key . '=' . $args['js_callback'][0] . '(' . $value_key . ',' . $args['js_callback'][1] . ');';
230			}
231			$script .= '_.each(' . $value_key . ', function(subValue,subKey){';
232
233			// Apply the value_pattern.
234			if ( '' !== $args['value_pattern'] ) {
235			$script .= $this->value_pattern_replacements( 'subValue', $args );
236			}
237
238			// Tweak to add url() for background-images.
239			if ( '' === $choice \|\| 'background-image' === $choice ) {
240			$script .= 'if(\'background-image\'===\'' . $args['property'] . '\'\|\|\'background-image\'===subKey){';
241			$script .= 'if(-1===subValue.indexOf(\'url(\')){subValue=\'url("\'+subValue+\'")\';}';
242			$script .= '}';
243			}
244
245			// Apply prefix.
246			$value = $value_key;
247			if ( '' !== $args['prefix'] ) {
248			$value = '\'' . $args['prefix'] . '\'+subValue';
249			}
250
251			// Mostly used for padding, margin & position properties.
252			$direction_script = 'if(_.contains([\'top\',\'bottom\',\'left\',\'right\'],subKey)){';
253			$direction_script .= 'css+=\'' . $args['element'] . '{' . $args['property'] . '-\'+subKey+\':\'+subValue+\'' . $args['units'] . $args['suffix'] . ';}\';}';
254			// Allows us to apply this just for a specific choice in the array of the values.
255			if ( '' !== $choice ) {
256			$choice_is_direction = ( false !== strpos( $choice, 'top' ) \|\| false !== strpos( $choice, 'bottom' ) \|\| false !== strpos( $choice, 'left' ) \|\| false !== strpos( $choice, 'right' ) );
257			$script .= 'if(\'' . $choice . '\'===subKey){';
258			$script .= ( $choice_is_direction ) ? $direction_script . 'else{' : '';
259			$script .= 'css+=\'' . $args['element'] . '{' . $args['property'] . ':\'+subValue+\';}\';';
260			$script .= ( $choice_is_direction ) ? '}' : '';
261			$script .= '}';
262			} else {
263			$script .= $direction_script . 'else{';
264
265			// This is where most object-based fields will go.
266			$script .= 'css+=\'' . $args['element'] . '{\'+subKey+\':\'+subValue+\'' . $args['units'] . $args['suffix'] . ';}\';';
267			$script .= '}';
268			}
269			$script .= '});';
270
271			if ( isset( $args['media_query'] ) ) {
272			$script .= 'css=\'' . $args['media_query'] . '{\'+css+\'}\';';
273			}
274
275			return array(
276			'script' => $property_script . $script,
277			'css' => 'css',
278			);
279			}
280
281			/**
282			* Processes script generation for typography fields.
283			*
284			* @access protected
285			* @since 3.0.0
286			* @param array $args The arguments for this js_var.
287			* @param array $field The field arguments.
288			*/
289			protected function script_var_typography( $args, $field ) {
290
291			$script = '';
292			$css = '';
293
294			// Load the font using WenFontloader.
295			// This is a bit ugly because wp_add_inline_script doesn't allow adding <script> directly.
296			$webfont_loader = 'sc=\'a\';jQuery(\'head\').append(sc.replace(\'a\',\'<\')+\'script>if(!_.isUndefined(WebFont)&&fontFamily){WebFont.load({google:{families:["\'+fontFamily.replace( /\"/g, \'"\' )+\':\'+variant+subsetsString+\'"]}});}\'+sc.replace(\'a\',\'<\')+\'/script>\');';
297
298			// Add the css.
299			$css_build_array = array(
300			'font-family' => 'fontFamily',
301			'font-size' => 'fontSize',
302			'line-height' => 'lineHeight',
303			'letter-spacing' => 'letterSpacing',
304			'word-spacing' => 'wordSpacing',
305			'text-align' => 'textAlign',
306			'text-transform' => 'textTransform',
307			'color' => 'color',
308			'font-weight' => 'fontWeight',
309			'font-style' => 'fontStyle',
310			);
311			$choice_condition = ( isset( $args['choice'] ) && '' !== $args['choice'] && isset( $css_build_array[ $args['choice'] ] ) );
312			$script .= ( ! $choice_condition ) ? $webfont_loader : '';
313			foreach ( $css_build_array as $property => $var ) {
314			if ( $choice_condition && $property !== $args['choice'] ) {
315			continue;
316			}
317			// Fixes https://github.com/aristath/kirki/issues/1436.
318			if ( ! isset( $field['default'] ) \|\| (
319			( 'font-family' === $property && ! isset( $field['default']['font-family'] ) ) \|\|
320			( 'font-size' === $property && ! isset( $field['default']['font-size'] ) ) \|\|
321			( 'line-height' === $property && ! isset( $field['default']['line-height'] ) ) \|\|
322			( 'letter-spacing' === $property && ! isset( $field['default']['letter-spacing'] ) ) \|\|
323			( 'word-spacing' === $property && ! isset( $field['default']['word-spacing'] ) ) \|\|
324			( 'text-align' === $property && ! isset( $field['default']['text-align'] ) ) \|\|
325			( 'text-transform' === $property && ! isset( $field['default']['text-transform'] ) ) \|\|
326			( 'color' === $property && ! isset( $field['default']['color'] ) ) \|\|
327			( 'font-weight' === $property && ( ! isset( $field['default']['variant'] ) \|\| ! isset( $field['default']['font-weight'] ) ) ) \|\|
328			( 'font-style' === $property && ( ! isset( $field['default']['variant'] ) \|\| ! isset( $field['default']['font-style'] ) ) )
329			) ) {
330			continue;
331			}
332			$script .= ( $choice_condition && 'font-family' === $args['choice'] ) ? $webfont_loader : '';
333
334			if ( 'font-family' === $property \|\| ( isset( $args['choice'] ) && 'font-family' === $args['choice'] ) ) {
335			$css .= 'fontFamilyCSS=fontFamily;if(0<fontFamily.indexOf(\' \')&&-1===fontFamily.indexOf(\'"\')){fontFamilyCSS=\'"\'+fontFamily+\'"\';}';
336			$var = 'fontFamilyCSS';
337			}
338			$css .= 'css+=(\'\'!==' . $var . ')?\'' . $args['element'] . '\'+\'{' . $property . ':\'+' . $var . '+\';}\':\'\';';
339			}
340
341			$script .= $css;
342			if ( isset( $args['media_query'] ) ) {
343			$script .= 'css=\'' . $args['media_query'] . '{\'+css+\'}\';';
344			}
345			return array(
346			'script' => $script,
347			'css' => 'css',
348			);
349			}
350
351			/**
352			* Processes script generation for typography fields.
353			*
354			* @access protected
355			* @since 3.0.0
356			* @param array $args The arguments for this js_var.
357			*/
358			protected function script_var_image( $args ) {
359			$return = $this->script_var( $args );
360			return array(
361			'script' => 'newval=(!_.isUndefined(newval.url))?newval.url:newval;' . $return['script'],
362			'css' => $return['css'],
363			);
364			}
365
366			/**
367			* Adds anything we need before the main script.
368			*
369			* @access private
370			* @since 3.0.0
371			* @param array $args The field args.
372			* @return string;
			0 ignored issues – show Documentation introduced 2017-05-27 11:35 UTC by Report Bug Copy Issue Report The doc-type `string;` could not be parsed: Expected "\|" or "end of type", but got ";" at position 6. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
373			*/
374			private function before_script( $args ) {
375
376			$script = '';
377
378			if ( isset( $args['type'] ) ) {
379			switch ( $args['type'] ) {
380			case 'kirki-typography':
381			$script .= 'fontFamily=(_.isUndefined(newval[\'font-family\']))?\'\':newval[\'font-family\'];';
382			$script .= 'variant=(_.isUndefined(newval.variant))?\'400\':newval.variant;';
383			$script .= 'subsets=(_.isUndefined(newval.subsets))?[]:newval.subsets;';
384			$script .= 'subsetsString=(_.isObject(newval.subsets))?\':\'+newval.subsets.join(\',\'):\'\';';
385			$script .= 'fontSize=(_.isUndefined(newval[\'font-size\']))?\'\':newval[\'font-size\'];';
386			$script .= 'lineHeight=(_.isUndefined(newval[\'line-height\']))?\'\':newval[\'line-height\'];';
387			$script .= 'letterSpacing=(_.isUndefined(newval[\'letter-spacing\']))?\'\':newval[\'letter-spacing\'];';
388			$script .= 'wordSpacing=(_.isUndefined(newval[\'word-spacing\']))?\'\':newval[\'word-spacing\'];';
389			$script .= 'textAlign=(_.isUndefined(newval[\'text-align\']))?\'\':newval[\'text-align\'];';
390			$script .= 'textTransform=(_.isUndefined(newval[\'text-transform\']))?\'\':newval[\'text-transform\'];';
391			$script .= 'color=(_.isUndefined(newval.color))?\'\':newval.color;';
392
393			$script .= 'fw=(!_.isString(newval.variant))?\'400\':newval.variant.match(/\d/g);';
394			$script .= 'fontWeight=(!_.isObject(fw))?400:fw.join(\'\');';
395			$script .= 'fontStyle=(-1!==variant.indexOf(\'italic\'))?\'italic\':\'normal\';';
396			$script .= 'css=\'\';';
397			break;
398			}
399			}
400			return $script;
401			}
402
403			/**
404			* Sanitizes the arguments and makes sure they are all there.
405			*
406			* @access private
407			* @since 3.0.0
408			* @param array $args The arguments.
409			* @return array
410			*/
411			private function get_args( $args ) {
412
413			// Make sure everything is defined to avoid "undefined index" errors.
414			$args = wp_parse_args( $args, array(
415			'element' => '',
416			'property' => '',
417			'prefix' => '',
418			'suffix' => '',
419			'units' => '',
420			'js_callback' => array( '', '' ),
421			'value_pattern' => '',
422			));
423
424			// Element should be a string.
425			if ( is_array( $args['element'] ) ) {
426			$args['element'] = implode( ',', $args['element'] );
427			}
428
429			// Make sure arguments that are passed-on to callbacks are strings.
430			if ( is_array( $args['js_callback'] ) && isset( $args['js_callback'][1] ) && is_array( $args['js_callback'][1] ) ) {
431			$args['js_callback'][1] = wp_json_encode( $args['js_callback'][1] );
432			}
433			return $args;
434
435			}
436
437			/**
438			* Returns script for value_pattern & replacements.
439			*
440			* @access private
441			* @since 3.0.0
442			* @param string $value The value placeholder.
443			* @param array $js_vars The js_vars argument.
444			* @return string The script.
445			*/
446			private function value_pattern_replacements( $value, $js_vars ) {
447			$script = '';
448			$alias = $value;
449			if ( ! isset( $js_vars['value_pattern'] ) ) {
450			return $value;
451			}
452			$value = $js_vars['value_pattern'];
453			if ( isset( $js_vars['pattern_replace'] ) ) {
454			$script .= 'settings=window.wp.customize.get();';
455			foreach ( $js_vars['pattern_replace'] as $search => $replace ) {
456			$replace = '\'+settings["' . $replace . '"]+\'';
457			$value = str_replace( $search, $replace, $js_vars['value_pattern'] );
458			$value = trim( $value, '+' );
459			}
460			}
461			$value_compiled = str_replace( '$', '\'+' . $alias . '+\'', $value );
462			$value_compiled = trim( $value_compiled, '+' );
463
464			return $script . $alias . '=\'' . $value_compiled . '\';';
465			}
466
467			/**
468			* Get the callback function/method we're going to use for this field.
469			*
470			* @access private
471			* @since 3.0.0
472			* @param array $args The field args.
473			* @return string\|array A callable function or method.
474			*/
475			protected function get_callback( $args ) {
476
477			switch ( $args['type'] ) {
478			case 'kirki-background':
479			case 'kirki-dimensions':
480			case 'kirki-multicolor':
481			case 'kirki-sortable':
482			$callback = array( $this, 'script_var_array' );
483			break;
484			case 'kirki-typography':
485			$callback = array( $this, 'script_var_typography' );
486			break;
487			case 'kirki-image':
488			$callback = array( $this, 'script_var_image' );
489			break;
490			default:
491			$callback = array( $this, 'script_var' );
492			}
493			return $callback;
494			}
495			}
496

aristath / kirki

Push — develop ( 0e4d5d...d3e799 )

Kirki_Modules_PostMessage::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like