# 数据库属性
模型特征用于实现通用功能。
### [](https://octobercms.com/docs/database/traits#hashable)可散列
首次在模型上设置属性时，会立即对哈希属性进行哈希处理。要对模型中的属性进行哈希处理，请应用`October\Rain\Database\Traits\Hashable`特征并`$hashable`使用包含要哈希的属性的数组声明一个属性。
~~~
class User extends Model
{
use \October\Rain\Database\Traits\Hashable;
/**
* @var array List of attributes to hash.
*/
protected $hashable = ['password'];
}
~~~
### [](https://octobercms.com/docs/database/traits#purgeable)可净化的
创建或更新模型时，清除的属性不会保存到数据库中。要清除模型中的属性，请应用`October\Rain\Database\Traits\Purgeable`特征并`$purgeable`使用包含要清除的属性的数组声明属性。
~~~
class User extends Model
{
use \October\Rain\Database\Traits\Purgeable;
/**
* @var array List of attributes to purge.
*/
protected $purgeable = ['password_confirmation'];
}
~~~
保存模型时，在触发[模型事件](https://octobercms.com/docs/database/traits#model-events)（包括验证）之前，将清除定义的属性。使用`getOriginalPurgeValue`来查找已清除的值。
~~~
return $user->getOriginalPurgeValue('password_confirmation');
~~~
### [](https://octobercms.com/docs/database/traits#encryptable)可加密
与可[散列特征](https://octobercms.com/docs/database/traits#hashable)相似，加密的属性在设置时会加密，但在检索到属性时也会解密。要加密模型中的属性，请应用`October\Rain\Database\Traits\Encryptable`特征并`$encryptable`使用包含要加密的属性的数组声明属性。
~~~
class User extends Model
{
use \October\Rain\Database\Traits\Encryptable;
/**
* @var array List of attributes to encrypt.
*/
protected $encryptable = ['api_key', 'api_secret'];
}
~~~
> **注意：**作为加密/解密过程的一部分，加密的属性将被序列化和反序列化。不要说是一个属性`encryptable`也[`jsonable`](https://octobercms.com/docs/database/model#standard-properties)同时作为`jsonable`进程将试图解码已经被去系列化由加密的值。
### [](https://octobercms.com/docs/database/traits#sluggable)慢跑
标签是有意义的代码，通常在页面URL中使用。要为您的模型自动生成唯一的子弹，请应用`October\Rain\Database\Traits\Sluggable`特征并声明`$slugs`属性。
~~~
class User extends Model
{
use \October\Rain\Database\Traits\Sluggable;
/**
* @var array Generate slugs for these attributes.
*/
protected $slugs = ['slug' => 'name'];
}
~~~
该`$slugs`属性应该是一个数组，其中键是子段的目标列，值是用于生成子段的源字符串。在上面的示例中，如果将`name`列设置为**Cheyenne**，那么在创建模型之前，**应将**`slug`列设置为**cheyenne**，**cheyenne-2**或**cheyenne-3**等。
要从多个源生成一个段，请传递另一个数组作为源值：
~~~
protected $slugs = [
'slug' => ['first_name', 'last_name']
];
~~~
仅在首次创建模型时才生成块。要覆盖或禁用此功能，只需手动设置slug属性：
~~~
$user = new User;
$user->name = 'Remy';
$user->slug = 'custom-slug';
$user->save(); // Slug will not be generated
~~~
`slugAttributes`更新模型时，请使用该方法来生成段塞：
~~~
$user = User::find(1);
$user->slug = null;
$user->slugAttributes();
$user->save();
~~~
### [](https://octobercms.com/docs/database/traits#sluggable-with-softdelete-trait)可搭配SoftDelete特性
默认情况下，生成段时会忽略软删除的模型。在恢复软删除的模型时，您可能要防止从属重复。
将`$allowTrashedSlugs`属性设置为`true`以便在生成新的段时考虑软删除的记录。
~~~
protected $allowTrashedSlugs = true;
~~~
### [](https://octobercms.com/docs/database/traits#revisionable)可修改的
十月模型可以通过存储修订来记录值的更改历史记录。要存储模型的修订版，请应用`October\Rain\Database\Traits\Revisionable`特征并`$revisionable`使用包含用于监视更改的属性的数组声明属性。您还需要定义一个名为的`$morphMany`[模型关系](https://octobercms.com/docs/database/relations)`revision_history`，该[模型关系](https://octobercms.com/docs/database/relations)引用`System\Models\Revision`名称为的类`revisionable`，这是修订历史记录数据的存储位置。
~~~
class User extends Model
{
use \October\Rain\Database\Traits\Revisionable;
/**
* @var array Monitor these attributes for changes.
*/
protected $revisionable = ['name', 'email'];
/**
* @var array Relations
*/
public $morphMany = [
'revision_history' => ['System\Models\Revision', 'name' => 'revisionable']
];
}
~~~
默认情况下，将保留500条记录，但是可以通过`$revisionableLimit`在模型上声明一个具有新限制值的属性来对其进行修改。
~~~
/**
* @var int Maximum number of revision records to keep.
*/
public $revisionableLimit = 8;
~~~
可以像其他任何关系一样访问修订历史记录：
~~~
$history = User::find(1)->revision_history;
foreach ($history as $record) {
echo $record->field . ' updated ';
echo 'from ' . $record->old_value;
echo 'to ' . $record->new_value;
}
~~~
修订记录可以选择使用`user_id`属性来支持用户关系。您可以`getRevisionableUser`在模型中包括一个方法来跟踪进行修改的用户。
~~~
public function getRevisionableUser()
{
return BackendAuth::getUser()->id;
}
~~~
### [](https://octobercms.com/docs/database/traits#sortable)可排序
排序的模型将存储一个数字值，`sort_order`该值保持集合中每个单独模型的排序顺序。要存储模型的排序顺序，请应用`October\Rain\Database\Traits\Sortable`特征并确保模式中定义了要使用的列（例如：）`$table->integer('sort_order')->default(0);`。
~~~
class User extends Model
{
use \October\Rain\Database\Traits\Sortable;
}
~~~
您可以通过定义`SORT_ORDER`常量来修改用于标识排序顺序的键名：
~~~
const SORT_ORDER = 'my_sort_order_column';
~~~
使用此`setSortableOrder`方法可以在单个记录或多个记录上设置订单。
~~~
// Sets the order of the user to 1...
$user->setSortableOrder($user->id, 1);
// Sets the order of records 1, 2, 3 to 3, 2, 1 respectively...
$user->setSortableOrder([1, 2, 3], [3, 2, 1]);
~~~
> **注意：**如果将此特征添加到先前已存在数据（行）的模型中，则可能需要先初始化数据集，然后该特征才能正常工作。为此，请手动更新每一行的`sort_order`列，或者对数据运行查询以将记录的`id`列复制到该`sort_order`列（例如`UPDATE myvendor_myplugin_mymodelrecords SET sort_order = id`）。
### [](https://octobercms.com/docs/database/traits#simple-tree)简单树
一个简单的树模型将使用该`parent_id`列维护模型之间的父子关系。要使用简单树，请应用`October\Rain\Database\Traits\SimpleTree`特征。
~~~
class Category extends Model
{
use \October\Rain\Database\Traits\SimpleTree;
}
~~~
此特征将自动注入两个称为和的[模型关系](https://octobercms.com/docs/database/relations)，它等效于以下定义：`parent``children`
~~~
public $belongsTo = [
'parent' => ['User', 'key' => 'parent_id'],
];
public $hasMany = [
'children' => ['User', 'key' => 'parent_id'],
];
~~~
您可以通过定义`PARENT_ID`常量来修改用于标识父项的键名：
~~~
const PARENT_ID = 'my_parent_column';
~~~
使用此特征的模型的集合将返回`October\Rain\Database\TreeCollection`添加`toNested`方法的类型。要构建一个预先加载的树结构，请返回具有预先加载的关系的记录。
~~~
Category::all()->toNested();
~~~
### 渲染图
为了渲染所有级别的项及其子项，可以使用递归处理
~~~
{% macro renderChildren(item) %}
{% import _self as SELF %}
{% if item.children is not empty %}
<ul>
{% for child in item.children %}
<li>{{ child.name }}{{ SELF.renderChildren(child) | raw }}</li>
{% endfor %}
</ul>
{% endif %}
{% endmacro %}
{% import _self as SELF %}
{{ SELF.renderChildren(category) | raw }}
~~~
### [](https://octobercms.com/docs/database/traits#nested-tree)嵌套树
该[组嵌套的模型](https://en.wikipedia.org/wiki/Nested_set_model)是使用维护模型中hierachies的先进技术`parent_id`，`nest_left`，`nest_right`，和`nest_depth`列。要使用嵌套集合模型，请应用`October\Rain\Database\Traits\NestedTree`特征。`SimpleTree`此模型的所有特征都固有地可用。
~~~
class Category extends Model
{
use \October\Rain\Database\Traits\NestedTree;
}
~~~
### 创建根节点
默认情况下，所有节点均创建为根：
~~~
$root = Category::create(['name' => 'Root category']);
~~~
另外，您可能会发现自己需要将现有节点转换为根节点：
~~~
$node->makeRoot();
~~~
您也可以使它的`parent_id`列无效，该列的作用与`makeRoot'相同。
~~~
$node->parent_id = null;
$node->save();
~~~
### 插入节点
您可以通过该关系直接插入新节点：
~~~
$child1 = $root->children()->create(['name' => 'Child 1']);
~~~
或将`makeChildOf`方法用于现有节点：
~~~
$child2 = Category::create(['name' => 'Child 2']);
$child2->makeChildOf($root);
~~~
### 删除节点
当使用该`delete`方法删除节点时，该节点的所有后代也将被删除。请注意，不会为子模型触发delete[模型事件](https://octobercms.com/docs/database/model#model-events)。
~~~
$child1->delete();
~~~
### 获取节点的嵌套级别
该`getLevel`方法将返回节点的当前嵌套级别或深度。
~~~
// 0 when root
$node->getLevel()
~~~
### 移动节点
有几种移动节点的方法：
* `moveLeft()`：找到左侧的同级并将其移到左侧。
* `moveRight()`：找到正确的同级并将其移到右侧。
* `moveBefore($otherNode)`：移至...左侧的节点
* `moveAfter($otherNode)`：移至...右侧的节点
* `makeChildOf($otherNode)`：将节点设为...的子节点
* `makeRoot()`：将当前节点设为根节点。
### [](https://octobercms.com/docs/database/traits#validation)验证方式
October模型使用内置的[Validator类](https://octobercms.com/docs/services/validation)。验证规则在模型类中定义为名为的属性`$rules`，并且该类必须使用trait`October\Rain\Database\Traits\Validation`：
~~~
class User extends Model
{
use \October\Rain\Database\Traits\Validation;
public $rules = [
'name' => 'required|between:4,16',
'email' => 'required|email',
'password' => 'required|alpha_num|between:4,8|confirmed',
'password_confirmation' => 'required|alpha_num|between:4,8'
];
}
~~~
> **注意**：您也可以将[数组语法](https://octobercms.com/docs/services/validation#validating-arrays)用于验证规则。
~~~
class User extends Model
{
use \October\Rain\Database\Traits\Validation;
public $rules = [
'links.*.url' => 'required|url',
'links.*.anchor' => 'required'
];
}
~~~
`save`调用方法时，模型会自动验证自己。
~~~
$user = new User;
$user->name = 'Actual Person';
$user->email = 'a.person@example.com';
$user->password = 'passw0rd';
// Returns false if model is invalid
$success = $user->save();
~~~
> **注意：**您也可以随时使用`validate`方法验证模型。
### [](https://octobercms.com/docs/database/traits#retrieving-validation-errors)检索验证错误
当模型验证失败时，会将`Illuminate\Support\MessageBag`对象附加到模型。包含验证失败消息的对象。使用`errors`方法或`$validationErrors`属性检索验证错误消息收集实例。使用检索所有验证错误`errors()->all()`。使用检索*特定*属性的错误`validationErrors->get('attribute')`。
> **注意：**模型利用MessagesBag对象，该对象具有[简单而优雅](https://octobercms.com/docs/services/validation#working-with-error-messages)的错误格式化[方法](https://octobercms.com/docs/services/validation#working-with-error-messages)。
### [](https://octobercms.com/docs/database/traits#overriding-validation)覆盖验证
该`forceSave`方法将验证模型并保存，无论是否存在验证错误。
~~~
$user = new User;
// Creates a user without validation
$user->forceSave();
~~~
### [](https://octobercms.com/docs/database/traits#custom-error-messages)自定义错误消息
就像Validator类一样，您可以使用[相同的语法](https://octobercms.com/docs/services/validation#custom-error-messages)设置自定义错误消息。
~~~
class User extends Model
{
public $customMessages = [
'required' => 'The :attribute field is required.',
...
];
}
~~~
您还可以将自定义错误消息添加到验证规则的数组语法中。
~~~
class User extends Model
{
use \October\Rain\Database\Traits\Validation;
public $rules = [
'links.*.url' => 'required|url',
'links.*.anchor' => 'required'
];
public $customMessages = [
'links.*.url.required' => 'The url is required',
'links.*.url.*' => 'The url needs to be a valid url'
'links.*.anchor.required' => 'The anchor text is required',
];
}
~~~
在上面的示例中，您可以将自定义错误消息写入特定的验证规则（此处使用：）`required`。或者，您可以使用`*`来选择其他所有内容（此处，我们`url`使用向验证规则中添加了自定义消息`*`）。
### [](https://octobercms.com/docs/database/traits#custom-attribute-names)自定义属性名称
您也可以使用`$attributeNames`数组设置自定义属性名称。
~~~
class User extends Model
{
public $attributeNames = [
'email' => 'Email Address',
...
];
}
~~~
### [](https://octobercms.com/docs/database/traits#dynamic-validation-rules)动态验证规则
您可以通过重写`beforeValidate`[模型事件](https://octobercms.com/docs/database/model#events)方法来动态应用规则。在这里，我们检查`is_remote`属性是否为`false`，然后将`latitude`和`longitude`属性动态设置为必填字段。
~~~
public function beforeValidate()
{
if (!$this->is_remote) {
$this->rules['latitude'] = 'required';
$this->rules['longitude'] = 'required';
}
}
~~~
### [](https://octobercms.com/docs/database/traits#custom-validation-rules)自定义验证规则
您也可以使用与Validator服务[相同的方式](https://octobercms.com/docs/services/validation#custom-validation-rules)创建自定义验证规则。
### [](https://octobercms.com/docs/database/traits#soft-deleting)软删除
软删除模型时，实际上不会从数据库中删除它。而是`deleted_at`在记录上设置时间戳。要为模型启用软删除，请将`October\Rain\Database\Traits\SoftDelete`特征应用于模型，然后将delete\_at列添加到`$dates`属性中：
~~~
class User extends Model
{
use \October\Rain\Database\Traits\SoftDelete;
protected $dates = ['deleted_at'];
}
~~~
要将`deleted_at`列添加到表中，可以使用`softDeletes`迁移中的方法：
~~~
Schema::table('posts', function ($table) {
$table->softDeletes();
});
~~~
现在，当您`delete`在模型上调用方法时，该`deleted_at`列将设置为当前时间戳。查询使用软删除的模型时，“已删除”模型将不包含在查询结果中。
要确定给定的模型实例是否已被软删除，请使用以下`trashed`方法：
~~~
if ($user->trashed()) {
//
}
~~~
### [](https://octobercms.com/docs/database/traits#querying-soft-deleted-models)查询软删除的模型
#### 包括软删除的模型
如上所述，软删除的模型将自动从查询结果中排除。但是，您可以使用`withTrashed`查询中的方法强制将软删除的模型显示在结果集中：
~~~
$users = User::withTrashed()->where('account_id', 1)->get();
~~~
该`withTrashed`方法还可以用于[关系](https://octobercms.com/docs/database/relations)查询：
~~~
$flight->history()->withTrashed()->get();
~~~
#### 仅检索软删除的模型
该`onlyTrashed`方法将**仅**检索软删除的模型：
~~~
$users = User::onlyTrashed()->where('account_id', 1)->get();
~~~
#### 恢复软删除的模型
有时您可能希望“取消删除”软删除的模型。要将软删除的模型恢复为活动状态，请`restore`在模型实例上使用方法：
~~~
$user->restore();
~~~
您也可以`restore`在查询中使用该方法来快速恢复多个模型：
~~~
// Restore a single model instance...
User::withTrashed()->where('account_id', 1)->restore();
// Restore all related models...
$user->posts()->restore();
~~~
#### 永久删除模型
有时您可能需要从数据库中真正删除模型。要从数据库中永久删除软删除的模型，请使用以下`forceDelete`方法：
~~~
// Force deleting a single model instance...
$user->forceDelete();
// Force deleting all related models...
$user->posts()->forceDelete();
~~~
### [](https://octobercms.com/docs/database/traits#soft-deleting-relations)软删除关系
当两个相关模型启用了软删除时，您可以通过`softDelete`在[关系定义中定义](https://octobercms.com/docs/database/relations#detailed-relationships)选项来级联删除事件。在此示例中，如果用户模型被软删除，则属于该用户的注释也将被软删除。
~~~
class User extends Model
{
use \October\Rain\Database\Traits\SoftDelete;
public $hasMany = [
'comments' => ['Acme\Blog\Models\Comment', 'softDelete' => true]
];
}
~~~
> **注意：**如果相关模型不使用软删除特征，则将其与`delete`选项一样对待并永久删除。
在这些相同的条件下，还原主模型时，所有使用该`softDelete`选项的相关模型也将还原。
~~~
// Restore the user and comments
$user->restore();
~~~
### [](https://octobercms.com/docs/database/traits#soft-delete-with-sluggable-trait)具有删除特性的软删除
默认情况下，当生成条块时，可拖动特征将忽略软删除的模型。为了使模型恢复[减轻](https://octobercms.com/docs/database/traits#sluggable-with-softdelete-trait)痛苦[的拖延部分](https://octobercms.com/docs/database/traits#sluggable-with-softdelete-trait)。
### [](https://octobercms.com/docs/database/traits#nullable)可空
可空属性设置为`NULL`空时。要使模型中的属性无效，请应用`October\Rain\Database\Traits\Nullable`特征并`$nullable`使用包含要无效的属性的数组声明属性。
~~~
class Product extends Model
{
use \October\Rain\Database\Traits\Nullable;
/**
* @var array Nullable attributes.
*/
protected $nullable = ['sku'];
}
~~~
- 基本说明
- 基本操作
- October cms 安装
- 后台控制器路径
- 图标
- 获取安装网上的插件/主题
- 插件构造器使用
- 定时任务
- October后台控制器
- vscode编辑器
- ajax操作
- 使用
- ajax更新组件
- ajax属性API
- JavaScript API
- ajax综合使用
- 主题
- 多语言主题
- 安装市场主题
- 主题程序处理
- 主题
- 页面
- 部件
- 布局
- 内容
- 组件
- 媒体
- 主题表单操作
- 表单使用
- 表单后端程序处理
- 插件
- 自定义插件
- 插件说明
- 插件导航条
- 插件数据库设置
- 插件的设置管理
- 插件的配置文件config
- 组件
- app服务
- app容器
- 扩展行为
- 缓存
- Collection类
- Lazy Collections
- Collection方法
- 助手函数
- 数组助手函数
- 路径助手函数
- 玄乐助手函数
- 其他助手函数
- 错误与记录
- 事件处理
- HTML页面
- 文件与目录操作
- 散列和加密
- 邮件
- 邮件内容
- 邮件发送
- 分页
- 模板解析器
- 动态解析器语法
- 队列消息
- 请求与输入
- 响应
- 视图
- 路由器
- 配置
- 验证操作
- 处理错误消息
- 错误消息与视图
- 可用的验证规则
- 有条件的验证规则
- 验证数组
- 错误消息
- 自定义验证规则
- 模型操作
- 定义模型与其属性
- 检索模型
- 插入与更新
- 删除模型
- 查询范围
- 事件操作
- 关联操作
- 定义关系
- 关系类型
- 多肽关系
- 关系查询
- 渴望加载
- 插入模型
- 数据库操作
- 基本用法
- 数据表结构
- 查询连贯操作
- 结果检索
- select子句
- 插入更新
- where子句
- 排序，分组，限制和偏移
- 文件附件
- Collection操作
- 属性操作
- 系列化json
- 数据库属性
- 数据库行为
- 控制器
- 后台控制器定义
- 后台页面
- 后台组件
- 后台表单
- 表单组件
- 表单视图
- 表单行为
- 后台列表
- 列表行为
- 列表过滤器
- 可用列类型
- 关系行为
- 关系行为类型
- 扩展关系行为
- 列表排序操作
- 导入导出操作
- 用于与权限
- corlate模板修改
- 修改顶部导航
- laravel问题
- 控制器不存在
- 控制器
- 路由组
- laravel笔记
- laravel 安装
- 伪静态配置
- 依赖注入 & 控制器
- 中间件
- 路由文件
- 视图