donatj/mysql-schema

Object Hierarchy Representing MySQL Schema

Maintainers

Details

github.com/donatj/php-mysqlschema

Source

Issues

Fund package maintenance!
www.paypal.me/donatj/15
Ko Fi
donatj

Installs: 58

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 1

Open Issues: 0

v0.2.0 2024-10-27 13:05 UTC

Requires

  • php: >=5.4.0

Requires (Dev)

MIT 9d8ca92ec8d7203fcc4075fe11e284d0a83e6da6

mysqlschemamodeling

This package is auto-updated.

Last update: 2024-10-30 17:21:33 UTC

README

Latest Stable Version License Scrutinizer Code Quality

Simple PHP MySQL Schema Model

Requirements

  • php: >=5.4.0

Installing

Install the latest version with:

composer require 'donatj/mysql-schema'

Documentation

Class: donatj\MySqlSchema\Columns\AbstractColumn

Method: AbstractColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: AbstractColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: AbstractColumn->getComment

function getComment()
Returns:
  • string

Method: AbstractColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: AbstractColumn->isNullable

function isNullable()
Returns:
  • bool

Method: AbstractColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: AbstractColumn->getName

function getName()
Returns:
  • string

Method: AbstractColumn->setName

function setName($name)
Parameters:
  • string $name

Method: AbstractColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: AbstractColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: AbstractColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: AbstractColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Class: donatj\MySqlSchema\Columns\Interfaces\CharsetColumnInterface

Method: CharsetColumnInterface->getCharset

function getCharset()
Returns:
  • null

Method: CharsetColumnInterface->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: CharsetColumnInterface->getCollation

function getCollation()
Returns:
  • null

Method: CharsetColumnInterface->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Class: donatj\MySqlSchema\Columns\Interfaces\OptionalLengthInterface

Method: OptionalLengthInterface->getLength

function getLength()
Returns:
  • int | null

Method: OptionalLengthInterface->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Class: donatj\MySqlSchema\Columns\Interfaces\RequiredLengthInterface

Method: RequiredLengthInterface->getLength

function getLength()
Returns:
  • int

Method: RequiredLengthInterface->setLength

function setLength($length)
Parameters:
  • int $length

Class: donatj\MySqlSchema\Columns\Interfaces\SignedInterface

Method: SignedInterface->isSigned

function isSigned()
Returns:
  • bool

Method: SignedInterface->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Json\JsonColumn

Method: JsonColumn->getTypeName

function getTypeName() : string
Returns:
  • string

Method: JsonColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: JsonColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: JsonColumn->getComment

function getComment()
Returns:
  • string

Method: JsonColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: JsonColumn->isNullable

function isNullable()
Returns:
  • bool

Method: JsonColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: JsonColumn->getName

function getName()
Returns:
  • string

Method: JsonColumn->setName

function setName($name)
Parameters:
  • string $name

Method: JsonColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: JsonColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: JsonColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Class: donatj\MySqlSchema\Columns\Numeric\AbstractFractionColumn

Method: AbstractFractionColumn->__construct

function __construct($name, $decimals)
Parameters:
  • string $name
  • int $decimals

Method: AbstractFractionColumn->getDecimals

function getDecimals()
Returns:
  • int

Method: AbstractFractionColumn->setDecimals

function setDecimals($decimals)
Parameters:
  • int $decimals

Method: AbstractFractionColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: AbstractFractionColumn->getComment

function getComment()
Returns:
  • string

Method: AbstractFractionColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: AbstractFractionColumn->isNullable

function isNullable()
Returns:
  • bool

Method: AbstractFractionColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: AbstractFractionColumn->getName

function getName()
Returns:
  • string

Method: AbstractFractionColumn->setName

function setName($name)
Parameters:
  • string $name

Method: AbstractFractionColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: AbstractFractionColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: AbstractFractionColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: AbstractFractionColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: AbstractFractionColumn->getLength

function getLength()
Returns:
  • int | null

