README

这是一个针对Laravel Orchid的扩展包，用于扩展其表格处理能力，并提供一些有用的辅助方法。

安装

通过Composer

$ composer require lmkhang10/orchid-tables

用法

此包添加以下新功能：

Checklist td - 表格的清单
TD/Field/Layout::can, canAll - 基于权限的字段、列、布局的可见性
Layout::html() - 布局的原始HTML
TD扩展
- date
- num
- limit
- bool
- keyValues
- link
- renderable
- rowClass
- rowLink
TableAdvanced - 可格式化、可点击的表格行
QuickExport - 在几秒钟内导出datatables

Screen\TdChecklist

带有全选支持的清单。可以通过按shift键选择范围。

用法

use Lintaba\OrchidTables\Screen\TDChecklist;

class UserTable extends Table {
//...
    public function columns(): array
    {
        return [
            TDChecklist::make(),
            //...
            TD::make('id'),
        ];
    }
}

TDChecklist::make($name = 'checkbox')

->checkboxSet(key,value)

几乎在TD上都可以使用。

默认情况下，它发送以下内容：

checkbox[] = 1

提供的集合的项目必须有一个getKey():int|string方法，该方法提供复选框的值。

默认情况下，清单属于主表单，与大多数操作按钮相关联，因此如果在Screen@commandBar()中有一个Button，也会发送选择列表。然而，模态有自己的表单，所以它不会包含在内。目前只支持一个表单。（如果您需要支持多个表单/模态，请随时提交工单。）

将清单的表单改为模态

class UserTable extends Table {
//...
    public function commandBar(): array {
        return [
            ModalToggle::make("my modal")->modal('myModal'),
        ];
    }
    public function columns(): array {
        return [
            TD::Checklist::make()->checkboxSet('form','screen-modal-form-myModal'),
        ];
    }

在出现错误/成功后返回，可以保持当前选择

class UserScreen extends Screen {
//...
    public function activateUsers(Request $request){
        Alert::message('Selected item count is still ' . count($request->get('checkbox', []) ) );
        $request->flash();
    }

可以混合使用

这些被混合到orchid的大多数可制作和可见的事物中。

TD
Field
LayoutFactory

can(string[] $permissions...)

如果当前用户没有列出的任何权限，则隐藏字段。

只有当之前的canSee没有隐藏它，并且用户被赋予了列出的权限中的任何一个时才显示。

canAll(string[] $permissions...)

如果当前用户没有列出的任何权限，则隐藏字段。

只有当之前的canSee没有隐藏它，并且用户被赋予了列出的权限中的所有权限时才显示。

内部使用can和canAll都使用canSee，因此在一个can之后链式调用另一个canSee将使权限检查无效。

使用不存在的权限会在开发模式下抛出一个容易修复的异常，以帮助避免错误。

布局混合

html

html(string|callable $content): self

创建一个Layout组件，渲染提供的HTML字符串（或其值，当它是闭包时。）

单元格混合

date

date(bool $withHumanReadable = true, string $format = null): self

将日期字符串或Carbon日期格式化为可读格式。默认格式为config('orchid-tables.date_format')，config('app.date_format')，或Y?-m-d H:i。（如果它是当前年份，则省略年份。）

num

num(int $decimals = 0,
        string $suffix = null,
        string $decimalSeparator = ',',
        string $thousandsSeparator = DataHelpers::NBSP): self

将数值格式化为更易读/方便的格式。

设置小数位数
可以添加后缀，使用非换行空格（nbsp）分隔，确保不会断到多行。

示例

TD::make('size')->num(2,'m²')

限制

limit(int $max = 100, string $end = '...')

保持文本在给定的最大字符数内。如果更长，则用...（或end中指定的任何内容）替换结尾。

bool()

根据列的值是布尔真值还是假值，显示绿色勾号或红色叉号。

keyValues()

keyValues(int $maxDepth = 3)

显示复杂对象/数组/JSON条目的键值结构（使用dl/dt/dd）。

默认限制最大深度为3。

link($href, $segments = null)

创建指向目标位置的链接/按钮。两者$href和$segments都可以是闭包或值。

示例

// article: { user: { id: 42, first: "John", last: "Doe", __toString:"John Doe" } }
TD::make('user')->link(function(User $user){return route('user.show',$user->id)}),
//<a href="/users/show/42">John Doe</a>

TD::make('user')->link('user.create',['last','first'])
//<a href="/users/show/42">Doe<br> John</a>

renderable()

尝试使用以下方式渲染模型：

其值，当其为标量或null时
作为Personable Persona
使用->presenter()获取Personable Persona
从->display()获取值
其name、slug或class@id作为最后的手段。

格式化可导出单元格

这些辅助方法与格式化的Excel导出非常有用。默认情况下，它未启用，因为它会增加额外的开销，通常不使用。要启用，您可以在配置中设置它

# config/orchid-tables.php
        'cell'   => Mixins\CellExportFormattableMixin::class,

或调用以下

\Lintaba\OrchidTables\Facades\OrchidTables::mixinTdExportFormattables();

增强方法

date
- 格式为日期
num
- 格式为提供的数字格式，但存储为数字。
keyValues
- 以JSON格式存储在输出中

此外，以下辅助方法也可用

####notExportable($notExportable = true): self 将列设置为不可导出。

建议将其设置在例如操作按钮上。

####setStyle($style): self

一个回调，用于格式化给定的行或实际格式。可以多次调用，结果将合并。回调可以返回phpexcel格式的数组，或以下之一（或多个合并在一起）

ExportStyles::FORMAT_NONE
ExportStyles::FORMAT_TEXT
ExportStyles::FORMAT_HUF
ExportStyles::FORMAT_USD
ExportStyles::FORMAT_EUR
ExportStyles::FORMAT_PCS
ExportStyles::FORMAT_DATE
ExportStyles::FORMAT_DATETIME
ExportStyles::FORMAT_TIME
ExportStyles::FORMAT_BOLD
ExportStyles::FORMAT_ITALIC
ExportStyles::FORMAT_UNDERLINED
ExportStyles::FORMAT_LEFT
ExportStyles::FORMAT_RIGHT
ExportStyles::FORMAT_CENTER
ExportStyles::FORMAT_TOP
ExportStyles::FORMAT_MIDDLE
ExportStyles::FORMAT_BOTTOM
ExportStyles::FORMAT_RED
ExportStyles::FORMAT_GREEN
ExportStyles::FORMAT_YELLOW
ExportStyles::FORMAT_BLUE
ExportStyles::FORMAT_BLACK

####exportRender(callable $callback): self

为Excel设置渲染器方法。输入是字段的值。必须返回一个string或stringable。

示例

TD::make('name')->exportRender(function(string $value, User $entry, int $rowNum){
    return Str::upper($value).' #'.$entry->id.' (row-'.$rowNum.')';
})

QuickExport

使用Lintaba\OrchidTables\Exports\QuickExport可以快速设置数据导出，无需创建额外的类，只需构建现有的表即可。

快速导出示例

use Lintaba\OrchidTables\Exports\QuickExport;
use Orchid\Screen\Actions\Button;
use Orchid\Screen\Screen;

class UsersTableScreen extends Screen
{

