Charcoal\Config\SeparatorAwareTrait

Complexity

Total Complexity

16

Size/Duplication

Total Lines	124
Duplicated Lines	19.35 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setSeparator()	0	17	3
A	separator()	0	4	1
A	hasWithSeparator()	9	15	4
A	getWithSeparator()	9	15	4
A	setWithSeparator()	6	19	4

<?php

namespace Charcoal\Config;

use InvalidArgumentException;

/**
 * Provides an object with the ability to perform lookups into multi-dimensional arrays.
 *
 * This is a full implementation of {@see SeparatorAwareInterface}.
 */
trait SeparatorAwareTrait
{
    /**
     * Token for accessing nested data.
     *
     * Is empty by default (which disables the separator feature).
     *
     * @var string
     */
    protected $separator = '';

    /**
     * Sets the token for traversing a data-tree.
     *
     * @param  string $separator The single-character token to delimit nested data.
     *     If the token is an empty string, data-tree traversal is disabled.
     * @throws InvalidArgumentException If the $separator is invalid.
     * @return self
     */
    final public function setSeparator($separator)
    {
        if (!is_string($separator)) {
            throw new InvalidArgumentException(
                'Separator must be a string'
            );
        }

        if (strlen($separator) > 1) {
            throw new InvalidArgumentException(
                'Separator must be one-character, or empty'
            );
        }

        $this->separator = $separator;
        return $this;
    }

    /**
     * Gets the token for traversing a data-tree, if any.
     *
     * @return string
     */
    final public function separator()
    {
        return $this->separator;
    }

    /**
     * Determines if this store contains the key-path and if its value is not NULL.
     *
     * Traverses each node in the key-path until the endpoint is located.
     *
     * @param  string $key The key-path to check.
     * @return boolean TRUE if $key exists and has a value other than NULL, FALSE otherwise.
     */
    final protected function hasWithSeparator($key)
    {
        $structure = $this;
        $splitKeys = explode($this->separator, $key);
        foreach ($splitKeys as $key) {

This code seems to be duplicated across your project.

            if (!isset($structure[$key])) {
                return false;
            }
            if (!is_array($structure[$key])) {
                return true;
            }
            $structure = $structure[$key];
        }
        return true;
    }

    /**
     * Returns the value from the key-path found on this object.
     *
     * Traverses each node in the key-path until the endpoint is located.
     *
     * @param  string $key The key-path to retrieve.
     * @return mixed Value of the requested $key on success, NULL if the $key is not set.
     */
    final protected function getWithSeparator($key)
    {
        $structure = $this;
        $splitKeys = explode($this->separator, $key);
        foreach ($splitKeys as $key) {

This code seems to be duplicated across your project.

            if (!isset($structure[$key])) {
                return null;
            }
            if (!is_array($structure[$key])) {
                return $structure[$key];
            }
            $structure = $structure[$key];
        }
        return $structure;
    }

    /**
     * Assign a value to the key-path, replacing / merging existing data with the same endpoint.
     *
     * Traverses, in reverse, each node in the key-path from the endpoint.
     *
     * @param  string $key   The key-path to assign $value to.
     * @param  mixed  $value The data value to assign to $key.
     * @return void
     */
    final protected function setWithSeparator($key, $value)
    {
        $structure = $value;
        $splitKeys = array_reverse(explode($this->separator, $key));
        foreach ($splitKeys as $key) {
            $structure = [
                $key => $structure
            ];
        }

        if (isset($this[$key])) {

This code seems to be duplicated across your project.

            $data = $this[$key];
            if (is_array($data)) {
                $structure[$key] = array_replace_recursive($data, $structure[$key]);
            }
        }

        $this[$key] = $structure[$key];
    }
}