Inheritance diagram for Bulkmail_Subscribe_Page:

Public Member Functions
	__construct ($assetid=0)

	_getAllowedLinks ()

	_createAdditional (&$link)

&	getUnverifiedUsersFolder ()

	getExistingBulkmailUserid ($value)

	getAvailableLocations ()

	processForm ()

	processVerification ()

	processPublicUserForm ()

	processMatrixUserForm ()

	addLinkingMessages ($fail_success)

	sendConfirmationEmail ($to, $from, $subscriptions, $unsubscriptions, $uniqid)

	sendAlreadySubscribedEmail ($to, $from, $subscriptions)

	getSubscribeEmailAddressKeywordReplacement ()

	getSubscribeUserNameKeywordReplacement ()

	getSubscriptionsPickerKeywordReplacement ()

	getUnsubscriptionsPickerKeywordReplacement ()

	getCurrentSubscriptionsKeywordReplacement ()

	_getDefaultBodycopyContents ($code)

Public Member Functions inherited from Page_User_Group_Manager
	__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
	$keywords

Data Fields inherited from Page_User_Group_Manager
	$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 34 of file bulkmail_subscribe_page.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 69 of file bulkmail_subscribe_page.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 122 of file bulkmail_subscribe_page.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 84 of file bulkmail_subscribe_page.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 973 of file bulkmail_subscribe_page.inc.

addLinkingMessages ( $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 with failed and successful assetids

Returns: void public

Definition at line 728 of file bulkmail_subscribe_page.inc.

getAvailableLocations ( )

Gets a list of the valid mailing lists, so that we can check if people are rewriting the GET vars to link themselves elsewhere

Returns: array private

Definition at line 193 of file bulkmail_subscribe_page.inc.

getCurrentSubscriptionsKeywordReplacement ( )

Returns replacement for the current_subscriptions keyword.

Returns: string private

Definition at line 940 of file bulkmail_subscribe_page.inc.

getExistingBulkmailUserid ( $value )

Gets the assetid of the unique Bulkmail_User asset with an email of $value

Parameters

string $value the email address to look for (unique attribute value)

Returns: int private

Definition at line 170 of file bulkmail_subscribe_page.inc.

getSubscribeEmailAddressKeywordReplacement ( )

Returns replacement for the subscribe_email_address keyword.

Returns: string private

Definition at line 880 of file bulkmail_subscribe_page.inc.

getSubscribeUserNameKeywordReplacement ( )

Returns replacement for the subscribe_email_address keyword.

Returns: string private

Definition at line 897 of file bulkmail_subscribe_page.inc.

getSubscriptionsPickerKeywordReplacement ( )

Returns replacement for the subscription_picker keyword.

Returns: string private

Definition at line 914 of file bulkmail_subscribe_page.inc.

getUnsubscriptionsPickerKeywordReplacement ( )

Returns replacement for the subscription_picker keyword.

Returns: string private

Definition at line 927 of file bulkmail_subscribe_page.inc.

& getUnverifiedUsersFolder ( )

Retrieves the unverified users folder

Returns: object private

Definition at line 153 of file bulkmail_subscribe_page.inc.

processForm ( )

This is called before the bodycopy contents are printed. It decides which functions to call based on whether the user is logged in or not (or has has clicked on a link in a verification email)

Returns: NULL private

Definition at line 229 of file bulkmail_subscribe_page.inc.

processMatrixUserForm ( )

Process a sub/unsubscribe request from logged in user

Returns: NULL private

Definition at line 583 of file bulkmail_subscribe_page.inc.

processPublicUserForm ( )

Process a sub/unsubscribe request from a public user (ie, someone that just wants to key in their email address and hit subscribe / unsubscribe), or a logged in user who has specified a different email address

Returns: NULL private

Definition at line 374 of file bulkmail_subscribe_page.inc.

processVerification ( )

Process a verification request. This will get called whenever the GET vars indicate that the user has done a click-through from a verification email.

Returns: NULL private

Definition at line 268 of file bulkmail_subscribe_page.inc.

sendAlreadySubscribedEmail	(	$to,
		$from,
		$subscriptions
	)

Send email stating that attempt was made to subscribe them to lists they are already a part of

Parameters

string	$to	Recipient email address (either 'user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om' or 'User user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om')
string	$from	Sending email address (formatted as above)
array	$subscriptions	Assetids the user wanted to link under

Returns: void public

Definition at line 837 of file bulkmail_subscribe_page.inc.

sendConfirmationEmail	(	$to,
		$from,
		$subscriptions,
		$unsubscriptions,
		$uniqid
	)

Send an email to the user asking them to verify their subscription / unsubscription request

Parameters

string	$to	Recipent email address (either 'user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om' or 'User user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om')
string	$from	Sending email address (formatted as above)
array	$subscriptions	Assetids the user wanted to link under
array	$unsubscriptions	Assetids the user wanted to remove himself from
array	$uniqid	Unique identifier (value of the link between user & unverified user folder)

Returns: void public

Definition at line 763 of file bulkmail_subscribe_page.inc.

Field Documentation

$keywords

Initial value:

= Array(
                        'logged_in'     => Array(
                                            'error_messages_list',
                                            'success_messages_list',
                                            'current_subscriptions',
                                            'subscriptions_picker',
                                            'unsubscriptions_picker',
                                            'user_name',
                                            'user_short_name',
                                            'user_email',
                                            'subscribe_user_name',
                                            'subscribe_email_address',
                                            'commit_button',
                                           ),
                        'not_logged_in' => Array(
                                            'error_messages_list',
                                            'success_messages_list',
                                            'subscriptions_picker',
                                            'unsubscriptions_picker',
                                            'subscribe_user_name',
                                            'subscribe_email_address',
                                            'commit_button',
                                           ),
                    )

Definition at line 37 of file bulkmail_subscribe_page.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/bulkmail/bulkmail_subscribe_page/bulkmail_subscribe_page.inc

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation