Page_Account_Manager Class Reference

Inheritance diagram for Page_Account_Manager:

Public Member Functions
	__construct ($assetid=0)
	create (&$link)
	saveAttributes ($dont_run_updated=FALSE)
	printFrontend ()
	_loadCreateReplacements ()
	initLimbo ()
	printLimbo ()
	_getAllowedLinks ()
	_processGlobalActions ()
	getCreateLocations ($create_type)
	_modifyCreateLink (&$link)
	_setCreateStatus (&$new_asset)
	processBackend (&$o, &$link)
	backendAccess ()
	_getBodycopies ()
	getSelectedCreateLocationsForPendingUser ($userid)
	validateUser (&$user)
	hipoValidateUser ($index, $item, $settings)
	hipoDeleteUser ($index, $item, $settings)
	resendValidation ($username=NULL)
	getValidationKeyForUser (&$user)
	_createPendingAccountsGroup ()
	_getPendingAccountsGroupId ()
&	_getCurrentPendingUser ()
	_removePendingUserFromPendingGroup ($userid)
	_getPendingUserIds ()
	onRequestKeywords (&$broadcaster, $vars=Array())
	_getLoggedInKeywords ()
	_getCreateLoginKeywords ()
	_getNotLoggedInKeywords ()
	getReSendValidationFormKeywordReplacement ()
	getEditDetailsLockErrorKeywordReplacement ()
	getEditDetailsSuccessKeywordReplacement ()
	getReSendValidationSuccessKeywordReplacement ()
	getLoginFormKeywordReplacement ()
	getLogoutFormKeywordReplacement ()
