Inheritance diagram for Page_Password_Reset:

Public Member Functions
	__construct ($assetid=0)

	create (&$link)

	_createAdditional (&$link)

	_getAllowedLinks ()

	printBody ()

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

	_printContents ($action)

	_printRequestAction ()

	_printRequestReceiptAction ()

	_printResetAction ()

	_printResetReceiptAction ()

	_buildContents ($action, $new_replacements=Array(), $extra='')

	_buildForm ($body_contents, $action)

	_resetPassword (&$user, $new_password)

	_createResetLink ($assetid)

	_getResetLink ($value)

	_getStandardKeywords ()

	_getRequestKeywords ()

	_getRequestReceiptKeywords ()

	_getResetKeywords ()

	_getResetReceiptKeywords ()

	getUsernameInputKeywordReplacement ()

	getPasswordInputKeywordReplacement ()

	getPasswordNewKeywordReplacement ()

	getPasswordConfirmationKeywordReplacement ()

	getSubmitButtonKeywordReplacement ()

	_getPendingAccountsGroupId ()

&	_getBodycopy ($link_value)

	_getBodycopies ()

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
	$default_state = 'request'

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

	_createAdditional (Array &$link)

	_getName ($short_name=FALSE)

Detailed Description

Definition at line 32 of file page_password_reset.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor.

Parameters

int $assetid the asset id to be loaded

Returns: void public

Definition at line 53 of file page_password_reset.inc.

Member Function Documentation

_buildContents	(	$action,
		$new_replacements = `Array()`,
		$extra = `''`
	)

Prepares a bodycopy to be rendered.

Parameters

string	$action	The action to be performed, aka. the bodycopy to be displayed
array	$new_replacements	An array of keyword replacements to supplement
string	$extra	An extra contents to be printed

Returns: string private

Definition at line 453 of file page_password_reset.inc.

_buildForm	(	$body_contents,
		$action
	)

Paints the bodycopy in a form.

Required for bodycopies that use form keywords so that they will function correctly.

Parameters

string	$body_contents	The contents to be rendered
string	$action	The 'action' that will be performed when the form is submitted

Returns: string private

Definition at line 493 of file page_password_reset.inc.

_createAdditional ( & $link )

Perform any additional processing required during the creation of this asset.

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 98 of file page_password_reset.inc.

_createResetLink ( $assetid )

Creates a 'reset' link.

We identify users that have requested to have their password reset by linking them to the user group we should have linked under this asset.

Parameters

string $assetid The ID of the asset to link

Returns: string private

Definition at line 555 of file page_password_reset.inc.

_getAllowedLinks ( )

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

Returns: array private

See Also: Asset::_getAllowLinks()

Definition at line 139 of file page_password_reset.inc.

_getBodycopies ( )

Return an array of bodycopies that need to be created.

Returns: array private

Definition at line 830 of file page_password_reset.inc.

& _getBodycopy ( $link_value )

Returns the linked bodycopy with the specified link value.

Parameters

string $link_value The value of the link between this asset and the bodycopy

Returns: object public

Definition at line 809 of file page_password_reset.inc.

_getPendingAccountsGroupId ( )

Get the ID of the Pending Accounts user group.

Returns: void public

Definition at line 791 of file page_password_reset.inc.

_getRequestKeywords ( )

The keywords used in the 'request' bodycopy.

Returns: array protected

Definition at line 644 of file page_password_reset.inc.

_getRequestReceiptKeywords ( )

The keywords used in the 'request_receipt' bodycopy.

Returns: array protected

Definition at line 661 of file page_password_reset.inc.

_getResetKeywords ( )

The keywords used in the 'reset' bodycopy.

Returns: array protected

Definition at line 676 of file page_password_reset.inc.

_getResetLink ( $value )

Returns a 'reset' link.

Given the value of the link, returns the link information between our user group and one of our 'password reset' pending users.

Parameters

string $value The value of the link between the two assets

Returns: string private

Definition at line 606 of file page_password_reset.inc.

_getResetReceiptKeywords ( )

The keywords used in the 'reset_receipt'

Returns: array protected

Definition at line 695 of file page_password_reset.inc.

_getStandardKeywords ( )

A bunch of keywords that should be available on all of our bodycopies.

Returns: array protected

Definition at line 626 of file page_password_reset.inc.

_printContents ( $action )

Based on what 'action' is being performed, prints the frontend.

Parameters

string $action The name of the bodycopy to print

Returns: string private

Definition at line 226 of file page_password_reset.inc.

_printRequestAction ( )

Prints the 'request' bodycopy.

The 'request' bodycopy allows the user to enter their details so that they may begin the process of resetting their password.

Returns: string private

Definition at line 253 of file page_password_reset.inc.

_printRequestReceiptAction ( )

Prints the 'request_receipt' bodycopy.

This bodycopy is a receipt of whatever happend on the 'request' bodycopy. It is used to inform the user of the results of the password reset request. Note that the user won't always be taken here after the 'request' process.

Returns: string private

Definition at line 272 of file page_password_reset.inc.

_printResetAction ( )

Prints the 'reset' bodycopy.

This bodycopy should only be accessable by the link sent in the 'reset email'. It will allow the user who (hopefully) submitted the corresponding request to specify a new password.

Returns: string private

Definition at line 348 of file page_password_reset.inc.

_printResetReceiptAction ( )

Prints the 'reset_receipt' bodycopy.

The receipt of the 'reset' bodycopy. This is rendered to inform the user of anything that happend during the 'reset' process. Note that the user will not necessarily be taken here under all circumstances.

Returns: string private

Definition at line 390 of file page_password_reset.inc.

_resetPassword	(	&	$user,
			$new_password
	)

Resets the password for the given user to the new password supplied.

Parameters

object	&$user	The user to reset the password for
string	$new_password	The password to set for said user

Returns: boolean private

Definition at line 514 of file page_password_reset.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 75 of file page_password_reset.inc.

getPasswordConfirmationKeywordReplacement ( )

Prints a form allowing the user to enter a new password.

Returns: string public

Definition at line 761 of file page_password_reset.inc.

getPasswordInputKeywordReplacement ( )

Prints a form allowing the user to enter a new password.

Returns: string public

Definition at line 730 of file page_password_reset.inc.

getPasswordNewKeywordReplacement ( )

Prints a form allowing the user to enter a new password.

Returns: string public

Definition at line 746 of file page_password_reset.inc.

getSubmitButtonKeywordReplacement ( )

Prints a form submit button.

Returns: string public

Definition at line 776 of file page_password_reset.inc.

getUsernameInputKeywordReplacement ( )

Prints form elements allowing the user to enter their username.

Returns: string public

Definition at line 710 of file page_password_reset.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 public

Definition at line 184 of file page_password_reset.inc.

printBody ( )

Called by the design to print the body of this asset.

Returns: void public

Definition at line 157 of file page_password_reset.inc.

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

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

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation