alsvanzelf\jsonapi\DataDocument

Complexity

Total Complexity

7

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	addIncludedResourceObject()	0	13	3
A	toArray()	0	14	3

<?php

namespace alsvanzelf\jsonapi;

use alsvanzelf\jsonapi\Document;
use alsvanzelf\jsonapi\exceptions\DuplicateException;
use alsvanzelf\jsonapi\helpers\Validator;
use alsvanzelf\jsonapi\objects\ResourceObject;

/**
 * @see ResourceDocument or CollectionDocument
 */

Missing @link tag in class comment

Missing @license tag in class comment

Missing @author tag in class comment

Missing @package tag in class comment

Missing @category tag in class comment

abstract class DataDocument extends Document {
	/** @var ResourceObject[] */
	protected $includedResources = [];
	/** @var Validator */
	protected $validator;
	
	public function __construct() {

Missing doc comment for function __construct()

		parent::__construct();
		
		$this->validator = new Validator();
	}
	
	/**
	 * human api
	 */
	
	/**
	 * spec api
	 */
	
	/**
	 * mainly used when an `included` query parameter is passed
	 * and resources are requested separate from what is standard for a response
	 * 
	 * @param ResourceObject ...$resourceObjects

Missing parameter comment

	 */

Missing @return tag in function comment

	public function addIncludedResourceObject(ResourceObject ...$resourceObjects) {
		foreach ($resourceObjects as $resourceObject) {
			try {
				$this->validator->claimUsedResourceIdentifier($resourceObject);
			}
			catch (DuplicateException $e) {
				// silently skip duplicates
				continue;
			}
			
			$this->includedResources[] = $resourceObject;
		}
	}
	
	/**
	 * internal api
	 */
	
	/**
	 * DocumentInterface
	 */
	
	/**
	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function toArray() {
		$array = parent::toArray();
		
		$array['data'] = null;
		
		if ($this->includedResources !== []) {
			$array['included'] = [];
			foreach ($this->includedResources as $resource) {
				$array['included'][] = $resource->toArray();
			}
		}
		
		return $array;
	}
}