Element index for package DB_Table

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

_

_getFormColDefs: in file Table.php, method DB_Table::_getFormColDefs()
Creates a column definition array suitable for DB_Table_QuickForm.

top

a

addElements: in file QuickForm.php, method DB_Table_QuickForm::addElements()
Adds DB_Table columns to a pre-existing HTML_QuickForm object.
addFilters: in file QuickForm.php, method DB_Table_QuickForm::addFilters()
Adds DB_Table filters to a pre-existing HTML_QuickForm object.
addFormElements: in file Table.php, method DB_Table::addFormElements()
Adds elements and rules to a pre-existing HTML_QuickForm object.
addRules: in file QuickForm.php, method DB_Table_QuickForm::addRules()
Adds element rules to a pre-existing HTML_QuickForm object.
alter: in file Table.php, method DB_Table::alter()
Alters the table based on $this->col and $this->idx.
alterTable: in file oci8.php, method DB_Table_Manager_oci8::alterTable()
alter an existing table
alterTable: in file pgsql.php, method DB_Table_Manager_pgsql::alterTable()
alter an existing table
alterTable: in file sqlite.php, method DB_Table_Manager_sqlite::alterTable()
alter an existing table
alterTable: in file mysqli.php, method DB_Table_Manager_mysqli::alterTable()
alter an existing table
alterTable: in file mysql.php, method DB_Table_Manager_mysql::alterTable()
alter an existing table
alterTable: in file ibase.php, method DB_Table_Manager_ibase::alterTable()
alter an existing table
autoRecast: in file Table.php, method DB_Table::autoRecast()
Turns on (or off) automatic recasting of insert and update data.
autoValidInsert: in file Table.php, method DB_Table::autoValidInsert()
Turns on (or off) automatic validation of inserted data.
autoValidUpdate: in file Table.php, method DB_Table::autoValidUpdate()
Turns on (or off) automatic validation of updated data.

top

b

$backend: in file Table.php, variable DB_Table::$backend
The backend type
buildSQL: in file Table.php, method DB_Table::buildSQL()
Builds the SQL command from a specified $this->sql element.
bogotest.php: procedural page bogotest.php

top

c

$col: in file Table.php, variable DB_Table::$col
Associative array of column definitions.
create: in file Table.php, method DB_Table::create()
Creates the table based on $this->col and $this->idx.
createForm: in file QuickForm.php, method DB_Table_QuickForm::createForm()
Creates an empty form object.
$col: in file bogotest.php, variable example::$col (subpackage: DB_Table)

top

d

