Documentation

Table
in package

FinalYes

Legacy DBMS table wrapper for select, insert, update, delete, and schema operations.

Tags
author

Daniel Schulz

since
2018-03-29

Table of Contents

Properties

$db  : Database
$name  : string

Methods

__construct()  : mixed
addIndex()  : void
createTable()  : void
delete()  : int|null
escape()  : string
getColumns()  : array<string|int, mixed>|null
getName()  : string
insert()  : int|null
optimize()  : bool|null
select()  : array<string|int, mixed>|null
tableExists()  : bool|null
tableMove()  : bool
update()  : int|null

Properties

$name

protected string $name

Methods

__construct()

public __construct(Database $db, string $tableName) : mixed
Parameters
$db : Database
$tableName : string

addIndex()

public addIndex(array<string|int, mixed>|string $index) : void
Parameters
$index : array<string|int, mixed>|string

createTable()

public createTable(array<string|int, mixed> $cols, array<string|int, mixed> $keys[, array<string|int, mixed> $options = [] ]) : void
Parameters
$cols : array<string|int, mixed>
$keys : array<string|int, mixed>
$options : array<string|int, mixed> = []

delete()

public delete([mixed $idQuery = false ]) : int|null
Parameters
$idQuery : mixed = false
Return values
int|null

escape()

public escape(string $string) : string
Parameters
$string : string
Return values
string

getColumns()

public getColumns() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getName()

public getName() : string
Return values
string

insert()

public insert([array<string|int, mixed> $insertData = [] ][, array<string|int, mixed> $onDuplicateData = [] ]) : int|null
Parameters
$insertData : array<string|int, mixed> = []
$onDuplicateData : array<string|int, mixed> = []
Return values
int|null

optimize()

public optimize() : bool|null
Return values
bool|null

select()

public select([array<string|int, mixed>|string|bool $columnQuery = true ][, array<string|int, mixed>|string $sqlQuery = '' ][, string $sqlSuffix = '' ]) : array<string|int, mixed>|null
Parameters
$columnQuery : array<string|int, mixed>|string|bool = true
$sqlQuery : array<string|int, mixed>|string = ''
$sqlSuffix : string = ''
Return values
array<string|int, mixed>|null

tableExists()

public tableExists() : bool|null
Return values
bool|null

tableMove()

public tableMove(string $newTableName[, string|null $newDbName = null ]) : bool
Parameters
$newTableName : string
$newDbName : string|null = null
Return values
bool

update()

public update([array<string|int, mixed> $arr = [] ][, mixed $idQuery = false ]) : int|null
Parameters
$arr : array<string|int, mixed> = []
$idQuery : mixed = false
Return values
int|null
On this page

Search results