Skip to content

Commit 789f72e

Browse files
authored
doc: fixes (#55)
1 parent 5782b3a commit 789f72e

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,25 @@ composer require rekalogika/mapper
1919
```php
2020
use App\Entity\Book;
2121
use Rekalogika\Mapper\MapperInterface;
22-
use Rekalogika\Mapper\IterableMapperInterface;
22+
23+
// map a single object:
2324

2425
/** @var MapperInterface $mapper */
25-
/** @var IterableMapperInterface $mapper */
2626
/** @var Book $book */
27-
/** @var iterable<Book> $books */
2827

29-
$bookDto = $mapper->map($book, BookDto::class);
28+
$result = $mapper->map($book, BookDto::class);
3029

31-
// or map to an existing object
30+
// map a single object to an existing object:
3231

3332
$bookDto = new BookDto();
3433
$mapper->map($book, $bookDto);
3534

36-
// map iterable of books
35+
// map an iterable of objects:
36+
37+
/** @var IterableMapperInterface $iterableMapper */
38+
/** @var iterable<Book> $books */
3739

38-
$bookDtos = $mapper->mapIterable($books, BookDto::class);
40+
$bookDtos = $iterableMapper->mapIterable($books, BookDto::class);
3941
```
4042

4143
## Why Use a Mapper?

0 commit comments

Comments
 (0)