Ubiquity\controllers\rest\api\jsonapi\JsonApiResponseFormatter

Complexity

Total Complexity

26

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Test Coverage

Coverage

78.56%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	formatException()	0	2	1
A	format()	0	2	1
A	addPageLinks()	0	5	2
A	__construct()	0	2	1
A	getOne()	0	2	1
A	get()	0	7	3
A	getDatas()	0	2	1
A	getLink()	0	6	2
A	getModel()	0	2	1
A	toJson()	0	2	1
A	getJSONDatas()	0	2	1
A	getFrontClassname()	0	2	1
A	addRelationshipsLink()	0	2	1
B	cleanRestObject()	0	36	8
A	addSelfLink()	0	2	1

<?php

namespace Ubiquity\controllers\rest\api\jsonapi;

use Ubiquity\controllers\rest\ResponseFormatter;
use Ubiquity\orm\OrmUtils;
use Ubiquity\cache\ClassUtils;

/**
 * JsonAPI Formatter
 * Ubiquity\controllers\rest\api\jsonapi$JsonApiResponseFormatter
 * This class is part of Ubiquity
 *
 * @author jcheron <myaddressmail@gmail.com>
 * @version 1.0.0
 * @since Ubiquity 2.0.11
 */
class JsonApiResponseFormatter extends ResponseFormatter {
	private $selfLink = "%baseRoute%/%classname%/%id%/";
	private $relationLink = "%baseRoute%/%classname%/%id%/%member%/";
	private $pageLink = "%baseRoute%/%classname%/?page[number]=%pageNumber%&page[size]=%pageSize%";
	private $baseRoute;

	public function __construct($baseRoute = "") {
		$this->baseRoute = $baseRoute;
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\ResponseFormatter::cleanRestObject()
	 */
	public function cleanRestObject($o, &$classname = null) {
		$pk = OrmUtils::getFirstKeyValue ( $o );
		$classname = get_class ( $o );
		$frontClassname = $this->getFrontClassname ( $classname );
		$r = [ 'id' => $pk,'type' => $frontClassname ];
		$r ['attributes'] = $o->_rest;
		$fieldsInRelations = OrmUtils::getRelationInfos ( $classname );

		$this->addSelfLink ( $r, $pk, $frontClassname );
		$o = $o->_rest;
		foreach ( $o as $k => $v ) {
			if (isset ( $fieldsInRelations [$k] )) {
				$member = $fieldsInRelations [$k] ['member'] ?? $k;
				if (isset ( $v->_rest )) {
					$r ['included'] [$k] = $this->cleanRestObject ( $v );
				} elseif (\is_array ( $v )) {
					foreach ( $v as $index => $value ) {
						if (isset ( $value->_rest ))
							$v [$index] = $this->cleanRestObject ( $value );
					}
					$r ['included'] [$k] = $v;
				} else {
					if (isset ( $v )) {
						$rFrontClassname = $this->getFrontClassname ( $fieldsInRelations [$k] ['className'] );
						$r ['relationships'] [$member] ['data'] = [ 'id' => $v,'type' => $rFrontClassname ];
						$this->addRelationshipsLink ( $r, $pk, $v, $frontClassname, $rFrontClassname, $member );
					}
				}

				unset ( $r ['attributes'] [$member] );
				unset ( $r ['attributes'] [$k] );
			}
		}
		unset ( $r ['attributes'] ['id'] );
		unset ( $r ['attributes'] ['_rest'] );
		return $r;
	}

	protected function addSelfLink(&$r, $pk, $frontClassname) {
		$r ['links'] ['self'] = $this->getLink ( $this->selfLink, [ "baseRoute" => $this->baseRoute,'id' => $pk,'classname' => $frontClassname ] );
	}

	protected function addPageLinks(&$r, $classname, $pages) {
		$pageSize = $pages ['pageSize'];
		unset ( $pages ['pageSize'] );
		foreach ( $pages as $page => $number ) {
			$r ['links'] [$page] = $this->getLink ( $this->pageLink, [ "baseRoute" => $this->baseRoute,'classname' => $classname,'pageNumber' => $number,'pageSize' => $pageSize ] );
		}
	}

	protected function addRelationshipsLink(&$r, $pk, $pkMember, $frontClassname, $rFrontClassname, $member) {
		$r ['relationships'] [$member] ['links'] = [ $this->getLink ( $this->relationLink, [ "baseRoute" => $this->baseRoute,'id' => $pk,'member' => $member,'classname' => $frontClassname ] ),$this->getLink ( $this->selfLink, [ "baseRoute" => $this->baseRoute,'id' => $pkMember,'classname' => $rFrontClassname ] ) ];
	}

	private function getLink($pattern, $params = []) {
		$r = $pattern;
		foreach ( $params as $k => $v ) {
			$r = str_replace ( '%' . $k . '%', $v, $r );
		}
		return $r;
	}

	private function getFrontClassname($classname) {
		return lcfirst ( ClassUtils::getClassSimpleName ( $classname ) );
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\ResponseFormatter::format()
	 */
	public function format($arrayResponse) {
		return parent::format ( $arrayResponse );
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\ResponseFormatter::formatException()
	 */
	public function formatException($e) {
		return parent::formatException ( $e );
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\ResponseFormatter::get()
	 */
	public function get($datas, $pages = null) {
		$datas = $this->getDatas ( $datas, $classname );
		$r = [ 'data' => $datas ];
		if (isset ( $pages ) && sizeof ( $datas ) > 0) {
			$this->addPageLinks ( $r, $this->getFrontClassname ( $classname ), $pages );
		}
		return $this->format ( $r );
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\ResponseFormatter::getDatas()
	 */
	public function getDatas($datas, &$classname) {
		return parent::getDatas ( $datas, $classname );
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\ResponseFormatter::getJSONDatas()
	 */
	public function getJSONDatas($datas) {
		return parent::getJSONDatas ( $datas );
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\ResponseFormatter::getModel()
	 */
	public function getModel($controllerName) {
		return parent::getModel ( $controllerName );
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\ResponseFormatter::getOne()
	 */
	public function getOne($datas) {
		return parent::getOne ( $datas );
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\controllers\rest\ResponseFormatter::toJson()
	 */
	public function toJson($data) {
		return parent::toJson ( $data );
	}
}