Method: AbstractFractionColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: AbstractFractionColumn->isSigned

function isSigned()
Returns:
  • bool

Method: AbstractFractionColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Numeric\AbstractIntegerColumn

Method: AbstractIntegerColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: AbstractIntegerColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: AbstractIntegerColumn->getComment

function getComment()
Returns:
  • string

Method: AbstractIntegerColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: AbstractIntegerColumn->isNullable

function isNullable()
Returns:
  • bool

Method: AbstractIntegerColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: AbstractIntegerColumn->getName

function getName()
Returns:
  • string

Method: AbstractIntegerColumn->setName

function setName($name)
Parameters:
  • string $name

Method: AbstractIntegerColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: AbstractIntegerColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: AbstractIntegerColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: AbstractIntegerColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: AbstractIntegerColumn->getLength

function getLength()
Returns:
  • int | null

Method: AbstractIntegerColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: AbstractIntegerColumn->isSigned

function isSigned()
Returns:
  • bool

Method: AbstractIntegerColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Numeric\AbstractNumberColumn

Method: AbstractNumberColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: AbstractNumberColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: AbstractNumberColumn->getComment

function getComment()
Returns:
  • string

Method: AbstractNumberColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: AbstractNumberColumn->isNullable

function isNullable()
Returns:
  • bool

Method: AbstractNumberColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: AbstractNumberColumn->getName

function getName()
Returns:
  • string

Method: AbstractNumberColumn->setName

function setName($name)
Parameters:
  • string $name

Method: AbstractNumberColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: AbstractNumberColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: AbstractNumberColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: AbstractNumberColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: AbstractNumberColumn->getLength

function getLength()
Returns:
  • int | null

Method: AbstractNumberColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: AbstractNumberColumn->isSigned

function isSigned()
Returns:
  • bool

Method: AbstractNumberColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Numeric\FixedPoint\DecimalColumn

Method: DecimalColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: DecimalColumn->__construct

function __construct($name, $decimals)
Parameters:
  • string $name
  • int $decimals

Method: DecimalColumn->getDecimals

function getDecimals()
Returns:
  • int

Method: DecimalColumn->setDecimals

function setDecimals($decimals)
Parameters:
  • int $decimals

Method: DecimalColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: DecimalColumn->getComment

function getComment()
Returns:
  • string

Method: DecimalColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: DecimalColumn->isNullable

function isNullable()
Returns:
  • bool

Method: DecimalColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: DecimalColumn->getName

function getName()
Returns:
  • string

Method: DecimalColumn->setName

function setName($name)
Parameters:
  • string $name

Method: DecimalColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: DecimalColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: DecimalColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: DecimalColumn->getLength

function getLength()
Returns:
  • int | null

Method: DecimalColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: DecimalColumn->isSigned

function isSigned()
Returns:
  • bool

Method: DecimalColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Numeric\FloatingPoint\DoubleColumn

Method: DoubleColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: DoubleColumn->__construct

function __construct($name, $decimals)
Parameters:
  • string $name
  • int $decimals

Method: DoubleColumn->getDecimals

function getDecimals()
Returns:
  • int

Method: DoubleColumn->setDecimals

function setDecimals($decimals)
Parameters:
  • int $decimals

Method: DoubleColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: DoubleColumn->getComment

function getComment()
Returns:
  • string

Method: DoubleColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: DoubleColumn->isNullable

function isNullable()
Returns:
  • bool

Method: DoubleColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: DoubleColumn->getName

function getName()
Returns:
  • string

Method: DoubleColumn->setName

function setName($name)
Parameters:
  • string $name

Method: DoubleColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: DoubleColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: DoubleColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: DoubleColumn->getLength

function getLength()
Returns:
  • int | null

Method: DoubleColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: DoubleColumn->isSigned

function isSigned()
Returns:
  • bool

Method: DoubleColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Numeric\FloatingPoint\FloatColumn

