README

安装
组件及其使用方法

安装

安装包: composer require duotek/laravel-basic-components
执行命令（从包中复制必要的设置）: php artisan vendor:publish --tag="laravel-basic-components-config"

如果项目中未使用 browser（用于后台的组件），则选项 4 和 5 不是必需的。

提取浏览器预设的迁移：php artisan vendor:publish --tag="laravel-basic-components-migrations"
执行命令: php artisan migrate

use App\Http\Resources\Web\MarketOffer\MarketOfferResource; use App\Models\Market\Offer\Offer as MarketOffer; use Duotek\LaravelBasicComponents\PanelSet\Filters\BooleanFilter; use Duotek\LaravelBasicComponents\PanelSet\Filters\SelectFilter; use Duotek\LaravelBasicComponents\PanelSet\PanelSet;

class MarketOfferPanelSet extends PanelSet {

protected string $model = MarketOffer::class;
public string $resource = MarketOfferResource::class;
public string $browserId = 'market_offers';

/**
 * Если необходимо передать кастомный способ поиска отличный от LIKE, делаем как в примере 1 
 */
public array $fieldsForDefaultSearchFilter = ['costs_type_id', 'payment_type_id'];

protected array $defaultOrderBy = [
    'created_at' => 'desc',
    // Пример с мапингом: принимаем `created_at`, а в запрос кладем `tips_codes.created_at`
    // 'created_at as tips_codes.created_at' => 'desc'
    // Для кастомизации смотри "Пример 2"
];

public array $availableOrderBy = [
    'created_at',
    // Пример с мапингом: принимаем `created_at`, а в запрос кладем `tips_codes.created_at`
    // 'created_at as tips_codes.created_at' 
    // Для кастомизации смотри "Пример 3"
];   

public function __construct() 
{
    parent::__construct();
    
    /**
     * Пример 1 
     */
    $this->fieldsForDefaultSearchFilter = [
        'costs_type_id',
        'payment_type_id',
        function (Builder $query, string|null $searchString) {
            $query->OrWhere('id', '=', $searchString);
        }
    ];
    
    /**
     * Пример 2 
     */
    $this->defaultOrderBy = [
        'created_at' => function (\Illuminate\Database\Eloquent\Builder $queryBuilder) {
            // Пример кастомизации: здесь пишем как обработать поле 'updated_at'
            $queryBuilder->orderByRaw('<RAW SQL QUERY>');
        }
    ];    
    
    /**
     * Пример 3 
     */
    $this->availableOrderBy = [
        'created_at' => function (\Illuminate\Database\Eloquent\Builder $queryBuilder, $field, $direction) {
            // Пример кастомизации: здесь пишем как обработать поле 'updated_at'
            $queryBuilder->orderByRaw('<RAW SQL QUERY>');
        }
    ]; 
}

protected function setFilters()
{
    $this->filtersManager->add(SelectFilter::class, 'product_id', 'Продукт', function (SelectFilter $selectFilter) {
    
        $exampleOptions = [
            0 => [
                'id' => 1,
                'title' => 'Продукт1'    
            ],
            1 => [
                'id' => 2,
                'title' => 'Продукт2'    
            ],
        ];
        
        $selectFilter->setOptions($exampleOptions);
    });
    
    $this->filtersManager->add(BooleanFilter::class, 'is_price_per_one_is_set', 'Тест', function (BooleanFilter $booleanFilter) {
    
        // В запрос передаем вместо 'is_price_per_one_is_set' => 'is_price_per_one_is'
        $booleanFilter->setFilterParamName('is_price_per_one_is');
        
        // Скрываем из интерфейса, но обрабатываем всё равно 
        $booleanFilter->hidden(); 
        
        // Делаем фильтр обязательным
        $booleanFilter->required();
    });
    
    // Пример кастомного запроса
    $this->filtersManager->add(SelectFilter::class, 'randomValue(ни на что не влияет в случае кастома)', 'Участник', function (SelectFilter $selectFilter) {
        $selectFilter
            ->setFilterParamName('user_id');
            ->setCustomQueryClosure(function (\Illuminate\Database\Eloquent\Builder $builder, $values) {
                $builder
                    ->where('market_deals.requester_user_id', $values[0])
                    ->orWhere('market_deals.responser_user_id', $values[0]);
        });
    });
}

}

2. Используем в контроллере

... /**

@throws InvalidJsonFormatForFiltersParameterException
@throws InvalidPanelSetConfigurationException */ 公共函数 browse(MarketOfferPanelSet $marketOfferPanelSet): JsonResponse { return response()->json($marketOfferPanelSet->handle()); } ...
```
#### Дополнительно:
Пример из `POSTMAN` как управляться с фильтрами:
```

readme_img/img.png

类 `PanelSetSortable` (`Duotek\LaravelBasicComponents\PanelSetSortable\PanelSetSortable`)

为什么需要它？

用作前端库的协议，通过后端定义前端接口。

用于具有拖放功能的组件。

组件定义记录的顺序
并且可以嵌套一个记录到另一个（可选）

如何使用？
创建 PanelSetSortable
<?php

namespace App\PanelSets\Backoffice\Suppliers\Levels;

use App\Http\Resources\Backoffice\Suppliers\Levels\LevelListResource; use App\Models\Suppliers\Levels\Level; use Duotek\LaravelBasicComponents\PanelSetSortable\PanelSetSortable;

class LevelPanelSetSortable extends PanelSetSortable {

protected string $model = Level::class;
public string $resource = LevelListResource::class;

/** [Опционально] Определяем нужна ли поддержка вложенности */
protected bool $isNested = false;

/** [Опционально] Колонка в таблице, которое будет отвечать за порядок */
protected string $orderField = 'order_index';

/** [Опционально] Колонка в таблице, которая определяет родителя при включенной вкложенности */
protected string $parentField = 'parent_id';

/** [Опционально] Колонка, содержащая в себе первичный ключ таблицы */
protected string $identifierField = 'id';

}

2. Используем в контроллере

use App\PanelSets\Backoffice\Suppliers\Levels\LevelPanelSetSortable; use Illuminate\Http\JsonResponse;

/**

GET
suppliers/levels/browse-sortable
[backoffice-api]
供应商级别浏览器排序 *
@param LevelPanelSetSortable $levelPanelSetSortable
@return JsonResponse */ 公共函数 browseSortable(LevelPanelSetSortable $levelPanelSetSortable): JsonResponse { return response()->json($levelPanelSetSortable->handle()); }

在控制器中添加更新排序/嵌套的方法

use Duotek\LaravelBasicComponents\Service\PanelSetSortableUpdateService\PanelSetSortableUpdateService;
use App\PanelSets\Backoffice\Suppliers\Levels\LevelPanelSetSortable;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;

/**

POST
suppliers/levels/browse-sortable/update
[backoffice-api]
更新浏览器排序 *
@bodyParam items object[] required
@bodyParam items[].id int required
@bodyParam items[].parent int required (如果嵌套关闭，从文档中删除) *
@param Request $request
@return JsonResponse
@throws ValidationException */ 公共函数 browseSortableUpdate(Request $request): JsonResponse { (new PanelSetSortableUpdateService(LevelPanelSetSortable::class))->setParams($request)->handle(); }

return response()->json(['status' => true]); }

类 `BrowserFilterPresetController` (`Duotek\LaravelBasicComponents\Controllers\BrowserFilterPresetController`)

为什么需要它？

用作前端和后端之间的协议。
包含用于 保存/更改/删除 用户预设的方法的控制器。

如何使用？

在路由文件中插入路由（在需要的地方）。

仅在后台使用，与组件 PanelSet 一起使用。

...
Route::post('browser/preset/create', [BrowserFilterPresetController::class, 'create']);
Route::post('browser/preset/update', [BrowserFilterPresetController::class, 'update']);
Route::post('browser/preset/delete', [BrowserFilterPresetController::class, 'delete']);
...

duotek / laravel-basic-components

维护者

详细信息

README

安装

组件及其使用方法

特质 `UploadFile` (`Duotek\LaravelBasicComponents\Traits\Model\UploadFile\UploadFile`)

为什么需要它？

如何使用？

类 `PanelSetSortable` (`Duotek\LaravelBasicComponents\PanelSetSortable\PanelSetSortable`)

为什么需要它？

如何使用？

类 `BrowserFilterPresetController` (`Duotek\LaravelBasicComponents\Controllers\BrowserFilterPresetController`)

为什么需要它？

如何使用？

duotek / laravel-basic-components

维护者

详细信息

README

安装

组件及其使用方法

特质 UploadFile (Duotek\LaravelBasicComponents\Traits\Model\UploadFile\UploadFile)

为什么需要它？

如何使用？

类 PanelSetSortable (Duotek\LaravelBasicComponents\PanelSetSortable\PanelSetSortable)

为什么需要它？

如何使用？

类 BrowserFilterPresetController (Duotek\LaravelBasicComponents\Controllers\BrowserFilterPresetController)

为什么需要它？

如何使用？

特质 `UploadFile` (`Duotek\LaravelBasicComponents\Traits\Model\UploadFile\UploadFile`)

类 `PanelSetSortable` (`Duotek\LaravelBasicComponents\PanelSetSortable\PanelSetSortable`)

类 `BrowserFilterPresetController` (`Duotek\LaravelBasicComponents\Controllers\BrowserFilterPresetController`)