Relation.php

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

<?php
 
namespace Bitrix\Im\V2;
 
use ArrayAccess;
use Bitrix\Im\Model\RelationTable;
use Bitrix\Im\V2\Common\ActiveRecordImplementation;
use Bitrix\Im\V2\Common\ContextCustomer;
use Bitrix\Im\V2\Common\FieldAccessImplementation;
use Bitrix\Im\V2\Common\RegistryEntryImplementation;
use Bitrix\Im\V2\Entity\User\User;
use Bitrix\Im\V2\Relation\Reason;
use Bitrix\Im\V2\Rest\RestEntity;
use Bitrix\Main\Type\DateTime;
 
class Relation implements ArrayAccess, RegistryEntry, ActiveRecord, RestEntity
{
    use FieldAccessImplementation;
    use ActiveRecordImplementation
    {
        prepareFields as protected prepareFieldsDefault;
    }
    use RegistryEntryImplementation;
    use ContextCustomer;
 
    protected ?int $id = null;
    protected ?int $chatId = null;
    protected ?string $messageType = null;
    protected ?int $userId = null;
    protected ?int $startId = null;
    protected ?int $unreadId = null;
    protected ?int $lastId = null;
    protected ?int $lastSendId = null;
    protected ?int $lastSendMessageId = null;
    protected ?int $lastFileId = null;
    protected ?DateTime $lastRead = null;
    protected ?int $status = null;
    protected ?int $callStatus = null;
    protected ?string $messageStatus = null;
    protected ?bool $notifyBlock = null;
    protected ?bool $manager = null;
    protected ?int $counter = null;
    protected ?int $startCounter = null;
    protected ?User $user = null;
    protected Reason $reason = Reason::DEFAULT;
    protected ?bool $isHidden = null;
    protected bool $isFake = false;
 
    public function __construct($source = null)
    {
        $this->initByDefault();
 
        if (!empty($source))
        {
            $this->load($source);
        }
    }
 
    public function getPrimaryId(): ?int
    {
        return $this->getId();
    }
 
    public function setPrimaryId(int $primaryId): self
    {
        return $this->setId($primaryId);
    }
 
    public static function getDataClass(): string
    {
        return RelationTable::class;
    }
 
    public function getUser(): User
    {
        if (isset($this->user))
        {
            return $this->user;
        }
 
        $this->user = User::getInstance($this->getUserId());
 
        return $this->user;
    }
 
    public function getChat(): Chat
    {
        return Chat::getInstance($this->getChatId());
    }
 
    public function fillRestriction(bool $hideHistory, Chat $chat): self
    {
        if ($hideHistory)
        {
            $this
                ->setStartId($chat->getLastMessageId() + 1)
                ->setLastFileId($chat->getLastFileId())
                ->setStartCounter($chat->getMessageCount())
            ;
        }
 
        if (!$hideHistory && $chat->getContext()->getUserId() > 0)
        {
            $selfRelation = $chat->getSelfRelation();
            if ($selfRelation !== null && $selfRelation->getStartId() > 0)
            {
                $this
                    ->setStartCounter($selfRelation->getStartId())
                    ->setLastFileId($selfRelation->getLastFileId())
                    ->setStartCounter($selfRelation->getStartCounter())
                ;
            }
        }
 
        return $this;
    }
 
    public function prepareFields(): Result
    {
        if ($this->isFake)
        {
            return (new Result())->setData(['SKIP_SAVE' => true]);
        }
 
        return $this->prepareFieldsDefault();
    }
 
    public function toRestFormat(array $option = []): ?array
    {
        return [
            'id' => $this->getId(),
            'userId' => $this->getUserId(),
            'chatId' => $this->getChatId(),
            'isHidden' => $this->isHidden(),
            'role' => mb_strtolower($this->getRole()),
        ];
    }
 
    public static function getRestEntityName(): string
    {
        return 'relation';
    }

