Kirki_Active_Callback::evaluate_requirement() - Code Metrics - Inspection of "Better handling for deeper nested conditions" - aristath/kirki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( b3f345...32c254 )

by Aristeides

created 2017-05-31 12:57 UTC

Kirki_Active_Callback::evaluate_requirement() C

↳ Parent: Kirki_Active_Callback

Complexity

Conditions	15
Paths	16

Size

Total Lines	48
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	15
eloc	23
nc	16
nop	4
dl	0
loc	48
rs	5.0127
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * Active callback used with the "required" argument in fields
 *
 * @package     Kirki
 * @category    Core
 * @author      Aristeides Stathopoulos
 * @copyright   Copyright (c) 2017, Aristeides Stathopoulos
 * @license     http://opensource.org/licenses/https://opensource.org/licenses/MIT
 */

/**
 * Callback class for use with the "required" argument
 */
class Kirki_Active_Callback {

	/**
	 * Figure out whether the current object should be displayed or not.
	 *
	 * @param  WP_Customize_Setting $object The current field.
	 * @return boolean
	 */
	public static function evaluate( $object ) {

		$show = true;

		// Get all fields.
		$fields = Kirki::$fields;

		// Make sure the current object matches a registered field.
		if ( ! isset( $object->setting->id ) || ! isset( $fields[ $object->setting->id ] ) ) {
			return true;
		}

		$field = $fields[ $object->setting->id ];

		if ( isset( $field['required'] ) ) {

			foreach ( $field['required'] as $requirement ) {
				$show = self::evaluate_requirement( $object, $field, $requirement, 'AND' );
				// The 1st level uses "AND" so no need to process further
				// if one requirement returns false.
				if ( ! $show ) {
					return false;
				}
			}
		}

		return true;

	}

	/**
	 * Figure out whether the current object should be displayed or not.
	 * We're only parsing a single requirement here from the array of requirements.
	 * This is a proxy function that facilitates evaluating and/or conditions.
	 *
	 * @param WP_Customize_Setting $object      The current field.
	 * @param object               $field       The current object.
	 * @param array                $requirement A single requirement.
	 * @param string               $relation    Can be "AND" or "OR".
	 * @return boolean
	 */
	private static function evaluate_requirement( $object, $field, $requirement, $relation ) {

		// Test for callables first.
		if ( is_callable( $requirement ) ) {
			return call_user_func_array( $requirement, array( $field, $object ) );
		}

		// Look for comparison array.
		if ( is_array( $requirement ) && isset( $requirement['operator'], $requirement['value'], $requirement['setting'] ) ) {

			if ( isset( $field['option_name'] ) && '' !== $field['option_name'] ) {
				if ( false === strpos( $requirement['setting'], '[' ) ) {
					$requirement['setting'] = $field['option_name'] . '[' . $requirement['setting'] . ']';
				}
			}

			$current_setting = $object->manager->get_setting( $requirement['setting'] );

			/**
			 * Depending on the 'operator' argument we use,
			 * we'll need to perform the appropriate comparison
			 * and figure out if the control will be shown or not.
			 */
			if ( method_exists( $current_setting, 'value' ) ) {
				return self::compare( $requirement['value'], $current_setting->value(), $requirement['operator'] );
			}
		} else {
			if ( ! is_array( $requirement ) ) {
				return true;
			}

			// Handles "OR/AND" functionality & switching.
			$show = false;
			$sub_relation = ( 'AND' === $relation ) ? 'OR' : 'AND';
			foreach ( $requirement as $sub_requirement ) {
				$show = self::evaluate_requirement( $object, $field, $sub_requirement, $sub_relation );
				if ( 'OR' === $sub_relation && $show ) {
					return true;
				}
				if ( 'AND' === $sub_relation && ! $show ) {
					return false;
				}
			}
			return $show;
		}

		return true;
	}

