okipa/laravel-bootstrap-table-list

This package is abandoned and no longer maintained. The author suggests using the https://github.com/Okipa/laravel-table package instead.

Bootstrap table list generator for Laravel.

2.1.10 2019-02-12 15:43 UTC

README

Source Code Latest Version Total Downloads License: MIT Build Status Code Coverage Scrutinizer Code Quality

Because it is sometimes convenient to build a simple backoffice without sophisticated javascript treatments, Laravel Bootstrap Table List proposes a model-based and highly customizable php table list generation, that simply render your table HTML in your view, with a code-side-configuration.

⚠️⚠️⚠️This package has been replaced by https://github.com/Okipa/laravel-table. ⚠️⚠️⚠️
⚠️⚠️⚠️Only bug fixes will be merged. Please consider moving to the new package. ⚠️⚠️⚠️

Before use

This V2 of this table list generator is pre-configured for Bootstrap 4 and Fontawesome 5.
However, this package is deeply configurable and it is possible to easily set it up for Bootstrap 3 and other versions of FA or other icon libraries (or not icon at all).
If the configuration does not give enough possibilities for your customization needs, you definitely should publish the templates and customize them in your project.

Notes:
If someone is motivated to give me a functional configuration for bootstrap 3, I will include it in the readme. It could interest some developers.
Anyway, a pre-configured bootstrap 3 version of this package does exists (with less features) : please check the v1.

Installation

  • Install the package with composer :
composer require okipa/laravel-bootstrap-table-list:^2.0
  • Laravel 5.5+ uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider. If you don't use auto-discovery or if you use a Laravel 5.4- version, add the package service provider in the register() method from your app/Providers/AppServiceProvider.php :
// laravel bootstrap table list
// https://github.com/Okipa/laravel-bootstrap-table-list
$this->app->register(Okipa\LaravelBootstrapTableList\TableListServiceProvider::class);
  • Load the package CSS or SASS file from the [path/to/composer/vendor]/okipa/laravel-bootstrap-table-list/styles directory to your project.

Package usage

Basic usage

In your controller, simply call the package like the following example to generate your table list :

// we instantiate a table list in the news controller
$table = app(TableList::class)
    ->setModel(News::class)
    ->setRoutes([
        'index' => ['alias' => 'news.index', 'parameters' => []],
    ]);
// we add some columns to the table list
$table->addColumn('title')
    ->isSortable()
    ->isSearchable()
    ->useForDestroyConfirmation();

Then, send your $table object in your view and render your table list :

{{ $table }}

That's it !

Notes :

  • Request : No need to transmit the request to the TableList : it systematically uses the current request given by the request() helper to get the number of lines to show and the searching, sorting or pagination data. However, if you need to pass a particular request to the TableList, you can do it with the setRequest() method.
  • Column titles : By default, the columns titles take the following value : trans('validation.attributes.[attribute]). You can set a custom title using the setTitle() method, especially when a a column is not related to a table attribute.

Advanced usage

If you need your table list for a more advanced usage, with a multilingual project for example, here is an example of what you can do in your controller :

// create your tablelist instance
$table = app(TableList::class)
    // set the model namespace
    ->setModel(News::class)
    // set a custom request to the table list rather than the request() one.
    ->setRequest($request)
    // set the route that will be targetted when the create / edit / delete button will be hit.
    ->setRoutes([
        'index'      => ['alias' => 'news.index', 'parameters' => []],
        'create'     => ['alias' => 'news.create', 'parameters' => []],
        'edit'       => ['alias' => 'news.edit', 'parameters' => []],
        'destroy'    => ['alias' => 'news.destroy', 'parameters' => []],
    ])
    // set the default number of rows to show in your table list.
    ->setRowsNumber(50)
    // show the rows number selector that will enable you to choose the number of rows to show.
    ->enableRowsNumberSelector()
    // add some query instructions for the special use cases
    ->addQueryInstructions(function ($query) use ($category_id) {
        // some examples of what you can do
        $query->select('news.*');
        // add a constraint
        $query->where('category_id', $category_id);
        // get value stored in a json field
        $query->addSelect('news.json_field->>json_attribute as json_attribute');
        // get a formatted value form a pivot table
        $query->selectRaw('count(comments.id) as comments_count');
        $query->leftJoin('news_commment', 'news_commment.news_id', '=', 'news.id');
        $query->leftJoin('comments', 'comments.id', '=', 'news_commment.comment_id');
        $query->groupBy('comments.id');
        // alias a value to make it available from the column model
        $query->addSelect('users.name as author');
        $query->join('users', 'users.id', '=', 'news.author_id');
    })
    // display some lines as disabled
    ->disableLines(function($model){
        return $model->id === 1 || $model->id === 2;
    }, ['disabled', 'bg-secondary'])
    // display some line as highlighted
    ->highlightLines(function($model){
        return $model->id === 3;
    }, ['highlighted', 'bg-success']);
// you can now join some columns to your tablelist.
// display the news image from a custom HTML element.
$table->addColumn('image')
    ->isCustomHtmlElement(function ($entity, $column) {
        return $entity->{$column->attribute})
            ? '<img src="' . $entity->{$column->attribute}) . '" alt="' .  $entity->title . '">'
            : null;
    });
