Class Xmf\Database\Tables


					
	public

__construct()

Constructor

#


					
	protected

name(string $table): string

Return a table name, prefixed with site table prefix

Parameters

$table

table name to contain prefix

Returns

table name with prefix

#


					
	public

addColumn(string $table, string $column, string $attributes): bool

Add new column for table to the work queue

Parameters

`$table`	table to contain the column
`$column`	name of column to add
`$attributes`	column_definition

Returns

true if no errors, false if errors encountered

#


					
	public

addPrimaryKey(string $table, string $column): bool

Add new primary key definition for table to work queue

Parameters

`$table`	table
`$column`	column or comma separated list of columns to use as primary key

Returns

true if no errors, false if errors encountered

#


					
	public

addIndex(string $name, string $table, string $column, bool $unique = false): bool

Add new index definition for index to work queue

Parameters

`$name`	name of index to add
`$table`	table indexed
`$column`	column or a comma separated list of columns to use as the key
`$unique`	true if index is to be unique

Returns

true if no errors, false if errors encountered

#


					
	protected

quoteIndexColumnName(string $columnName): string

Backtick quote the column names used in index creation.

Handles prefix indexed columns specified as name(length) - i.e. name(20).

Parameters

$columnName

column name to quote with optional prefix length

#


					
	public

addTable(string $table): bool

Load table schema from database, or starts new empty schema if table does not exist

Parameters

$table

table

Returns

true if no errors, false if errors encountered

#


					
	public

useTable(string $table): bool

AddTable only if it exists

Parameters

$table

table

Returns

true if table exists, false otherwise

#


					
	public

getColumnAttributes(string $table, string $column): string|false

Get column attributes

Parameters

`$table`	table containing the column
`$column`	column to alter

Returns

attribute string, or false if error encountered

#


					
	public

getTableIndexes(string $table): array|false

Get indexes for a table

Parameters

$table

get indexes for this named table

Returns

array of indexes, or false if error encountered

#


					
	public

alterColumn(string $table, string $column, string $attributes, string $newName = ''): bool

Add alter column operation to the work queue

Parameters

`$table`	table containing the column
`$column`	column to alter
`$attributes`	new column_definition
`$newName`	new name for column, blank to keep same

Returns

true if no errors, false if errors encountered

#


					
	public

copyTable(string $table, string $newTable, bool $withData = false): bool

Loads table schema from database, and adds newTable with that schema to the queue

Parameters

`$table`	existing table
`$newTable`	new table
`$withData`	true to copy data, false for schema only

Returns

true if no errors, false if errors encountered

#


					
	public

dropColumn(string $table, string $column): bool

Add drop column operation to the work queue

Parameters

`$table`	table containing the column
`$column`	column to drop

Returns

true if no errors, false if errors encountered

#


					
	public

dropIndex(string $name, string $table): bool

Add drop index operation to the work queue

Parameters

`$name`	name of index to drop
`$table`	table indexed

Returns

true if no errors, false if errors encountered

#


					
	public

dropIndexes(string $table): bool

Add drop for all (non-PRIMARY) keys for a table to the work queue. This can be used to clean up indexes with automatic…

Add drop for all (non-PRIMARY) keys for a table to the work queue. This can be used to clean up indexes with automatic names.

Parameters

$table

table indexed

Returns

true if no errors, false if errors encountered

#


					
	public

dropPrimaryKey(string $table): bool

Add drop of PRIMARY key for a table to the work queue

Parameters

$table

table

Returns

true if no errors, false if errors encountered

#


					
	public

dropTable(string $table): bool

Add drop of table to the work queue

Parameters

$table

table

Returns

true if no errors, false if errors encountered

#


					
	public

renameTable(string $table, string $newName): bool

Add rename table operation to the work queue

Parameters

`$table`	table
`$newName`	new table name

Returns

true if no errors, false if errors encountered

#


					
	public

setTableOptions(string $table, string $options): bool

