FigTree\Validation\AbstractFilter

Complexity

Total Complexity

17

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	filterArray()	0	13	3
A	getDefinition()	0	9	2
A	filterInputArray()	0	13	3
A	getDefinitions()	0	5	1
A	getRule()	0	5	1
A	setRuleFactory()	0	5	1
A	filterValue()	0	15	3
A	filterInput()	0	15	3

<?php

namespace FigTree\Validation;

use FigTree\Validation\Contracts\{
	FilterInterface,
	RuleFactoryInterface,
	RuleInterface
};
use FigTree\Validation\Exceptions\InvalidRuleException;

abstract class AbstractFilter implements FilterInterface
{
	protected RuleFactoryInterface $ruleFactory;

	/**
	 * Set or remove a RuleFactory.
	 *
	 * @param \FigTree\Validation\Contracts\RuleFactoryInterface $ruleFactory
	 *
	 * @return $this
	 */
	public function setRuleFactory(RuleFactoryInterface $ruleFactory): FilterInterface
	{
		$this->ruleFactory = $ruleFactory;

		return $this;
	}

	/**
	 * Filter a single value against the Filter.
	 *
	 * @param string $field
	 * @param mixed $value
	 *
	 * @return mixed
	 */
	public function filterValue(string $field, mixed $value, $default = null): mixed
	{
		$definition = $this->getDefinition($field);

		if (empty($definition)) {
			return $default;
		}

		$filter = $definition['filter'];

		if (empty($filter)) {
			throw new InvalidRuleException($this->getRule($field));

It seems like $this->getRule($field) can also be of type null; however, parameter $rule of FigTree\Validation\Exceptions\InvalidRuleException::__construct() does only seem to accept FigTree\Validation\Contracts\RuleInterface, maybe add an additional type check?

		}

		return filter_var($value, $filter, $definition);
	}

	/**
	 * Filter a single input field against the Filter.
	 *
	 * @param integer $type
	 * @param string $field
	 *
	 * @return mixed
	 */
	public function filterInput(int $type, string $field, $default = null): mixed
	{
		$definition = $this->getDefinition($field);

		if (empty($definition)) {
			return $default;
		}

		$filter = $definition['filter'];

		if (empty($filter)) {
			throw new InvalidRuleException($this->getRule($field));

It seems like $this->getRule($field) can also be of type null; however, parameter $rule of FigTree\Validation\Exceptions\InvalidRuleException::__construct() does only seem to accept FigTree\Validation\Contracts\RuleInterface, maybe add an additional type check?

		}

		return filter_input($type, $field, $filter, $definition);
	}

	/**
	 * Filter an array of values against the Filter.
	 *
	 * @param array $data
	 * @param boolean $addEmpty
	 *
	 * @return mixed
	 */
	public function filterArray(array $data, bool $addEmpty = true): array
	{
		$definitions = $this->getDefinitions();

		$input = filter_var_array($data, $definitions, $addEmpty);

		if (!is_array($input)) {
			$input = ($addEmpty)
				? array_fill_keys(array_keys($definitions), null)
				: [];
		}

		return $input;
	}

	/**
	 * Filter an array of input values against the Filter.
	 *
	 * @param integer $type
	 * @param boolean $addEmpty
	 *
	 * @return mixed
	 */
	public function filterInputArray(int $type, bool $addEmpty = true): array
	{
		$definitions = $this->getDefinitions();

		$input = filter_input_array($type, $definitions, $addEmpty);

		if (!is_array($input)) {
			$input = ($addEmpty)
				? array_fill_keys(array_keys($definitions), null)
				: [];
		}

		return $input;
	}

	/**
	 * Get a single Rule.
	 *
	 * @param string $field
	 *
	 * @return \FigTree\Validation\Contracts\RuleInterface|null
	 */
	protected function getRule(string $field): ?RuleInterface
	{
		$rules = $this->getRules();

		return $rules[$field] ?? null;
	}

	/**
	 * Get a single Rule as a native filter definition.
	 *
	 * @param string $field
	 *
	 * @return array|null
	 */
	protected function getDefinition(string $field): ?array
	{
		$rule = $this->getRule($field);

		if (!($rule instanceof RuleInterface)) {
			return null;
		}

		return $rule->toArray();
	}

	/**
	 * Get the Rules as a native filter definition.
	 *
	 * @return array
	 */
	protected function getDefinitions(): array
	{
		return array_map(
			fn (RuleInterface $rule) => $rule->toArray(),
			$this->getRules()
		);
	}
}