ButtonGenerator::normalizeTextbox() - Code Metrics - Inspection of "fix tests" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8a0962...507d84 )

by Paul

created 2018-07-31 02:45 UTC

ButtonGenerator::normalizeTextbox() A

↳ Parent: ButtonGenerator

Complexity

Conditions	1
Paths	1

Size

Total Lines	15
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	13
nc	1
nop	1
dl	0
loc	15
ccs	3
cts	3
cp	1
crap	1
rs	9.8333
c	0
b	0
f	0

<?php

namespace GeminiLabs\SiteReviews\Shortcodes;

use GeminiLabs\SiteReviews\Database;
use GeminiLabs\SiteReviews\Shortcodes\ButtonGenerator;

abstract class ButtonGenerator
{
	/**
	 * @var array
	 */
	public $properties;

	/**
	 * @var string
	 */
	public $tag;

	/**
	 * @var array
	 */
	protected $errors = [];

	/**
	 * @var array
	 */
	protected $required = [];

	/**
	 * @return array
	 */
	abstract public function fields();

	/**
	 * @param string $tag
	 * @return static
	 */
	public function register( $tag, array $args )
	{
		$this->tag = $tag;
		$this->properties = wp_parse_args( $args, [
			'btn_close' => esc_html__( 'Close', 'site-reviews' ),
			'btn_okay' => esc_html__( 'Insert Shortcode', 'site-reviews' ),
			'errors' => $this->errors,
			'fields' => $this->getFields(),
			'label' => '['.$tag.']',
			'required' => $this->required,
			'title' => esc_html__( 'Shortcode', 'site-reviews' ),
		]);
		return $this;
	}

	/**
	 * @return array
	 */
	protected function generateFields( array $fields )
	{
		$generatedFields = array_map( function( $field ) {
			if( empty( $field ))return;
			$field = $this->normalize( $field );
			if( !method_exists( $this, $method = 'normalize'.ucfirst( $field['type'] )))return;
			return $this->$method( $field );
		}, $fields );
		return array_values( array_filter( $generatedFields ));
	}

	/**
	 * @return array
	 */
	protected function getFields()
	{
		$fields = $this->generateFields( $this->fields() );
		if( !empty( $this->errors )) {
			$errors = [];
			foreach( $this->required as $name => $alert ) {
				if( false !== array_search( $name, array_column( $fields, 'name' )))continue;
				$errors[] = $this->errors[$name];
			}
			$this->errors = $errors;
		}
		return empty( $this->errors )
			? $fields
			: $this->errors;
	}

	/**
	 * @return array
	 */
	protected function normalize( array $field )
	{
		return wp_parse_args( $field, [
			'items' => [],
			'type' => '',
		]);
	}

	/**
	 * @return void|array
	 */
	protected function normalizeCheckbox( array $field )
	{
		return $this->normalizeField( $field, [
			'checked' => false,
			'label' => '',
			'minHeight' => '',
			'minWidth' => '',
			'name' => false,
			'text' => '',
			'tooltip' => '',
			'type' => '',
			'value' => '',
		]);
	}

	/**
	 * @return void|array
	 */
	protected function normalizeContainer( array $field )
	{
		if( !array_key_exists( 'html', $field ) && !array_key_exists( 'items', $field ))return;
		$field['items'] = $this->generateFields( $field['items'] );
		return $field;
	}

	/**
	 * @return void|array
	 */
	protected function normalizeField( array $field, array $defaults )
	{
		if( !$this->validate( $field ))return;
		return array_filter( shortcode_atts( $defaults, $field ), function( $value ) {
			return $value !== '';
		});
	}

	/**
	 * @return void|array
	 */
	protected function normalizeListbox( array $field )
	{
		$listbox = $this->normalizeField( $field, [
			'label' => '',
			'minWidth' => '',
			'name' => false,
			'options' => [],
			'placeholder' => esc_attr__( '- Select -', 'site-reviews' ),
			'tooltip' => '',
			'type' => '',
			'value' => '',
		]);
		if( !is_array( $listbox ))return;
		if( !array_key_exists( '', $listbox['options'] )) {
			$listbox['options'] = ['' => $listbox['placeholder']] + $listbox['options'];
		}
		foreach( $listbox['options'] as $value => $text ) {
			$listbox['values'][] = [
				'text' => $text,
				'value' => $value,
			];
		}
		return $listbox;
	}

	/**
	 * @return void|array
	 */
	protected function normalizePost( array $field )
	{
		if( !is_array( $field['query_args'] )) {
			$field['query_args'] = [];
		}
		$posts = get_posts( wp_parse_args( $field['query_args'], [
			'order' => 'ASC',
			'orderby' => 'title',
			'post_type' => 'post',
			'posts_per_page' => 30,
		]));
		if( !empty( $posts )) {
			$options = [];
			foreach( $posts as $post ) {
				$options[$post->ID] = esc_html( $post->post_title );
			}
			$field['options'] = $options;
			$field['type'] = 'listbox';
			return $this->normalizeListbox( $field );
		}
		$this->validate( $field );
	}

	/**
	 * @return void|array
	 */
	protected function normalizeTextbox( array $field )
	{
		return $this->normalizeField( $field, [
			'hidden' => false,
			'label' => '',
			'maxLength' => '',
			'minHeight' => '',
			'minWidth' => '',
			'multiline' => false,
			'name' => false,
			'size' => '',
			'text' => '',
			'tooltip' => '',
			'type' => '',
			'value' => '',
		]);
	}

	/**
	 * @return bool
	 */
	protected function validate( array $field )
	{
		$args = shortcode_atts([
			'label' => '',
			'name' => false,
			'required' => false,
		], $field );
		if( !$args['name'] ) {
			return false;
		}
		return $this->validateErrors( $args ) && $this->validateRequired( $args );
	}

	/**
	 * @return bool
	 */
	protected function validateErrors( array $args )
	{
		if( !isset( $args['required']['error'] )) {
			return true;
		}
		$this->errors[$args['name']] = $this->normalizeContainer([
			'html' => $args['required']['error'],
			'type' => 'container',
		]);
		return false;
	}

	/**
	 * @return bool
	 */
	protected function validateRequired( array $args )
	{
		if( $args['required'] == false ) {
			return true;
		}
		$alert = esc_html__( 'Some of the shortcode options are required.', 'site-reviews' );
		if( isset( $args['required']['alert'] )) {
			$alert = $args['required']['alert'];
		}
		else if( !empty( $args['label'] )) {
			$alert = sprintf(
				esc_html_x( 'The "%s" option is required.', 'the option label', 'site-reviews' ),
				str_replace( ':', '', $args['label'] )
			);
		}
		$this->required[$args['name']] = $alert;
		return false;
	}
}


1		<?php
2
3		namespace GeminiLabs\SiteReviews\Shortcodes;
4
5		use GeminiLabs\SiteReviews\Database;
6		use GeminiLabs\SiteReviews\Shortcodes\ButtonGenerator;
7
8		abstract class ButtonGenerator
9		{
10		/**
11		* @var array
12		*/
13		public $properties;
14
15		/**
16		* @var string
17		*/
18		public $tag;
19
20		/**
21		* @var array
22		*/
23		protected $errors = [];
24
25		/**
26		* @var array
27		*/
28		protected $required = [];
29
30		/**
31		* @return array
32		*/
33		abstract public function fields();
34
35		/**
36		* @param string $tag
37		* @return static
38		*/
39	1	public function register( $tag, array $args )
40		{
41	1	$this->tag = $tag;
42	1	$this->properties = wp_parse_args( $args, [
43	1	'btn_close' => esc_html__( 'Close', 'site-reviews' ),
44	1	'btn_okay' => esc_html__( 'Insert Shortcode', 'site-reviews' ),
45	1	'errors' => $this->errors,
46	1	'fields' => $this->getFields(),
47	1	'label' => '['.$tag.']',
48	1	'required' => $this->required,
49	1	'title' => esc_html__( 'Shortcode', 'site-reviews' ),
50		]);
51	1	return $this;
52		}
53
54		/**
55		* @return array
56		*/
57		protected function generateFields( array $fields )
58		{
59	1	$generatedFields = array_map( function( $field ) {
60	1	if( empty( $field ))return;
61	1	$field = $this->normalize( $field );
62	1	if( !method_exists( $this, $method = 'normalize'.ucfirst( $field['type'] )))return;
63	1	return $this->$method( $field );
64	1	}, $fields );
65	1	return array_values( array_filter( $generatedFields ));
66		}
67
68		/**
69		* @return array
70		*/
71	1	protected function getFields()
72		{
73	1	$fields = $this->generateFields( $this->fields() );
74	1	if( !empty( $this->errors )) {
75		$errors = [];
76		foreach( $this->required as $name => $alert ) {
77		if( false !== array_search( $name, array_column( $fields, 'name' )))continue;
78		$errors[] = $this->errors[$name];
79		}
80		$this->errors = $errors;
81		}
82	1	return empty( $this->errors )
83	1	? $fields
84	1	: $this->errors;
85		}
86
87		/**
88		* @return array
89		*/
90	1	protected function normalize( array $field )
91		{
92	1	return wp_parse_args( $field, [
93	1	'items' => [],
94		'type' => '',
95		]);
96		}
97
98		/**
99		* @return void\|array
100		*/
101	1	protected function normalizeCheckbox( array $field )
102		{
103	1	return $this->normalizeField( $field, [
104	1	'checked' => false,
105		'label' => '',
106		'minHeight' => '',
107		'minWidth' => '',
108		'name' => false,
109		'text' => '',
110		'tooltip' => '',
111		'type' => '',
112		'value' => '',
113		]);
114		}
115
116		/**
117		* @return void\|array
118		*/
119	1	protected function normalizeContainer( array $field )
120		{
121	1	if( !array_key_exists( 'html', $field ) && !array_key_exists( 'items', $field ))return;
122	1	$field['items'] = $this->generateFields( $field['items'] );
123	1	return $field;
124		}
125
126		/**
127		* @return void\|array
128		*/
129	1	protected function normalizeField( array $field, array $defaults )
130		{
131	1	if( !$this->validate( $field ))return;
132	1	return array_filter( shortcode_atts( $defaults, $field ), function( $value ) {
133	1	return $value !== '';
134	1	});
135		}
136
137		/**
138		* @return void\|array
139		*/
140	1	protected function normalizeListbox( array $field )
141		{
142	1	$listbox = $this->normalizeField( $field, [
143	1	'label' => '',
144	1	'minWidth' => '',
145		'name' => false,
146		'options' => [],
147	1	'placeholder' => esc_attr__( '- Select -', 'site-reviews' ),
148	1	'tooltip' => '',
149	1	'type' => '',
150	1	'value' => '',
151		]);
152	1	if( !is_array( $listbox ))return;
153	1	if( !array_key_exists( '', $listbox['options'] )) {
154	1	$listbox['options'] = ['' => $listbox['placeholder']] + $listbox['options'];
155		}
156	1	foreach( $listbox['options'] as $value => $text ) {
157	1	$listbox['values'][] = [
158	1	'text' => $text,
159	1	'value' => $value,
160		];
161		}
162	1	return $listbox;
163		}
164
165		/**
166		* @return void\|array
167		*/
168		protected function normalizePost( array $field )
169		{
170		if( !is_array( $field['query_args'] )) {
171		$field['query_args'] = [];
172		}
173		$posts = get_posts( wp_parse_args( $field['query_args'], [
174		'order' => 'ASC',
175		'orderby' => 'title',
176		'post_type' => 'post',
177		'posts_per_page' => 30,
178		]));
179		if( !empty( $posts )) {
180		$options = [];
181		foreach( $posts as $post ) {
182		$options[$post->ID] = esc_html( $post->post_title );
183		}
184		$field['options'] = $options;
185		$field['type'] = 'listbox';
186		return $this->normalizeListbox( $field );
187		}
188		$this->validate( $field );
189		}
190
191		/**
192		* @return void\|array
193		*/
194	1	protected function normalizeTextbox( array $field )
195		{
196	1	return $this->normalizeField( $field, [
197	1	'hidden' => false,
198		'label' => '',
199		'maxLength' => '',
200		'minHeight' => '',
201		'minWidth' => '',
202		'multiline' => false,
203		'name' => false,
204		'size' => '',
205		'text' => '',
206		'tooltip' => '',
207		'type' => '',
208		'value' => '',
209		]);
210		}
211
212		/**
213		* @return bool
214		*/
215	1	protected function validate( array $field )
216		{
217	1	$args = shortcode_atts([
218	1	'label' => '',
219		'name' => false,
220		'required' => false,
221	1	], $field );
222	1	if( !$args['name'] ) {
223		return false;
224		}
225	1	return $this->validateErrors( $args ) && $this->validateRequired( $args );
226		}
227
228		/**
229		* @return bool
230		*/
231	1	protected function validateErrors( array $args )
232		{
233	1	if( !isset( $args['required']['error'] )) {
234	1	return true;
235		}
236		$this->errors[$args['name']] = $this->normalizeContainer([
237		'html' => $args['required']['error'],
238		'type' => 'container',
239		]);
240		return false;
241		}
242
243		/**
244		* @return bool
245		*/
246	1	protected function validateRequired( array $args )
247		{
248	1	if( $args['required'] == false ) {
249	1	return true;
250		}
251		$alert = esc_html__( 'Some of the shortcode options are required.', 'site-reviews' );
252		if( isset( $args['required']['alert'] )) {
253		$alert = $args['required']['alert'];
254		}
255		else if( !empty( $args['label'] )) {
256		$alert = sprintf(
257		esc_html_x( 'The "%s" option is required.', 'the option label', 'site-reviews' ),
258		str_replace( ':', '', $args['label'] )
259		);
260		}
261		$this->required[$args['name']] = $alert;
262		return false;
263		}
264		}
265

pryley / site-reviews

Push — master ( 8a0962...507d84 )

ButtonGenerator::normalizeTextbox() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like