Add alter table table_options (ENGINE, DEFAULT CHARSET, etc.) to work queue

Parameters

`$table`	table
`$options`	table_options

Returns

true if no errors, false if errors encountered

#


					
	public

resetQueue(): void

Clear the work queue

#


					
	public

executeQueue(bool $force = false): bool

Executes the work queue

Parameters

$force

true to force updates even if this is a 'GET' request

Returns

true if no errors, false if errors encountered

#


					
	public

delete(string $table, string|CriteriaElement $criteria): bool

Create a DELETE statement and add it to the work queue

Parameters

`$table`	table
`$criteria`	string where clause or object criteria

Returns

true if no errors, false if errors encountered

#


					
	public

insert(string $table, array $columns, boolean $quoteValue = true): boolean

Create an INSERT SQL statement and add it to the work queue.

Parameters

`$table`	table
`$columns`	array of 'column'=>'value' entries
`$quoteValue`	true to quote values, false if caller handles quoting

Returns

true if no errors, false if errors encountered

#


					
	public

update(string $table, array $columns, string|CriteriaElement $criteria, boolean $quoteValue = true): boolean

Create an UPDATE SQL statement and add it to the work queue

Parameters

`$table`	table
`$columns`	array of 'column'=>'value' entries
`$criteria`	string where clause or object criteria
`$quoteValue`	true to quote values, false if caller handles quoting

Returns

true if no errors, false if errors encountered

#


					
	public

truncate(string $table): bool

Add statement to remove all rows from a table to the work queue

Parameters

$table

table

Returns

true if no errors, false if errors encountered

#


					
	protected

renderTableCreate(string $table, bool $prefixed = false): string|false

return SQL to create the table

This method does NOT modify the work queue

Parameters

`$table`	table
`$prefixed`	true to return with table name prefixed

Returns

string SQL to create table, or false if errors encountered

#


					
	protected

execSql(string $sql, bool $force = false): mixed

execute an SQL statement

Parameters

`$sql`	SQL statement to execute
`$force`	true to use force updates even in safe requests

Returns

result resource if no error, true if no error but no result false if error encountered. Any error message is in $this->lastError;

#


					
	protected

fetch(resource $result): mixed

fetch the next row of a result set

Parameters

$result

as returned by query

Returns

false on error

#


					
	protected

quoteDefaultClause(string|null $default): string

create default value clause for DDL

Parameters

$default

the default value to be quoted

Returns

the correctly quoted default value

#


					
	protected

getTable(string $table): array|bool

get table definition from INFORMATION_SCHEMA

Parameters

$table

table

Returns

table definition array if table exists, true if table not defined, or false on error. Error message in $this->lastError;

#


					
	protected

expandQueue(): void

During processing, tables to be created are put in the queue as an array('createtable' => tablename) since the…

During processing, tables to be created are put in the queue as an array('createtable' => tablename) since the definition is not complete. This method will expand those references to the full ddl to create the table.

#


					
	public

getLastError(): string

Return message from last error encountered

Returns

last error message

#


					
	public

getLastErrNo(): int

Return code from last error encountered

Returns

last error number

#


					
	public

dumpTables(): array

dumpTables - utility function to dump raw tables array

Returns

tables

#


					
	public

dumpQueue(): array

dumpQueue - utility function to dump the work queue

Returns

work queue

#


					
	public

addToQueue(string $sql): void

addToQueue - utility function to add a statement to the work queue

Parameters

$sql

an SQL/DDL statement to add

#


					
	protected

tableNotEstablished(): false

Set lastError as table not established

#

Properties
`protected`	`XoopsDatabase`	`$db`	#
`protected`	`string`	`$databaseName`	#
`protected`	`array`	`$tables` Tables Tables	#
`protected`	`array`	`$queue` Work queue Work queue	#
`protected`	`string`	`$lastError` last error message last error message	#
`protected`	`int`	`$lastErrNo` last error number last error number	#

Namespaces

Classes

Class Xmf\Database\Tables

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters