This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. More...

Inheritance diagram for SpecialOATHEnable:

[legend]

Collaboration diagram for SpecialOATHEnable:

[legend]

Public Member Functions
	__construct (OATHUserRepository $repository, OATHUser $user)
	Initialize the OATH user based on the current local User object in the context.

	alterForm (HTMLForm $form)
	Set the page title and add JavaScript RL modules.

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

	execute ( $par)

	onSubmit (array $formData)

	onSuccess ()
	Do something exciting on successful processing of the form, most likely to show a confirmation message.

	requiresUnblock ()

Public Member Functions inherited from FormSpecialPage
	requiresWrite ()
	Whether this action requires the wiki not to be locked.

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.

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

	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.

	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.

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

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

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

	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)
	Wrapper around wfMessage that sets the current context.

	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.

	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.

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

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

Protected Member Functions
	checkExecutePermissions (User $user)
	Require users to be logged in.

	getDisplayFormat ()

	getFormFields ()

	getScratchTokensForDisplay (OATHAuthKey $key)
	Retrieve current scratch tokens for display purposes.

	getSecretForDisplay (OATHAuthKey $key)
	Retrieve the current secret for display purposes.

Protected Member Functions inherited from FormSpecialPage
	getForm ()
	Get the HTMLForm to control behavior.

	getMessagePrefix ()
	Get message prefix for HTMLForm.

	postText ()
	Add post-text to the form.

	preText ()
	Add pre-text to the form.

	setParameter ( $par)
	Maybe do something interesting with the subpage parameter.

	setReauthPostData (array $data)
	Preserve POST data across reauthentication.

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.

	getCacheTTL ()

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

	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.

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

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

Private Member Functions
	createResourceList ( $resources)

	tokenFormatterFunction ( $token)
	Formats a key or scratch token by creating groups of 4 separated by space characters.

Private Attributes
OATHUserRepository	$OATHRepository

OATHUser	$OATHUser

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 FormSpecialPage
string null	$par = null
	The sub-page of the special page.

array null	$reauthPostData = null
	POST data preserved across re-authentication.

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Detailed Description

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html Special page to display key information to the user

Definition at line 24 of file SpecialOATHEnable.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialOATHEnable::__construct	(	OATHUserRepository	$repository,
		OATHUser	$user )

Initialize the OATH user based on the current local User object in the context.

Parameters

OATHUserRepository	$repository
OATHUser	$user

Definition at line 37 of file SpecialOATHEnable.php.

References $user, and and().

Member Function Documentation

◆ alterForm()

SpecialOATHEnable::alterForm ( HTMLForm $form )

Set the page title and add JavaScript RL modules.

Parameters

HTMLForm $form

Reimplemented from FormSpecialPage.

Definition at line 53 of file SpecialOATHEnable.php.

References ContextSource\getOutput(), and SpecialPage\msg().

◆ checkExecutePermissions()

SpecialOATHEnable::checkExecutePermissions ( User $user )

protected

Require users to be logged in.

Parameters

User $user

Returns: bool|void

Reimplemented from FormSpecialPage.

Definition at line 82 of file SpecialOATHEnable.php.

References SpecialPage\requireLogin().

◆ createResourceList()

SpecialOATHEnable::createResourceList ( $resources )

private

Parameters

$resources array

Returns: string

Definition at line 221 of file SpecialOATHEnable.php.

Referenced by getFormFields().

◆ doesWrites()

SpecialOATHEnable::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 44 of file SpecialOATHEnable.php.

◆ execute()

SpecialOATHEnable::execute ( $par )

Parameters

string $par

Reimplemented from FormSpecialPage.

Definition at line 91 of file SpecialOATHEnable.php.

References FormSpecialPage\$par, and SpecialPage\getOutput().

◆ getDisplayFormat()

SpecialOATHEnable::getDisplayFormat ( )

protected

Returns: string

Reimplemented from FormSpecialPage.

Definition at line 64 of file SpecialOATHEnable.php.

◆ getFormFields()

SpecialOATHEnable::getFormFields ( )

protected

Returns: array[]

Reimplemented from FormSpecialPage.

Definition at line 99 of file SpecialOATHEnable.php.

References and(), createResourceList(), OATHUser\getAccount(), OATHUser\getIssuer(), SpecialPage\getRequest(), getScratchTokensForDisplay(), getSecretForDisplay(), SpecialPage\msg(), and OATHAuthKey\newFromRandom().

◆ getScratchTokensForDisplay()

SpecialOATHEnable::getScratchTokensForDisplay ( OATHAuthKey $key )

protected

Retrieve current scratch tokens for display purposes.

The characters of the token are split in groups of 4

Parameters

OATHAuthKey $key

Returns: string[]

Definition at line 249 of file SpecialOATHEnable.php.

References and(), and OATHAuthKey\getScratchTokens().

Referenced by getFormFields().

◆ getSecretForDisplay()

SpecialOATHEnable::getSecretForDisplay ( OATHAuthKey $key )

protected

Retrieve the current secret for display purposes.

The characters of the token are split in groups of 4

Parameters

OATHAuthKey $key

Returns: String

Definition at line 237 of file SpecialOATHEnable.php.

References OATHAuthKey\getSecret(), and tokenFormatterFunction().

Referenced by getFormFields().

◆ onSubmit()

SpecialOATHEnable::onSubmit ( array $formData )

Parameters

array $formData

Returns: array|bool

Reimplemented from FormSpecialPage.

Definition at line 181 of file SpecialOATHEnable.php.

References SpecialPage\getName(), SpecialPage\getRequest(), SpecialPage\getUser(), and OATHUser\setKey().

◆ onSuccess()

SpecialOATHEnable::onSuccess ( )

Do something exciting on successful processing of the form, most likely to show a confirmation message.

Since: 1.22 Default is to do nothing

Reimplemented from FormSpecialPage.

Definition at line 212 of file SpecialOATHEnable.php.

References SpecialPage\getOutput().

◆ requiresUnblock()

SpecialOATHEnable::requiresUnblock ( )

Returns: bool

Reimplemented from FormSpecialPage.

Definition at line 71 of file SpecialOATHEnable.php.

◆ tokenFormatterFunction()

SpecialOATHEnable::tokenFormatterFunction ( $token )

private

Formats a key or scratch token by creating groups of 4 separated by space characters.

Parameters

string $token Token to format

Returns: string The token formatted for display

Definition at line 259 of file SpecialOATHEnable.php.

References and().

Referenced by getSecretForDisplay().

Member Data Documentation

◆ $OATHRepository

OATHUserRepository SpecialOATHEnable::$OATHRepository

private

Definition at line 26 of file SpecialOATHEnable.php.

◆ $OATHUser

OATHUser SpecialOATHEnable::$OATHUser

private

Definition at line 29 of file SpecialOATHEnable.php.

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

extensions/OATHAuth/includes/special/SpecialOATHEnable.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ checkExecutePermissions()

◆ createResourceList()

◆ doesWrites()

◆ execute()

◆ getDisplayFormat()

◆ getFormFields()

◆ getScratchTokensForDisplay()

◆ getSecretForDisplay()

◆ onSubmit()

◆ onSuccess()

◆ requiresUnblock()

◆ tokenFormatterFunction()

Member Data Documentation

◆ $OATHRepository

◆ $OATHUser