Kirki_Fonts_Google::__construct() - 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-11-21 18:21 UTC

Kirki_Fonts_Google::__construct() A

↳ Parent: Kirki_Fonts_Google

Complexity

Conditions	3
Paths	2

Size

Total Lines	16
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	7
nc	2
nop	0
dl	0
loc	16
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Processes typography-related fields
 * and generates the google-font link.
 *
 * @package     Kirki
 * @category    Core
 * @author      Aristeides Stathopoulos
 * @copyright   Copyright (c) 2017, Aristeides Stathopoulos
 * @license     http://opensource.org/licenses/https://opensource.org/licenses/MIT
 * @since       1.0
 */

/**
 * Manages the way Google Fonts are enqueued.
 */
final class Kirki_Fonts_Google {

	/**
	 * The Kirki_Fonts_Google instance.
	 * We use the singleton pattern here to avoid loading the google-font array multiple times.
	 * This is mostly a performance tweak.
	 *
	 * @access private
	 * @var null|object
	 */
	private static $instance = null;

	/**
	 * If set to true, forces loading ALL variants.
	 *
	 * @static
	 * @access public
	 * @var bool
	 */
	public static $force_load_all_variants = false;

	/**
	 * If set to true, forces loading ALL subsets.
	 *
	 * @static
	 * @access public
	 * @var bool
	 */
	public static $force_load_all_subsets = false;

	/**
	 * The array of fonts
	 *
	 * @access public
	 * @var array
	 */
	public $fonts = array();

	/**
	 * An array of all google fonts.
	 *
	 * @access private
	 * @var array
	 */
	private $google_fonts = array();

	/**
	 * The array of subsets
	 *
	 * @access public
	 * @var array
	 */
	public $subsets = array();

	/**
	 * The class constructor.
	 */
	private function __construct() {

		$config = apply_filters( 'kirki/config', array() );

		// If we have set $config['disable_google_fonts'] to true then do not proceed any further.
		if ( isset( $config['disable_google_fonts'] ) && true === $config['disable_google_fonts'] ) {
			return;
		}

		add_action( 'wp_ajax_kirki_fonts_google_all_get', array( $this, 'get_googlefonts_json' ) );
		add_action( 'wp_ajax_noprinv_kirki_fonts_google_all_get', array( $this, 'get_googlefonts_json' ) );

		// Populate the array of google fonts.
		$this->google_fonts = Kirki_Fonts::get_google_fonts();

	}

	/**
	 * Get the one, true instance of this class.
	 * Prevents performance issues since this is only loaded once.
	 *
	 * @return object Kirki_Fonts_Google
	 */
	public static function get_instance() {
		if ( null === self::$instance ) {
			self::$instance = new Kirki_Fonts_Google();
		}
		return self::$instance;
	}

	/**
	 * Processes the arguments of a field
	 * determines if it's a typography field
	 * and if it is, then takes appropriate actions.
	 *
	 * @param array $args The field arguments.
	 */
	public function generate_google_font( $args ) {

		// Process typography fields.
		if ( isset( $args['type'] ) && 'kirki-typography' === $args['type'] ) {

			// Get the value.
			$value = Kirki_Values::get_sanitized_field_value( $args );

			// If we don't have a font-family then we can skip this.
			if ( ! isset( $value['font-family'] ) ) {
				return;
			}

			// If not a google-font, then we can skip this.
			if ( ! Kirki_Fonts::is_google_font( $value['font-family'] ) ) {
				return;
			}

			// Set a default value for variants.
			if ( ! isset( $value['variant'] ) ) {
				$value['variant'] = 'regular';
			}
			if ( isset( $value['subsets'] ) ) {

				// Add the subset directly to the array of subsets in the Kirki_GoogleFonts_Manager object.
				// Subsets must be applied to ALL fonts if possible.
				if ( ! is_array( $value['subsets'] ) ) {
					$this->subsets[] = $value['subsets'];
				} else {
					foreach ( $value['subsets'] as $subset ) {
						$this->subsets[] = $subset;
					}
				}
			}

			// Add the requested google-font.
			if ( ! isset( $this->fonts[ $value['font-family'] ] ) ) {
				$this->fonts[ $value['font-family'] ] = array();
			}
			if ( ! in_array( $value['variant'], $this->fonts[ $value['font-family'] ], true ) ) {
				$this->fonts[ $value['font-family'] ][] = $value['variant'];
			}
			// Are we force-loading all variants?
			if ( true === self::$force_load_all_variants ) {
				$all_variants = Kirki_Fonts::get_all_variants();
				$args['choices']['variant'] = array_keys( $all_variants );
			}

			if ( ! empty( $args['choices']['variant'] ) && is_array( $args['choices']['variant'] ) ) {
				foreach ( $args['choices']['variant'] as $extra_variant ) {
					$this->fonts[ $value['font-family'] ][] = $extra_variant;
				}
			}
		} else {

			// Process non-typography fields.
			if ( isset( $args['output'] ) && is_array( $args['output'] ) ) {
				foreach ( $args['output'] as $output ) {

					// If we don't have a typography-related output argument we can skip this.
					if ( ! isset( $output['property'] ) || ! in_array( $output['property'], array( 'font-family', 'font-weight', 'font-subset', 'subset', 'subsets' ), true ) ) {
						continue;
					}

					// Get the value.
					$value = Kirki_Values::get_sanitized_field_value( $args );

					if ( is_string( $value ) ) {
						if ( 'font-family' === $output['property'] ) {
							if ( ! array_key_exists( $value, $this->fonts ) ) {
								$this->fonts[ $value ] = array();
							}
						} elseif ( 'font-weight' === $output['property'] ) {
							foreach ( $this->fonts as $font => $variants ) {
								if ( ! in_array( $value, $variants, true ) ) {
									$this->fonts[ $font ][] = $value;
								}
							}
						} elseif ( 'font-subset' === $output['property'] || 'subset' === $output['property'] || 'subsets' === $output['property'] ) {
							if ( ! is_array( $value ) ) {
								if ( ! in_array( $value, $this->subsets, true ) ) {
									$this->subsets[] = $value;
								}
							} else {
								foreach ( $value as $subset ) {
									if ( ! in_array( $subset, $this->subsets, true ) ) {
										$this->subsets[] = $subset;
									}
								}
							}
						}
					}
				} // End foreach().
			} // End if().
		} // End if().
	}

	/**
	 * Determines the vbalidity of the selected font as well as its properties.
	 * This is vital to make sure that the google-font script that we'll generate later
	 * does not contain any invalid options.
	 */
	public function process_fonts() {

		// Early exit if font-family is empty.
		if ( empty( $this->fonts ) ) {
			return;
		}

		$valid_subsets = array();
		foreach ( $this->fonts as $font => $variants ) {

			// Determine if this is indeed a google font or not.
			// If it's not, then just remove it from the array.
			if ( ! array_key_exists( $font, $this->google_fonts ) ) {
				unset( $this->fonts[ $font ] );
				continue;
			}

			// Get all valid font variants for this font.
			$font_variants = array();
			if ( isset( $this->google_fonts[ $font ]['variants'] ) ) {
				$font_variants = $this->google_fonts[ $font ]['variants'];
			}
			foreach ( $variants as $variant ) {

				// If this is not a valid variant for this font-family
				// then unset it and move on to the next one.
				if ( ! in_array( $variant, $font_variants, true ) ) {
					$variant_key = array_search( $variant, $this->fonts[ $font ], true );
					unset( $this->fonts[ $font ][ $variant_key ] );
					continue;
				}
			}

			// Check if the selected subsets exist, even in one of the selected fonts.
			// If they don't, then they have to be removed otherwise the link will fail.
			if ( isset( $this->google_fonts[ $font ]['subsets'] ) ) {
				foreach ( $this->subsets as $subset ) {
					if ( in_array( $subset, $this->google_fonts[ $font ]['subsets'], true ) ) {
						$valid_subsets[] = $subset;
					}
				}
			}
		}
		$this->subsets = $valid_subsets;
	}

	/**
	 * Gets the googlefonts JSON file.
	 *
	 * @since 3.0.17
	 * @return string

	 */
	public function get_googlefonts_json() {
		echo file_get_contents( wp_normalize_path( dirname( __FILE__ ) . '/webfonts.json' ) ); // WPCS: XSS ok.

		exit();
	}
}


1			<?php
2			/**
3			* Processes typography-related fields
4			* and generates the google-font link.
5			*
6			* @package Kirki
7			* @category Core
8			* @author Aristeides Stathopoulos
9			* @copyright Copyright (c) 2017, Aristeides Stathopoulos
10			* @license http://opensource.org/licenses/https://opensource.org/licenses/MIT
11			* @since 1.0
12			*/
13
14			/**
15			* Manages the way Google Fonts are enqueued.
16			*/
17			final class Kirki_Fonts_Google {
18
19			/**
20			* The Kirki_Fonts_Google instance.
21			* We use the singleton pattern here to avoid loading the google-font array multiple times.
22			* This is mostly a performance tweak.
23			*
24			* @access private
25			* @var null\|object
26			*/
27			private static $instance = null;
28
29			/**
30			* If set to true, forces loading ALL variants.
31			*
32			* @static
33			* @access public
34			* @var bool
35			*/
36			public static $force_load_all_variants = false;
37
38			/**
39			* If set to true, forces loading ALL subsets.
40			*
41			* @static
42			* @access public
43			* @var bool
44			*/
45			public static $force_load_all_subsets = false;
46
47			/**
48			* The array of fonts
49			*
50			* @access public
51			* @var array
52			*/
53			public $fonts = array();
54
55			/**
56			* An array of all google fonts.
57			*
58			* @access private
59			* @var array
60			*/
61			private $google_fonts = array();
62
63			/**
64			* The array of subsets
65			*
66			* @access public
67			* @var array
68			*/
69			public $subsets = array();
70
71			/**
72			* The class constructor.
73			*/
74			private function __construct() {
75
76			$config = apply_filters( 'kirki/config', array() );
77
78			// If we have set $config['disable_google_fonts'] to true then do not proceed any further.
79			if ( isset( $config['disable_google_fonts'] ) && true === $config['disable_google_fonts'] ) {
80			return;
81			}
82
83			add_action( 'wp_ajax_kirki_fonts_google_all_get', array( $this, 'get_googlefonts_json' ) );
84			add_action( 'wp_ajax_noprinv_kirki_fonts_google_all_get', array( $this, 'get_googlefonts_json' ) );
85
86			// Populate the array of google fonts.
87			$this->google_fonts = Kirki_Fonts::get_google_fonts();
88
89			}
90
91			/**
92			* Get the one, true instance of this class.
93			* Prevents performance issues since this is only loaded once.
94			*
95			* @return object Kirki_Fonts_Google
96			*/
97			public static function get_instance() {
98			if ( null === self::$instance ) {
99			self::$instance = new Kirki_Fonts_Google();
100			}
101			return self::$instance;
102			}
103
104			/**
105			* Processes the arguments of a field
106			* determines if it's a typography field
107			* and if it is, then takes appropriate actions.
108			*
109			* @param array $args The field arguments.
110			*/
111			public function generate_google_font( $args ) {
112
113			// Process typography fields.
114			if ( isset( $args['type'] ) && 'kirki-typography' === $args['type'] ) {
115
116			// Get the value.
117			$value = Kirki_Values::get_sanitized_field_value( $args );
118
119			// If we don't have a font-family then we can skip this.
120			if ( ! isset( $value['font-family'] ) ) {
121			return;
122			}
123
124			// If not a google-font, then we can skip this.
125			if ( ! Kirki_Fonts::is_google_font( $value['font-family'] ) ) {
126			return;
127			}
128
129			// Set a default value for variants.
130			if ( ! isset( $value['variant'] ) ) {
131			$value['variant'] = 'regular';
132			}
133			if ( isset( $value['subsets'] ) ) {
134
135			// Add the subset directly to the array of subsets in the Kirki_GoogleFonts_Manager object.
136			// Subsets must be applied to ALL fonts if possible.
137			if ( ! is_array( $value['subsets'] ) ) {
138			$this->subsets[] = $value['subsets'];
139			} else {
140			foreach ( $value['subsets'] as $subset ) {
141			$this->subsets[] = $subset;
142			}
143			}
144			}
145
146			// Add the requested google-font.
147			if ( ! isset( $this->fonts[ $value['font-family'] ] ) ) {
148			$this->fonts[ $value['font-family'] ] = array();
149			}
150			if ( ! in_array( $value['variant'], $this->fonts[ $value['font-family'] ], true ) ) {
151			$this->fonts[ $value['font-family'] ][] = $value['variant'];
152			}
153			// Are we force-loading all variants?
154			if ( true === self::$force_load_all_variants ) {
155			$all_variants = Kirki_Fonts::get_all_variants();
156			$args['choices']['variant'] = array_keys( $all_variants );
157			}
158
159			if ( ! empty( $args['choices']['variant'] ) && is_array( $args['choices']['variant'] ) ) {
160			foreach ( $args['choices']['variant'] as $extra_variant ) {
161			$this->fonts[ $value['font-family'] ][] = $extra_variant;
162			}
163			}
164			} else {
165
166			// Process non-typography fields.
167			if ( isset( $args['output'] ) && is_array( $args['output'] ) ) {
168			foreach ( $args['output'] as $output ) {
169
170			// If we don't have a typography-related output argument we can skip this.
171			if ( ! isset( $output['property'] ) \|\| ! in_array( $output['property'], array( 'font-family', 'font-weight', 'font-subset', 'subset', 'subsets' ), true ) ) {
172			continue;
173			}
174
175			// Get the value.
176			$value = Kirki_Values::get_sanitized_field_value( $args );
177
178			if ( is_string( $value ) ) {
179			if ( 'font-family' === $output['property'] ) {
180			if ( ! array_key_exists( $value, $this->fonts ) ) {
181			$this->fonts[ $value ] = array();
182			}
183			} elseif ( 'font-weight' === $output['property'] ) {
184			foreach ( $this->fonts as $font => $variants ) {
185			if ( ! in_array( $value, $variants, true ) ) {
186			$this->fonts[ $font ][] = $value;
187			}
188			}
189			} elseif ( 'font-subset' === $output['property'] \|\| 'subset' === $output['property'] \|\| 'subsets' === $output['property'] ) {
190			if ( ! is_array( $value ) ) {
191			if ( ! in_array( $value, $this->subsets, true ) ) {
192			$this->subsets[] = $value;
193			}
194			} else {
195			foreach ( $value as $subset ) {
196			if ( ! in_array( $subset, $this->subsets, true ) ) {
197			$this->subsets[] = $subset;
198			}
199			}
200			}
201			}
202			}
203			} // End foreach().
204			} // End if().
205			} // End if().
206			}
207
208			/**
209			* Determines the vbalidity of the selected font as well as its properties.
210			* This is vital to make sure that the google-font script that we'll generate later
211			* does not contain any invalid options.
212			*/
213			public function process_fonts() {
214
215			// Early exit if font-family is empty.
216			if ( empty( $this->fonts ) ) {
217			return;
218			}
219
220			$valid_subsets = array();
221			foreach ( $this->fonts as $font => $variants ) {
222
223			// Determine if this is indeed a google font or not.
224			// If it's not, then just remove it from the array.
225			if ( ! array_key_exists( $font, $this->google_fonts ) ) {
226			unset( $this->fonts[ $font ] );
227			continue;
228			}
229
230			// Get all valid font variants for this font.
231			$font_variants = array();
232			if ( isset( $this->google_fonts[ $font ]['variants'] ) ) {
233			$font_variants = $this->google_fonts[ $font ]['variants'];
234			}
235			foreach ( $variants as $variant ) {
236
237			// If this is not a valid variant for this font-family
238			// then unset it and move on to the next one.
239			if ( ! in_array( $variant, $font_variants, true ) ) {
240			$variant_key = array_search( $variant, $this->fonts[ $font ], true );
241			unset( $this->fonts[ $font ][ $variant_key ] );
242			continue;
243			}
244			}
245
246			// Check if the selected subsets exist, even in one of the selected fonts.
247			// If they don't, then they have to be removed otherwise the link will fail.
248			if ( isset( $this->google_fonts[ $font ]['subsets'] ) ) {
249			foreach ( $this->subsets as $subset ) {
250			if ( in_array( $subset, $this->google_fonts[ $font ]['subsets'], true ) ) {
251			$valid_subsets[] = $subset;
252			}
253			}
254			}
255			}
256			$this->subsets = $valid_subsets;
257			}
258
259			/**
260			* Gets the googlefonts JSON file.
261			*
262			* @since 3.0.17
263			* @return string
			0 ignored issues – show Documentation introduced 2017-11-20 21:14 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
264			*/
265			public function get_googlefonts_json() {
266			echo file_get_contents( wp_normalize_path( dirname( __FILE__ ) . '/webfonts.json' ) ); // WPCS: XSS ok.
			0 ignored issues – show introduced 2017-11-20 21:14 UTC by Report Bug Copy Issue Report file_get_contents is highly discouraged, please use wpcom_vip_file_get_contents() instead. Loading history...
267			exit();
268			}
269			}
270

aristath / kirki

Pull Request — master (#1653)

Kirki_Fonts_Google::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like