RApiHalDocumentResource::toArray() - Code Metrics - Inspection of "Add Alternate Links for languages" - redCOMPONENT-COM/redCORE - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — develop (#888)

by Lu Nguyen
created 2020-10-09 08:58 UTC
RApiHalDocumentResource::toArray() A

↳ Parent: RApiHalDocumentResource
Complexity

Conditions	5
Paths	12
Size

Total Lines	25
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	10
c	0
b	0
f	0
dl	0
loc	25
rs	9.6111
cc	5
nc	12
nop	0
<?php
/**
 * @package     Redcore
 * @subpackage  Api
 *
 * @copyright   Copyright (C) 2008 - 2020 redWEB.dk. All rights reserved.
 * @license     GNU General Public License version 2 or later, see LICENSE.
 */

defined('JPATH_BASE') or die;

/**
 * Object to represent a hypermedia resource in HAL.
 *
 * @since  1.2
 */
class RApiHalDocumentResource extends RApiHalDocumentBase
{
	/**
	 * Json option
	 */
	const JSON_NUMERIC_CHECK_ON = true;

	/**
	 * Json option
	 */
	const JSON_NUMERIC_CHECK_OFF = false;

	/**
	 * @var bool
	 */
	protected $jsonNumericCheck = self::JSON_NUMERIC_CHECK_OFF;

	/**
	 * Internal storage of `RApiHalDocumentLink` objects
	 * @var array
	 */
	protected $_links = array();

	/**
	 * Internal storage of primitive types
	 * @var array
	 */
	protected $_data = array();

	/**
	 * Internal storage of `Resource` objects
	 * @var array
	 */
	protected $_embedded = array();

	/**
	 * Constructor.
	 *
	 * @param   string       $href      Href
	 * @param   array        $data      Data
	 * @param   string|null  $title     Title
	 * @param   string|null  $name      Name
	 * @param   string|null  $hreflang  Href language
	 */
	public function __construct($href, array $data = array(), $title = null, $name = null, $hreflang = null)
	public function __construct($href, array $data = array(), $title = null, $name = null, /** @scrutinizer ignore-unused */ $hreflang = null)
	{
		/*$this->setLink(
			new RApiHalDocumentLink($href, 'self', $title, $name, $hreflang)
		);*/
		$this->setData($data);
		$this->setData(/** @scrutinizer ignore-type */ $data);
	}

	/**
	 * Gets self link
	 *
	 * @return RApiHalDocumentLink
	 */
	public function getSelf()
	{
		return $this->_links['self'];
	}

	/**
	 * Gets all links
	 *
	 * @return array
	 */
	public function getLinks()
	{
		return $this->_links;
	}

	/**
	 * Gets all Embeded elements
	 *
	 * @return array
	 */
	public function getEmbedded()
	{
		return $this->_embedded;
	}

	/**
	 * Add a link to the resource.
	 *
	 * Per the JSON-HAL specification, a link relation can reference a
	 * single link or an array of links. By default, two or more links with
	 * the same relation will be treated as an array of links. The $singular
	 * flag will force links with the same relation to be overwritten. The
	 * $plural flag will force links with only one relation to be treated
	 * as an array of links. The $plural flag has no effect if $singular
	 * is set to true.
	 *
	 * @param   RApiHalDocumentLink  $link      Link
	 * @param   bool                 $singular  Force overwrite of the existing link
	 * @param   bool                 $plural    Force plural mode even if only one link is present
	 *
	 * @return RApiHalDocumentResource
	 */
	public function setLink(RApiHalDocumentLink $link, $singular = false, $plural = false)
	{
		$rel = $link->getRel();

		if ($singular || (!isset($this->_links[$rel]) && !$plural))
		{
			$this->_links[$rel] = $link;
		}
		else
		{
			if (isset($this->_links[$rel]) && !is_array($this->_links[$rel]))
			{
				$orig_link = $this->_links[$rel];
				$this->_links[$rel] = array($orig_link);
			}

			$this->_links[$rel][] = $link;
		}

		return $this;
	}

	/**
	 * Set multiple links at once
	 *
	 * @param   array  $links     List of links
	 * @param   bool   $singular  Force overwrite of the existing link
	 * @param   bool   $plural    Force plural mode even if only one link is present
	 *
	 * @return RApiHalDocumentResource
	 */
	public function setLinks(array $links, $singular = false, $plural = false)
	{
		foreach ($links as $link)
		{
			$this->setLink($link, $singular, $plural);
		}

		return $this;
	}

	/**
	 * Replace existing link to the resource.
	 *
	 * @param   RApiHalDocumentLink  $link   Link
	 * @param   mixed                $group  Groupped link container
	 *
	 * @return RApiHalDocumentResource
	 */
	public function setReplacedLink(RApiHalDocumentLink $link, $group = '')
	{
		$rel = $link->getRel();

		if ($group !== '')
		{
			$this->_links[$rel][$group] = $link;
		}
		else
		{
			$this->_links[$rel] = $link;
		}

		return $this;
	}

	/**
	 * Sets data to the resource
	 *
	 * @param   string  $rel   Rel element
	 * @param   mixed   $data  Data for the resource
	 *
	 * @return RApiHalDocumentResource
	 */
	public function setData($rel, $data = null)
	{
		if (is_array($rel) && null === $data)

		{
			foreach ($rel as $k => $v)
			{
				$this->_data[$k] = $v;
			}
		}
		else
		{
			$this->_data[$rel] = $data;
		}

		return $this;
	}

	/**
	 * Sets data to the resource
	 *
	 * @param   string  $rel       Rel element
	 * @param   string  $key       Key value for the resource
	 * @param   string  $data      Data value for the resource
	 * @param   bool    $singular  Force overwrite of the existing data
	 * @param   bool    $plural    Force plural mode even if only one link is present
	 *
	 * @return RApiHalDocumentResource
	 */
	public function setDataGrouped($rel, $key = '', $data = '', $singular = false, $plural = false)
	{
		if ($singular || (!isset($this->_data[$rel]) && !$plural))
		{
			$this->_data[$rel][$key] = $data;
		}
		else
		{
			if (isset($this->_data[$rel]) && !is_array($this->_data[$rel]))
			{
				$orig_link = $this->_data[$rel];
				$this->_data[$rel] = array($orig_link);
			}

			$this->_data[$rel][$key] = $data;
		}

		return $this;
	}

	/**
	 * Sets Embedded resource
	 *
	 * @param   string                   $rel       Relation of the resource
	 * @param   RApiHalDocumentResource  $resource  Resource
	 * @param   bool                     $singular  Force overwrite of the existing embedded element
	 *
	 * @return RApiHalDocumentResource
	 */
	public function setEmbedded($rel, RApiHalDocumentResource $resource = null, $singular = false)
	{
		if ($singular)
		{
			$this->_embedded[$rel] = $resource;
		}
		else
		{
			$this->_embedded[$rel][] = $resource;
		}

		return $this;
	}

	/**
	 * Converts current RApiHalDocumentResource object to Array
	 *
	 * @return array
	 */
	public function toArray()
	{
		$data = array();

		foreach ($this->_links as $rel => $link)
		{
			$links = $this->_recourseLinks($link);

			if (!empty($links))
			{
				$data['_links'][$rel] = $links;
			}
		}

		foreach ($this->_data as $key => $value)
		{
			$data[$key] = $value;
		}

		foreach ($this->_embedded as $rel => $embed)
		{
			$data['_embedded'][$rel] = $this->_recourseEmbedded($embed);
		}

		return $data;
	}

	/**
	 * Recourse function for Embedded objects
	 *
	 * @param   RApiHalDocumentResource|null|array  $embedded  Embedded object
	 *
	 * @return array
	 */
	protected function _recourseEmbedded($embedded)
	{
		if (is_null($embedded))
		{
			return null;
		}

		$result = array();

		if ($embedded instanceof self)
		{
			$result = $embedded->toArray();
		}
		else
		{
			foreach ($embedded as $embed)
			{
				if ($embed instanceof self)
				{
					$result[] = $embed->toArray();
				}
			}
		}

		return $result;
	}

	/**
	 * Recourse function for Link objects
	 *
	 * @param   array|RApiHalDocumentLink  $links  Link object
	 *
	 * @return array
	 */
	protected function _recourseLinks($links)
	{
		$result = array();

		if (!is_array($links))
		{
			$result = $links->toArray();
		}
		else
		{
			foreach ($links as $link)
			{
				$result[] = $link->toArray();
			}
		}

		return $result;
	}

	/**
	 * Convert function to Json format
	 *
	 * @return string
	 */
	public function toJson()
	{
		// Check for defined constants
		if (!defined('JSON_UNESCAPED_SLASHES'))
		{
			define('JSON_UNESCAPED_SLASHES', 64);
		}

		if (defined(JSON_NUMERIC_CHECK) && $this->jsonNumericCheck)
		{
			return json_encode($this->toArray(), JSON_UNESCAPED_SLASHES | JSON_NUMERIC_CHECK);
		}

		return json_encode($this->toArray(), JSON_UNESCAPED_SLASHES);
	}

	/**
	 * Convert function to string format
	 *
	 * @return string
	 */
	public function __toString()
	{
		return $this->toJson();
	}

	/**
	 * Get XML document of current resource
	 *
	 * @param   SimpleXMLElement|null  $xml  XML document
	 *
	 * @return SimpleXMLElement
	 */
	public function getXML($xml = null)
	{
		if (!($xml instanceof SimpleXMLElement))
		{
			$xml = new SimpleXMLElement('<resource></resource>');
		}

		$this->xml = $xml;

		foreach ($this->_links as $links)
		{
			if (is_array($links))
			{
				foreach ($links as $link)
				{
					$this->_addLinks($link);
				}
			}
			else
			{
				$this->_addLinks($links);
			}
		}

		$this->_addData($this->xml, $this->_data);
		$this->_getEmbedded($this->_embedded);

		return $this->xml;
	}

	/**
	 * Get Embedded of current resource
	 *
	 * @param   mixed        $embedded  Embedded list
	 * @param   string|null  $_rel      Relation of embedded object
	 *
	 * @return void
	 */
	protected function _getEmbedded($embedded, $_rel = null)
	{
		/* @var $embed RApiHalDocumentResource */
		foreach ($embedded as $rel => $embed)
		{
			if ($embed instanceof RApiHalDocumentResource)
			{
				$rel = is_numeric($rel) ? $_rel : $rel;
				$this->_getEmbRes($embed)->addAttribute('rel', $rel);
			}
			else
			{
				if (!is_null($embed))
				{
					$this->_getEmbedded($embed, $rel);
				}
				else
				{
					$rel = is_numeric($rel) ? $_rel : $rel;
					$this->xml->addChild('resource')->addAttribute('rel', $rel);
				}
			}
		}
	}

	/**
	 * Get Embedded of current resource in XML format
	 *
	 * @param   RApiHalDocumentResource  $embed  Embedded object
	 *
	 * @return SimpleXMLElement
	 */
	protected function _getEmbRes(RApiHalDocumentResource $embed)
	{
		$resource = $this->xml->addChild('resource');

		return $embed->getXML($resource);
	}

	/**
	 * Sets XML document to this resource
	 *
	 * @param   SimpleXMLElement  $xml  XML document
	 *
	 * @return RApiHalDocumentResource
	 */
	public function setXML(SimpleXMLElement $xml)
	{
		$this->xml = $xml;

		return $this;
	}

	/**
	 * Adds data to the current resource
	 *
	 * @param   SimpleXMLElement  $xml          XML document
	 * @param   array             $data         Data
	 * @param   string            $keyOverride  Key override
	 *
	 * @return void
	 */
	protected function _addData(SimpleXMLElement $xml, array $data, $keyOverride = null)
	{
		foreach ($data as $key => $value)
		{
			// Alpha-numeric key => array value
			if (!is_numeric($key) && is_array($value))
			{
				$c = $xml->addChild($key);
				$this->_addData($c, $value, $key);
			}
			// Alpha-numeric key => non-array value
			elseif (!is_numeric($key) && !is_array($value))
			{
				$xml->addChild($key, $value);
			}
			// Numeric key => array value
			elseif (is_array($value))
			{
				$this->_addData($xml, $value);
			}
			// Numeric key => non-array value
			else
			{
				$xml->addChild($keyOverride, $value);
			}
		}
	}

	/**
	 * Adds links to the current resource
	 *
	 * @param   RApiHalDocumentLink  $link  Link
	 *
	 * @return void
	 */
	protected function _addLinks(RApiHalDocumentLink $link)
	{
		if ($link->getRel() != 'self' && !is_numeric($link->getRel()))
		{
			$this->_addLink($link);
		}
	}

	/**
	 * Adds link to the current resource
	 *
	 * @param   RApiHalDocumentLink  $link  Link
	 *
	 * @return RApiHalDocumentResource
	 */
	protected function _addLink(RApiHalDocumentLink $link)
	{
		$this->setXMLAttributes($this->xml->addChild('link'), $link);

		return $this;
	}

	/**
	 * Method to load an object or an array into this HAL object.
	 *
	 * @param   object  $object  Object whose properties are to be loaded.
	 *
	 * @return object This method may be chained.
	 */
	public function load($object)
	{
		foreach ($object as $name => $value)
		{
			// For _links and _embedded, we merge rather than replace.
			if ($name == '_links')
			{
				$this->_links = array_merge((array) $this->_links, (array) $value);
			}
			elseif ($name == '_embedded')
			{
				$this->_embedded = array_merge((array) $this->_embedded, (array) $value);
			}
			else
			{
				$this->_data[$name] = $value;
			}
		}

		return $this;
	}

	/**
	 * Sets the ability to perform numeric to int conversion of the JSON output.
	 *
	 * <b>Example Usage:</b>
	 * <code>
	 * $hal->setJsonNumericCheck($jsonNumericCheck = self::JSON_NUMERIC_CHECK_OFF);
	 * $hal->setJsonNumericCheck($jsonNumericCheck = self::JSON_NUMERIC_CHECK_ON);
	 * </code>
	 *
	 * @param   bool  $jsonNumericCheck  Json numeric check
	 *
	 * @return RApiHalDocumentResource
	 */
	public function setJsonNumericCheck($jsonNumericCheck = self::JSON_NUMERIC_CHECK_OFF)
	{
		$this->jsonNumericCheck = $jsonNumericCheck;

		return $this;
	}

	/**
	 * Creates empty array of Xml configuration Resource field
	 *
	 * @param   array   $resource          Resource array
	 * @param   string  $resourceSpecific  Resource specific container
	 *
	 * @return array
	 */
	public static function defaultResourceField($resource = array(), $resourceSpecific = 'rcwsGlobal')
	{
		$defaultResource = array(
			'resourceSpecific' => !empty($resource['resourceSpecific']) ? $resource['resourceSpecific'] : $resourceSpecific,
			'displayGroup'     => !empty($resource['displayGroup']) ? $resource['displayGroup'] : '',
			'displayName'      => !empty($resource['displayName']) ? $resource['displayName'] : '',
			'fieldFormat'      => !empty($resource['fieldFormat']) ? $resource['fieldFormat'] : '',
			'transform'        => !empty($resource['transform']) ? $resource['transform'] : '',
			'linkName'         => !empty($resource['linkName']) ? $resource['linkName'] : '',
			'linkTitle'        => !empty($resource['linkTitle']) ? $resource['linkTitle'] : '',
			'hrefLang'         => !empty($resource['hrefLang']) ? $resource['hrefLang'] : '',
			'linkTemplated'    => !empty($resource['linkTemplated']) ? $resource['linkTemplated'] : '',
			'linkRel'          => !empty($resource['linkRel']) ? $resource['linkRel'] : '',
			'description'      => !empty($resource['description']) ? $resource['description'] : '',
		);

		return array_merge($resource, $defaultResource);
	}

	/**
	 * Merges two resource fields
	 *
	 * @param   array  $resourceMain   Resource array main
	 * @param   array  $resourceChild  Resource array child
	 *
	 * @return array
	 */
	public static function mergeResourceFields($resourceMain = array(), $resourceChild = array())
	{
		foreach ($resourceMain as $key => $value)
		{
			$resourceMain[$key] = !empty($resourceChild[$key]) ? $resourceChild[$key] : $resourceMain[$key];
		}

		return $resourceMain;
	}
}

redCOMPONENT-COM / redCORE

Pull Request — develop (#888)

RApiHalDocumentResource::toArray() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
