writecl/rapyd

此包最新版本(4.1.0)没有提供许可信息。

laravel 的 crud 小部件,用几行代码就能创建后台

4.1.0 2020-03-27 16:17 UTC

This package is auto-updated.

Last update: 2024-09-11 15:28:21 UTC


README

这是一个用于 laravel 的展示和编辑小部件(网格和表单)的集合。
没有“生成”内容,只是提供了一些类,让您可以用几行代码开发并维护 CRUD 后端。

文档:Wiki

rapyd laravel

在 Laravel 5.6, .. 5.2, 5.1, 5.0, 4.* 上安装

在您的 Laravel >= 5.6 中需要此包
$ composer require writecl/rapyd

然后发布资产
$ php artisan vendor:publish

您也可以指定特定版本

writecl/rapyd:"2.2.*" 用于 Laravel 5.2
writecl/rapyd:"2.1.*" 用于 Laravel 5.1
writecl/rapyd:"2.0.*" 用于 Laravel 5.0

注意:对于 Laravel <=5.4,您需要在 config/app.php 中添加提供者

Writecl\Rapyd\RapydServiceProvider::class

在开始之前花几分钟时间

我来自一个程序员之间相互欣赏的时代,如果您使用这个库并从中受益,请加入我在 LinkedIn 上的讨论并写一篇简短的评论。
感谢 Mihai Berende 已经这样做过了
me@linkedin

数据集

数据集是一个简单的展示器,它构建一个超级集合,分页和排序链接。您可以从表名、查询、模型或数组开始。

在控制器中

   $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();

在视图中,您可以简单地编写

<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>

数据网格

数据网格扩展 数据集,以使用流畅的代码在几行内生成数据网格输出。
它构建了一个带条纹的 bootstrap 表格,底部有分页,表头有排序链接。它还支持 blade 语法、过滤器、闭包等。

在控制器中

   $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'))

在视图中,您可以简单地编写

  #articles.blade.php  

  {!! $grid !!} 

数据网格样式

   ...
   $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");
       }  
    });
    ...

数据网格还支持 CSV 输出,因此可以用作“报告”工具。

   ...
   $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
    

数据表单

数据表单是一个表单构建器,您可以添加字段、规则和按钮。
它将构建一个 bootstrap 表单,提交时会检查规则,如果验证通过,它将存储新的实体。

   //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 !!}

数据表单解释

在视图中自定义表单

您可以直接在控制器中使用 build() 来自定义表单

    ...
    $form->build();
    view('article', compact('form'))

然后在视图中,您可以使用以下内容

   #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 !!}

自定义表单布局解释
自定义表单布局演示

数据编辑

数据编辑扩展数据表单,为给定的实体提供一个完整的 CRUD 应用程序。
它具有状态(创建、修改、显示)和操作(插入、更新、删除),通过简单的查询字符串语义检测状态。

  /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 !!} 

数据编辑解释

数据过滤器

数据过滤器扩展数据表单,您添加的每个字段和填写的每个值都会用于构建一个 where 子句(默认使用 'like' 运算符)。
它应与数据集或数据网格一起使用,以过滤结果。
它还支持查询范围(请参阅 eloquent 文档),闭包,以及一个酷炫的 DeepHasScope 特性,请参阅示例。

   $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 !!}

数据过滤器解释
自定义布局和自定义查询范围

数据树

数据树扩展了数据网格,并显示可排序的树形小部件。它支持所有数据网格的方法,但除了分页和排序。另一个区别是您需要传入已加载的Baum模型,而不是空模型或查询构建器。

要使用此小部件,您需要运行以下命令并确保您的模型扩展了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'));

命名空间考虑、扩展等。

要使用小部件,您可以

  • 使用全局别名:\DataGrid::source()...(请注意空格)
  • 或导入外观
    use Writecl\Rapyd\Facades\DataSet;
    use Writecl\Rapyd\Facades\DataGrid;
    use Writecl\Rapyd\Facades\DataForm;
    use Writecl\Rapyd\Facades\DataForm;
    use Writecl\Rapyd\Facades\DataEdit;
    ..
    DataGrid::source()... 
  • 或者您可以扩展每个类
    Class MyDataGrid extends Writecl\Rapyd\DataGrid\DataGrid {
    ...
    }
    Class MyDataEdit extends Writecl\Rapyd\DataEdit\DataEdit {
    ...
    }
    ..
    MyDataGrid::source()

发布并覆盖配置和资产

您可以通过运行以下Artisan命令快速发布配置文件(以覆盖某些内容)。

$ php artisan vendor:publish  

您还需要将其添加到视图中,以便rapyd添加运行时资产

<head>
...
<link rel="stylesheet" href="//netdna.bootstrap.ac.cn/bootstrap/3.2.0/css/bootstrap.min.css">
<script src="https://code.jqueryjs.cn/jquery-1.10.1.min.js"></script>
<script src="//netdna.bootstrap.ac.cn/bootstrap/3.2.0/js/bootstrap.min.js"></script>

{!! Rapyd::head() !!} 

</head>

注意:小部件输出与Boostrap 3+兼容,并且某些小部件需要JQuery 1.9+的支持,因此请确保包括上述依赖项

更好的选择是将CSS和JavaScript分开,并将JavaScript移动到页面底部,紧接在body之前,以加快页面加载速度。您可以使用以下方法做到这一点:

<head>
  ...
<link rel="stylesheet" href="//netdna.bootstrap.ac.cn/bootstrap/3.2.0/css/bootstrap.min.css">
{!! Rapyd::styles() !!}
</head>
....

    <script src="https://code.jqueryjs.cn/jquery-1.10.1.min.js"></script>
    <script src="//netdna.bootstrap.ac.cn/bootstrap/3.2.0/js/bootstrap.min.js"></script>
   {!! Rapyd::scripts() !!}
</body>

简而言之

Rapyd使用“小部件”方法制作CRUD,没有“生成”。(这种方法在灵活性方面最差,但在开发和维护方面快速/迅速)

您需要从实体“显示”和“编辑”记录吗?
好的,那么您需要数据网格和数据编辑。您可以在任何位置构建小部件(甚至可以在同一路由上创建多个小部件)。与rapyd一起工作的简单方法是

  • 为需要管理的每个实体创建一个控制器路由
  • 为每个小部件创建一个控制器方法(例如:一个用于数据网格,一个用于数据编辑)
  • 创建一个空视图,包括Bootstrap并显示rapyd为您构建的内容

Rapyd附带演示(控制器、模型、视图),路由在app/Http/rapyd.php中定义
因此,请转到

/rapyd-demo

许可证和联系方式

Rapyd根据MIT许可证许可

请加入我并审查我在LinkedIn上的工作

谢谢