$db: in file Table.php, variable DB_Table::$db
The PEAR DB/MDB2 object that connects to the database.
DB_Table: in file Table.php, class DB_Table
DB_Table is a database API and data type SQL abstraction class.
DB_Table: in file Table.php, method DB_Table::DB_Table()
Constructor.
DB_TABLE_ERR_ALTER_INDEX_IMPOS: in file Table.php, constant DB_TABLE_ERR_ALTER_INDEX_IMPOS
Error code at alter() time when altering a(n) index/constraint is not possible (e.g. because MDB2 has no support for the change or because the DBMS does not support the change).
DB_TABLE_ERR_ALTER_TABLE_IMPOS: in file Table.php, constant DB_TABLE_ERR_ALTER_TABLE_IMPOS
Error code at alter() time when altering a table field is not possible (e.g. because MDB2 has no support for the change or because the DBMS does not support the change).
DB_TABLE_ERR_CREATE_FLAG: in file Table.php, constant DB_TABLE_ERR_CREATE_FLAG
Error code when you use a create() flag that is not recognized (must be 'safe', 'drop', 'verify' or boolean false.
DB_TABLE_ERR_CREATE_PHPTYPE: in file Table.php, constant DB_TABLE_ERR_CREATE_PHPTYPE
Error code at instantiation time when a creation mode is not available for a phptype.
DB_TABLE_ERR_DECLARE_COLNAME: in file Table.php, constant DB_TABLE_ERR_DECLARE_COLNAME
Error code at create() time when you define a column in $this->col with an invalid column name (usually because it's a reserved keyword).
DB_TABLE_ERR_DECLARE_DECIMAL: in file Table.php, constant DB_TABLE_ERR_DECLARE_DECIMAL
Error code at create() time when you have an error in a 'decimal' definition (usually becuase the 'size' or 'scope' are wrong).
DB_TABLE_ERR_DECLARE_IDXNAME: in file Table.php, constant DB_TABLE_ERR_DECLARE_IDXNAME
Error code at create() time when you define an index in $this->idx with an invalid index name (usually because it's a reserved keyword).
DB_TABLE_ERR_DECLARE_PRIMARY: in file Table.php, constant DB_TABLE_ERR_DECLARE_PRIMARY
Error code at create() time when you define more than one primary key in $this->idx.
DB_TABLE_ERR_DECLARE_PRIM_SQLITE: in file Table.php, constant DB_TABLE_ERR_DECLARE_PRIM_SQLITE
Error code at create() time when a primary key is defined in $this->idx and SQLite is used (SQLite does not support primary keys).
DB_TABLE_ERR_DECLARE_STRING: in file Table.php, constant DB_TABLE_ERR_DECLARE_STRING
Error code at create() time when you have an error in a 'char' or 'varchar' definition in $this->col (usually because 'size' is wrong).
DB_TABLE_ERR_DECLARE_STRLEN: in file Table.php, constant DB_TABLE_ERR_DECLARE_STRLEN
Error code at create() time when you define a column name that is more than 30 chars long (an Oracle restriction).
DB_TABLE_ERR_DECLARE_TYPE: in file Table.php, constant DB_TABLE_ERR_DECLARE_TYPE
Error code at create() time when you define a column in $this->col with an unrecognized 'type'.
DB_TABLE_ERR_IDX_COL_CLOB: in file Table.php, constant DB_TABLE_ERR_IDX_COL_CLOB
Error code at create() time when you define an index in $this->idx that refers to a CLOB column.
DB_TABLE_ERR_IDX_COL_UNDEF: in file Table.php, constant DB_TABLE_ERR_IDX_COL_UNDEF
Error code at create() time when you define an index in $this->idx that refers to a column that does not exist in the $this->col array.
DB_TABLE_ERR_IDX_NO_COLS: in file Table.php, constant DB_TABLE_ERR_IDX_NO_COLS
Error code at create() time when you define an index in $this->idx that has no columns.
DB_TABLE_ERR_IDX_STRLEN: in file Table.php, constant DB_TABLE_ERR_IDX_STRLEN
Error code at create() time when the index name ends up being more than 30 chars long (an Oracle restriction).
DB_TABLE_ERR_IDX_TYPE: in file Table.php, constant DB_TABLE_ERR_IDX_TYPE
Error code at create() time when you define a $this->idx index type that is not recognized (must be 'normal' or 'unique').
DB_TABLE_ERR_INS_COL_NOMAP: in file Table.php, constant DB_TABLE_ERR_INS_COL_NOMAP
Error code when you try to insert data to a column that is not in the $this->col array.
DB_TABLE_ERR_INS_COL_REQUIRED: in file Table.php, constant DB_TABLE_ERR_INS_COL_REQUIRED
Error code when you try to insert data, and that data does not have a column marked as 'require' in the $this->col array.
DB_TABLE_ERR_INS_DATA_INVALID: in file Table.php, constant DB_TABLE_ERR_INS_DATA_INVALID
Error code when auto-validation fails on data to be inserted.
DB_TABLE_ERR_NOT_DB_OBJECT: in file Table.php, constant DB_TABLE_ERR_NOT_DB_OBJECT
Error code at instantiation time when the first parameter to the constructor is not a PEAR DB object.
DB_TABLE_ERR_NO_COLS: in file Table.php, constant DB_TABLE_ERR_NO_COLS
Error code at instantiation time when the column definition array does not contain at least one column.
DB_TABLE_ERR_PHPTYPE: in file Table.php, constant DB_TABLE_ERR_PHPTYPE
Error code at instantiation time when the PEAR DB/MDB2 $phptype is not supported by DB_Table.
DB_TABLE_ERR_SEQ_STRLEN: in file Table.php, constant DB_TABLE_ERR_SEQ_STRLEN
Error code at nextID() time when the sequence name is more than 30 chars long (an Oracle restriction).
DB_TABLE_ERR_SQL_UNDEF: in file Table.php, constant DB_TABLE_ERR_SQL_UNDEF
Error code when you call select() or selectResult() and the first parameter does not match any of the $this->sql keys.
DB_TABLE_ERR_TABLE_STRLEN: in file Table.php, constant DB_TABLE_ERR_TABLE_STRLEN
Error code at create() time when the table name is more than 30 chars long (an Oracle restriction).
DB_TABLE_ERR_UPD_COL_NOMAP: in file Table.php, constant DB_TABLE_ERR_UPD_COL_NOMAP
Error code when you try to update data to a column that is not in the $this->col array.
DB_TABLE_ERR_UPD_COL_REQUIRED: in file Table.php, constant DB_TABLE_ERR_UPD_COL_REQUIRED
Error code when you try to update data, and that data does not have a column marked as 'require' in the $this->col array.
DB_TABLE_ERR_UPD_DATA_INVALID: in file Table.php, constant DB_TABLE_ERR_UPD_DATA_INVALID
Error code when auto-validation fails on update data.
DB_TABLE_ERR_VALIDATE_TYPE: in file Table.php, constant DB_TABLE_ERR_VALIDATE_TYPE
Error code at validation time when a column in $this->col has an unrecognized 'type'.
DB_TABLE_ERR_VER_COLUMN_MISSING: in file Table.php, constant DB_TABLE_ERR_VER_COLUMN_MISSING
Error code at verify() time when the column does not exist in the database table.
DB_TABLE_ERR_VER_COLUMN_TYPE: in file Table.php, constant DB_TABLE_ERR_VER_COLUMN_TYPE
Error code at verify() time when the column type does not match the type specified in the column declaration.
DB_TABLE_ERR_VER_IDX_COL_MISSING: in file Table.php, constant DB_TABLE_ERR_VER_IDX_COL_MISSING
Error code at verify() time when an index does not contain all columns that it should contain.
DB_TABLE_ERR_VER_IDX_MISSING: in file Table.php, constant DB_TABLE_ERR_VER_IDX_MISSING
Error code at verify() time when an index cannot be found in the database table.
DB_TABLE_ERR_VER_TABLE_MISSING: in file Table.php, constant DB_TABLE_ERR_VER_TABLE_MISSING
Error code at verify() time when the table does not exist in the database.
DB_Table_Manager_ibase: in file ibase.php, class DB_Table_Manager_ibase
Index, constraint and alter methods for DB_Table usage with PEAR::DB as backend. (Code adopted from PEAR::MDB2)
DB_Table_Manager_mysql: in file mysql.php, class DB_Table_Manager_mysql
Index, constraint and alter methods for DB_Table usage with PEAR::DB as backend. (Code adopted from PEAR::MDB2)
DB_Table_Manager_mysqli: in file mysqli.php, class DB_Table_Manager_mysqli
Index, constraint and alter methods for DB_Table usage with PEAR::DB as backend. (Code adopted from PEAR::MDB2)
DB_Table_Manager_oci8: in file oci8.php, class DB_Table_Manager_oci8
Index, constraint and alter methods for DB_Table usage with PEAR::DB as backend. (Code adopted from PEAR::MDB2)
DB_Table_Manager_pgsql: in file pgsql.php, class DB_Table_Manager_pgsql
Index, constraint and alter methods for DB_Table usage with PEAR::DB as backend. (Code adopted from PEAR::MDB2)
DB_Table_Manager_sqlite: in file sqlite.php, class DB_Table_Manager_sqlite
Index, constraint and alter methods for DB_Table usage with PEAR::DB as backend. (Code adopted from PEAR::MDB2)
DB_Table_QuickForm: in file QuickForm.php, class DB_Table_QuickForm
DB_Table_QuickForm creates HTML_QuickForm objects from DB_Table properties.
DB_Table_Valid: in file Valid.php, class DB_Table_Valid
DB_Table_Valid validates values against DB_Table column types.
delete: in file Table.php, method DB_Table::delete()
Deletes table rows matching a custom WHERE clause.
dropConstraint: in file ibase.php, method DB_Table_Manager_ibase::dropConstraint()
drop existing constraint
dropConstraint: in file pgsql.php, method DB_Table_Manager_pgsql::dropConstraint()
drop existing constraint
dropConstraint: in file mysqli.php, method DB_Table_Manager_mysqli::dropConstraint()
drop existing constraint
dropConstraint: in file sqlite.php, method DB_Table_Manager_sqlite::dropConstraint()
drop existing constraint
dropConstraint: in file oci8.php, method DB_Table_Manager_oci8::dropConstraint()
drop existing constraint
dropConstraint: in file mysql.php, method DB_Table_Manager_mysql::dropConstraint()
drop existing constraint
dropIndex: in file ibase.php, method DB_Table_Manager_ibase::dropIndex()
drop existing index
dropIndex: in file sqlite.php, method DB_Table_Manager_sqlite::dropIndex()
drop existing index
dropIndex: in file pgsql.php, method DB_Table_Manager_pgsql::dropIndex()
drop existing index
dropIndex: in file mysqli.php, method DB_Table_Manager_mysqli::dropIndex()
drop existing index
dropIndex: in file oci8.php, method DB_Table_Manager_oci8::dropIndex()
drop existing index
dropIndex: in file mysql.php, method DB_Table_Manager_mysql::dropIndex()
drop existing index

top

e

$error: in file Table.php, variable DB_Table::$error
If there is an error on instantiation, this captures that error.
example: in file bogotest.php, class example (subpackage: DB_Table)
DB_Table is a database API and data type SQL abstraction class.

top

f

$fetchmode: in file Table.php, variable DB_Table::$fetchmode
When calling select() and selectResult(), use this fetch mode (usually a DB_FETCHMODE_* constant). If null, uses whatever is set in the $db PEAR DB/MDB2 object.
$fetchmode_object_class: in file Table.php, variable DB_Table::$fetchmode_object_class
When fetchmode is DB_FETCHMODE_OBJECT, use this class for each returned row. If null, uses whatever is set in the $db PEAR DB/MDB2 object.
fixColDef: in file QuickForm.php, method DB_Table_QuickForm::fixColDef()
"Fixes" a DB_Table column definition for QuickForm.

top

g

getBlankRow: in file Table.php, method DB_Table::getBlankRow()
Returns a blank row array based on the column map.
getColumns: in file Table.php, method DB_Table::getColumns()
Returns all or part of the $this->col property array.
getElement: in file QuickForm.php, method DB_Table_QuickForm::getElement()
Build a single QuickForm element based on a DB_Table column.
getElements: in file QuickForm.php, method DB_Table_QuickForm::getElements()
Gets controls for a list of columns
getForm: in file QuickForm.php, method DB_Table_QuickForm::getForm()
Build a form based on DB_Table column definitions.
getForm: in file Table.php, method DB_Table::getForm()
Creates and returns a QuickForm object based on table columns.
getFormElement: in file Table.php, method DB_Table::getFormElement()
Creates and returns a single QuickForm element based on a DB_Table column name.
getFormElements: in file Table.php, method DB_Table::getFormElements()
Creates and returns an array of QuickForm elements based on a DB_Table column name.
getFormGroup: in file Table.php, method DB_Table::getFormGroup()
Creates and returns an array of QuickForm elements based on an array of DB_Table column names.
getGroup: in file QuickForm.php, method DB_Table_QuickForm::getGroup()
Build an array of form elements based from DB_Table columns.
getIndexes: in file Table.php, method DB_Table::getIndexes()
Returns all or part of the $this->idx property array.
getPHPTypeAndDBSyntax: in file Table.php, method DB_Table::getPHPTypeAndDBSyntax()
Detect values of 'phptype' and 'dbsyntax' keys of DSN.
getTableConstraintDefinition: in file oci8.php, method DB_Table_Manager_oci8::getTableConstraintDefinition()
get the structure of a constraint into an array
getTableConstraintDefinition: in file pgsql.php, method DB_Table_Manager_pgsql::getTableConstraintDefinition()
get the structure of a constraint into an array
getTableConstraintDefinition: in file mysql.php, method DB_Table_Manager_mysql::getTableConstraintDefinition()
get the structure of a constraint into an array
getTableConstraintDefinition: in file sqlite.php, method DB_Table_Manager_sqlite::getTableConstraintDefinition()
get the structure of a constraint into an array
getTableConstraintDefinition: in file mysqli.php, method DB_Table_Manager_mysqli::getTableConstraintDefinition()
get the structure of a constraint into an array
getTableConstraintDefinition: in file ibase.php, method DB_Table_Manager_ibase::getTableConstraintDefinition()
get the structure of a constraint into an array
getTableIndexDefinition: in file mysqli.php, method DB_Table_Manager_mysqli::getTableIndexDefinition()
get the structure of an index into an array
getTableIndexDefinition: in file pgsql.php, method DB_Table_Manager_pgsql::getTableIndexDefinition()
get the structure of an index into an array
getTableIndexDefinition: in file oci8.php, method DB_Table_Manager_oci8::getTableIndexDefinition()
get the structure of an index into an array
getTableIndexDefinition: in file mysql.php, method DB_Table_Manager_mysql::getTableIndexDefinition()
get the structure of an index into an array
getTableIndexDefinition: in file ibase.php, method DB_Table_Manager_ibase::getTableIndexDefinition()
get the structure of an index into an array
getTableIndexDefinition: in file sqlite.php, method DB_Table_Manager_sqlite::getTableIndexDefinition()
get the structure of an index into an array

top

i

$idx: in file Table.php, variable DB_Table::$idx
Associative array of index definitions.
insert: in file Table.php, method DB_Table::insert()
Inserts a single table row after validating through validInsert().
isBigint: in file Valid.php, method DB_Table_Valid::isBigint()
Check if a value validates against the 'bigint' data type.
isBoolean: in file Valid.php, method DB_Table_Valid::isBoolean()
Check if a value validates against the 'boolean' data type.
isChar: in file Valid.php, method DB_Table_Valid::isChar()
Check if a value validates against the 'char' and 'varchar' data type.
isClob: in file Valid.php, method DB_Table_Valid::isClob()
Check if a value validates against the 'clob' data type.
isDate: in file Valid.php, method DB_Table_Valid::isDate()
Check if a value validates against the 'date' data type.
isDecimal: in file Valid.php, method DB_Table_Valid::isDecimal()
Check if a value validates against the 'decimal' data type.
isDouble: in file Valid.php, method DB_Table_Valid::isDouble()
Check if a value validates against the 'double' data type.
isInteger: in file Valid.php, method DB_Table_Valid::isInteger()
Check if a value validates against the 'integer' data type.
isRequired: in file Table.php, method DB_Table::isRequired()
Is a specific column required to be set and non-null?
isSingle: in file Valid.php, method DB_Table_Valid::isSingle()
Check if a value validates against the 'single' data type.
isSmallint: in file Valid.php, method DB_Table_Valid::isSmallint()
Check if a value validates against the 'smallint' data type.
isTime: in file Valid.php, method DB_Table_Valid::isTime()
Check if a value validates against the 'time' data type.
isTimestamp: in file Valid.php, method DB_Table_Valid::isTimestamp()
Check if a value validates against the 'timestamp' data type.
isValid: in file Table.php, method DB_Table::isValid()
Checks if a value validates against the DB_Table data type for a given column. This only checks that it matches the data type; it does not do extended validation.
ibase.php: procedural page ibase.php
$idx: in file bogotest.php, variable example::$idx (subpackage: DB_Table)

top

l

listTableConstraints: in file ibase.php, method DB_Table_Manager_ibase::listTableConstraints()
list all constraints in a table
listTableConstraints: in file oci8.php, method DB_Table_Manager_oci8::listTableConstraints()
list all constraints in a table
listTableConstraints: in file mysqli.php, method DB_Table_Manager_mysqli::listTableConstraints()
list all constraints in a table
listTableConstraints: in file sqlite.php, method DB_Table_Manager_sqlite::listTableConstraints()
list all constraints in a table
listTableConstraints: in file pgsql.php, method DB_Table_Manager_pgsql::listTableConstraints()
list all constraints in a table
listTableConstraints: in file mysql.php, method DB_Table_Manager_mysql::listTableConstraints()
list all constraints in a table
listTableIndexes: in file pgsql.php, method DB_Table_Manager_pgsql::listTableIndexes()
list all indexes in a table
listTableIndexes: in file sqlite.php, method DB_Table_Manager_sqlite::listTableIndexes()
list all indexes in a table
listTableIndexes: in file mysqli.php, method DB_Table_Manager_mysqli::listTableIndexes()
list all indexes in a table
listTableIndexes: in file ibase.php, method DB_Table_Manager_ibase::listTableIndexes()
list all indexes in a table
listTableIndexes: in file mysql.php, method DB_Table_Manager_mysql::listTableIndexes()
list all indexes in a table
listTableIndexes: in file oci8.php, method DB_Table_Manager_oci8::listTableIndexes()
list all indexes in a table

top

m

modeSupported: in file Table.php, method DB_Table::modeSupported()
Is a creation mode supported for a RDBMS by DB_Table?
mysqli.php: procedural page mysqli.php
mysql.php: procedural page mysql.php
Manager.php: procedural page Manager.php

top

n

nextID: in file Table.php, method DB_Table::nextID()
Generates a sequence value; sequence name defaults to the table name.

top

o

oci8.php: procedural page oci8.php

top

p

pgsql.php: procedural page pgsql.php

top

q

quote: in file Table.php, method DB_Table::quote()
Escapes and enquotes a value for use in an SQL query.
QuickForm.php: procedural page QuickForm.php

top

r

recast: in file Table.php, method DB_Table::recast()
Forces array elements to the proper types for their columns.

top

s

$sql: in file Table.php, variable DB_Table::$sql
Baseline SELECT maps for select(), selectResult(), selectCount().
select: in file Table.php, method DB_Table::select()
Selects rows from the table using one of the DB/MDB2 get*() methods.
selectCount: in file Table.php, method DB_Table::selectCount()
Counts the number of rows which will be returned by a query.
selectResult: in file Table.php, method DB_Table::selectResult()
Selects rows from the table as a DB_Result/MDB2_Result_* object.
setErrorMessage: in file Table.php, method DB_Table::setErrorMessage()
Overwrite one or more error messages, e.g. to internationalize them.
supported: in file Table.php, method DB_Table::supported()
Is a particular RDBMS supported by DB_Table?
sqlite.php: procedural page sqlite.php
$sql: in file bogotest.php, variable example::$sql (subpackage: DB_Table)

top

t

$table: in file Table.php, variable DB_Table::$table
The table or view in the database to which this object binds.
Table.php: procedural page Table.php
throwError: in file Table.php, method DB_Table::throwError()
Specialized version of throwError() modeled on PEAR_Error.

top

u

update: in file Table.php, method DB_Table::update()
Updates table row(s) matching a custom WHERE clause, after checking against validUpdate().

top

v

Valid.php: procedural page Valid.php
validInsert: in file Table.php, method DB_Table::validInsert()
Validates an array for insertion into the table.
validUpdate: in file Table.php, method DB_Table::validUpdate()
Validates an array for updating the table.
verify: in file Table.php, method DB_Table::verify()
Verifies the table based on $this->col and $this->idx.

top