Inheritance diagram for Page_User_Group_Manager:

Public Member Functions
	__construct ($assetid=0)

	_createAdditional (&$link)

	_getDefaultBodycopyContents ($code)

	printBody ()

	processForm ()

	processMinorLinks ($minor_id, $old_links=Array(), $new_links=Array(), $link_type, $link_value=NULL)

	generateMessages ($fail_success)

	printAvailableLocations ($suffix='_location_selection')

	_getAllowedLinks ()

&	getBodycopyContents ($name, $replacements=Array())

&	getBodycopy ($name)

	onRequestKeywords (&$broadcaster, $vars=Array())

	printBodycopyContents ()

	_getCommaSeparatedNamesByAssetid ($assetids)

	getLocationPickerKeywordReplacement ()

	getUserNameKeywordReplacement ()

	getUserShortNameKeywordReplacement ()

	getUserEmailKeywordReplacement ()

	getUserIdKeywordReplacement ()

	getCommitButtonKeywordReplacement ()

	getErrorMessagesListKeywordReplacement ()

	getSuccessMessagesListKeywordReplacement ()

	_generateMessageList ($messages, $suffix)

	getLoginFormKeywordReplacement ()

Public Member Functions inherited from Page
	__construct ($assetid=0)

	_getAllowedLinks ()

	printBody ()

Public Member Functions inherited from Asset
	Asset ($assetid=0)

	create (Array &$link)

	load ($assetid)

	_loadDataPaths ()

	reload ()

	canDelete ()

	delete ($release_lock=TRUE, $check_locked=TRUE)

	useSystemVersion ()

	loadSystemVersion ()

	saveSystemVersion ()

	clearSystemVersion ()

	revertToSystemVersion ()

	revertNoticeLinksToSystemVersion ()

	_updated ($update_parents=TRUE)

	type ()

	getTypeAncestors ($include_asset=TRUE)

	incrementVersion ($number='micro', $update_parents=TRUE)

	getLanguages ()

	setLanguages (Array $languages)

	setCharset ($charset)

	setForceSecure ($force_secure)

	remapAssetids (Array $map)

	morph ($new_type_code)

	_morphCleanup ($new_type_code)

	onRequestKeywords (Asset $broadcaster, Array $vars=Array())

	canClone ()

	cloneComponents (Asset $clone, Array $components, $override=FALSE)

	cloneComponentsAdditional (Asset $clone, Array $components)

	cloneLinks (Asset $clone)

	getStatus ()

	getAvailableStatii ()

	getStatusDescription ()

	processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)

	setDate ($date_type, $time=NULL, $userid=NULL)

	lockTypes ()

	canForceablyAcquireLock ($lock_type)

	getEditingLocks ($keywords)

	_getAllowedLinks ()

	createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE, $locked=0)

	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)

	canCreateLink (Asset $minor, $link_type, $exclusive)

	canMoveLink (Asset $minor, Asset $old_major, $link_type)

	describeLink ($linkid)

	isDeletableLink ($linkid)

	canDeleteLink ($linkid)

	deleteLink ($linkid, $check_locked=TRUE)

	linksUpdated ()

	canCloneLink ()

	saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)

	setAttrValue ($name, $value)

	attr ($name)

