BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
ApiQueryInfo Class Reference
Inheritance diagram for ApiQueryInfo:
Collaboration diagram for ApiQueryInfo:

Public Member Functions

 __construct (ApiQuery $query, $moduleName)
 
 requestExtraData ($pageSet)
 
 getCacheMode ($params)
 
 getAllowedParams ()
 
 getHelpUrls ()
 
- Public Member Functions inherited from ApiQueryBase
 __construct (ApiQuery $queryModule, $moduleName, $paramPrefix= '')
 
 getCacheMode ($params)
 
 requestExtraData ($pageSet)
 
 getQuery ()
 
 getParent ()
 
 selectNamedDB ($name, $db, $groups)
 
 prepareUrlQuerySearchString ($query=null, $protocol=null)
 
 showHiddenUsersAddBlockInfo ($showBlockInfo)
 
 titlePartToKey ($titlePart, $namespace=NS_MAIN)
 
 prefixedTitlePartToKey ($titlePart, $defaultNamespace=NS_MAIN)
 
 validateSha1Hash ($hash)
 
 validateSha1Base36Hash ($hash)
 
 userCanSeeRevDel ()
 
- Public Member Functions inherited from ApiBase
 __construct (ApiMain $mainModule, $moduleName, $modulePrefix= '')
 
 execute ()
 
 getModuleManager ()
 
 getCustomPrinter ()
 
 getHelpUrls ()
 
 shouldCheckMaxlag ()
 
 isReadMode ()
 
 isWriteMode ()
 
 mustBePosted ()
 
 isDeprecated ()
 
 isInternal ()
 
 needsToken ()
 
 getConditionalRequestData ($condition)
 
 getModuleName ()
 
 getModulePrefix ()
 
 getMain ()
 
 isMain ()
 
 getParent ()
 
 lacksSameOriginSecurity ()
 
 getModulePath ()
 
 getModuleFromPath ($path)
 
 getResult ()
 
 getErrorFormatter ()
 
 getContinuationManager ()
 
 setContinuationManager (ApiContinuationManager $manager=null)
 
 dynamicParameterDocumentation ()
 
 encodeParamName ($paramName)
 
 extractRequestParams ($parseLimit=true)
 
 requireOnlyOneParameter ($params, $required)
 
 requireMaxOneParameter ($params, $required)
 
 requireAtLeastOneParameter ($params, $required)
 
 requirePostedParameters ($params, $prefix= 'prefix')
 
 getTitleOrPageId ($params, $load=false)
 
 getTitleFromTitleOrPageId ($params)
 
 validateToken ($token, array $params)
 
 getWatchlistUser ($params)
 
 errorArrayToStatus (array $errors, User $user=null)
 
 addWarning ($msg, $code=null, $data=null)
 
 addDeprecation ($msg, $feature, $data=[])
 
 addError ($msg, $code=null, $data=null)
 
 addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'])
 
 dieWithError ($msg, $code=null, $data=null, $httpCode=null)
 
 dieWithException ($exception, array $options=[])
 
 dieBlocked (Block $block)
 
 dieStatus (StatusValue $status)
 
 dieReadOnly ()
 
 checkUserRightsAny ($rights, $user=null)
 
 checkTitleUserPermissions (Title $title, $actions, $user=null)
 
 dieWithErrorOrDebug ($msg, $code=null, $data=null, $httpCode=null)
 
 logFeatureUsage ($feature)
 
 getFinalSummary ()
 
 getFinalDescription ()
 
 getFinalParams ($flags=0)
 
 getFinalParamDescription ()
 
 modifyHelp (array &$help, array $options, array &$tocData)
 
 profileIn ()
 
 profileOut ()
 
 safeProfileOut ()
 
 profileDBIn ()
 
 profileDBOut ()
 
 setWarning ($warning)
 
 dieUsage ($description, $errorCode, $httpRespCode=0, $extradata=null)
 
 getErrorFromStatus ($status, &$extraData=null)
 
 parseMsg ($error)
 
 dieUsageMsg ($error)
 
 dieUsageMsgOrDebug ($error)
 
