laravel-tblist

Simple admin table listing for bootstrap 3 and laravel 4|5, _(*1)

Installation

Add the following to your composer.json file:, _(*2)

"nerweb/laravel-tblist": "1.2.x"

Then, run composer update nerweb/laravel-tblist or composer install if you have not already installed packages., _(*3)

and, _(*4)

Publish assets:, _(*5)

php artisan asset:publish nerweb/laravel-tblist

Simple Example

First, create a class name UserTblist., _(*6)

use Nerweb\Tblist\BaseTblist;

class UserTblist extends BaseTblist {

    // set no result message
    public $noResults = "No User found.";

    function __construct()
    {
        $this->table = 'users';

        $this->setQuery();
        $this->setColumns();
    }

    protected function setQuery()
    {
        $this->query = User::where('active',1);
        $this->columnsToSelect = array('*');
    }

    protected function setColumns()
    {
        $this->addCheckableColumn();

        $this->columns['username'] = array(
            'label'     => 'Username',
            'sortable'  => true,
            'table_column'  => 'users.username',
        );

        $this->columns['email'] = array(
            'label'         => 'Email',
            'sortable'      => true,
            'classes'       => 'someclass someclass2',
            'table_column'  => 'users.email',
            'thead_attr'    => 'style="width:200px" data-someattr="example"',
        );

        $this->addActionColumn();
    }
}

Create a route and and its controller. insert below inside the controller method., _(*7)

$list = new UserTblist();
$list->prepareList();

return View::make('users.index', array('list', $list));

Create the blade user/index.blade.php and insert below., _(*8)

{{ Form:open(array(
    'action' => $list->getBaseURL(),
    'method' =>'get',
    'id' =>'user_tblist',
    'class' =>'tblist-form'
)) }}
{{ $list->getTableData() }}
{{ $list->getPagination() }}
{{ $list->getPaginationInfo() }}
{{ Form::close() }}

For complete example, see example folder., _(*9)

API Reference

Note! Child class should always extend Nerweb\Tblist\BaseTblist., _(*10)

Column

The column property accepts a data for column name as a key and column options as a value., _(*11)

Column key

The column key may or may not exists in the result row. Column key also assumes as the name to be sorted., _(*12)

Note! if column key doesn't exists in the result row, you should create a protected method colSetTheColumnName as custom column., _(*13)

Column options

Options	type	Description
`label`	`string`	Column header label.
`sortable`	`bool`	Whether sortable or not.
`table_column`	`string`	if set, then use its value instead of the `column key` as the column name to sort (i.e `roles.admin`, `users.admin`).
`classes`	`string`	table column classes. Note! Both applied to header, footer and body column.
`thead_attr`	`string`	Table header attribute.

Note! All column option is default to null., _(*14)

Custom Column Display

Add protected method colSetColumnNameToCamel (i.e colSetUsername, colSetCreatedAt) that only accepts 1 parameter an object of result row. Then echo or display the string., _(*15)

Example

in your class, UserTblist for this example. Add this next to setColumns method, _(*16)

protected function colSetUsername($row)
{
    echo Html::link("/users/{$row->id}/view", $row->username);
}

Custom Column

Sometimes we want to show column that is not in the result object row., _(*17)

To do this, add a column key to columns property and make sure that the sortable options is set to false., _(*18)

and, _(*19)

create a method called colSetYourColumnName($row) that accepts result row., _(*20)

Multiple Tblist

Sometimes we want to display multiple table listing on the same page., _(*21)

To do this,, _(*22)

on class initialization, in this case $list = new UserTblist(). Override base URL via $list->setBaseURL($url, $parameters) method.
set the tblist form action with $list->getBaseURL().
create the route with controller and return the json data of the tblist.