Generic delegate for list widgets (ListWidgetModule) whose contents are determined by database entries of a specific model. More...

Inheritance diagram for CriteriaListWidgetDelegate:

Public Member Functions
	__construct ($oCriteriaDelegate, $sModelName, $sDefaultOrderColumn=null, $sDefaultSortOrder='asc')

	setModelName ($sModelName)

	getModelName ()

	getListSettings ()

	getDelegate ()

	getColumnIdentifiers ()

	__call ($sMethodName, $aArguments)

	getMetadataForColumn ($sColumnIdentifier)

	getCriteria ($bSortIsIrrelevant=false)

	getListContents ($iRowStart=0, $iRowCount=null)

	getCustomListElements ()

	setOrderColumnSort ($sOrderColumn, $sSortOrder)

	getOrderColumnSort ()

	allowSort ($sColumnIdentifier)

	doSort ($sColumnIdentifier, $aRowData, $aRelatedRowData, $sPosition)

	setSearch ($sSearch)

	getSearch ()

	deleteRow ($aRowData)

	rowFromData ($aRowData)

	numberOfRows ()

Public Attributes
const	SELECT_ALL = '__all'

const	SELECT_WITHOUT = '__without'

const	FILTER_TYPE_IS = 'is'

const	FILTER_TYPE_IN = 'in'

const	FILTER_TYPE_BEGINS = 'begins'

const	FILTER_TYPE_CONTAINS = 'contains'

const	FILTER_TYPE_TAG = 'tag'

const	FILTER_TYPE_IS_NULL = 'is_null'

const	FILTER_TYPE_MANUAL = 'manual'

Detailed Description

Generic delegate for list widgets (ListWidgetModule) whose contents are determined by database entries of a specific model.

Usage:

$this->oCriteriaListWidgetDelegate = new CriteriaListWidgetDelegate($this, 'ModelName');

$this->oListWidget = WidgetModule::getWidget('list', null, $this->oCriteriaListWidgetDelegate);

CriteriaListWidgetDelegate still needs its own delegate. The required method for this is getColumnIdentifiers. Optional methods are as follows:

getCriteria to customize the database query
getDatabaseColumnForColumn for columns whose identifier or field_name does not correspond to a database field directly (you only need this if you wish to sort or filter by a column)
getFilterTypeForColumn return one of the given FILTER_TYPE_* constants to allow filtering by a specific column (the column does not need to be displayed). Set the filters using ListWidgetModule::setOption() (also from JavaScript).

Member Function Documentation

CriteriaListWidgetDelegate::getSearch ( )

Searching only works if the ModelNamePeer class has a Method named addSearchToCriteria($sSearchString, $oCriteria) which should set all the necessary search query params on the criteria.

The documentation for this class was generated from the following file:

cms-full/base/lib/classes/CriteriaListWidgetDelegate.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation