first commit

Author: z-song

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+phpunit.phar
+/vendor
+composer.phar
+composer.lock
+*.project
+.idea/

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jens Segers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,66 @@
+laravel-admin grid-sortable
+======
+
+这个插件可以帮助你通过拖动数据列表的行来进行排序，前端基于[jQueryUI sortable](https://jqueryui.com/sortable/), 后端基于[eloquent-sortable](https://github.com/spatie/eloquent-sortable)
+
+## Installation
+
+```shell
+composer require laravel-admin-ext/grid-sortable -vvv
+```
+
+## Usage
+
+定义模型
+
+```php
+<?php
+
+use Illuminate\Database\Eloquent\Model;
+use Spatie\EloquentSortable\Sortable;
+use Spatie\EloquentSortable\SortableTrait;
+
+class MyModel extends Model implements Sortable
+{
+    use SortableTrait;
+
+    public $sortable = [
+        'order_column_name' => 'order_column',
+        'sort_when_creating' => true,
+    ];
+}
+```
+
+在Grid中使用
+
+```php
+$grid = new Grid(new MyModel);
+
+$grid->sortable();
+```
+
+这样会给表格增加一列排序列，拖动之后在表格顶部会出现一个Save order的按钮，点击保存排序
+
+## Translation
+
+排序保存按钮默认的文字是`Save order`，如果使用其他语言，比如简体中文，那么可以在`resources/lang/zh-CN.json`文件中增加一项翻译
+
+```json
+{
+    "Save order": "保存排序"
+}
+```
+
+其他语言也是按照上面的方式操作。
+
+## Donate
+
+> Help keeping the project development going, by donating a little. Thanks in advance.
+
+[![PayPal Me](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/zousong)
+
+![-1](https://cloud.githubusercontent.com/assets/1479100/23287423/45c68202-fa78-11e6-8125-3e365101a313.jpg)
+
+License
+------------
+Licensed under [The MIT License (MIT)](LICENSE).

composer.json

@@ -0,0 +1,34 @@
+{
+    "name": "laravel-admin-ext/grid-sortable",
+    "description": "Sort the grid data by drag and drop rows",
+    "type": "library",
+    "keywords": ["laravel-admin", "extension", "grid", "sortable"],
+    "homepage": "https://github.com/laravel-admin-ext/grid-sortable",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "z-song",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": ">=7.0.0",
+        "encore/laravel-admin": ">=1.7.2",
+        "spatie/eloquent-sortable": "*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "~6.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Encore\\Admin\\GridSortable\\": "src/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Encore\\Admin\\GridSortable\\GridSortableServiceProvider"
+            ]
+        }
+    }
+}

resources/assets/jquery-ui.min.js

@@ -0,0 +1,36 @@
+<?php
+
+Route::post('_grid-sortable_', function (\Illuminate\Http\Request $request) {
+
+    $sorts = $request->get('_sort');
+
+    $sorts = collect($sorts)
+        ->pluck('key')
+        ->combine(
+            collect($sorts)->pluck('sort')->sort()
+        );
+
+    $status     = true;
+    $message    = trans('admin.save_succeeded');
+    $modelClass = $request->get('_model');
+
+    try {
+        /** @var \Illuminate\Database\Eloquent\Collection $models */
+        $models = $modelClass::find($sorts->keys());
+
+        foreach ($models as $model) {
+
+            $column = data_get($model->sortable, 'order_column_name', 'order_column');
+
+            $model->{$column} = $sorts->get($model->getKey());
+            $model->save();
+        }
+
+    } catch (Exception $exception) {
+        $status  = false;
+        $message = $exception->getMessage();
+    }
+
+    return response()->json(compact('status', 'message'));
+
+})->name('laravel-admin-grid-sortable');

routes/web.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Encore\Admin\GridSortable;
+
+use Encore\Admin\Extension;
+use Encore\Admin\Grid;
+use Encore\Admin\Grid\Tools\ColumnSelector;
+use Spatie\EloquentSortable\Sortable;
+
+class GridSortable extends Extension
+{
+    public $name = 'grid-sortable';
+
+    public $assets = __DIR__.'/../resources/assets';
+
+    protected $column = '__sortable__';
+
+    public function install()
+    {
+        ColumnSelector::ignore($column = $this->column);
+
+        Grid::macro('sortable', function () use ($column) {
+
+            $this->tools(function (Grid\Tools $tools) {
+                $tools->append(new SaveOrderBtn());
+            });
+
+            $sortName = $this->model()->getSortName();
+
+            if (!request()->has($sortName)
+                && $this->model()->eloquent() instanceof Sortable
+            ) {
+                $this->model()->ordered();
+            }
+
+            $this->column($column, ' ')
+                ->displayUsing(SortableDisplay::class);
+        });
+    }
+}

src/GridSortable.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Encore\Admin\GridSortable;
+
+use Encore\Admin\Admin;
+use Illuminate\Support\ServiceProvider;
+
+class GridSortableServiceProvider extends ServiceProvider
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function boot(GridSortable $extension)
+    {
+        if (! GridSortable::boot()) {
+            return ;
+        }
+
+        if ($this->app->runningInConsole() && $assets = $extension->assets()) {
+            $this->publishes(
+                [$assets => public_path('vendor/laravel-admin-ext/grid-sortable')],
+                'laravel-admin-grid-sortable'
+            );
+        }
+
+        $this->app->booted(function () {
+            GridSortable::routes(__DIR__.'/../routes/web.php');
+        });
+
+        Admin::booting(function () {
+            Admin::headerJs('vendor/laravel-admin-ext/grid-sortable/jquery-ui.min.js');
+        });
+
+        $extension->install();
+    }
+}

src/GridSortableServiceProvider.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Encore\Admin\GridSortable;
+
+use Encore\Admin\Admin;
+use Encore\Admin\Grid\Tools\AbstractTool;
+
+class SaveOrderBtn extends AbstractTool
+{
+    protected function script()
+    {
+        $route = route('laravel-admin-grid-sortable');
+
+        $class = get_class($this->getGrid()->model()->getOriginalModel());
+
+        $class = str_replace('\\', '\\\\', $class);
+
+        $script = <<<SCRIPT
+(function () {
+    
+    $('.grid-save-order-btn').click(function () {
+
+        $.post('{$route}', {
+            _token: $.admin.token,
+            _model: '{$class}',
+            _sort: $(this).data('sort'),
+        },
+        function(data){
+        
+            if (data.status) {
+                $.admin.toastr.success(data.message, '', {positionClass:"toast-top-center"});
+                $.admin.reload();
+            } else {
+                $.admin.toastr.error(data.message, '', {positionClass:"toast-top-center"});
+            }
+        });
+    });
+    
+})();
+SCRIPT;
+        Admin::script($script);
+    }
+
+    public function render()
+    {
+        $this->script();
+
+        $text = __('Save order');
+
+        return <<<HTML
+<button type="button" class="btn btn-sm btn-info grid-save-order-btn" style="margin-left: 10px;display: none;">
+    <i class="fa fa-save"></i><span class="hidden-xs">&nbsp;&nbsp;{$text}</span>
+</button>
+HTML;
+    }
+}

src/SaveOrderBtn.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Encore\Admin\GridSortable;
+
+use Encore\Admin\Admin;
+use Encore\Admin\Grid\Displayers\AbstractDisplayer;
+
+class SortableDisplay extends AbstractDisplayer
+{
+    protected function script()
+    {
+        $id = $this->getGrid()->tableID;
+
+        $script = <<<SCRIPT
+        
+(function () {
+    $("#{$id} tbody").sortable({
+        placeholder: "sort-highlight",
+        handle: ".grid-sortable-handle",
+        forcePlaceholderSize: true,
+        zIndex: 999999
+    }).on("sortupdate", function(event, ui) {
+    
+        var sorts = [];
+        $(this).find('.grid-sortable-handle').each(function () {
+            sorts.push($(this).data());
+        });
+        
+        var \$btn = $('#{$id}').closest('.box').find('.grid-save-order-btn');
+        \$btn.data('sort', sorts).show();
+    });
+})();
+SCRIPT;
+
+        Admin::script($script);
+    }
+
+    protected function getRowSort()
+    {
+        $column = data_get($this->row->sortable, 'order_column_name', 'order_column');
+
+        return $this->row->{$column};
+    }
+
+    public function display()
+    {
+        $this->script();
+
+        $key = $this->getKey();
+        $sort = $this->getRowSort();
+
+        return <<<HTML
+<a class="grid-sortable-handle" style="cursor: move;" data-key="{$key}" data-sort="{$sort}">
+    <i class="fa fa-ellipsis-v"></i>
+    <i class="fa fa-ellipsis-v"></i>
+  </a>
+HTML;
+    }
+}