&	attrByRef ($name)

	getAttribute ($name, $mute_errors=FALSE)

	getAssetKeywords ($descriptions=FALSE)

	getAvailableKeywords ()

	getKeywordReplacement ($keyword)

	getAssetWebPathKeywordReplacement ()

	getCustomKeywordReplacements ($keywords=Array(), $invoke_backend=FALSE)

	processCustomKeywords ($keywords=Array())

	getContent ()

	setContent ()

	getEffectiveLastUpdatedTime ($assetids)

	readAccess (Array $assetids=Array())

	writeAccess ($lock_type='', Array $assetids=Array(), $only_workflow=TRUE)

	adminAccess ($lock_type='', Array $assetids=Array())

	backendAccess ()

	liveEditAccess ($lock_type)

	canliveEdit ($lock_type)

	effectiveUnrestricted ()

	checkAccess ($perm, $lock_type, Array $assetids=Array(), $only_workflow=TRUE)

	accessEffective ()

	permissionsUpdated ()

	printFrontend ()

	printFrontendAsset (Asset $asset, $design=NULL)

	getValidProtocols ()

	printHead ()

	printBody ()

	getCurrentPaintLayoutName ()

	getCurrentDesignName ()

	printBodyWithPaintLayout ($layout_id='')

	initLimbo ()

	printLimbo ()

	paintBackend (Backend_Outputter $o)

	getPrefix ()

	processBackend (Backend_Outputter $o, Array &$link)

	getEI ()

	getEditFns ()

	getBackendHref ($screen='', $backend_page=TRUE)

	getURL ($base_url=NULL, $ignore_rollback=FALSE, $base_contextid=NULL)

	getURLs ()

	getHref ($base_url=NULL, $ignore_rollback=FALSE)

	getWebDataPath ()

	getWebPaths ()

	saveWebPaths ($paths, $auto_add_remaps=TRUE)

	getLookups ($field='')

	getDesignLookups ()

	getLookupValues ($inherited=NULL, $prefix='', $like_search=TRUE, $ignore_override=FALSE)

	deleteLookupValue ($layout_name, $layout_value)

	setPaintLayouts ($layouts)

	updateLookups ($auto_add_remaps=TRUE)

	setLookupValues (Array $values)

	getAssetStatusDescriptionKeywordReplacement ()

	getAssetStatusColourKeywordReplacement ()

	replaceKeywordsInString ($string)

	fastTrack ($tasks)

	unFastTrack ($tasks)

	shouldFastTrack ($task, $assetid=NULL)

	getFaskTrackedTaskAssetids ($task)

	getDependantParentsURL ()

Public Member Functions inherited from MySource_Object
	MySource_Object ()

	__sleep ()

	__wakeup ()

Data Fields
	$bodycopies

	$keywords

	$errors

	$messages

Additional Inherited Members
Protected Member Functions inherited from Page
	_preCreateCheck (Array &$link)

	_createAdditional (Array &$link)

	_getName ($short_name=FALSE)

Detailed Description

Definition at line 33 of file page_user_group_manager.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 67 of file page_user_group_manager.inc.

Member Function Documentation

_createAdditional ( & $link )

Perform any additional processing required during the creation of this asset

Search pages create a few bodycopy assets when they are created

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 85 of file page_user_group_manager.inc.

_generateMessageList	(	$messages,
		$suffix
	)

Print out an unordered list

Parameters

array	$messages	Array of messages
string	$suffix	The suffix

Returns: string private

Definition at line 623 of file page_user_group_manager.inc.

_getAllowedLinks ( )

Returns an array of all the permitted link types, the type asset and the cardinality

Returns: array private

See Also: Asset::_getAllowLinks()

Definition at line 347 of file page_user_group_manager.inc.

_getCommaSeparatedNamesByAssetid ( $assetids )

Takes an array of assetids and returns the asset names as a comma separated string

Parameters

array $assetids Array of assetids

Returns: string private

Definition at line 484 of file page_user_group_manager.inc.

_getDefaultBodycopyContents ( $code )

Get the default contents for a bodycopy

Parameters

string $code The code name for the bodycopy

Returns: void public

Definition at line 121 of file page_user_group_manager.inc.

generateMessages ( $fail_success )

Takes an associative array of assetids and writes relevant error/success messages to $this->[errors|messages] for later formatting

Parameters

array $fail_success associative array of assetids

Returns: void public

Definition at line 279 of file page_user_group_manager.inc.

& getBodycopy ( $name )

Retrieves a bodycopy by name Returns the bodycopy, or null if the name does not match any bodycopies.

Parameters

string $name the name of the bodycopy to retrieve

Returns: mixed object|NULL private

See Also: Search_Page::bodycopies

Definition at line 393 of file page_user_group_manager.inc.

& getBodycopyContents	(	$name,
		$replacements = `Array()`
	)

