ListboxFunctions.php File Reference

Go to the source code of this file.

Functions
	g_getOIDs ($type, $queryStr=null, $orderbyStr=null, $realOIDs=false, $language=null)
	g_getObjects ($type, $parentOID)
	g_getTypes ()
	g_getOIDArray ($oidStringList)
	g_getConfigFiles ()
	g_getBackupNames ()

Variables
	$g_oidArray = array()

Function Documentation

g_getOIDs	(		$type,
			$queryStr = null,
			$orderbyStr = null,
			$realOIDs = false,
			$language = null
	)

wCMF - wemove Content Management Framework Copyright (C) 2005-2014 wemove digital solutions GmbH

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:

ListboxFunctions.php 1462 2014-02-04 23:52:27Z iherwig

Global function for id (oid) retrieval. For parameters see PersistenceFacade::getOIDs(). If the type is a Node the display value for an oid is defined by the 'display_value' property of the corresponding type. If not given the oid is displayed.

Parameters

type	The type to retrieve the ids (oids) for
queryStr	A query to be used with StringQuery [default: null]
orderbyStr	String with comma separated list of attributes to use for sorting e.g. 'Author.name ASC, Author.created DESC' [default: null]
realOIDs	True/False indicates wether to fetch ids (false) or oids (true) [default: false]
language	A language code if the returned data should be localized, optional [default: null]

Returns

An assoziative array with the database ids (or object ids depending on the last parameter) as keys and the display values as values

Note

This function is especially useful as fkt parameter for list input type see FormUtil::getInputControl()

Definition at line 39 of file ListboxFunctions.php.

References BUILDDEPTH_SINGLE, PersistenceFacade\composeOID(), PersistenceFacade\createStringQuery(), PersistenceFacade\getInstance(), Localization\getInstance(), PersistenceFacade\getOIDParameter(), PersistenceFacade\isKnownType(), and WCMFException\throwEx().

Referenced by ListboxController\executeKernel().

Here is the call graph for this function:

g_getObjects	(		$type,
			$parentOID
	)

Global function that retrieves all oids of a given type that may be assoziated with a given parent (except for those that are already assoziated). This method is used to fill listboxes in the assoziated view.

Returns

An associative array of object ids (key: oid, value: display value)

Definition at line 97 of file ListboxFunctions.php.

References BUILDDEPTH_SINGLE, PersistenceFacade\createObjectQuery(), PersistenceFacade\getInstance(), PersistenceFacade\isKnownType(), PersistenceFacade\isValidOID(), and WCMFException\throwEx().

Here is the call graph for this function:

g_getTypes

(

)

Global function that retrieves all entity types. This method is used to fill listboxes in the assoziated view.

Returns

An associative array of type names (key: type, value: dispaly name)

Definition at line 134 of file ListboxFunctions.php.

References BUILDDEPTH_SINGLE, PersistenceFacade\getInstance(), and PersistenceFacade\getKnownTypes().

Here is the call graph for this function:

g_getOIDArray

(

$oidStringList

)

Definition at line 153 of file ListboxFunctions.php.

References $g_oidArray, BUILDDEPTH_SINGLE, PersistenceFacade\getInstance(), and PersistenceFacade\isValidOID().

Here is the call graph for this function:

g_getConfigFiles

(

)

Global function that retrieves all config files. This method is used to fill listboxes in the assoziated view.

Returns

An associative array of config file names (key: filename, value: filename)

Definition at line 184 of file ListboxFunctions.php.

References WCMFInifileParser\getIniFiles().

Here is the call graph for this function:

g_getBackupNames

(

)

Global function for backup name retrieval.

Returns

An array of backup names

Definition at line 201 of file ListboxFunctions.php.

References InifileParser\getInstance(), and WCMFException\throwEx().

Here is the call graph for this function:

Variable Documentation

$g_oidArray = array()

Global function that makes an associate array from oids given as '|' separated string. This method is used to fill listboxes in the assoziated view.

Returns

An associative array of object ids (key: oid, value: display value)

Definition at line 152 of file ListboxFunctions.php.

Referenced by g_getOIDArray().