README

对象集合。

技术栈

kuaukutsu/ds-collection 是基于以下主要技术栈构建的

• PHP – 编程语言
• PHPUnit – 测试框架
• GitHub Actions – 持续集成

示例

$collection = new DtoCollection();
$collection->attach(new Dto(1, 'first'));
$collection->attach(new Dto(2, 'second'));

$collectionOther = new DtoCollection();
$collectionOther->attach(new Dto(3, 'third'));
$collectionOther->attach(new Dto(4, 'fourth'));

$collection->merge($collectionOther);

过滤

$collection = new DtoCollection();
$collection->attach(new Dto(1, 'first'));
$collection->attach(new Dto(2, 'second'));
$collection->attach(new Dto(3, 'first'));
$collection->attach(new Dto(4, 'second'));

$collectionByFiltered = $collection->filter(
    static fn(Dto $dto): bool => $dto->name === 'first'
);

排序

$collection = new DtoCollection();
$collection->attach(new Dto(1, 'first'));
$collection->attach(new Dto(2, 'second'));
$collection->attach(new Dto(3, 'first'));
$collection->attach(new Dto(4, 'second'));

$sortCollection = $collection->sort(
    static fn(Dto $a, Dto $b): int => strcmp($a->name, $b->name)
);

索引

在集合类中，必须指定基于哪个对象的属性来索引集合。这通过 indexBy 方法实现，例如

/**
 * @param Dto $item
 * @return int
 */
protected function indexBy($item): int
{
    return $item->id;
}

/**
 * @param Dto $item
 * @return string
 */
protected function indexBy($item): string
{
    return $item->name;
}

这允许通过索引键快速访问对象，例如通过按键名 indexBy

$collection = new DtoCollection();
$collection->attach(new Dto(1, 'first'));
$collection->attach(new Dto(2, 'second'));

$dto = $collection->get('second');

复合键

索引键可以是复合的，例如

/**
 * @param Dto $item
 * @return array<scalar>
 */
protected function indexBy($item): array
{
    return [$item->id, $item->name];
}

$collection = new DtoCollection();
$collection->attach(new Dto(1, 'first'));
$collection->attach(new Dto(2, 'second'));
$collection->attach(new Dto(3, 'third'));

$dto = $collection->get(2, 'second');

特性

• php >= 8.0
• WeakMap (https://php.ac.cn/manual/ru/class.weakmap.php, https://sergeymukhin.com/blog/php-8-weakmaps-slabye-karty)

Docker

docker pull ghcr.io/kuaukutsu/php:8.1-cli

docker pull ghcr.io/kuaukutsu/php:8.2-cli

容器

• ghcr.io/kuaukutsu/php:${PHP_VERSION}-cli (默认)
• jakzal/phpqa:php${PHP_VERSION}

shell

docker run --init -it --rm -v "$(pwd):/app" -w /app ghcr.io/kuaukutsu/php:8.1-cli sh

测试

单元测试

该软件包使用 PHPUnit 进行测试。要运行测试

make phpunit

PHP_VERSION=7.4 make phpunit

静态分析

代码使用 Psalm 进行静态分析。要运行静态分析

make psalm

PHP_VERSION=7.4 make psalm

代码嗅探器

make phpcs

Rector

make rector