GatewayPage This class is the generic unlisted special page in charge of actually displaying the form. More...

Inheritance diagram for GatewayPage:

[legend]

Collaboration diagram for GatewayPage:

[legend]

Public Member Functions
	__construct ()
	Constructor.

	displayFailPage ()
	Display a failure page.

	displayForm ()
	Build and display form to user.

	execute ( $par)
	Show the special page.

	setClientVariables (&$vars)
	MakeGlobalVariablesScript handler, sends settings to Javascript.

	setClientVariablesWithErrorHandling (&$vars)

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

	showContinueButton ()
	Integrations that never need a continue button should override to return false.

	showSubmethodButtons ()
	Integrations that do not show submethod buttons should override to return false.

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

Static Public Member Functions
static	getGatewayPageName (string $gatewayId, Config $mwConfig)
	Get the name of the special page for a gateway.

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.

Public Attributes
GatewayAdapter	$adapter
	The gateway adapter object.

bool	$supportsMonthlyConvert = false
	flag for setting Monthly Convert modal on template

Protected Member Functions
	addGatewaySpecificResources (OutputPage $out)
	Override this to add any gateway-specific scripts or stylesheets that can't be loaded via ResourceLoader (gateway-specific ResourceLoader modules are listed in ui_modules.yaml and loaded in Gateway_Form_Mustache::getResources).

	displayResultsForDebug (PaymentTransactionResponse $results=null)
	displayResultsForDebug

	getGatewayIdentifier ()
	Get the current adapter class.

	getLogPrefix ()
	Try to get donor information to tag log entries in case we don't have an adapter instance.

	getVariant ()

	handleDonationRequest ()
	Respond to a donation request.

	handleRequest ()
	Handle the donation request.

	isProcessImmediate ()
	Determine if we should attempt to process the payment now.

	processPayment ()
	Ask the adapter to perform a payment.

	renderIframe ( $url)
	Append iframe.

	renderResponse (PaymentResult $result)
	Take UI action suggested by the payment result.

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.

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

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

Protected Attributes
string	$gatewayIdentifier
	Derived classes must override this with the identifier of the gateway as set in GatewayAdapter::IDENTIFIER.

Psr Log LoggerInterface	$logger
	Gateway-specific logger.

bool	$showError = false
	When true, display an error form rather than the standard payment form.

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

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

GatewayPage This class is the generic unlisted special page in charge of actually displaying the form.

Each gateway will have one or more direct descendants of this class, with most of the gateway-specific control logic in its handleRequest function. For instance: extensions/DonationInterface/globalcollect_gateway/globalcollect_gateway.body.php

*** Constraint for implementing classes *** The special page name must always be the gateway adapter class name with 'Adapter' replaced with 'Gateway'.

Definition at line 34 of file GatewayPage.php.

Constructor & Destructor Documentation

◆ __construct()

GatewayPage::__construct ( )

Constructor.

Definition at line 69 of file GatewayPage.php.

Member Function Documentation

◆ addGatewaySpecificResources()

GatewayPage::addGatewaySpecificResources ( OutputPage $out )

protected

Override this to add any gateway-specific scripts or stylesheets that can't be loaded via ResourceLoader (gateway-specific ResourceLoader modules are listed in ui_modules.yaml and loaded in Gateway_Form_Mustache::getResources).

For example, scripts hosted by the payment provider could be added here.

Parameters

OutputPage $out

Reimplemented in BraintreeGateway.

Definition at line 600 of file GatewayPage.php.

Referenced by displayForm().

◆ displayFailPage()

GatewayPage::displayFailPage ( )

Display a failure page.

Definition at line 221 of file GatewayPage.php.

References displayForm(), SpecialPage\getConfig(), SpecialPage\getOutput(), and SpecialPage\msg().

Referenced by execute(), ResultSwitcher\handleResultRequest(), and renderResponse().

◆ displayForm()

GatewayPage::displayForm ( )

Build and display form to user.

Definition at line 187 of file GatewayPage.php.

