rapyd-laravel
This is a pool of presentation and editing widgets (Grids and Forms) for laravel.
Nothing to "generate", just some classes to let you develop and maintain CRUD backends in few lines of code.
Documentation: Wiki
Demo: rapyd.dev
Install in Laravel 8, 7, 6, 5.8..
require the package in your Laravel
$ composer require zofe/rapyd
then publish assets:
$ php artisan vendor:publish
and choose Zofe\Rapyd\RapydServiceProvider
how to
just go to /rapyd-demo for a bit of demos of all widgets.
Then you'll be able to populate some data (be sure that db connection env/config is valid)
A couple of minutes of your time before you start
I came from an era where there was mutual appreciation among programmers, if you use this library and benefit from it join-me on Linkedin and write a short review.
Thanks to Mihai Berende for having done it already
me@linkedin
DataSet
DataSet is a simple presenter, it build a super-collection, a pagination and orderby links. You can start from tablename, a query, a model, o just an array.
in a controller
$set = \DataSet::source("tablename")->paginate(10)->getSet();
$set = \DataSet::source(DB::table('users')->select('name', 'email'))->paginate(10)->getSet();
$set = \DataSet::source(new Article)->paginate(10)->getSet();
$set = \DataSet::source(Article::with('author'))->paginate(10)->getSet();
$set = \DataSet::source($multidimensional_array)->paginate(10)->getSet();
in a view you can just write
<p>
//cycle
@foreach ($set->data as $item)
{{ $item->title }}<br />
{{ $item->author->name }}<br />
@endforeach
//pagination
{{ $set->links() }} <br />
//sort link
{{ $set->orderbyLink('title', 'asc') }} <br />
</p>
DataGrid
DataGrid extend DataSet to make data-grid output with few lines of fluent code.
It build a bootstrap striped table, with pagination at bottom and order-by links on table header. It support also blade syntax, filters, closures etc..
in a controller
$grid = \DataGrid::source(Article::with('author')); //same source types of DataSet
$grid->add('title','Title', true); //field name, label, sortable
$grid->add('author.fullname','author'); //relation.fieldname
$grid->add('{{ substr($body,0,20) }}...','Body'); //blade syntax with main field
$grid->add('{{ $author->firstname }}','Author'); //blade syntax with related field
$grid->add('body|strip_tags|substr[0,20]','Body'); //filter (similar to twig syntax)
$grid->add('body','Body')->filter('strip_tags|substr[0,20]'); //another way to filter
$grid->edit('/articles/edit', 'Edit','modify|delete'); //shortcut to link DataEdit actions
//cell closure
$grid->add('revision','Revision')->cell( function( $value, $row) {
return ($value != '') ? "rev.{$value}" : "no revisions for art. {$row->id}";
});
//row closure
$grid->row(function ($row) {
if ($row->cell('public')->value < 1) {
$row->cell('title')->style("color:Gray");
$row->style("background-color:#CCFF66");
}
});
$grid->link('/articles/edit',"Add New", "TR"); //add button
$grid->orderBy('article_id','desc'); //default orderby
$grid->paginate(10); //pagination
view('articles', compact('grid'))
in a view you can just write
#articles.blade.php
{!! $grid !!}
styling a datagrid
...
$grid->add('title','Title', true)->style("width:100px"); //adding style to th
$grid->add('body','Body')->attr("class","custom_column"); //adding class to a th
...
//row and cell manipulation via closure
$grid->row(function ($row) {
if ($row->cell('public')->value < 1) {
$row->cell('title')->style("color:Gray");
$row->style("background-color:#CCFF66");
}
});
...
datagrid supports also csv output, so it can be used as "report" tool.
...
$grid->add('title','Title');
$grid->add('body','Body')
...
$grid->buildCSV(); // force download
$grid->buildCSV('export_articles', 'Y-m-d.His'); // force download with custom stamp
$grid->buildCSV('uploads/filename', 'Y-m-d'); // write on file
...
$grid->buildCSV('uploads/filename', 'Y-m-d', false); // without sanitize cells
$as_excel = ['delimiter'=>',', 'enclosure'=>'"', 'line_ending'=>"\n"];
$grid->buildCSV('uploads/filename', 'Y-m-d', true, $as_excel); // with customizations
DataForm
DataForm is a form builder, you can add fields, rules and buttons.
It will build a bootstrap form, on submit it will check rules and if validation pass it'll store new entity.
//start with empty form to create new Article
$form = \DataForm::source(new Article);
//or find a record to update some value
$form = \DataForm::source(Article::find(1));
//add fields to the form
$form->add('title','Title', 'text'); //field name, label, type
$form->add('body','Body', 'textarea')->rule('required'); //validation
//some enhanced field (images, wysiwyg, autocomplete, maps, etc..):
$form->add('photo','Photo', 'image')->move('uploads/images/')->preview(80,80);
$form->add('body','Body', 'redactor'); //wysiwyg editor
$form->add('author.name','Author','autocomplete')->search(['firstname','lastname']);
$form->add('categories.name','Categories','tags'); //tags field
$form->add('map','Position','map')->latlon('latitude','longitude'); //google map
//you can also use now the smart syntax for all fields:
$form->text('title','Title'); //field name, label
$form->textarea('body','Body')->rule('required'); //validation
//change form orientation
$form->attributes(['class'=>'form-inline']);
...
$form->submit('Save');
$form->saved(function() use ($form)
{
$form->message("ok record saved");
$form->link("/another/url","Next Step");
});
view('article', compact('form'))
#article.blade.php
{!! $form !!}
customize form in view
You can directly customize form using build() in your controller
...
$form->build();
view('article', compact('form'))
then in the view you can use something like this:
#article.blade.php
{!! $form->header !!}
{!! $form->message !!} <br />
@if(!$form->message)
<div class="row">
<div class="col-sm-4">
{!! $form->render('title') !!}
</div>
<div class="col-sm-8">
{!! $form->render('body') !!}
</div>
</div>
...
@endif
{!! $form->footer !!}
custom form layout explained
custom form layout demo
DataEdit
DataEdit extends DataForm, it's a full CRUD application for given Entity.
It has status (create, modify, show) and actions (insert, update, delete) It detect status by simple query string semantic:
/dataedit/uri empty form to CREATE new records
/dataedit/uri?show={record_id} filled output to READ record (without form)
/dataedit/uri?modify={record_id} filled form to UPDATE a record
/dataedit/uri?delete={record_id} perform record DELETE
...
//simple crud for Article entity
$edit = \DataEdit::source(new Article);
$edit->link("article/list","Articles", "TR")->back();
$edit->add('title','Title', 'text')->rule('required');
$edit->add('body','Body','textarea')->rule('required');
$edit->add('author.name','Author','autocomplete')->search(['firstname','lastname']);
//you can also use now the smart syntax for all fields:
$edit->textarea('title','Title');
$edit->autocomplete('author.name','Author')->search(['firstname','lastname']);
return $edit->view('crud', compact('edit'));
#crud.blade.php
{!! $edit !!}
DataFilter
DataFilter extends DataForm, each field you add and each value you fill in that form is used to build a where clause (by default using 'like' operator).
It should be used in conjunction with a DataSet or DataGrid to filter results.
It also support query scopes (see eloquent documentation), closures, and a cool DeepHasScope trait see samples:
$filter = \DataFilter::source(new Article);
//simple like
$filter->add('title','Title', 'text');
//simple where with exact match
$filter->add('id', 'ID', 'text')->clause('where')->operator('=');
//custom query scope, you can define the query logic in your model
$filter->add('search','Search text', 'text')->scope('myscope');
//cool deep "whereHas" (you must use DeepHasScope trait bundled on your model)
//this can build a where on a very deep relation.field
$filter->add('search','Search text', 'text')->scope('hasRel','relation.relation.field');
//closure query scope, you can define on the fly the where
$filter->add('search','Search text', 'text')->scope( function ($query, $value) {
return $query->whereIn('field', ["1","3",$value]);
})
$filter->submit('search');
$filter->reset('reset');
$grid = \DataGrid::source($filter);
$grid->add('nome','Title', true);
$grid->add('{{ substr($body,0,20) }}...','Body');
$grid->paginate(10);
view('articles', compact('filter', 'grid'))
# articles.blade
{!! $filter !!}
{!! $grid !!}
DataFilter explained
Custom layout and custom query scope
DataTree
The DataTree extends the DataGrid, and displays sortable tree widget. It supports all the methods of the DataGrid with the exception of pagination and sorting. Another difference is you need to pass in an already loaded Baum Model, not an empty Model or Query Builder.
To use this widget you need to php composer.phar require baum/baum and make sure your model extends Baum\Node.
// the root node won't appear, only its sub-nodes will be displayed.
$root = Menu::find(1) or App::abort(404);
$tree = \DataTree::source($root);
$tree->add('title');
$tree->edit("/menu/edit", 'Edit', 'modify|delete');
$tree->submit('Save the order');
return view('menu-list', compact('tree'));
Namespace consideration, Extending etc.
To use widgets you can:
- just use the global aliases:
\DataGrid::source()...(please note the '') - or import facades:
use Zofe\Rapyd\Facades\DataSet;
use Zofe\Rapyd\Facades\DataGrid;
use Zofe\Rapyd\Facades\DataForm;
use Zofe\Rapyd\Facades\DataForm;
use Zofe\Rapyd\Facades\DataEdit;
..
DataGrid::source()...
- or you can extend each class
Class MyDataGrid extends Zofe\Rapyd\DataGrid\DataGrid {
...
}
Class MyDataEdit extends Zofe\Rapyd\DataEdit\DataEdit {
...
}
..
MyDataGrid::source()
Publish & override configuration and assets
You can quickly publish the configuration file (to override something) by running the following Artisan command.
$ php artisan vendor:publish
You need also to add this to your views, to let rapyd add runtime assets:
<head>
...
<link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
<script src="http://code.jquery.com/jquery-1.10.1.min.js"></script>
<script src="//netdna.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
{!! Rapyd::head() !!}
</head>
note: widget output is in standard with Boostrap 3+, and some widget need support of JQuery 1.9+ so be sure to include dependencies as above
A better choice is to split css and javascipts and move javascript at bottom, just before body to speedup the page, you can do this with:
<head>
...
<link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
{!! Rapyd::styles() !!}
</head>
....
<script src="http://code.jquery.com/jquery-1.10.1.min.js"></script>
<script src="//netdna.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
{!! Rapyd::scripts() !!}
</body>
In short
Rapyd use a "widget" approach to make a crud, without "generation". (this approach is worst in terms of flexibility but fast/rapid in terms of development and maintenance):
You need to "show" and "edit" record from an entity?
Ok so you need a DataGrid and DataEdit. You can build widgets where you want (even multiple widgets on same route). An easy way to work with rapyd is:
- make a route to a controller for each entity you need to manage
- make the controller with one method for each widget (i.e.: one for a datagrid and one for a dataedit)
- make an empty view, include bootstrap and display content that rapyd will build for you
Rapyd comes with demo (controller, models, views) a route is defined in app/Http/rapyd.php
so go to:
/rapyd-demo
License & Contacts
Rapyd is licensed under the MIT license
Please join me and review my work on Linkedin
thanks
11 Aug 26, 2022
87 Oct 13, 2022
10 Dec 19, 2022
1.1k Dec 26, 2022
39 Dec 21, 2022
15 Oct 31, 2019
217 Oct 24, 2022
839 Dec 22, 2022
107 Dec 5, 2022
11 Sep 10, 2022
41 Dec 24, 2022
5 Jun 12, 2023
393 Nov 28, 2022
75 Jan 2, 2023
33 Nov 26, 2022
11 Sep 29, 2022
38 Nov 3, 2022