Field::normalizeDependsOn() - Code Metrics - Inspection of "settings now work" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ceec33...d1be46 )

by Paul

created 2018-05-31 19:15 UTC

Field::normalizeDependsOn() A

↳ Parent: Field

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
eloc	8
nc	2
nop	0
dl	0
loc	10
ccs	0
cts	10
cp	0
crap	12
rs	9.4285
c	0
b	0
f	0

<?php

namespace GeminiLabs\SiteReviews\Modules\Html;

use GeminiLabs\SiteReviews\Database\OptionManager;
use GeminiLabs\SiteReviews\Helper;
use GeminiLabs\SiteReviews\Modules\Html\Builder;
use GeminiLabs\SiteReviews\Modules\Html\Template;

class Field
{
	const MULTI_FIELD_TYPES = ['radio', 'checkbox'];

	/**
	 * @var array
	 */
	public $field;

	public function __construct( array $field = [] )
	{
		$this->field = wp_parse_args( $field, [
			'is_hidden' => false,
			'is_multi' => false,
			'is_valid' => true,
			'path' => '',
		]);
		$this->normalize();
	}

	/**
	 * @return string
	 */
	public function build()
	{
		if( !$this->field['is_valid'] )return;
		if( $this->field['is_multi'] ) {
			return $this->buildMultiField();
		}
		$this->field['data-depends'] = $this->getFieldDependsOn();
		return glsr( Template::class )->build( 'partials/settings/form-table-row', [
			'context' => [
				'class' => $this->getFieldClass(),
				'field' => glsr( Builder::class )->{$this->field['type']}( $this->field ),
				'label' => glsr( Builder::class )->label( $this->field['legend'], ['for' => $this->field['id']] ),
			],
		]);
	}

	/**
	 * @return void
	 */
	public function render()
	{
		echo $this->build();
	}

	/**
	 * @return string
	 */
	protected function buildMultiField()
	{
		return glsr( Template::class )->build( 'partials/settings/form-table-row-multiple', [
			'context' => [
				'class' => $this->getFieldClass(),
				'depends_on' => $this->getFieldDependsOn(),
				'field' => glsr( Builder::class )->{$this->field['type']}( $this->field ),
				'label' => glsr( Builder::class )->label( $this->field['legend'], ['for' => $this->field['id']] ),
				'legend' => $this->field['legend'],
			],
		]);
	}

	/**
	 * @return string
	 */
	protected function getFieldClass()
	{
		return $this->field['is_hidden']
			? 'hidden'
			: '';
	}

	/**
	 * @return string
	 */
	protected function getFieldDefault()
	{
		return isset( $this->field['default'] )
			? $this->field['default']
			: '';
	}

	/**
	 * @return string
	 */
	protected function getFieldDependsOn()
	{
		return !empty( $this->field['depends_on'] )
			? $this->field['depends_on']
			: '';
	}

	/**
	 * @param string $path
	 * @param string $expectedValue
	 * @return bool
	 */
	protected function isFieldHidden( $path, $expectedValue )
	{
		$optionValue = glsr( OptionManager::class )->get(
			$path,
			glsr( Helper::class )->getPathValue( $path, glsr()->defaults )
		);
		if( is_array( $expectedValue )) {

			return !in_array( $optionValue, $expectedValue );
		}
		return $optionValue != $expectedValue;
	}

	/**
	 * @return bool
	 */
	protected function isFieldValid()
	{
		$isValid = true;
		$missingValues = [];
		$requiredValues = [
			'label', 'name', 'type',
		];
		foreach( $requiredValues as $value ) {
			if( isset( $this->field[$value] ))continue;
			$missingValues[] = $value;
			$isValid = $this->field['is_valid'] = false;
		}
		if( !empty( $missingValues )) {
			glsr_log()
				->warning( 'Field is missing: '.implode( ', ', $missingValues ))
				->info( $this->field );
		}
		return $isValid;
	}

	/**
	 * @return void
	 */
	protected function normalize()
	{
		if( !$this->isFieldValid() )return;
		$field = $this->field;
		foreach( $field as $key => $value ) {
			$methodName = glsr( Helper::class )->buildMethodName( $key, 'normalize' );
			if( !method_exists( $this, $methodName ))continue;
			$this->$methodName();
		}
		$this->normalizeFieldId();
		$this->normalizeFieldType();
		$this->normalizeFieldValue();
	}

	/**
	 * @return void
	 */
	protected function normalizeDependsOn()
	{
		if( empty( $this->field['depends_on'] ) || !is_array( $this->field['depends_on'] ))return;
		$path = key( $this->field['depends_on'] );
		$value = $this->field['depends_on'][$path];
		$this->field['depends_on'] = json_encode([
			'name' => glsr( Helper::class )->convertPathToName( $path, OptionManager::databaseKey() ),
			'value' => $value,
		], JSON_HEX_APOS|JSON_HEX_QUOT );
		$this->field['is_hidden'] = $this->isFieldHidden( $path, $value );
	}

	/**
	 * @return void
	 */
	protected function normalizeFieldId()
	{
		if( isset( $this->field['id'] ))return;
		$this->field['id'] = glsr( Helper::class )->convertNameToId( $this->field['name'] );
	}

	/**
	 * @return void
	 */
	protected function normalizeFieldType()
	{
		$className = glsr( Helper::class )->buildClassName( $this->field['type'], 'Modules\Html\Fields' );
		if( class_exists( $className )) {
			$this->field = array_merge( $this->field, glsr( $className )->defaults() );
			$this->field = array_merge( $this->field, glsr( $className )->/** @scrutinizer ignore-call */ defaults() );
		}
		if( in_array( $this->field['type'], static::MULTI_FIELD_TYPES )) {
			$this->field['is_multi'] = true;
		}
	}

	/**
	 * @return void
	 */
	protected function normalizeFieldValue()
	{
		if( isset( $this->field['value'] ))return;
		$this->field['value'] = glsr( OptionManager::class )->get(
			$this->field['path'],
			$this->getFieldDefault()
		);
	}

	/**
	 * @return void
	 */
	protected function normalizeLabel()
	{
		$this->field['legend'] = $this->field['label'];
		unset( $this->field['label'] );
	}

	/**
	 * @return void
	 */
	protected function normalizeName()
	{
		$this->field['path'] = $this->field['name'];
		$this->field['name'] = glsr( Helper::class )->convertPathToName(
			$this->field['name'],
			OptionManager::databaseKey()
		);
	}
}


pryley / site-reviews

Push — master ( ceec33...d1be46 )

Field::normalizeDependsOn() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like