1. class
  2. Windwalker
  3. Database
  4. Driver
  5. Mysql
  6. MysqlTable

MysqlTable

class MysqlTable extends AbstractTable (View source)

Class MysqlTable

Methods

__construct(string $table, AbstractDatabaseDriver $db)

Constructor.

from AbstractTable
AbstractTable
create(callable|Schema $schema, bool $ifNotExists = true, array $options = array())

create

AbstractTable
update(callable|Schema $schema)

update

from AbstractTable
$this
save(callable|Schema $schema, bool $ifNotExists = true, array $options = array())

save

from AbstractTable
AbstractTable
drop(bool $ifExists = true, string $option = '')

drop

from AbstractTable
boolean
exists()

exists

from AbstractTable
$this
rename(string $newName, boolean $returnNew = true)

rename

AbstractTable
lock()

Locks a table in the database.

from AbstractTable
AbstractTable
unlock()

unlock

from AbstractTable
AbstractTable
truncate()

Method to truncate a table.

from AbstractTable
array|boolean
getDetail()

getDetail

from AbstractTable
array
getColumns(bool $refresh = false)

Get table columns.

from AbstractTable
mixed
getColumnDetails(bool $refresh = false)

getColumnDetails

stdClass
getColumnDetail(string $column)

getColumnDetail

from AbstractTable
boolean
hasColumn(string $column)

hasColumn

from AbstractTable
AbstractTable
addColumn(string $name, string $type = 'text', bool $signed = true, bool $allowNull = true, string $default = '', string $comment = '', array $options = array())

addColumn

AbstractTable
dropColumn(string $name)

dropColumn

from AbstractTable
AbstractTable
modifyColumn(string|Column $name, string $type = 'text', bool $signed = true, bool $allowNull = true, string $default = '', string $comment = '', array $options = array())

modifyColumn

AbstractTable
changeColumn(string $oldName, string|Column $newName, string $type = 'text', bool $signed = true, bool $allowNull = true, string $default = '', string $comment = '', array $options = array())

changeColumn

AbstractTable
addIndex(string $type, array $columns = array(), string $name = null, string $comment = null, array $options = array())

addIndex

AbstractTable
dropIndex(string $name)

dropIndex

array
getIndexes()

getIndexes

boolean
hasIndex(string $name)

hasIndex

from AbstractTable
string
getName()

Method to get property Table

from AbstractTable
AbstractTable
setName(string $name)

Method to set property table

from AbstractTable
AbstractDatabaseDriver
getDriver()

Method to get property Db

from AbstractTable
AbstractTable
setDriver(AbstractDatabaseDriver $db)

Method to set property db

from AbstractTable
Schema
getSchema()

getSchema

from AbstractTable
AbstractDatabase
getDatabase()

Method to get property Database

from AbstractTable
AbstractTable
setDatabase(AbstractDatabase $database)

Method to set property database

from AbstractTable
DataType
getDataType()

getTypeMapper

from AbstractTable
AbstractTable
reset()

reset

from AbstractTable

Details

in AbstractTable at line line 64
__construct(string $table, AbstractDatabaseDriver $db)

Constructor.

Parameters

string $table
AbstractDatabaseDriver $db

at line line 33
AbstractTable create(callable|Schema $schema, bool $ifNotExists = true, array $options = array())

create

Parameters

callable|Schema $schema
bool $ifNotExists
array $options

Return Value

AbstractTable

in AbstractTable at line line 89
AbstractTable update(callable|Schema $schema)

update

Parameters

callable|Schema $schema

Return Value

AbstractTable

in AbstractTable at line line 115
$this save(callable|Schema $schema, bool $ifNotExists = true, array $options = array())

save

Parameters

callable|Schema $schema
bool $ifNotExists
array $options

Return Value

$this

in AbstractTable at line line 142
AbstractTable drop(bool $ifExists = true, string $option = '')

drop

Parameters

bool $ifExists
string $option

Return Value

AbstractTable

in AbstractTable at line line 158
boolean exists()

exists

Return Value

boolean

at line line 322
$this rename(string $newName, boolean $returnNew = true)

rename

Parameters