    protected static function mirrorDataEntityFields(): array
    {
        return [
            'ID' => [
                'primary' => true,
                'field' => 'id',
                'set' => 'setId', 
                'get' => 'getId', 
            ],
            'CHAT_ID' => [
                'field' => 'chatId',
                'set' => 'setChatId', 
                'get' => 'getChatId', 
            ],
            'MESSAGE_TYPE' => [
                'field' => 'messageType',
                'set' => 'setMessageType', 
                'get' => 'getMessageType', 
            ],
            'USER_ID' => [
                'field' => 'userId',
                'set' => 'setUserId', 
                'get' => 'getUserId', 
            ],
            'START_ID' => [
                'field' => 'startId',
                'set' => 'setStartId', 
                'get' => 'getStartId', 
            ],
            'UNREAD_ID' => [
                'field' => 'unreadId',
                'set' => 'setUnreadId', 
                'get' => 'getUnreadId', 
            ],
            'LAST_ID' => [
                'field' => 'lastId',
                'set' => 'setLastId', 
                'get' => 'getLastId', 
            ],
            'LAST_SEND_ID' => [
                'field' => 'lastSendId',
                'set' => 'setLastSendId', 
                'get' => 'getLastSendId', 
            ],
            'LAST_SEND_MESSAGE_ID' => [
                'field' => 'lastSendMessageId',
                'set' => 'setLastSendMessageId', 
                'get' => 'getLastSendMessageId', 
            ],
            'LAST_FILE_ID' => [
                'field' => 'lastFileId',
                'set' => 'setLastFileId', 
                'get' => 'getLastFileId', 
            ],
            'LAST_READ' => [
                'field' => 'lastRead',
                'set' => 'setLastReadInternal', 
                'get' => 'getLastRead', 
            ],
            'STATUS' => [
                'field' => 'status',
                'set' => 'setStatus', 
                'get' => 'getStatus', 
            ],
            'CALL_STATUS' => [
                'field' => 'callStatus',
                'set' => 'setCallStatus', 
                'get' => 'getCallStatus', 
            ],
            'MESSAGE_STATUS' => [
                'field' => 'messageStatus',
                'set' => 'setMessageStatus', 
                'get' => 'getMessageStatus', 
            ],
            'NOTIFY_BLOCK' => [
                'field' => 'notifyBlock',
                'set' => 'setNotifyBlock', 
                'get' => 'getNotifyBlock', 
            ],
            'MANAGER' => [
                'field' => 'manager',
                'set' => 'setManager', 
                'get' => 'getManager', 
            ],
            'COUNTER' => [
                'field' => 'counter',
                'set' => 'setCounter', 
                'get' => 'getCounter', 
            ],
            'START_COUNTER' => [
                'field' => 'startCounter',
                'set' => 'setStartCounter', 
                'get' => 'getStartCounter', 
            ],
            'REASON' => [
                'field' => 'reason',
                'set' => 'setReason', 
                'get' => 'getReason', 
                'loadFilter' => 'prepareReasonForLoad', 
                'saveFilter' => 'prepareReasonForSave', 
            ],
            'IS_HIDDEN' => [
                'field' => 'isHidden',
                'set' => 'markAsHidden', 
                'get' => 'isHidden', 
            ],
        ];
    }
 
    //region Getters & setters
 
    public function getId(): ?int
    {
        return $this->id;
    }
 
    public function setId(?int $id): Relation
    {
        $this->id = $id;
        return $this;
    }
 
    public function getChatId(): ?int
    {
        return $this->chatId;
    }
 
    public function setChatId(?int $chatId): Relation
    {
        $this->chatId = $chatId;
        return $this;
    }
 
    public function getMessageType(): ?string
    {
        return $this->messageType;
    }
 
    public function setMessageType(?string $messageType): Relation
    {
        $this->messageType = $messageType;
        return $this;
    }
 
    public function getUserId(): ?int
    {
        return $this->userId;
    }
 
    public function setUserId(?int $userId): Relation
    {
        $this->userId = $userId;
        return $this;
    }
 
    public function getStartId(): ?int
    {
        return $this->startId;
    }
 
    public function setStartId(?int $startId): Relation
    {
        $this->startId = $startId;
        return $this;
    }
 
    public function getUnreadId(): ?int
    {
        return $this->unreadId;
    }
 
    public function setUnreadId(?int $unreadId): Relation
    {
        $this->unreadId = $unreadId;
        return $this;
    }
 
    public function getLastId(): ?int
    {
        return $this->lastId;
    }
 
