Docs For Class DB

object DB_Table DB_Table(
object
&$db, string
$table, [mixed
$create = false])

Constructor.

If there is an error on instantiation, $this->error will be populated with the PEAR_Error.

Access: public

Parameters:

object	`&$db`	—	A PEAR DB object.
string	`$table`	—	The table name to connect to in the database.
mixed	`$create`	—	The automatic table creation mode to pursue: boolean false to not attempt creation, 'safe' to create the table only if it does not exist, or 'drop' to drop any existing table with the same name and re-create it.

[ Top ]

void addFormElements(
object
&$form, [array
$columns = null], [string
$array_name = null])

Adds elements and rules to a pre-existing HTML_QuickForm object.

See: DB_Table_QuickForm
See: HTML_QuickForm
Access: public

Parameters:

object	`&$form`	—	An HTML_QuickForm object.
array	`$columns`	—	A sequential array of column names to use in the form; if null, uses all columns.
string	`$array_name`	—	By default, the form will use the names of the columns as the names of the form elements. If you pass $array_name, the column names will become keys in an array named for this parameter.

[ Top ]

void autoValidInsert(
[bool
$flag = true])

Turn on (or off) automatic validation of inserted data.

Access: public

Parameters:

bool $flag — True to turn on auto-validation, false to turn it off.

[ Top ]

void autoValidUpdate(
[bool
$flag = true])

Turn on (or off) automatic validation of updated data.

Access: public

Parameters:

bool $flag — True to turn on auto-validation, false to turn it off.

[ Top ]

mixed buildSQL(
string
$sqlkey, [string
$filter = null], [string
$order = null], [int
$start = null], [int
$count = null])

Build the SQL command from a specified $this->sql element.

Return: A PEAR_Error on failure, or an SQL command string on success.
Access: public

Parameters:

string	`$sqlkey`	—	The $this->sql key to use as the basis for the SQL query string.
string	`$filter`	—	A filter to add to the WHERE clause of the defined SELECT in $this->sql.
string	`$order`	—	An ORDER clause to override the defined order in $this->sql.
int	`$start`	—	The row number to start listing from in the result set.
int	`$count`	—	The number of rows to list in the result set.

[ Top ]

mixed create(
mixed
$flag)

Create the table based on $this->col and $this->idx.

Return: Boolean false if there was no attempt to create the table, boolean true if the attempt succeeded, or a PEAR_Error if the attempt failed.
See: DB_Table_Manager::create()
Access: public

Parameters:

mixed $flag — Boolean false to abort the create attempt from the start, 'drop' to drop the existing table and re-create it, or 'safe' to only create the table if it does not exist in the database.

[ Top ]

mixed delete(
string
$where)

Delete table rows matching a custom WHERE clause.

Return: Void on success or a PEAR_Error object on failure.
See: DB::query()
Access: public

Parameters:

string $where — The WHERE clause for the delete command.

[ Top ]

array getBlankRow(
)

Return a blank row array based on the column map.

The array keys are the column names, and all values are set to null.

Return: An associative array where the key is column name and the value is null.
Access: public

[ Top ]

mixed getColumns(
[mixed
$col = null])

Returns all or part of the $this->col property array.

Return: All or part of the $this->col property array, or boolean false if no matching column names are found.
Access: public

Parameters:

mixed $col — If null, returns the $this->col property array as it is. If string, returns that column name from the $this->col array. If an array, returns those columns named as the array values from the $this->col array as an array.

[ Top ]

object HTML_QuickForm &getForm(
[array
$columns = null], [string
$array_name = null], [array
$args = array()])

Create and return a QuickForm object based on table columns.

See: DB_Table_QuickForm
See: HTML_QuickForm
Access: public

Parameters:

array $columns — A sequential array of column names to use in the form; if null, uses all columns.

string $array_name — By default, the form will use the names of the columns as the names of the form elements. If you pass $array_name, the column names will become keys in an array named for this parameter.

array

$args

—

An associative array of optional arguments to pass to the QuickForm object. The keys are...

'formName' : String, name of the form; defaults to the name of this table.

'method' : String, form method; defaults to 'post'.

'action' : String, form action; defaults to $_SERVER['REQUEST_URI'].

'target' : String, form target target; defaults to '_self'

'attributes' : Associative array, extra attributes for <form> tag; the key is the attribute name and the value is attribute value.

'trackSubmit' : Boolean, whether to track if the form was submitted by adding a special hidden field

[ Top ]

object HTML_QuickForm_Element &getFormElement(
string
$column, string
$elemname)

Creates and returns a single QuickForm element based on a DB_Table column name.

See: DB_Table_QuickForm
See: HTML_QuickForm
Access: public

Parameters:

string	`$column`	—	A DB_Table column name.
string	`$elemname`	—	The name to use for the generated QuickForm element.

[ Top ]

array &getFormGroup(
[array
$columns = null], [string
$array_name = null])

Creates and returns an array of QuickForm elements based on an array of DB_Table column names.

Return: An array of HTML_QuickForm_Element objects.
See: DB_Table_QuickForm
See: HTML_QuickForm
Access: public

Parameters:

array	`$columns`	—	A sequential array of column names to use in the form; if null, uses all columns.
string	`$array_name`	—	By default, the form will use the names of the columns as the names of the form elements. If you pass $array_name, the column names will become keys in an array named for this parameter.

[ Top ]

array getIndexes(
[mixed
$idx = null], string
$col)

Returns all or part of the $this->idx property array.

Return: All or part of the $this->idx property array.
Access: public

Parameters:

string $col — If specified, returns only this index key from the $this->col property array.

[ Top ]

mixed insert(
array
$data)

Insert a single table row after validating through validInsert().

Return: Void on success, a PEAR_Error object on failure.
See: DB::autoExecute()
See: DB_Table::validInsert()
Access: public

Parameters:

array $data — An associative array of key-value pairs where the key is the column name and the value is the column value. This is the data that will be inserted into the table. Data is checked against the column data type for validity.

[ Top ]

boolean isRequired(
mixed
$column)

Is a specific column required to be set and non-null?

Return: True if required, false if not.
Access: public

Parameters:

mixed $column — The column to check against.

[ Top ]

boolean isValid(
array
$val, array
$col)

Check 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.

Return: True if the value validates (matches the data type), false if not.
See: DB_Table_Valid
Access: public

Parameters:

array	`$val`	—	A value to check against the column's DB_Table data type.
array	`$col`	—	A column name from $this->col.

[ Top ]

integer nextID(
[string
$seq_name = null])

Generate a sequence value; sequence name defaults to the table name.

Return: The next value in the sequence.
See: DB::nextID()
Access: public

Parameters:

string $seq_name — The sequence name; defaults to _table_id.

[ Top ]

string quote(
mixed
$val)

Escape and enquote a value for use in an SQL query.

Helps makes user input safe against SQL injection attack.

Return: The value with quotes escaped, and inside single quotes.
See: DB_Common::quoteSmart()
Access: public

[ Top ]

void recast(
array
&$data)

Force array elements to the proper types for their columns.

This will not valiate the data, and will forcibly change the data to match the recast-type.

The date, time, and timestamp recasting has special logic for arrays coming from an HTML_QuickForm object so that the arrays are converted into properly-formatted strings.

Access: public
Todo: If a column key holds an array of values (say from a multiple select) then this method will not work properly; it will recast the value to the string 'Array'. Is this bad?

Parameters:

array &$data — The data array to re-cast.

[ Top ]

mixed select(
string
$sqlkey, [string
$filter = null], [string
$order = null], [int
$start = null], [int
$count = null])

Select rows from the table using one of the 'DB::get*()' methods.

Return: An array of records from the table (if anything but 'getOne'), a single value (if 'getOne'), or a PEAR_Error object.
See: DB::getRow()
See: DB_Table::_swapModes()
See: DB::getOne()
See: DB::getCol()
See: DB::getAll()
See: DB::getAssoc()
Access: public

Parameters:

string	`$sqlkey`	—	The name of the SQL SELECT to use from the $this->sql property array.
string	`$filter`	—	Ad-hoc SQL snippet to AND with the default SELECT WHERE clause.
string	`$order`	—	Ad-hoc SQL snippet to override the default SELECT ORDER BY clause.
int	`$start`	—	The row number to start listing from in the result set.
int	`$count`	—	The number of rows to list in the result set.

[ Top ]

