SetaFramework API Reference

Index

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

com\setasign\SetaFramework\Database\Manager

AbstractManager Class AbstractManager

File: /SetaFramework/src/Database/Manager/AbstractManager.php

Class hierarchy

AbstractManager
- Driver\Mysql

Summary

Methods

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

Properties

$database

Properties

$database

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

Methods

__construct()

public AbstractManager::__construct (

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

)

Parameters

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

dropTable()

abstract public AbstractManager::dropTable (

string $tableName

): void

Drops a table.

Parameters

$tableName : string

getAlterDefinition()

abstract public AbstractManager::getAlterDefinition (

string $originalTableName,
array{columnOrder: string[], addColumns: Column\AbstractColumn[], modifyColumns: Column\AbstractColumn[], changeColumns: array<string, array{oldName: string, column: 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: Column\AbstractColumn[], modifyColumns: Column\AbstractColumn[], changeColumns: array<string, array{oldName: string, column: Column\AbstractColumn}>, dropColumns: string[], addKeys: array<string, array{type: string, columns: string[]}>, dropKeys: string[], changeTableName: string|false, changeEngine: string|false, changeTableCollation: string|false}

getColumnDefinition()

abstract public AbstractManager::getColumnDefinition (

Column\AbstractColumn $column

): string

Returns the column definition for the column as string.

Should be used in getCreateDefinition and getAlterDefinition.

Parameters

$column : Column\AbstractColumn

getCreateDefinition()

abstract public AbstractManager::getCreateDefinition (

TableSchema $tableSchema,
bool $ifNotExist = false

): string

Returns the sql command for creating the table

Parameters

$tableSchema : TableSchema
$ifNotExist : bool

getDatabase()

public AbstractManager::getDatabase (

void

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

Returns the database instance.

getDefaultCollation()

abstract public AbstractManager::getDefaultCollation (

void

): string

getDefaultEngine()

abstract public AbstractManager::getDefaultEngine (

void

): ?string

Returns the table engine.

getTableNames()

abstract public AbstractManager::getTableNames (

void

): array

Return the names of all tables in the database.

getTableSchema()

abstract public AbstractManager::getTableSchema (

string $tableName

Returns the tableSchema for the table.

The table must already exist in the database.

Parameters

$tableName : string

hasColumn()

abstract public AbstractManager::hasColumn (

string $tableName,
string $column

): bool

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

Note: the table must exist.

Parameters

$tableName : string
$column : string

hasTable()

abstract public AbstractManager::hasTable (

string $tableName

): bool

Checks whether a table exist.

Parameters

$tableName : string

renameTable()

abstract public AbstractManager::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