Inheritance diagram for AsyncPagingController:

Public Member Functions
	hasView ()

	executeKernel ()

	getObjects ($type, $filter, $sortArray, &$pagingInfo)

	getOIDs ($type, $filter, $sortArray, &$pagingInfo)

	getSortingProperties ()

	modifyModel (&$nodes)

	sortByRealSubject ($a, $b)

Public Member Functions inherited from Controller
	Controller (&$delegate)

	initialize (&$request, &$response)

	validate ()

	hasView ()

	execute ()

	executeKernel ()

	getErrorMsg ()

	setErrorMsg ($msg)

	appendErrorMsg ($msg)

&	getRequest ()

&	getResponse ()

&	getView ()

&	getDelegate ()

	getViewTemplate ($controller, $context, $action)

	getCacheId ()

	assignViewDefaults (&$view)

	isLocalizedRequest ()

Public Attributes
	$_sortProperties = null

Public Attributes inherited from Controller
	$_request = null

	$_response = null

	$_errorMsg = ''

	$_view = null

	$_delegate = null

Detailed Description

AsyncPagingController is a controller that allows to navigate lists.

Licensed under the terms of any of the following licenses at your choice:

GNU Lesser General Public License (LGPL) http://www.gnu.org/licenses/lgpl.html
Eclipse Public License (EPL) http://www.eclipse.org/org/documents/epl-v10.php

See the license.txt file distributed with this work for additional information.

Id:: class.AsyncPagingController.php 1462 2014-02-04 23:52:27Z iherwig

Input actions:

unspecified: List nodes

Output actions:

ok In any case

Parameters

[in]	type	The entity type to list
[in]	filter	A query passed to ObjectQuery::executeString()
[in]	limit	The page size of the used PagingInfo
[in]	start	The start index used to initialize the used PagingInfo
[in]	sort	The attribute to order the entities by
[in]	dir	The direction to use to order (ASC\|DESC)
[in]	poid	The parent object id of the entities if any (this is used to set relation information on the result)
[in]	renderValues	True/False wether to render the values using NodeUtil::renderValues or not (optional, default: false)
[in]	completeObjects	True/False wether to return all object attributes objects or only the display values using NodeUtil::removeNonDisplayValues (optional, default: false)
[out]	totalCount	The total number of all entities that match the criteria
[out]	objects	An array of entities of the specified type Additional properties are 'realSubject', 'realSubjectType' and 'composition' for many-to-many entities and 'clientOID'

Author: ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 54 of file class.AsyncPagingController.php.

Member Function Documentation

AsyncPagingController::hasView ( )

See Also: Controller::hasView()

Definition at line 61 of file class.AsyncPagingController.php.

AsyncPagingController::executeKernel ( )

Do processing and assign Node data to View.

Returns: False in every case.

See Also: Controller::executeKernel()

Definition at line 70 of file class.AsyncPagingController.php.

References ACTION_READ, RightsManager\getInstance(), Localization\getInstance(), getObjects(), getSortingProperties(), Controller\isLocalizedRequest(), modifyModel(), PagingInfo\setIndex(), and Obfuscator\unveil().

Here is the call graph for this function:

AsyncPagingController::getObjects	(		$type,
			$filter,
			$sortArray,
		&	$pagingInfo
	)

Get the object to display. The default implementation uses ObjectQuery::executeString for the object retrieval. Subclasses may override this. If filter is an empty string, all nodes of the given type will be selected.

Parameters

type	The object type
filter	The filter query passed from the view (a serialized ObjectQuery).
sortArray	An array of attributes to order by (with an optional ASC\|DESC appended)
pagingInfo	A reference to the current paging information (Paginginfo instance)

Returns: An array of object instances

Definition at line 146 of file class.AsyncPagingController.php.

References BUILDDEPTH_SINGLE, ObjectQuery\executeString(), NodeUtil\getNodeQuery(), getSortingProperties(), and PersistenceFacade\isKnownType().

Referenced by executeKernel().

Here is the call graph for this function:

AsyncPagingController::getOIDs	(		$type,
			$filter,
			$sortArray,
		&	$pagingInfo
	)

Deprecated:

Definition at line 167 of file class.AsyncPagingController.php.

References WCMFException\throwEx().

Here is the call graph for this function:

AsyncPagingController::getSortingProperties ( )

Get the sorting properties from the 'sort', 'dir' request parameters. The type is guessed from the sort parameter (if it has the form type.attribute or the attribute belongs to the type given in the 'type' request parameter)