Skip to content

Commit

Permalink
docs: ✏️ UPDATE README
Browse files Browse the repository at this point in the history
  • Loading branch information
mpyw committed Jun 19, 2021
1 parent cd32bc9 commit f08c1b0
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,8 @@ Note: See also [lampager/lampager](https://github.com/lampager/lampager).

| Name | Type | Parent Class | Description |
|:---|:---|:---|:---|
| Lampager\\Doctrine2\\`Paginator` | Class | Lampager\\`Paginator` | Fluent factory implementation for Laravel |
| Lampager\\Doctrine2\\`Processor` | Class | Lampager\\`AbstractProcessor` | Processor implementation for Laravel |
| Lampager\\Doctrine2\\`Paginator` | Class | Lampager\\`Paginator` | Fluent factory implementation for Doctrine 2 |
| Lampager\\Doctrine2\\`Processor` | Class | Lampager\\`AbstractProcessor` | Processor implementation for Doctrine 2 |
| Lampager\\Doctrine2\\`Compiler` | Class | | Compile Lampager Query into Doctrine QueryBuilder |

## API
Expand All @@ -193,6 +193,24 @@ static Paginator create(\Doctrine\ORM\QueryBuilder $builder): static
Paginator::__construct(\Doctrine\ORM\QueryBuilder $builder)
```

### Paginator::setMapping()

```php
Paginator::setMapping(string[] $mapping): $this
```

#### Arguments

- **`(string[])`** __*$mapping*__<br> An associative array that contains `$columnNameOrCursorKey => $fetchedFieldName`.

### Paginator::setMaxResults()

Alias for `\Lampager\Paginator::limit()`.

```php
Paginator::setMaxResults(int $limit): $this
```

### Paginator::transform()

Transform Lampager Query into Doctrine Query.
Expand Down

0 comments on commit f08c1b0

Please sign in to comment.