Download the PHP package christhompsontldr/laraman without Composer
On this page you can find all versions of the php package christhompsontldr/laraman. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download christhompsontldr/laraman
More information about christhompsontldr/laraman
Files in christhompsontldr/laraman
Informations about the package laraman
Laraman - Laravel Data Manager
Laraman is a Laravel based administration panel.
Laraman provides a quick user interface for reviewing and managing data stored in your database.
Laraman is really good at the index route, searching, filtering and pagination. It leaves the create, update and delete to the application.
Installation
Composer
Require this package with composer:
Service Provider
After updating composer, add the ServiceProvider to the providers array in config/app.php
Laravel 5.x:
Config
Copy the config/laraman.php
file from the packge to your applications config directory.
Routes
Laraman utilizes the resource
method in routes to build all the required routes.
In routes/web.php
add"
Laraman will now look for a app/Http/Controllers/Manage/UserController.php
.
The namespace of the Laraman controllers can be changed in the config/laraman.php
file. Manage
is the default namespace.
Models
Include the Laraman trait on your model
and then use it
Laraman utilizes something we call formatters
. We have included a few default formatters, but you are welcome to write your own. Review the Christhompsontldr\Laraman\Traits\LaramanModel
class for examples.
Think of these as post-accessors. This allows Laraman to manipulate model data after the application's accessors have been applied.
Example of using the date formatter
Controllers
Include the Laraman trait on your controller
and then use it
Laraman expects your controller to have a __configure()
method where a few things are configured.
This example will build an index route with a table with 4 columns and 1 button.
Options
Model
If the model name you want to use doesn't make the naming convention you used for your controller, it can be set with the model attribute
Views
Need to load views from another path, use the viewPath
attribute
Route
The route where laraman lives for this controller can be changed
Search
You can enable model level searches with the searchEnabled
attribute
Your model will need to have implemented a search()
method. This is commonly found in the Laravel Scout library or the Algolia Search for Laravel library.
Columns
The only required array key for a column is the field
. This will be the database column name you want to display.
display
display
will change the name displayed to the user in the top of the table.
related model data
The dot notation can be used to reach related model data.
organization.name
will load the name from the related organization.
blade
If you need to use a custom blade for a field, define it like this
Filters
Laraman can utilize filters defined on the model
If the model has a filterEvent
defined, it will be utilized
Could be used to apply model scopes like scopeSend()
and scopeOpen()
.
Buttons
Action buttons can be added with the buttons
attribute
Scopes
If you need to scope the model being used, define a scope
method in your controller
Extras
Have extra data to pass from the controller to the view, use extras