[ class tree: ] [ index: ] [ all elements ]

Index of all elements

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

a

addElements
in file QuickForm.php, method DB_Table_QuickForm::addElements()
    Adds DB_Table columns 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.
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

buildSQL
in file Table.php, method DB_Table::buildSQL()
    Builds the SQL command from a specified $this->sql element.
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.
create
in file Manager.php, method DB_Table_Manager::create()
    Create the table based on DB_Table column and index arrays.
top

d

$db
in file Table.php, variable DB_Table::$db
    The PEAR DB object that connects to the database.
DB_Table
in file Table.php, method DB_Table::DB_Table()
    Constructor.
DB_Table
in file Table.php, class DB_Table
    DB_Table is a database API and data type SQL abstraction class.
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', or boolean false.
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_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_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_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_PHPTYPE
in file Table.php, constant DB_TABLE_ERR_PHPTYPE
    Error code at instantiation time when the PEAR DB $phptype is not supported by DB_Table.
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_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_Manager
in file Manager.php, class DB_Table_Manager
    Creates tables from DB_Table definitions.
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.
top

e

$error
in file Table.php, variable DB_Table::$error
    If there is an error on instantiation, this captures that error.
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 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 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.
getDeclare
in file Manager.php, method DB_Table_Manager::getDeclare()
    Get the column declaration string for a DB_Table column.
getElement
in file QuickForm.php, method DB_Table_QuickForm::getElement()
    Build a single QuickForm element based on a DB_Table column.
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.
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.
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.
top

m

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

q

QuickForm.php
procedural page QuickForm.php
quote
in file Table.php, method DB_Table::quote()
    Escapes and enquotes a value for use in an SQL query.
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 SQL SELECT mappings for select() and selectResult().
select
in file Table.php, method DB_Table::select()
    Selects rows from the table using one of the 'DB::get*()' methods.
selectResult
in file Table.php, method DB_Table::selectResult()
    Selects rows from the table as a DB_Result object.
supported
in file Table.php, method DB_Table::supported()
    Is a particular RDBMS supported by 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.
top

_

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

Documentation generated on Mon, 11 Mar 2019 13:52:54 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.