Maslosoft\Mangan\Validator

Complexity

Total Complexity

30

Size/Duplication

Total Lines	198
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

97.33%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
C	validateEntity()	0	62	12
A	getErrors()	0	4	1
A	setErrors()	0	7	2
C	validate()	0	78	13

<?php

/**
 * This software package is licensed under AGPL or Commercial license.
 *
 * @package maslosoft/mangan
 * @licence AGPL or Commercial
 * @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
 * @copyright Copyright (c) Maslosoft
 * @copyright Copyright (c) Others as mentioned in code
 * @link https://maslosoft.com/mangan/
 */

namespace Maslosoft\Mangan;

use InvalidArgumentException;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Helpers\Validator\Factory;
use Maslosoft\Mangan\Interfaces\ValidatableInterface;
use Maslosoft\Mangan\Meta\ManganMeta;

/**
 * Validator
 *
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
class Validator implements ValidatableInterface
{

	const EventBeforeValidate = 'beforeValidate';
	const EventAfterValidate = 'afterValidate';

	/**
	 * Model instance
	 * @var AnnotatedInterface
	 */
	private $model = null;

	/**
	 * Metadata for model
	 * @var ManganMeta
	 */
	private $meta = null;

	/**
	 * Array of error messages.
	 * Keys are field names, secondary keys are numeric
	 * @var string[][]
	 */
	private $errors = [];

	public function __construct(AnnotatedInterface $model)
	{
		$this->model = $model;
		$this->meta = ManganMeta::create($this->model);

		// Ensure that errors array is initialized - even if does not have validators
		foreach (array_keys($this->meta->fields()) as $name)
		{
			$this->errors[$name] = [];
		}
	}

	/**
	 * Validate model, optionally only selected fields
	 * @param string[] $fields
	 * @return boolean
	 */
	public function validate($fields = [])
	{
		$valid = [];
		if (empty($fields))
		{
			$fields = array_keys($this->meta->fields());
		}
		foreach ($fields as $name)
		{
			$fieldMeta = $this->meta->field($name);

			// Reset errors
			$this->errors[$name] = [];

			// Check if meta for field exists
			if (empty($fieldMeta))
			{
				throw new InvalidArgumentException(sprintf("Unknown field `%s` in model `%s`", $name, get_class($this->model)));
			}

			// Validate sub documents
			// Skip fields that are not updatable
			if ($fieldMeta->owned && $fieldMeta->updatable)
			{
				if (is_array($this->model->$name))
				{
					// Handle arrays of documents
					foreach ($this->model->$name as $fieldIndex => $model)
					{
						$validator = new Validator($model);
						$isValid = $validator->validate();
						$valid[] = (int) $isValid;
						if (!$isValid)
						{
							$errors = [
								$name => [
									$fieldIndex => $validator->getErrors()
								]
							];
							$this->setErrors($errors);
						}
					}
				}
				elseif (!empty($this->model->$name))
				{
					// Handle single documents
					$validator = new Validator($this->model->$name);
					$isValid = $validator->validate();
					$valid[] = (int) $isValid;
					if (!$isValid)
					{
						$errors = [
							$name => $validator->getErrors()
						];
						$this->setErrors($errors);
					}
				}
			}

			// Skip field without validators
			if (empty($fieldMeta->validators))
			{
				continue;
			}
			$valid[] = (int) $this->validateEntity($name, $fieldMeta->validators);
		}

		// Model validators
		$typeValidators = $this->meta->type()->validators;
		if (!empty($typeValidators))
		{
			$typeName = $this->meta->type()->name;
			// Reset errors
			$this->errors[$typeName] = [];
			$valid[] = (int) $this->validateEntity($typeName, $typeValidators);
		}
		return count($valid) === array_sum($valid);
	}

	private function validateEntity($name, $validators)
	{
		$valid = [];
		foreach ($validators as $validatorMeta)
		{
			// Filter out validators based on scenarios
			if (!empty($validatorMeta->on))
			{
				$on = (array) $validatorMeta->on;
				$enabled = false;
				foreach ($on as $scenario)
				{
					if ($scenario === ScenarioManager::getScenario($this->model))
					{
						$enabled = true;
						break;
					}
				}
				if (!$enabled)
				{
					continue;
				}
			}
			if (!empty($validatorMeta->except))
			{
				$except = (array) $validatorMeta->except;
				$enabled = true;
				foreach ($except as $scenario)
				{
					if ($scenario === ScenarioManager::getScenario($this->model))
					{
						$enabled = false;
						break;
					}
				}
				if (!$enabled)
				{
					continue;
				}
			}


			// Create validator and validate
			$validator = Factory::create($this->model, $validatorMeta, $name);
			if ($validator->isValid($this->model, $name))
			{
				$valid[] = true;
			}
			else
			{
				$valid[] = false;
				$this->errors[$name] = array_merge($this->errors[$name], $validator->getErrors());

				// Set errors to model instance if it implements ValidatableInterface
				if ($this->model instanceof ValidatableInterface)
				{
					$this->model->setErrors($this->errors);
				}
			}
		}
		return count($valid) === array_sum($valid);
	}

	public function getErrors()
	{
		return $this->errors;
	}

	public function setErrors($errors)
	{
		foreach ($errors as $field => $errors)
		{
			$this->errors[$field] = $errors;
		}
	}

}