arrayfield.php

<?php
namespace Bitrix\Main\ORM\Fields;
 
use Bitrix\Main\DB\SqlExpression;
use Bitrix\Main\Web\Json;
 
class ArrayField extends ScalarField
{
    protected $serializationType;
 
    protected $encodeFunction;
 
    protected $decodeFunction;
 
    public function __construct($name, $parameters = [])
    {
        $this->configureSerializationJson();
 
        $this->addSaveDataModifier([$this, 'encode']);
        $this->addFetchDataModifier([$this, 'decode']);
 
        parent::__construct($name, $parameters);
    }
 
    public function configureSerializationJson()
    {
        $this->serializationType = 'json';
        $this->encodeFunction = [$this, 'encodeJson'];
        $this->decodeFunction = [$this, 'decodeJson'];
 
        return $this;
    }
 
    public function configureSerializationPhp()
    {
        $this->serializationType = 'php';
        $this->encodeFunction = [$this, 'encodePhp'];
        $this->decodeFunction = [$this, 'decodePhp'];
 
        return $this;
    }
 
    public function configureSerializeCallback($callback)
    {
        $this->encodeFunction = $callback;
        $this->serializationType = 'custom';
 
        return $this;
    }
 
    public function configureUnserializeCallback($callback)
    {
        $this->decodeFunction = $callback;
        $this->serializationType = 'custom';
 
        return $this;
    }
 
    public function encode($value)
    {
        $callback = $this->encodeFunction;
        return $callback($value);
    }
 
    public function decode($value)
    {
        if($value <> '')
        {
            $callback = $this->decodeFunction;
            return $callback($value);
        }
 
        return [];
    }
 
    public function encodeJson($value)
    {
        return Json::encode($value);
    }
 
    public function decodeJson($value)
    {
        return Json::decode($value);
    }
 
    public function encodePhp($value)
    {
        return serialize($value);
    }
 
    public function decodePhp($value)
    {
        return unserialize($value);
    }
 
    public function cast($value)
    {
        if ($this->is_nullable && $value === null)
        {
            return $value;
        }
 
        if ($value instanceof SqlExpression)
        {
            return $value;
        }
 
        return (array) $value;
    }
 
    public function convertValueFromDb($value)
    {
        return $this->getConnection()->getSqlHelper()->convertFromDbString($value);
    }
 
    public function convertValueToDb($value)
    {
        if ($value instanceof SqlExpression)
        {
            return $value;
        }
 
        return $value === null && $this->is_nullable
            ? $value
            : $this->getConnection()->getSqlHelper()->convertToDbString($value);
    }
 
    public function getGetterTypeHint()
    {
        return $this->getNullableTypeHint('array');
    }
 
    public function getSetterTypeHint()
    {
        return $this->getNullableTypeHint('array');
    }
}