enjame/bitrix-models

0.7.22 2020-01-24 12:51 UTC

README

Latest Stable Version Total Downloads Build Status Scrutinizer Quality Score

Bitrix模型

介绍

本包将Model Layer引入到Bitrix中。这个层逻辑上由两部分组成

  1. 用于Bitrix实体(以下简称“Bitrix模型”)的模型,通过Bitrix的API(如CIBlockElement等)工作,并在其之上构建。而从外部来看,这个构建类似于Eloquent
  2. 用于任意表的模型,通过illuminate/database整体和Eloquent具体工作。

安装

  1. composer require arrilot/bitrix-models
  2. init.php中注册包 - Arrilot\BitrixModels\ServiceProvider::register();

使用Bitrix模型

可用的以下模型可用于继承

Arrilot\BitrixModels\Models\ElementModel
Arrilot\BitrixModels\Models\SectionModel
Arrilot\BitrixModels\Models\UserModel
Arrilot\BitrixModels\Models\D7Model

以下我们将以元素信息块模型(ElementModel)为例进行说明。对于其他实体,API几乎相同。

ElementModel完全支持第二版信息块(在单独的表中存储属性)。对于第一版,由于CIBlockElement::GetList()的工作特性,某些功能可能无法正常工作。最大的问题是:如果信息块有多个属性,那么使用limit()、take()和first()的查询将不正确,并且会得到比所需更少的元素,并且不会包含完整的多个属性集。如果您仍然打算在第一版信息块中使用ElementModel,那么请在模型类内部设置const IBLOCK_VERSION = 1;

创建商品信息块模型。

<?php

use Arrilot\BitrixModels\Models\ElementModel;

class Product extends ElementModel
{
    /**
     * Corresponding iblock id.
     *
     * @return int
     */
    const IBLOCK_ID = 1;
}

要使用模型,只需在常数中指定信息块的ID。对于用户来说,这也不需要。

如果您不想绑定到信息块ID,可以在模型中重写方法public static iblockId(),例如按代码获取信息块ID。这提供了更大的灵活性,但您可能需要执行额外的数据库查询。

我们将使用我们的Product类,既在静态上下文中,也在动态上下文中。

添加产品

// $fields - массив, аналогичный передаваемому в CIblockElement::Add(), но IBLOCK_ID в нём можно не указывать.
$product = Product::create($fields);

注意:如果后续使用$product字段,建议立即使用新数据库查询更新对象。这是因为CIblockElement::Add()和CIblockElement::GetList()中的字段格式在100%上不匹配。可以这样操作

$product = Product::create($fields)
$product->refresh();

更新

// вариант 1
$product['NAME'] = 'Новое имя продукта';
$product->save();

// вариант 2
$product->update(['NAME' => 'Новое имя продукта']);

不查询数据库实例化模型。

对于一些操作,不需要从数据库获取信息,只需ID即可。在这种情况下,只需实例化模型对象,并在构造函数中传递标识符。

$product = new Product($id);

//теперь есть возможно работать с моделью, допустим
$product->deactivate();

从数据库获取对象字段

$product = new Product($id);

// метод `load` обращается к базе, только если информация еще не была получена.
$product->load();

// Если мы хотим принудительно обновить информацию из базы даже если она уже была получена ранее
$product->refresh();

// После любого из этих методов, мы можем работать с полученными полями (`echo $product['CODE'];`)

//Для текущего пользователья есть отдельный хэлпер
$user = User::current();
// В итоге мы получаем инстанс User с заполненными полями. 
// Сколько бы раз мы не вызывали `User::current()` в рамках работы скрипта, запрос в базу происходит только один раз - первый.
// `User::freshCurrent()` - то же самое, но получает данные из базы каждый раз.

所述方法在类模型实例内保存数据库中的数据。模型对象实现了ArrayAccess,因此可以像使用数组一样处理它们。

$product->load();
if ($product['CODE'] === 'test') {
    $product->deactivate();
}

将模型转换为数组/json。

$array = $product->toArray();
$json = $product->toJson();

默认情况下,所有模型字段都可用在数组中,这并不总是希望的。模型有特殊属性protected $visible = [];protected $hidden = [];,可以使用它们来定义白名单/黑名单字段,以将模型转换为数组/json。

从数据库获取信息

使用模型最常见的场景是从数据库获取元素/列表。用于构建查询的是“Fluent API”,它在内部使用标准的Bitrix API。