Method: FloatColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: FloatColumn->__construct

function __construct($name, $decimals)
Parameters:
  • string $name
  • int $decimals

Method: FloatColumn->getDecimals

function getDecimals()
Returns:
  • int

Method: FloatColumn->setDecimals

function setDecimals($decimals)
Parameters:
  • int $decimals

Method: FloatColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: FloatColumn->getComment

function getComment()
Returns:
  • string

Method: FloatColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: FloatColumn->isNullable

function isNullable()
Returns:
  • bool

Method: FloatColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: FloatColumn->getName

function getName()
Returns:
  • string

Method: FloatColumn->setName

function setName($name)
Parameters:
  • string $name

Method: FloatColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: FloatColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: FloatColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: FloatColumn->getLength

function getLength()
Returns:
  • int | null

Method: FloatColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: FloatColumn->isSigned

function isSigned()
Returns:
  • bool

Method: FloatColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Numeric\Integers\BigIntColumn

Method: BigIntColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: BigIntColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: BigIntColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: BigIntColumn->getComment

function getComment()
Returns:
  • string

Method: BigIntColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: BigIntColumn->isNullable

function isNullable()
Returns:
  • bool

Method: BigIntColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: BigIntColumn->getName

function getName()
Returns:
  • string

Method: BigIntColumn->setName

function setName($name)
Parameters:
  • string $name

Method: BigIntColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: BigIntColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: BigIntColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: BigIntColumn->getLength

function getLength()
Returns:
  • int | null

Method: BigIntColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: BigIntColumn->isSigned

function isSigned()
Returns:
  • bool

Method: BigIntColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Numeric\Integers\IntColumn

Method: IntColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: IntColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: IntColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: IntColumn->getComment

function getComment()
Returns:
  • string

Method: IntColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: IntColumn->isNullable

function isNullable()
Returns:
  • bool

Method: IntColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: IntColumn->getName

function getName()
Returns:
  • string

Method: IntColumn->setName

function setName($name)
Parameters:
  • string $name

Method: IntColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: IntColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: IntColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: IntColumn->getLength

function getLength()
Returns:
  • int | null

Method: IntColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: IntColumn->isSigned

function isSigned()
Returns:
  • bool

Method: IntColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Numeric\Integers\MediumIntColumn

Method: MediumIntColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: MediumIntColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: MediumIntColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: MediumIntColumn->getComment

function getComment()
Returns:
  • string

Method: MediumIntColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: MediumIntColumn->isNullable

function isNullable()
Returns:
  • bool

Method: MediumIntColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: MediumIntColumn->getName

function getName()
Returns:
  • string

Method: MediumIntColumn->setName

function setName($name)
Parameters:
  • string $name

Method: MediumIntColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: MediumIntColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: MediumIntColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: MediumIntColumn->getLength

function getLength()
Returns:
  • int | null

Method: MediumIntColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: MediumIntColumn->isSigned

function isSigned()
Returns:
  • bool

Method: MediumIntColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Numeric\Integers\SmallIntColumn

Method: SmallIntColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: SmallIntColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: SmallIntColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: SmallIntColumn->getComment

function getComment()
Returns:
  • string

Method: SmallIntColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: SmallIntColumn->isNullable

function isNullable()
Returns:
  • bool

Method: SmallIntColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: SmallIntColumn->getName

function getName()
Returns:
  • string

Method: SmallIntColumn->setName

function setName($name)
Parameters:
  • string $name

Method: SmallIntColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: SmallIntColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: SmallIntColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: SmallIntColumn->getLength

function getLength()
Returns:
  • int | null

Method: SmallIntColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: SmallIntColumn->isSigned

function isSigned()
Returns:
  • bool

Method: SmallIntColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\Numeric\Integers\TinyIntColumn

Method: TinyIntColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: TinyIntColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: TinyIntColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: TinyIntColumn->getComment

