alsvanzelf\jsonapi\objects\ResourceIdentifierObject

Complexity

Total Complexity

28

Size/Duplication

Total Lines	189
Duplicated Lines	14.81 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	3
A	addMeta()	0	7	2
A	setType()	0	3	1
A	setId()	0	3	1
A	setMetaObject()	0	3	1
A	fromResourceObject()	0	9	2
A	equals()	0	7	3
A	hasIdentification()	0	3	2
A	getIdentificationKey()	0	7	2
A	isEmpty()	13	13	6
A	toArray()	15	15	4
A	getResource()	0	3	1

<?php

namespace alsvanzelf\jsonapi\objects;

use alsvanzelf\jsonapi\exceptions\Exception;
use alsvanzelf\jsonapi\helpers\AtMemberManager;
use alsvanzelf\jsonapi\helpers\Validator;
use alsvanzelf\jsonapi\interfaces\ObjectInterface;
use alsvanzelf\jsonapi\interfaces\ResourceInterface;
use alsvanzelf\jsonapi\objects\MetaObject;

class ResourceIdentifierObject implements ObjectInterface, ResourceInterface {

Missing doc comment for class ResourceIdentifierObject

	use AtMemberManager;
	
	/** @var string */
	protected $type;
	/** @var string */
	protected $id;
	/** @var MetaObject */
	protected $meta;
	/** @var Validator */
	protected $validator;
	
	/**
	 * @note $type and $id are optional to pass during construction
	 *       however they are required for a valid ResourceIdentifierObject
	 *       so use ->setType() and ->setId() if not passing them during construction
	 * 
	 * @param string     $type optional
	 * @param string|int $id   optional
	 */
	public function __construct($type=null, $id=null) {
		$this->validator = new Validator();
		
		if ($type !== null) {
			$this->setType($type);
		}
		if ($id !== null) {
			$this->setId($id);
		}
		
		// always mark as used, as these keys are reserved
		$this->validator->claimUsedFields($fieldNames=['type'], Validator::OBJECT_CONTAINER_TYPE);
		$this->validator->claimUsedFields($fieldNames=['id'], Validator::OBJECT_CONTAINER_ID);
	}
	
	/**
	 * human api
	 */
	
	/**
	 * @param string $key

Missing parameter comment

	 * @param mixed  $value

Missing parameter comment

	 */

Missing @return tag in function comment

	public function addMeta($key, $value) {
		if ($this->meta === null) {
			$this->setMetaObject(new MetaObject());
		}
		
		$this->meta->add($key, $value);
	}
	
	/**
	 * spec api
	 */
	
	/**
	 * @param string $type

Missing parameter comment

	 */

Missing @return tag in function comment

	public function setType($type) {
		$this->type = $type;
	}
	
	/**
	 * @param string|int $id will be casted to a string
	 */

Missing @return tag in function comment

	public function setId($id) {
		$this->id = (string) $id;
	}
	
	/**
	 * @param MetaObject $metaObject

Missing parameter comment

	 */

Missing @return tag in function comment

	public function setMetaObject(MetaObject $metaObject) {
		$this->meta = $metaObject;
	}
	
	/**
	 * internal api
	 */
	
	/**
	 * @internal
	 * 
	 * @param  ResourceObject $resourceObject

Missing parameter comment

	 * @return ResourceIdentifierObject
	 */
	public static function fromResourceObject(ResourceObject $resourceObject) {
		$resourceIdentifierObject = new self($resourceObject->type, $resourceObject->id);

The property id cannot be accessed from this context as it is declared protected in class alsvanzelf\jsonapi\objects\ResourceIdentifierObject.

The property type cannot be accessed from this context as it is declared protected in class alsvanzelf\jsonapi\objects\ResourceIdentifierObject.

		
		if ($resourceObject->meta !== null) {

The property meta cannot be accessed from this context as it is declared protected in class alsvanzelf\jsonapi\objects\ResourceIdentifierObject.

			$resourceIdentifierObject->setMetaObject($resourceObject->meta);

The property meta cannot be accessed from this context as it is declared protected in class alsvanzelf\jsonapi\objects\ResourceIdentifierObject.

		}
		
		return $resourceIdentifierObject;
	}
	
	/**
	 * @internal
	 * 
	 * @param  ResourceInterface $resource

Missing parameter comment

	 * @return boolean
	 * 
	 * @throws Exception if one or both are missing identification
	 */
	public function equals(ResourceInterface $resource) {
		if ($this->hasIdentification() === false || $resource->getResource()->hasIdentification() === false) {
			throw new Exception('can not compare resources if identification is missing');
		}
		
		return ($this->getIdentificationKey() === $resource->getResource()->getIdentificationKey());
	}
	
	/**
	 * @internal
	 * 
	 * @return boolean
	 */
	public function hasIdentification() {
		return ($this->type !== null && $this->id !== null);
	}
	
	/**
	 * get a key to uniquely define this resource
	 * 
	 * @internal
	 * 
	 * @return string
	 * 
	 * @throws Exception if type or id is not set yet
	 */
	public function getIdentificationKey() {
		if ($this->hasIdentification() === false) {
			throw new Exception('resource has no identification yet');
		}
		
		return $this->type.'|'.$this->id;
	}
	
	/**
	 * ObjectInterface
	 */
	
	/**
	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function isEmpty() {

This method seems to be duplicated in your project.

		if ($this->type !== null || $this->id !== null) {
			return false;
		}
		if ($this->meta !== null && $this->meta->isEmpty() === false) {
			return false;
		}
		if ($this->hasAtMembers()) {
			return false;
		}
		
		return true;
	}
	
	/**
	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function toArray() {

This method seems to be duplicated in your project.

		$array = $this->getAtMembers();
		
		$array['type'] = $this->type;
		
		if ($this->id !== null) {
			$array['id'] = $this->id;
		}
		
		if ($this->meta !== null && $this->meta->isEmpty() === false) {
			$array['meta'] = $this->meta->toArray();
		}
		
		return $array;
	}
	
	/**
	 * ResourceInterface
	 */
	
	/**

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

	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function getResource($identifierOnly=false) {
		return $this;
	}
}