Public Member Functions inherited from Page_Asset_Builder
	__construct ($assetid=0)
	_createAdditional (&$link)
	saveAttributes ($dont_run_updated=FALSE)
	prepareLink (&$asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	isDeletableLink ($linkid)
	_getAllowedLinks ()
	printBody ()
	_printBody ()
	getFormCaptchaKeywordReplacement ()
	getFormCaptchaImageKeywordReplacement ()
	getFormCaptchaFieldKeywordReplacement ()
	getFormCaptchaLinkKeywordReplacement ()
	_processGlobalActions ()
	_abortAssetCreate ($linkid=0)
	getSelectedCreateLocations ()
	getAllSelectableCreateLocations ()
	_getMetadataSchemasToApply ()
	getFixedCreateLocations ()
	getRuleMatchCreateLocations ($create_type, $attributes=Array())
	getCreateLocations ($create_type)
	getAdditionalCreateLocations ()
	getDynamicCreateLocations ()
	_sanitiseLocationSetName ($set_name)
	_modifyCreateLink (&$link)
	_setCreateStatus (&$new_asset)
	_loadAssetReplacements ()
	_loadCreateReplacements ()
	_printContents ()
	_errorHandler ($err_no, $err_msg, $err_file, $err_line)
	_getBodycopies ()
	onRequestKeywords (&$broadcaster, $vars=Array())
	_getNotLoggedInKeywords ()
	_getLoggedInKeywords ()
	_getCreatedKeywords ()
	_getSelectableLocationKeywords ()
	_getDynamicLocationKeywords ()
	getLoginInviteKeywordReplacement ()
	getLoginErrorKeywordReplacement ()
	getLoginFormKeywordReplacement ()
	getCreatedAssetidKeywordReplacement ()
	getCreatedAssetNameKeywordReplacement ()
	getCreatedAssetShortNameKeywordReplacement ()
	getCreatedAssetUrlKeywordReplacement ()
	getCreatedAssetEditKeywordReplacement ()
	getCreatedAssetBackendKeywordReplacement ()
	getCreateErrorKeywordReplacement ()
	getCreateInviteKeywordReplacement ()
	getCreateFormKeywordReplacement ()
&	_getCreateFormLayout ($type_code)
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 ()

Additional Inherited Members
Data Fields inherited from Page_Asset_Builder
	$_current_state = ''
	$_errors = Array()
	$_replacements = Array()
	$_default_state = 'create'
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_account_manager.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 43 of file page_account_manager.inc.

Member Function Documentation

_createPendingAccountsGroup

(

)

Create the pending accounts user group

Returns

boolean protected

Definition at line 1027 of file page_account_manager.inc.

_getAllowedLinks

(

)

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

Returns

boolean private

See Also

Asset::_getAllowLinks()

Definition at line 314 of file page_account_manager.inc.

_getBodycopies

(

)

Return an array of bodycopies that need to be created

Returns

array private

Definition at line 654 of file page_account_manager.inc.

_getCreateLoginKeywords

(

)

Get the keyword replacements used in not_logged_in bodycopy

Returns

array protected

Definition at line 1215 of file page_account_manager.inc.

& _getCurrentPendingUser

(

)

Get the current pending user (for a request that came from a validation email)

Returns

object protected

Definition at line 1067 of file page_account_manager.inc.

_getLoggedInKeywords

(

)

Get the keyword replacements used in not_logged_in bodycopy

Returns

array protected

Definition at line 1184 of file page_account_manager.inc.

_getNotLoggedInKeywords

(

)

Get the keyword replacements used in not_logged_in bodycopy

Returns

array protected

Definition at line 1236 of file page_account_manager.inc.

_getPendingAccountsGroupId

(

)

Get the ID of the Pending Accounts group

Returns

string public

Definition at line 1049 of file page_account_manager.inc.

_getPendingUserIds

(

)

Return an array of the currently pending users

Returns

object protected

Definition at line 1115 of file page_account_manager.inc.

_loadCreateReplacements

(

)

Loads keyword replacements for the create asset interface, into the Asset Builder

Returns

void private

Definition at line 201 of file page_account_manager.inc.

_modifyCreateLink

(

&

$link

)

Takes the default link that was created and allows for adjustments if necessary

Parameters

array

&$link

the current link array

Returns

void private

Definition at line 572 of file page_account_manager.inc.

_processGlobalActions

(

)

Process any global Account Manager actions

This function builds on the Asset Builder one by auto filling the username field of the login form that may be printed once the user account has been created.

Returns

boolean private

See Also

Page_Asset_Builder::_processGlobalActions()

Definition at line 334 of file page_account_manager.inc.

_removePendingUserFromPendingGroup

(

$userid

)

Remove a user from the pending-users group

Parameters

string

$userid

the assetid of the pending user to remove

Returns

boolean protected

Definition at line 1093 of file page_account_manager.inc.

_setCreateStatus

(

&

$new_asset

)

Sets the status of the newly created asset

If we are using email validation we dont change the status of the new asset

Parameters

object

&$new_asset

the newly created asset

Returns

boolean private

Definition at line 592 of file page_account_manager.inc.

backendAccess

(

)

Determine if the current user is allowed into this asset's backend interface

Returns

boolean public

Definition at line 637 of file page_account_manager.inc.

create

(

&

$link

)

Create this asset

The return value will be:

• FALSE if the asset was not created
• the ID of the newly created link if the asset and intital link were created

Parameters

array

&$link

information used to create the initial link

Returns

mixed int|boolean public

Definition at line 64 of file page_account_manager.inc.

getCreateLocations

(

$create_type

)

Work out the create locations for a new asset

Account manager replaces the create location list with its pending-accounts group when email validation is enabled, but it still checks the parent create locations to make sure there will be somewhere to move the user to after it's been validated.

Parameters

string

$create_type

the type of asset we are getting create locations for

Returns

array private

Definition at line 546 of file page_account_manager.inc.

getEditDetailsLockErrorKeywordReplacement

(

)

Get edit_details_lock_error keyword replacement

Returns

string public

Definition at line 1280 of file page_account_manager.inc.

getEditDetailsSuccessKeywordReplacement

(

)

Get edit_details_success keyword replacement

Returns

string public

Definition at line 1293 of file page_account_manager.inc.

getLoginFormKeywordReplacement

(

)

Get login_form keyword replacement

Returns

string public

Definition at line 1319 of file page_account_manager.inc.

getLogoutFormKeywordReplacement

(

)

Get logout_form keyword replacement

Returns

string public

Definition at line 1338 of file page_account_manager.inc.

getReSendValidationFormKeywordReplacement

(

)

Get edit_details_lock_error keyword replacement

Returns

string public

Definition at line 1264 of file page_account_manager.inc.

getReSendValidationSuccessKeywordReplacement

(

)

Get edit_details_success keyword replacement

Returns

string public

Definition at line 1306 of file page_account_manager.inc.

getSelectedCreateLocationsForPendingUser

(

$userid

)

Returns a list of selected create locations for a specified pending user

Parameters

string

$userid

the userid of the pending user

Returns

array public

Definition at line 688 of file page_account_manager.inc.

getValidationKeyForUser

(

&

$user

)

Returns the validation key for the supplied user.

Parameters

object

&$user

The user we want the validation key for

Returns

string public

Definition at line 1009 of file page_account_manager.inc.

hipoDeleteUser	(		$index,
			$item,
			$settings
	)

A Quick HIPO callback function that deletes a user that is passetd to it

Parameters

mixed	$index	The index of the item currently being processed
mixed	$item	The complete list of items to process
mixed	$settings	An array containing whatever settings this Quick HIPO requires

Returns

boolean public

Definition at line 883 of file page_account_manager.inc.

hipoValidateUser	(		$index,
			$item,
			$settings
	)

A Quick HIPO callback function that validates a user passed to it

Parameters

mixed	$index	The index of the item currently being processed
mixed	$item	The complete list of items to process
array	$settings	An array containing whatever settings this Quick HIPO requires

Returns

boolean public

Definition at line 861 of file page_account_manager.inc.

initLimbo

(

)

Initialise the limbo (simple-edit) interface by painting to the limbo outputter

This function should be overridden if assets want to expose another asset's interface instead of their own. By default, the normal backend is printed for the default screen.

Returns

void public

See Also

printLimbo

Definition at line 219 of file page_account_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 1145 of file page_account_manager.inc.

printFrontend

(

)

Prints out the Frontend for this asset

Returns

void public

Definition at line 163 of file page_account_manager.inc.

printLimbo

(

)

Called by the design to print the body of this asset when in limbo

Returns

void public

Definition at line 232 of file page_account_manager.inc.

processBackend	(	&	$o,
		&	$link
	)

Processes a backend submission from this asset, returns true if all OK

Parameters

object	&$o	Backendoutputer
array	&$link	information used to create the initial link

Returns

boolean public

Definition at line 612 of file page_account_manager.inc.

resendValidation

(

$username = NULL

)

Re-sends validation email to specified user

Parameters

string

$username

The username of the user to resend the email for (optional)

Returns

boolean private

Definition at line 928 of file page_account_manager.inc.

saveAttributes

(

$dont_run_updated = FALSE

)

Save attributes set with setAttrValue to the database

Parameters

boolean

$dont_run_updated

if true this->_updated() won't be run (THIS IS ONLY EVER CALLED FROM Asset::create())

Returns

boolean public

See Also

setAttrValue()

Definition at line 89 of file page_account_manager.inc.

validateUser

(

&

$user

)

Validates the passed user

Parameters

object

&$user

the user to validate

Returns

boolean public

Definition at line 713 of file page_account_manager.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/cms/page_templates/page_account_manager/page_account_manager.inc