References addGatewaySpecificResources(), SpecialPage\getHookContainer(), and SpecialPage\getOutput().

Referenced by displayFailPage(), handleDonationRequest(), and renderResponse().

◆ displayResultsForDebug()

GatewayPage::displayResultsForDebug ( PaymentTransactionResponse $results = null )

protected

displayResultsForDebug

Displays useful information for debugging purposes. Enable with $wgDonationInterfaceDisplayDebug, or the adapter equivalent.

Parameters

PaymentTransactionResponse | null $results

Returns: null

Definition at line 254 of file GatewayPage.php.

References SpecialPage\getOutput(), and SpecialPage\getRequest().

◆ execute()

GatewayPage::execute ( $par )

Show the special page.

Parameters

string | null $par parameter passed to the page or null

Reimplemented from SpecialPage.

Reimplemented in DlocalGateway.

Definition at line 79 of file GatewayPage.php.

References displayFailPage(), DonationInterface\getAdapterClassForGateway(), SpecialPage\getConfig(), SpecialPage\getContext(), getGatewayIdentifier(), DonationLoggerFactory\getLogger(), DonationLoggerFactory\getLoggerForType(), getLogPrefix(), SpecialPage\getOutput(), SpecialPage\getRequest(), getVariant(), handleRequest(), and DonationInterface\setSmashPigProvider().

◆ getGatewayIdentifier()

GatewayPage::getGatewayIdentifier ( )

protected

Get the current adapter class.

Returns: string containing the chosen adapter class name

Override if your page selects between multiple adapters based on context.

Definition at line 242 of file GatewayPage.php.

References $gatewayIdentifier.

Referenced by execute().

◆ getGatewayPageName()

static GatewayPage::getGatewayPageName	(	string	$gatewayId,
		Config	$mwConfig )

static

Get the name of the special page for a gateway.

Parameters

string	$gatewayId
Config	$mwConfig	MediaWiki Config

Returns: string

Definition at line 572 of file GatewayPage.php.

Referenced by GatewayChooser\buildGatewayPageURL().

◆ getLogPrefix()

GatewayPage::getLogPrefix ( )

protected

Try to get donor information to tag log entries in case we don't have an adapter instance.

Returns: string

Definition at line 447 of file GatewayPage.php.

References SpecialPage\getRequest().

Referenced by execute().

◆ getVariant()

GatewayPage::getVariant ( )

protected

Definition at line 532 of file GatewayPage.php.

References SpecialPage\getRequest().

Referenced by execute().

◆ handleDonationRequest()

GatewayPage::handleDonationRequest ( )

protected

Respond to a donation request.

Definition at line 317 of file GatewayPage.php.

References displayForm(), isProcessImmediate(), processPayment(), and setHeaders().

Referenced by handleRequest().

◆ handleRequest()

GatewayPage::handleRequest ( )

protected

Handle the donation request.

FIXME: Be more disciplined about how handleRequest fits with handleDonationRequest. Would it be cleaner to move to a pre and post hook scheme?

Reimplemented in ResultSwitcher, and PaypalExpressGatewayResult.

Definition at line 180 of file GatewayPage.php.

References handleDonationRequest().

Referenced by execute().

◆ isProcessImmediate()

GatewayPage::isProcessImmediate ( )

protected

Determine if we should attempt to process the payment now.

Returns: bool True if we should attempt processing.

Definition at line 357 of file GatewayPage.php.

Referenced by handleDonationRequest().

◆ processPayment()

GatewayPage::processPayment ( )

protected

Ask the adapter to perform a payment.

Route the donor based on the response.

Definition at line 378 of file GatewayPage.php.

References renderResponse().

Referenced by handleDonationRequest().

◆ renderIframe()

GatewayPage::renderIframe ( $url )

protected

Append iframe.

TODO: Should be rendered by the template.

Parameters

string $url

Definition at line 425 of file GatewayPage.php.

References SpecialPage\getOutput().

Referenced by renderResponse().

◆ renderResponse()

GatewayPage::renderResponse ( PaymentResult $result )

protected

Take UI action suggested by the payment result.

Parameters

PaymentResult $result returned by gateway adapter's doPayment or processDonorReturn function

Definition at line 387 of file GatewayPage.php.

References displayFailPage(), displayForm(), PaymentResult\getErrors(), PaymentResult\getIframe(), SpecialPage\getOutput(), PaymentResult\getRedirect(), ResultPages\getThankYouPage(), PaymentResult\isFailed(), and renderIframe().

Referenced by ResultSwitcher\handleResultRequest(), and processPayment().

◆ setClientVariables()

GatewayPage::setClientVariables ( & $vars )

MakeGlobalVariablesScript handler, sends settings to Javascript.

Parameters

array &$vars

Reimplemented in AdyenCheckoutGateway, AmazonGateway, BraintreeGateway, DlocalGateway, and ResultSwitcher.

Definition at line 493 of file GatewayPage.php.

References MessageUtils\getCountrySpecificMessage(), SpecialPage\getRequest(), and ResultPages\getThankYouPage().

Referenced by setClientVariablesWithErrorHandling().

◆ setClientVariablesWithErrorHandling()

GatewayPage::setClientVariablesWithErrorHandling ( & $vars )

Definition at line 469 of file GatewayPage.php.

References SpecialPage\getRequest(), and setClientVariables().

◆ setHeaders()

GatewayPage::setHeaders ( )

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

Reimplemented from SpecialPage.

Definition at line 461 of file GatewayPage.php.

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

Referenced by handleDonationRequest(), and ResultSwitcher\handleResultRequest().

◆ showContinueButton()

GatewayPage::showContinueButton ( )

Integrations that never need a continue button should override to return false.

Returns: bool

Reimplemented in AdyenCheckoutGateway, AmazonGateway, BraintreeGateway, and DlocalGateway.

Definition at line 561 of file GatewayPage.php.

◆ showSubmethodButtons()

GatewayPage::showSubmethodButtons ( )

Integrations that do not show submethod buttons should override to return false.

Returns: bool

Reimplemented in AdyenCheckoutGateway, AdyenCheckoutGatewayResult, AmazonGateway, DlocalGateway, and PaypalExpressGateway.

Definition at line 552 of file GatewayPage.php.

Member Data Documentation

◆ $adapter

GatewayAdapter GatewayPage::$adapter

The gateway adapter object.

Definition at line 52 of file GatewayPage.php.

◆ $gatewayIdentifier

string GatewayPage::$gatewayIdentifier

protected

Derived classes must override this with the identifier of the gateway as set in GatewayAdapter::IDENTIFIER.

Definition at line 46 of file GatewayPage.php.

Referenced by getGatewayIdentifier().

◆ $logger

Psr Log LoggerInterface GatewayPage::$logger

protected

Gateway-specific logger.

Definition at line 58 of file GatewayPage.php.

◆ $showError

bool GatewayPage::$showError = false

protected

When true, display an error form rather than the standard payment form.

Definition at line 64 of file GatewayPage.php.

◆ $supportsMonthlyConvert

bool GatewayPage::$supportsMonthlyConvert = false

flag for setting Monthly Convert modal on template

Definition at line 39 of file GatewayPage.php.

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

extensions/DonationInterface/gateway_common/GatewayPage.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addGatewaySpecificResources()

◆ displayFailPage()

◆ displayForm()

◆ displayResultsForDebug()

◆ execute()

◆ getGatewayIdentifier()

◆ getGatewayPageName()

◆ getLogPrefix()

◆ getVariant()

◆ handleDonationRequest()

◆ handleRequest()

◆ isProcessImmediate()

◆ processPayment()

◆ renderIframe()

◆ renderResponse()

◆ setClientVariables()

◆ setClientVariablesWithErrorHandling()

◆ setHeaders()

◆ showContinueButton()

◆ showSubmethodButtons()

Member Data Documentation

◆ $adapter

◆ $gatewayIdentifier

◆ $logger

◆ $showError

◆ $supportsMonthlyConvert