Skip to content

Add readme #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kbond wants to merge 1 commit into
base: 1.x
Choose a base branch
from
Draft

Add readme #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`