Ahc\Underscore\UnderscoreBase

Complexity

Total Complexity

40

Size/Duplication

Total Lines	364
Duplicated Lines	0 %

Importance

Changes	6
Bugs	1	Features	5

27 Methods

Rating	Name	Duplication	Size	Complexity
A	getData()	0	3	1
A	getIterator()	0	3	1
A	mixin()	0	3	1
A	pick()	0	5	2
A	tap()	0	5	1
A	flat()	0	15	4
A	offsetSet()	0	3	1
A	offsetExists()	0	3	1
A	offsetUnset()	0	3	1
A	__toString()	0	3	1
A	invert()	0	3	1
A	pairs()	0	9	2
A	offsetGet()	0	3	1
A	valueOf()	0	3	1
A	negate()	0	4	1
A	now()	0	3	1
A	values()	0	3	1
A	valueFn()	0	14	4
A	__call()	0	9	2
A	__get()	0	8	2
A	get()	0	7	2
A	__construct()	0	3	2
A	jsonSerialize()	0	3	1
A	keys()	0	3	1
A	clon()	0	3	1
A	omit()	0	8	2
A	count()	0	3	1

<?php

/*
 * This file is part of the PHP-UNDERSCORE package.
 *
 * (c) Jitendra Adhikari <jiten.adhikary@gmail.com>
 *     <https://github.com/adhocore>
 *
 * Licensed under MIT license.
 */

namespace Ahc\Underscore;

class UnderscoreBase implements \ArrayAccess, \Countable, \IteratorAggregate, \JsonSerializable
{
    use Arrayizes;
    use UnderscoreAliases;

    const VERSION = '0.0.2';

    /** @var array The array manipulated by this Underscore instance */
    protected $data;

    /** @var array Custom userland functionality through named callbacks */
    protected static $mixins = [];

    /**
     * Constructor. Only allow `Ahc\Underscore\Underscore` to be instantiated in userland.
     *
     * @param array|mixed $data Array or array like or array convertible.
     */
    protected function __construct($data = [])
    {
        $this->data = \is_array($data) ? $data : $this->asArray($data);
    }

    /**
     * Get the underlying array data.
     *
     * @param string|int|null $index
     *
     * @return mixed
     */
    public function get($index = null)
    {
        if (null === $index) {
            return $this->data;
        }

        return $this->data[$index];
    }

    /**
     * Get data.
     *
     * @return array
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * Flatten a multi dimension array to 1 dimension.
     *
     * @param array $array
     *
     * @return array
     */
    public function flat($array, &$flat = [])
    {
        foreach ($array as $value) {
            if ($value instanceof static) {
                $value = $value->get();
            }

            if (\is_array($value)) {
                $this->flat($value, $flat);
            } else {
                $flat[] = $value;
            }
        }

        return $flat;
    }

    /**
     * Negate a given truth test callable.
     *
     * @param callable $fn
     *
     * @return callable
     */
    protected function negate(callable $fn)
    {
        return function () use ($fn) {
            return !\call_user_func_array($fn, \func_get_args());
        };
    }

    /**
     * Get a value generator callable.
     *
     * @param callable|string|null $fn
     *
     * @return callable
     */
    protected function valueFn($fn)
    {
        if (\is_callable($fn)) {
            return $fn;
        }

        return function ($value) use ($fn) {
            if (null === $fn) {
                return $value;
            }

            $value = \array_column([$value], $fn);

It seems like $fn can also be of type callable; however, parameter $column_key of array_column() does only seem to accept integer|null|string, maybe add an additional type check?

            return  $value ? $value[0] : null;
        };
    }

    /**
     * Checks if offset/index exists.
     *
     * @param string|int $index
     *
     * @return bool
     */
    public function offsetExists($index)
    {
        return \array_key_exists($index, $this->data);
    }

    /**
     * Gets the value at given offset/index.
     *
     * @return mixed
     */
    public function offsetGet($index)
    {
        return $this->data[$index];
    }

    /**
     * Sets a new value at the given offset/index.
     *
     * @param string|int $index
     * @param mixed      $value
     *
     * @return void
     */
    public function offsetSet($index, $value)
    {
        $this->data[$index] = $value;
    }

