aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 81ecd196b93e3599f4be2c025d8929ca7d34c57a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# Twig SortByField Extension [![](https://img.shields.io/travis/victorhaggqvist/Twig-sort-by-field.svg?style=flat)](https://travis-ci.org/victorhaggqvist/Twig-sort-by-field)
A Twig Extension filter to sort an array of entries (objects or arrays) by an entry field.

Since version 0.1.5 Doctrine collections can be sorted as is with no need to manually extract the array first.

## Install
With composer

    composer require snilius/twig-sort-by-field

## Usage
The list could look like this, but obviously with more than one key per array.

```php
$base = array(
  array(
    "name" => "Redmine"
  ),
  array(
    "name" => "GitLab"
  ),
  array(
    "name" => "Jenkins"
  ),
  array(
    "name" => "Piwik"
  )
);
```

```twig
{% for item in base | sortbyfield('name') %}

    {{ item.name }}

{% endfor %}
```

For Symfony usage you'll want to add it as a service and tag it for Twig.

```yml
# app/config/services.yml
services:
    twig.extension.sortbyfield:
        class: Snilius\Twig\SortByFieldExtension
        tags:
            - { name: twig.extension }
```

## License

    Copyright 2015 Victor Häggqvist

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.