A special page that allows users to send e-mails to other users. More...

Inheritance diagram for SpecialEmailUser:

[legend]

Collaboration diagram for SpecialEmailUser:

[legend]

Public Member Functions
	__construct (UserNameUtils $userNameUtils, UserNamePrefixSearch $userNamePrefixSearch, UserOptionsLookup $userOptionsLookup)

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

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

	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.

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

	sendEmailForm ()

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

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

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.

	getAssociatedNavigationLinks ()
	Return an array of strings representing page titles that are discoverable to end users via UI.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

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

	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.

	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.

	getShortDescription (string $path='')
	Similar to getDescription but takes into account sub pages and designed for display in tabs.

	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}}.

	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.

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

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	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.

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

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

Static Public Member Functions
static	getPermissionsError ( $user, $editToken, Config $config=null)
	Check whether a user is allowed to send email.

static	getTarget ( $target, User $sender)
	Validate target User.

static	submit (array $data, IContextSource $context)
	Really send a mail.

static	validateTarget ( $target, User $sender)
	Validate target User.

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	newSearchPage (User $user)
	Get the users preferred search page.

Protected Member Functions
	getFormFields ()

	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'.

	userForm ( $name)
	Form to ask for target user name.

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.

	getAuthManager ()

	getCacheTTL ()

	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.

	getSpecialPageFactory ()

	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, SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

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

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

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

Protected Attributes
	$mTarget

User string	$mTargetObj

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

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Additional Inherited Members
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).

Detailed Description

A special page that allows users to send e-mails to other users.

Definition at line 36 of file SpecialEmailUser.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialEmailUser::__construct	(	UserNameUtils	$userNameUtils,
		UserNamePrefixSearch	$userNamePrefixSearch,
		UserOptionsLookup	$userOptionsLookup )

Parameters

UserNameUtils	$userNameUtils
UserNamePrefixSearch	$userNamePrefixSearch
UserOptionsLookup	$userOptionsLookup

Definition at line 58 of file SpecialEmailUser.php.

Member Function Documentation

◆ doesWrites()

SpecialEmailUser::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 69 of file SpecialEmailUser.php.

◆ execute()

SpecialEmailUser::execute ( $subPage )

Default execute method Checks user permissions.

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

Stability: stable: to override

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 132 of file SpecialEmailUser.php.

References $title, SpecialPage\getConfig(), SpecialPage\getOutput(), getPermissionsError(), SpecialPage\getRequest(), getTarget(), SpecialPage\getUser(), SpecialPage\outputHeader(), sendEmailForm(), SpecialPage\setHeaders(), and userForm().

◆ getDescription()

SpecialEmailUser::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.

Derived classes can override this, but usually it is easier to keep the default behavior.

Stability: stable: to override

Returns: string

Reimplemented from SpecialPage.

Definition at line 73 of file SpecialEmailUser.php.

References getTarget(), SpecialPage\getUser(), and SpecialPage\msg().

◆ getFormFields()

SpecialEmailUser::getFormFields ( )

protected

Definition at line 82 of file SpecialEmailUser.php.

References SpecialPage\getLinkRenderer(), SpecialPage\getUser(), and SpecialPage\msg().

Referenced by sendEmailForm().

◆ getGroupName()

SpecialEmailUser::getGroupName ( )

protected

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

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 575 of file SpecialEmailUser.php.

◆ getPermissionsError()

static SpecialEmailUser::getPermissionsError	(		$user,
			$editToken,
		Config	$config = null )

static

Check whether a user is allowed to send email.

Parameters

User	$user
string	$editToken
Config \| null	$config	optional for backwards compatibility

Returns: null|string|array Null on success, string on error, or array on hook error

Definition at line 273 of file SpecialEmailUser.php.

References wfDebug().

Referenced by execute(), and ApiEmailUser\execute().

◆ getTarget()

static SpecialEmailUser::getTarget	(		$target,
		User	$sender )

static

Validate target User.

Parameters

string	$target	Target user name
User	$sender	User sending the email

Returns: User|string User object on success or a string on error

Definition at line 192 of file SpecialEmailUser.php.

References User\newFromName(), validateTarget(), and wfDebug().

Referenced by execute(), ApiEmailUser\execute(), getDescription(), and submit().

◆ prefixSearchSubpages()

SpecialEmailUser::prefixSearchSubpages	(	$search,
		$limit,
		$offset )

Return an array of subpages beginning with $search that this special page will accept.

Parameters

string	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)

Returns: string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 564 of file SpecialEmailUser.php.

◆ sendEmailForm()

SpecialEmailUser::sendEmailForm ( )

Definition at line 350 of file SpecialEmailUser.php.

References $mTargetObj, SpecialPage\getContext(), getFormFields(), SpecialPage\getHookRunner(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), StatusValue\isGood(), and SpecialPage\msg().

Referenced by execute().

◆ submit()

static SpecialEmailUser::submit	(	array	$data,
		IContextSource	$context )

static

Really send a mail.

Permissions should have been checked using getPermissionsError(). It is probably also a good idea to check the edit token and ping limiter in advance.

Parameters

array	$data
IContextSource	$context

Returns: Status|false

Exceptions

MWException if EmailUser hook sets the error to something unsupported

Definition at line 398 of file SpecialEmailUser.php.

References $type, IContextSource\getConfig(), getTarget(), SpecialPage\getTitleFor(), IContextSource\getUser(), and MessageLocalizer\msg().

Referenced by ApiEmailUser\execute().

◆ userForm()

SpecialEmailUser::userForm ( $name )

protected

Form to ask for target user name.

Parameters

string $name User name submitted.

Definition at line 327 of file SpecialEmailUser.php.

References SpecialPage\getContext(), SpecialPage\getPageTitle(), and SpecialPage\msg().

Referenced by execute().

◆ validateTarget()

static SpecialEmailUser::validateTarget	(		$target,
		User	$sender )

static

Validate target User.

Parameters

User	$target	Target user
User	$sender	User sending the email

Returns: string Error message or empty string if valid.

Since: 1.30

Definition at line 213 of file SpecialEmailUser.php.

References User\getId(), MediaWiki\User\UserOptionsLookup\getOption(), User\isNewbie(), and wfDebug().

Referenced by getTarget(), and Skin\showEmailUser().

Member Data Documentation

◆ $mTarget

SpecialEmailUser::$mTarget

protected

Definition at line 37 of file SpecialEmailUser.php.

◆ $mTargetObj

User string SpecialEmailUser::$mTargetObj

protected

Definition at line 42 of file SpecialEmailUser.php.

Referenced by sendEmailForm().

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

includes/specials/SpecialEmailUser.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doesWrites()

◆ execute()

◆ getDescription()

◆ getFormFields()

◆ getGroupName()

◆ getPermissionsError()

◆ getTarget()

◆ prefixSearchSubpages()

◆ sendEmailForm()

◆ submit()

◆ userForm()

◆ validateTarget()

Member Data Documentation

◆ $mTarget

◆ $mTargetObj