ApiQueryUserInfo Class Reference

Query module to get information about the currently logged-in user. More...

Inheritance diagram for ApiQueryUserInfo:

Collaboration diagram for ApiQueryUserInfo:

Public Member Functions
	__construct (ApiQuery $query, $moduleName)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	getAllowedParams ()
	Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
	getHelpUrls ()
	Return links to more detailed help pages about the module.
Public Member Functions inherited from ApiQueryBase
	__construct (ApiQuery $queryModule, $moduleName, $paramPrefix='')
	Stable to call.
	getCacheMode ( $params)
	Get the cache mode for the data generated by this module.
	requestExtraData ( $pageSet)
	Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName')
	showHiddenUsersAddBlockInfo ( $showBlockInfo)
	Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block information.
	getQuery ()
	Get the main Query module.
	getParent ()
	Get the parent of this module Stable to override. Since 1.25 Returns ApiBase|null
	selectNamedDB ( $name, $db, $groups)
	Selects the query database connection with the given name.
	titlePartToKey ( $titlePart, $namespace=NS_MAIN)
	Convert an input title or title prefix into a dbkey.
	prefixedTitlePartToKey ( $titlePart, $defaultNamespace=NS_MAIN)
	Convert an input title or title prefix into a namespace constant and dbkey.
	validateSha1Hash ( $hash)
	validateSha1Base36Hash ( $hash)
	userCanSeeRevDel ()
	Check whether the current user has permission to view revision-deleted fields.
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.
	shouldCheckMaxlag ()
	Indicates if this module needs maxlag to be checked Stable to override.
	isReadMode ()
	Indicates whether this module requires read rights 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.
	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)

Static Public Member Functions
static	getCentralUserInfo (Config $config, User $user, $attachedWiki=null)
	Get central user info.
Static Public Member Functions inherited from ApiQueryBase
static	addTitleInfo (&$arr, $title, $prefix='')
	Add information (title and namespace) about a Title object to a result array.
Static Public Member Functions inherited from ApiBase
static	makeMessage ( $msg, IContextSource $context, array $params=null)
	Create a Message from a string or array.

Protected Member Functions
	getCurrentUserInfo ()
	getExamplesMessages ()
	Returns usage examples for this module.
	getLatestContributionTime ()
	getRateLimits ()
Protected Member Functions inherited from ApiQueryBase
	resetQueryParams ()
	Blank the internal arrays with query parameters.
	getQueryBuilder ()
	Get the SelectQueryBuilder.
	addTables ( $tables, $alias=null)
	Add a set of tables to the internal array.
	addJoinConds ( $join_conds)
	Add a set of JOIN conditions to the internal array.
	addFields ( $value)
	Add a set of fields to select to the internal array.
	addFieldsIf ( $value, $condition)
	Same as addFields(), but add the fields only if a condition is met.
	addWhere ( $value)
	Add a set of WHERE clauses to the internal array.
	addWhereIf ( $value, $condition)
	Same as addWhere(), but add the WHERE clauses only if a condition is met.
	addWhereFld ( $field, $value)
	Equivalent to addWhere( [ $field => $value ] )
	addWhereIDsFld ( $table, $field, $ids)
	Like addWhereFld for an integer list of IDs.
	addWhereRange ( $field, $dir, $start, $end, $sort=true)
	Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.
	addTimestampWhereRange ( $field, $dir, $start, $end, $sort=true)
	Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end to database timestamps.
	addOption ( $name, $value=null)
	Add an option such as LIMIT or USE INDEX.
	select ( $method, $extraQuery=[], array &$hookData=null)
	Execute a SELECT query based on the values in the internal arrays.
	processRow ( $row, array &$data, array &$hookData)
	Call the ApiQueryBaseProcessRow hook.
	getDB ()
	Get the Query database connection (read-only) Stable to override.
	getPageSet ()
	Get the PageSet object to work on Stable to override.
	addPageSubItems ( $pageId, $data)
	Add a sub-element under the page element with the given page ID.
	addPageSubItem ( $pageId, $item, $elemname=null)
	Same as addPageSubItems(), but one element of $data at a time.
	setContinueEnumParameter ( $paramName, $paramValue)
	Set a query-continue value.
	parsePrefixedTitlePart ( $titlePart, $defaultNamespace=NS_MAIN)
	Convert an input title or title prefix into a TitleValue.
	executeGenderCacheFromResultWrapper (IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
	Preprocess the result set to fill the GenderCache with the necessary information before using self::addTitleInfo.
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.
	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.

Private Attributes
array	$params = []
array	$prop = []
const	WL_UNREAD_LIMIT = 1000

Additional Inherited Members
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.
Static Protected Member Functions inherited from ApiBase
static	dieDebug ( $method, $message)
	Internal code errors should be reported with this method.

Detailed Description

Query module to get information about the currently logged-in user.

Definition at line 30 of file ApiQueryUserInfo.php.

Constructor & Destructor Documentation

__construct()

ApiQueryUserInfo::__construct	(	ApiQuery	$query,
			$moduleName )

Definition at line 41 of file ApiQueryUserInfo.php.

Member Function Documentation

execute()

ApiQueryUserInfo::execute

(

)

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 45 of file ApiQueryUserInfo.php.

References ApiBase\extractRequestParams(), getCurrentUserInfo(), ApiBase\getModuleName(), and ApiBase\getResult().

getAllowedParams()

ApiQueryUserInfo::getAllowedParams

(

)

Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Stable to override

Returns

array

Reimplemented from ApiBase.

Definition at line 301 of file ApiQueryUserInfo.php.

References ApiBase\getModulePrefix(), ApiBase\PARAM_ALL, ApiBase\PARAM_DEPRECATED_VALUES, ApiBase\PARAM_HELP_MSG_PER_VALUE, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.

getCentralUserInfo()

static ApiQueryUserInfo::getCentralUserInfo ( Config $config, User $user, $attachedWiki = null )

static

Get central user info.

Parameters

Config	$config
User	$user
string | null	$attachedWiki

Returns

array Central user info

• centralids: Array mapping non-local Central ID provider names to IDs
• attachedlocal: Array mapping Central ID provider names to booleans indicating whether the local user is attached.
• attachedwiki: Array mapping Central ID provider names to booleans indicating whether the user is attached to $attachedWiki.

Definition at line 69 of file ApiQueryUserInfo.php.

References Config\get(), and User\getName().

Referenced by ApiQueryAllUsers\execute(), ApiQueryUsers\execute(), and getCurrentUserInfo().

getCurrentUserInfo()

ApiQueryUserInfo::getCurrentUserInfo ( )

protected

Definition at line 96 of file ApiQueryUserInfo.php.

References $lang, getCentralUserInfo(), ContextSource\getConfig(), getLatestContributionTime(), ApiBase\getMain(), ApiBase\getPermissionManager(), getRateLimits(), ContextSource\getRequest(), ContextSource\getUser(), ApiBase\lacksSameOriginSecurity(), and wfTimestamp().

Referenced by execute().

getExamplesMessages()

ApiQueryUserInfo::getExamplesMessages ( )

protected

Returns usage examples for this module.

Return value has query strings as keys, with values being either strings (message key), arrays (message key + parameter), or Message objects.

Do not call this base class implementation when overriding this method.

Since

1.25 Stable to override

Returns

array

Reimplemented from ApiBase.

Definition at line 345 of file ApiQueryUserInfo.php.

getHelpUrls()

ApiQueryUserInfo::getHelpUrls

(

)

Return links to more detailed help pages about the module.

Since

1.25, returning boolean false is deprecated Stable to override

Returns

string|array

Reimplemented from ApiBase.

Definition at line 354 of file ApiQueryUserInfo.php.

getLatestContributionTime()

ApiQueryUserInfo::getLatestContributionTime ( )

protected

Returns

string|null ISO 8601 timestamp of current user's last contribution or null if none

Definition at line 285 of file ApiQueryUserInfo.php.

References $dbr, $res, ApiQueryBase\getDB(), ContextSource\getUser(), and wfTimestamp().

Referenced by getCurrentUserInfo().

getRateLimits()

ApiQueryUserInfo::getRateLimits ( )

protected

Definition at line 243 of file ApiQueryUserInfo.php.

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

Referenced by getCurrentUserInfo().

Member Data Documentation

$params

array ApiQueryUserInfo::$params = []

private

Definition at line 37 of file ApiQueryUserInfo.php.

$prop

array ApiQueryUserInfo::$prop = []

private

Definition at line 39 of file ApiQueryUserInfo.php.

WL_UNREAD_LIMIT

const ApiQueryUserInfo::WL_UNREAD_LIMIT = 1000

private

Definition at line 34 of file ApiQueryUserInfo.php.

---

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

• includes/api/ApiQueryUserInfo.php