README

弃用 - 模型

包已被 aedart/athenaeum 替换 所有已知组件已迁移到 Athenaeum 包。

集合了各种获取器和设置器-接口，以及各种特性实现，用于不同类型的“常见”属性。可用于创建 DTOs。

内容

• 何时使用此包
• 如何安装
• 快速入门
  • 创建你的接口
  • 具体实现
• 可用属性
• 贡献
• 致谢
• 版本
• 许可证

何时使用此包

• 当需要明确指定给定对象上必须有哪些属性时
• （当多个对象共享相同的属性时）

如何安装

composer require aedart/model

此包使用 composer。如果你不知道这是什么或者它是如何工作的，我建议在使用此包之前先阅读一些相关信息。

快速入门

创建你的接口

在以下示例中，我们创建一个简单的个人接口，包括id、姓名和描述；

<?php

namespace Acme\Contracts;

use Aedart\Model\Contracts\Integers\IdAware;
use Aedart\Model\Contracts\Strings\DescriptionAware;
use Aedart\Model\Contracts\Strings\NameAware;

interface Person extends
    IdAware,
    NameAware,
    DescriptionAware
{
    
}

具体实现

使用默认提供的特性，以创建接口的具体实现；

<?php

namespace Acme\Models;

use Acme\Contracts\Person as PersonInterface;
use Aedart\Model\Traits\Strings\DescriptionTrait;
use Aedart\Model\Traits\Strings\IdTrait;
use Aedart\Model\Traits\Strings\NameTrait;

class Person implements PersonInterface
{
    use IdTrait;
    use NameTrait;
    use DescriptionTrait;   
}

可用属性

随着我其他项目的进展，将添加更多属性...

贡献

你是否发现了缺陷（ 错误或设计缺陷 ），或者希望进行改进？在以下章节中，你可能找到一些有用的信息，了解你可以如何帮助这个项目。无论如何，我感谢你抽出时间帮助我改进这个项目的交付成果和整体质量。

错误报告

如果你确信你发现了一个错误，那么至少你应该创建一个新的问题。在该问题中，你应该至少描述以下内容；

• 缺陷位于何处
• 对缺陷的良好、简短、精确的描述（为什么它是缺陷）
• 如何复制缺陷
• （可能的解决缺陷的方法）

当有时间时，我将审查你的问题并采取行动。

分叉、编写代码并发送拉取请求

一份良好且写得好的错误报告可以帮到我很多。然而，如果您可以选择或希望自行解决缺陷，以下是您可以这样做的步骤：

• 分叉此项目
• 为修复特定缺陷创建一个新的本地开发分支
• 编写您的代码/更改
• 创建可执行测试用例（证明您的更改是稳固的！)
• 提交并将您的更改推送到您的分叉仓库
• 发送包含您的更改的拉取请求
• 喝一杯啤酒 - 您应得的 :)

一旦我收到您的拉取请求（并且有时间处理），我将审查您的更改并将它们合并到这个项目中。如果没有，我将通知您我选择不合并的原因。

致谢

• PHPStorm ，JetBrains；为开发最好的PHP IDE，并支持此及其他开源项目
• PHPUnit ，Sebastian Bergmann；神啊……我们仍然知道一些开发者、经理和决策者，他们认为优秀的软件根本不需要测试！我们没有想过在没有像PHPUnit这样的优秀测试工具的项目上工作。
• Codeception ，Michael Bodnarchuk；让PHPUnit变得更好。
• Composer & Packagist ，Nils Adermann, Jordi Boggiano & et al.；PHP社区发生过的最好的事情之一。
• Git ，Software Freedom Conservancy；没有它……我们可能仍然停留在软件开发“石器时代”。
• Laracasts ，Jeffrey Way et al.；物有所值……
• PHP ，Rasmus Lerdorf & The PHP Group；我们可能还在用老式的ASP开发这个项目……（打了个寒颤！）

版本管理

此软件包遵循语义版本控制2.0.0

许可

BSD-3-Clause，请阅读此软件包中包含的LICENSE文件