Retrieves a bodycopy's contents by name Returns the bodycopy's contents, or empty string if the name does not match any bodycopies

Parameters

string	$name	the name of the bodycopy to retrieve
array	$replacements	Replacement texts

Returns: mixed string|NULL private

See Also: Search_Page::bodycopies; Search_Page::getBodycopy

Definition at line 366 of file page_user_group_manager.inc.

getCommitButtonKeywordReplacement ( )

Returns replacement for the commit_button keyword.

Returns: string private

See Also: Asset::_getAllowLinks()

Definition at line 577 of file page_user_group_manager.inc.

getErrorMessagesListKeywordReplacement ( )

Returns replacement for the error_messages_list keyword.

Returns: string private

Definition at line 594 of file page_user_group_manager.inc.

getLocationPickerKeywordReplacement ( )

Returns replacement for the location_picker keyword.

Returns: string private

Definition at line 506 of file page_user_group_manager.inc.

getLoginFormKeywordReplacement ( )

Get login_form keyword replacement

Returns: string public

Definition at line 644 of file page_user_group_manager.inc.

getSuccessMessagesListKeywordReplacement ( )

Returns replacement for the error_messages_list keyword.

Returns: string private

Definition at line 607 of file page_user_group_manager.inc.

getUserEmailKeywordReplacement ( )

Returns replacement for the user_email keyword.

Returns: string private

Definition at line 547 of file page_user_group_manager.inc.

getUserIdKeywordReplacement ( )

Returns replacement for the user_id keyword.

Returns: string private

See Also: Asset::_getAllowLinks()

Definition at line 563 of file page_user_group_manager.inc.

getUserNameKeywordReplacement ( )

Returns replacement for the user_name keyword.

Returns: string private

Definition at line 519 of file page_user_group_manager.inc.

getUserShortNameKeywordReplacement ( )

Returns replacement for the user_short_name keyword.

Returns: string private

Definition at line 533 of file page_user_group_manager.inc.

onRequestKeywords	(	&	$broadcaster,
			$vars = `Array()`
	)

Add valid keywords for this asset to an array of keywords when asked

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster we add keywords to the $vars['keywords'] array

Returns: boolean private

Definition at line 417 of file page_user_group_manager.inc.

printAvailableLocations ( $suffix = '_location_selection' )

Displays a list of available locations to link the current asset to

Parameters

string $suffix The suffix

Returns: void public

Definition at line 309 of file page_user_group_manager.inc.

printBody ( )

printBody

Returns: void public

Definition at line 142 of file page_user_group_manager.inc.

printBodycopyContents ( )

Returns the contents of the bodycopy with all replacements made

Returns: string private

See Also: Asset::_getAllowLinks()

Definition at line 449 of file page_user_group_manager.inc.

processForm ( )

Process submissions made by the user.

Returns: boolean public

Definition at line 175 of file page_user_group_manager.inc.

processMinorLinks	(	$minor_id,
		$old_links = `Array()`,
		$new_links = `Array()`,
		$link_type,
		$link_value = `NULL`
	)

Handle linking this asset under multiple parents

Parameters

int	$minor_id	asset we are going to link
array	$old_links	The current assets we are linked to
array	$new_links	The new selections we wish to be linked to
int	$link_type	type of link to use
string	$link_value	value associated with the link

Returns: void public

Definition at line 226 of file page_user_group_manager.inc.

Field Documentation

$bodycopies

Initial value:

= Array(
                        'logged_in'     => 'Logged In Layout',
                        'not_logged_in' => 'Not Logged In Layout',
                      )

Definition at line 36 of file page_user_group_manager.inc.

$keywords

Initial value:

= Array(
                        'logged_in'     => Array(
                                            'error_messages_list',
                                            'success_messages_list',
                                            'location_picker',
                                            'user_name',
                                            'user_short_name',
                                            'user_email',
                                            'commit_button',
                                           ),
                        'not_logged_in' => Array(
                                            'login_form',
                                           ),
                    )

Definition at line 41 of file page_user_group_manager.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/cms/page_templates/page_user_group_manager/page_user_group_manager.inc

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation