ActiveRecordImplementation.php

См. документацию.

<?php
 
namespace Bitrix\Im\V2\Common;
 
use Bitrix\Main\NotImplementedException;
use Bitrix\Main\ORM\Data\DataManager;
use Bitrix\Main\ORM\Entity;
use Bitrix\Main\ORM\Fields\Relations\Relation;
use Bitrix\Main\ORM\Objectify\EntityObject;
use Bitrix\Im\Model\EO_Chat;
use Bitrix\Im\Model\EO_Message;
use Bitrix\Im\Model\EO_MessageParam;
use Bitrix\Im\V2\Error;
use Bitrix\Im\V2\Result;
use Bitrix\Im\V2\RegistryEntry;
use Bitrix\Main\ORM\Objectify\Values;
use Bitrix\Main\Type\DateTime;

trait ActiveRecordImplementation
{
    protected $dataObject;
 
    // Object changed flag
    protected bool $isChanged = true;
 
    // Object marked to drop
    protected bool $markedDrop = false;

    protected static function mirrorDataEntityFields(): array
    {
        throw new NotImplementedException;
        return [];
    }

    public function getDataEntity(): EntityObject
    {
        if ($this->dataObject === null)
        {
            $dataClass = static::getDataClass();
            $entityObjectClass = $dataClass::getObjectClass();
            $this->dataObject = new $entityObjectClass;
        }
 
        return $this->dataObject;
    }

    protected function setDataEntity(EntityObject $dataObject): self
    {
        $this->dataObject = $dataObject;
        return $this;
    }
 
    protected function resetDataEntity(array $preselectedFields = []): self
    {
        $fields = $preselectedFields;
        if ($this->dataObject)
        {
            $fields += $this->dataObject->collectValues(Values::ACTUAL);
        }
 
        $this->dataObject = static::getDataClass()::getObjectClass()::wakeUp($fields);
 
        return $this;
    }

    public function load($source): Result
    {
        $result = new Result;
 
        if (is_numeric($source))
        {
            $source = (int)$source;
            $dataClass = static::getDataClass();
            $dataObject = $dataClass::getByPrimary($source)->fetchObject();
 
            if (
                $dataObject instanceof EntityObject
                && $dataObject->hasId()
            )
            {
                $result = $this->initByDataEntity($dataObject);
            }
            else
            {
                $result->addError(new Error(Error::NOT_FOUND));
            }
        }
 
        elseif ($source instanceof EntityObject)
        {
            $result = $this->initByDataEntity($source);
        }
 
        elseif (is_array($source))
        {
            $result = $this->initByArray($source);
        }
        else
        {
            $result->addError(new Error(Error::NOT_FOUND));
        }
 
        if ($result->isSuccess() && $this->getPrimaryId())
        {
            $this->markChanged(false);
 
            if (
                $this instanceof RegistryEntry
                && $this->getRegistry()
            )
            {
                $this->getRegistry()[$this->getPrimaryId()] = $this;
            }
        }
 
        return $result;
    }

    protected function initByDefault(): void
    {
        foreach (static::mirrorDataEntityFields() as $field)
        {
            if (
                !isset($field['primary'])
                && !isset($field['alias'])
                && isset($field['field'], $field['default'])
                && !isset($this->{$field['field']})
                && ($default = $field['default'])
                && is_string($default)
                && is_callable([$this, $default])
            )
            {
                $this->{$field['field']} = $this->$default();
            }
        }
    }

    protected function initByDataEntity(EntityObject $dataObject, ?array $fieldsMask = null): Result
    {
        $result = new Result;
 
        $this->setDataEntity($dataObject);
        $entityFields = $dataObject->collectValues();
 
        foreach (static::mirrorDataEntityFields() as $offset => $field)
        {
            if (isset($field['alias']) || !isset($field['field']))
            {
                continue;
            }
 
            if (!empty($fieldsMask) && !in_array($offset, $fieldsMask, true))
            {
                continue;
            }
 
            if (isset($entityFields[$offset]))
            {
                if (
                    isset($field['loadFilter'])
                    && ($loadFilter = $field['loadFilter'])
                    && is_string($loadFilter)
                    && is_callable([$this, $loadFilter])
                )
                {
                    $this->{$field['field']} = $this->$loadFilter($entityFields[$offset]);
                }
                else
                {
                    $this->{$field['field']} = $entityFields[$offset];
                }
            }
        }
 
        if ($result->isSuccess() && $this->getPrimaryId())
        {
            $this->markChanged(false);
        }
 
        return $result;
    }