	/**
	 * Compares the 2 values given the condition
	 *
	 * @param mixed  $value1   The 1st value in the comparison.
	 * @param mixed  $value2   The 2nd value in the comparison.
	 * @param string $operator The operator we'll use for the comparison.
	 * @return boolean whether The comparison has succeded (true) or failed (false).
	 */
	public static function compare( $value1, $value2, $operator ) {
		switch ( $operator ) {
			case '===':
				$show = ( $value1 === $value2 ) ? true : false;
				break;
			case '==':
			case '=':
			case 'equals':
			case 'equal':
				$show = ( $value1 == $value2 ) ? true : false;
				break;
			case '!==':
				$show = ( $value1 !== $value2 ) ? true : false;
				break;
			case '!=':
			case 'not equal':
				$show = ( $value1 != $value2 ) ? true : false;
				break;
			case '>=':
			case 'greater or equal':
			case 'equal or greater':
				$show = ( $value2 >= $value1 ) ? true : false;
				break;
			case '<=':
			case 'smaller or equal':
			case 'equal or smaller':
				$show = ( $value2 <= $value1 ) ? true : false;
				break;
			case '>':
			case 'greater':
				$show = ( $value2 > $value1 ) ? true : false;
				break;
			case '<':
			case 'smaller':
				$show = ( $value2 < $value1 ) ? true : false;
				break;
			case 'contains':
			case 'in':
				if ( is_array( $value1 ) && ! is_array( $value2 ) ) {
					$array  = $value1;
					$string = $value2;
				} elseif ( is_array( $value2 ) && ! is_array( $value1 ) ) {
					$array  = $value2;
					$string = $value1;
				}
				if ( isset( $array ) && isset( $string ) ) {
					if ( ! in_array( $string, $array, true ) ) {
						$show = false;
					}
				} else {
					if ( false === strrpos( $value1, $value2 ) && false === strpos( $value2, $value1 ) ) {
						$show = false;
					}
				}
				break;
			default:
				$show = ( $value1 == $value2 ) ? true : false;

		} // End switch().

		if ( isset( $show ) ) {
			return $show;
		}

		return true;
	}
}


