am2studio/laravel-exporter

1.0.2 2017-05-08 14:01 UTC

This package is not auto-updated.

Last update: 2024-12-19 06:56:39 UTC


README

Package contains trait for exporting documents

Install

Via Composer

$ composer require am2studio/laravel-exporter

Usage

Trait in controller :

/**
 * Class UserController
 * @package App\Http\Controllers\Backend\Admin
 */
class UserController extends Controller
{
    use \AM2Studio\Laravel\Exporter\Exporter;

Using trait function in controller

/**
 * @return mixed
 */
public function csv()
{
    $users = (new User)->paginate(10);
    return $this->exportOneSheet(
        $users,
        ['first_name' => 'First name', 'last_name' => 'Last Name', 'gender' => 'Gender'],
        'Users', 'users', 'xls', 'Creator', 'Company'
    );
}

Function parameters

First parameter in  \Illuminate\Pagination\LengthAwarePaginator
Second parameter is array with attribute name in db and title in export
Rest parameters are
    title for document
    filename for document
    format for document (xsl,pdf etc.)
    document creator
    document company

Change log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING and CONDUCT for details.

License

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