function getComment()
Returns:
  • string

Method: TinyIntColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: TinyIntColumn->isNullable

function isNullable()
Returns:
  • bool

Method: TinyIntColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: TinyIntColumn->getName

function getName()
Returns:
  • string

Method: TinyIntColumn->setName

function setName($name)
Parameters:
  • string $name

Method: TinyIntColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: TinyIntColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: TinyIntColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: TinyIntColumn->getLength

function getLength()
Returns:
  • int | null

Method: TinyIntColumn->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Method: TinyIntColumn->isSigned

function isSigned()
Returns:
  • bool

Method: TinyIntColumn->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Columns\String\AbstractCharacterColumn

Method: AbstractCharacterColumn->__construct

function __construct($name, $length)
Parameters:
  • string $name
  • int $length

Method: AbstractCharacterColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: AbstractCharacterColumn->getComment

function getComment()
Returns:
  • string

Method: AbstractCharacterColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: AbstractCharacterColumn->isNullable

function isNullable()
Returns:
  • bool

Method: AbstractCharacterColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: AbstractCharacterColumn->getName

function getName()
Returns:
  • string

Method: AbstractCharacterColumn->setName

function setName($name)
Parameters:
  • string $name

Method: AbstractCharacterColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: AbstractCharacterColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: AbstractCharacterColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: AbstractCharacterColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: AbstractCharacterColumn->getCharset

function getCharset()
Returns:
  • null

Method: AbstractCharacterColumn->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: AbstractCharacterColumn->getCollation

function getCollation()
Returns:
  • null

Method: AbstractCharacterColumn->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Method: AbstractCharacterColumn->getLength

function getLength()
Returns:
  • int

Method: AbstractCharacterColumn->setLength

function setLength($length)
Parameters:
  • int $length

Class: donatj\MySqlSchema\Columns\String\AbstractStringColumn

Method: AbstractStringColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: AbstractStringColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: AbstractStringColumn->getComment

function getComment()
Returns:
  • string

Method: AbstractStringColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: AbstractStringColumn->isNullable

function isNullable()
Returns:
  • bool

Method: AbstractStringColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: AbstractStringColumn->getName

function getName()
Returns:
  • string

Method: AbstractStringColumn->setName

function setName($name)
Parameters:
  • string $name

Method: AbstractStringColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: AbstractStringColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: AbstractStringColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: AbstractStringColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: AbstractStringColumn->getCharset

function getCharset()
Returns:
  • null

Method: AbstractStringColumn->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: AbstractStringColumn->getCollation

function getCollation()
Returns:
  • null

Method: AbstractStringColumn->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Class: donatj\MySqlSchema\Columns\String\AbstractTextColumn

Method: AbstractTextColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: AbstractTextColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: AbstractTextColumn->getComment

function getComment()
Returns:
  • string

Method: AbstractTextColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: AbstractTextColumn->isNullable

function isNullable()
Returns:
  • bool

Method: AbstractTextColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: AbstractTextColumn->getName

function getName()
Returns:
  • string

Method: AbstractTextColumn->setName

function setName($name)
Parameters:
  • string $name

Method: AbstractTextColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: AbstractTextColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: AbstractTextColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: AbstractTextColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: AbstractTextColumn->getCharset

function getCharset()
Returns:
  • null

Method: AbstractTextColumn->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: AbstractTextColumn->getCollation

function getCollation()
Returns:
  • null

Method: AbstractTextColumn->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Class: donatj\MySqlSchema\Columns\String\Character\CharColumn

Method: CharColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: CharColumn->__construct

function __construct($name, $length)
Parameters:
  • string $name
  • int $length

Method: CharColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: CharColumn->getComment

function getComment()
Returns:
  • string

Method: CharColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: CharColumn->isNullable

function isNullable()
Returns:
  • bool

Method: CharColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: CharColumn->getName