1			<?php
2			/**
3			* Active callback used with the "required" argument in fields
4			*
5			* @package Kirki
6			* @category Core
7			* @author Aristeides Stathopoulos
8			* @copyright Copyright (c) 2017, Aristeides Stathopoulos
9			* @license http://opensource.org/licenses/https://opensource.org/licenses/MIT
10			*/
11
12			/**
13			* Callback class for use with the "required" argument
14			*/
15			class Kirki_Active_Callback {
16
17			/**
18			* Figure out whether the current object should be displayed or not.
19			*
20			* @param WP_Customize_Setting $object The current field.
21			* @return boolean
22			*/
23			public static function evaluate( $object ) {
24
25			$show = true;
26
27			// Get all fields.
28			$fields = Kirki::$fields;
29
30			// Make sure the current object matches a registered field.
31			if ( ! isset( $object->setting->id ) \|\| ! isset( $fields[ $object->setting->id ] ) ) {
32			return true;
33			}
34
35			$field = $fields[ $object->setting->id ];
36
37			if ( isset( $field['required'] ) ) {
38
39			foreach ( $field['required'] as $requirement ) {
40			$show = self::evaluate_requirement( $object, $field, $requirement, 'AND' );
41			// The 1st level uses "AND" so no need to process further
42			// if one requirement returns false.
43			if ( ! $show ) {
44			return false;
45			}
46			}
47			}
48
49			return true;
50
51			}
52
53			/**
54			* Figure out whether the current object should be displayed or not.
55			* We're only parsing a single requirement here from the array of requirements.
56			* This is a proxy function that facilitates evaluating and/or conditions.
57			*
58			* @param WP_Customize_Setting $object The current field.
59			* @param object $field The current object.
60			* @param array $requirement A single requirement.
61			* @param string $relation Can be "AND" or "OR".
62			* @return boolean
63			*/
64			private static function evaluate_requirement( $object, $field, $requirement, $relation ) {
65
66			// Test for callables first.
67			if ( is_callable( $requirement ) ) {
68			return call_user_func_array( $requirement, array( $field, $object ) );
69			}
70
71			// Look for comparison array.
72			if ( is_array( $requirement ) && isset( $requirement['operator'], $requirement['value'], $requirement['setting'] ) ) {
73
74			if ( isset( $field['option_name'] ) && '' !== $field['option_name'] ) {
75			if ( false === strpos( $requirement['setting'], '[' ) ) {
76			$requirement['setting'] = $field['option_name'] . '[' . $requirement['setting'] . ']';
77			}
78			}
79
80			$current_setting = $object->manager->get_setting( $requirement['setting'] );
81
82			/**
83			* Depending on the 'operator' argument we use,
84			* we'll need to perform the appropriate comparison
85			* and figure out if the control will be shown or not.
86			*/
87			if ( method_exists( $current_setting, 'value' ) ) {
88			return self::compare( $requirement['value'], $current_setting->value(), $requirement['operator'] );
89			}
90			} else {
91			if ( ! is_array( $requirement ) ) {
92			return true;
93			}
94
95			// Handles "OR/AND" functionality & switching.
96			$show = false;
97			$sub_relation = ( 'AND' === $relation ) ? 'OR' : 'AND';
98			foreach ( $requirement as $sub_requirement ) {
99			$show = self::evaluate_requirement( $object, $field, $sub_requirement, $sub_relation );
100			if ( 'OR' === $sub_relation && $show ) {
101			return true;
102			}
103			if ( 'AND' === $sub_relation && ! $show ) {
104			return false;
105			}
106			}
107			return $show;
108			}
109
110			return true;
111			}
112
113			/**
114			* Compares the 2 values given the condition
115			*
116			* @param mixed $value1 The 1st value in the comparison.
117			* @param mixed $value2 The 2nd value in the comparison.
118			* @param string $operator The operator we'll use for the comparison.
119			* @return boolean whether The comparison has succeded (true) or failed (false).
120			*/
121			public static function compare( $value1, $value2, $operator ) {
122			switch ( $operator ) {
123			case '===':
124			$show = ( $value1 === $value2 ) ? true : false;
125			break;
126			case '==':
127			case '=':
128			case 'equals':
129			case 'equal':
130			$show = ( $value1 == $value2 ) ? true : false;
131			break;
132			case '!==':
133			$show = ( $value1 !== $value2 ) ? true : false;
134			break;
135			case '!=':
136			case 'not equal':
137			$show = ( $value1 != $value2 ) ? true : false;
138			break;
139			case '>=':
140			case 'greater or equal':
141			case 'equal or greater':
142			$show = ( $value2 >= $value1 ) ? true : false;
143			break;
144			case '<=':
145			case 'smaller or equal':
146			case 'equal or smaller':
147			$show = ( $value2 <= $value1 ) ? true : false;
148			break;
149			case '>':
150			case 'greater':
151			$show = ( $value2 > $value1 ) ? true : false;
152			break;
153			case '<':
154			case 'smaller':
155			$show = ( $value2 < $value1 ) ? true : false;
156			break;
157			case 'contains':
158			case 'in':
159			if ( is_array( $value1 ) && ! is_array( $value2 ) ) {
160			$array = $value1;
161			$string = $value2;
162			} elseif ( is_array( $value2 ) && ! is_array( $value1 ) ) {
163			$array = $value2;
164			$string = $value1;
165			}
166			if ( isset( $array ) && isset( $string ) ) {
167			if ( ! in_array( $string, $array, true ) ) {
168			$show = false;
169			}
170			} else {
171			if ( false === strrpos( $value1, $value2 ) && false === strpos( $value2, $value1 ) ) {
172			$show = false;
173			}
174			}
175			break;
176			default:
177			$show = ( $value1 == $value2 ) ? true : false;
178
179			} // End switch().
180
181			if ( isset( $show ) ) {
182			return $show;
183			}
184
185			return true;
186			}
187			}
188

aristath / kirki

Push — develop ( b3f345...32c254 )

Kirki_Active_Callback::evaluate_requirement() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like