abdallhsamy/helpers

该包包含一些有用的类,可以帮助您更快地开发

v1.2.0 2021-07-24 08:51 UTC

This package is auto-updated.

Last update: 2024-09-04 14:45:34 UTC


README

该包包含一些有用的类,可以帮助您更快地开发

使用该包的好处

  • 您可以将迁移文件移动到子目录中,例如 ex: database/migration/company/xxxxx_create_company_contacts_table.php
  • 使用分页、过滤和搜索,无需修改控制器方法或路由参数。 ex : /api/v1/users/search=Abdallah%20Samy&age=27&country_id=27&limit=15
    • @param search 用于搜索 ,
    • @param age 用于过滤
    • @param country_id 用于过滤
    • 和 @param limit 用于分页

迁移目录示例

├── migrations
│   ├── Employees
│   │   ├── 2020_07_13_002708_create_xxxxx_table.php
│   ├── General
│   │   ├── 2020_06_25_094724_create_xxxxxx_table.php
│   │   ├── 2020_06_25_154805_create_xxxxxx_table.php
│   ├── Library
│   │   ├── 2020_07_12_131550_create_xxxxxx_table.php
│   │   ├── 2020_07_13_160900_create_xxxxxx_table.php
│   │   ├── 2020_07_13_160903_create_xxxxxx_table.php
│   │   └── 2020_07_13_160904_create_xxxxxx_table.php
│   └── Users
│       ├── 2020_06_14_145802_create_xxxxxx_table.php
│       ├── 2020_06_14_145803_create_xxxxxx_table.php
│       ├── 2020_06_15_110700_create_xxxxxx_table.php
│       └── 2020_08_30_132633_create_xxxxxx_table.php
└── seeds

安装

使用 Composer

composer require abdallhsamy/helpers

配置文件和迁移

使用以下命令发布包配置文件和迁移

php artisan vendor:publish --provider="AbbdallhSamy\Helpers\Providers\HelperServiceProvider"

然后运行迁移

php artisan migrate

特质和契约

模型

AbdallhSamy\Helpers\Traits\Models\{ActivityLogTrait, ModelFilters, ModelSearch} 特质添加到您的模型中。

请参阅以下模型示例

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use AbdallhSamy\Helpers\Traits\Models\{ActivityLogTrait, ModelFilters, ModelSearch};
class User extends Authenticatable
{
    use ActivityLogTrait, ModelFilters, ModelSearch;

    protected $filterItems = [];
    protected $searchItems = [];

    ...

控制器

<?php

namespace App\Http\Controllers\API\V1;

use App\Models\User;
use App\Http\Controllers\Controller;
use App\Http\Requests\User\UserCollection;
use AbdallhSamy\Helpers\{Contracts\EnhancedQueryInterface, Traits\Controllers\EnhancedQuery};

class UserAPIController extends Controller implements EnhancedQueryInterface
{
    use EnhancedQuery;

    private $model;

    public function __construct()
    {
        $this->model = User::latest();
    }

    /**
    * must be implemented
    */
    public function collection($users)
    {
        return new UserCollection($users);
    }

    /**
    * Display a listing of the resource.
    * @param Request $request
    * mixed
    * @return ResourceCollection
    */
    public function index(Request $request)
    {
        return $this->query($request->all());
    }

...

添加了新的 Eloquent 构建方法 toRawSql()

使用示例

return Recipe::select('dish_id', 'id')
    ->with('dish:name,id,price,photo')
    ->withCount('recipeMaterials')
    ->toRawSql();

输出

select `dish_id`, `id`, (select count(*) from `recipe_materials` where `recipes`.`id` = `recipe_materials`.`recipe_id`) as `recipe_materials_count` from `recipes`