string $newName
boolean $returnNew

Return Value

$this

in AbstractTable at line line 183
AbstractTable lock()

Locks a table in the database.

Return Value

AbstractTable Returns this object to support chaining.

Exceptions

RuntimeException

in AbstractTable at line line 197
AbstractTable unlock()

unlock

Return Value

AbstractTable Returns this object to support chaining.

Exceptions

RuntimeException

in AbstractTable at line line 212
AbstractTable truncate()

Method to truncate a table.

Return Value

AbstractTable

Exceptions

RuntimeException

in AbstractTable at line line 224
array|boolean getDetail()

getDetail

Return Value

array|boolean

in AbstractTable at line line 236
array getColumns(bool $refresh = false)

Get table columns.

Parameters

bool $refresh

Return Value

array Table columns with type.

at line line 343
mixed getColumnDetails(bool $refresh = false)

getColumnDetails

Parameters

bool $refresh

Return Value

mixed

in AbstractTable at line line 257
stdClass getColumnDetail(string $column)

getColumnDetail

Parameters

string $column

Return Value

stdClass

in AbstractTable at line line 271
boolean hasColumn(string $column)

hasColumn

Parameters

string $column

Return Value

boolean

at line line 98
AbstractTable addColumn(string $name, string $type = 'text', bool $signed = true, bool $allowNull = true, string $default = '', string $comment = '', array $options = array())

addColumn

Parameters

string $name
string $type
bool $signed
bool $allowNull
string $default
string $comment
array $options

Return Value

AbstractTable

in AbstractTable at line line 298
AbstractTable dropColumn(string $name)

dropColumn

Parameters

string $name

Return Value

AbstractTable

at line line 143
AbstractTable modifyColumn(string|Column $name, string $type = 'text', bool $signed = true, bool $allowNull = true, string $default = '', string $comment = '', array $options = array())

modifyColumn

Parameters

string|Column $name
string $type
bool $signed
bool $allowNull
string $default
string $comment
array $options

Return Value

AbstractTable

at line line 201
AbstractTable changeColumn(string $oldName, string|Column $newName, string $type = 'text', bool $signed = true, bool $allowNull = true, string $default = '', string $comment = '', array $options = array())

changeColumn

Parameters

string $oldName
string|Column $newName
string $type
bool $signed
bool $allowNull
string $default
string $comment
array $options

Return Value

AbstractTable

at line line 257
AbstractTable addIndex(string $type, array $columns = array(), string $name = null, string $comment = null, array $options = array())

addIndex

Parameters

string $type
array $columns
string $name
string $comment
array $options

Return Value

AbstractTable

at line line 300
AbstractTable dropIndex(string $name)

dropIndex

Parameters

string $name

Return Value

AbstractTable

at line line 360
array getIndexes()

getIndexes

Return Value

array

in AbstractTable at line line 381
boolean hasIndex(string $name)

hasIndex

Parameters

string $name

Return Value

boolean

in AbstractTable at line line 401
string getName()

Method to get property Table

Return Value

string

in AbstractTable at line line 418
AbstractTable setName(string $name)

Method to set property table

Parameters

string $name

Return Value

AbstractTable Return self to support chaining.

in AbstractTable at line line 430
AbstractDatabaseDriver getDriver()

Method to get property Db

Return Value

AbstractDatabaseDriver

in AbstractTable at line line 442
AbstractTable setDriver(AbstractDatabaseDriver $db)

Method to set property db

Parameters

AbstractDatabaseDriver $db

Return Value

AbstractTable Return self to support chaining.

in AbstractTable at line line 454
Schema getSchema()

getSchema

Return Value

Schema

in AbstractTable at line line 490
AbstractDatabase getDatabase()

Method to get property Database

Return Value

AbstractDatabase

in AbstractTable at line line 502
AbstractTable setDatabase(AbstractDatabase $database)

Method to set property database

Parameters

AbstractDatabase $database

Return Value

AbstractTable Return self to support chaining.

in AbstractTable at line line 519
DataType getDataType()

getTypeMapper

Return Value

DataType

in AbstractTable at line line 579
AbstractTable reset()

reset

Return Value

AbstractTable