Laravel Query Builder 开源项目教程

Laravel Query Builder 开源项目教程

laravel-query-builderEasily build Eloquent queries from API requests项目地址:https://gitcode.com/gh_mirrors/la/laravel-query-builder

项目的目录结构及介绍

Laravel Query Builder 项目的目录结构遵循标准的 Laravel 项目结构，并包含一些特定于该包的文件和目录。以下是主要目录和文件的介绍：

laravel-query-builder/
├── src/
│   ├── Concerns/
│   ├── Exceptions/
│   ├── Filters/
│   ├── Includes/
│   ├── QueryBuilder.php
│   ├── QueryBuilderRequest.php
│   └── ...
├── tests/
│   ├── Feature/
│   ├── Unit/
│   └── ...
├── config/
│   └── query-builder.php
├── resources/
│   └── views/
│       └── ...
├── routes/
│   └── api.php
├── composer.json
├── README.md
└── ...

• src/: 包含所有核心代码文件，如 QueryBuilder.php 和 QueryBuilderRequest.php。
• tests/: 包含单元测试和功能测试。
• config/: 包含配置文件 query-builder.php。
• resources/: 包含视图文件和其他资源。
• routes/: 包含路由定义，如 api.php。
• composer.json: 项目的依赖管理文件。
• README.md: 项目的介绍和使用说明。

项目的启动文件介绍

Laravel Query Builder 的启动文件主要是 QueryBuilder.php，它位于 src/ 目录下。这个文件是构建查询的核心类，提供了允许过滤、排序和包含 Eloquent 关系的方法。

namespace Spatie\QueryBuilder;

use Illuminate\Database\Eloquent\Builder;

class QueryBuilder extends Builder
{
    // 核心方法和属性
}

项目的配置文件介绍

配置文件 query-builder.php 位于 config/ 目录下。这个文件定义了包的默认配置选项，如允许的过滤器、包含的关系等。

return [
    'allowed_filters' => [],
    'allowed_includes' => [],
    'allowed_sorts' => [],
    'default_filter_column' => null,
    'default_filter_value' => null,
    'disable_invalid_filter_query_exception' => false,
];

• allowed_filters: 允许的过滤器列表。
• allowed_includes: 允许的包含关系列表。
• allowed_sorts: 允许的排序字段列表。
• default_filter_column: 默认的过滤器列。
• default_filter_value: 默认的过滤器值。
• disable_invalid_filter_query_exception: 是否禁用无效过滤器查询的异常。

通过这些配置选项，可以灵活地控制查询构建器的行为。

laravel-query-builderEasily build Eloquent queries from API requests项目地址:https://gitcode.com/gh_mirrors/la/laravel-query-builder