    public function commandBar(): array
    {
        return [
            Button::make('export')->method('export')->rawClick(),
        ];
    }

    public function export(){
        $query = User::filters()->defaultSort('id', 'desc');
        return (new QuickExport($query, UserTable::class))->download('userExport.xlsx');
    }
//...

TableAdvanced

扩展的表布局，\Lintaba\OrchidTables\Screen\TableAdvanced增加了以下功能

rowClass($row)

根据行计算类名列表。对于整行着色非常有用。

rowLink($row)

使整行可点击。

示例

use Lintaba\OrchidTables\Screen\TableAdvanced

class UserTable extends TableAdvanced
{

    public function rowClass(User $row)
    {
        return $row->active ? 'bg-success' : 'bg-danger';
    }

    public function rowLink(User $row)
    {
        return route('admin.users.show',$row);
    }
//...

自定义

运行以下命令以发布配置

php artisan vendor:publish --tag="orchid-tables.config"

# /config/orchid-tables.php
use Lintaba\OrchidTables\Mixins;

return [
    'mixins' => [
        'can'    => Mixins\CanMixin::class,
        'cell'   => Mixins\CellMixin::class,
        'layout' => Mixins\LayoutMixin::class,
    ],

    'date_format' => null,
];

根据现有的混入（如\Lintaba\OrchidTables\CellMixin）扩展或创建您的覆盖。您可以通过将这些混入的键设置为null来打开或关闭这些混入中的任何一个。

更改日志

请参阅变更日志获取有关最近更改的更多信息。

测试

$ composer test

贡献

请参阅contributing.md以及打开问题跟踪单以获取详细信息及待办事项清单。

致谢

许可证

MIT。请参阅许可证文件获取更多信息。

lmkhang10 / orchid-tables

维护者

详细信息