Класс BooleanField

Граф наследования:BooleanField:

Открытые члены
	__construct ($name, $parameters=array())
	BooleanField constructor. Подробнее...
	configureStorageValues ($falseValue, $trueValue)
	configureValues ($falseValue, $trueValue)
	Short alias for configureStorageValues. Подробнее...
	normalizeValue ($value)
	Convert true/false values to actual field values. Подробнее...
	booleanizeValue ($value)
	Converts any possible value to strict boolean. Подробнее...
	getValidators ()
	getValues ()
	isValueEmpty ($value)
	cast ($value)
	convertValueFromDb ($value)
	convertValueToDb ($value)
	getGetterTypeHint ()
	getSetterTypeHint ()
Открытые члены унаследованные от ScalarField
	getTypeMask ()
	configurePrimary ($value=true)
	isPrimary ()
	configureRequired ($value=true)
	isRequired ()
	configureUnique ($value=true)
	isUnique ()
	configureAutocomplete ($value=true)
	isAutocomplete ()
	configurePrivate ($value=true)
	isPrivate ()
	configureColumnName ($value)
	getColumnName ()
	setColumnName ($column_name)
	configureDefaultValue ($value)
	getDefaultValue ($row=null)
Открытые члены унаследованные от Field
	setEntity (Entity $entity)
	resetEntity ()
	validateValue ($value, $primary, $row, Result $result)
	modifyValueBeforeSave ($value, $data)
	addValidator ($validator)
	getFetchDataModifiers ()
	addFetchDataModifier ($modifier)
	getSaveDataModifiers ()
	addSaveDataModifier ($modifier)
	isSerialized ()
	setSerialized ()
	configureSerialized ()
	getName ()
	setName ($name)
	configureTitle ($title)
	Lang phrase. Подробнее...
	getTitle ()
	setParameter ($name, $value)
	getParameter ($name)
	hasParameter ($name)
	setParentField (Field $parentField)
	getParentField ()
	getDataType ()
	getEntity ()
	getLangCode ()
	getConnection ()
	serialize ($value)
	unserialize ($value)
	postInitialize ()
	Called after being initialized by Entity. Подробнее...

Защищенные данные
	$values
Защищенные данные унаследованные от ScalarField
	$is_primary
	$is_unique
	$is_required
	$is_autocomplete
	$is_private
	$column_name = ''
	$default_value
Защищенные данные унаследованные от Field
	$name
	$dataType
	$initialParameters
	$title
	$validation = null
	$validators = null
	$additionalValidators = array()
	$fetchDataModification = null
	$fetchDataModifiers
	$additionalFetchDataModifiers = array()
	$saveDataModification = null
	$saveDataModifiers
	$additionalSaveDataModifiers = array()
	$isSerialized = false
	$parentField
	$entity

Дополнительные унаследованные члены
Открытые статические члены унаследованные от Field
static	getOldDataTypeByClass ($class)
static	getOldDataTypeByField (Field $field)
static	getClassByOldDataType ($dateType)
Защищенные члены унаследованные от Field
	appendValidator ($validator)
	appendFetchDataModifier ($modifier)
	appendSaveDataModifier ($modifier)
Статические защищенные данные унаследованные от Field
static	$oldDataTypes

Подробное описание

См. определение в файле booleanfield.php строка 16

Конструктор(ы)

__construct()

__construct	(		$name,
			$parameters = array()
	)

BooleanField constructor.

Аргументы

	$name
array	$parameters	deprecated, use configure* and add* methods instead

Исключения

Переопределяет метод предка ScalarField.

См. определение в файле booleanfield.php строка 32

    {
        parent::__construct($name, $parameters);
 
        if (empty($parameters['values']))
        {
            $this->values = array(false, true);
        }
        else
        {
            $this->values = $parameters['values'];
        }
 
        $this->addSaveDataModifier(array($this, 'normalizeValue'));
    }

Методы

booleanizeValue()

booleanizeValue

(

$value

)

Converts any possible value to strict boolean.

Аргументы

$value

Возвращает

bool

См. определение в файле booleanfield.php строка 112

    {
        if (is_bool($value))
        {
            return $value;
        }
 
        $normalizedValue = $this->normalizeValue($value);
        return (bool) array_search($normalizedValue, $this->values, true);
    }

cast()

cast

(

$value

)

Аргументы

mixed

$value

Возвращает

mixed

Замещает IReadable.

См. определение в файле booleanfield.php строка 155

    {
        return $this->booleanizeValue($value);
    }

configureStorageValues()

configureStorageValues	(		$falseValue,
			$trueValue
	)

Аргументы

$falseValue
$trueValue

Возвращает

$this

См. определение в файле booleanfield.php строка 54

    {
        $this->values = [$falseValue, $trueValue];
        return $this;
    }

configureValues()

configureValues	(		$falseValue,
			$trueValue
	)

Short alias for configureStorageValues.

Аргументы

$falseValue
$trueValue

Возвращает

BooleanField

См. определение в файле booleanfield.php строка 68

    {
        return $this->configureStorageValues($falseValue, $trueValue);
    }

convertValueFromDb()

convertValueFromDb

(

$value

)

Аргументы

$value

Возвращает

mixed

Замещает IReadable.

См. определение в файле booleanfield.php строка 165

    {
        return $this->booleanizeValue($value);
    }

convertValueToDb()

convertValueToDb

(

$value

)

Аргументы

mixed

$value

Возвращает

string

Исключения

Замещает IReadable.

См. определение в файле booleanfield.php строка 176

    {
        return $this->getConnection()->getSqlHelper()->convertToDbString(
            $this->normalizeValue($value)
        );
    }

getGetterTypeHint()

getGetterTypeHint

(

)

Возвращает

string

Переопределяет метод предка ScalarField.

См. определение в файле booleanfield.php строка 186

    {
        return '\\boolean';
    }

getSetterTypeHint()

getSetterTypeHint

(

)

Возвращает

string

Переопределяет метод предка ScalarField.

См. определение в файле booleanfield.php строка 194

    {
        return '\\boolean';
    }

getValidators()

getValidators

(

)

Возвращает

array|\Bitrix\Main\ORM\Fields\Validators\Validator[]|callback[]

Исключения

Переопределяет метод предка Field.

См. определение в файле booleanfield.php строка 128

    {
        $validators = parent::getValidators();
 
        if ($this->validation === null)
        {
            $validators[] = new Validators\BooleanValidator;
        }
 
        return $validators;
    }

getValues()

getValues

(

)

См. определение в файле booleanfield.php строка 140

    {
        return $this->values;
    }

isValueEmpty()

isValueEmpty

(

$value

)

Переопределяет метод предка ScalarField.

См. определение в файле booleanfield.php строка 145

    {
        return (strval($value) === '' && $value !== false);
    }

normalizeValue()

normalizeValue

(

$value

)

Convert true/false values to actual field values.

Аргументы

boolean | integer | string

$value

Возвращает

mixed

См. определение в файле booleanfield.php строка 78

    {
        if (
            (is_string($value) && ($value == '1' || $value == '0'))
            ||
            (is_bool($value))
        )
        {
            $value = (int) $value;
        }
        elseif (is_string($value) && $value == 'true')
        {
            $value = 1;
        }
        elseif (is_string($value) && $value == 'false')
        {
            $value = 0;
        }
 
        if (is_integer($value) && ($value == 1 || $value == 0))
        {
            $value = $this->values[$value];
        }
 
        return $value;
    }

Поля

$values

$values

protected

См. определение в файле booleanfield.php строка 22

---

Объявления и описания членов класса находятся в файле:

• booleanfield.php