function getName()
Returns:
  • string

Method: CharColumn->setName

function setName($name)
Parameters:
  • string $name

Method: CharColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: CharColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: CharColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: CharColumn->getCharset

function getCharset()
Returns:
  • null

Method: CharColumn->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: CharColumn->getCollation

function getCollation()
Returns:
  • null

Method: CharColumn->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Method: CharColumn->getLength

function getLength()
Returns:
  • int

Method: CharColumn->setLength

function setLength($length)
Parameters:
  • int $length

Class: donatj\MySqlSchema\Columns\String\Character\VarcharColumn

Method: VarcharColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: VarcharColumn->__construct

function __construct($name, $length)
Parameters:
  • string $name
  • int $length

Method: VarcharColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: VarcharColumn->getComment

function getComment()
Returns:
  • string

Method: VarcharColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: VarcharColumn->isNullable

function isNullable()
Returns:
  • bool

Method: VarcharColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: VarcharColumn->getName

function getName()
Returns:
  • string

Method: VarcharColumn->setName

function setName($name)
Parameters:
  • string $name

Method: VarcharColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: VarcharColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: VarcharColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: VarcharColumn->getCharset

function getCharset()
Returns:
  • null

Method: VarcharColumn->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: VarcharColumn->getCollation

function getCollation()
Returns:
  • null

Method: VarcharColumn->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Method: VarcharColumn->getLength

function getLength()
Returns:
  • int

Method: VarcharColumn->setLength

function setLength($length)
Parameters:
  • int $length

Class: donatj\MySqlSchema\Columns\String\Text\LongTextColumn

Method: LongTextColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: LongTextColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: LongTextColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: LongTextColumn->getComment

function getComment()
Returns:
  • string

Method: LongTextColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: LongTextColumn->isNullable

function isNullable()
Returns:
  • bool

Method: LongTextColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: LongTextColumn->getName

function getName()
Returns:
  • string

Method: LongTextColumn->setName

function setName($name)
Parameters:
  • string $name

Method: LongTextColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: LongTextColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: LongTextColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: LongTextColumn->getCharset

function getCharset()
Returns:
  • null

Method: LongTextColumn->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: LongTextColumn->getCollation

function getCollation()
Returns:
  • null

Method: LongTextColumn->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Class: donatj\MySqlSchema\Columns\String\Text\MediumTextColumn

Method: MediumTextColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: MediumTextColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: MediumTextColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: MediumTextColumn->getComment

function getComment()
Returns:
  • string

Method: MediumTextColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: MediumTextColumn->isNullable

function isNullable()
Returns:
  • bool

Method: MediumTextColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: MediumTextColumn->getName

function getName()
Returns:
  • string

Method: MediumTextColumn->setName

function setName($name)
Parameters:
  • string $name

Method: MediumTextColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: MediumTextColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: MediumTextColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: MediumTextColumn->getCharset

function getCharset()
Returns:
  • null

Method: MediumTextColumn->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: MediumTextColumn->getCollation

function getCollation()
Returns:
  • null

Method: MediumTextColumn->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Class: donatj\MySqlSchema\Columns\String\Text\TextColumn

Method: TextColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: TextColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: TextColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: TextColumn->getComment

function getComment()
Returns:
  • string

Method: TextColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: TextColumn->isNullable

function isNullable()
Returns:
  • bool

Method: TextColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: TextColumn->getName

function getName()
Returns:
  • string

Method: TextColumn->setName

function setName($name)
Parameters:
  • string $name

Method: TextColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: TextColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: TextColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: TextColumn->getCharset

function getCharset()
Returns:
  • null

Method: TextColumn->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: TextColumn->getCollation

function getCollation()
Returns:
  • null

Method: TextColumn->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Class: donatj\MySqlSchema\Columns\String\Text\TinyTextColumn

Method: TinyTextColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: TinyTextColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: TinyTextColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: TinyTextColumn->getComment

function getComment()
Returns:
  • string

Method: TinyTextColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: TinyTextColumn->isNullable

function isNullable()
Returns:
  • bool

Method: TinyTextColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: TinyTextColumn->getName

function getName()
Returns:
  • string

Method: TinyTextColumn->setName

function setName($name)
Parameters:
  • string $name

Method: TinyTextColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: TinyTextColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: TinyTextColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: TinyTextColumn->getCharset

function getCharset()
Returns:
  • null

Method: TinyTextColumn->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: TinyTextColumn->getCollation

function getCollation()
Returns:
  • null

Method: TinyTextColumn->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Class: donatj\MySqlSchema\Columns\Temporal\AbstractTemporalColumn

Method: AbstractTemporalColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: AbstractTemporalColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: AbstractTemporalColumn->getComment

function getComment()
Returns:
  • string

Method: AbstractTemporalColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: AbstractTemporalColumn->isNullable

function isNullable()
Returns:
  • bool

Method: AbstractTemporalColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: AbstractTemporalColumn->getName

function getName()
Returns:
  • string

Method: AbstractTemporalColumn->setName

function setName($name)
Parameters:
  • string $name

Method: AbstractTemporalColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: AbstractTemporalColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: AbstractTemporalColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: AbstractTemporalColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Class: donatj\MySqlSchema\Columns\Temporal\DateTimeColumn

Method: DateTimeColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: DateTimeColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: DateTimeColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: DateTimeColumn->getComment

function getComment()
Returns:
  • string

Method: DateTimeColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: DateTimeColumn->isNullable

function isNullable()
Returns:
  • bool

Method: DateTimeColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: DateTimeColumn->getName

function getName()
Returns:
  • string

Method: DateTimeColumn->setName

function setName($name)
Parameters:
  • string $name

Method: DateTimeColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: DateTimeColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: DateTimeColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Class: donatj\MySqlSchema\Columns\Temporal\TimeColumn

Method: TimeColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: TimeColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: TimeColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: TimeColumn->getComment

function getComment()
Returns:
  • string

Method: TimeColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: TimeColumn->isNullable

function isNullable()
Returns:
  • bool

Method: TimeColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: TimeColumn->getName

function getName()
Returns:
  • string

Method: TimeColumn->setName

function setName($name)
Parameters:
  • string $name

Method: TimeColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: TimeColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: TimeColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Class: donatj\MySqlSchema\Columns\Temporal\TimestampColumn

Method: TimestampColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: TimestampColumn->__construct

function __construct($name)
Parameters:
  • string $name

Method: TimestampColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: TimestampColumn->getComment

function getComment()
Returns:
  • string

Method: TimestampColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: TimestampColumn->isNullable

function isNullable()
Returns:
  • bool

Method: TimestampColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: TimestampColumn->getName

function getName()
Returns:
  • string

Method: TimestampColumn->setName

function setName($name)
Parameters:
  • string $name

Method: TimestampColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: TimestampColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: TimestampColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Class: donatj\MySqlSchema\Columns\Temporal\YearColumn

Method: YearColumn->__construct

function __construct($name [, $length = 4])
Parameters:
  • string $name
  • int $length - 2 or 4

Method: YearColumn->setLength

function setLength($length)
Parameters:
  • int $length - 2 or 4

Method: YearColumn->getTypeName

function getTypeName()
Returns:
  • string

Method: YearColumn->getTables

function getTables()
Returns:
  • \donatj\MySqlSchema\Table[]

Method: YearColumn->getComment

function getComment()
Returns:
  • string

Method: YearColumn->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: YearColumn->isNullable

function isNullable()
Returns:
  • bool

Method: YearColumn->setNullable

function setNullable($nullable)
Parameters:
  • bool $nullable

Method: YearColumn->getName

function getName()
Returns:
  • string

Method: YearColumn->setName

function setName($name)
Parameters:
  • string $name