    public function setLastId(?int $lastId): Relation
    {
        $this->lastId = $lastId;
        return $this;
    }
 
    public function getLastSendId(): ?int
    {
        return $this->lastSendId;
    }
 
    public function setLastSendId(?int $lastSendId): Relation
    {
        $this->lastSendId = $lastSendId;
        return $this;
    }
 
    public function getLastSendMessageId(): ?int
    {
        return $this->lastSendMessageId;
    }
 
    public function setLastSendMessageId(?int $lastSendMessageId): Relation
    {
        $this->lastSendMessageId = $lastSendMessageId;
        return $this;
    }
 
    public function getLastFileId(): ?int
    {
        return $this->lastFileId;
    }
 
    public function setLastFileId(?int $lastFileId): Relation
    {
        $this->lastFileId = $lastFileId;
        return $this;
    }
 
    public function getLastRead(): ?DateTime
    {
        return $this->lastRead;
    }
 
    public function setLastRead(?DateTime $lastRead): Relation
    {
        $this->lastRead = $lastRead;
        return $this;
    }
 
    private function setLastReadInternal($lastRead): Relation
    {
        $lastReadDateTime = null;
 
        if ($lastRead instanceof DateTime)
        {
            $lastReadDateTime = $lastRead;
        }
        elseif (!empty($lastRead))
        {
            $lastReadDateTime = DateTime::tryParse($lastRead) ?? DateTime::tryParse($lastRead, 'Y-m-d H:i:s');
        }
 
        return $this->setLastRead($lastReadDateTime);
    }
 
    public function getStatus(): ?int
    {
        return $this->status;
    }
 
    public function setStatus(?int $status): Relation
    {
        $this->status = $status;
        return $this;
    }
 
    public function getCallStatus(): ?int
    {
        return $this->callStatus;
    }
 
    public function setCallStatus(?int $callStatus): Relation
    {
        $this->callStatus = $callStatus;
        return $this;
    }
 
    public function getMessageStatus(): ?string
    {
        return $this->messageStatus;
    }
 
    public function setMessageStatus(?string $messageStatus): Relation
    {
        $this->messageStatus = $messageStatus;
        return $this;
    }
 
    public function getNotifyBlock(): ?bool
    {
        return $this->notifyBlock;
    }
 
    public function setNotifyBlock(?bool $notifyBlock): Relation
    {
        $this->notifyBlock = $notifyBlock;
        return $this;
    }
 
    public function getManager(): ?bool
    {
        return $this->manager;
    }
 
    public function setManager(?bool $manager): Relation
    {
        $this->manager = $manager;
        return $this;
    }
 
    public function getCounter(): ?int
    {
        return $this->counter;
    }
 
    public function setCounter(?int $counter): Relation
    {
        $this->counter = $counter;
        return $this;
    }
 
    public function getStartCounter(): ?int
    {
        return $this->startCounter;
    }
 
    public function setStartCounter(?int $startCounter): Relation
    {
        $this->startCounter = $startCounter;
        return $this;
    }
 
    public function getReason(): Reason
    {
        return $this->reason;
    }
 
    public function setReason(Reason $reason): self
    {
        $this->reason = $reason;
 
        return $this;
    }
 
    public function prepareReasonForLoad(string $reason): Reason
    {
        return Reason::tryFrom($reason) ?? Reason::DEFAULT;
    }
 
    public function prepareReasonForSave(Reason $reason): string
    {
        return $reason->value;
    }
 
    public function isHidden(): ?bool
    {
        return $this->isHidden;
    }
 
    public function markAsHidden(?bool $isHidden): Relation
    {
        $this->isHidden = $isHidden;
        return $this;
    }
 
    public function getRole(): string
    {
        if (!$this->getId())
        {
            return Chat::ROLE_GUEST;
        }
        if ($this->getManager())
        {
            return Chat::ROLE_MANAGER;
        }
        if ($this->getChat()->getAuthorId() === $this->getUserId())
        {
            return Chat::ROLE_OWNER;
        }
 
        return Chat::ROLE_MEMBER;
    }
 
    public function markAsFake(): self
    {
        $this->isFake = true;
 
        return $this;
    }
 
    //endregion
}