Docs For Class KDatabaseTableAbstract

constructor __construct [line 71]

KDatabaseTableAbstract __construct(
[
$config = null])

Object constructor

Tags:

access:

public

Overrides KObject::__construct() (Constructor)

Parameters:

object An

$config

optional KConfig object with configuration options.

[ Top ]

method count [line 564]

int count(
[mixed
$query = null])

Count table rows

Tags:

return:	Number of rows
access:	public

Parameters:

mixed

$query

KDatabaseQuery object or query string or null to count all rows

[ Top ]

method delete [line 706]

bool|integer delete(
KDatabaseRowInterface
$row)

Table delete method

Tags:

return:	Returns the number of rows deleted, or FALSE if delete query was not executed.
access:	public

Parameters:

object A

$row

KDatabaseRow object

[ Top ]

method filter [line 815]

array filter(
boolean
$data, [array
$base = true])

Table filter method

This function removes extra columns based on the table columns taking any table mappings into account and filters the data based on each column type.

Tags:

return:	The filtered data array
access:	public

Parameters:

boolean	$data	If TRUE, get the column information from the base table. Default is TRUE.
array	$base	An associative array of data to be filtered

[ Top ]

method getBase [line 206]

string getBase(
)

Gets the base table name without the table prefix

If the table type is 'VIEW' the base name will be the name of the base table that is connected to the view. If the table type is 'BASE' this function will return the same as getName

Tags:

access:

public

[ Top ]

method getColumn [line 260]

KDatabaseColumn getColumn(
boolean
$columnname, [
$base = false])

Get a column by name

Tags:

return:	Returns a KDatabaseSchemaColumn object or NULL if the column does not exist
access:	public

Parameters:

boolean	$columnname	If TRUE, get the column information from the base table. Default is FALSE.
	$base

[ Top ]

method getColumns [line 273]

array getColumns(
[boolean
$base = false])

Gets the columns for the table

Tags:

return:	Associative array of KDatabaseSchemaColumn objects
throws:	KDatabaseTableException
access:	public

Parameters:

boolean

$base

If TRUE, get the column information from the base table. Default is FALSE.

[ Top ]

method getDatabase [line 160]

KDatabaseAdapterAbstract getDatabase(
)

Get the database adapter

Tags:

access:

public

[ Top ]

method getDefault [line 400]

mixed getDefault(

$columnname)

Get a default by name

Tags:

return:	Returns the column default value or NULL if the column does not exist
access:	public

Parameters:

$columnname

[ Top ]

method getDefaults [line 377]

array getDefaults(
)

Get default values for all columns

Tags:

access:

public

[ Top ]

method getIdentityColumn [line 342]

string getIdentityColumn(
)

Gets the identitiy column of the table.

Tags:

access:

public

[ Top ]

method getName [line 192]

string getName(
)

Gets the table schema name without the table prefix

Tags:

access:

public

[ Top ]

method getPrimaryKey [line 216]

array getPrimaryKey(
)

Gets the primary key(s) of the table

Tags:

return:	An asscociate array of fields defined in the primary key
access:	public

[ Top ]

method getRow [line 412]

KDatabaseRowInterface getRow(
[
$options = array()])

Get an instance of a row object for this table

Tags:

access:

public

Parameters:

array

$options

An optional associative array of configuration settings.

[ Top ]

method getRowset [line 431]

KDatabaseRowInterface getRowset(
[
$options = array()])

Get an instance of a rowset object for this table

Tags:

access:

public

Parameters:

array

$options

An optional associative array of configuration settings.

[ Top ]

method getSchema [line 237]

object|null getSchema(
)

Gets the schema of the table

Tags:

return:	Returns a KDatabaseSchemaTable object or NULL if the table doesn't exists
throws:	KDatabaseTableException
access:	public

[ Top ]

method getUniqueColumns [line 357]

array getUniqueColumns(
)

Gets the unqiue columns of the table

Tags:

return:	An asscociate array of unique table columns by column name
access:	public

[ Top ]

method insert [line 603]

bool|integer insert(
KDatabaseRowInterface
$row)

Table insert method

Tags:

return:	Returns the number of rows inserted, or FALSE if insert query was not executed.
access:	public

Parameters:

object A

$row

KDatabaseRow object