- Public Member Functions inherited from ContextSource
 getContext ()
 
 setContext (IContextSource $context)
 
 getConfig ()
 
 getRequest ()
 
 getTitle ()
 
 canUseWikiPage ()
 
 getWikiPage ()
 
 getOutput ()
 
 getUser ()
 
 getLanguage ()
 
 getSkin ()
 
 getTiming ()
 
 getStats ()
 
 msg ($key)
 
 exportSession ()
 

Static Public Member Functions

static resetTokenCache ()
 
static getEditToken ($pageid, $title)
 
static getDeleteToken ($pageid, $title)
 
static getProtectToken ($pageid, $title)
 
static getMoveToken ($pageid, $title)
 
static getBlockToken ($pageid, $title)
 
static getUnblockToken ($pageid, $title)
 
static getEmailToken ($pageid, $title)
 
static getImportToken ($pageid, $title)
 
static getWatchToken ($pageid, $title)
 
static getOptionsToken ($pageid, $title)
 
- Static Public Member Functions inherited from ApiQueryBase
static addTitleInfo (&$arr, $title, $prefix= '')
 
- Static Public Member Functions inherited from ApiBase
static truncateArray (&$arr, $limit)
 
static makeMessage ($msg, IContextSource $context, array $params=null)
 

Public Attributes

 $fld_talkid = false
 
 $fld_subjectid = false
 
 $fld_url = false
 
 $fld_readable = false
 
 $fld_watched = false
 
 $fld_watchers = false
 
 $fld_visitingwatchers = false
 
 $fld_notificationtimestamp = false
 
 $fld_preload = false
 
 $fld_displaytitle = false
 
 $fld_varianttitles = false
 
 $pageIsRedir
 
 $pageIsNew
 
 $pageTouched
 
 $pageLatest
 
 $pageLength
 
 $restrictionTypes
 
 $watched
 
 $watchers
 
 $visitingwatchers
 
 $notificationtimestamps
 
 $talkids
 
 $subjectids
 
 $displaytitles
 
 $variantTitles
 
- Public Attributes inherited from ApiQueryBase
 $mDb
 
 $tables
 
 $where
 
 $fields
 
 $options
 
 $join_conds
 
- Public Attributes inherited from ApiBase
const ALL_DEFAULT_STRING = '*'
 
const LIMIT_BIG1 = 500
 
const LIMIT_BIG2 = 5000
 
const LIMIT_SML1 = 50
 
const LIMIT_SML2 = 500
 
const GET_VALUES_FOR_HELP = 1
 
 $mModulePrefix
 
const PARAM_DFLT = 0
 
const PARAM_ISMULTI = 1
 
const PARAM_TYPE = 2
 
const PARAM_MAX = 3
 
const PARAM_MAX2 = 4
 
const PARAM_MIN = 5
 
const PARAM_ALLOW_DUPLICATES = 6
 
const PARAM_DEPRECATED = 7
 
const PARAM_REQUIRED = 8
 
const PARAM_RANGE_ENFORCE = 9
 
const PARAM_HELP_MSG = 10
 
const PARAM_HELP_MSG_APPEND = 11
 
const PARAM_HELP_MSG_INFO = 12
 
const PARAM_VALUE_LINKS = 13
 
const PARAM_HELP_MSG_PER_VALUE = 14
 
const PARAM_SUBMODULE_MAP = 15
 
const PARAM_SUBMODULE_PARAM_PREFIX = 16
 
const PARAM_ALL = 17
 
const PARAM_EXTRA_NAMESPACES = 18
 
const PARAM_SENSITIVE = 19
 
const PARAM_DEPRECATED_VALUES = 20
 
const PARAM_ISMULTI_LIMIT1 = 21
 
const PARAM_ISMULTI_LIMIT2 = 22
 
const PARAM_MAX_BYTES = 23
 
const PARAM_MAX_CHARS = 24
 

Protected Member Functions

 getTokenFunctions ()
 
 getExamplesMessages ()
 
- Protected Member Functions inherited from ApiQueryBase
 getDB ()
 
 getPageSet ()
 
 resetQueryParams ()
 
 addTables ($tables, $alias=null)
 
 addJoinConds ($join_conds)
 
 addFields ($value)
 
 addFieldsIf ($value, $condition)
 
 addWhere ($value)
 
 addWhereIf ($value, $condition)
 
 addWhereFld ($field, $value)
 
 addWhereRange ($field, $dir, $start, $end, $sort=true)
 
 addTimestampWhereRange ($field, $dir, $start, $end, $sort=true)
 
 addOption ($name, $value=null)
 
 select ($method, $extraQuery=[], array &$hookData=null)
 
 processRow ($row, array &$data, array &$hookData)
 
 addPageSubItems ($pageId, $data)
 
 addPageSubItem ($pageId, $item, $elemname=null)
 
 setContinueEnumParameter ($paramName, $paramValue)
 
- Protected Member Functions inherited from ApiBase
 getExamplesMessages ()
 
 getAllowedParams ()
 
 getWebUITokenSalt (array $params)
 
 getDB ()
 
 getParameter ($paramName, $parseLimit=true)
 
 getWatchlistValue ($watchlist, $titleObj, $userOption=null)
 
 getParameterFromSettings ($paramName, $paramSettings, $parseLimit)
 
 handleParamNormalization ($paramName, $value, $rawValue)
 
 explodeMultiValue ($value, $limit)
 
 parseMultiValue ($valueName, $value, $allowMultiple, $allowedValues, $allSpecifier=null, $limit1=null, $limit2=null)
 
 validateLimit ($paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
 
 validateTimestamp ($value, $encParamName)
 
 setWatch ($watch, $titleObj, $userOption=null)
 
 dieContinueUsageIf ($condition)
 
 getSummaryMessage ()
 
 getExtendedDescription ()
 
 getHelpFlags ()
 
 getModuleSourceInfo ()
 
 getDescription ()
 
 getParamDescription ()
 
 getExamples ()
 
 useTransactionalTimeLimit ()
 
 getDescriptionMessage ()
 

Static Protected Attributes

static $cachedTokens = []
 

Detailed Description

A query module to show basic page information.

Member Function Documentation

static ApiQueryInfo::getBlockToken (   $pageid,
  $title 
)
static
Deprecated:
since 1.24
static ApiQueryInfo::getDeleteToken (   $pageid,
  $title 
)
static
Deprecated:
since 1.24
static ApiQueryInfo::getEditToken (   $pageid,
  $title 
)
static
Deprecated:
since 1.24
static ApiQueryInfo::getEmailToken (   $pageid,
  $title 
)
static
Deprecated:
since 1.24
static ApiQueryInfo::getImportToken (   $pageid,
  $title 
)
static
Deprecated:
since 1.24
static ApiQueryInfo::getMoveToken (   $pageid,
  $title 
)
static
Deprecated:
since 1.24
static ApiQueryInfo::getOptionsToken (   $pageid,
  $title 
)
static
Deprecated:
since 1.24
static ApiQueryInfo::getProtectToken (   $pageid,
  $title 
)
static
Deprecated:
since 1.24
ApiQueryInfo::getTokenFunctions ( )
protected

Get an array mapping token names to their handler functions. The prototype for a token function is func($pageid, $title) it should return a token or false (permission denied)

Deprecated:
since 1.24
Returns
array [ tokenname => function ]
static ApiQueryInfo::getUnblockToken (   $pageid,
  $title 
)
static
Deprecated:
since 1.24
static ApiQueryInfo::getWatchToken (   $pageid,
  $title 
)
static
Deprecated:
since 1.24
ApiQueryInfo::requestExtraData (   $pageSet)
Parameters
ApiPageSet$pageSet
Returns
void
static ApiQueryInfo::resetTokenCache ( )
static
Deprecated:
since 1.24

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