alsvanzelf\jsonapi\CollectionDocument

Complexity

Total Complexity

16

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	fromResources()	0	9	2
A	add()	0	8	2
A	setPaginationLinks()	0	14	5
A	addResource()	0	15	4
A	toArray()	0	10	2
A	getContainedResources()	0	3	1

<?php

namespace alsvanzelf\jsonapi;

use alsvanzelf\jsonapi\DataDocument;
use alsvanzelf\jsonapi\Document;
use alsvanzelf\jsonapi\exceptions\InputException;
use alsvanzelf\jsonapi\interfaces\PaginableInterface;
use alsvanzelf\jsonapi\interfaces\RecursiveResourceContainerInterface;
use alsvanzelf\jsonapi\interfaces\ResourceContainerInterface;
use alsvanzelf\jsonapi\interfaces\ResourceInterface;
use alsvanzelf\jsonapi\objects\ResourceObject;
use alsvanzelf\jsonapi\objects\ResourceIdentifierObject;

/**
 * this document is a set of Resources
 * this document should be used if there could be multiple, also if only one or even none is returned
 */

Missing @category tag in class comment

Missing @link tag in class comment

Missing @license tag in class comment

Missing @author tag in class comment

Missing @package tag in class comment

class CollectionDocument extends DataDocument implements PaginableInterface, ResourceContainerInterface {
	/** @var ResourceInterface[] */
	protected $resources = [];
	/** @var array */
	protected static $defaults = [
		/**
		 * add resources inside relationships to /included when adding resources to the collection
		 */
		'includeContainedResources' => true,
	];
	
	/**
	 * human api
	 */
	
	/**
	 * generate a CollectionDocument from one or multiple resources
	 * 
	 * adds included resources if found inside the resource's relationships, use {@see ->addResource()} to change that behavior
	 * 
	 * @param  ResourceInterface ...$resources

Missing parameter comment

	 * @return CollectionDocument
	 */
	public static function fromResources(ResourceInterface ...$resources) {
		$collectionDocument = new self();
		
		foreach ($resources as $resource) {
			$collectionDocument->addResource($resource);
		}
		
		return $collectionDocument;
	}
	
	/**
	 * @param string     $type

Missing parameter comment

	 * @param string|int $id

Missing parameter comment

	 * @param array      $attributes optional, if given a ResourceObject is added, otherwise a ResourceIdentifierObject is added
	 */

Missing @return tag in function comment

	public function add($type, $id, array $attributes=[]) {
		if ($attributes === []) {
			$this->addResource(new ResourceIdentifierObject($type, $id));
		}
		else {
			$this->addResource(ResourceObject::fromArray($attributes, $type, $id));
		}
	}
	
	/**

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

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

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

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

	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function setPaginationLinks($previousHref=null, $nextHref=null, $firstHref=null, $lastHref=null) {
		if ($previousHref !== null) {
			$this->addLink('prev', $previousHref);
		}
		if ($nextHref !== null) {
			$this->addLink('next', $nextHref);
		}
		if ($firstHref !== null) {
			$this->addLink('first', $firstHref);
		}
		if ($lastHref !== null) {
			$this->addLink('last', $lastHref);
		}
	}
	
	/**
	 * spec api
	 */
	
	/**
	 * add a resource to the collection
	 * 
	 * adds included resources if found inside the resource's relationships, unless $options['includeContainedResources'] is set to false
	 * 
	 * @param ResourceInterface $resource

Missing parameter comment

	 * @param array             $options  optional {@see CollectionDocument::$defaults}
	 * 
	 * @throws InputException if the resource is empty
	 */

Missing @return tag in function comment

	public function addResource(ResourceInterface $resource, array $options=[]) {
		if ($resource->getResource()->isEmpty()) {
			throw new InputException('does not make sense to add empty resources to a collection');
		}
		
		$options = array_merge(self::$defaults, $options);
		
		$this->validator->claimUsedResourceIdentifier($resource);
		
		$this->resources[] = $resource;
		
		if ($options['includeContainedResources'] && $resource instanceof RecursiveResourceContainerInterface) {
			$this->addIncludedResourceObject(...$resource->getNestedContainedResourceObjects());
		}
	}
	
	/**
	 * DocumentInterface
	 */
	
	/**
	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function toArray() {
		$array = parent::toArray();
		
		$array['data'] = [];
		foreach ($this->resources as $resource) {
			$array['data'][] = $resource->getResource()->toArray();
		}
		
		return $array;
	}
	
	/**
	 * ResourceContainerInterface
	 */
	
	/**
	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function getContainedResources() {
		return $this->resources;
	}
}