Inheritance diagram for ORMTable:

Collaboration diagram for ORMTable:

Public Member Functions
	canHaveField ($name)
	Gets if the object can take a certain field.
	count (array $conditions=array(), array $options=array())
	Returns the amount of matching records.
	delete (array $conditions, $functionName=null)
	Removes the object from the database.
	getAPIParams ($requireParams=false, $setDefaults=false)
	Get API parameters for the fields supported by this object.
	getDefaults ()
	Returns a list of default field values.
	getFieldDescriptions ()
	Returns an array with the fields and their descriptions.
	getFieldNames ()
	Return the names of the fields.
	getFieldsFromDBResult (stdClass $result)
	Get an array with fields from a database result, that can be fed directly to the constructor or to setFields.
	getPrefixedField ($field)
	Takes in a field and returns an it's prefixed version, ready for db usage.
	getPrefixedFields (array $fields)
	Takes in a field or array of fields and returns an array with their prefixed versions, ready for db usage.
	getPrefixedValues (array $values)
	Takes in an associative array with field names as keys and their values as value.
	getReadDb ()
	Get the database type used for read operations.
	getSummaryFields ()
	Returns a list of the summary fields.
	has (array $conditions=array())
	Returns if there is at least one record matching the provided conditions.
	newFromArray (array $data, $loadDefaults=false)
	newFromDBResult (stdClass $result)
	newRow (array $data, $loadDefaults=false)
	Get a new instance of the class from an array.
	newRowFromDBResult (stdClass $result)
	Get a new instance of the class from a database result.
	rawSelect ($fields=null, array $conditions=array(), array $options=array(), $functionName=null)
	Do the actual select.
	rawSelectRow (array $fields, array $conditions=array(), array $options=array(), $functionName=null)
	Selects the the specified fields of the records matching the provided conditions.
	select ($fields=null, array $conditions=array(), array $options=array(), $functionName=null)
	Selects the the specified fields of the records matching the provided conditions and returns them as DBDataObject.
	selectFields ($fields=null, array $conditions=array(), array $options=array(), $collapse=true, $functionName=null)
	Selects the the specified fields of the records matching the provided conditions and returns them as associative arrays.
	selectFieldsRow ($fields=null, array $conditions=array(), array $options=array(), $collapse=true, $functionName=null)
	Selects the the specified fields of the first record matching the provided conditions and returns it as an associative array, or false when nothing matches.
	selectObjects ($fields=null, array $conditions=array(), array $options=array(), $functionName=null)
	Selects the the specified fields of the records matching the provided conditions and returns them as DBDataObject.
	selectRow ($fields=null, array $conditions=array(), array $options=array(), $functionName=null)
	Selects the the specified fields of the first matching record.
	setReadDb ($db)
	Set the database type to use for read operations.
	unprefixFieldName ($fieldName)
	Takes a field name with prefix and returns the unprefixed equivalent.
	unprefixFieldNames (array $fieldNames)
	Takes an array of field names with prefix and returns the unprefixed equivalent.
	update (array $values, array $conditions=array())
	Update the records matching the provided conditions by setting the fields that are keys in the $values param to their corresponding values.
	updateSummaryFields ($summaryFields=null, array $conditions=array())
	Computes the values of the summary fields of the objects matching the provided conditions.
Static Public Member Functions
static	singleton ()
	Get an instance of this class.
Protected Member Functions
	getFieldPrefix ()
	Gets the db field prefix.
Protected Attributes
integer	$readDb = DB_SLAVE
	The database connection to use for read operations.
Static Protected Attributes
static	$instanceCache = array()

Detailed Description

Definition at line 30 of file ORMTable.php.

Member Function Documentation

ORMTable::canHaveField ( $ name )

Gets if the object can take a certain field.

Since:: 1.20

Parameters:

string $name

Returns:: boolean

Implements IORMTable.

Definition at line 670 of file ORMTable.php.

ORMTable::count	(	array $	conditions = `array()`,
		array $	options = `array()`
	)

Returns the amount of matching records.

Condition field names get prefixed.

Note that this can be expensive on large tables. In such cases you might want to use DatabaseBase::estimateRowCount instead.

Since:: 1.20

Parameters:

array	$conditions
array	$options

Returns:: integer

Implements IORMTable.

Definition at line 308 of file ORMTable.php.

ORMTable::delete	(	array $	conditions,
		$	functionName = `null`
	)

Removes the object from the database.

Since:: 1.20

Parameters:

array	$conditions
string \| null	$functionName

Returns:: boolean Success indicator

Implements IORMTable.

Definition at line 328 of file ORMTable.php.

ORMTable::getAPIParams	(	$	requireParams = `false`,
		$	setDefaults = `false`
	)

Get API parameters for the fields supported by this object.

Since:: 1.20

Parameters:

boolean	$requireParams
boolean	$setDefaults

Returns:: array

Implements IORMTable.

Definition at line 346 of file ORMTable.php.

ORMTable::getDefaults ( )

Returns a list of default field values.

field name => field value

Since:: 1.20

Returns:: array

Implements IORMTable.

Definition at line 65 of file ORMTable.php.

ORMTable::getFieldDescriptions ( )

Returns an array with the fields and their descriptions.

field name => field description

Since:: 1.20

Returns:: array

Implements IORMTable.

Definition at line 394 of file ORMTable.php.

ORMTable::getFieldNames ( )

Return the names of the fields.

Since:: 1.20

Returns:: array

Implements IORMTable.

Definition at line 657 of file ORMTable.php.

ORMTable::getFieldPrefix ( ) [abstract, protected]

Gets the db field prefix.

Since:: 1.20

Returns:: string

Reimplemented in TestORMTable.

ORMTable::getFieldsFromDBResult ( stdClass $ result )

Get an array with fields from a database result, that can be fed directly to the constructor or to setFields.

Since:: 1.20

Parameters:

stdClass $result

Returns:: array

Implements IORMTable.

Definition at line 585 of file ORMTable.php.

ORMTable::getPrefixedField ( $ field )

Takes in a field and returns an it's prefixed version, ready for db usage.

Since:: 1.20

Parameters:

string | array $field

Returns:: string

Implements IORMTable.

Definition at line 527 of file ORMTable.php.

ORMTable::getPrefixedFields ( array $ fields )

Takes in a field or array of fields and returns an array with their prefixed versions, ready for db usage.

Since:: 1.20

Parameters:

array | string $fields

Returns:: array

Implements IORMTable.

Definition at line 510 of file ORMTable.php.

ORMTable::getPrefixedValues ( array $ values )

Takes in an associative array with field names as keys and their values as value.

The field names are prefixed with the db field prefix.

Since:: 1.20

Parameters:

array $values

Returns:: array

Implements IORMTable.

Definition at line 477 of file ORMTable.php.

ORMTable::getReadDb ( )

Get the database type used for read operations.

Since:: 1.20

Returns:: integer DB_ enum

Implements IORMTable.

Definition at line 405 of file ORMTable.php.

ORMTable::getSummaryFields ( )

Returns a list of the summary fields.

These are fields that cache computed values, such as the amount of linked objects of $type. This is relevant as one might not want to do actions such as log changes when these get updated.

Since:: 1.20

Returns:: array

Implements IORMTable.

Definition at line 78 of file ORMTable.php.

ORMTable::has ( array $ conditions = array() )

Returns if there is at least one record matching the provided conditions.

Condition field names get prefixed.

Since:: 1.20

Parameters:

array $conditions

Returns:: boolean

Implements IORMTable.

Definition at line 290 of file ORMTable.php.

ORMTable::newFromArray	(	array $	data,
		$	loadDefaults = `false`
	)

See also:: ORMTable::newRow

Deprecated:: use newRow instead

Since:: 1.20

Parameters:

array	$data
boolean	$loadDefaults

Returns:: IORMRow

Definition at line 631 of file ORMTable.php.

ORMTable::newFromDBResult ( stdClass $ result )

See also:: ORMTable::newRowFromFromDBResult

Deprecated:: use newRowFromDBResult instead

Since:: 1.20

Parameters:

stdClass $result

Returns:: IORMRow

Definition at line 603 of file ORMTable.php.

ORMTable::newRow	(	array $	data,
		$	loadDefaults = `false`
	)

Get a new instance of the class from an array.

Since:: 1.20

Parameters:

array	$data
boolean	$loadDefaults

Returns:: IORMRow

Implements IORMTable.

Definition at line 645 of file ORMTable.php.

ORMTable::newRowFromDBResult ( stdClass $ result )

Get a new instance of the class from a database result.

Since:: 1.20

Parameters:

stdClass $result

Returns:: IORMRow

Implements IORMTable.

Definition at line 616 of file ORMTable.php.

ORMTable::rawSelect	(	$	fields = `null`,
		array $	conditions = `array()`,
		array $	options = `array()`,
		$	functionName = `null`
	)

Do the actual select.

Since:: 1.20

Parameters:

null \| string \| array	$fields
array	$conditions
array	$options
null \| string	$functionName

Returns:: ResultWrapper

Implements IORMTable.

Definition at line 138 of file ORMTable.php.

ORMTable::rawSelectRow	(	array $	fields,
		array $	conditions = `array()`,
		array $	options = `array()`,
		$	functionName = `null`
	)

Selects the the specified fields of the records matching the provided conditions.

Field names do NOT get prefixed.

Since:: 1.20

Parameters:

array	$fields
array	$conditions
array	$options
string \| null	$functionName

Returns:: ResultWrapper

Implements IORMTable.

Definition at line 241 of file ORMTable.php.

ORMTable::select	(	$	fields = `null`,
		array $	conditions = `array()`,
		array $	options = `array()`,
		$	functionName = `null`
	)

