Kirki_Output::apply_value_pattern() - Code Metrics - Inspection of "another code improvement" - aristath/kirki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 772847...bba6ff )

by Aristeides

created 2017-07-22 01:59 UTC

Kirki_Output::apply_value_pattern() D

↳ Parent: Kirki_Output

Complexity

Conditions	29
Paths	413

Size

Total Lines	70
Code Lines	49

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	29
eloc	49
nc	413
nop	2
dl	0
loc	70
rs	4.1236
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * Handles CSS output for fields.
 *
 * @package     Kirki
 * @subpackage  Controls
 * @copyright   Copyright (c) 2017, Aristeides Stathopoulos
 * @license     http://opensource.org/licenses/https://opensource.org/licenses/MIT
 * @since       2.2.0
 */

/**
 * Handles field CSS output.
 */
class Kirki_Output {

	/**
	 * The Kirki configuration used in the field.
	 *
	 * @access protected
	 * @var string
	 */
	protected $config_id = 'global';

	/**
	 * The field's `output` argument.
	 *
	 * @access protected
	 * @var array
	 */
	protected $output = array();

	/**
	 * An array of the generated styles.
	 *
	 * @access protected
	 * @var array
	 */
	protected $styles = array();

	/**
	 * The value.
	 *
	 * @access protected
	 * @var string|array
	 */
	protected $value;

	/**
	 * The class constructor.
	 *
	 * @access public
	 * @param string       $config_id The config ID.
	 * @param array        $output    The output argument.
	 * @param string|array $value     The value.
	 */
	public function __construct( $config_id, $output, $value ) {

		$this->config_id = $config_id;
		$this->value     = $value;
		$this->output    = $output;

		$this->parse_output();
	}

	/**
	 * If we have a sanitize_callback defined, apply it to the value.
	 *
	 * @param array        $output The output args.
	 * @param string|array $value  The value.
	 *
	 * @return string|array
	 */
	protected function apply_sanitize_callback( $output, $value ) {

		if ( isset( $output['sanitize_callback'] ) && null !== $output['sanitize_callback'] ) {

			// If the sanitize_callback is invalid, return the value.
			if ( ! is_callable( $output['sanitize_callback'] ) ) {
				return $value;
			}
			return call_user_func( $output['sanitize_callback'], $this->value );
		}

		return $value;

	}

	/**
	 * If we have a value_pattern defined, apply it to the value.
	 *
	 * @param array        $output The output args.
	 * @param string|array $value  The value.
	 *
	 * @return string|array
	 */
	protected function apply_value_pattern( $output, $value ) {

		if ( isset( $output['value_pattern'] ) && ! empty( $output['value_pattern'] ) && is_string( $output['value_pattern'] ) ) {
			if ( ! is_array( $value ) ) {
				$value = str_replace( '$', $value, $output['value_pattern'] );
			}
			if ( is_array( $value ) ) {
				foreach ( array_keys( $value ) as $value_k ) {
					if ( ! is_string( $value[ $value_k ] ) ) {
						continue;
					}
					if ( isset( $output['choice'] ) ) {
						if ( $output['choice'] === $value_k ) {
							$value[ $output['choice'] ] = str_replace( '$', $value[ $output['choice'] ], $output['value_pattern'] );
						}
						continue;
					}
					$value[ $value_k ] = str_replace( '$', $value[ $value_k ], $output['value_pattern'] );
				}
			}
			if ( isset( $output['pattern_replace'] ) && is_array( $output['pattern_replace'] ) ) {
				$option_type = ( '' !== Kirki::get_config_param( $this->config_id, 'option_type' ) ) ? Kirki::get_config_param( $this->config_id, 'option_type' ) : 'theme_mod';
				$option_name = Kirki::get_config_param( $this->config_id, 'option_name' );
				$options     = array();
				if ( $option_name ) {
					$options = ( 'site_option' === $option_type ) ? get_site_option( $option_name ) : get_option( $option_name );
				}
				foreach ( $output['pattern_replace'] as $search => $replace ) {
					$replacement = '';
					switch ( $option_type ) {
						case 'option':
							if ( is_array( $options ) ) {
								if ( $option_name ) {
									$subkey = str_replace( array( $option_name, '[', ']' ), '', $replace );
									$replacement = ( isset( $options[ $subkey ] ) ) ? $options[ $subkey ] : '';
									break;
								}
								$replacement = ( isset( $options[ $replace ] ) ) ? $options[ $replace ] : '';
								break;
							}
							$replacement = get_option( $replace );
							break;
						case 'site_option':
							$replacement = ( is_array( $options ) && isset( $options[ $replace ] ) ) ? $options[ $replace ] : get_site_option( $replace );
							break;
						case 'user_meta':
							$user_id = get_current_user_id();
							if ( $user_id ) {
								// @codingStandardsIgnoreLine
								$replacement = get_user_meta( $user_id, $replace, true );
							}
							break;
						default:
							$replacement = get_theme_mod( $replace );
					}
					$replacement = ( false === $replacement ) ? '' : $replacement;
					if ( is_array( $value ) ) {
						foreach ( $value as $k => $v ) {
							$value[ $k ] = str_replace( $search, $replacement, $value[ $v ] );
						}
						return $value;
					}
					$value = str_replace( $search, $replacement, $value );
				} // End foreach().
			} // End if().
		} // End if().

		return $value;

	}

	/**
	 * Parses the output arguments.
	 * Calls the process_output method for each of them.
	 *
	 * @access protected
	 */
	protected function parse_output() {
		foreach ( $this->output as $output ) {
			$skip = false;

			// Apply any sanitization callbacks defined.
			$value = $this->apply_sanitize_callback( $output, $this->value );

			// Skip if value is empty.
			if ( '' === $this->value ) {
				$skip = true;
			}

			// No need to proceed this if the current value is the same as in the "exclude" value.
			if ( isset( $output['exclude'] ) && is_array( $output['exclude'] ) ) {
				foreach ( $output['exclude'] as $exclude ) {
					if ( is_array( $value ) ) {
						if ( is_array( $exclude ) ) {
							$diff1 = array_diff( $value, $exclude );
							$diff2 = array_diff( $exclude, $value );

							if ( empty( $diff1 ) && empty( $diff2 ) ) {
								$skip = true;
							}
						}
						// If 'choice' is defined check for sub-values too.
						// Fixes https://github.com/aristath/kirki/issues/1416.
						if ( isset( $output['choice'] ) && isset( $value[ $output['choice'] ] ) && $exclude == $value[ $output['choice'] ] ) {
							$skip = true;
						}
					}
					if ( $skip ) {
						continue;
					}

					// Skip if value is defined as excluded.
					if ( $exclude === $value ) {
						$skip = true;
					}
				}
			}
			if ( $skip ) {
				continue;
			}

			// Apply any value patterns defined.
			$value = $this->apply_value_pattern( $output, $value );

			if ( isset( $output['element'] ) && is_array( $output['element'] ) ) {
				$output['element'] = array_unique( $output['element'] );
				sort( $output['element'] );
				$output['element'] = implode( ',', $output['element'] );
			}

			$value = $this->process_value( $value, $output );
			$this->process_output( $output, $value );
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		} // End foreach().
	}