// display the news title that is contained in the news table and use this field in the destroy confirmation modal.
// this field will also be searchable in the search field.
$table->addColumn('title')
    ->isSortable()
    ->isSearchable()
    ->useForDestroyConfirmation();
// display an abreviated content from a text with the number of caracters you want.
$table->addColumn('content')
    ->setStringLimit(30);
// display a value from a sql alias
// in this case, you will target the `users` table and the `author` field, and make this sortable and searchable.
// this way, you tell the tablelist to manipulate the `name` attribute in the sql queries but to display the aliased `author` model attribute.
$table->addColumn('author')
    ->setCustomTable('users', 'name')
    ->isSortable()
    ->isSearchable();
// display the category with a custom column title, as a button, prefixed with an icon and with a value contained in config.
$table->addColumn('category_id')
    ->setTitle('Category custom name')
    ->setIcon('your-icon')
    ->isButton(['btn', 'btn-sm', 'btn-outline-primary'])
    ->isCustomValue(function ($entity, $column) {
        return config('news.category.' . $entity->{$column->attribute});
    });
// display a button to preview the news
$table->addColumn()
    ->isLink(function($entity, $column){
        return route('news.show', ['id' => $entity->id]);
    })
    ->isButton(['btn', 'btn-sm', 'btn-primary']);
// display the formatted release date of the news and choose to sort the list by this field by default.
$table->addColumn('released_at')
    ->isSortable()
    ->sortByDefault('desc')
    ->setColumnDateTimeFormat('d/m/Y H:i:s');

API

TableList public methods

public function setModel(string $tableModel): \Okipa\LaravelBootstrapTableList\TableList

Set the model used for the table list generation (required).

public function setRequest(Request $request): \Okipa\LaravelBootstrapTableList\TableList

Set the request used for the table list generation (required).

public function setRoutes(array $routes): \Okipa\LaravelBootstrapTableList\TableList

Set the routes used for the table list generation (required) :

  • Each route will be generated with the line entity id. The given extra parameters will be added for the route generation.
  • The index route is required and must be the route that will be used to display the page that contains the table list.
  • The following routes can be defined as well :
    • create : must be used to redirect toward the entity creation page. Displays a Create button under the table list if defined.
    • edit : must be used to redirect toward the entity edition page. Displays a Edit icon on each table list line if defined.
    • destroy : must be used to destroy a table list line. Displays a Remove icon on each table list line if defined.
    • Each route have to be defined with the following structure :
'index' => [
    'alias' => 'news.index',
    'parameters' => [
        // set your extra parameters here or let the array empty
    ]
]
public function setRowsNumber(int $owsNumber): TableList

Set a custom number of rows for the table list (optional).

public function enableRowsNumberSelector(): TableList

Enables the rows number selection in the table list (optional) :

  • Calling this method displays a rows number input that enable the user to choose how much rows to show.
public function addQueryInstructions(Closure $queryClosure): TableList

Set the query closure that will be used during the table list generation (optional).
For example, you can define your joined tables here.
The closure let you manipulate the following attribute : $query`.

public function disableLines(Closure $disableLinesClosure, array $lineClass = []): TableList

Set the disable lines closure that will be executed during the table list generation (optional).
The optional second param let you set the class that will be applied for the disabled lines.
By default, the config('tablelist.value.disabled_line.class') config value is applied.
For example, you can disable the current logged user to prevent him being edited or deleted from the table list.
The closure let you manipulate the following attribute : $model.

public function highlightLines(Closure $highlightLinesClosure, array $lineClass = []): TableList

Set the highlight lines closure that will executed during the table list generation (optional).
The optional second param let you set the class that will be applied for the highlighted lines.
By default, the config('tablelist.value.highlighted_line.class') config value is applied.
The closure let you manipulate the following attribute : $model.

public function addColumn(string $attribute = null) : TableList

Add a column that will be displayed in the table list (required) :

  • At least one column must be added to the table list.
  • A column can be created without attribute specification, in case of HTML element display, for example.

TableListColumn public methods

public function setTitle(string $title): TableListColumn

Set the column title (optional).

public function sortByDefault(string $direction = 'asc'): TableListColumn

Set the default sorted column (required).

public function useForDestroyConfirmation(): TableListColumn

Use the column attribute for the destroy confirmation message generation (required) :

  • At least one column must be selected for destroy confirmation if a destroy route is set.
  • This method can be called only once.
public function isSortable(): TableListColumn

Make the column sortable (optional).

public function isSearchable(): TableListColumn

Make the column searchable (optional).

public function setCustomTable(string $customColumnTable, string $customColumnTableRealAttribute = null): TableListColumn

Define the custom related table for the column attribute (optional).
Defining the custom related table becomes mandatory if you define your column as searchable and if the column attribute does not directly belong to the table list model table. The custom real attribute will only be used for the sql request and will also be required only if the defined column attribute does not directly exist in the defined custom table.

Examples :

$table = app(TableList::class)->setRoutes($routes)
    ->setModel(Company::class)
    ->addQueryInstructions(function($query) {
        $query->select('companies.*');
        $query->addSelect('users.name as owner');
        $query->join('users', 'users.id', '=', 'companies.owner_id');
    });
// Here, you target the `owner` attribute, which is an alias produced in the `addSelect` bellow, and which will be attached to the `Company` object.
// Displaying and sorting this alias attribute wouldn't cause any problem but here, we want to authorize the search by owner.
// As this attribute does not really exist in the users table, you have to precise which real field to use for the search sql request : the `name` attribute.
$table->addColumn('owner')
    ->setCustomTable('users', 'name')
    ->isSearchable();
public function setColumnDateTimeFormat(string $columnDateFormat): TableListColumn

Set the format for a datetime, date or time attribute (optional).
(Carbon::parse($value)->format($format) method is used under the hood).

public function isButton(array $buttonClass = []): TableListColumn

Set the column button class (optional).
The attribute is wrapped into a button.

public function setIcon(string $icon, $showWithNoValue = false): TableListColumn

Set the icon to display before the value (optional).

public function setStringLimit(int $stringLimit): TableListColumn

Set the string value display limitation (optional).
Shows "..." when the limit is reached....ravel-bootstrap-table-list/src/Traits/RoutesValidationChecks.php

public function isLink($url = null): TableListColumn

Set the link url.
You can declare the link as a string or as a closure which will let you manipulate the following attributes : $entity, $column.
If no url is declared, it will be set with the column value.

public function isCustomValue(Closure $customValueClosure): TableListColumn

Set a custom value in the method closure (optional).
The closure let you manipulate the following attributes : $entity, $column.

public function isCustomHtmlElement(Closure $customHtmlEltClosure): TableListColumn

Set the HTML element to render in the method closure (optional).
The closure let you manipulate the following attributes : $entity, $column.

Configurations

To personalize the package configuration, you have to publish it first with the following script :

php artisan vendor:publish --tag=tablelist::config

Then, open the published package configuration file (config/tablelist.php) and override the default table list configuration by setting your own values.

Customize translations

You can customize the table list associated translation by publishing them in your project :

php artisan vendor:publish --tag=tablelist::translations

Once you have published them, You will find them in your resources/lang directory.

Customize templates

Publish the package blade templates file in your project :

php artisan vendor:publish --tag=tablelist::views

Then, change the content from the package templates in your resources/views/vendor/tablelist directory.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributors

License

The MIT License (MIT). Please see License File for more information.