NilPortugues\Api\Mapping\Mapping

Complexity

Total Complexity

42

Size/Duplication

Total Lines	419
Duplicated Lines	0 %

Coupling/Cohesion

Components	7
Dependencies	2

Importance

Changes	7
Bugs	0	Features	3

36 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getClassAlias()	0	4	1
A	setClassAlias()	0	8	1
A	getIdProperties()	0	4	1
A	addIdProperty()	0	4	1
A	hideProperty()	0	4	1
A	addPropertyAlias()	0	6	1
A	updatePropertyMappings()	0	14	2
A	setPropertyNameAliases()	0	8	2
A	setProperties()	0	4	1
A	getProperties()	0	4	1
A	getClassName()	0	4	1
A	getResourceUrl()	0	4	1
A	getAliasedProperties()	0	4	1
A	getHiddenProperties()	0	4	1
A	setHiddenProperties()	0	4	1
A	getRelationships()	0	4	1
A	addAdditionalRelationships()	0	4	1
A	getMetaData()	0	4	1
A	setMetaData()	0	4	1
A	addMetaData()	0	4	1
A	getSelfUrl()	0	4	1
A	setSelfUrl()	0	4	1
A	getRelatedUrl()	0	6	2
A	setFilterKeys()	0	4	1
A	getFilterKeys()	0	4	1
A	setRelationshipUrls()	0	6	1
A	getRelationshipSelfUrl()	0	6	2
A	setUrls()	0	4	1
A	getUrls()	0	4	1
A	setCuries()	0	8	3
A	getCuries()	0	4	1
A	addIncludedResource()	0	4	1
A	getIncludedResources()	0	4	1
A	filteringIncludedResources()	0	4	1
A	isFilteringIncludedResources()	0	4	1

<?php

namespace NilPortugues\Api\Mapping;

use NilPortugues\Api\Transformer\Helpers\RecursiveFormatterHelper;

class Mapping
{
    /**
     * @var string
     */
    private $className = '';
    /**
     * @var string
     */
    private $resourceUrlPattern = '';
    /**
     * @var string
     */
    private $classAlias = '';
    /**
     * @var array
     */
    private $aliasedProperties = [];
    /**
     * @var array
     */
    private $hiddenProperties = [];
    /**
     * @var array
     */
    private $idProperties = [];
    /**
     * @var array
     */
    private $relationships = [];
    /**
     * @var array
     */
    private $metaData = [];
    /**
     * @var string
     */
    private $selfUrl = '';

    /**
     * @var array
     */
    private $otherUrls = [];

    /**
     * @var array
     */
    private $relationshipSelfUrl = [];

    /**
     * @var array
     */
    private $filterKeys = [];

    /**
     * @var array
     */
    private $curies = [];

    /**
     * @var array
     */
    private $properties = [];

    /**
     * @var array
     */
    private $includedKeys = [];

    /**
     * @var bool
     */
    private $filteringIncluded = false;

    /**
     * @param       $className
     * @param null  $resourceUrlPattern
     * @param array $idProperties
     */
    public function __construct($className, $resourceUrlPattern = null, array $idProperties = [])
    {
        $this->className = (string) $className;
        $this->resourceUrlPattern = $resourceUrlPattern;
        $this->idProperties = $idProperties;
    }

    /**
     * @return string
     */
    public function getClassAlias()
    {
        return $this->classAlias;
    }

    /**
     * @param string $aliasedClass
     *
     * @return $this
     */
    public function setClassAlias($aliasedClass)
    {
        $this->classAlias = RecursiveFormatterHelper::camelCaseToUnderscore(
            RecursiveFormatterHelper::namespaceAsArrayKey($aliasedClass)
        );

        return $this;
    }

    /**
     * @return array
     */
    public function getIdProperties()
    {
        return (array) $this->idProperties;
    }

    /**
     * @param $idProperty
     */
    public function addIdProperty($idProperty)
    {
        $this->idProperties[] = (string) $idProperty;
    }

    /**
     * @param string $propertyName
     */
    public function hideProperty($propertyName)
    {
        $this->hiddenProperties[] = $propertyName;
    }

    /**
     * @param $propertyName
     * @param $propertyAlias
     */
    public function addPropertyAlias($propertyName, $propertyAlias)
    {
        $this->aliasedProperties[$propertyName] = $propertyAlias;

        $this->updatePropertyMappings($propertyName, $propertyAlias);
    }

    /**
     * @param $propertyName
     * @param $propertyAlias
     */
    private function updatePropertyMappings($propertyName, $propertyAlias)
    {
        if (\in_array($propertyName, $this->idProperties)) {
            $position = \array_search($propertyName, $this->idProperties, true);
            $this->idProperties[$position] = $propertyAlias;
        }

        $search = \sprintf('{%s}', $propertyName);
        $replace = \sprintf('{%s}', $propertyAlias);

        $this->selfUrl = \str_replace($search, $replace, $this->selfUrl);
        $this->resourceUrlPattern = \str_replace($search, $replace, $this->resourceUrlPattern);
        $this->otherUrls = \str_replace($search, $replace, $this->otherUrls);
    }

