README

Avris Bag 是一组帮助器，使 PHP 中处理数组更加容易。

安装

composer require avris/bag

Bag

Bag 类代表一个键值存储。它可以作为一个数组和对象使用，从而缩短并优化代码

$array = [
    'foo' => 'bar',
    'lorem' => [
    	'ipsum' => ['dolor', 'sit', 'amet']
    ],
];

$bag = new Bag($array);

// all return 'bar'
var_dump(isset($array['foo']) ? $array['foo'] : null);
var_dump($bag->get('foo')); 
var_dump($bag['foo']); 
var_dump($bag('foo')); 

// all return null
var_dump(isset($array['nonexistent']) ? $array['nonexistent'] : null);
var_dump($bag->get('nonexistent')); 
var_dump($bag['nonexistent']); 
var_dump($bag('nonexistent')); 

// all return 'default'
var_dump(isset($array['nonexistent']) ? $array['nonexistent'] : 'default');
var_dump($bag->get('nonexistent', 'default')); 
var_dump($bag['nonexistent'] ?: 'default'); 
var_dump($bag('nonexistent', 'default')); 

// all are equivalent
$array['x'] => 'y';
$bag->set('x', 'y');
$bag['x'] = 'y';

// all are equivalent
var_dump(count($array));
var_dump($bag->count());
var_dump(count($bag));

// all are equivalent
var_dump(count($array) === 0);
var_dump($bag->isEmpty());
var_dump(count($bag) === 0);

// all are equivalent
var_dump(array_keys($array));
var_dump($bag->keys());
var_dump(array_keys($bag));

// all are equivalent
var_dump(isset($array['foo']));
var_dump($bag->has('foo'));
var_dump(isset($bag['foo']));

// all are equivalent
unset($array['foo']);
$bag->delete('foo');
unset($bag['foo']);
	
// all are equivalent
$array = [];
$bag->clear();

就像使用简单数组一样，您也可以对 Bag 进行 迭代 并 json_encode 它。

其他功能 包括

• $bag->getDeep($key, $default = null) -- 使用点分隔的字符串作为键从嵌套树中获取值，例如 $bag->getDeep('lorem.ipsum.1') 将返回 'sit';
• $bag->add(array) -- 将其他数组合并到 Bag 中，而不会覆盖现有键；
• $bag->replace(array) -- 将其他数组合并到 Bag 中，会覆盖现有键；
• $bag->appendToElement($key, $value) -- 将 $bag[$key] 作为列表处理并在其末尾追加 $value；
• $bag->prependToElement($key, $value) -- 将 $bag[$key] 作为列表处理并在其开头预置 $value；
• $bag->map(function ($key, $value) {}) -- 通过回调函数映射值返回一个新的 Bag；
• $bag->filter(function ($key, $value) {}) -- 返回一个新的 Bag，只包含原始 Bag 中回调函数返回为真的值。
• $bag->flatten() -- 返回一个新的 Bag，具有平展的键，例如 lorem.ipsum。

集合

Set 是一种类似的结构，但它不关心键，并确保所有值都是唯一的。有时使用回调函数实例化它很有帮助

$set = new Set(['post', 'get', 'GET'], 'strtoupper');
// internal values are: 'POST' and 'GET'

var_dump($set->has('post')); // true
var_dump($set->has('POST')); // true
var_dump($set->has('DELETE')); // false

方法

• $set->add($value)
• $set->addMultiple(array $values)
• $set->has($value)
• $set->delete($value)
• $set->first()
• $set->last()
• $set->clear()

BagHelper

这个类提供了四个静态方法

• BagHelper::isArray($object) -- 检查 $object 是否为数组或类似数组 (\Traversable);
• BagHelper::toArray($object) -- 将 $object 转换为数组；
• BagHelper::magicGetter($object, $attr, $default = null) -- 尝试从对象中获取值，使用
  • $object['key'],
  • $object->key(),
  • $object->getKey(),
  • $object->key
  • $object->get('key')
  • 如果失败，则回退到 $default。
• BagHelper::magicSetter($object, $attr, $value) -- 尝试将值设置到对象中，使用
  • $object['key'] = $value,
  • $object->setKey($value),
  • $object->key = $value,
  • $object->set($key, $value)

嵌套

这个类提供了两个静态方法，用于访问数组和对象的嵌套

• Nested::get($object, array $keys, $default = null),
• Nested::set(array &$array, array $keys, $value) (只支持数组)。

例如

Nested::get($container, ['github', 'webhooks', 'foo']);

可能返回一个值

$container->get('github')->getWebhooks()['foo'];

除非链中的任何元素不存在 -- 此时返回 $default。

类似地

Nested::set($array, ['foo', 'bar', 'baz'], 8);

等同于

$array['foo']['bar']['baz'] = 8;

但它创建所有数组，如果它们尚未存在。

QueueBag

这个类像一个正常的队列，但允许您入队和出队键值对，并为您提供标准的 Bag 功能。

$queue = new QueueBag();
$queue->enqueue('key', 'value')
$queue->enqueue('foo', 'bar')
list($key, $value) = $queue->dequeue()

StackBag

这个类像一个正常的栈，但允许您推入和弹出键值对，并为您提供标准的 Bag 功能。

$stack = new StackBag();
$stack->push('key', 'value')
$stack->push('foo', 'bar')
list($key, $value) = $stack->pop()

版权

• 作者： Andre Prusinowski (Avris.it)
• 许可证： MIT