Selects the the specified fields of the records matching the provided conditions and returns them as DBDataObject.

Field names get prefixed.

Since:: 1.20

Parameters:

array \| string \| null	$fields
array	$conditions
array	$options
string \| null	$functionName

Returns:: ORMResult

Implements IORMTable.

Definition at line 95 of file ORMTable.php.

ORMTable::selectFields	(	$	fields = `null`,
		array $	conditions = `array()`,
		array $	options = `array()`,
		$	collapse = `true`,
		$	functionName = `null`
	)

Selects the the specified fields of the records matching the provided conditions and returns them as associative arrays.

Provided field names get prefixed. Returned field names will not have a prefix.

When $collapse is true: If one field is selected, each item in the result array will be this field. If two fields are selected, each item in the result array will have as key the first field and as value the second field. If more then two fields are selected, each item will be an associative array.

Since:: 1.20

Parameters:

array \| string \| null	$fields
array	$conditions
array	$options
boolean	$collapse	Set to false to always return each result row as associative array.
string \| null	$functionName

Returns:: array of array

Implements IORMTable.

Definition at line 178 of file ORMTable.php.

ORMTable::selectFieldsRow	(	$	fields = `null`,
		array $	conditions = `array()`,
		array $	options = `array()`,
		$	collapse = `true`,
		$	functionName = `null`
	)

Selects the the specified fields of the first record matching the provided conditions and returns it as an associative array, or false when nothing matches.

This method makes use of selectFields and expects the same parameters and returns the same results (if there are any, if there are none, this method returns false).

See also:: ORMTable::selectFields

Since:: 1.20

Parameters:

array \| string \| null	$fields
array	$conditions
array	$options
boolean	$collapse	Set to false to always return each result row as associative array.
string \| null	$functionName

Returns:: mixed|array|bool False on failure

Implements IORMTable.

Definition at line 271 of file ORMTable.php.

ORMTable::selectObjects	(	$	fields = `null`,
		array $	conditions = `array()`,
		array $	options = `array()`,
		$	functionName = `null`
	)

Selects the the specified fields of the records matching the provided conditions and returns them as DBDataObject.

Field names get prefixed.

Since:: 1.20

Parameters:

array \| string \| null	$fields
array	$conditions
array	$options
string \| null	$functionName

Returns:: array of self

Implements IORMTable.

Definition at line 113 of file ORMTable.php.

ORMTable::selectRow	(	$	fields = `null`,
		array $	conditions = `array()`,
		array $	options = `array()`,
		$	functionName = `null`
	)

Selects the the specified fields of the first matching record.

Field names get prefixed.

Since:: 1.20

Parameters:

array \| string \| null	$fields
array	$conditions
array	$options
string \| null	$functionName

Returns:: IORMRow|bool False on failure

Implements IORMTable.

Definition at line 219 of file ORMTable.php.

ORMTable::setReadDb ( $ db )

Set the database type to use for read operations.

Parameters:

integer $db

Since:: 1.20

Implements IORMTable.

Definition at line 416 of file ORMTable.php.

static ORMTable::singleton ( ) [static]

Get an instance of this class.

Since:: 1.20

Returns:: IORMTable

Implements IORMTable.

Definition at line 564 of file ORMTable.php.

Referenced by TestORMRowTest\getTableInstance().

ORMTable::unprefixFieldName ( $ fieldName )

Takes a field name with prefix and returns the unprefixed equivalent.

Since:: 1.20

Parameters:

string $fieldName

Returns:: string

Implements IORMTable.

Definition at line 553 of file ORMTable.php.

ORMTable::unprefixFieldNames ( array $ fieldNames )

Takes an array of field names with prefix and returns the unprefixed equivalent.

Since:: 1.20

Parameters:

array $fieldNames

Returns:: array

Implements IORMTable.

Definition at line 540 of file ORMTable.php.

ORMTable::update	(	array $	values,
		array $	conditions = `array()`
	)

Update the records matching the provided conditions by setting the fields that are keys in the $values param to their corresponding values.

Since:: 1.20

Parameters:

array	$values
array	$conditions

Returns:: boolean Success indicator

Implements IORMTable.

Definition at line 432 of file ORMTable.php.

ORMTable::updateSummaryFields	(	$	summaryFields = `null`,
		array $	conditions = `array()`
	)

Computes the values of the summary fields of the objects matching the provided conditions.

Since:: 1.20

Parameters:

array \| string \| null	$summaryFields
array	$conditions

Implements IORMTable.

Definition at line 451 of file ORMTable.php.

Member Data Documentation

ORMTable::$instanceCache = array() [static, protected]

Definition at line 47 of file ORMTable.php.

integer ORMTable::$readDb = DB_SLAVE [protected]

The database connection to use for read operations.

Can be changed via

See also:: setReadDb.

Since:: 1.20 DB_ enum

Definition at line 55 of file ORMTable.php.

The documentation for this class was generated from the following file:

includes/db/ORMTable.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation