MatchingGifts Employer Search API. More...

Inheritance diagram for EmployerSearchAPI:

[legend]

Collaboration diagram for EmployerSearchAPI:

[legend]

Public Member Functions
	execute ()
	Read in the Employers file, transform it to an array and then filter results against the search query.

	getAllowedParams ()

	isReadMode ()
	Indicates whether this module requires read rights Stable to override.

Public Member Functions inherited from ApiBase
	__construct (ApiMain $mainModule, $moduleName, $modulePrefix='')
	Stable to call.

	getModuleManager ()
	Get the module manager, or null if this module has no sub-modules.

	getCustomPrinter ()
	If the module may only be used with a certain format module, it should override this method to return an instance of that formatter.

	getHelpUrls ()
	Return links to more detailed help pages about the module.

	shouldCheckMaxlag ()
	Indicates if this module needs maxlag to be checked Stable to override.

	isWriteMode ()
	Indicates whether this module requires write mode.

	mustBePosted ()
	Indicates whether this module must be called with a POST request Stable to override.

	isDeprecated ()
	Indicates whether this module is deprecated.

	isInternal ()
	Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable.

	needsToken ()
	Returns the token type this module requires in order to execute.

	getConditionalRequestData ( $condition)
	Returns data for HTTP conditional request mechanisms.

	getModuleName ()
	Get the name of the module being executed by this instance.

	getModulePrefix ()
	Get parameter prefix (usually two letters or an empty string).

	getMain ()
	Get the main module.

	isMain ()
	Returns true if this module is the main module ($this === $this->mMainModule), false otherwise.

	getParent ()
	Get the parent of this module Stable to override.

	lacksSameOriginSecurity ()
	Returns true if the current request breaks the same-origin policy.

	getModulePath ()
	Get the path to this module.

	getModuleFromPath ( $path)
	Get a module from its module path.

	getResult ()
	Get the result object.

	getErrorFormatter ()
	Get the error formatter Stable to override.

	getContinuationManager ()
	Get the continuation manager.

	setContinuationManager (ApiContinuationManager $manager=null)
	Set the continuation manager.

	dynamicParameterDocumentation ()
	Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams().

	encodeParamName ( $paramName)
	This method mangles parameter name based on the prefix supplied to the constructor.

	extractRequestParams ( $options=[])
	Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default.

	requireOnlyOneParameter ( $params,... $required)
	Die if none or more than one of a certain set of parameters is set and not false.

	requireMaxOneParameter ( $params,... $required)
	Die if more than one of a certain set of parameters is set and not false.

	requireAtLeastOneParameter ( $params,... $required)
	Die if none of a certain set of parameters is set and not false.

	requirePostedParameters ( $params, $prefix='prefix')
	Die if any of the specified parameters were found in the query part of the URL rather than the post body.

	getTitleOrPageId ( $params, $load=false)
	Get a WikiPage object from a title or pageid param, if possible.

	getTitleFromTitleOrPageId ( $params)
	Get a Title object from a title or pageid param, if possible.

	handleParamNormalization ( $paramName, $value, $rawValue)
	Handle when a parameter was Unicode-normalized.

	validateToken ( $token, array $params)
	Validate the supplied token.

	getWatchlistUser ( $params)
	Gets the user for whom to get the watchlist.

	errorArrayToStatus (array $errors, User $user=null)
	Turn an array of message keys or key+param arrays into a Status.

	addBlockInfoToStatus (StatusValue $status, User $user=null)
	Add block info to block messages in a Status.

	addWarning ( $msg, $code=null, $data=null)
	Add a warning for this module.

	addDeprecation ( $msg, $feature, $data=[])
	Add a deprecation warning for this module.

	addError ( $msg, $code=null, $data=null)
	Add an error for this module without aborting.

	addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
	Add warnings and/or errors from a Status.

	dieWithError ( $msg, $code=null, $data=null, $httpCode=0)
	Abort execution with an error.

	dieWithException (Throwable $exception, array $options=[])
	Abort execution with an error derived from a throwable.

	dieBlocked (AbstractBlock $block)
	Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info.

	dieStatus (StatusValue $status)
	Throw an ApiUsageException based on the Status object.

	dieReadOnly ()
	Helper function for readonly errors.

	checkUserRightsAny ( $rights, $user=null)
	Helper function for permission-denied errors.

	checkTitleUserPermissions (LinkTarget $linkTarget, $actions, array $options=[])
	Helper function for permission-denied errors.

	dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null)
	Will only set a warning instead of failing if the global $wgDebugAPI is set to true.

	logFeatureUsage ( $feature)
	Write logging information for API features to a debug log, for usage analysis.

	getFinalSummary ()
	Get final module summary.

	getFinalDescription ()
	Get final module description, after hooks have had a chance to tweak it as needed.

	getFinalParams ( $flags=0)
	Get final list of parameters, after hooks have had a chance to tweak it as needed.

	getFinalParamDescription ()
	Get final parameter descriptions, after hooks have had a chance to tweak it as needed.

	modifyHelp (array &$help, array $options, array &$tocData)
	Called from ApiHelp before the pieces are joined together and returned.

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()
	Stable to override.

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)

Public Attributes
const	CACHE_KEY = 'EmployersList'
	Key for employers list in object cache.

const	CACHE_TTL = 3600
	TTL for employers list in object cache, in seconds (set to 1 hour)

const	MAX_RESULTS = 10
	Maximum number of results to return.

Public Attributes inherited from ApiBase
const	ALL_DEFAULT_STRING = '*'

const	GET_VALUES_FOR_HELP = 1
	getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough.

const	LIMIT_BIG1 = 500
	Fast query, standard limit.

const	LIMIT_BIG2 = 5000
	Fast query, apihighlimits limit.

const	LIMIT_SML1 = 50
	Slow query, standard limit.

const	LIMIT_SML2 = 500
	Slow query, apihighlimits limit.

const	PARAM_DFLT = ParamValidator::PARAM_DEFAULT

const	PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI

const	PARAM_TYPE = ParamValidator::PARAM_TYPE

const	PARAM_MAX = IntegerDef::PARAM_MAX

const	PARAM_MAX2 = IntegerDef::PARAM_MAX2

const	PARAM_MIN = IntegerDef::PARAM_MIN

const	PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES

const	PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED

const	PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED

const	PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP

const	PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX

const	PARAM_ALL = ParamValidator::PARAM_ALL

const	PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES

const	PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE

const	PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES

const	PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1

const	PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2

const	PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES

const	PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS

const	PARAM_RANGE_ENFORCE = 'api-param-range-enforce'
	(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE

const	PARAM_HELP_MSG = 'api-param-help-msg'
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter.

const	PARAM_HELP_MSG_APPEND = 'api-param-help-msg-append'
	((string\|array\|Message)[]) Specify additional i18n messages to append to the normal message for this parameter.

const	PARAM_HELP_MSG_INFO = 'api-param-help-msg-info'
	(array) Specify additional information tags for the parameter.

const	PARAM_VALUE_LINKS = 'api-param-value-links'
	Deprecated and unused.

const	PARAM_HELP_MSG_PER_VALUE = 'api-param-help-msg-per-value'
	((string\|array\|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage().

const	PARAM_TEMPLATE_VARS = 'param-template-vars'
	(array) Indicate that this is a templated parameter, and specify replacements.

Protected Member Functions
	getEmployersList ()
	Return an array of employers, where values are associative arrays with id and name keys.

	getExamplesMessages ()

Protected Member Functions inherited from ApiBase
	explodeMultiValue ( $value, $limit)
	Split a multi-valued parameter string, like explode()

	parseMultiValue ( $valueName, $value, $allowMultiple, $allowedValues, $allSpecifier=null, $limit1=null, $limit2=null)
	Return an array of values that were given in a 'a\|b\|c' notation, after it optionally validates them against the list allowed values.

	validateLimit ( $name, &$value, $min, $max, $botMax=null, $enforceLimits=false)
	Validate the value against the minimum and user/bot maximum limits.

	validateTimestamp ( $value, $encParamName)
	Validate and normalize parameters of type 'timestamp'.

	getWebUITokenSalt (array $params)
	Fetch the salt used in the Web UI corresponding to this module.

	getDB ()
	Gets a default replica DB connection object Stable to override.

	getPermissionManager ()
	Obtain a PermissionManager instance that subclasses may use in their authorization checks.

	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata.

	getHookRunner ()
	Get an ApiHookRunner for running core API hooks.

	getParameter ( $paramName, $parseLimit=true)
	Get a value for the given parameter.

	getParameterFromSettings ( $name, $settings, $parseLimit)
	Using the settings determine the value for the given parameter.

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

	filterIDs ( $fields, array $ids)
	Filter out-of-range values from a list of positive integer IDs.

	dieContinueUsageIf ( $condition)
	Die with the 'badcontinue' error.

	getSummaryMessage ()
	Return the summary message.

	getExtendedDescription ()
	Return the extended help text message.

	getHelpFlags ()
	Generates the list of flags for the help screen and for action=paraminfo.

	getModuleSourceInfo ()
	Returns information about the source of this module, if known.

Protected Attributes
string	$apiError

Psr Log LoggerInterface	$logger

Private Member Functions
	initLogger ()
	Set up the Logger instance.

	setError ( $errorMsg)
	Set the API error string and log an error.

Additional Inherited Members
Static Public Member Functions inherited from ApiBase
static	makeMessage ( $msg, IContextSource $context, array $params=null)
	Create a Message from a string or array.

Static Protected Member Functions inherited from ApiBase
static	dieDebug ( $method, $message)
	Internal code errors should be reported with this method.

Detailed Description

MatchingGifts Employer Search API.

This API allows for the searching of companies which can then be used to populate the Employer field across the paymentswiki forms.

The datasource for this API is currently a CSV which contains the full list of matchin gift employers available and is provided to us via a third party. A separate process manages updating that datasource.

Definition at line 16 of file employerSearch.api.php.

Member Function Documentation

◆ execute()

EmployerSearchAPI::execute ( )

Read in the Employers file, transform it to an array and then filter results against the search query.

Reimplemented from ApiBase.

Definition at line 47 of file employerSearch.api.php.

References $cache, getEmployersList(), ApiBase\getParameter(), ApiBase\getResult(), and initLogger().

◆ getAllowedParams()

EmployerSearchAPI::getAllowedParams ( )

Returns: array

Reimplemented from ApiBase.

Definition at line 88 of file employerSearch.api.php.

References true.

◆ getEmployersList()

EmployerSearchAPI::getEmployersList ( )

protected

Return an array of employers, where values are associative arrays with id and name keys.

The data is based on the configured employer csv file. Returns false if there was a problem loading or parsing the file.

Returns: array|bool

Definition at line 107 of file employerSearch.api.php.

References ContextSource\getConfig(), and setError().

Referenced by execute().

◆ getExamplesMessages()

EmployerSearchAPI::getExamplesMessages ( )

protected

See also: ApiBase::getExamplesMessages()

Returns: array

Reimplemented from ApiBase.

Definition at line 96 of file employerSearch.api.php.

◆ initLogger()

EmployerSearchAPI::initLogger ( )

private

Set up the Logger instance.

Note: It looks like we currently need a gateway to be set to use DonationInterface Logger.

Definition at line 165 of file employerSearch.api.php.

References DonationInterface\getAdapterClassForGateway(), and DonationLoggerFactory\getLogger().

Referenced by execute().

◆ isReadMode()

EmployerSearchAPI::isReadMode ( )

Indicates whether this module requires read rights Stable to override.

Returns: bool

Reimplemented from ApiBase.

Definition at line 177 of file employerSearch.api.php.

◆ setError()

EmployerSearchAPI::setError ( $errorMsg )

private

Set the API error string and log an error.

Parameters

string $errorMsg

Definition at line 152 of file employerSearch.api.php.

Referenced by getEmployersList().

Member Data Documentation

◆ $apiError

string EmployerSearchAPI::$apiError

protected

Definition at line 21 of file employerSearch.api.php.

◆ $logger

Psr Log LoggerInterface EmployerSearchAPI::$logger

protected

Definition at line 26 of file employerSearch.api.php.

◆ CACHE_KEY

const EmployerSearchAPI::CACHE_KEY = 'EmployersList'

Key for employers list in object cache.

Definition at line 31 of file employerSearch.api.php.

◆ CACHE_TTL

const EmployerSearchAPI::CACHE_TTL = 3600

TTL for employers list in object cache, in seconds (set to 1 hour)

Definition at line 36 of file employerSearch.api.php.

◆ MAX_RESULTS

const EmployerSearchAPI::MAX_RESULTS = 10

Maximum number of results to return.

Definition at line 41 of file employerSearch.api.php.

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

extensions/DonationInterface/gateway_common/employerSearch.api.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ execute()

◆ getAllowedParams()

◆ getEmployersList()

◆ getExamplesMessages()

◆ initLogger()

◆ isReadMode()

◆ setError()

Member Data Documentation

◆ $apiError

◆ $logger

◆ CACHE_KEY

◆ CACHE_TTL

◆ MAX_RESULTS