    /**
     * Unsets/removes the value at given index.
     *
     * @param string|int $index
     */
    public function offsetUnset($index)
    {
        unset($this->data[$index]);
    }

    /**
     * Gets the count of items.
     *
     * @return int
     */
    public function count()
    {
        return \count($this->data);
    }

    /**
     * Gets the iterator for looping.
     *
     * @return \ArrayIterator
     */
    public function getIterator()
    {
        return new \ArrayIterator($this->data);
    }

    /**
     * Gets the data for json serialization.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /**
     * Stringify the underscore instance.
     *
     * @return string Json encoded data.
     */
    public function __toString()
    {
        return \json_encode($this->toArray());
    }

    /**
     * The current time in millisec.
     *
     * @return float
     */
    public function now()
    {
        return \microtime(1) * 1000;
    }

    /**
     * Get all the keys.
     *
     * @return self
     */
    public function keys()
    {
        return new static(\array_keys($this->data));
    }

    /**
     * Get all the keys.
     *
     * @return self
     */
    public function values()
    {
        return new static(\array_values($this->data));
    }

    /**
     * Pair all items to use an array of index and value.
     *
     * @return self
     */
    public function pairs()
    {
        $pairs = [];

        foreach ($this->data as $index => $value) {
            $pairs[$index] = [$index, $value];
        }

        return new static($pairs);
    }

    /**
     * Swap index and value of all the items. The values should be stringifiable.
     *
     * @return self
     */
    public function invert()
    {
        return new static(\array_flip($this->data));
    }

    /**
     * Pick only the items having one of the whitelisted indexes.
     *
     * @param array|...string|...int $index Either whitelisted indexes as array or as variads.
     *
     * @return self
     */
    public function pick($index)
    {
        $indices = \array_flip(\is_array($index) ? $index : \func_get_args());

        return new static(\array_intersect_key($this->data, $indices));
    }

    /**
     * Omit the items having one of the blacklisted indexes.
     *
     * @param array|...string|...int $index Either blacklisted indexes as array or as variads.
     *
     * @return self
     */
    public function omit($index)
    {
        $indices = \array_diff(
            \array_keys($this->data),
            \is_array($index) ? $index : \func_get_args()
        );

        return $this->pick($indices);
    }

    /**
     * Creates a shallow copy.
     *
     * @return self
     */
    public function clon()
    {
        return clone $this;
    }

    /**
     * Invokes callback fn with clone and returns original self.
     *
     * @param callable $fn
     *
     * @return self
     */
    public function tap(callable $fn)
    {
        $fn($this->clon());

        return $this;
    }

    /**
     * Adds a custom handler/method to instance. The handler is bound to this instance.
     *
     * @param string   $name
     * @param \Closure $fn
     *
     * @return self
     */
    public static function mixin($name, \Closure $fn)
    {
        static::$mixins[$name] = $fn;
    }

    /**
     * Calls the registered mixin by its name.
     *
     * @param string $name
     * @param array  $args
     *
     * @return self
     */
    public function __call($method, $args)
    {
        if (isset(static::$mixins[$method])) {
            $method = \Closure::bind(static::$mixins[$method], $this);

            return $method($args);
        }

        throw new UnderscoreException("The mixin with name '$method' is not defined");
    }

    /**
     * Facilitates the use of Higher Order Messaging.
     *
     * @param string $method
     *
     * @return self
     */
    public function __get($method)
    {
        // For now no mixins in HOM :)
        if (!\method_exists($this, $method)) {
            throw new UnderscoreException("The '$method' is not defined");
        }

        return new HigherOrderMessage($this, $method);

The expression return new Ahc\Underscore\HigherOrderMessage($this, $method) returns the type Ahc\Underscore\HigherOrderMessage which is incompatible with the documented return type Ahc\Underscore\UnderscoreBase.

    }

    /**
     * Get string value (JSON representation) of this instance.
     *
     * @return string
     */
    public function valueOf()
    {
        return (string) $this;
    }
}