alsvanzelf\jsonapi\helpers\Validator

Complexity

Total Complexity

17

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	claimUsedFields()	0	22	6
A	clearUsedFields()	0	9	3
A	claimUsedResourceIdentifier()	0	13	3
A	checkMemberName()	0	22	2
A	checkHttpStatusCode()	0	12	3

<?php

namespace alsvanzelf\jsonapi\helpers;

use alsvanzelf\jsonapi\exceptions\DuplicateException;
use alsvanzelf\jsonapi\exceptions\InputException;
use alsvanzelf\jsonapi\interfaces\ResourceInterface;

/**
 * @internal
 */

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

Missing @category tag in class comment

class Validator {
	const OBJECT_CONTAINER_TYPE          = 'type';
	const OBJECT_CONTAINER_ID            = 'id';
	const OBJECT_CONTAINER_ATTRIBUTES    = 'attributes';
	const OBJECT_CONTAINER_RELATIONSHIPS = 'relationships';
	
	/** @var array */
	protected $usedFields = [];
	/** @var array */
	protected $usedResourceIdentifiers = [];
	/** @var array */
	protected static $defaults = [
		/**
		 * blocks 'type' as a keyword inside attributes or relationships
		 * the specification doesn't allow this as 'type' is already set at the root of a resource
		 * set to true if migrating to jsonapi and currently using 'type' as attribute or relationship
		 */
		'enforceTypeFieldNamespace' => true,
	];
	
	/**

Parameter $fieldNames should have a doc-comment as per coding-style.

	 * block if already existing in another object, otherwise just overwrite
	 * 
	 * @see https://jsonapi.org/format/1.1/#document-resource-object-fields
	 * 
	 * @param  string[] $fieldName

There is no parameter named $fieldName. Did you maybe mean $fieldNames?

Doc comment for parameter $fieldName does not match actual variable name $fieldNames

Missing parameter comment

	 * @param  string   $objectContainer one of the Validator::OBJECT_CONTAINER_* constants
	 * @param  array    $options         optional {@see Validator::$defaults}
	 * 
	 * @throws DuplicateException
	 */

Missing @return tag in function comment

	public function claimUsedFields(array $fieldNames, $objectContainer, array $options=[]) {
		$options = array_merge(self::$defaults, $options);
		
		foreach ($fieldNames as $fieldName) {
			if (isset($this->usedFields[$fieldName]) === false) {
				$this->usedFields[$fieldName] = $objectContainer;
				continue;
			}
			if ($this->usedFields[$fieldName] === $objectContainer) {
				continue;
			}
			
			/**
			 * @note this is not allowed by the specification
			 */
			if ($this->usedFields[$fieldName] === Validator::OBJECT_CONTAINER_TYPE && $options['enforceTypeFieldNamespace'] === false) {
				continue;
			}
			
			throw new DuplicateException('field name "'.$fieldName.'" already in use at "data.'.$this->usedFields[$fieldName].'"');
		}
	}
	
	/**

Parameter $objectContainerToClear should have a doc-comment as per coding-style.

	 * @param string $objectContainer one of the Validator::OBJECT_CONTAINER_* constants

Doc comment for parameter $objectContainer does not match actual variable name $objectContainerToClear

There is no parameter named $objectContainer. Did you maybe mean $objectContainerToClear?

	 */

Missing @return tag in function comment

	public function clearUsedFields($objectContainerToClear) {
		foreach ($this->usedFields as $fieldName => $containerFound) {
			if ($containerFound !== $objectContainerToClear) {
				continue;
			}
			
			unset($this->usedFields[$fieldName]);
		}
	}
	
	/**
	 * @param  ResourceInterface $resource

Missing parameter comment

	 * 
	 * @throws InputException if no type or id has been set on the resource
	 * @throws DuplicateException if the combination of type and id has been set before
	 */

Missing @return tag in function comment

	public function claimUsedResourceIdentifier(ResourceInterface $resource) {
		if ($resource->getResource()->hasIdentification() === false) {
			throw new InputException('can not validate resource without identifier, set type and id first');
		}
		
		$resourceKey = $resource->getResource()->getIdentificationKey();
		if (isset($this->usedResourceIdentifiers[$resourceKey]) === false) {
			$this->usedResourceIdentifiers[$resourceKey] = true;
			return;
		}
		
		throw new DuplicateException('can not have multiple resources with the same identification');
	}
	
	/**
	 * @see https://jsonapi.org/format/1.1/#document-member-names
	 * 
	 * @todo allow non-url safe chars
	 * 
	 * @param  string $memberName

Missing parameter comment

	 * 
	 * @throws InputException
	 */

Missing @return tag in function comment

	public static function checkMemberName($memberName) {
		$globallyAllowedCharacters  = 'a-zA-Z0-9';
		$generallyAllowedCharacters = $globallyAllowedCharacters.'_-';
		
		$regex = '{^
			(
				['.$globallyAllowedCharacters.']
				
				|
				
				['.$globallyAllowedCharacters.']
				['.$generallyAllowedCharacters.']*
				['.$globallyAllowedCharacters.']
			)
		$}x';
		
		if (preg_match($regex, $memberName) === 1) {
			return;
		}
		
		throw new InputException('invalid member name "'.$memberName.'"');
	}
	
	/**
	 * @param  string|int $httpStatusCode

Missing parameter comment

	 * @return boolean
	 */
	public static function checkHttpStatusCode($httpStatusCode) {
		$httpStatusCode = (int) $httpStatusCode;
		
		if ($httpStatusCode < 100) {
			return false;
		}
		if ($httpStatusCode >= 600) {
			return false;
		}
		
		return true;
	}
}