cleanup deprecated links array

Author: lode

src/helpers/LinksManager.php

@@ -3,7 +3,6 @@
 namespace alsvanzelf\jsonapi\helpers;
 
 use alsvanzelf\jsonapi\objects\LinkObject;
-use alsvanzelf\jsonapi\objects\LinksArray;
 use alsvanzelf\jsonapi\objects\LinksObject;
 
 trait LinksManager {
@@ -26,20 +25,6 @@ public function addLink($key, $href, array $meta=[]) {
 		$this->links->add($key, $href, $meta);
 	}
 
-	/**
-	 * append a link to a key with an array of links
-	 * 
-	 * @deprecated array links are not supported anymore {@see ->addLink()}
-	 * 
-	 * @param string $key
-	 * @param string $href
-	 * @param array  $meta optional, if given a LinkObject is added, otherwise a link string is added
-	 */
-	public function appendLink($key, $href, array $meta=[]) {
-		$this->ensureLinksObject();
-		$this->links->append($key, $href, $meta);
-	}
-	
 	/**
 	 * spec api
 	 */
@@ -55,32 +40,6 @@ public function addLinkObject($key, LinkObject $linkObject) {
 		$this->links->addLinkObject($key, $linkObject);
 	}
 
-	/**
-	 * set a key containing a LinksArray
-	 * 
-	 * @deprecated array links are not supported anymore {@see ->addLinkObject()}
-	 * 
-	 * @param string     $key
-	 * @param LinksArray $linksArray
-	 */
-	public function addLinksArray($key, LinksArray $linksArray) {
-		$this->ensureLinksObject();
-		$this->links->addLinksArray($key, $linksArray);
-	}
-	
-	/**
-	 * append a LinkObject to a key with a LinksArray
-	 * 
-	 * @deprecated array links are not supported anymore {@see ->addLinkObject()}
-	 * 
-	 * @param string     $key
-	 * @param LinkObject $linkObject
-	 */
-	public function appendLinkObject($key, LinkObject $linkObject) {
-		$this->ensureLinksObject();
-		$this->links->appendLinkObject($key, $linkObject);
-	}
-	
 	/**
 	 * set a LinksObject containing all links
 	 * 

src/interfaces/HasLinksInterface.php

@@ -5,7 +5,6 @@
 namespace alsvanzelf\jsonapi\interfaces;
 
 use alsvanzelf\jsonapi\objects\LinkObject;
-use alsvanzelf\jsonapi\objects\LinksArray;
 use alsvanzelf\jsonapi\objects\LinksObject;
 
 interface HasLinksInterface {
@@ -19,43 +18,13 @@ interface HasLinksInterface {
 	 */
 	public function addLink($key, $href, array $meta=[]);
 
-	/**
-	 * append a link to a key with an array of links
-	 * 
-	 * if $meta is given, a LinkObject is added, otherwise a link string is added
-	 * 
-	 * @deprecated array links are not supported anymore {@see ->addLink()}
-	 * 
-	 * @param string $key
-	 * @param string $href
-	 */
-	public function appendLink($key, $href, array $meta=[]);
-	
 	/**
 	 * set a key containing a LinkObject
 	 * 
 	 * @param string $key
 	 */
 	public function addLinkObject($key, LinkObject $linkObject);
 
-	/**
-	 * set a key containing a LinksArray
-	 * 
-	 * @deprecated array links are not supported anymore {@see ->addLinkObject()}
-	 * 
-	 * @param string $key
-	 */
-	public function addLinksArray($key, LinksArray $linksArray);
-	
-	/**
-	 * append a LinkObject to a key with a LinksArray
-	 * 
-	 * @deprecated array links are not supported anymore {@see ->addLinkObject()}
-	 * 
-	 * @param string $key
-	 */
-	public function appendLinkObject($key, LinkObject $linkObject);
-	
 	/**
 	 * set a LinksObject containing all links
 	 */

src/objects/ErrorObject.php

@@ -162,18 +162,6 @@ public function setTypeLink($href, array $meta=[]) {
 		$this->addLink('type', $href, $meta);
 	}
 
-	/**
-	 * append a link of the generic type of this error, explained in a human-friendly way
-	 * 
-	 * @deprecated array links are not supported anymore {@see ->setTypeLink()}
-	 * 
-	 * @param string $href
-	 * @param array  $meta optional, if given a LinkObject is added, otherwise a link string is added
-	 */
-	public function appendTypeLink($href, array $meta=[]) {
-		$this->appendLink('type', $href, $meta);
-	}
-	
 	/**
 	 * blame the json pointer from the request body causing this error
 	 * 

src/objects/LinksArray.php

@@ -7,7 +7,6 @@
 use alsvanzelf\jsonapi\helpers\Validator;
 use alsvanzelf\jsonapi\objects\AbstractObject;
 use alsvanzelf\jsonapi\objects\LinkObject;
-use alsvanzelf\jsonapi\objects\LinksArray;
 
 class LinksObject extends AbstractObject {
 	/** @var array with string|LinkObject */
@@ -55,32 +54,6 @@ public function add($key, $href, array $meta=[]) {
 		}
 	}
 