要开始构建查询,使用静态方法::query()。该方法返回查询构建器对象(ElementQuerySectionQueryUserQuery),然后通过该对象构建查询链。

最简单的示例

$products = Product::query()->select('ID')->getList();

实际上,这个表单更多是为了理解而提供的,有更方便的视图,它使用 __callStatic 将控制权传递给请求对象。

$products = Product::select('ID')->getList();

任何查询链必须以以下方法之一结束

  1. ->getList() - 获取对象集合(见 https://laravel.net.cn/docs/master/collections)。默认情况下,每个元素的键是其 ID。
  2. ->getById($id) - 根据其 ID 获取对象。
  3. ->first() - 获取一个(第一个)符合查询参数的对象。
  4. ->count() - 获取对象数量。
  5. ->paginate() 或 ->simplePaginate() - 获取分页列表及元数据(见 https://laravel.net.cn/docs/master/pagination
  6. 单个实体的方法:->getByLogin($login)->getByEmail($email) - 获取具有给定登录名/电子邮件的第一个用户。 ->getByCode($code)->getByExternalId($id) - 获取第一个匹配 CODE/EXTERNAL_ID 的元素或信息块部分。

查询选择管理

  1. ->sort($array) - 类似于 $arSortCIBlockElement::GetList 的第一个参数)

示例

->sort(['NAME' => 'ASC', 'ID' => 'DESC'])

->sort('NAME', 'DESC') // = ->sort(['NAME' => 'DESC'])

->sort('NAME') // = ->sort(['NAME' => 'ASC'])

  1. ->filter($array) - 类似于 $arFilter
  2. ->navigation($array)
  3. ->select(...) - 类似于 $arSelect

示例

->select(['ID', 'NAME'])

->select('ID', 'NAME')

select() 支持两个额外的值 - 'FIELDS'(选择所有字段),'PROPS'(选择所有属性)。对于用户,还可以指定 'GROUPS'(在查询中选择用户组)。对于 ElementModel,默认值为 ['FIELDS', 'PROPS']

  1. ->limit($int)->take($int)->page($int)->forPage($page, $perPage) - 用于导航

Fetch 和 GetNext

默认情况下,在模型内部迭代从数据库获取的元素/部分/用户时使用高效的方法 ->Fetch()。与 ->GetNext() 不同,它不会将数据转换为 html 安全格式,也不会将 DETAIL_PAGE_URL、SECTION_PAGE_URL 转换为元素的实时 URL 和分类的 URL。如果查询结果需要这些转换,则可以切换到该方法。

  1. 可以通过设置模型属性来一次性切换整个模型。

        public static $fetchUsing = 'GetNext';
    
        // полная форма, если нужно менять параметры.
        public static $fetchUsing = [
            'method' => 'GetNext',
            'params' => [true, true],
        ];
  2. 也可以为单个查询切换。

         Products::query()->filter(['ACTIVE' => 'Y'])->fetchUsing('GetNext')->getList()`
         // вместо строки `'GetNext'` можно как и в первом случае использовать массив.

一些额外注意事项

  1. 为了限制选择,添加了别名 limit($value)(对应 nPageSize)和 page($num)(对应 iNumPage
  2. 在某些地方,API 比 Bitrix 本身更友好。例如,在用户筛选中,不必使用 'GROUP_IDS'。在传递 'GROUP_ID'(Bitrix 所需的键,例如在创建用户时)或 'GROUPS' 时,结果将相同。
  3. 在创建或更新信息块元素和部分时,Bitrix 会重建搜索索引,并允许在调用 Add/Update 时跳过此重建以增加性能。在模型中,您可以立即通过在模型类中设置 protected static $updateSearch = false; 或在添加/更新前调用单独的静态方法 Product::setUpdateSearch(false) 来达到相同的效果。
  4. 可以使用类似的方式管理 CIBlockElement::Add/Update 的 $bWorkFlow 和 $bResizePictures 标志。

查询作用域

可以通过在模型中添加以 "scope" 开头的公共方法来扩展查询构建器。为此,需要创建一个以 "scope" 开头的方法。

包中已经存在的一个 "query scope" 示例。

    /**
     * Scope to get only active items.
     *
     * @param BaseQuery $query
     *
     * @return BaseQuery
     */
    public function scopeActive($query)
    {
        $query->filter['ACTIVE'] = 'Y';
    
        return $query;
    }

...

$products = Product::filter(['SECTION_ID' => $secId])
                    ->active()
                    ->getList();

在 "query scopes" 中也可以传递额外的参数。

    /**
     * @param ElementQuery $query
     * @param string|array $category
     *
     * @return ElementQuery
     */
    public function scopeFromSectionWithCode($query, $category)
    {
        $query->filter['SECTION_CODE'] = $category;

        return $query;
    }

...
$users = Product::fromSectionWithCode('sale')->getList();

这些作用域已经存在于包中,可以使用。

停止操作

有时需要在查询范围内停止从数据库中采样。为此,只需返回 false。示例

    public function scopeFromCategory($query, $category)
    {
        if (!$category) {
            return false;
        }
        
        $query->filter['SECTION_CODE'] = $category;

        return $query;
    }
...

结果,将不会向数据库发出请求 - getList() 将返回空集合,getById() 将返回 false,而 count() 将返回 0。

可以通过手动调用方法 ->stopQuery() 达到相同的效果

查询缓存

对于上述所有 Bitrix 模型,都有一个简单的内置缓存机制。只需在调用链中添加 ->cache($minutes)->,然后从数据库中采样结果将在指定分钟内被缓存。例如:$products = Products::query()->cache(30)->filter(['ACTIVE' => 'Y'])->getList() 在幕后,缓存是通过 Bitrix d7 的标准机制实现的。缓存键取决于模型和所有查询参数。

访问器

有时需要在从数据库中提取数据并获得模型数据之间进行某种修改。为此,使用访问器。与 "查询范围" 一样,为了添加访问器,需要将方法添加到相应的模型中。

方法命名规则为 $methodName = "get".camelCase($field)."Attribute"。示例

    public function getXmlIdAttribute($value)
    {
        return (int) $value;  
    }
    
    // теперь в $product['XML_ID'] всегда будет целочисленное значение
    

需要谨慎使用此方法,因为原始值将不可用。

还可以为不存在的(虚拟)字段创建访问器,例如

    public function getFullNameAttribute()
    {
        return $this['NAME']." ".$this['LAST_NAME'];
    }
    
    ...
    
    echo $user['NAME']; // John
    echo $user['LAST_NAME']; // Doe
    echo $user['FULL_NAME']; // John Doe

为了使这些虚拟访问器在 toArray() 和 toJson() 中显示,必须显式地将它们指定在模型的 $appends 字段中。

    protected $appends = ['FULL_NAME'];

语言访问器

对于多语言网站,典型的做法是为每种语言创建一个属性,例如,UF_TITLE_RU,UF_TITLE_BY。在这种情况下,可以为每个此类字段创建一个访问器

// используем далее $section['UF_TITLE'];
public function getUfTitleAttribute()
{
    return $this['UF_TITLE_' . strtoupper(LANGUAGE_ID)];
}

// используем далее $element['PROPERTY_TITLE'];
public function getPropertyTitleAttribute()
{
    return $this['PROPERTY_TITLE_' . strtoupper(LANGUAGE_ID) . '_VALUE'];
}

由于这些访问器类型相同并且具有会污染模型的缺点,因此可以使用特殊简短语法

class Product extends ElementModel
{
    protected $languageAccessors = [
        'PROPERTY_TITLE',
        'PROPERTY_FOO'
    ];
}

模型事件(Model Events)

事件允许在模型的各个生命周期点插入代码。例如,在创建元素时自动设置字符码。模型事件不使用 Bitrix 的事件模型(无论是旧内核还是 D7)和仅涉及模型内部发生的事情。使用 Bitrix 事件可以覆盖更多用例。

事件处理器通过在模型类中重写相应的方法来设置。

class News extends ElementModel
{
    /**
     * Hook into before item create or update.
     *
     * @return mixed
     */
    protected function onBeforeSave()
    {
        $this['CODE'] = CUtil::translit($this['NAME'], "ru");
    }

    /**
     * Hook into after item create or update.
     *
     * @param bool $result
     *
     * @return void
     */
    protected function onAfterSave($result)
    {
        //
    }
}

其他事件处理器的签名与上面提供的相同。

可用事件列表

  1. onBeforeCreate - 在添加记录之前
  2. onAfterCreate(bool $result) - 在添加记录之后
  3. onBeforeUpdate - 在更新记录之前
  4. onAfterUpdate(bool $result) - 在更新记录之后
  5. onBeforeSave - 在添加或更新记录之前
  6. onAfterSave(bool $result) - 在添加或更新记录之后
  7. onBeforeDelete - 在删除记录之前
  8. onAfterDelete(bool $result) - 在删除记录之后

如果从 onBefore...() 处理器中返回 return false;,则后续操作将被取消。在处理器中,可以使用当前模型对象属性获取额外信息。例如,在 onBefore...() 处理器中,可以通过 $this->fields 访问所有字段;在所有 onAfter...() 处理器中,可以通过 $this->eventErrors 访问错误数组;在 onBeforeUpdate()onBeforeSave() 处理器中,可以通过 $this->fieldsSelectedForSave 访问要更新的字段键数组。

D7 Model

与之前模型略有不同的是 D7Model。与旧的 GetList 等不同,它使用 D7 作为后端。通过它可以操作 D7 的普通实体以及高负载块。

高负载块示例

class Subscriber extends D7Model
{
    public static function tableClass()
    {
        $hlBlock = HighloadBlockTable::getRowById(1);
    
        return HighloadBlockTable::compileEntity($hlBlock)->getDataClass();
    }
}

显然,获取高负载块类的逻辑可以是任意的,但重要的是不要忘记编译它,否则它将不会工作。最方便的选项可能是使用辅助包 https://github.com/arrilot/bitrix-iblock-helper/。有了它,我们将得到以下内容

class Subscriber extends D7Model
{
    public static function tableClass()
    {
        return highloadblock_class('app_subscribers');
    }
}

如果我们不是与高负载块,而是与完整的D7 ORM实体工作,则只需在此方法中返回该实体的完整类名。D7Model的调用链和方法名称与先前模型相同。传递给这些方法的任何内容都将进一步传递到D7。

例如,获取所有名为John的订阅者,并缓存5分钟

$subscribers = Subscriber::query()->cache(5)->filter(['=NAME'=>'John])->getList();

以下是完整的方法列表

/**
 * static int count()
 *
 * D7Query methods
 * @method static D7Query runtime(array|\Bitrix\Main\Entity\ExpressionField $fields)
 * @method static D7Query enableDataDoubling()
 * @method static D7Query disableDataDoubling()
 * @method static D7Query cacheJoins(bool $value)
 *
 * BaseQuery methods
 * @method static Collection getList()
 * @method static D7Model first()
 * @method static D7Model getById(int $id)
 * @method static D7Query sort(string|array $by, string $order='ASC')
 * @method static D7Query order(string|array $by, string $order='ASC') // same as sort()
 * @method static D7Query filter(array $filter)
 * @method static D7Query addFilter(array $filters)
 * @method static D7Query resetFilter()
 * @method static D7Query navigation(array $filter)
 * @method static D7Query select($value)
 * @method static D7Query keyBy(string $value)
 * @method static D7Query limit(int $value)
 * @method static D7Query offset(int $value)
 * @method static D7Query page(int $num)
 * @method static D7Query take(int $value) // same as limit()
 * @method static D7Query forPage(int $page, int $perPage=15)
 * @method static \Illuminate\Pagination\LengthAwarePaginator paginate(int $perPage = 15, string $pageName = 'page')
 * @method static \Illuminate\Pagination\Paginator simplePaginate(int $perPage = 15, string $pageName = 'page')
 * @method static D7Query stopQuery()
 * @method static D7Query cache(float|int $minutes)
 */

有关详细信息,请参阅vendor/arrilot/bitrix-models/src/Models/D7Model.phpvendor/arrilot/bitrix-models/src/Queries/D7Query.php

模型之间的关联(关系)

除了处理单独的Bitrix模型外,还可以在模型之间建立关联,这使得它们可以通过主要数据对象轻松获取。例如,商品与商品问题相关联。通过声明这种关系,您可以使用表达式$product->questions获取模型问题对象,它以Question类(BaseBitrixModel的子类)对象的形式返回有关问题的信息。

声明关系

/**
 * Class Product
 *
 * @property Brand $brand
 * @property ProductQuestion $questions
 * @property Storage $storages
 */
class Product extends ElementModel
{
    ...
    
    /**
     * ID Brand записан в текущую модель в свойтво PROPERTY_BRAND_VALUE (не множественное)
     * (у товара может быть только один бренд, но у бренда много товаров)
     */
    public function brand()
    {
        return $this->hasOne(Brand::class, 'ID', 'PROPERTY_BRAND_VALUE');
    }
    
    /**
     * У ProductQuestion в свойтве PROPERTY_PRODUCT_VALUE записан ID текущей модели
     * (у товара может быть много вопросов, но вопрос относится только к одному товару)
     *
     * Но это будет так же работать, если PROPERTY_PRODUCT_VALUE будет множественным
     */
    public function questions()
    {
        return $this->hasMany(ProductQuestion::class, 'PROPERTY_PRODUCT_VALUE', 'ID');
    }
    
    /**
     * ID Storage записан в текущую модель в свойтво PROPERTY_STORAGE_VALUE (множественное)
     * (у товара может быть много складов, на складе может быть много товаров)
     */
    public function storages()
    {
        return $this->hasMany(Storage::class, 'ID', 'PROPERTY_STORAGE_VALUE');

    }
}

关系名称区分大小写。

在声明关系时,您必须指定以下信息

  • 关系复数:使用hasMany()或hasOne()方法调用指定。
  • 关联类名称:作为hasMany() / hasOne()方法的第一个参数指定。
  • 两种数据类型之间的关联:第二个参数是外部模型中的字段,第三个是内部模型中的字段(默认为ID)。
  • 与其它ORM不同,多对多关系不使用中间(pivot)表。相反,使用Bitrix的多属性。

访问关联数据

声明关系后,您可以通过关系名称获取关联数据。访问是通过对象属性实现的。属性名称=关系方法名称(当然,不带方法括号)

$product = Product::getById(1);

// В этот момент используются магические методы и выполняются sql запросы в БД за данными.
$product->brand; // Объект класса Brand
$product->questions; // Collection объектов класса ProductQuestion

// Запросы в базу выполняются лишь один раз. При повторном обращении к переменной возвращаются данные получененные при первом запросе. 
$product->brand;
$product->questions;

延迟加载和贪婪加载

上述示例中使用了延迟加载(数据在第一次访问时加载)。当处理数据数组时,我们会在循环中收到查询,即n + 1问题。

$products = Product::getList();

foreach($products as $product) {
    // Выполняется запрос
    $product->brand;
}

为了避免这种情况,需要使用贪婪加载

// Выполняется один дополнительный запрос который получит все бренды для всех полученных продуктов.
$products = Product::query()->with('brand')->getList();

foreach($products as $product) {
    // Запрос не выполняется
    $product->brand;
}
  • with方法可以多次调用。
  • 作为参数接受字符串 - 关系名称或多个字符串/字符串数组->with('brand', 'questions')/->with(['brand', 'questions'])
  • 您可以指定嵌套关系->with('questions.answers')(在这种情况下,将立即加载问题和每个问题的答案列表。总共3个查询 - 商品、问题、答案)。
  • 可以使用回调修改查询。例如,仅加载活动问题,并为其加载答案
->with([
    'questions' => function ($query) {
        $query->filter(['ACTIVE' => 'Y'])
    },
    'questions.answers'
])

使用Eloquent模型

包的第二部分是ORM Eloquent的集成,用于Bitrix的用户表,即手动开发而不是与系统一起提供的表。实际上,这是D7 ORM和此包中的D7Model的直接查询的替代品。

通过Eloquent不仅可以处理用户表,还可以处理高负载块,这非常方便。在这种情况下,我们使用高负载块表,而无需使用任何Bitrix API。

需要注意的是,与Bitrix不同,Eloquent使用PDO作为PHP的扩展来访问mysql,而不是mysql/mysqli。这意味着

  1. 必须安装和配置PDO
  2. 在请求时将创建两个数据库连接。

注意:问题:为什么在同一个包中有Eloquent,如果已经有了D7Model?选择哪个更好?回答:选择取决于项目和个人的偏好。Eloquent比Bitrix和D7Model中的所有内容都更方便、功能更强大。例如,那里有通过中间表实现的完整模型关系等。另一方面,这是一个大的外部依赖,有自己的要求

缺点

安装

首先,需要添加另一个依赖项 - composer require illuminate/database。之后,在 init.php 文件中添加一行代码 - Arrilot\BitrixModels\ServiceProvider::registerEloquent();。现在,可以创建继承自 EloquentModel 的 Eloquent 模型了。

<?php

use Arrilot\BitrixModels\Models\EloquentModel;

class Product extends EloquentModel
{
    protected $table = 'app_products';
}

如果表名为 products(类的复数形式),则可以省略 protected $table = 'products';,这是 Eloquent 的标准行为。

  1. 主键是 ID,而不是 id
  2. 记录创建和更新时间字段分别命名为 UF_CREATED_ATUF_UPDATED_AT,而不是 created_atupdated_at

如果您决定不在表中添加 UF_CREATED_ATUF_UPDATED_AT 字段,则需要在模型中设置 public $timestamps = false;

通过 Eloquent 操作 Highload-块

假设我们为品牌创建了一个 Highload-块,名为 Brands,为其指定了 brands 表,并添加了 UF_NAME 属性。对应的模型类将如下所示:

<?php

use Arrilot\BitrixModels\Models\EloquentModel;

class Brand extends EloquentModel
{
    public $timestamps = false;
}

要向其中添加新记录,可以使用以下代码:

$brand = new Brand();
$brand['UF_NAME'] = 'Nike';
$brand->save();

// либо даже такого если настроены $fillable поля.
$brand = Brand::create(['UF_NAME' => 'Nike']);

要完全使用 Eloquent 模型,了解该 ORM 的官方文档非常重要 (链接再次提供)

最后要注意的是,尽管 Bitrix 模型和 Eloquent 模型的 API 非常相似(这在很大程度上是由于 bitrix-models 在 Eloquent 影响下开发),但它们仍然是不同的东西,并且它们在内部是完全独立的。例如,不能建立 Eloquent 模型和 Bitrix 模型之间的关联。

Highload-块和 Eloquent 模型的多属性

Highload-块的多属性实现有些巧妙。数据存储在两个地方。

  1. 直接在 Highload-块表中以序列化形式。
  2. 在为该属性创建的辅助表中。幸运的是,该包很好地解决了这个问题。添加多属性时,只需将模型中该属性的代码添加到模型的 $multipleHighloadBlockFields 字段数组中。例如 public $multipleHighloadBlockFields = ['UF_SOME_MULTIPLE_FIELD']; 然后
  3. $model['UF_SOME_MULTIPLE_FIELD'] 将返回反序列化的数组。
  4. 添加/更新字段值时,也只需将数组放入 $model['UF_SOME_MULTIPLE_FIELD'] 中,无需手动序列化。
  5. 添加/更新字段值时,更改将自动应用于辅助表。无需手动更改它。要使最后一点工作,需要安装额外的依赖项 - composer require illuminate/events。没有这个依赖项,辅助表将不会更新。关于它的更多详细信息在下一段中。

Eloquent 模型的事件

Eloquent 有所谓的 模型事件 / Model events,这允许在模型工作的某个时刻插入。整体上,这与 Bitrix 的 OnBeforeIblockElementUpdate 等事件非常相似。如果需要它们,则需要与 illuminate/database 一起安装依赖项 illuminate/events

composer require illuminate/events

查询构建器

在连接 Eloquent 时,我们免费获得了 Laravel 的 Query Builder https://laravel.net.cn/docs/master/queries,它非常有用,如果需要直接与数据库交互,而无需通过模型层的话。它比 $DB->Query() 等方式更方便,也更安全。

通过全局可访问的类 DB 进行操作。例如,将品牌元素添加到 HL-块的方式如下:

DB::table('brands')->insert(['UF_NAME' => 'Nike']);

分页导航

Bitrix 模型和 Eloquent 模型都支持 ->paginate()->simplePaginate()(请参阅 https://laravel.net.cn/docs/master/pagination)。要使用 ->links() 显示分页导航,则需要

  1. 安装 https://github.com/arrilot/bitrix-blade/
  2. 将默认视图从 https://github.com/laravel/framework/tree/master/src/Illuminate/Pagination/resources/views 复制到 local/views/pagination

之后,您可以修改这些视图或创建新的视图。

D7Model/EloquentModel 中的元素活动性

在 Bitrix 的信息块中,存在一个字段 ACTIVE = 'Y'/'N',经常用于过滤。在高清加载块和自定义表中,默认没有这样的字段,但是包提供了一个 trait,有助于创建类似的功能。它是如何工作的

  1. 向表/高清加载块中添加字段 UF_DEACTIVATED_AT,类型为 datetime。

  2. 在 D7Model/EloquentModel 中添加 trait use \Arrilot\BitrixModels\Models\Traits\DeactivationTrait;

  3. 现在模型中可用以下方法

    3.1. $model->deactivate()$model->activate() - 在数据库中禁用或启用元素。

    3.2. $model->markForDeactivation()$model->markForActivation() - 与之相同,但只更改 PHP 变量,不执行 ->save()。如果需要激活时对表进行其他更改,而不想进行额外的数据库查询,这很有用。

    3.3. 范围 ->active()->deactivated()。例如 SomeD7Model::query()->active()->getList()