Class: ForwardFW_List_Sql

Source Location: /List/Sql.php

Class Overview

ArrayObject
   |
   --ForwardFW_List
      |
      --ForwardFW_List_Sql

A list of models that can load themself from DB.

Author(s):

Alexander Opitz <opitz.alexander@primacom.net>

Variables

Methods

Inherited Variables

Class: ForwardFW_List

ForwardFW_List::$strObjectName

Inherited Methods

Class: ForwardFW_List

ForwardFW_List::__construct(): Constructor
ForwardFW_List::addObjectByArray(): Creates a new object of the List type, loads it with the array information and add it to the list.
ForwardFW_List::addToList(): Adds object to the list
ForwardFW_List::createNew(): Creates a new object of type $strObjectName which won't be added to list and returns this object.
ForwardFW_List::createNewToList(): Creates a new Object of type $strObjectName, adds it to the list and returns the object
ForwardFW_List::getObjectName(): Returns the Name of the objects this list will manage
ForwardFW_List::isUseable(): Examines if the given object is from typet this list will hold.
ForwardFW_List::loadByArray(): Loads an array to this list. The array needs to hold arrays with the data of the object.
ForwardFW_List::removeFromList(): Removes given Object from List and returns state if it was in list.
ForwardFW_List::sort(): Sorts the array

Class Details

[line 47]
A list of models that can load themself from DB.

Tags:

author:	Alexander Opitz <opitz.alexander@primacom.net>
link:	http://forwardfw.sourceforge.net
license:	GNU General Public License

[ Top ]

Class Variables

$strDBConnection = ''

[line 71]

Name of the connection which should be used for this object to load/save.

Tags:

access:

protected

Type:

string

[ Top ]

$strTableName = ''

[line 55]

Name of the table, which is mostly a prefix and the object name in lowercase.

Tags:

access:

protected

Type:

string

[ Top ]

$strTablePrefix = ''

[line 63]

Prefix for the table name

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

constructor __construct [line 81]

new __construct(
[string
$_strTablePrefix = ''], [string
$_strDBConnection = 'default'])

constructor

Tags:

return:

instance

Overrides ForwardFW_List::__construct() (Constructor)

Parameters:

string	$_strTablePrefix	Prefix der Tabellennamen im Projekt.
string	$_strDBConnection	Name of the DB connection to use.

[ Top ]

method loadAll [line 98]

boolean loadAll(
)

Loads all data from given table.

Tags:

return:

True if object was loadable otherwise false.

[ Top ]

method loadByWhereClause [line 113]

boolean loadByWhereClause(
string
$strWhereClause, [string
$strGroupBy = ''], [string
$strOrderBy = ''], [string
$strLimit = ''])

Loads all data from given table by given where clause.

Tags:

return:

True if object was loadable otherwise false.

Parameters:

string	$strWhereClause	Where clause for the select.
string	$strGroupBy	Group by clause for the select.
string	$strOrderBy	Order by clause for the select.
string	$strLimit	Limit clause for the select.

[ Top ]

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