Semantic MediaWiki and related extensions
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SMW\MediaWiki\Api\ApiRequestParameterFormatter Class Reference

Public Member Functions

 __construct (array $requestParameters)
 
 getAskApiParameters ()
 
 getAskArgsApiParameter ($key)
 

Protected Member Functions

 formatAskArgs ()
 
 formatParameters ()
 
 formatConditions ($condition)
 
 formatPrintouts ($printout)
 

Protected Attributes

 $requestParameters = array()
 
 $results = null
 

Detailed Description

This class handles Api related request parameter formatting

GNU GPL v2+

Since
1.9
Author
mwjames

Constructor & Destructor Documentation

SMW\MediaWiki\Api\ApiRequestParameterFormatter::__construct ( array  $requestParameters)
Since
1.9
Parameters
array$requestParameters

Member Function Documentation

SMW\MediaWiki\Api\ApiRequestParameterFormatter::formatAskArgs ( )
protected

Return formatted request parameters

Since
1.9
Returns
ObjectDictionary
SMW\MediaWiki\Api\ApiRequestParameterFormatter::formatConditions (   $condition)
protected

Format conditions

Since
1.9
Parameters
string$condition
Returns
string
SMW\MediaWiki\Api\ApiRequestParameterFormatter::formatParameters ( )
protected

Format parameters

Since
1.9
Returns
string
SMW\MediaWiki\Api\ApiRequestParameterFormatter::formatPrintouts (   $printout)
protected

Format printout and returns a SMWPrintRequest object

Since
1.9
Parameters
string$printout
Returns
PrintRequest
SMW\MediaWiki\Api\ApiRequestParameterFormatter::getAskApiParameters ( )

Return formatted request parameters for the AskApi

Since
1.9
Returns
array
SMW\MediaWiki\Api\ApiRequestParameterFormatter::getAskArgsApiParameter (   $key)

Return formatted request parameters AskArgsApi

Since
1.9
Returns
array

Member Data Documentation

SMW\MediaWiki\Api\ApiRequestParameterFormatter::$requestParameters = array()
protected
SMW\MediaWiki\Api\ApiRequestParameterFormatter::$results = null
protected

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