Docs For Class PNObjectArray

PNObjectArray PNObjectArray(
[init
$init = null], [where
$where = ''])

Constructur, init everything to sane defaults and handle parameters

Parameters:

init	$init	Initialization value (see _init() for details)
where	$where	The where clause to apply to the DB get/select (optional) (default='')

[ Top ]

The clean(
[objArray
$objArray = null])

Clean the acquired input

Tags:

return:

Object Data

Parameters:

objArray

$objArray

The object-array to clean (optional) (default=null, reverts to $this->_objData)

[ Top ]

The delete(
)

Generic delete handler for an object

Tags:

return:

Object Data

Overridden in child classes as:

PNCategoryArray::delete()

Overrides PNObject::delete() (Generic delete handler for an object)

[ Top ]

The deleteWhere(
[where
$where = null])

Delete with a where-clause

Tags:

return:

Object Data

Parameters:

where

$where

The where-clause to use

[ Top ]

The genFilter(
[filter
$filter = array()])

Generate a filter for the array view. Default implementation which can be overridden by subclasses.

Tags:

return:

generated filter (where-clause) string

Overridden in child classes as:

PNLogEventArray::genFilter()

Parameters:

filter

$filter

An array containing the set filter values (optional) (default=array())

[ Top ]

The get(
[where
$where = ''], [sort
$sort = ''], [limitOffset
$limitOffset = -1], [limitNumRows
$limitNumRows = -1], [assocKey
$assocKey = null], [force
$force = false], [distinct
$distinct = false])

Return the current object data. Maps to $this->getWhere().

Tags:

return:

object's data value

Overrides PNObject::get() (Return the current object data. If $key and $field are supplied, the object is fetched again from the database.)

Parameters:

where	$where	The where-clause to use
sort	$sort	The order-by clause to use
limitOffset	$limitOffset	The limiting offset
limitNumRows	$limitNumRows	The limiting number of rows
assocKey	$assocKey	Key field to use for building an associative array (optional) (default=null)
force	$force	whether or not to force a DB-get (optional) (default=false)
distinct	$distinct	whether or not to do a select distinct (optional) (default=false)

[ Top ]

The getCount(
[where
$where = ''], [doJoin
$doJoin = false])

Return the record count for the given object set

Tags:

return:

object's data set count

Parameters:

where	$where	The where-clause to use
doJoin	$doJoin	whether or not to use the auto-join for the count

[ Top ]

The getData(
)

Return the currently set object data

Tags:

return:

object's data array

Overrides PNObject::getData() (Return the currently set object data)

[ Top ]

The getDataField(

$offset, 
$key, [
$default = null])

Generic function to retrieve

Tags:

return:

Object Data

Overrides PNObject::getDataField() (Generic function to retrieve)

Parameters:

	$offset
	$key
	$default

[ Top ]

void getHash(
[
$includeStandardFields = true], [
$objArray = null])

Get the hashcode for this object data array

Overrides PNObject::getHash() (Get the hashcode for this object data)

Parameters:

	$includeStandardFields
	$objArray

[ Top ]

The getSelector(
name
$name, [selected
$selected = -1234], [defaultValue
$defaultValue = 0], [defaultText
$defaultText = ''], [allValue
$allValue = 0], [allText
$allText = ''], [idField
$idField = 'id'], [nameField
$nameField = 'title'], [submit
$submit = false], [ignoreList
$ignoreList = null])

Get a selector for the object array

Tags:

return:

generated selector html text

Parameters:

name	$name	The name of the selector to generate
selected	$selected	The currently selected value (optional) (default=-1234)
defaultValue	$defaultValue	The default value (optional) (default=0)
defaultText	$defaultText	The default text (optional) (default='')
allValue	$allValue	The all-selected value (optional) (default=0)
allText	$allText	The all-selected text (optional) (default='')
idField	$idField	The id field to use (optional) (default='id')
nameField	$nameField	The name field to use (optional) (default='title')
submit	$submit	whether or not to submit the form upon selection (optional) (default=false)
ignoreList	$ignoreList	The list of entries to ignore (default=null)

[ Top ]

The getWhere(
[where
$where = ''], [sort
$sort = ''], [limitOffset
$limitOffset = -1], [limitNumRows
$limitNumRows = -1], [assocKey
$assocKey = null], [force
$force = false], [distinct
$distinct = false])

Return/Select the object using the given where clause.

Tags:

return:

object's data value

Overrides PNObject::getWhere() (Return/Select the object using the given where clause.)

Parameters:

where	$where	The where-clause to use
sort	$sort	The order-by clause to use
limitOffset	$limitOffset	The limiting offset
limitNumRows	$limitNumRows	The limiting number of rows
assocKey	$assocKey	Key field to use for building an associative array (optional) (default=null)
force	$force	whether or not to force a DB-get (optional) (default=false)
distinct	$distinct	whether or not to do a select distinct (optional) (default=false)

[ Top ]

The insert(
)

Generic insert handler for an object (ID is inserted into the object data)

Tags:

return:

Object Data

Overrides PNObject::insert() (Generic insert handler for an object (ID is inserted into the object data))

[ Top ]

The save(
)

Save an object - if it has an ID update it, otherwise insert it

Tags:

return:

result set

Overrides PNObject::save() (Generic insert handler for an object (ID is inserted into the object data). If the object contains a valid ID, it is updated, otherwise it it inserted)

[ Top ]

The select(
[where
$where = ''], [orderBy
$orderBy = ''], [limitOffset
$limitOffset = -1], [limitNumRows
$limitNumRows = -1], [assocKey
$assocKey = false], [distinct
$distinct = false])

Generic select handler for an object. Select (and set) the specified object array

Tags:

return:

selected Object-Array

Overrides PNObject::select() (Select the object from the database using the specified key (and field))

Parameters:

where	$where	The where-clause to use
orderBy	$orderBy	The order-by clause to use
limitOffset	$limitOffset	The limiting offset
limitNumRows	$limitNumRows	The limiting number of rows
assocKey	$assocKey	Key field to use for building an associative array (optional) (default=null)
distinct	$distinct	whether or not to use the distinct clause

[ Top ]

The selectPostProcess(
[
$data = null])

Iterate over the object data and post-process it

Tags:

return:

Object Data

Overridden in child classes as:

PNCategoryArray::selectPostProcess()

Overrides PNObject::selectPostProcess() (Post-Process the newly selected object. Subclasses can define appropriate implementations.)

Parameters:

$data

[ Top ]

void setData(
data
$data)

Set (and return) the object data. Since we dont' have a definitive key, we don't cache

Overrides PNObject::setData() (Set (and return) the object data.)

Parameters:

data

$data

The data to assign

[ Top ]

The update(
)

Generic upate handler for an object

Tags:

return:

Object Data

Overrides PNObject::update() (Generic upate handler for an object)

[ Top ]

Boolean validate(
)

Constructur, init everything to sane defaults and handle parameters

Tags:

return:

indicating whether or not validation passed successfully

Overrides PNObject::validate() (Generic function to validate an object)

[ Top ]

void _init(
[init
$init = null], [where
$where = ''], [orderBy
$orderBy = ''], [assocKey
$assocKey = null])

Internal intialization routine

Overrides PNObject::_init() (Internal intialization routine)

Parameters:

init	$init	Initialization value (can be an object or a string directive) (optional) (default=null)
where	$where	The where clause to use when retrieving the object array (optional) (default='')
orderBy	$orderBy	The order-by clause to use when retrieving the object array (optional) (default='')
assocKey	$assocKey	Key field to use for building an associative array (optional) (default=null) If $init is an arrary it is set(), otherwise it is interpreted as a string specifying the source from where the data should be retrieved from.

[ Top ]

Class: PNObjectArray

Class Overview

Methods

Child classes:

Inherited Variables

Class: PNObject

Inherited Methods

Class: PNObject

Class Details

Class Methods

constructor PNObjectArray [line 28]

Parameters:

method clean [line 369]

Tags:

Parameters:

method delete [line 324]

Tags:

method deleteWhere [line 348]

Tags:

Parameters:

method genFilter [line 137]

Tags:

Parameters:

method get [line 181]

Tags:

Parameters:

method getCount [line 119]

Tags:

Parameters:

method getData [line 192]

Tags:

method getDataField [line 246]

Tags:

Parameters:

method getHash [line 459]

Parameters:

method getSelector [line 404]

Tags:

Parameters:

method getWhere [line 156]

Tags:

Parameters:

method insert [line 280]

Tags:

method save [line 262]

Tags:

method select [line 210]

Tags:

Parameters:

method selectPostProcess [line 236]

Tags:

Parameters:

method setData [line 100]

Parameters:

method update [line 302]

Tags:

method validate [line 441]

Tags:

method _init [line 56]

Parameters: