BooleanUtils Class Reference

Public Member Functions
	__construct (array $trueValues=[true, 1, 'true', '1'], array $falseValues=[false, 0, 'false', '0'])
	toBoolean ($value)
	convert ($value)

Detailed Description

Utility methods for the boolean data type

@api

Since

100.0.2

Definition at line 14 of file BooleanUtils.php.

Constructor & Destructor Documentation

__construct()

__construct	(	array	$trueValues = [true,
		1	,
		'true'	,
		'1']	,
		array	$falseValues = [false,
		0	,
		'false'	,
		'0']
	)

Parameters

array	$trueValues
array	$falseValues	@codingStandardsIgnoreStart

Definition at line 35 of file BooleanUtils.php.

      {
        $this->trueValues = $trueValues;
        $this->falseValues = $falseValues;
    }

Member Function Documentation

convert()

convert

(

$value

)

Try to convert $value to boolean else return non processed $value

Parameters

mixed

$value

Returns

mixed

Since

101.0.0

Definition at line 77 of file BooleanUtils.php.

    {
        if (in_array($value, $this->trueValues, true)) {
            return true;
        } elseif (in_array($value, $this->falseValues, true)) {
            return false;
        } else {
            return $value;
        }
    }

toBoolean()

toBoolean

(

$value

)

Retrieve boolean value for an expression

Parameters

mixed

$value

Boolean expression

Returns

bool

Exceptions

Built-in function filter_var() is not used, because such values as on/off are irrelevant in some contexts http://www.php.net/manual/en/filter.filters.validate.php

Definition at line 52 of file BooleanUtils.php.

    {
        if (in_array($value, $this->trueValues, true)) {
            return true;
        }
        if (in_array($value, $this->falseValues, true)) {
            return false;
        }
        $allowedValues = array_merge($this->trueValues, $this->falseValues);
        throw new \InvalidArgumentException(
            'Boolean value is expected, supported values: ' . var_export($allowedValues, true)
        );
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Stdlib/BooleanUtils.php