SetaFramework API Reference

Index

\com\setasign\SetaFramework
1. Database
  1. Manager
    1. Driver
      1. Mysql

com\setasign\SetaFramework\Database\Manager\Driver

Mysql Class Mysql

File: /SetaFramework/src/Database/Manager/Driver/Mysql.php

Class hierarchy

\com\setasign\SetaFramework\Database\Manager\AbstractManager
- Mysql

Summary

Methods

__construct()
createTypeInstance()
dropTable()
getAlterDefinition()
getColumnDefinition()
getCreateDefinition()
getDatabase()
getDefaultCollation()
getDefaultEngine()
getDropTableQuery()
getTableNames()
getTableSchema()
getTypeName()
hasColumn()
hasTable()
renameTable()

Properties

$database

Properties

$database

protected \com\setasign\SetaFramework\Database\Database \com\setasign\SetaFramework\Database\Manager\AbstractManager::$database

Methods

__construct()

public \com\setasign\SetaFramework\Database\Manager\AbstractManager::__construct (

\com\setasign\SetaFramework\Database\Database $database

)

Parameters

$database : \com\setasign\SetaFramework\Database\Database

createTypeInstance()

protected Mysql::createTypeInstance (

string $columnName,
string $type,
?string $collation,
bool $allowNull,
?scalar $default,
string $extra

): \com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn

Creates a columnObject from the databaseType

Parameters

$columnName : string
$type : string
$collation : ?string
$allowNull : bool
$default : ?scalar
$extra : string

dropTable()

public Mysql::dropTable (

string $tableName

): void

Drops a table.

Parameters

$tableName : string

getAlterDefinition()

public Mysql::getAlterDefinition (

string $originalTableName,
array{columnOrder: string[], addColumns: \com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn[], modifyColumns: \com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn[], changeColumns: array<string, array{oldName: string, column: \com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn}>, dropColumns: string[], addKeys: array<string, array{type: string, columns: string[]}>, dropKeys: string[], changeTableName: string|false, changeEngine: string|false, changeTableCollation: string|false} $changes

): string

Returns the sql command for alter the table.

$changes: all entries are arrays, following keys are used:

Key	Description
addColumns & modifyColumns	value = AbstractColumn $column
changeColumns	key = string $oldColumnName; value = AbstractColumn $column
dropColumns	value = string $columnName
addKeys	key = string $indexName; value = array('type' => int $indexType; 'columns' => string[] $columns)
dropKeys	value = string $indexName

Parameters

$originalTableName : string
$changes : array{columnOrder: string[], addColumns: \com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn[], modifyColumns: \com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn[], changeColumns: array<string, array{oldName: string, column: \com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn}>, dropColumns: string[], addKeys: array<string, array{type: string, columns: string[]}>, dropKeys: string[], changeTableName: string|false, changeEngine: string|false, changeTableCollation: string|false}

Exceptions

Throws \com\setasign\SetaFramework\Exception

getColumnDefinition()

public Mysql::getColumnDefinition (

\com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn $column

): string

Returns the column definition for the column as string.

Parameters

$column : \com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn

getCreateDefinition()

public Mysql::getCreateDefinition (

\com\setasign\SetaFramework\Database\Manager\TableSchema $tableSchema,
bool $ifNotExist = false

): string

Returns the sql command for creating the table

Parameters

$tableSchema : \com\setasign\SetaFramework\Database\Manager\TableSchema
$ifNotExist : bool

Exceptions

Throws \com\setasign\SetaFramework\Exception

getDatabase()

public \com\setasign\SetaFramework\Database\Manager\AbstractManager::getDatabase (

void

): \com\setasign\SetaFramework\Database\Database

Returns the database instance.

getDefaultCollation()

public Mysql::getDefaultCollation (

void

): string

getDefaultEngine()

public Mysql::getDefaultEngine (

void

): ?string

getDropTableQuery()

public Mysql::getDropTableQuery (

string $tableName

): string

Parameters

$tableName : string

getTableNames()

public Mysql::getTableNames (

void

): array

Return the names of all tables in the database.

getTableSchema()

public Mysql::getTableSchema (

string $tableName

): \com\setasign\SetaFramework\Database\Manager\TableSchema

Returns the tableSchema for the table.

The table must already exist in the database.

Parameters

$tableName : string

getTypeName()

protected Mysql::getTypeName (

\com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn $column

): string

Returns the columnType for the db from the columnObject

Parameters

$column : \com\setasign\SetaFramework\Database\Manager\Column\AbstractColumn

hasColumn()

public Mysql::hasColumn (

string $tableName,
string $column

): bool

Checks whether a column exists (with as little overhead as possible).

Parameters

$tableName : string
$column : string

hasTable()

public Mysql::hasTable (

string $tableName

): bool

Checks whether a table exist.

Parameters

$tableName : string

renameTable()

public Mysql::renameTable (

string $oldTableName,
string $newTableName

): void

Renames a table.

Mustn't be used if there exists a tableSchema for the table! (Only in TableSchema::rename)

Parameters

$oldTableName : string
$newTableName : string