Inheritance diagram for EmailPreferences:

[legend]

Collaboration diagram for EmailPreferences:

[legend]

Public Member Functions
	__construct ()

	execute ( $subpage)
	Default execute method Checks user permissions.

	setupOptIn ( $params)

Public Member Functions inherited from UnlistedSpecialPage
	__construct ( $name, $restriction='', $function=false, $file='default')
	Stable to call.

	isListed ()
	Whether this special page is listed in Special:SpecialPages Stable to override.

Public Member Functions inherited from SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.

	doesWrites ()
	Indicates whether this special page may perform database writes.

	getConfig ()
	Shortcut to get main config object.

	getContext ()
	Gets the context this SpecialPage is executed in.

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page Stable to override.

	getName ()
	Get the name of this Special Page.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRequest ()
	Get the WebRequest being used for this instance.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getSkin ()
	Shortcut to get the skin being used for this instance.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}} Stable to override.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	run ( $subPage)
	Entry point.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Public Attributes
const	BAD_DATA_SESSION_KEY = 'email-pref-bad_data'

const	CIVI_NO_RESULTS_ERROR = 'No result found'

const	FALLBACK_COUNTRY = 'US'

const	FALLBACK_LANGUAGE = 'en_US'

Protected Member Functions
	executeEmailPreferences ( $params)

	executeOptIn ( $params)

	executeUnsubscribe ( $params)

	paramsForPreferencesForm ( $checksum, $contact_id)

	renderError ( $subpage='optin')

	renderQuery ( $subpage, array $params)

	renderSuccess ( $subpage='optin', $params=[])

	setPageTitle ( $subpage)

	validate (array $params, $posted)

	validateEmail (array $params, $posted)

	validateToken (array $params, $posted)

	wasCanceled ( $params)

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have Stable to override.

	getCacheTTL ()
	Stable to override.

	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

	getHookContainer ()

	getHookRunner ()

	getLanguageConverter ()
	Shortcut to get language's converter.

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes! Stable to override.

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Additional Inherited Members
Static Public Member Functions inherited from SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

Static Protected Member Functions inherited from SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Detailed Description

Definition at line 5 of file EmailPreferences.php.

Constructor & Destructor Documentation

◆ __construct()

EmailPreferences::__construct ( )

Definition at line 15 of file EmailPreferences.php.

Member Function Documentation

◆ execute()

EmailPreferences::execute ( $subPage )

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stable to override

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 19 of file EmailPreferences.php.

References executeEmailPreferences(), executeOptIn(), executeUnsubscribe(), SpecialPage\getConfig(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\outputHeader(), paramsForPreferencesForm(), renderError(), renderQuery(), SpecialPage\setHeaders(), setPageTitle(), validate(), and wasCanceled().

◆ executeEmailPreferences()

EmailPreferences::executeEmailPreferences ( $params )

protected

Definition at line 191 of file EmailPreferences.php.

References renderError(), and renderSuccess().

Referenced by execute().

◆ executeOptIn()

EmailPreferences::executeOptIn ( $params )

protected

Definition at line 176 of file EmailPreferences.php.

References renderError(), renderSuccess(), and setupOptIn().

Referenced by execute().

◆ executeUnsubscribe()

EmailPreferences::executeUnsubscribe ( $params )

protected

Definition at line 187 of file EmailPreferences.php.

Referenced by execute().

◆ paramsForPreferencesForm()

EmailPreferences::paramsForPreferencesForm	(		$checksum,
			$contact_id )

protected

Definition at line 72 of file EmailPreferences.php.

References FALLBACK_COUNTRY, FALLBACK_LANGUAGE, LanguageNames\FALLBACK_NATIVE, SpecialPage\getConfig(), CiviproxyConnect\getEmailPreferences(), SpecialPage\getLanguage(), DonationLoggerFactory\getLoggerFromParams(), CountryNames\getNames(), LanguageNames\getNames(), and LanguageNames\LIST_MW_AND_CLDR.

Referenced by execute().

◆ renderError()

EmailPreferences::renderError ( $subpage = 'optin' )

protected

Definition at line 219 of file EmailPreferences.php.

References renderQuery().

Referenced by execute(), executeEmailPreferences(), and executeOptIn().

◆ renderQuery()

EmailPreferences::renderQuery	(		$subpage,
		array	$params )

protected

Definition at line 229 of file EmailPreferences.php.

References SpecialPage\getOutput().

Referenced by execute(), renderError(), and renderSuccess().

◆ renderSuccess()

EmailPreferences::renderSuccess	(		$subpage = 'optin',
			$params = [] )

protected

Definition at line 224 of file EmailPreferences.php.

References renderQuery().

Referenced by executeEmailPreferences(), and executeOptIn().

◆ setPageTitle()

EmailPreferences::setPageTitle ( $subpage )

protected

Definition at line 282 of file EmailPreferences.php.

References $title, SpecialPage\getOutput(), and SpecialPage\msg().

Referenced by execute().

◆ setupOptIn()

EmailPreferences::setupOptIn ( $params )

Definition at line 151 of file EmailPreferences.php.

Referenced by executeOptIn().

◆ validate()

EmailPreferences::validate	(	array	$params,
			$posted )

protected

Definition at line 234 of file EmailPreferences.php.

References validateEmail(), and validateToken().

Referenced by execute().

◆ validateEmail()

EmailPreferences::validateEmail	(	array	$params,
			$posted )

protected

Definition at line 253 of file EmailPreferences.php.

Referenced by validate().

◆ validateToken()

EmailPreferences::validateToken	(	array	$params,
			$posted )

protected

Definition at line 267 of file EmailPreferences.php.

Referenced by validate().

◆ wasCanceled()

EmailPreferences::wasCanceled ( $params )

protected

Definition at line 301 of file EmailPreferences.php.

Referenced by execute().

Member Data Documentation

◆ BAD_DATA_SESSION_KEY

const EmailPreferences::BAD_DATA_SESSION_KEY = 'email-pref-bad_data'

Definition at line 13 of file EmailPreferences.php.

◆ CIVI_NO_RESULTS_ERROR

const EmailPreferences::CIVI_NO_RESULTS_ERROR = 'No result found'

Definition at line 11 of file EmailPreferences.php.

◆ FALLBACK_COUNTRY

const EmailPreferences::FALLBACK_COUNTRY = 'US'

Definition at line 7 of file EmailPreferences.php.

Referenced by paramsForPreferencesForm().

◆ FALLBACK_LANGUAGE

const EmailPreferences::FALLBACK_LANGUAGE = 'en_US'

Definition at line 8 of file EmailPreferences.php.

Referenced by paramsForPreferencesForm().

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

extensions/DonationInterface/special/EmailPreferences.php

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ executeEmailPreferences()

◆ executeOptIn()

◆ executeUnsubscribe()

◆ paramsForPreferencesForm()

◆ renderError()

◆ renderQuery()

◆ renderSuccess()

◆ setPageTitle()

◆ setupOptIn()

◆ validate()

◆ validateEmail()

◆ validateToken()

◆ wasCanceled()

Member Data Documentation

◆ BAD_DATA_SESSION_KEY

◆ CIVI_NO_RESULTS_ERROR

◆ FALLBACK_COUNTRY

◆ FALLBACK_LANGUAGE