Documentation

Client
in package

FinalYes

Legacy mysqli client wrapper with process-wide default connection configuration.

Tags
author

Daniel Schulz

since
2018-03-29

Table of Contents

Constants

ENV_CONNECTION_PASSWORD  : mixed = 'MYSQL_PASSWORD'
ENV_CONNECTION_PASSWORD_FILE  : mixed = 'MYSQL_PASSWORD_FILE'
ENV_CONNECTION_SERVER  : mixed = 'MYSQL_HOST'
ENV_CONNECTION_USER  : mixed = 'MYSQL_USER'

Properties

$connected  : bool
$dbName  : string|null
$sqli  : mysqli

Methods

__construct()  : mixed
addIndex()  : void
clearDefaultAuthority()  : void
createDatabase()  : void
createTable()  : void
databaseExists()  : bool|null
delete()  : int|null
deleteDatabase()  : void
disconnect()  : void
escape()  : string
execute()  : mysqli_result|bool
executeFile()  : bool|null
getColumns()  : array<string|int, mixed>|null
getDatabaseList()  : array<string|int, mixed>|null
getDefaultAuthority()  : Authority
getTableList()  : array<string|int, mixed>|null
insert()  : int|null
optimize()  : bool
reconnect()  : bool
resetCharset()  : void
select()  : array<string|int, mixed>|null
setDatabase()  : bool|null
setDefaultAuthority()  : void
tableExists()  : bool|null
tableMove()  : bool
update()  : int|null
_get_update_data()  : string
connect()  : bool
error()  : void
get_handle()  : string
get_ids()  : string

Constants

ENV_CONNECTION_PASSWORD

public mixed ENV_CONNECTION_PASSWORD = 'MYSQL_PASSWORD'

ENV_CONNECTION_PASSWORD_FILE

public mixed ENV_CONNECTION_PASSWORD_FILE = 'MYSQL_PASSWORD_FILE'

ENV_CONNECTION_SERVER

public mixed ENV_CONNECTION_SERVER = 'MYSQL_HOST'

ENV_CONNECTION_USER

public mixed ENV_CONNECTION_USER = 'MYSQL_USER'

Properties

$connected

protected bool $connected = false

$dbName

protected string|null $dbName = null

Methods

__construct()

public __construct() : mixed

addIndex()

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

clearDefaultAuthority()

public static clearDefaultAuthority() : void

createDatabase()

public createDatabase(string $dbName) : void
Parameters
$dbName : string

createTable()

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

databaseExists()

public databaseExists(string $dbName) : bool|null
Parameters
$dbName : string
Return values
bool|null

delete()

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

deleteDatabase()

public deleteDatabase(string $dbName) : void
Parameters
$dbName : string

disconnect()

public disconnect() : void

escape()

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

execute()

public execute(string $sqlString) : mysqli_result|bool
Parameters
$sqlString : string
Return values
mysqli_result|bool

executeFile()

public executeFile(string $file) : bool|null
Parameters
$file : string
Return values
bool|null

getColumns()

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

getDatabaseList()

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

getTableList()

public getTableList(string $dbName) : array<string|int, mixed>|null
Parameters
$dbName : string
Return values
array<string|int, mixed>|null

insert()

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

optimize()

public optimize(string $dbName, string $tableName) : bool
Parameters
$dbName : string
$tableName : string
Return values
bool

reconnect()

public reconnect() : bool
Return values
bool

resetCharset()

public resetCharset(string $dbName[, string|null $tableName = null ]) : void
Parameters
$dbName : string
$tableName : string|null = null

select()

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

setDatabase()

public setDatabase(string $dbName) : bool|null
Parameters
$dbName : string
Return values
bool|null

tableExists()

public tableExists(string $dbName, string $tableName) : bool|null
Parameters
$dbName : string
$tableName : string
Return values
bool|null

tableMove()

public tableMove(string $oldDbName, string $oldTableName, string $newDbName, string $newTableName) : bool
Parameters
$oldDbName : string
$oldTableName : string
$newDbName : string
$newTableName : string
Return values
bool

update()

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

_get_update_data()

protected _get_update_data(array<string|int, mixed> $arr) : string
Parameters
$arr : array<string|int, mixed>
Return values
string

connect()

protected connect() : bool
Return values
bool

error()

protected error([string|null $sql = null ]) : void
Parameters
$sql : string|null = null

get_handle()

protected get_handle(string|null $dbName[, string|null $tableName = null ]) : string
Parameters
$dbName : string|null
$tableName : string|null = null
Return values
string

get_ids()

protected get_ids(mixed $idQuery) : string
Parameters
$idQuery : mixed
Return values
string
On this page

Search results