Kirki_Util::get_variables() - Code Metrics - Inspection of "Develop" - aristath/kirki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1553)

by Aristeides

created 2017-10-12 12:50 UTC

Kirki_Util::get_variables() D

↳ Parent: Kirki_Util

Complexity

Conditions	10
Paths	12

Size

Total Lines	38
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	12
nc	12
nop	0
dl	0
loc	38
rs	4.8196
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * A utility class for Kirki.
 *
 * @package     Kirki
 * @category    Core
 * @author      Aristeides Stathopoulos
 * @copyright   Copyright (c) 2017, Aristeides Stathopoulos
 * @license     http://opensource.org/licenses/https://opensource.org/licenses/MIT
 * @since       3.0.9
 */

/**
 * Utility class.
 */
class Kirki_Util {

	/**
	 * Constructor.
	 *
	 * @since 3.0.9
	 * @access public
	 */
	public function __construct() {

		add_filter( 'http_request_args', array( $this, 'http_request' ), 10, 2 );
	}

	/**
	 * Determine if Kirki is installed as a plugin.
	 *
	 * @static
	 * @access public
	 * @since 3.0.0
	 * @return bool
	 */
	public static function is_plugin() {

		$is_plugin = false;
		if ( ! function_exists( 'get_plugins' ) ) {
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
		}

		// Get all plugins.
		$plugins = get_plugins();
		$_plugin = '';
		foreach ( $plugins as $plugin => $args ) {
			if ( ! $is_plugin && isset( $args['Name'] ) && ( 'Kirki' === $args['Name'] || 'Kirki Toolkit' === $args['Name'] ) ) {
				$is_plugin = true;
				$_plugin   = $plugin;
			}
		}

		// No need to proceed any further if Kirki wasn't found in the list of plugins.
		if ( ! $is_plugin ) {
			return false;
		}

		// Make sure the is_plugins_loaded function is loaded.
		include_once ABSPATH . 'wp-admin/includes/plugin.php';

		// Extra logic in case the plugin is installed but not activated.
		if ( $_plugin && ! is_plugin_active( $_plugin ) ) {
			return false;
		}
		return $is_plugin;
	}

	/**
	 * Build the variables.
	 *
	 * @static
	 * @access public
	 * @since 3.0.9
	 * @return array Formatted as array( 'variable-name' => value ).
	 */
	public static function get_variables() {

		$variables = array();

		// Loop through all fields.
		foreach ( Kirki::$fields as $field ) {

			// Check if we have variables for this field.
			if ( isset( $field['variables'] ) && $field['variables'] && ! empty( $field['variables'] ) ) {

				// Loop through the array of variables.
				foreach ( $field['variables'] as $field_variable ) {

					// Is the variable ['name'] defined? If yes, then we can proceed.
					if ( isset( $field_variable['name'] ) ) {

						// Sanitize the variable name.
						$variable_name = esc_attr( $field_variable['name'] );

						// Do we have a callback function defined? If not then set $variable_callback to false.
						$variable_callback = ( isset( $field_variable['callback'] ) && is_callable( $field_variable['callback'] ) ) ? $field_variable['callback'] : false;

						// If we have a variable_callback defined then get the value of the option
						// and run it through the callback function.
						// If no callback is defined (false) then just get the value.
						$variables[ $variable_name ] = Kirki_Values::get_value( $field['settings'] );
						if ( $variable_callback ) {
							$variables[ $variable_name ] = call_user_func( $field_variable['callback'], Kirki_Values::get_value( $field['settings'] ) );
						}
					}
				}
			}
		}

		// Pass the variables through a filter ('kirki/variable') and return the array of variables.
		return apply_filters( 'kirki/variable', $variables );

	}

	/**
	 * HTTP Request injection.
	 *
	 * @access public
	 * @since 3.0.0
	 * @param array  $request The request params.
	 * @param string $url     The request URL.
	 * @return array
	 */
	public function http_request( $request = array(), $url = '' ) {
		// Early exit if installed as a plugin or not a request to wordpress.org,
		// or finally if we don't have everything we need.
		if (
			self::is_plugin() ||
			false === strpos( $url, 'wordpress.org' ) || (
				! isset( $request['body'] ) ||
				! isset( $request['body']['plugins'] ) ||
				! isset( $request['body']['translations'] ) ||
				! isset( $request['body']['locale'] ) ||
				! isset( $request['body']['all'] )
			)
		) {
			return $request;
		}

		$plugins = json_decode( $request['body']['plugins'], true );
		if ( ! isset( $plugins['plugins'] ) ) {
			return $request;
		}
		$exists = false;
		foreach ( $plugins['plugins'] as $plugin ) {
			if ( isset( $plugin['Name'] ) && 'Kirki Toolkit' === $plugin['Name'] ) {
				$exists = true;
			}
		}
		// Inject data.
		if ( ! $exists && defined( 'KIRKI_PLUGIN_FILE' ) ) {
			$plugins['plugins']['kirki/kirki.php'] = get_plugin_data( KIRKI_PLUGIN_FILE );
		}
		$request['body']['plugins'] = wp_json_encode( $plugins );
		return $request;
	}
}


