Docs For Class KDatabaseRowAbstract

KDatabaseRowAbstract __construct(
[
$config = null])

Constructor

Tags:

access:

public

Overridden in child classes as:

KDatabaseRowTable::__construct(): Object constructor

Overrides KObjectArray::__construct() (Constructor)

Parameters:

object An

$config

optional KConfig object with configuration options.

[ Top ]

integer count(
)

Count the rows in the database based on the data in the row

Tags:

access:

public

Overridden in child classes as:

KDatabaseRowTable::count(): Count the rows in the database based on the data in the row

Implementation of:

KDatabaseRowInterface::count(): Count the rows in the database based on the data in the row

[ Top ]

boolean delete(
)

Deletes the row form the database.

Tags:

return:	If successfull return TRUE, otherwise FALSE
access:	public

Overridden in child classes as:

KDatabaseRowTable::delete(): Deletes the row form the database.

Implementation of:

KDatabaseRowInterface::delete(): Deletes the row form the database.

[ Top ]

array getData(
[boolean
$modified = false])

Returns an associative array of the raw data

Tags:

access:

public

Implementation of:

KDatabaseRowInterface::getData(): Returns an associative array of the raw data

Parameters:

boolean

$modified

If TRUE, only return the modified data. Default FALSE

[ Top ]

string getIdentityColumn(
)

Gets the identitiy column of the rowset

Tags:

access:

public

[ Top ]

array getModified(
)

Get a list of columns that have been modified

Tags:

return:	An array of column names that have been modified
access:	public

Implementation of:

KDatabaseRowInterface::getModified(): Get a list of columns that have been modified

[ Top ]

string getStatus(
)

Returns the status

Tags:

return:	The status
access:	public

Implementation of:

KDatabaseRowInterface::getStatus(): Returns the status of this row.

[ Top ]

string getStatusMessage(
)

Returns the status message

Tags:

return:	The status message
access:	public

[ Top ]

boolean isConnected(
)

Test the connected status of the row.

Tags:

return:	Returns TRUE by default.
access:	public

Overridden in child classes as:

KDatabaseRowTable::isConnected(): Test the connected status of the row.

Implementation of:

KDatabaseRowInterface::isConnected(): Test the connected status of the row.

[ Top ]

boolean isModified(
string
$column)

Check if a column has been modified

Tags:

access:

public

Implementation of:

KDatabaseRowInterface::isModified(): Check if a column has been modified

Parameters:

string

$column

The column name.

[ Top ]

bool isNew(
)

Checks if the row is new or not

Tags:

access:

public

Implementation of:

KDatabaseRowInterface::isNew(): Checks if the row is new or not

[ Top ]

object If load(
)

Load the row from the database.

Tags:

return:	successfull returns the row object, otherwise NULL
access:	public

Overridden in child classes as:

KDatabaseRowTable::load(): Load the row from the database using the data in the row

Implementation of:

KDatabaseRowInterface::load(): Load the row from the database.

[ Top ]

boolean reset(
)

Resets to the default properties

Tags:

return:	If successfull return TRUE, otherwise FALSE
access:	public

Overridden in child classes as:

KDatabaseRowTable::reset(): Reset the row data using the defaults

Implementation of:

KDatabaseRowInterface::reset(): Resets to the default properties

[ Top ]

boolean save(
)

Saves the row to the database.

This performs an intelligent insert/update and reloads the properties with fresh data from the table on success.

Tags:

return:	If successfull return TRUE, otherwise FALSE
access:	public

Overridden in child classes as:

KDatabaseRowTable::save(): Saves the row to the database.

Implementation of:

KDatabaseRowInterface::save(): Saves the row to the database.

[ Top ]

KDatabaseRowAbstract setData(
mixed
$data, [boolean
$modified = true])

Set the row data

Tags:

access:

public

Implementation of:

KDatabaseRowInterface::setData(): Set the row data

Parameters:

mixed	$data	Either and associative array, an object or a KDatabaseRow
boolean	$modified	If TRUE, update the modified information for each column being set. Default TRUE

[ Top ]

KDatabaseRowAbstract setStatus(
string|null
$status)

Set the status

Tags:

access:

public

Parameters:

string|null

$status

The status value or NULL to reset the status

[ Top ]

KDatabaseRowAbstract setStatusMessage(
string
$message)

Set the status message

Tags:

access:

public

Parameters:

string

$message

The status message

[ Top ]

void _initialize(

$config)

Initializes the options for the object

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

Tags:

access:

protected

Overridden in child classes as:

KDatabaseRowTable::_initialize(): Initializes the options for the object

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

Parameters:

object An

$config

optional KConfig object with configuration options.

[ Top ]

mixed __call(
string
$method, array
$arguments)

Search the mixin method map and call the method or trigger an error

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

Overridden in child classes as:

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

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 ]

void __set(
string
$column, mixed
$value)

Set row field value

If the value is the same as the current value and the row is loaded from the database the value will not be reset. If the row is new the value will be (re)set and marked as modified

Tags:

access:

public

Overrides KObjectArray::__set() (Set a value by key)

Parameters:

string	$column	The column name.
mixed	$value	The value for the property.

[ Top ]

void __unset(
string
$column)

Unset a row field

Tags:

access:

public

Overridden in child classes as:

KDatabaseRowTable::__unset(): Unset a row field

Overrides KObjectArray::__unset() (Unset a key)

Parameters:

string

$column

The column name.

[ Top ]

Class: KDatabaseRowAbstract

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Class: KObjectArray

Class: KObject

Inherited Methods

Class: KObjectArray

Class: KObject

Class Details

Tags:

Class Variables

$_identity_column =

Tags:

$_modified = array()

Tags:

$_new = true

Tags:

$_status = null

Tags:

$_status_message = ''

Tags:

Class Methods

constructor __construct [line 64]

Tags:

Parameters:

method count [line 286]

Tags:

method delete [line 263]

Tags:

method getData [line 135]

Tags:

Parameters:

method getIdentityColumn [line 330]

Tags:

method getModified [line 340]

Tags:

method getStatus [line 181]

Tags:

method getStatusMessage [line 213]

Tags:

method isConnected [line 124]

Tags:

method isModified [line 351]

Tags:

Parameters:

method isNew [line 366]

Tags:

method load [line 236]

Tags:

method reset [line 273]

Tags:

method save [line 251]

Tags:

method setData [line 154]

Tags:

Parameters:

method setStatus [line 192]

Tags:

Parameters:

method setStatusMessage [line 225]

Tags:

Parameters:

method _initialize [line 106]

Tags:

Parameters:

method __call [line 383]

Tags:

Parameters:

method __set [line 302]

Tags:

Parameters:

method __unset [line 318]

Tags:

Parameters: