Alchemy\Phraseanet\Helper\MetadataHelper

Complexity

Total Complexity

41

Size/Duplication

Total Lines	211
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

69.41%

Importance

Changes	8
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getFieldName()	0	14	4
B	getFieldAlias()	0	16	5
C	getStoryField()	0	29	7
A	appendValueToMap()	0	14	3
B	getStoryFields()	0	24	6
B	getRecordFields()	0	25	6
B	getRecordField()	0	21	5
A	getRecordMultiField()	0	18	4

<?php

namespace Alchemy\Phraseanet\Helper;

use Alchemy\Phraseanet\Mapping\FieldMap;
use PhraseanetSDK\Entity\Record;
use PhraseanetSDK\Entity\Story;

class MetadataHelper
{

    /**
     * @var string
     */
    private $defaultLocale;

    /**
     * @var FieldMap
     */
    private $fieldsMap;

    /**
     * @var string
     */
    private $fallbackLocale;

    /**
     * @param FieldMap $fieldsMap
     * @param string $defaultLocale
     * @param string $fallbackLocale
     */
    public function __construct(FieldMap $fieldsMap, $defaultLocale, $fallbackLocale)
    {
        $this->fieldsMap = $fieldsMap;
        $this->defaultLocale = $defaultLocale;
        $this->fallbackLocale = $fallbackLocale;
    }

    public function getFieldName($alias, $locale = null)
    {
        if ($locale === null) {
            $locale = $this->defaultLocale;
        }

        try {
            return $this->fieldsMap->getFieldName($alias, $locale);
        } catch (\OutOfBoundsException $exception) {
            if ($locale !== $this->defaultLocale) {
                return $this->getFieldName($alias, $this->defaultLocale);
            }
        }
    }

    /**
     * @param $fieldName
     * @param null $locale
     * @param bool $fallback Whether the lookup should fallback to the default locale
     * @return string
     */
    public function getFieldAlias($fieldName, $locale = null, $fallback = true)
    {
        if ($locale == null) {
            $locale = $this->defaultLocale;
        }

        if ($this->fieldsMap->isFieldMapped($fieldName, $locale)) {
            return $this->fieldsMap->getAliasFromFieldName($fieldName, $locale);
        }

        if ($locale !== $this->defaultLocale && $fallback) {
            return $this->getFieldAlias($fieldName, $this->defaultLocale);
        }

        throw new \RuntimeException("No alias is available for field '$fieldName' with locale '$locale'.");
    }

    public function getStoryField(Story $story, $field, $locale = null)
    {
        // @todo Clean up code
        if ($locale == null) {
            $locale = $this->defaultLocale;
        }

        if (! $this->fieldsMap->hasAlias($field, $locale)) {
            if ($locale !== $this->defaultLocale) {
                return $this->getStoryField($story, $field, $this->defaultLocale);
            }

            return '';
        }

        $key = $this->fieldsMap->getFieldName($field, $locale);

        foreach ($story->getCaption() as $captionField) {
            if ($key === $captionField->getName()) {
                return $captionField->getValue();
            }
        }

        if ($locale !== $this->defaultLocale) {
            return $this->getStoryField($story, $field, $this->defaultLocale);
        }

        return '';
    }

    public function getStoryFields(Story $story, array $fields = null, $locale = null)
    {
        if ($locale == null) {
            $locale = $this->defaultLocale;
        }

        $map = [];

        foreach ($story->getMetadata() as $metadata) {
            if (!$this->fieldsMap->isFieldMapped($metadata->getName(), $locale)) {
                continue;
            }

            $alias = $this->fieldsMap->getAliasFromFieldName($metadata->getName(), $locale);

            if ($fields !== null && !in_array($alias, $fields)) {
                continue;
            }

            $map = $this->appendValueToMap($map, $alias, $metadata->getValue());
        }

        return $map;
    }

    public function getRecordFields(Record $record, array $fields = null, $locale = null)
    {
        // @todo Clean up code
        if ($locale == null) {
            $locale = $this->defaultLocale;
        }

        $map = [];

        foreach ($record->getMetadata() as $metadata) {
            if (!$this->fieldsMap->isFieldMapped($metadata->getName(), $locale)) {
                continue;
            }

            $alias = $this->fieldsMap->getAliasFromFieldName($metadata->getName(), $locale);

            if ($fields !== null && !in_array($alias, $fields)) {
                continue;
            }

            $map = $this->appendValueToMap($map, $alias, $metadata->getValue());
        }

        return $map;
    }

    /**
     * @param array $map
     * @param string $alias
     * @param string $value
     * @return array
     */
    private function appendValueToMap($map, $alias, $value)
    {
        if (isset($map[$alias])) {
            if (!is_array($map[$alias])) {
                $map[$alias] = [$map[$alias]];
            }

            $map[$alias][] = $value;
        } else {
            $map[$alias] = $value;
        }

        return $map;
    }

    public function getRecordField(Record $record, $field, $locale = null)
    {
        if ($locale == null) {
            $locale = $this->defaultLocale;
        }

        if (!$this->fieldsMap->hasAlias($field, $locale)) {
            return null;
        }

        $key = $this->fieldsMap->getFieldName($field, $locale);

        foreach ($record->getMetadata() as $metadata) {
            // Try to find the corresponding RecordCaption
            if ($key === $metadata->getName()) {
                return $metadata->getValue();
            }
        }

        return null;
    }

    public function getRecordMultiField(Record $record, $field, $locale = null)
    {
        if (!$this->fieldsMap->hasAlias($field, $locale)) {
            return [];
        }

        $key = $this->fieldsMap->getFieldName($field, $locale);
        $values = array();

        foreach ($record->getMetadata() as $metadata) {
            // Try to find the corresponding RecordCaption
            if ($key === $metadata->getName()) {
                $values[] = $metadata->getValue();
            }
        }

        return $values;
    }
}