Skip to content
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

Jump to bottom

Add documentation details on how to extends views #633

Merged
merged 2 commits into from
Feb 19, 2020
Merged

Add documentation details on how to extends views #633

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea3a09e
Add details on how to extends views
remy-theroux Feb 17, 2020
ca19189
Fix property visibility and class extensibility
remy-theroux Feb 17, 2020
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
9 changes: 9 additions & 0 deletions doc/Cookbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,15 @@ sylius_shop_api:
total: \NiceTotalView
```

You have to extend the base view class in order to match view factory type hint.
```php
class NiceTotalView extends TotalView
{
/** @var float */
public $nicePersonDiscount;
}
```

One other thing to keep in mind when working with the API and creating new views is that the endpoints that return multiple resources (for example a list of products) are usually paginated. Pagination in the shop api is implemented with the plugin [Pagerfanta](https://github.com/whiteoctober/Pagerfanta) which needs besides the attributes that it should serialize on the product also a key relations like the route to the individual products. The current object you are serializing is in the object "variable" and can be used with the expression syntax as shown below:
```yml
relations:
Expand Down