alsvanzelf\jsonapi\helpers\LinksManager

Complexity

Total Complexity

8

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	addLink()	0	4	1
A	appendLink()	0	4	1
A	addLinkObject()	0	4	1
A	addLinksArray()	0	4	1
A	appendLinkObject()	0	4	1
A	setLinksObject()	0	3	1
A	ensureLinksObject()	0	5	2

<?php

namespace alsvanzelf\jsonapi\helpers;

use alsvanzelf\jsonapi\objects\LinkObject;
use alsvanzelf\jsonapi\objects\LinksArray;
use alsvanzelf\jsonapi\objects\LinksObject;

trait LinksManager {

Missing doc comment for trait LinksManager

	/** @var LinksObject */
	protected $links;
	
	/**
	 * human api
	 */
	
	/**
	 * set a key containing a link
	 * 
	 * @param string $key

Missing parameter comment

	 * @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 addLink($key, $href, array $meta=[]) {
		$this->ensureLinksObject();
		$this->links->add($key, $href, $meta);
	}
	
	/**
	 * append a link to a key with an array of links
	 * 
	 * @param string $key

Missing parameter comment

	 * @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 appendLink($key, $href, array $meta=[]) {
		$this->ensureLinksObject();
		$this->links->append($key, $href, $meta);
	}
	
	/**
	 * spec api
	 */
	
	/**
	 * set a key containing a LinkObject
	 * 
	 * @param string     $key

Missing parameter comment

	 * @param LinkObject $linkObject

Missing parameter comment

	 */

Missing @return tag in function comment

	public function addLinkObject($key, LinkObject $linkObject) {
		$this->ensureLinksObject();
		$this->links->addLinkObject($key, $linkObject);
	}
	
	/**
	 * set a key containing a LinksArray
	 * 
	 * @param string     $key

Missing parameter comment

	 * @param LinksArray $linksArray

Missing parameter comment

	 */

Missing @return tag in function comment

	public function addLinksArray($key, LinksArray $linksArray) {
		$this->ensureLinksObject();
		$this->links->addLinksArray($key, $linksArray);
	}
	
	/**
	 * append a LinkObject to a key with a LinksArray
	 * 
	 * @param string     $key

Missing parameter comment

	 * @param LinkObject $linkObject

Missing parameter comment

	 */

Missing @return tag in function comment

	public function appendLinkObject($key, LinkObject $linkObject) {
		$this->ensureLinksObject();
		$this->links->appendLinkObject($key, $linkObject);
	}
	
	/**
	 * set a LinksObject containing all links
	 * 
	 * @param LinksObject $linksObject

Missing parameter comment

	 */

Missing @return tag in function comment

	public function setLinksObject(LinksObject $linksObject) {
		$this->links = $linksObject;
	}
	
	/**
	 * internal api
	 */
	
	/**
	 * @internal
	 */

Missing @return tag in function comment

	private function ensureLinksObject() {
		if ($this->links === null) {
			$this->setLinksObject(new LinksObject());
		}
	}
}