	/**
	 * Parses an output and creates the styles array for it.
	 *
	 * @access protected
	 * @param array  $output The field output.
	 * @param string $value  The value.
	 *
	 * @return void
	 */
	protected function process_output( $output, $value ) {
		if ( ! isset( $output['element'] ) || ! isset( $output['property'] ) ) {
			return;
		}
		$output['media_query'] = ( isset( $output['media_query'] ) ) ? $output['media_query'] : 'global';
		$output['prefix']      = ( isset( $output['prefix'] ) ) ? $output['prefix'] : '';
		$output['units']       = ( isset( $output['units'] ) ) ? $output['units'] : '';
		$output['suffix']      = ( isset( $output['suffix'] ) ) ? $output['suffix'] : '';

		// Properties that can accept multiple values.
		// Useful for example for gradients where all browsers use the "background-image" property
		// and the browser prefixes go in the value_pattern arg.
		$accepts_multiple = array(
			'background-image',
			'background',
		);
		if ( in_array( $output['property'], $accepts_multiple, true ) ) {
			if ( isset( $this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ] ) && ! is_array( $this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ] ) ) {
				$this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ] = (array) $this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ];
			}
			$this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ][] = $output['prefix'] . $value . $output['units'] . $output['suffix'];
			return;
		}
		$this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ] = $output['prefix'] . $value . $output['units'] . $output['suffix'];
	}

	/**
	 * Some CSS properties are unique.
	 * We need to tweak the value to make everything works as expected.
	 *
	 * @access protected
	 * @param string $property The CSS property.
	 * @param string $value    The value.
	 *
	 * @return array
	 */
	protected function process_property_value( $property, $value ) {
		$properties = apply_filters( "kirki/{$this->config_id}/output/property-classnames", array(
			'font-family'         => 'Kirki_Output_Property_Font_Family',
			'background-image'    => 'Kirki_Output_Property_Background_Image',
			'background-position' => 'Kirki_Output_Property_Background_Position',
		) );
		if ( array_key_exists( $property, $properties ) ) {
			$classname = $properties[ $property ];
			$obj = new $classname( $property, $value );
			return $obj->get_value();
		}
		return $value;
	}

	/**
	 * Returns the value.
	 *
	 * @access protected
	 * @param string|array $value The value.
	 * @param array        $output The field "output".
	 * @return string|array
	 */
	protected function process_value( $value, $output ) {
		if ( isset( $output['property'] ) ) {
			return $this->process_property_value( $output['property'], $value );

		}
		return $value;
	}

	/**
	 * Exploses the private $styles property to the world
	 *
	 * @access protected
	 * @return array
	 */
	public function get_styles() {
		return $this->styles;
	}
}


1			<?php
2			/**
3			* Handles CSS output for fields.
4			*
5			* @package Kirki
6			* @subpackage Controls
7			* @copyright Copyright (c) 2017, Aristeides Stathopoulos
8			* @license http://opensource.org/licenses/https://opensource.org/licenses/MIT
9			* @since 2.2.0
10			*/
11
12			/**
13			* Handles field CSS output.
14			*/
15			class Kirki_Output {
16
17			/**
18			* The Kirki configuration used in the field.
19			*
20			* @access protected
21			* @var string
22			*/
23			protected $config_id = 'global';
24
25			/**
26			* The field's `output` argument.
27			*
28			* @access protected
29			* @var array
30			*/
31			protected $output = array();
32
33			/**
34			* An array of the generated styles.
35			*
36			* @access protected
37			* @var array
38			*/
39			protected $styles = array();
40
41			/**
42			* The value.
43			*
44			* @access protected
45			* @var string\|array
46			*/
47			protected $value;
48
49			/**
50			* The class constructor.
51			*
52			* @access public
53			* @param string $config_id The config ID.
54			* @param array $output The output argument.
55			* @param string\|array $value The value.
56			*/
57			public function __construct( $config_id, $output, $value ) {
58
59			$this->config_id = $config_id;
60			$this->value = $value;
61			$this->output = $output;
62
63			$this->parse_output();
64			}
65
66			/**
67			* If we have a sanitize_callback defined, apply it to the value.
68			*
69			* @param array $output The output args.
70			* @param string\|array $value The value.
71			*
72			* @return string\|array
73			*/
74			protected function apply_sanitize_callback( $output, $value ) {
75
76			if ( isset( $output['sanitize_callback'] ) && null !== $output['sanitize_callback'] ) {
77
78			// If the sanitize_callback is invalid, return the value.
79			if ( ! is_callable( $output['sanitize_callback'] ) ) {
80			return $value;
81			}
82			return call_user_func( $output['sanitize_callback'], $this->value );
83			}
84
85			return $value;
86
87			}
88
89			/**
90			* If we have a value_pattern defined, apply it to the value.
91			*
92			* @param array $output The output args.
93			* @param string\|array $value The value.
94			*
95			* @return string\|array
96			*/
97			protected function apply_value_pattern( $output, $value ) {
98
99			if ( isset( $output['value_pattern'] ) && ! empty( $output['value_pattern'] ) && is_string( $output['value_pattern'] ) ) {
100			if ( ! is_array( $value ) ) {
101			$value = str_replace( '$', $value, $output['value_pattern'] );
102			}
103			if ( is_array( $value ) ) {
104			foreach ( array_keys( $value ) as $value_k ) {
105			if ( ! is_string( $value[ $value_k ] ) ) {
106			continue;
107			}
108			if ( isset( $output['choice'] ) ) {
109			if ( $output['choice'] === $value_k ) {
110			$value[ $output['choice'] ] = str_replace( '$', $value[ $output['choice'] ], $output['value_pattern'] );
111			}
112			continue;
113			}
114			$value[ $value_k ] = str_replace( '$', $value[ $value_k ], $output['value_pattern'] );
115			}
116			}
117			if ( isset( $output['pattern_replace'] ) && is_array( $output['pattern_replace'] ) ) {
118			$option_type = ( '' !== Kirki::get_config_param( $this->config_id, 'option_type' ) ) ? Kirki::get_config_param( $this->config_id, 'option_type' ) : 'theme_mod';
119			$option_name = Kirki::get_config_param( $this->config_id, 'option_name' );
120			$options = array();
121			if ( $option_name ) {
122			$options = ( 'site_option' === $option_type ) ? get_site_option( $option_name ) : get_option( $option_name );
123			}
124			foreach ( $output['pattern_replace'] as $search => $replace ) {
125			$replacement = '';
126			switch ( $option_type ) {
127			case 'option':
128			if ( is_array( $options ) ) {
129			if ( $option_name ) {
130			$subkey = str_replace( array( $option_name, '[', ']' ), '', $replace );
131			$replacement = ( isset( $options[ $subkey ] ) ) ? $options[ $subkey ] : '';
132			break;
133			}
134			$replacement = ( isset( $options[ $replace ] ) ) ? $options[ $replace ] : '';
135			break;
136			}
137			$replacement = get_option( $replace );
138			break;
139			case 'site_option':
140			$replacement = ( is_array( $options ) && isset( $options[ $replace ] ) ) ? $options[ $replace ] : get_site_option( $replace );
141			break;
142			case 'user_meta':
143			$user_id = get_current_user_id();
144			if ( $user_id ) {
145			// @codingStandardsIgnoreLine
146			$replacement = get_user_meta( $user_id, $replace, true );
147			}
148			break;
149			default:
150			$replacement = get_theme_mod( $replace );
151			}
152			$replacement = ( false === $replacement ) ? '' : $replacement;
153			if ( is_array( $value ) ) {
154			foreach ( $value as $k => $v ) {
155			$value[ $k ] = str_replace( $search, $replacement, $value[ $v ] );
156			}
157			return $value;
158			}
159			$value = str_replace( $search, $replacement, $value );
160			} // End foreach().
161			} // End if().
162			} // End if().
163
164			return $value;
165
166			}
167
168			/**
169			* Parses the output arguments.
170			* Calls the process_output method for each of them.
171			*
172			* @access protected
173			*/
174			protected function parse_output() {
175			foreach ( $this->output as $output ) {
176			$skip = false;
177
178			// Apply any sanitization callbacks defined.
179			$value = $this->apply_sanitize_callback( $output, $this->value );
180
181			// Skip if value is empty.
182			if ( '' === $this->value ) {
183			$skip = true;
184			}
185
186			// No need to proceed this if the current value is the same as in the "exclude" value.
187			if ( isset( $output['exclude'] ) && is_array( $output['exclude'] ) ) {
188			foreach ( $output['exclude'] as $exclude ) {
189			if ( is_array( $value ) ) {
190			if ( is_array( $exclude ) ) {
191			$diff1 = array_diff( $value, $exclude );
192			$diff2 = array_diff( $exclude, $value );
193
194			if ( empty( $diff1 ) && empty( $diff2 ) ) {
195			$skip = true;
196			}
197			}
198			// If 'choice' is defined check for sub-values too.
199			// Fixes https://github.com/aristath/kirki/issues/1416.
200			if ( isset( $output['choice'] ) && isset( $value[ $output['choice'] ] ) && $exclude == $value[ $output['choice'] ] ) {
201			$skip = true;
202			}
203			}
204			if ( $skip ) {
205			continue;
206			}
207
208			// Skip if value is defined as excluded.
209			if ( $exclude === $value ) {
210			$skip = true;
211			}
212			}
213			}
214			if ( $skip ) {
215			continue;
216			}
217
218			// Apply any value patterns defined.
219			$value = $this->apply_value_pattern( $output, $value );
220
221			if ( isset( $output['element'] ) && is_array( $output['element'] ) ) {
222			$output['element'] = array_unique( $output['element'] );
223			sort( $output['element'] );
224			$output['element'] = implode( ',', $output['element'] );
225			}
226
227			$value = $this->process_value( $value, $output );
228			$this->process_output( $output, $value );
			0 ignored issues – show Bug introduced 2017-04-21 22:53 UTC by Report Bug Copy Issue Report It seems like `$value` defined by `$this->process_value($value, $output)` on line `227` can also be of type `array`; however, `Kirki_Output::process_output()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
229			} // End foreach().
230			}
231
232			/**
233			* Parses an output and creates the styles array for it.
234			*
235			* @access protected
236			* @param array $output The field output.
237			* @param string $value The value.
238			*
239			* @return void
240			*/
241			protected function process_output( $output, $value ) {
242			if ( ! isset( $output['element'] ) \|\| ! isset( $output['property'] ) ) {
243			return;
244			}
245			$output['media_query'] = ( isset( $output['media_query'] ) ) ? $output['media_query'] : 'global';
246			$output['prefix'] = ( isset( $output['prefix'] ) ) ? $output['prefix'] : '';
247			$output['units'] = ( isset( $output['units'] ) ) ? $output['units'] : '';
248			$output['suffix'] = ( isset( $output['suffix'] ) ) ? $output['suffix'] : '';
249
250			// Properties that can accept multiple values.
251			// Useful for example for gradients where all browsers use the "background-image" property
252			// and the browser prefixes go in the value_pattern arg.
253			$accepts_multiple = array(
254			'background-image',
255			'background',
256			);
257			if ( in_array( $output['property'], $accepts_multiple, true ) ) {
258			if ( isset( $this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ] ) && ! is_array( $this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ] ) ) {
259			$this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ] = (array) $this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ];
260			}
261			$this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ][] = $output['prefix'] . $value . $output['units'] . $output['suffix'];
262			return;
263			}
264			$this->styles[ $output['media_query'] ][ $output['element'] ][ $output['property'] ] = $output['prefix'] . $value . $output['units'] . $output['suffix'];
265			}
266
267			/**
268			* Some CSS properties are unique.
269			* We need to tweak the value to make everything works as expected.
270			*
271			* @access protected
272			* @param string $property The CSS property.
273			* @param string $value The value.
274			*
275			* @return array
276			*/
277			protected function process_property_value( $property, $value ) {
278			$properties = apply_filters( "kirki/{$this->config_id}/output/property-classnames", array(
279			'font-family' => 'Kirki_Output_Property_Font_Family',
280			'background-image' => 'Kirki_Output_Property_Background_Image',
281			'background-position' => 'Kirki_Output_Property_Background_Position',
282			) );
283			if ( array_key_exists( $property, $properties ) ) {
284			$classname = $properties[ $property ];
285			$obj = new $classname( $property, $value );
286			return $obj->get_value();
287			}
288			return $value;
289			}
290
291			/**
292			* Returns the value.
293			*
294			* @access protected
295			* @param string\|array $value The value.
296			* @param array $output The field "output".
297			* @return string\|array
298			*/
299			protected function process_value( $value, $output ) {
300			if ( isset( $output['property'] ) ) {
301			return $this->process_property_value( $output['property'], $value );
			0 ignored issues – show Bug introduced 2016-04-09 22:07 UTC by Report Bug Copy Issue Report It seems like `$value` defined by parameter `$value` on line 299 can also be of type `array`; however, `Kirki_Output::process_property_value()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
302			}
303			return $value;
304			}
305
306			/**
307			* Exploses the private $styles property to the world
308			*
309			* @access protected
310			* @return array
311			*/
312			public function get_styles() {
313			return $this->styles;
314			}
315			}
316

aristath / kirki

Push — develop ( 772847...bba6ff )

Kirki_Output::apply_value_pattern() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like