Listem
, (*1)
Listem is an easy to use (but highly customizable) data sorting and filtering module for PHP >= 5.4, which can be used for data lists/tables/grids, reports or APIs., (*2)
Installation
Make sure you have Composer installed and run the below command from your project directory., (*3)
composer require listem/listem-php
General Usage
Set configurations and initialize., (*4)
$config = [
'filters' => [
'name' => ['label' => 'Title'],
'content' => ['label' => 'Content', 'column' => ['content', 'summary']],
'state' => [
'label' => 'State',
'type' => Listem\Filter::ENUM_INPUT,
'enums' => [
1 => 'Active',
0 => 'Draft'
]
],
'created_at' => ['label' => 'Created On', 'type' => Listem\Filter::DATE],
'category' => ['label' => 'Category', 'type' => Listem\Filter::ENUM_SELECT]
],
'sorters' => [
'name' => ['label' => 'Full Name', 'column' => 'users.name'],
'active' => ['label' => 'Active', 'column' => 'users.active']
]
];
$list = new Listem\ListEntity($config, new Listem\Conditions\MySQL, new Listem\Params\Get);
$filters = $list->getFilters();
$sorters = $list>getSorters();
$filterConditions = $filters->getConditions();
$sorterConditions = $sorters->getConditions();
$data = BlogPost::whereRaw($condition);
->orderBy($sorterConditions['column'], $sorterConditions['side'])
->get()
->toArray();
Pass $filters and $sorters to your view and render them easily., (*5)
<
table>
<thead>
<tr>
<th><?php $sorters->render('title') ?></th>
<th>Slug</th>
<th><?php $sorters->render('content') ?></th>
<!-- Or you can render parts of it, so you have more control -->
<th>
<a href="<?php $sorters->getLink('created_at') ?>">
<?php $sorters->getLabel('created_at') ?>
<span class="<?php $sorters->sorted('created_at') ? 'up' : 'down' ?>"></span>
</a>
</th>
</tr>
</thead>
...
Documentation
Contributing
Please see CONTRIBUTING and CODE_OF_CONDUCT for details., (*6)
License
The MIT License (MIT). Please see License File for more information., (*7)
Wallogit.com
