4. Getting a paginated (or flat) list of resources¶

To get a paginated list of users, we will use indexAction of our controller! In the default scenario, it will return an instance of paginator, with a list of Users.

# routing.yml

app_user_index:
    path: /users
    methods: [GET]
    defaults:
        _controller: app.controller.user:indexAction

When you go to /users, ResourceController will use the repository (app.repository.user) to create a paginator. The default template will be rendered - App:User:index.html.twig with the paginator as the users variable. A paginator can be a simple array if you disable the pagination otherwise it is a instance of Pagerfanta\Pagerfanta which is the library used to manage the pagination.

4.1. Overriding the template and criteria¶

Just like for the showAction, you can override the default template and criteria.

# routing.yml

app_user_index_inactive:
    path: /users/inactive
    methods: [GET]
    defaults:
        _controller: app.controller.user:indexAction
        _sylius:
            criteria:
                enabled: false
            template: App:User:inactive.html.twig

This action will render a custom template with a paginator only for disabled users.

4.2. Sorting collection or paginator¶

Except filtering, you can also sort users.

# routing.yml

app_user_index_top:
    path: /users/top
    methods: [GET]
    defaults:
        _controller: app.controller.user:indexAction
        _sylius:
            sorting:
                score: desc
            template: App:User:top.html.twig

Under that route, you can paginate over the users by their score.

4.3. Using a custom repository method¶

You can define your own repository method too, you can use the same way explained in <show_resource>.

Примечание

If you want to paginate your resources you need to use EntityReposiory::getPaginator($queryBuilder). It will transform your doctrine query builder into Pagerfanta\Pagerfanta object.

4.4. Changing the “max per page” option of paginator¶

You can also control the “max per page” for paginator, using paginate parameter.

# routing.yml

app_user_index_top:
    path: /users/top
    methods: [GET]
    defaults:
        _controller: app.controller.user:indexAction
        _sylius:
            paginate: 5
            sorting:
                score: desc
            template: App:User:top.html.twig

This will paginate users by 5 per page, where 10 is the default.

4.5. Disabling pagination - getting flat list¶

Pagination is handy, but you do not always want to do it, you can disable pagination and simply request a collection of resources.

# routing.yml

app_user_index_top3:
    path: /users/top
    methods: [GET]
    defaults:
        _controller: app.controller.user:indexAction
        _sylius:
            paginate: false
            limit: 3
            sorting:
                score: desc
            template: App:User:top3.html.twig

That action will return the top 3 users by score, as the users variable.

4.6. Updating the position of your resource¶

You need to define two routes, they will use to update the position of the resource.

# routing.yml

my_route_move_up:
    pattern: /{id}/move-up
    methods: [PUT]
    defaults:
        _controller: sylius.controller.resource:moveUpAction
        _sylius:
            redirect: referer
            sortable_position: priority # the default value is position

my_route_move_down:
    pattern: /{id}/move-down
    methods: [PUT]
    defaults:
        _controller: sylius.controller.resource:moveDownAction
        _sylius:
            redirect: referer
            sortable_position: priority # the default value is position

You need to update your doctrine mapping :

<!-- resource.orm.xml -->

<field name="priority" type="integer">
    <gedmo:sortable-position/>
</field>

In your template, you can use the macro move to print the move up and move down buttons:

{# index.html.twig #}

{% import 'SyliusResourceBundle:Macros:buttons.html.twig' as buttons %}

{{ buttons.move(path('my_route_move_up', {'id': resource.id}), 'up', loop.first and not resources.hasPreviousPage, loop.last and not resources.hasNextPage) }}
{{ buttons.move(path('my_route_move_down', {'id': resource.id}), 'down', loop.first and not resources.hasPreviousPage, loop.last and not resources.hasNextPage) }}

4.7. Listing tools¶

4.7.1. Sorting your resources (sylius_resource_sort)¶

This TWIG extension renders the title of your columns (in your table), it created the link used to sort your resources. You will need to enable it per route

# routing.yml

app_user_index:
    path: /users
    methods: [GET]
    defaults:
        _controller: app.controller.user:indexAction
        sortable: true

or globally

# config.yml

sylius_resource:
    settings:
        sortable: true

4.7.1.1. Parameters¶

Parameter	Mandatory	Type	Description
property	YES	string	Name of the property (attribute defined in your classes)
label	NO	string	Default order, it can be asc or desc (default : asc)
order	NO	string	Unique id of the address
options	NO	array	Additional options : template (string) : Path to the template route (string) : Key of the new route route_params (array) : Additional route parameters

This extension renders the following template : SyliusResourceBundle:Twig:sorting.html.twig. You will need to enable it per route

# routing.yml

app_user_index:
    path: /users
    methods: [GET]
    defaults:
        _controller: app.controller.user:indexAction
        paginate: $paginate

or globally

# config.yml

sylius_resource:
    settings:
        paginate: $paginate

4.7.1.2. Example¶

<table>
    <tr>
        <td>
            {{ sylius_resource_sort('productId', 'product.id'|trans) }}
        </td>
        <td>
            {{ sylius_resource_sort('productName', 'product.name'|trans, 'desc', {'route': 'my_custom_route'}) }}
        </td>
    </tr>
<table>

4.7.2. Number of item by page (sylius_resource_paginate)¶

This TWIG extension renders a HTML select which allows the user to choose how many items he wants to display in the page.

4.7.2.1. Parameters¶

Parameter	Mandatory	Type	Description
paginator	YES	string	An instance of PagerFanta
limits	YES	string	An array of paginate value
options	NO	array	Additional options : template (string) : Path to the template route (string) : Key of the new route route_params (array) : Additional route parameters

This extension renders the following template : SyliusResourceBundle:Twig:paginate.html.twig

4.7.2.2. Example¶

{{ sylius_resource_paginate(paginator, [10, 30, 50]) }}

<table>
    <!-- ... -->
</table>

{{ sylius_resource_paginate(paginator, [10, 30, 50]) }}

4.7.3. Rendering pagination¶

For now, you need to create your own macro, it could look like :

{% macro pagination(paginator, options) %}
    {% if paginator.haveToPaginate()|default(false) %}
        {{ pagerfanta(paginator, 'twitter_bootstrap3_translated', options|default({})) }}
    {% endif %}
{% endmacro %}