Predefined_Options_Field::load_options() - Code Metrics - Inspection of "remove unexpected nested array handling of predefi..." - htmlburger/carbon-fields - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — development ( c8ad86...7036a1 )

unknown

created 2017-07-25 07:40 UTC

Predefined_Options_Field::load_options() B

↳ Parent: Predefined_Options_Field

Complexity

Conditions	6
Paths	6

Size

Total Lines	21
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	42

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	15
nc	6
nop	0
dl	0
loc	21
ccs	0
cts	16
cp	0
crap	42
rs	8.7624
c	1
b	0
f	0

<?php

namespace Carbon_Fields\Field;

use Carbon_Fields\Exception\Incorrect_Syntax_Exception;

/**
 * Base class for fields with predefined options.
 * Mainly used to reduce the bloat on the base Field class.
 */
abstract class Predefined_Options_Field extends Field {

	/**
	 * Stores the raw, unprocessed field options
	 *
	 * @var array(array|callable)
	 */
	protected $option_collections = array();

	/**
	 * Check if an array is indexed
	 *
	 * @param  array   $array
	 * @return boolean
	 */
	protected function is_indexed_array( $array ) {
		return array_keys( $array ) === range( 0, count( $array ) - 1 );
	}

	/**
	 * Set the options of this field.
	 * Accepts either array of data or a callback that returns the data.
	 *
	 * @param  array|callable $options
	 * @return Field          $this
	 */
	public function set_options( $options ) {
		if ( ! is_callable( $options ) && ! is_array( $options ) ) {
			Incorrect_Syntax_Exception::raise( 'Only arrays and callbacks are allowed in the <code>set_options()</code> method.' );
			return $this;
		}

		$this->option_collections = array();
		return $this->add_options( $options );
	}

	/**
	 * Add new options to this field.
	 * Accepts either array of data or a callback that returns the data.
	 *
	 * @param  array|callable $options
	 * @return Field          $this
	 */
	public function add_options( $options ) {
		if ( ! is_callable( $options ) && ! is_array( $options ) ) {
			Incorrect_Syntax_Exception::raise( 'Only arrays and callbacks are allowed in the <code>add_options()</code> method.' );
			return $this;
		}

		$this->option_collections[] = $options;
		return $this;
	}

	/**
	 * Get a populated array of options executing any callbacks in the process
	 *
	 * @return array
	 */
	protected function load_options() {
		$options = array();
		foreach ( $this->option_collections as $collection ) {
			$collection_items = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			if ( is_callable( $collection ) ) {
				$collection_items = call_user_func( $collection );
				if ( ! is_array( $collection_items ) ) {
					continue;
				}
			} else {
				$collection_items = $collection;
			}
			if ( $this->is_indexed_array( $options ) && $this->is_indexed_array( $collection_items ) ) {
				$options = array_merge( $options, $collection_items );
			} else {
				$options = array_replace( $options, $collection_items );
			}
		}

		return $options;
	}

	/**
	 * Retrieve the current options.
	 *
	 * @return array|callable $options
	 */
	public function get_options() {
		return $this->load_options();
	}

	/**
	 * Changes the options array structure. This is needed to keep the array items order when it is JSON encoded.
	 * Will also work with a callable that returns an array.
	 *
	 * @param array|callable $options
	 * @return array
	 */
	protected function parse_options( $options ) {
		$parsed = array();

		if ( is_callable( $options ) ) {
			$options = call_user_func( $options );
		}

		foreach ( $options as $key => $value ) {
			$parsed[] = array(
				'name' => $value,
				'value' => $key,
			);
		}

		return $parsed;
	}
}


1		<?php
2
3		namespace Carbon_Fields\Field;
4
5		use Carbon_Fields\Exception\Incorrect_Syntax_Exception;
6
7		/**
8		* Base class for fields with predefined options.
9		* Mainly used to reduce the bloat on the base Field class.
10		*/
11		abstract class Predefined_Options_Field extends Field {
12
13		/**
14		* Stores the raw, unprocessed field options
15		*
16		* @var array(array\|callable)
17		*/
18		protected $option_collections = array();
19
20		/**
21		* Check if an array is indexed
22		*
23		* @param array $array
24		* @return boolean
25		*/
26		protected function is_indexed_array( $array ) {
27		return array_keys( $array ) === range( 0, count( $array ) - 1 );
28		}
29
30		/**
31		* Set the options of this field.
32		* Accepts either array of data or a callback that returns the data.
33		*
34		* @param array\|callable $options
35		* @return Field $this
36		*/
37	9	public function set_options( $options ) {
38	9	if ( ! is_callable( $options ) && ! is_array( $options ) ) {
39	4	Incorrect_Syntax_Exception::raise( 'Only arrays and callbacks are allowed in the <code>set_options()</code> method.' );
40		return $this;
41		}
42
43	5	$this->option_collections = array();
44	5	return $this->add_options( $options );
45		}
46
47		/**
48		* Add new options to this field.
49		* Accepts either array of data or a callback that returns the data.
50		*
51		* @param array\|callable $options
52		* @return Field $this
53		*/
54	13	public function add_options( $options ) {
55	13	if ( ! is_callable( $options ) && ! is_array( $options ) ) {
56	4	Incorrect_Syntax_Exception::raise( 'Only arrays and callbacks are allowed in the <code>add_options()</code> method.' );
57		return $this;
58		}
59
60	9	$this->option_collections[] = $options;
61	9	return $this;
62		}
63
64		/**
65		* Get a populated array of options executing any callbacks in the process
66		*
67		* @return array
68		*/
69		protected function load_options() {
70		$options = array();
71		foreach ( $this->option_collections as $collection ) {
72		$collection_items = array();
		1 ignored issue – show Unused Code introduced 2017-07-25 07:42 UTC by Report Bug Copy Issue Report `$collection_items` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
73		if ( is_callable( $collection ) ) {
74		$collection_items = call_user_func( $collection );
75		if ( ! is_array( $collection_items ) ) {
76		continue;
77		}
78		} else {
79		$collection_items = $collection;
80		}
81		if ( $this->is_indexed_array( $options ) && $this->is_indexed_array( $collection_items ) ) {
82		$options = array_merge( $options, $collection_items );
83		} else {
84		$options = array_replace( $options, $collection_items );
85		}
86		}
87
88		return $options;
89		}
90
91		/**
92		* Retrieve the current options.
93		*
94		* @return array\|callable $options
95		*/
96	13	public function get_options() {
97	13	return $this->load_options();
98		}
99
100		/**
101		* Changes the options array structure. This is needed to keep the array items order when it is JSON encoded.
102		* Will also work with a callable that returns an array.
103		*
104		* @param array\|callable $options
105		* @return array
106		*/
107		protected function parse_options( $options ) {
108		$parsed = array();
109
110		if ( is_callable( $options ) ) {
111		$options = call_user_func( $options );
112		}
113
114		foreach ( $options as $key => $value ) {
115		$parsed[] = array(
116		'name' => $value,
117		'value' => $key,
118		);
119		}
120
121		return $parsed;
122		}
123		}
124

htmlburger / carbon-fields

Push — development ( c8ad86...7036a1 )

Predefined_Options_Field::load_options() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like