From 789f72e204ba8496f886fc4bb4879c7756221dd7 Mon Sep 17 00:00:00 2001 From: Priyadi Iman Nurcahyo <1102197+priyadi@users.noreply.github.com> Date: Mon, 29 Apr 2024 10:54:15 +0700 Subject: [PATCH] doc: fixes (#55) --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cf274aa..d024974 100644 --- a/README.md +++ b/README.md @@ -19,23 +19,25 @@ composer require rekalogika/mapper ```php use App\Entity\Book; use Rekalogika\Mapper\MapperInterface; -use Rekalogika\Mapper\IterableMapperInterface; + +// map a single object: /** @var MapperInterface $mapper */ -/** @var IterableMapperInterface $mapper */ /** @var Book $book */ -/** @var iterable $books */ -$bookDto = $mapper->map($book, BookDto::class); +$result = $mapper->map($book, BookDto::class); -// or map to an existing object +// map a single object to an existing object: $bookDto = new BookDto(); $mapper->map($book, $bookDto); -// map iterable of books +// map an iterable of objects: + +/** @var IterableMapperInterface $iterableMapper */ +/** @var iterable $books */ -$bookDtos = $mapper->mapIterable($books, BookDto::class); +$bookDtos = $iterableMapper->mapIterable($books, BookDto::class); ``` ## Why Use a Mapper?