    /**
     * @param array $properties
     */
    public function setPropertyNameAliases(array $properties)
    {
        $this->aliasedProperties = \array_merge($this->aliasedProperties, $properties);

        foreach ($this->aliasedProperties as $propertyName => $propertyAlias) {
            $this->updatePropertyMappings($propertyName, $propertyAlias);
        }
    }

    /**
     * @param $properties
     */
    public function setProperties(array $properties)
    {
        $this->properties = $properties;
    }

    /**
     * @return array
     */
    public function getProperties()
    {
        return $this->properties;
    }

    /**
     * @return mixed
     */
    public function getClassName()
    {
        return $this->className;
    }

    /**
     */
    public function getResourceUrl()
    {
        return $this->resourceUrlPattern;
    }

    /**
     * @return array
     */
    public function getAliasedProperties()
    {
        return $this->aliasedProperties;
    }

    /**
     * @return array
     */
    public function getHiddenProperties()
    {
        return (array) $this->hiddenProperties;
    }

    /**
     * @param array $hidden
     */
    public function setHiddenProperties(array $hidden)
    {
        $this->hiddenProperties = \array_merge($this->hiddenProperties, $hidden);
    }

    /**
     * @return array
     */
    public function getRelationships()
    {
        return $this->relationships;
    }

    /**
     * @param array $relationships
     */
    public function addAdditionalRelationships(array $relationships)
    {
        $this->relationships = $relationships;
    }

    /**
     * @return array
     */
    public function getMetaData()
    {
        return $this->metaData;
    }

    /**
     * @param array $metaData
     */
    public function setMetaData(array $metaData)
    {
        $this->metaData = $metaData;
    }

    /**
     * @param string $key
     * @param        $value
     */
    public function addMetaData($key, $value)
    {
        $this->metaData[$key] = $value;
    }

    /**
     * @return string
     */
    public function getSelfUrl()
    {
        return $this->selfUrl;
    }

    /**
     * @param string $self
     *
     * @throws \InvalidArgumentException
     */
    public function setSelfUrl($self)
    {
        $this->selfUrl = (string) $self;
    }

    /**
     * @param $propertyName
     *
     * @return string
     */
    public function getRelatedUrl($propertyName)
    {
        return (!empty($this->relationshipSelfUrl[$propertyName]['related']))
            ? $this->relationshipSelfUrl[$propertyName]['related']
            : '';
    }

    /**
     * @param array $filterKeys
     */
    public function setFilterKeys(array $filterKeys)
    {
        $this->filterKeys = $filterKeys;
    }

    /**
     * @return array
     */
    public function getFilterKeys()
    {
        return (array) $this->filterKeys;
    }

    /**
     * @param string $propertyName
     * @param string $urls
     *
     * @return $this
     */
    public function setRelationshipUrls($propertyName, $urls)
    {
        $this->relationshipSelfUrl[$propertyName] = $urls;

        return $this;
    }

    /**
     * @param $propertyName
     *
     * @return string
     */
    public function getRelationshipSelfUrl($propertyName)
    {
        return (!empty($this->relationshipSelfUrl[$propertyName]['self']))
            ? $this->relationshipSelfUrl[$propertyName]['self']
            : '';
    }

    /**
     * @param array $urls
     */
    public function setUrls(array $urls)
    {
        $this->otherUrls = $urls;
    }

    /**
     * @return array
     */
    public function getUrls()
    {
        return $this->otherUrls;
    }

    /**
     * @param array $curies
     *
     * @throws MappingException
     */
    public function setCuries(array $curies)
    {
        if (empty($curies['name']) || empty($curies['href'])) {
            throw new MappingException('Curies must define "name" and "href" properties');
        }

        $this->curies = $curies;
    }

    /**
     * @return array
     */
    public function getCuries()
    {
        return $this->curies;
    }


    /**
     * Used by JSON API included resource filtering.
     *
     * @param $resource
     */
    public function addIncludedResource($resource) {

        $this->includedKeys[] = $resource;
    }

    /**
     * Returns the allowed included resources.
     *
     * @return array
     */
    public function getIncludedResources()
    {
        return $this->includedKeys;
    }


    /**
     * @param bool $filtering
     */
    public function filteringIncludedResources($filtering = true)
    {
        $this->filteringIncluded = $filtering;
    }

    /**
     * Returns true if included resource filtering has been set, false otherwise.
     *
     * @return bool
     */
    public function isFilteringIncludedResources()
    {
        return $this->filteringIncluded;
    }
}