objectfield.php

<?php
namespace Bitrix\Main\ORM\Fields;
 
class ObjectField extends ScalarField
{
    protected $objectClasses = [];
 
    protected $encodeFunction;
 
    protected $decodeFunction;
 
    public function __construct($name, $parameters = [])
    {
        $this->addSaveDataModifier([$this, 'encode']);
        $this->addFetchDataModifier([$this, 'decode']);
 
        parent::__construct($name, $parameters);
    }
 
    public function getObjectClasses()
    {
        return $this->objectClasses;
    }
 
    public function configureObjectClass($objectClass)
    {
        $classes = is_array($objectClass) ? $objectClass : [$objectClass];
 
        foreach ($classes as $class)
        {
            if (substr($class, 0, 1) !== '\\')
            {
                $class = '\\'.$class;
            }
 
            $this->objectClasses[] = $class;
        }
 
        return $this;
    }
 
    public function configureSerializeCallback($callback)
    {
        $this->encodeFunction = $callback;
 
        return $this;
    }
 
    public function configureUnserializeCallback($callback)
    {
        $this->decodeFunction = $callback;
 
        return $this;
    }
 
    public function encode($value)
    {
        $callback = $this->encodeFunction;
        return $callback($value);
    }
 
    public function decode($value)
    {
        $callback = $this->decodeFunction;
        return $callback($value);
    }
 
    public function cast($value)
    {
        // try to check type
        if (!empty($this->objectClasses))
        {
            $foundClass = false;
 
            foreach ($this->objectClasses as $objectType)
            {
                if ($value instanceof $objectType)
                {
                    $foundClass = true;
                    break;
                }
            }
 
            if (!$foundClass)
            {
                trigger_error(sprintf(
                        'Invalid value type `%s` for `%s` field',
                        gettype($value) === 'object' ? get_class($value) : gettype($value),
                        $this->entity->getFullName().':'.$this->name
                    ), E_USER_WARNING
                );
            }
        }
 
        return $value;
    }
 
    public function convertValueFromDb($value)
    {
        return $this->getConnection()->getSqlHelper()->convertFromDbString($value);
    }
 
    public function convertValueToDb($value)
    {
        return $value === null && $this->is_nullable
            ? $value
            : $this->getConnection()->getSqlHelper()->convertToDbString($value);
    }
 
    public function getGetterTypeHint()
    {
        $type = 'mixed';
 
        if (!empty($this->objectClasses))
        {
            $types =  $this->objectClasses;
 
            if ($this->is_nullable)
            {
                $types[] = 'null';
            }
 
            $type =  join('|', $types);
        }
 
        return $type;
    }
 
    public function getSetterTypeHint()
    {
        $type = 'mixed';
 
        if (!empty($this->objectClasses))
        {
            $types =  $this->objectClasses;
 
            if ($this->is_nullable)
            {
                $types[] = 'null';
            }
 
            $type =  join('|', $types);
        }
 
        return $type;
    }
}