feat: add underscore base class

Author: adhocore

src/UnderscoreBase.php

@@ -0,0 +1,202 @@
+<?php
+
+namespace Ahc\Underscore;
+
+class UnderscoreBase implements \ArrayAccess, \Countable, \IteratorAggregate, \JsonSerializable
+{
+    const VERSION = '0.0.1';
+
+    /** @var array The array manipulated by this Underscore instance */
+    protected $data;
+
+    /**
+     * Constructor.
+     *
+     * @param array|mixed $data.
+     */
+    public 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 as array.
+     *
+     * @param mixed $data
+     *
+     * @return array
+     */
+    public function asArray($data)
+    {
+        if (\is_array($data)) {
+            return $data;
+        }
+
+        if ($data instanceof static) {
+            return $data->get();
+        }
+
+        // @codeCoverageIgnoreStart
+        if ($data instanceof \Traversable) {
+            return \iterator_to_array($data);
+        }
+        // @codeCoverageIgnoreEnd
+
+        if ($data instanceof \JsonSerializable) {
+            return $data->jsonSerialize();
+        }
+
+        if (\method_exists($data, 'toArray')) {
+            return $data->toArray();
+        }
+
+        return (array) $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);
+
+            return $value ? $value[0] : null;
+        };
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function offsetExists($index)
+    {
+        return \array_key_exists($index, $this->data);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function offsetGet($index)
+    {
+        return $this->data[$index];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function offsetSet($index, $value)
+    {
+        $this->data[$index] = $value;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function offsetUnset($index)
+    {
+        unset($this->data[$index]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function count()
+    {
+        return \count($this->data);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getIterator()
+    {
+        return new \ArrayIterator($this->data);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function jsonSerialize()
+    {
+        return $this->data;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __toString()
+    {
+        return \json_encode($this->data);
+    }
+
+    public static function _($data)
+    {
+        return new static($data);
+    }
+}