Method: YearColumn->toString

function toString(\donatj\MySqlSchema\Table $table)
Parameters:
  • \donatj\MySqlSchema\Table $table
Returns:
  • string

Method: YearColumn->getDefault

function getDefault()
Returns:
  • mixed

Method: YearColumn->setDefault

function setDefault($default)
Parameters:
  • mixed $default

Method: YearColumn->getLength

function getLength()
Returns:
  • int

Class: donatj\MySqlSchema\Columns\Traits\OptionalLengthTrait

Method: OptionalLengthTrait->getLength

function getLength()
Returns:
  • int | null

Method: OptionalLengthTrait->setLength

function setLength([ $length = null])
Parameters:
  • int | null $length

Class: donatj\MySqlSchema\Columns\Traits\RequiredLengthTrait

Method: RequiredLengthTrait->getLength

function getLength()
Returns:
  • int

Method: RequiredLengthTrait->setLength

function setLength($length)
Parameters:
  • int $length

Class: donatj\MySqlSchema\Columns\Traits\SignedTrait

Method: SignedTrait->isSigned

function isSigned()
Returns:
  • bool

Method: SignedTrait->setSigned

function setSigned($signed)
Parameters:
  • bool $signed

Class: donatj\MySqlSchema\Table

Method: Table->__construct

function __construct($name)

Table constructor.

Parameters:
  • string $name

Method: Table->getColumns

function getColumns()
Returns:
  • \donatj\MySqlSchema\Columns\AbstractColumn[]

Method: Table->getComment

function getComment()
Returns:
  • string

Method: Table->setComment

function setComment($comment)
Parameters:
  • string $comment

Method: Table->getEngine

function getEngine()
Returns:
  • null

Method: Table->setEngine

function setEngine($engine)
Parameters:
  • null $engine

Method: Table->getName

function getName()
Returns:
  • string

Method: Table->setName

function setName($name)
Parameters:
  • string $name

Undocumented Method: Table->addAutoIncrement(\donatj\MySqlSchema\Columns\Numeric\AbstractIntegerColumn $column)

Method: Table->isAutoIncrement

function isAutoIncrement(\donatj\MySqlSchema\Columns\Numeric\AbstractIntegerColumn $column)
Parameters:
  • \donatj\MySqlSchema\Columns\Numeric\AbstractIntegerColumn $column
Returns:
  • bool

Undocumented Method: Table->addPrimaryKey(\donatj\MySqlSchema\Columns\AbstractColumn $column)

Method: Table->isPrimaryKey

function isPrimaryKey(\donatj\MySqlSchema\Columns\AbstractColumn $column)
Parameters:
  • \donatj\MySqlSchema\Columns\AbstractColumn $column
Returns:
  • bool

Undocumented Method: Table->addKeyColumn($keyName, \donatj\MySqlSchema\Columns\AbstractColumn $column [, $index = null [, $type = 'NORMAL' [, $method = '']]])

Undocumented Method: Table->addForeignKey(\donatj\MySqlSchema\Columns\AbstractColumn $local, \donatj\MySqlSchema\Columns\AbstractColumn $remote)

Undocumented Method: Table->addColumn(\donatj\MySqlSchema\Columns\AbstractColumn $column)

Undocumented Method: Table->toString()

Method: Table->getCharset

function getCharset()
Returns:
  • null

Method: Table->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: Table->getCollation

function getCollation()
Returns:
  • null

Method: Table->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Class: donatj\MySqlSchema\Traits\CharsetAndCollationTrait

Method: CharsetAndCollationTrait->getCharset

function getCharset()
Returns:
  • null

Method: CharsetAndCollationTrait->setCharset

function setCharset($charset)
Parameters:
  • null $charset

Method: CharsetAndCollationTrait->getCollation

function getCollation()
Returns:
  • null

Method: CharsetAndCollationTrait->setCollation

function setCollation($collation)
Parameters:
  • null $collation

Class: donatj\MySqlSchema\Traits\EscapeTrait