Kirki_Field_Typography::sanitize() - Code Metrics - Inspection of "3.0.17" - aristath/kirki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1653)

by Aristeides

created 2017-12-02 13:32 UTC

Kirki_Field_Typography::sanitize() C

↳ Parent: Kirki_Field_Typography

Complexity

Conditions	34
Paths	75

Size

Total Lines	78
Code Lines	56

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	34
eloc	56
nc	75
nop	1
dl	0
loc	78
rs	5.0147
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * Override field methods
 *
 * @package     Kirki
 * @subpackage  Controls
 * @copyright   Copyright (c) 2017, Aristeides Stathopoulos
 * @license     http://opensource.org/licenses/https://opensource.org/licenses/MIT
 * @since       2.2.7
 */

/**
 * Field overrides.
 */
class Kirki_Field_Typography extends Kirki_Field {

	/**
	 * Sets the control type.
	 *
	 * @access protected
	 */
	protected function set_type() {

		$this->type = 'kirki-typography';

	}

	/**
	 * The class constructor.
	 * Parses and sanitizes all field arguments.
	 * Then it adds the field to Kirki::$fields.
	 *
	 * @access public
	 * @param string $config_id    The ID of the config we want to use.
	 *                             Defaults to "global".
	 *                             Configs are handled by the Kirki_Config class.
	 * @param array  $args         The arguments of the field.
	 */
	public function __construct( $config_id = 'global', $args = array() ) {
		parent::__construct( $config_id, $args );
		$this->set_default();
	}

	/**
	 * Sets the default value.
	 *
	 * @access protected
	 */
	protected function set_default() {

		// Accomodate the use of font-weight and convert to variant.
		if ( isset( $this->default['font-weight'] ) ) {
			$this->default['variant'] = ( 'regular' === $this->default['font-weight'] ) ? 400 : (string) intval( $this->default['font-weight'] );
		}

		// Make sure letter-spacing has units.
		if ( isset( $this->default['letter-spacing'] ) && is_numeric( $this->default['letter-spacing'] ) && $this->default['letter-spacing'] ) {
			$this->default['letter-spacing'] .= 'px';
		}

		// Make sure we use "subsets" instead of "subset".
		if ( isset( $this->default['subset'] ) && ! empty( $this->default['subset'] ) && ( ! isset( $this->default['subsets'] ) || empty( $this->default['subsets'] ) ) ) {
			$this->default['subsets'] = $this->default['subset'];
		}
	}

	/**
	 * Sets the $sanitize_callback
	 *
	 * @access protected
	 */
	protected function set_sanitize_callback() {

		// If a custom sanitize_callback has been defined,
		// then we don't need to proceed any further.
		if ( ! empty( $this->sanitize_callback ) ) {
			return;
		}
		$this->sanitize_callback = array( __CLASS__, 'sanitize' );

	}

	/**
	 * Sets the $js_vars
	 *
	 * @access protected
	 */
	protected function set_js_vars() {

		if ( ! is_array( $this->js_vars ) ) {
			$this->js_vars = array();
		}

		// Check if transport is set to auto.
		// If not, then skip the auto-calculations and exit early.
		if ( 'auto' !== $this->transport ) {
			return;
		}

		// Set transport to refresh initially.
		// Serves as a fallback in case we failt to auto-calculate js_vars.
		$this->transport = 'refresh';

		$js_vars = array();

		// Try to auto-generate js_vars.
		// First we need to check if js_vars are empty, and that output is not empty.
		if ( ! empty( $this->output ) ) {

			// Start going through each item in the $output array.
			foreach ( $this->output as $output ) {

				// If 'element' or 'property' are not defined, skip this.
				if ( ! isset( $output['element'] ) ) {
					continue;
				}
				if ( is_array( $output['element'] ) ) {
					$output['element'] = implode( ',', $output['element'] );
				}

				// If we got this far, it's safe to add this.
				$js_vars[] = $output;
			}

			// Did we manage to get all the items from 'output'?
			// If not, then we're missing something so don't add this.
			if ( count( $js_vars ) !== count( $this->output ) ) {
				return;
			}
			$this->js_vars   = $js_vars;
			$this->transport = 'postMessage';

		}

	}

	/**
	 * Sanitizes typography controls
	 *
	 * @static
	 * @since 2.2.0
	 * @param array $value The value.
	 * @return array
	 */
	public static function sanitize( $value ) {

		if ( ! is_array( $value ) ) {
			return array();
		}

		foreach ( $value as $key => $val ) {
			switch ( $key ) {
				case 'font-family':
					$value['font-family'] = esc_attr( $val );
					break;
				case 'font-weight':
					if ( isset( $value['variant'] ) ) {
						break;
					}
					$value['variant'] = $val;
					if ( isset( $value['font-style'] ) && 'italic' === $value['font-style'] ) {
						$value['variant'] = ( '400' !== $val || 400 !== $val ) ? $value['variant'] . 'italic' : 'italic';
					}
					break;
				case 'variant':
					// Use 'regular' instead of 400 for font-variant.
					$value['variant'] = ( 400 === $val || '400' === $val ) ? 'regular' : $val;
					// Get font-weight from variant.
					$value['font-weight'] = filter_var( $value['variant'], FILTER_SANITIZE_NUMBER_FLOAT, FILTER_FLAG_ALLOW_FRACTION );
					$value['font-weight'] = ( 'regular' === $value['variant'] || 'italic' === $value['variant'] ) ? 400 : absint( $value['font-weight'] );
					// Get font-style from variant.
					if ( ! isset( $value['font-style'] ) ) {
						$value['font-style'] = ( false === strpos( $value['variant'], 'italic' ) ) ? 'normal' : 'italic';
					}
					break;
				case 'subset':
					// Make sure the saved value is "subsets" (plural) and not "subset".
					// This is for compatibility with older versions.
					if ( ! empty( $value['subset'] ) && ! isset( $value['subsets'] ) || empty( $value['subset'] ) ) {
						$value['subsets'] = $value['subset'];
					}
					unset( $value['subset'] );
					// Make sure we're using a valid subset.
					$valid_subsets = Kirki_Fonts::get_google_font_subsets();
					$subsets_ok = array();
					$value['subsets'] = (array) $value['subsets'];
					foreach ( $value['subsets'] as $subset ) {
						if ( array_key_exists( $subset, $valid_subsets ) ) {
							$subsets_ok[] = $subset;
						}
					}
					$value['subsets'] = $subsets_ok;
					break;
				case 'font-size':
				case 'letter-spacing':
				case 'word-spacing':
				case 'line-height':
					$value[ $key ] = Kirki_Sanitize_Values::css_dimension( $val );
					break;
				case 'text-align':
					if ( ! in_array( $val, array( 'inherit', 'left', 'center', 'right', 'justify' ), true ) ) {
						$value['text-align'] = 'inherit';
					}
					break;
				case 'text-transform':
					if ( ! in_array( $val, array( 'none', 'capitalize', 'uppercase', 'lowercase', 'initial', 'inherit' ), true ) ) {
						$value['text-transform'] = 'none';
					}
					break;
				case 'text-decoration':
					if ( ! in_array( $val, array( 'none', 'underline', 'overline', 'line-through', 'initial', 'inherit' ), true ) ) {
						$value['text-transform'] = 'none';
					}
					break;
				case 'color':
					$value['color'] = ariColor::newColor( $val )->toCSS( 'hex' );
					break;
			} // End switch().
		} // End foreach().

		return $value;
	}

	/**
	 * Sets the $choices
	 *
	 * @access protected
	 * @since 3.0.0
	 */
	protected function set_choices() {

		if ( ! is_array( $this->choices ) ) {
			$this->choices = array();
		}
		$this->choices = wp_parse_args(
			$this->choices, array(
				'variant' => array(),
				'fonts'   => array(
					'standard' => array(),
					'google'   => array(),
				),
			)
		);
	}
}


1			<?php
2			/**
3			* Override field methods
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.7
10			*/
11
12			/**
13			* Field overrides.
14			*/
15			class Kirki_Field_Typography extends Kirki_Field {
16
17			/**
18			* Sets the control type.
19			*
20			* @access protected
21			*/
22			protected function set_type() {
23
24			$this->type = 'kirki-typography';
25
26			}
27
28			/**
29			* The class constructor.
30			* Parses and sanitizes all field arguments.
31			* Then it adds the field to Kirki::$fields.
32			*
33			* @access public
34			* @param string $config_id The ID of the config we want to use.
35			* Defaults to "global".
36			* Configs are handled by the Kirki_Config class.
37			* @param array $args The arguments of the field.
38			*/
39			public function __construct( $config_id = 'global', $args = array() ) {
40			parent::__construct( $config_id, $args );
41			$this->set_default();
42			}
43
44			/**
45			* Sets the default value.
46			*
47			* @access protected
48			*/
49			protected function set_default() {
50
51			// Accomodate the use of font-weight and convert to variant.
52			if ( isset( $this->default['font-weight'] ) ) {
53			$this->default['variant'] = ( 'regular' === $this->default['font-weight'] ) ? 400 : (string) intval( $this->default['font-weight'] );
54			}
55
56			// Make sure letter-spacing has units.
57			if ( isset( $this->default['letter-spacing'] ) && is_numeric( $this->default['letter-spacing'] ) && $this->default['letter-spacing'] ) {
58			$this->default['letter-spacing'] .= 'px';
59			}
60
61			// Make sure we use "subsets" instead of "subset".
62			if ( isset( $this->default['subset'] ) && ! empty( $this->default['subset'] ) && ( ! isset( $this->default['subsets'] ) \|\| empty( $this->default['subsets'] ) ) ) {
63			$this->default['subsets'] = $this->default['subset'];
64			}
65			}
66
67			/**
68			* Sets the $sanitize_callback
69			*
70			* @access protected
71			*/
72			protected function set_sanitize_callback() {
73
74			// If a custom sanitize_callback has been defined,
75			// then we don't need to proceed any further.
76			if ( ! empty( $this->sanitize_callback ) ) {
77			return;
78			}
79			$this->sanitize_callback = array( __CLASS__, 'sanitize' );
80
81			}
82
83			/**
84			* Sets the $js_vars
85			*
86			* @access protected
87			*/
88			protected function set_js_vars() {
89
90			if ( ! is_array( $this->js_vars ) ) {
91			$this->js_vars = array();
92			}
93
94			// Check if transport is set to auto.
95			// If not, then skip the auto-calculations and exit early.
96			if ( 'auto' !== $this->transport ) {
97			return;
98			}
99
100			// Set transport to refresh initially.
101			// Serves as a fallback in case we failt to auto-calculate js_vars.
102			$this->transport = 'refresh';
103
104			$js_vars = array();
105
106			// Try to auto-generate js_vars.
107			// First we need to check if js_vars are empty, and that output is not empty.
108			if ( ! empty( $this->output ) ) {
109
110			// Start going through each item in the $output array.
111			foreach ( $this->output as $output ) {
112
113			// If 'element' or 'property' are not defined, skip this.
114			if ( ! isset( $output['element'] ) ) {
115			continue;
116			}
117			if ( is_array( $output['element'] ) ) {
118			$output['element'] = implode( ',', $output['element'] );
119			}
120
121			// If we got this far, it's safe to add this.
122			$js_vars[] = $output;
123			}
124
125			// Did we manage to get all the items from 'output'?
126			// If not, then we're missing something so don't add this.
127			if ( count( $js_vars ) !== count( $this->output ) ) {
128			return;
129			}
130			$this->js_vars = $js_vars;
131			$this->transport = 'postMessage';
132
133			}
134
135			}
136
137			/**
138			* Sanitizes typography controls
139			*
140			* @static
141			* @since 2.2.0
142			* @param array $value The value.
143			* @return array
144			*/
145			public static function sanitize( $value ) {
146
147			if ( ! is_array( $value ) ) {
148			return array();
149			}
150
151			foreach ( $value as $key => $val ) {
152			switch ( $key ) {
153			case 'font-family':
154			$value['font-family'] = esc_attr( $val );
155			break;
156			case 'font-weight':
157			if ( isset( $value['variant'] ) ) {
158			break;
159			}
160			$value['variant'] = $val;
161			if ( isset( $value['font-style'] ) && 'italic' === $value['font-style'] ) {
162			$value['variant'] = ( '400' !== $val \|\| 400 !== $val ) ? $value['variant'] . 'italic' : 'italic';
163			}
164			break;
165			case 'variant':
166			// Use 'regular' instead of 400 for font-variant.
167			$value['variant'] = ( 400 === $val \|\| '400' === $val ) ? 'regular' : $val;
168			// Get font-weight from variant.
169			$value['font-weight'] = filter_var( $value['variant'], FILTER_SANITIZE_NUMBER_FLOAT, FILTER_FLAG_ALLOW_FRACTION );
170			$value['font-weight'] = ( 'regular' === $value['variant'] \|\| 'italic' === $value['variant'] ) ? 400 : absint( $value['font-weight'] );
171			// Get font-style from variant.
172			if ( ! isset( $value['font-style'] ) ) {
173			$value['font-style'] = ( false === strpos( $value['variant'], 'italic' ) ) ? 'normal' : 'italic';
174			}
175			break;
176			case 'subset':
177			// Make sure the saved value is "subsets" (plural) and not "subset".
178			// This is for compatibility with older versions.
179			if ( ! empty( $value['subset'] ) && ! isset( $value['subsets'] ) \|\| empty( $value['subset'] ) ) {
180			$value['subsets'] = $value['subset'];
181			}
182			unset( $value['subset'] );
183			// Make sure we're using a valid subset.
184			$valid_subsets = Kirki_Fonts::get_google_font_subsets();
185			$subsets_ok = array();
186			$value['subsets'] = (array) $value['subsets'];
187			foreach ( $value['subsets'] as $subset ) {
188			if ( array_key_exists( $subset, $valid_subsets ) ) {
189			$subsets_ok[] = $subset;
190			}
191			}
192			$value['subsets'] = $subsets_ok;
193			break;
194			case 'font-size':
195			case 'letter-spacing':
196			case 'word-spacing':
197			case 'line-height':
198			$value[ $key ] = Kirki_Sanitize_Values::css_dimension( $val );
199			break;
200			case 'text-align':
201			if ( ! in_array( $val, array( 'inherit', 'left', 'center', 'right', 'justify' ), true ) ) {
202			$value['text-align'] = 'inherit';
203			}
204			break;
205			case 'text-transform':
206			if ( ! in_array( $val, array( 'none', 'capitalize', 'uppercase', 'lowercase', 'initial', 'inherit' ), true ) ) {
207			$value['text-transform'] = 'none';
208			}
209			break;
210			case 'text-decoration':
211			if ( ! in_array( $val, array( 'none', 'underline', 'overline', 'line-through', 'initial', 'inherit' ), true ) ) {
212			$value['text-transform'] = 'none';
213			}
214			break;
215			case 'color':
216			$value['color'] = ariColor::newColor( $val )->toCSS( 'hex' );
217			break;
218			} // End switch().
219			} // End foreach().
220
221			return $value;
222			}
223
224			/**
225			* Sets the $choices
226			*
227			* @access protected
228			* @since 3.0.0
229			*/
230			protected function set_choices() {
231
232			if ( ! is_array( $this->choices ) ) {
233			$this->choices = array();
234			}
235			$this->choices = wp_parse_args(
236			$this->choices, array(
237			'variant' => array(),
238			'fonts' => array(
239			'standard' => array(),
240			'google' => array(),
241			),
242			)
243			);
244			}
245			}
246

aristath / kirki

Pull Request — master (#1653)

Kirki_Field_Typography::sanitize() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like