diff --git a/README.md b/README.md new file mode 100644 index 0000000..397abf9 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# zenstruck/collection + +[![CI](https://github.com/zenstruck/collection/actions/workflows/ci.yml/badge.svg)](https://github.com/zenstruck/collection/actions/workflows/ci.yml) +[![codecov](https://codecov.io/gh/zenstruck/collection/branch/1.x/graph/badge.svg?token=SD4WLSHY7X)](https://codecov.io/gh/zenstruck/collection) + +Helpers for iterating/paginating/filtering collections (with Doctrine [ORM](#orm)/DBAL implementations and [batch +processing](#batch-processing) utilities). + +## Installation + +```bash +composer require zenstruck/collection +``` + +## `Collection` + +### `IterableCollection` + +### `FactoryCollection` + +### `CallbackCollection` + +## Pagination + +### `Page` + +### `PageCollection` + +### `Paginatable` + +### Pagerfanta Adapter + +## Doctrine Integration + +### `CollectionDecorator` + +### ORM + +#### Batch Processing + +##### `BatchIterator` + +##### `BatchProcessor` + +#### `Result` + +##### `Deletable` + +#### `Repository` + +##### `ObjectRepository` + +##### `CollectionRepository` + +TODO: document `Paginatable` usage + +##### `ServiceRepository` + +##### `EntityRepositoryMixin` + +##### `Writable` + +##### `Removable` + +##### `Flushable`