1			<?php
2			/**
3			* A utility class for Kirki.
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			* @since 3.0.9
11			*/
12
13			/**
14			* Utility class.
15			*/
16			class Kirki_Util {
17
18			/**
19			* Constructor.
20			*
21			* @since 3.0.9
22			* @access public
23			*/
24			public function __construct() {
25
26			add_filter( 'http_request_args', array( $this, 'http_request' ), 10, 2 );
27			}
28
29			/**
30			* Determine if Kirki is installed as a plugin.
31			*
32			* @static
33			* @access public
34			* @since 3.0.0
35			* @return bool
36			*/
37			public static function is_plugin() {
38
39			$is_plugin = false;
40			if ( ! function_exists( 'get_plugins' ) ) {
41			require_once ABSPATH . 'wp-admin/includes/plugin.php';
42			}
43
44			// Get all plugins.
45			$plugins = get_plugins();
46			$_plugin = '';
47			foreach ( $plugins as $plugin => $args ) {
48			if ( ! $is_plugin && isset( $args['Name'] ) && ( 'Kirki' === $args['Name'] \|\| 'Kirki Toolkit' === $args['Name'] ) ) {
49			$is_plugin = true;
50			$_plugin = $plugin;
51			}
52			}
53
54			// No need to proceed any further if Kirki wasn't found in the list of plugins.
55			if ( ! $is_plugin ) {
56			return false;
57			}
58
59			// Make sure the is_plugins_loaded function is loaded.
60			include_once ABSPATH . 'wp-admin/includes/plugin.php';
61
62			// Extra logic in case the plugin is installed but not activated.
63			if ( $_plugin && ! is_plugin_active( $_plugin ) ) {
64			return false;
65			}
66			return $is_plugin;
67			}
68
69			/**
70			* Build the variables.
71			*
72			* @static
73			* @access public
74			* @since 3.0.9
75			* @return array Formatted as array( 'variable-name' => value ).
76			*/
77			public static function get_variables() {
78
79			$variables = array();
80
81			// Loop through all fields.
82			foreach ( Kirki::$fields as $field ) {
83
84			// Check if we have variables for this field.
85			if ( isset( $field['variables'] ) && $field['variables'] && ! empty( $field['variables'] ) ) {
86
87			// Loop through the array of variables.
88			foreach ( $field['variables'] as $field_variable ) {
89
90			// Is the variable ['name'] defined? If yes, then we can proceed.
91			if ( isset( $field_variable['name'] ) ) {
92
93			// Sanitize the variable name.
94			$variable_name = esc_attr( $field_variable['name'] );
95
96			// Do we have a callback function defined? If not then set $variable_callback to false.
97			$variable_callback = ( isset( $field_variable['callback'] ) && is_callable( $field_variable['callback'] ) ) ? $field_variable['callback'] : false;
98
99			// If we have a variable_callback defined then get the value of the option
100			// and run it through the callback function.
101			// If no callback is defined (false) then just get the value.
102			$variables[ $variable_name ] = Kirki_Values::get_value( $field['settings'] );
103			if ( $variable_callback ) {
104			$variables[ $variable_name ] = call_user_func( $field_variable['callback'], Kirki_Values::get_value( $field['settings'] ) );
105			}
106			}
107			}
108			}
109			}
110
111			// Pass the variables through a filter ('kirki/variable') and return the array of variables.
112			return apply_filters( 'kirki/variable', $variables );
113
114			}
115
116			/**
117			* HTTP Request injection.
118			*
119			* @access public
120			* @since 3.0.0
121			* @param array $request The request params.
122			* @param string $url The request URL.
123			* @return array
124			*/
125			public function http_request( $request = array(), $url = '' ) {
126			// Early exit if installed as a plugin or not a request to wordpress.org,
127			// or finally if we don't have everything we need.
128			if (
129			self::is_plugin() \|\|
130			false === strpos( $url, 'wordpress.org' ) \|\| (
131			! isset( $request['body'] ) \|\|
132			! isset( $request['body']['plugins'] ) \|\|
133			! isset( $request['body']['translations'] ) \|\|
134			! isset( $request['body']['locale'] ) \|\|
135			! isset( $request['body']['all'] )
136			)
137			) {
138			return $request;
139			}
140
141			$plugins = json_decode( $request['body']['plugins'], true );
142			if ( ! isset( $plugins['plugins'] ) ) {
143			return $request;
144			}
145			$exists = false;
146			foreach ( $plugins['plugins'] as $plugin ) {
147			if ( isset( $plugin['Name'] ) && 'Kirki Toolkit' === $plugin['Name'] ) {
148			$exists = true;
149			}
150			}
151			// Inject data.
152			if ( ! $exists && defined( 'KIRKI_PLUGIN_FILE' ) ) {
153			$plugins['plugins']['kirki/kirki.php'] = get_plugin_data( KIRKI_PLUGIN_FILE );
154			}
155			$request['body']['plugins'] = wp_json_encode( $plugins );
156			return $request;
157			}
158			}
159

aristath / kirki

Pull Request — master (#1553)

Kirki_Util::get_variables() D

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like