-	/**
-	 * appends a link to an array of links under a specific key
-	 * 
-	 * @see LinksArray for use cases
-	 * 
-	 * @deprecated array links are not supported anymore {@see ->add()}
-	 * 
-	 * @param string $key
-	 * @param string $href
-	 * @param array  $meta optional, if given a LinkObject is added, otherwise a link string is added
-	 * 
-	 * @throws DuplicateException if another link is already using that $key but is not an array
-	 */
-	public function append($key, $href, array $meta=[]) {
-		Validator::checkMemberName($key);
-		
-		if (isset($this->links[$key]) === false) {
-			$this->addLinksArray($key, new LinksArray());
-		}
-		elseif ($this->links[$key] instanceof LinksArray === false) {
-			throw new DuplicateException('can not add to key "'.$key.'", it is not an array of links');
-		}
-		
-		$this->links[$key]->add($href, $meta);
-	}
-	
 	/**
 	 * spec api
 	 */
@@ -117,45 +90,6 @@ public function addLinkObject($key, LinkObject $linkObject) {
 		$this->links[$key] = $linkObject;
 	}
 
-	/**
-	 * @deprecated array links are not supported anymore {@see ->addLinkObject()}
-	 * 
-	 * @param string     $key
-	 * @param LinksArray $linksArray
-	 * 
-	 * @throws DuplicateException if another link is already using that $key
-	 */
-	public function addLinksArray($key, LinksArray $linksArray) {
-		Validator::checkMemberName($key);
-		
-		if (isset($this->links[$key])) {
-			throw new DuplicateException('link with key "'.$key.'" already set');
-		}
-		
-		$this->links[$key] = $linksArray;
-	}
-	
-	/**
-	 * @deprecated array links are not supported anymore {@see ->addLinkObject()}
-	 * 
-	 * @param  string     $key
-	 * @param  LinkObject $linkObject
-	 * 
-	 * @throws DuplicateException if another link is already using that $key but is not an array
-	 */
-	public function appendLinkObject($key, LinkObject $linkObject) {
-		Validator::checkMemberName($key);
-		
-		if (isset($this->links[$key]) === false) {
-			$this->addLinksArray($key, new LinksArray());
-		}
-		elseif ($this->links[$key] instanceof LinksArray === false) {
-			throw new DuplicateException('can not add to key "'.$key.'", it is not an array of links');
-		}
-		
-		$this->links[$key]->addLinkObject($linkObject);
-	}
-	
 	/**
 	 * ObjectInterface
 	 */
@@ -188,9 +122,6 @@ public function toArray() {
 			if ($link instanceof LinkObject && $link->isEmpty() === false) {
 				$array[$key] = $link->toArray();
 			}
-			elseif ($link instanceof LinksArray && $link->isEmpty() === false) { // @phpstan-ignore method.deprecatedClass
-				$array[$key] = $link->toArray(); // @phpstan-ignore method.deprecatedClass
-			}
 			elseif ($link instanceof LinkObject && $link->isEmpty()) {
 				$array[$key] = null;
 			}