[ Top ]

method isConnected [line 182]

boolean isConnected(
)

Test the connected status of the table

Tags:

return:	Returns TRUE if we have a reference to a live KDatabaseAdapterAbstract object.
access:	public

[ Top ]

method lock [line 750]

void lock(
)

Lock the table.

return boolean True on success, false otherwise.

Tags:

access:

public

[ Top ]

method mapColumns [line 293]

array|string mapColumns(
array|string
$data, [boolean
$reverse = false])

Table map method

This functions maps the column names to those in the table schema

Tags:

return:	The mapped data or column name
access:	public

Parameters:

array\|string	$data	An associative array of data to be mapped, or a column name
boolean	$reverse	If TRUE, perform a reverse mapping

[ Top ]

method select [line 456]

KDatabaseRow select(
[mixed
$query = null], [integer
$mode = KDatabase::FETCH_ROWSET])

Table select method

The name of the resulting row(set) class is based on the table class name eg Com<Mycomp>Table<Tablename> -> Com<Mycomp>Row(set)<Tablename>

This function will return an empty rowset if called without a parameter.

Tags:

return:	or KDatabaseRowset depending on the mode. By default will return a KDatabaseRowset
access:	public

Parameters:

mixed	$query	KDatabaseQuery, query string, array of row id's, or an id or null
integer	$mode	The database fetch style. Default FETCH_ROWSET.

[ Top ]

method setDatabase [line 171]

KDatabaseTableAbstract setDatabase(
KDatabaseAdapterAbstract
$database)

Set the database adapter

Tags:

access:

public

Parameters:

object A

$database

KDatabaseAdapterAbstract

[ Top ]

method unlock [line 780]

void unlock(
)

Unlock the table.

return boolean True on success, false otherwise.

Tags:

access:

public

[ Top ]

method update [line 651]

boolean|integer update(
KDatabaseRowInterface
$row)

Table update method

Tags:

return:	Returns the number of rows updated, or FALSE if insert query was not executed.
access:	public

Parameters:

object A

$row

KDatabaseRow object

[ Top ]

method _initialize [line 132]

void _initialize(

$config)

Initializes the options for the object

Called from __construct() as a first step of object instantiation.

Tags:

access:

protected

Overrides KObject::_initialize() (Initializes the options for the object)

Parameters:

object An

$config

optional KConfig object with configuration options.

[ Top ]

method __call [line 842]

mixed __call(
string
$method, array
$arguments)

Search the behaviors to see if this table behaves as.

Function is also capable of checking is a behavior has been mixed succesfully using is[Behavior] function. If the behavior exists the function will return TRUE, otherwise FALSE.

Tags:

return:	The result of the function
throws:	BadMethodCallException If method could not be found
access:	public

Overrides KObject::__call() (Search the mixin method map and call the method or trigger an error)

Parameters:

string	$method	The function name
array	$arguments	The function arguments

[ Top ]

Class: KDatabaseTableAbstract

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Class: KObject

Inherited Methods

Class: KObject

Class Details

Tags:

Class Variables

$_base =

Tags:

$_column_map = array()

Tags:

$_database = false

Tags:

$_defaults =

Tags:

$_identity_column =

Tags:

$_name =

Tags:

Class Methods

constructor __construct [line 71]

Tags:

Parameters:

method count [line 564]

Tags:

Parameters:

method delete [line 706]

Tags:

Parameters:

method filter [line 815]

Tags:

Parameters:

method getBase [line 206]

Tags:

method getColumn [line 260]

Tags:

Parameters:

method getColumns [line 273]

Tags:

Parameters:

method getDatabase [line 160]

Tags:

method getDefault [line 400]

Tags:

Parameters:

method getDefaults [line 377]

Tags:

method getIdentityColumn [line 342]

Tags:

method getName [line 192]

Tags:

method getPrimaryKey [line 216]

Tags:

method getRow [line 412]

Tags:

Parameters:

method getRowset [line 431]

Tags:

Parameters:

method getSchema [line 237]

Tags:

method getUniqueColumns [line 357]

Tags:

method insert [line 603]

Tags:

Parameters:

method isConnected [line 182]

Tags:

method lock [line 750]

Tags:

method mapColumns [line 293]

Tags:

Parameters:

method select [line 456]