flo5581/larabackend

Backend for laravel

larabackend

Installation

Add packages to composer.json:

"flostone/larahelpers" : "1.0.*", _(*1)

Add to Kernel.php in App\Console:, _(*2)

\FloStone\Backend\Commands\AdminInstallation::class, _(*3)

Register Service Provider:

Flo\Backend\BackendProvider::class
Flo5581\Larahelpers\BladeExtensions::class
Maatwebsite\Excel\ExcelServiceProvider::class
, _(*4)

Add Facades

'Excel' => Maatwebsite\Excel\Facades\Excel::class, _(*5)

Execute:, _(*6)

php artisan admin:install, _(*7)

This will work with Laravel 5.0.* however you need to use strings instead of ::class
Example:
'\FloStone\Backend\Commands\AdminInstallation', _(*8)

Basic Usage

Before you do anything: Create a controller that extends, _(*9)

FloStone\Backend\Controllers\AdminController, _(*10)

and add the controller to your routes.php using, _(*11)

Route::controller('admin', 'YourController'), _(*12)

or, _(*13)

controller('admin', 'YourController'), _(*14)

Remember to protected the controller with a middleware but when you do that You need to call the parent constructor as well, _(*15)

public function __constrcut() {
parent::__construct();
``$this->middleware('admin);<br>}`, _(*16)

First you need to tell the Backend what controller methods should be displayed in the menu A key indicates the name displayed in the menu, the value tells the controller method, _(*17)

public static $displayed_actions = ['Index' => 'getIndex'], _(*18)

To create a view that displays a model you have to use the view method of the parent controller. Don't use the laravel view method! just pass through the model you wish to use., _(*19)

public function getIndex()
{
$this->view(Model::class);
}, _(*20)

To add parts to the view like a table where the content should be displayed you need to use the addTable method, _(*21)

$this->view(Model::class)->addTable(), _(*22)

This will automatically print out the data of the model in the table. Additionally you can provide a Collection of custom data to the table as the first parameter and you can decide if the content should be editable using the second parameter, the default value is true, _(*23)

$this->view(Model::class)->addTable($custom_data, true), _(*24)

Finally call the render method to make everything work, _(*25)

$this->view(Model::class)->addTable()->render(), _(*26)

To define which columns of your model should be displayed inside the table you have to add, _(*27)

public static $displayed_columns = ['email', 'name'], _(*28)

to your model and put in the fields that should be displayed To define the columns the can be edited by an admin, you need to add, _(*29)

public static $editable_columns = ['email' => []], _(*30)

Additionally you should can add properties to that field like setting a label that is shown as headline in the table, _(*31)

public static $editable_columns = ['email' => ['label' => 'E-Mail']], _(*32)

Keep in mind that not having this variable or having it empty will cause an error, _(*33)

Add an export field by using addExport as method Pass through the filetype as first parameter, _(*34)

$this->view(Model::class)->addTable()->addExport('xls')->render(), _(*35)

Model Definitions

Here is a list of all Model definitions and what they do:, _(*36)

1

public static $display_columns = ['column' => [(options)]]
Field MUST be set!
An array of all displayed columns in the backend table
Options:
'label' => 'Name of Column'
'relation' => [(properties)]
Relation Properties:
'method' => 'nameofrelationmethod'
'display' => 'displayedfieldofrelatedobject', _(*37)

2

public static $editable_columns = ['column' => [(options)]]
Field MUST be set!
An array of columns that should be editable
Options:
'label' => 'Name of Column'
'type' => 'Type of Field'
List of field types:
'string'
'text'
'textarea'
'integer'
'int'
'password'
'pass'
'checkbox'
'boolean'
'select'
'selectbox'
'enum'
'file'
'image'
, _(*38)

3

public static $export_fields = ['column' => [(options)]]
Field CAN be set
An array of fields that should be exported, exports all columns AND relations by default
Options:
'label' => 'Name of Column'
'relation' => [(properties)]
Relation Properties:
'method' => 'nameofrelationmethod'
'display' => 'displayedfieldofrelatedobject', _(*39)