Class windowList

Description

This class need to be the motherclass in your framework classes, which are defined via the window links in your extension.

Located in /windowList.class.php (line 14)


	
			
Variable Summary
boolean $add
array $columns
boolean $edit
string $iconAdd
string $iconDelete
string $iconEdit
integer $itemsPerPage
boolean $navigation
mixed $orderBy
array $primary
boolean $remove
string $table
Method Summary
windowList __construct ()
array acl (array $pItem)
string countSql ()
bool deleteItem ()
void exportItems ()
datatype filterSql ()
array getItems ()
object this init ()
void load ()
void myconstruct ()
boolean removeSelected ()
string sql ([bool $pCountSql = false])
string where ()
void _removeN2N (datatype $pVal)
Variables
boolean $add = false (line 66)

Defines whether the add button should be displayed

  • access: public
array $columns = array() (line 37)

Defines the columns of your table which should be displayed.

  • abstract:
  • access: public
boolean $edit = false (line 77)

Defines whether the edit button should be displayed

  • access: public
string $iconAdd = 'add.png' (line 51)

Defines the icon for the add button

  • var: name of image
  • access: public
string $iconDelete = 'delete.png' (line 61)

Defines the icon for the remove/delete button

  • var: name of image
  • access: public
string $iconEdit = 'page_white_edit.png' (line 56)

Defines the icon for the edit button

  • var: name of image
  • access: public
integer $itemsPerPage = 10 (line 42)

Defines how many rows should be displayed per page.

  • var: number of rows per page
  • access: public
bool $multiLanguage = false (line 90)

Defines whether the list windows should display the language select box.

Note: Your table need a field 'lang' varchar(2). The windowList class filter by this.

  • access: public
boolean $navigation = false (line 82)

TBD

  • access: public
mixed $orderBy = '' (line 44)
  • access: public
mixed $orderByDirection = 'ASC' (line 45)
  • access: public
array $primary = array() (line 31)

Defines your primary fiels as a array.

Example: $primary = array('rsn'); Example: $primary = array('id', 'name');

  • abstract:
  • access: public
boolean $remove = false (line 72)

Defines whether the remove/delete button should be displayed Also on each row the Delete-Button and the checkboxes.

  • access: public
string $table = '' (line 22)

Defines the table which should be accessed.

This variable has to be set by any subclass.

  • var: table name
  • abstract:
  • access: public
Methods
Constructor __construct (line 107)

Constructor

windowList __construct ()
acl (line 434)

Each item go through this function in getItems(). Defines whether a item is editable or deleteable.

array acl (array $pItem)
  • array $pItem
countSql (line 321)

Returns the SQL for counting all items.

  • return: SQL
string countSql ()
deleteItem (line 137)

Deletes the Item from the database which is specified in the request

bool deleteItem ()
exportItems (line 392)

Build and send the items via specified exportType to the client.

void exportItems ()
filterSql (line 198)

Build a WHERE clause for search functionality.

datatype filterSql ()
getItems (line 329)

Gets all Items for getArvg('page')

array getItems ()
init (line 96)

TBD

  • return: object
object this init ()
load (line 129)

Loads all entries from $table

void load ()
myconstruct (line 114)

TBD

void myconstruct ()
removeSelected (line 159)

Removes selected files from database.

boolean removeSelected ()
sql (line 246)

Builds the complete SQL for all items.

string sql ([bool $pCountSql = false])
  • bool $pCountSql: Defines whether the SQL is used for counting or not
where (line 237)

Defines a extra filter in WHERE. Starting with "AND "

string where ()
_removeN2N (line 185)

Remove all related database entries from selected item.

void _removeN2N (datatype $pVal)
  • datatype $pVal

Documentation generated on Tue, 18 Jan 2011 23:34:39 +0100 by phpDocumentor 1.4.3