scalarfield.php

<?php
namespace Bitrix\Main\ORM\Fields;
use Bitrix\Main\DB\SqlExpression;
use Bitrix\Main\ORM\Fields\FieldTypeMask;
 
abstract class ScalarField extends Field implements IStorable, ITypeHintable
{
    protected $is_primary;
 
    protected $is_unique;
 
    protected $is_required;
 
    protected $is_autocomplete;
 
    protected $is_private;
 
    protected $is_nullable;
 
    protected $column_name = '';
 
    protected $default_value;
 
    public function __construct($name, $parameters = array())
    {
        parent::__construct($name, $parameters);
 
        $this->is_primary = (isset($parameters['primary']) && $parameters['primary']);
        $this->is_unique = (isset($parameters['unique']) && $parameters['unique']);
        $this->is_required = (isset($parameters['required']) && $parameters['required']);
        $this->is_autocomplete = (isset($parameters['autocomplete']) && $parameters['autocomplete']);
        $this->is_private = (isset($parameters['private']) && $parameters['private']);
        $this->is_nullable = (isset($parameters['nullable']) && $parameters['nullable']);
 
        $this->column_name = $parameters['column_name'] ?? $this->name;
        $this->default_value = $parameters['default_value'] ?? null;
    }
 
    public function getTypeMask()
    {
        return FieldTypeMask::SCALAR;
    }
 
    public function configurePrimary($value = true)
    {
        $this->is_primary = (bool) $value;
        return $this;
    }
 
    public function isPrimary()
    {
        return $this->is_primary;
    }
 
    public function configureRequired($value = true)
    {
        $this->is_required = (bool) $value;
        return $this;
    }
 
    public function isRequired()
    {
        return $this->is_required;
    }
 
    public function configureUnique($value = true)
    {
        $this->is_unique = (bool) $value;
        return $this;
    }
 
    public function isUnique()
    {
        return $this->is_unique;
    }
 
    public function configureAutocomplete($value = true)
    {
        $this->is_autocomplete = (bool) $value;
        return $this;
    }
 
    public function isAutocomplete()
    {
        return $this->is_autocomplete;
    }
 
 
    public function configurePrivate($value = true)
    {
        $this->is_private = (bool) $value;
        return $this;
    }
 
    public function isPrivate()
    {
        return $this->is_private;
    }
 
    public function configureNullable($value = true)
    {
        $this->is_nullable = (bool) $value;
        return $this;
    }
 
    public function isNullable()
    {
        return $this->is_nullable;
    }
 
    public function configureColumnName($value)
    {
        $this->column_name = $value;
        return $this;
    }
 
    public function getColumnName()
    {
        return $this->column_name;
    }
 
    public function setColumnName($column_name)
    {
        $this->column_name = $column_name;
    }
 
    public function configureDefaultValue($value)
    {
        $this->default_value = $value;
        return $this;
    }
 
    public function getDefaultValue($row = null)
    {
        if (!is_string($this->default_value) && is_callable($this->default_value))
        {
            return call_user_func($this->default_value, $row);
        }
        else
        {
            return $this->default_value;
        }
    }
 
    public function isValueEmpty($value)
    {
        if ($value instanceof SqlExpression)
        {
            $value = $value->compile();
        }
 
        return ((string)$value === '');
    }
 
    public function getGetterTypeHint()
    {
        return $this->getNullableTypeHint('\\string');
    }
 
    public function getSetterTypeHint()
    {
        return $this->getNullableTypeHint('\\string');
    }
 
    protected function getNullableTypeHint(string $type): string
    {
        return $this->is_nullable ? '?' . $type : $type;
    }
}