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

Public Member Functions

 __construct ($main, $action)
 
 execute ()
 
 getAllowedParams ()
 
 getParamDescription ()
 
 getDescription ()
 
 getExamples ()
 
 getHelpUrls ()
 
- 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 ($manager)
 
 dynamicParameterDocumentation ()
 
 encodeParamName ($paramName)
 
 extractRequestParams ($parseLimit=true)
 
 requireOnlyOneParameter ($params, $required)
 
 requireMaxOneParameter ($params, $required)
 
 requireAtLeastOneParameter ($params, $required)
 
 requirePostedParameters ($params, $prefix= 'prefix')
 
 getTitleOrPageId ($params, $load=false)
 
 validateToken ($token, array $params)
 
 getWatchlistUser ($params)
 
 setWarning ($warning)
 
 dieUsage ($description, $errorCode, $httpRespCode=0, $extradata=null)
 
 dieBlocked (Block $block)
 
 getErrorFromStatus ($status, &$extraData=null)
 
 dieStatus ($status)
 
static dieReadOnly ()
 
 dieUsageMsg ($error)
 
 dieUsageMsgOrDebug ($error)
 
 parseMsg ($error)
 
 logFeatureUsage ($feature)
 
 getFinalDescription ()
 
 getFinalParams ($flags=0)
 
 getFinalParamDescription ()
 
 modifyHelp (array &$help, array $options, array &$tocData)
 
 makeHelpMsg ()
 
 makeHelpMsgParameters ()
 
 getModuleProfileName ($db=false)
 
 profileIn ()
 
 profileOut ()
 
 safeProfileOut ()
 
 getProfileTime ()
 
 profileDBIn ()
 
 profileDBOut ()
 
 getProfileDBTime ()
 
 getResultData ()
 
- Public Member Functions inherited from ContextSource
 getContext ()
 
 setContext (IContextSource $context)
 
 getConfig ()
 
 getRequest ()
 
 getTitle ()
 
 canUseWikiPage ()
 
 getWikiPage ()
 
 getOutput ()
 
 getUser ()
 
 getLanguage ()
 
 getSkin ()
 
 getTiming ()
 
 getStats ()
 
 msg ()
 
 exportSession ()
 

Static Public Member Functions

static parseSections ($str, $data, &$missingSections)
 
- Static Public Member Functions inherited from ApiBase
static truncateArray (&$arr, $limit)
 
static makeMessage ($msg, IContextSource $context, array $params=null)
 

Public Attributes

const CACHE_VERSION = 8
 
- Public Attributes inherited from ApiBase
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_SENSITIVE = 17
 

Protected Member Functions

 makeTitle ($name)
 
 getPageImage (Title $title)
 
 findFile ($title, $options=array())
 
 isMainPage ($title)
 
 getParserOutput (WikiPage $wp, ParserOptions $parserOptions, $oldid=null)
 
 makeWikiPage (Title $title)
 
 makeParserOptions (WikiPage $wp)
 
 getExamplesMessages ()
 
- 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)
 
 parseMultiValue ($valueName, $value, $allowMultiple, $allowedValues)
 
 validateLimit ($paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
 
 validateTimestamp ($value, $encParamName)
 
 setWatch ($watch, $titleObj, $userOption=null)
 
 dieContinueUsageIf ($condition)
 
 getDescriptionMessage ()
 
 getHelpFlags ()
 
 getModuleSourceInfo ()
 
 getDescription ()
 
 getParamDescription ()
 
 getExamples ()
 
 makeHelpArrayToString ($prefix, $title, $input)
 
 useTransactionalTimeLimit ()
 

Detailed Description

ApiMobileView.php Extends Api of MediaWiki with actions for mobile devices. For further information see https://www.mediawiki.org/wiki/Extension:MobileFrontend#API

Constructor & Destructor Documentation

ApiMobileView::__construct (   $main,
  $action 
)

Run constructor of ApiBase

Parameters
ApiMain$mainInstance of class ApiMain
string$actionName of this module

Member Function Documentation

ApiMobileView::execute ( )

Execute the requested Api actions.

Todo:
: Write some unit tests for API results
ApiMobileView::findFile (   $title,
  $options = array() 
)
protected

Wrapper for wfFindFile

Parameters
Title | string$title
array$options
Returns
bool|File
ApiMobileView::getAllowedParams ( )

Get allowed Api parameters.

Returns
array
ApiMobileView::getDescription ( )

Get description of this Api.

Deprecated:
since MediaWiki core 1.25
Returns
string
ApiMobileView::getExamples ( )

Returns some Api request examples for mobile Api.

Deprecated:
since MediaWiki core 1.25
Returns
array
ApiMobileView::getExamplesMessages ( )
protected

Returns usage examples for this module.

See Also
ApiBase::getExamplesMessages()
ApiMobileView::getHelpUrls ( )

Returns the Help URL for this Api

Returns
string
ApiMobileView::getPageImage ( Title  $title)
protected

Wrapper that returns a page image for a given title

Parameters
Title$title
Returns
bool|File
ApiMobileView::getParamDescription ( )

Get the description for Api parameters.

Deprecated:
since MediaWiki core 1.25
Returns
array
ApiMobileView::getParserOutput ( WikiPage  $wp,
ParserOptions  $parserOptions,
  $oldid = null 
)
protected

Performs a page parse

Parameters
WikiPage$wp
ParserOptions$parserOptions
null|int[$oldid] Revision ID to get the text from, passing null or 0 will get the current revision (default value)
Returns
ParserOutput|null
ApiMobileView::isMainPage (   $title)
protected

Check if page is the main page after follow redirect when followRedirects is true.

Parameters
Title$titleTitle object to check
Returns
boolean
ApiMobileView::makeParserOptions ( WikiPage  $wp)
protected

Creates a ParserOptions instance

Parameters
WikiPage$wp
Returns
ParserOptions
ApiMobileView::makeTitle (   $name)
protected

Creates and validates a title

Parameters
string$name
Returns
Title
ApiMobileView::makeWikiPage ( Title  $title)
protected

Creates a WikiPage from title

Parameters
Title$title
Returns
WikiPage
static ApiMobileView::parseSections (   $str,
  $data,
$missingSections 
)
static

Parses requested sections string into a list of sections

Parameters
string$strString to parse
array$dataProcessed parser output
array$missingSectionsUpon return, contains the list of sections that were requested but are not present in parser output
Returns
array

Member Data Documentation

const ApiMobileView::CACHE_VERSION = 8

Increment this when changing the format of cached data


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