broke basic FlatArray behavior into trait
This commit is contained in:
Joby Elliott
parent
adad4833e8
commit
d037e063a7
2 changed files with 216 additions and 208 deletions
|
|
@ -4,217 +4,10 @@ namespace Flatrr;
|
|||
|
||||
class FlatArray implements FlatArrayInterface
|
||||
{
|
||||
private $_arrayData = array();
|
||||
use FlatArrayTrait;
|
||||
|
||||
public function __construct(array $data = null)
|
||||
{
|
||||
$this->merge($data);
|
||||
}
|
||||
|
||||
public function push(?string $name, $value)
|
||||
{
|
||||
$arr = $this->get($name);
|
||||
if ($arr !== null && !is_array($arr)) {
|
||||
return;
|
||||
}
|
||||
$arr[] = $value;
|
||||
$this->set($name, $arr);
|
||||
}
|
||||
|
||||
public function pop(?string $name)
|
||||
{
|
||||
$arr = $this->get($name);
|
||||
if ($arr !== null && !is_array($arr)) {
|
||||
return;
|
||||
}
|
||||
$out = array_pop($arr);
|
||||
$this->set($name, $arr);
|
||||
return $out;
|
||||
}
|
||||
|
||||
public function shift(?string $name, $value)
|
||||
{
|
||||
$arr = $this->get($name);
|
||||
if ($arr !== null && !is_array($arr)) {
|
||||
return;
|
||||
}
|
||||
array_unshift($arr, $value);
|
||||
$this->set($name, $arr);
|
||||
}
|
||||
|
||||
public function unshift(?string $name)
|
||||
{
|
||||
$arr = $this->get($name);
|
||||
if ($arr !== null && !is_array($arr)) {
|
||||
return;
|
||||
}
|
||||
$out = array_shift($arr);
|
||||
$this->set($name, $arr);
|
||||
return $out;
|
||||
}
|
||||
|
||||
public function set(?string $name, $value)
|
||||
{
|
||||
return $this->flattenSearch($name, $value);
|
||||
}
|
||||
|
||||
public function get(?string $name = null)
|
||||
{
|
||||
return $this->flattenSearch($name);
|
||||
}
|
||||
|
||||
public function unset(?string $name)
|
||||
{
|
||||
$this->flattenSearch($name, null, true);
|
||||
}
|
||||
|
||||
public function offsetSet($name, $value)
|
||||
{
|
||||
return $this->set($name, $value);
|
||||
}
|
||||
|
||||
public function offsetGet($name)
|
||||
{
|
||||
return $this->get($name);
|
||||
}
|
||||
|
||||
public function offsetExists($name)
|
||||
{
|
||||
return $this->flattenSearch($name) !== null;
|
||||
}
|
||||
|
||||
public function offsetUnset($name)
|
||||
{
|
||||
return $this->unset($name);
|
||||
}
|
||||
|
||||
public function rewind()
|
||||
{
|
||||
return reset($this->_arrayData);
|
||||
}
|
||||
|
||||
public function current()
|
||||
{
|
||||
return current($this->_arrayData);
|
||||
}
|
||||
|
||||
public function next()
|
||||
{
|
||||
return next($this->_arrayData);
|
||||
}
|
||||
|
||||
public function key()
|
||||
{
|
||||
return key($this->_arrayData);
|
||||
}
|
||||
|
||||
public function valid()
|
||||
{
|
||||
return isset($this->_arrayData[$this->key()]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively set a value, with control over whether existing values or new
|
||||
* values take precedence
|
||||
*/
|
||||
public function merge($value, string $name = null, bool $overwrite = false)
|
||||
{
|
||||
if (!isset($this[$name])) {
|
||||
//easiest possible outcome, old value doesn't exist, so we can just write the value
|
||||
$this->set($name, $value);
|
||||
return;
|
||||
} elseif (is_array($value) && is_array($this->get($name))) {
|
||||
//both new and old values are arrays
|
||||
foreach ($value as $k => $v) {
|
||||
if ($name) {
|
||||
$k = $name.'.'.$k;
|
||||
}
|
||||
$this->merge($v, $k, $overwrite);
|
||||
}
|
||||
return;
|
||||
} else {
|
||||
//old and new values exist, and one or both are not arrays, $overwrite rules the day
|
||||
if ($overwrite) {
|
||||
$this->set($name, $value);
|
||||
}
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively builds a reference down into $this->config from a config key
|
||||
* string. It sets it if $value exists, otherwise it returns the value if it
|
||||
* exists.
|
||||
*/
|
||||
protected function flattenSearch(?string $name, $value = null, $unset = false)
|
||||
{
|
||||
//normalize key names in $value, and also $name
|
||||
$value = $this->normalizeValue($value);
|
||||
$name = preg_replace('/[^a-z0-9\-\_\.]/', '', strtolower($name));
|
||||
//check for home strings
|
||||
if ($name == '' || $name === null) {
|
||||
if ($unset) {
|
||||
$this->_arrayData = [];
|
||||
} elseif ($value !== null) {
|
||||
$this->_arrayData = $value;
|
||||
}
|
||||
return $this->_arrayData;
|
||||
}
|
||||
//validate
|
||||
if (substr($name, -1, 1) == '.' || substr($name, 0, 1) == '..' || strpos($name, '..') !== false) {
|
||||
return null;
|
||||
}
|
||||
//build a reference to where this name should be
|
||||
$parent = &$this->_arrayData;
|
||||
$name = explode('.', $name);
|
||||
$key = array_pop($name);
|
||||
foreach ($name as $part) {
|
||||
if (!isset($parent[$part])) {
|
||||
if ($value !== null) {
|
||||
$parent[$part] = array();
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
$parent = &$parent[$part];
|
||||
}
|
||||
//now we have a ref, see if we can unset or set it
|
||||
if ($unset) {
|
||||
unset($parent[$key]);
|
||||
return null;
|
||||
} elseif ($value !== null) {
|
||||
if (is_array(@$parent[$key]) && is_array($value)) {
|
||||
//both value and destination are arrays, merge them
|
||||
$parent[$key] = array_replace_recursive($parent[$key], $value);
|
||||
} else {
|
||||
//set the hard way
|
||||
if (!is_array($parent)) {
|
||||
$parent = array();
|
||||
}
|
||||
$parent[$key] = $value;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
//return value
|
||||
if (!is_array($parent)) {
|
||||
return null;
|
||||
}
|
||||
return @$parent[$key];
|
||||
}
|
||||
|
||||
protected function normalizeValue($value)
|
||||
{
|
||||
if (!is_array($value)) {
|
||||
return $value;
|
||||
}
|
||||
$norm = [];
|
||||
foreach ($value as $key => $value) {
|
||||
$nKey = preg_replace('/[^a-z0-9\-\_]/', '', strtolower($key));
|
||||
if ($nKey == '') {
|
||||
throw new \Exception("Key \"$key\" can't be used inside a FlatArray");
|
||||
}
|
||||
$norm[$nKey] = $this->normalizeValue($value);
|
||||
}
|
||||
return $norm;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
215
src/FlatArrayTrait.php
Normal file
215
src/FlatArrayTrait.php
Normal file
|
|
@ -0,0 +1,215 @@
|
|||
<?php
|
||||
/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
|
||||
namespace Flatrr;
|
||||
|
||||
trait FlatArrayTrait
|
||||
{
|
||||
private $_arrayData = array();
|
||||
|
||||
public function push(?string $name, $value)
|
||||
{
|
||||
$arr = $this->get($name);
|
||||
if ($arr !== null && !is_array($arr)) {
|
||||
return;
|
||||
}
|
||||
$arr[] = $value;
|
||||
$this->set($name, $arr);
|
||||
}
|
||||
|
||||
public function pop(?string $name)
|
||||
{
|
||||
$arr = $this->get($name);
|
||||
if ($arr !== null && !is_array($arr)) {
|
||||
return;
|
||||
}
|
||||
$out = array_pop($arr);
|
||||
$this->set($name, $arr);
|
||||
return $out;
|
||||
}
|
||||
|
||||
public function shift(?string $name, $value)
|
||||
{
|
||||
$arr = $this->get($name);
|
||||
if ($arr !== null && !is_array($arr)) {
|
||||
return;
|
||||
}
|
||||
array_unshift($arr, $value);
|
||||
$this->set($name, $arr);
|
||||
}
|
||||
|
||||
public function unshift(?string $name)
|
||||
{
|
||||
$arr = $this->get($name);
|
||||
if ($arr !== null && !is_array($arr)) {
|
||||
return;
|
||||
}
|
||||
$out = array_shift($arr);
|
||||
$this->set($name, $arr);
|
||||
return $out;
|
||||
}
|
||||
|
||||
public function set(?string $name, $value)
|
||||
{
|
||||
return $this->flattenSearch($name, $value);
|
||||
}
|
||||
|
||||
public function get(?string $name = null)
|
||||
{
|
||||
return $this->flattenSearch($name);
|
||||
}
|
||||
|
||||
public function unset(?string $name)
|
||||
{
|
||||
$this->flattenSearch($name, null, true);
|
||||
}
|
||||
|
||||
public function offsetSet($name, $value)
|
||||
{
|
||||
return $this->set($name, $value);
|
||||
}
|
||||
|
||||
public function offsetGet($name)
|
||||
{
|
||||
return $this->get($name);
|
||||
}
|
||||
|
||||
public function offsetExists($name)
|
||||
{
|
||||
return $this->flattenSearch($name) !== null;
|
||||
}
|
||||
|
||||
public function offsetUnset($name)
|
||||
{
|
||||
return $this->unset($name);
|
||||
}
|
||||
|
||||
public function rewind()
|
||||
{
|
||||
return reset($this->_arrayData);
|
||||
}
|
||||
|
||||
public function current()
|
||||
{
|
||||
return current($this->_arrayData);
|
||||
}
|
||||
|
||||
public function next()
|
||||
{
|
||||
return next($this->_arrayData);
|
||||
}
|
||||
|
||||
public function key()
|
||||
{
|
||||
return key($this->_arrayData);
|
||||
}
|
||||
|
||||
public function valid()
|
||||
{
|
||||
return isset($this->_arrayData[$this->key()]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively set a value, with control over whether existing values or new
|
||||
* values take precedence
|
||||
*/
|
||||
public function merge($value, string $name = null, bool $overwrite = false)
|
||||
{
|
||||
if (!isset($this[$name])) {
|
||||
//easiest possible outcome, old value doesn't exist, so we can just write the value
|
||||
$this->set($name, $value);
|
||||
return;
|
||||
} elseif (is_array($value) && is_array($this->get($name))) {
|
||||
//both new and old values are arrays
|
||||
foreach ($value as $k => $v) {
|
||||
if ($name) {
|
||||
$k = $name.'.'.$k;
|
||||
}
|
||||
$this->merge($v, $k, $overwrite);
|
||||
}
|
||||
return;
|
||||
} else {
|
||||
//old and new values exist, and one or both are not arrays, $overwrite rules the day
|
||||
if ($overwrite) {
|
||||
$this->set($name, $value);
|
||||
}
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively builds a reference down into $this->config from a config key
|
||||
* string. It sets it if $value exists, otherwise it returns the value if it
|
||||
* exists.
|
||||
*/
|
||||
protected function flattenSearch(?string $name, $value = null, $unset = false)
|
||||
{
|
||||
//normalize key names in $value, and also $name
|
||||
$value = $this->normalizeValue($value);
|
||||
$name = preg_replace('/[^a-z0-9\-\_\.]/', '', strtolower($name));
|
||||
//check for home strings
|
||||
if ($name == '' || $name === null) {
|
||||
if ($unset) {
|
||||
$this->_arrayData = [];
|
||||
} elseif ($value !== null) {
|
||||
$this->_arrayData = $value;
|
||||
}
|
||||
return $this->_arrayData;
|
||||
}
|
||||
//validate
|
||||
if (substr($name, -1, 1) == '.' || substr($name, 0, 1) == '..' || strpos($name, '..') !== false) {
|
||||
return null;
|
||||
}
|
||||
//build a reference to where this name should be
|
||||
$parent = &$this->_arrayData;
|
||||
$name = explode('.', $name);
|
||||
$key = array_pop($name);
|
||||
foreach ($name as $part) {
|
||||
if (!isset($parent[$part])) {
|
||||
if ($value !== null) {
|
||||
$parent[$part] = array();
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
$parent = &$parent[$part];
|
||||
}
|
||||
//now we have a ref, see if we can unset or set it
|
||||
if ($unset) {
|
||||
unset($parent[$key]);
|
||||
return null;
|
||||
} elseif ($value !== null) {
|
||||
if (is_array(@$parent[$key]) && is_array($value)) {
|
||||
//both value and destination are arrays, merge them
|
||||
$parent[$key] = array_replace_recursive($parent[$key], $value);
|
||||
} else {
|
||||
//set the hard way
|
||||
if (!is_array($parent)) {
|
||||
$parent = array();
|
||||
}
|
||||
$parent[$key] = $value;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
//return value
|
||||
if (!is_array($parent)) {
|
||||
return null;
|
||||
}
|
||||
return @$parent[$key];
|
||||
}
|
||||
|
||||
protected function normalizeValue($value)
|
||||
{
|
||||
if (!is_array($value)) {
|
||||
return $value;
|
||||
}
|
||||
$norm = [];
|
||||
foreach ($value as $key => $value) {
|
||||
$nKey = preg_replace('/[^a-z0-9\-\_]/', '', strtolower($key));
|
||||
if ($nKey == '') {
|
||||
throw new \Exception("Key \"$key\" can't be used inside a FlatArray");
|
||||
}
|
||||
$norm[$nKey] = $this->normalizeValue($value);
|
||||
}
|
||||
return $norm;
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue