Boolean Class Reference

Inheritance diagram for Boolean:

Public Member Functions
	__construct (Nullable $nullable, ResourceConnection $resourceConnection, Comment $comment)
	toDefinition (ElementInterface $column)
	fromDefinition (array $data)

Data Fields
const	TYPE = 'BOOLEAN'
const	INTEGER_TYPE = 'tinyint'
const	INTEGER_PADDING = '1'

Detailed Description

As all MySQL aliases as BOOL or BOOLEAN are converted to TINYINT(1) proposed to processed tinyint as boolean.

Definition at line 19 of file Boolean.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Nullable	$nullable,
		ResourceConnection	$resourceConnection,
		Comment	$comment
	)

Constructor.

Parameters

Nullable	$nullable
ResourceConnection	$resourceConnection
Comment	$comment

Definition at line 58 of file Boolean.php.

      {
        $this->nullable = $nullable;
        $this->resourceConnection = $resourceConnection;
        $this->comment = $comment;
    }

Member Function Documentation

fromDefinition()

fromDefinition

(

array

$data

)

Boolean is presented as tinyint(1).

Input always will be array of SQL definitions, like: 'type' => 'name VARCHAR(255)'\ 'nullable' => 'no'

Parameters

array

$data

Returns

array

Implements DbDefinitionProcessorInterface.

Definition at line 90 of file Boolean.php.

    {
        if ($data['type'] === self::INTEGER_TYPE && $data['padding'] === self::INTEGER_PADDING) {
            $data['type'] = strtolower(self::TYPE);
            if (isset($data['default'])) {
                $data['default'] = $data['default'] === null ? null : (bool) $data['default'];
            }
            $data['unsigned'] = false; //Not signed for boolean
            unset($data['padding']);
        }

        return $data;
    }

toDefinition()

toDefinition

(

ElementInterface

$column

)

Parameters

\Magento\Framework\Setup\Declaration\Schema\Dto\Columns\Boolean

$column

Output always will be SQL definition.

Implements DbDefinitionProcessorInterface.

Definition at line 72 of file Boolean.php.

    {
        return sprintf(
            '%s %s %s %s %s',
            $this->resourceConnection->getConnection()->quoteIdentifier($column->getName()),
            self::TYPE,
            $this->nullable->toDefinition($column),
            $column->getDefault() !== null ?
                sprintf('DEFAULT %s', $column->getDefault() ? 1 : 0) : '',
            $this->comment->toDefinition($column)
        );
    }

Field Documentation

INTEGER_PADDING

const INTEGER_PADDING = '1'

Padding for integer described below.

Definition at line 34 of file Boolean.php.

INTEGER_TYPE

const INTEGER_TYPE = 'tinyint'

Type of integer that is used in MySQL for boolean.

Definition at line 29 of file Boolean.php.

TYPE

const TYPE = 'BOOLEAN'

Type the column is persisted with.

Definition at line 24 of file Boolean.php.

---

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

• vendor/magento/framework/Setup/Declaration/Schema/Db/MySQL/Definition/Columns/Boolean.php