Integer Class Reference

Inheritance diagram for Integer:

Public Member Functions
	__construct (string $name, string $type, Table $table, int $padding, bool $nullable=true, bool $unsigned=false, bool $identity=false, int $default=null, string $comment=null, string $onCreate=null)
	getPadding ()
	isNullable ()
	getDefault ()
	isUnsigned ()
	isIdentity ()
	getDiffSensitiveParams ()
Public Member Functions inherited from Column
	__construct (string $name, string $type, Table $table, string $comment=null, string $onCreate=null)
	getTable ()
	getElementType ()
	getOnCreate ()
	getComment ()
Public Member Functions inherited from GenericElement
	__construct (string $name, string $type)
	getName ()
	getType ()

Additional Inherited Members
Data Fields inherited from Column
const	TYPE = 'column'

Detailed Description

Integer column. Declared in SQL, like INT(11) or BIGINT(20). Where digit is padding, how many zeros should be added before first non-zero digit.

Definition at line 17 of file Integer.php.

Constructor & Destructor Documentation

__construct()

__construct	(	string	$name,
		string	$type,
		Table	$table,
		int	$padding,
		bool	$nullable = true,
		bool	$unsigned = false,
		bool	$identity = false,
		int	$default = null,
		string	$comment = null,
		string	$onCreate = null
	)

Constructor.

Parameters

string	$name
string	$type
Table	$table
int	$padding
bool	$nullable
bool	$unsigned
bool	$identity
float | int	$default
string | null	$comment
string | null	$onCreate	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 63 of file Integer.php.

      {
        parent::__construct($name, $type, $table, $comment, $onCreate);
        $this->nullable = $nullable;
        $this->default = $default;
        $this->unsigned = $unsigned;
        $this->padding = $padding;
        $this->identity = $identity;
    }

Member Function Documentation

getDefault()

getDefault

(

)

Return default value. Note: default value should be int.

Returns

int | null

Implements ColumnDefaultAwareInterface.

Definition at line 109 of file Integer.php.

    {
        return $this->default;
    }

getDiffSensitiveParams()

getDiffSensitiveParams

(

)

Return sensitive params, with respect of which we will compare db and xml For instance, padding => '2' identity => nullSuch params as name, renamedTo, disabled, tableName should be avoided here. As this params are system and must not participate in comparison at all.

Returns

array

Implements ElementDiffAwareInterface.

Definition at line 137 of file Integer.php.

    {
        return [
            'type' => $this->getType(),
            'nullable' => $this->isNullable(),
            'padding' => $this->getPadding(),
            'unsigned' => $this->isUnsigned(),
            'identity' => $this->isIdentity(),
            'default' => $this->getDefault(),
            'comment' => $this->getComment()
        ];
    }

getPadding()

getPadding

(

)

Column padding.

Returns

int

Definition at line 88 of file Integer.php.

    {
        return $this->padding;
    }

isIdentity()

isIdentity

(

)

Define whether column can be autoincrement or not.

Returns

bool

Implements ColumnIdentityAwareInterface.

Definition at line 129 of file Integer.php.

    {
        return $this->identity;
    }

isNullable()

isNullable

(

)

Check whether column can be nullable.

Returns

bool

Implements ColumnNullableAwareInterface.

Definition at line 98 of file Integer.php.

    {
        return $this->nullable;
    }

isUnsigned()

isUnsigned

(

)

Check whether element is unsigned or not.

Returns

bool

Implements ColumnUnsignedAwareInterface.

Definition at line 119 of file Integer.php.

    {
        return $this->unsigned;
    }

---

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

• vendor/magento/framework/Setup/Declaration/Schema/Dto/Columns/Integer.php