alsvanzelf\jsonapi\objects\LinksArray

Complexity

Total Complexity

13

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	fromArray()	0	9	2
A	fromObject()	0	5	1
A	add()	0	8	2
A	addLinkString()	0	3	1
A	addLinkObject()	0	3	1
A	isEmpty()	0	3	1
A	toArray()	0	14	5

<?php

namespace alsvanzelf\jsonapi\objects;

use alsvanzelf\jsonapi\helpers\Converter;
use alsvanzelf\jsonapi\interfaces\ObjectInterface;
use alsvanzelf\jsonapi\objects\LinkObject;

/**
 * an array of links (strings and LinkObjects), used for:
 * - type links in an ErrorObject
 * - profile links at root level
 */

Missing @author tag in class comment

Missing @package tag in class comment

Missing @category tag in class comment

Missing @link tag in class comment

Missing @license tag in class comment

class LinksArray implements ObjectInterface {
	/** @var array with string|LinkObject */
	protected $links = [];
	
	/**
	 * human api
	 */
	
	/**
	 * @param  string[] $hrefs

Missing parameter comment

	 * @return LinksArray
	 */
	public static function fromArray(array $hrefs) {
		$linksArray = new self();
		
		foreach ($hrefs as $href) {
			$linksArray->add($href);
		}
		
		return $linksArray;
	}
	
	/**
	 * @param  object $hrefs

Missing parameter comment

	 * @return LinksArray
	 */
	public static function fromObject($hrefs) {
		$array = Converter::objectToArray($hrefs);
		
		return self::fromArray($array);
	}
	
	/**
	 * @param string $href

Missing parameter comment

	 * @param array  $meta optional, if given a LinkObject is added, otherwise a link string is added
	 */

Missing @return tag in function comment

	public function add($href, array $meta=[]) {
		if ($meta === []) {
			$this->addLinkString($href);
		}
		else {
			$this->addLinkObject(new LinkObject($href, $meta));
		}
	}
	
	/**
	 * spec api
	 */
	
	/**
	 * @param string $href

Missing parameter comment

	 */

Missing @return tag in function comment

	public function addLinkString($href) {
		$this->links[] = $href;
	}
	
	/**
	 * @param LinkObject $linkObject

Missing parameter comment

	 */

Missing @return tag in function comment

	public function addLinkObject(LinkObject $linkObject) {
		$this->links[] = $linkObject;
	}
	
	/**
	 * ObjectInterface
	 */
	
	/**
	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function isEmpty() {
		return ($this->links === []);
	}
	
	/**
	 * @inheritDoc
	 */

Missing @return tag in function comment

	public function toArray() {
		$array = [];
		
		foreach ($this->links as $link) {
			if ($link instanceof LinkObject && $link->isEmpty() === false) {
				$array[] = $link->toArray();
			}
			elseif (is_string($link)) {
				$array[] = $link;
			}
		}
		
		return $array;
	}
}