Charcoal\Property\TemplateProperty

Complexity

Total Complexity

29

Size/Duplication

Total Lines	196
Duplicated Lines	6.12 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	type()	0	4	1
A	setDependencies()	0	9	2
A	setChoices()	0	10	1
A	addChoices()	0	10	1
A	addChoice()	0	10	1
C	displayVal()	12	50	15
A	__toString()	0	15	4
A	sqlExtra()	0	4	1
A	sqlType()	0	8	2
A	sqlPdoType()	0	4	1

<?php

namespace Charcoal\Property;

use PDO;

use RuntimeException;
use InvalidArgumentException;

// From Pimple
use Pimple\Container;

// From 'charcoal-translator'
use Charcoal\Translator\Translation;

// From 'charcoal-property'
use Charcoal\Property\AbstractProperty;
use Charcoal\Property\SelectablePropertyInterface;
use Charcoal\Property\SelectablePropertyTrait;

/**
 * Template Selector Property
 */
class TemplateProperty extends AbstractProperty implements SelectablePropertyInterface

There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: loadMetadata, metadata, metadataIdent, setMetadata, setMetadataIdent, setMetadataLoader, setValidator, validate, validator

{
    use SelectablePropertyTrait;

    /**
     * The available selectable templates.
     *
     * @var array|null
     */
    private $availableTemplates;

    /**
     * @return string
     */
    public function type()
    {
        return 'template';
    }

    /**
     * Inject dependencies from a DI Container.
     *
     * @param  Container $container A dependencies container instance.
     * @return void
     */
    public function setDependencies(Container $container)
    {
        parent::setDependencies($container);

        if (isset($container['config']['templates'])) {
            $this->availableTemplates = $this->parseChoices($container['config']['templates']);

The method parseChoices() does not exist on Charcoal\Property\TemplateProperty. Did you maybe mean choice()?

            $this->choices = $this->availableTemplates;
        }
    }

    /**
     * Set the available choices.
     *
     * @param  array $choices One or more choice structures.
     * @return TemplateProperty Chainable.
     */
    public function setChoices(array $choices)
    {
        unset($choices);

        $this->logger->debug(
            'Choices can not be set for template properties. They are auto-generated from available languages.'
        );

        return $this;
    }

    /**
     * Merge the available choices.
     *
     * @param  array $choices One or more choice structures.
     * @return TemplateProperty Chainable.
     */
    public function addChoices(array $choices)
    {
        unset($choices);

        $this->logger->debug(
            'Choices can not be added for template properties. They are auto-generated from available languages.'
        );

        return $this;
    }

    /**
     * Add a choice to the available choices.
     *
     * @param string       $choiceIdent The choice identifier (will be key / default ident).
     * @param string|array $choice      A string representing the choice label or a structure.
     * @return TemplateProperty Chainable.
     */
    public function addChoice($choiceIdent, $choice)
    {
        unset($choiceIdent, $choice);

        $this->logger->debug(
            'Choices can not be added for template properties. They are auto-generated from available languages.'
        );

        return $this;
    }

    /**
     * Format the given value for display.
     *
     * @param  mixed $val     The value to to convert for display.
     * @param  array $options Optional display options.
     * @return string
     */
    public function displayVal($val, array $options = [])
    {
        if ($val === null || $val === '') {
            return '';
        }

        /** Parse multilingual values */
        if ($this->l10n()) {
            $propertyValue = $this->l10nVal($val, $options);
            if ($propertyValue === null) {
                return '';
            }
        } elseif ($val instanceof Translation) {
            $propertyValue = (string)$val;
        } else {
            $propertyValue = $val;
        }

        $separator = $this->multipleSeparator();

        /** Parse multiple values / ensure they are of array type. */
        if ($this->multiple()) {
            if (!is_array($propertyValue)) {
                $propertyValue = explode($separator, $propertyValue);
            }
        }

        if ($separator === ',') {
            $separator = ', ';
        }

        if (is_array($propertyValue)) {
            foreach ($propertyValue as &$value) {
                if (is_string($value)) {

This code seems to be duplicated across your project.

                    $value = $this->choiceLabel($value);

The method choiceLabel() does not exist on Charcoal\Property\TemplateProperty. Did you maybe mean choice()?

                    if (!is_string($value)) {
                        $value = $this->l10nVal($value, $options);
                    }
                }
            }
            $propertyValue = implode($separator, $propertyValue);
        } elseif (is_string($propertyValue)) {

This code seems to be duplicated across your project.

            $propertyValue = $this->choiceLabel($propertyValue);

The method choiceLabel() does not exist on Charcoal\Property\TemplateProperty. Did you maybe mean choice()?

            if (!is_string($propertyValue)) {
                $propertyValue = $this->l10nVal($propertyValue, $options);
            }
        }

        return $propertyValue;

The return type of return $propertyValue; (string|null|object|integer|double|boolean) is incompatible with the return type declared by the interface Charcoal\Property\PropertyInterface::displayVal of type string.

    }

    /**
     * Retrieve the selected template's FQCN.
     *
     * @return string
     */
    public function __toString()
    {
        $val = $this->val();
        if ($this->hasChoice($val)) {
            $choice = $this->choice($val);
            $keys   = [ 'controller', 'template', 'class' ];
            foreach ($keys as $key) {
                if (isset($choice[$key])) {
                    return $choice[$key];
                }
            }
        }

        return '';
    }

    /**
     * @return string
     */
    public function sqlExtra()
    {
        return '';
    }

    /**
     * Get the SQL type (Storage format)
     *
     * @return string The SQL type
     */
    public function sqlType()
    {
        if ($this->multiple()) {
            return 'TEXT';
        }

        return 'VARCHAR(255)';
    }

    /**
     * @return integer
     */
    public function sqlPdoType()
    {
        return PDO::PARAM_STR;
    }
}