README

注意：此 v1.x 包已被弃用，推荐使用 v2.x 包，并且不再维护。 了解更多。

Squire 是一个用于常见固定数据的静态 Eloquent 模型库，例如国家、货币和机场。它基于 Caleb Porzio 的 Sushi 包 构建。

Squire 的常见用例包括

• 填充下拉选项，例如地址表单中的国家选择器。
• 将其他数据附加到您的应用程序中的其他模型上，例如将机场信息附加到 Flight 模型。请参阅模型关系部分。

内容

• 安装 Squire
• 使用模型
• 可用模型
  • Squire\Models\Airline
  • Squire\Models\Airport
  • Squire\Models\Continent
  • Squire\Models\Counties\GbCounty
  • Squire\Models\Country
  • Squire\Models\Currency
  • Squire\Models\Region
• 模型关系
• 列定制
• 贡献

安装 Squire

您可以使用 Composer 将 Squire 安装到您的应用程序中。

composer require danharrin/squire

无需额外设置。

使用模型

您可以像与其他 Eloquent 模型一样与 Squire 模型交互，除了它只处理只读操作。

use Squire\Models\Country;

Country::all(); // Get information about all countries.

Country::find('us'); // Get information about the United States.

Country::where('name', 'like', 'a%')->get(); // Get information about all countries beginning with the letter "a".

可用模型

Squire\Models\Airline

Squire\Models\Airport

Squire\Models\Continent

Squire\Models\Counties\GbCounty

Squire\Models\Country

Squire\Models\Currency

Squire\Models\Region

模型关系

在您的应用程序中实现模型与Squire模型之间的Eloquent关系非常简单。您可以选择几种方法。

使用继承

最简单的选项是在您的应用程序中创建一个新的模型，并让它扩展Squire模型。您的新应用程序模型现在将像原始的Squire模型一样运行，除了您可以注册新方法和根据您的喜好进行自定义。

<?php

namespace App\Models;

use Squire\Models\Country as SquireCountry;

class Country extends SquireCountry
{
    public function users()
    {
        return $this->hasMany(User::class);
    }
}

有关如何使用此方法提供更多自定义选项的更多信息，请参阅模型自定义部分。

使用resolveRelationUsing()

另一种选择是resolveRelationUsing()方法。这允许您在应用程序的任何位置动态地为Squire模型注册关系，例如，在服务提供程序中。

use App\Models\User;
use Squire\Models\Country;

Country::resolveRelationUsing('users', function (Country $country) {
    return $country->hasMany(User::class);
});

列自定义

Squire 允许您自定义任何提供模型上的列名。

在您的应用程序中创建一个新的模型，并让它扩展您想要自定义的 Squire 模型

<?php

namespace App\Models;

use Squire\Models\Country as SquireCountry;

class Country extends SquireCountry
{
    protected $map = [
        'dial_code' => 'calling_code',
    ];
}

在这个例子中，扩展了 Squire\Models\Country 模型的 App\Models\Country，将 calling_code 列重新映射为 dial_code

use App\Models\Country;

Country::find('us')->dial_code; // 1

贡献

如果您有要贡献给库的固定数据，请提交一个拉取请求！

作为参考，查看现有的模型。