mixed selectResult(
string
$sqlkey, [string
$filter = null], [string
$order = null], [int
$start = null], [int
$count = null])

Select rows from the table as a DB_Result object.

Return: A PEAR_Error on failure, or a DB_Result object on success.
See: DB_Table::_swapModes()
Access: public

Parameters:

string	`$sqlkey`	—	The name of the SQL SELECT to use from the $this->sql property array.
string	`$filter`	—	Ad-hoc SQL snippet to add to the default SELECT WHERE clause.
string	`$order`	—	Ad-hoc SQL snippet to override the default SELECT ORDER BY clause.
int	`$start`	—	The record number to start listing from in the result set.
int	`$count`	—	The number of records to list in the result set.

[ Top ]

bool supported(
string
$phptype)

Is a particular RDBMS supported by DB_Table?

Return: True if supported, false if not.
Access: public

Parameters:

string $phptype — The RDBMS type for PHP.

[ Top ]

object PEAR_Error &throwError(
string
$code, [string
$extra = null])

Specialized version of throwError() modeled on PEAR_Error.

Throws a PEAR_Error with a DB_Table error message based on a DB_Table constant error code.

Access: public

Parameters:

string	`$code`	—	A DB_Table error code constant.
string	`$extra`	—	Extra text for the error (in addition to the regular error message).

[ Top ]

mixed update(
array
$data, string
$where)

Update table row(s) matching a custom WHERE clause, after checking against validUpdate().

Return: Void on success, a PEAR_Error object on failure.
See: DB::autoExecute()
See: DB_Table::validUpdate()
Access: public

Parameters:

array	`$data`	—	An associative array of key-value pairs where the key is the column name and the value is the column value. These are the columns that will be updated with new values.
string	`$where`	—	An SQL WHERE clause limiting which records are to be updated.

[ Top ]

mixed validInsert(
array
&$data)

Validate an array for insertion into the table.

Return: Boolean true on success, a PEAR_Error object on failure.
See: DB_Table::insert()
Access: public

Parameters:

array $data — An associative array of key-value pairs where the key is the column name and the value is the column value. This is the data that will be inserted into the table. Data is checked against the column data type for validity.

[ Top ]

mixed validUpdate(
array
&$data)

Validate an array for updating the table.

Return: Boolean true on success, a PEAR_Error object on failure.
See: DB_Table::update()
Access: public

Parameters:

array $data — An associative array of key-value pairs where the key is the column name and the value is the column value. This is the data that will be inserted into the table. Data is checked against the column data type for validity.

[ Top ]

array _getFormColDefs(
[string|array
$column_set = null])

Creates a column definition array suitable for DB_Table_QuickForm.

Return: An array of columne defintions suitable for passing to DB_Table_QuickForm.
Access: public

Parameters:

string|array $column_set — A string column name, a sequential array of columns names, or an associative array where the key is a column name and the value is the default value for the generated form element. If null, uses all columns for this class.

[ Top ]

Class: DB_Table

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$col = array()

$db = null

$error = null

$fetchmode = null

$fetchmode_object_class = null

$idx = array()

$sql = array()

$table = null

Method Detail

DB_Table (Constructor) [line 478]

Parameters:

addFormElements [line 1665]

Parameters:

autoValidInsert [line 971]

Parameters:

autoValidUpdate [line 1093]

Parameters:

buildSQL [line 842]

Parameters:

create [line 1436]

Parameters:

delete [line 1178]

Parameters:

getBlankRow [line 1243]

getColumns [line 551]

Parameters:

getForm [line 1633]

Parameters:

getFormElement [line 1725]

Parameters:

getFormGroup [line 1697]

Parameters:

getIndexes [line 601]

Parameters:

insert [line 944]

Parameters:

isRequired [line 1580]

Parameters:

isValid [line 1497]

Parameters:

nextID [line 1198]

Parameters:

quote [line 1224]

recast [line 1280]

Parameters:

select [line 675]

Parameters:

selectResult [line 738]

Parameters:

supported [line 527]

Parameters:

throwError [line 440]

Parameters:

update [line 1066]

Parameters:

validInsert [line 1001]

Parameters:

validUpdate [line 1123]

Parameters:

_getFormColDefs [line 1749]

Parameters: