ForwardFW
[ class tree: ForwardFW ] [ index: ForwardFW ] [ all elements ]

Class: ForwardFW_List

Source Location: /List.php

Class Overview

ArrayObject
   |
   --ForwardFW_List

This is the basic List class for ForwardFW Object


Author(s):

Variables

Methods


Child classes:

ForwardFW_List_Sql
A list of models that can load themself from DB.
ForwardFW_List_Timer
A list of Timer models.

Inherited Constants

Class: ArrayObject (Internal Class)

ARRAY_AS_PROPS = 2
STD_PROP_LIST = 1

Inherited Methods

Class: ArrayObject (Internal Class)

constructor __construct ( $array )
append ( $value )
asort ( )
count ( )
exchangeArray ( $array )
getArrayCopy ( )
getFlags ( )
getIterator ( )
getIteratorClass ( )
ksort ( )
natcasesort ( )
natsort ( )
offsetExists ( $index )
offsetGet ( $index )
offsetSet ( $index, $newval )
offsetUnset ( $index )
serialize ( )
setFlags ( $flags )
setIteratorClass ( $iteratorClass )
uasort ( $cmp_function )
uksort ( $cmp_function )
unserialize ( $serialized )

Class Details

[line 45]
This is the basic List class for ForwardFW Object



Tags:



[ Top ]


Class Variables

$strObjectName =  ''

[line 52]

Name of the object this list will manage



Tags:

access:  protected

Type:   string


[ Top ]



Class Methods


constructor __construct [line 59]

void __construct( )

Constructor



Tags:

access:  public


Overridden in child classes as:

ForwardFW_List_Sql::__construct()
constructor

Overrides ArrayObject::constructor __construct ( $array ) (parent method not documented)

[ Top ]

method addObjectByArray [line 145]

void addObjectByArray( array $arObject)

Creates a new object of the List type, loads it with the array information and add it to the list.



Tags:

access:  public


Parameters:

array   $arObject   An Array which have fill up Data for the object

[ Top ]

method addToList [line 102]

boolean addToList( ForwardFW_Object $obj)

Adds object to the list



Tags:

return:  if $obj could be add to the list
access:  public


Parameters:

ForwardFW_Object   $obj   The object which should be add

[ Top ]

method createNew [line 73]

ForwardFW_Object createNew( )

Creates a new object of type $strObjectName which won't be added to list and returns this object.



Tags:

return:  The created Base_Object
access:  public


[ Top ]

method createNewToList [line 86]

ForwardFW_Object createNewToList( )

Creates a new Object of type $strObjectName, adds it to the list and returns the object



Tags:

access:  public


[ Top ]

method getObjectName [line 210]

string getObjectName( )

Returns the Name of the objects this list will manage



Tags:

return:  Name of the objects
access:  public


[ Top ]

method isUseable [line 182]

boolean isUseable( ForwardFW_Object $obj)

Examines if the given object is from typet this list will hold.



Tags:

return:  True if given object can be managed by this list otherwise false.
access:  public


Parameters:

ForwardFW_Object   $obj   Object to examine

[ Top ]

method loadByArray [line 162]

void loadByArray( array $arData)

Loads an array to this list. The array needs to hold arrays with the data of the object.



Tags:

access:  public


Parameters:

array   $arData   the array with the objects for this list.

[ Top ]

method removeFromList [line 121]

boolean removeFromList( $obj)

Removes given Object from List and returns state if it was in list.



Tags:

return:  True if object could be removed otherwise false


Parameters:

ForwardFW_Object   $obj   The object that should be removed from list.

[ Top ]

method sort [line 198]

void sort( )

Sorts the array



Tags:

access:  public


[ Top ]


Documentation generated on Sun, 30 Jan 2011 20:46:43 +0100 by phpDocumentor 1.4.3