    protected function initByArray(array $source): Result
    {
        $result = new Result;
        $fieldsToFill = $source;
 
        if ($this->hasPrimary($source))
        {
            [$ormFields, $fieldsToFill] = $this->separateFieldsOrmAndOther($source);
            $result = $this->initByDataEntity(static::getDataClass()::getObjectClass()::wakeUp($ormFields));
            if (!$result->isSuccess())
            {
                return $result;
            }
        }
 
        if (!empty($fieldsToFill))
        {
            $this->fill($fieldsToFill);
        }
 
        if ($result->isSuccess() && $this->getPrimaryId())
        {
            $this->markChanged(false);
        }
 
        return $result;
    }
 
    protected function hasPrimary(array $source): bool
    {
        $fields = static::mirrorDataEntityFields();
 
        foreach ($source as $key => $value)
        {
            if (!isset($fields[$key]))
            {
                continue;
            }
 
            $field = isset($fields[$key]['alias']) ? $fields[$fields[$key]['alias']] : $fields[$key];
 
            if (isset($field['primary']) && $field['primary'])
            {
                return true;
            }
        }
 
        return false;
    }
 
    protected function separateFieldsOrmAndOther(array $source): array
    {
        $fields = static::mirrorDataEntityFields();
        $entity = static::getDataClass()::getEntity();
        $ormFields = [];
        $otherFields = [];
 
        foreach ($source as $key => $value)
        {
            if (!isset($fields[$key]))
            {
                continue;
            }
 
            $fieldName = $fields[$key]['alias'] ?? $key;
 
            if ($entity->hasField($fieldName) && !($entity->getField($fieldName) instanceof Relation))
            {
                if (
                    $value !== null
                    && $entity->getField($fieldName) instanceof \Bitrix\Main\ORM\Fields\DatetimeField
                    && is_string($value)
                )
                {
                    if (is_string($value) && !is_numeric($value))
                    {
                        $value = DateTime::tryParse($value) ?? DateTime::tryParse($value, 'Y-m-d H:i:s') ?? $value;
                    }
                    if (is_numeric($value))
                    {
                        $value = DateTime::createFromTimestamp((int)$value);
                    }
                }
                $ormFields[$fieldName] = $value;
            }
            else
            {
                $otherFields[$key] = $value;
            }
        }
 
        return [$ormFields, $otherFields];
    }
 
    public function prepareFields(): Result
    {
        $result = new Result;
 
        foreach (static::mirrorDataEntityFields() as $offset => $field)
        {
            if (isset($field['primary']) || isset($field['alias']) || (isset($field['skipSave']) && $field['skipSave'] === true))
            {
                continue;
            }
 
            if (
                isset($field['beforeSave'])
                && ($beforeSave = $field['beforeSave'])
                && is_string($beforeSave)
                && is_callable([$this, $beforeSave])
            )
            {
                $check = $this->$beforeSave();
                if (!$check->isSuccess())
                {
                    $result->addErrors($check->getErrors());
                    continue;
                }
            }
 
            if (
                isset($field['field'])
                && (isset($this->{$field['field']}) || $field['nullable'] === true)
            )
            {
                if (
                    isset($field['saveFilter'])
                    && ($saveFilter = $field['saveFilter'])
                    && is_string($saveFilter)
                    && is_callable([$this, $saveFilter])
                )
                {
                    $this->getDataEntity()->set($offset, $this->$saveFilter($this->{$field['field']}));
                }
                else
                {
                    $this->getDataEntity()->set($offset, $this->{$field['field']});
                }
 
                $this->markChanged($this->isChanged || $this->getDataEntity()->isChanged($offset));
            }
        }
 
        return $result;
    }

    public function save(): Result
    {
        $result = $this->prepareFields();
        if (!$result->isSuccess())
        {
            return $result;
        }
        if (!$this->isChanged())
        {
            return $result->setResult(['IS_CHANGES' => false]);
        }
        if ($result->getData()['SKIP_SAVE'] ?? false)
        {
            return $result;
        }
 
        $saveResult = $this->getDataEntity()->save();
        if ($saveResult->isSuccess())
        {
            $this->updateState();
 
            $this->setPrimaryId((int)$saveResult->getId());
 
            if (
                $this instanceof RegistryEntry
                && $this->getRegistry()
            )
            {
                $this->getRegistry()[$this->getPrimaryId()] = $this;
            }
 
            $this->markChanged(false);
        }
        else
        {
            $result->addErrors($saveResult->getErrors());
        }
 
        return $result;
    }
 
    protected function updateState(?array $fieldsToFill = null): Result
    {
        return $this->initByDataEntity($this->getDataEntity(), $fieldsToFill);
    }

    public function delete(): Result
    {
        $this->markDrop();
        $result = new Result;
        if ($this->getDataEntity()->hasId())
        {
            $deleteResult = $this->getDataEntity()->delete();
            if (!$deleteResult->isSuccess())
            {
                return $result->addErrors($deleteResult->getErrors());
            }
        }
 
        if (
            $this instanceof RegistryEntry
            && $this->getRegistry()
        )
        {
            unset($this->getRegistry()[$this->getPrimaryId()]);
        }
 
        return $result;
    }

    public function markChanged(?bool $state = null): self
    {
        if ($state === null)
        {
            $this->isChanged = true;
        }
        else
        {
            $this->isChanged = $state;
        }
        if ($this->isChanged)
        {
            $this->markedDrop = false;
        }
        return $this;
    }

    public function isChanged(): bool
    {
        return $this->isChanged;
    }

    public function markDrop(): self
    {
        $this->isChanged = false;
        $this->markedDrop = true;
        return $this;
    }

    public function isDeleted(): bool
    {
        return $this->markedDrop;
    }
 
    public function fillActual(array $fieldsToFill): self
    {
        foreach ($fieldsToFill as $fieldName)
        {
            if ($this->getDataEntity()->entity->hasField($fieldName))
            {
                $this->getDataEntity()->unset($fieldName);
            }
        }
        $this->getDataEntity()->fill($fieldsToFill);
 
        $this->updateState($fieldsToFill);
 
        return $this;
    }

    public function fill(array $source): self
    {
        $fields = static::mirrorDataEntityFields();
 
        foreach ($fields as $offset => $field)
        {
            if (isset($source[$offset]))
            {
                if (isset($field['primary']))
                {
                    continue;
                }
                if (isset($field['alias']))
                {
                    $field = $fields[$field['alias']];
                }
                if (
                    isset($field['set'])
                    && ($setter = $field['set'])
                    && is_string($setter)
                    && is_callable([$this, $setter])
                )
                {
                    $this->$setter($source[$offset]);
                }
                elseif (isset($field['field']))
                {
                    $this->{$field['field']} = $source[$offset];
                }
            }
        }
 
        return $this;
    }
 
    public function onAfterOrmUpdate(array $fields): self
    {
        $this->resetDataEntity($fields);
        $this->updateState(array_keys($fields));
 
        return $this;
    }

    public function toArray(bool $recursive = false): array
    {
        $result = [];
        $fields = static::mirrorDataEntityFields();
 
        foreach ($fields as $offset => $field)
        {
            if (isset($field['alias']))
            {
                continue;
            }
            if (
                isset($field['get'])
                && ($getter = $field['get'])
                && is_string($getter)
                && is_callable([$this, $getter])
            )
            {
                $value = $this->$getter();
            }
            else
            {
                $value = $this->{$field['field']};
            }
 
            if (is_object($value) && !($value instanceof DateTime))
            {
                if ($recursive && method_exists($value, 'toArray'))
                {
                    $value = $value->toArray($recursive);
                }
                else
                {
                    continue;
                }
            }
 
            $result[$offset] = $value;
        }
 
        return $result;
    }
}