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

Public Member Functions

 render (array $parameters)
 
 getMessage ()
 
- Public Member Functions inherited from ParserHook
 __construct ($forTagExtensions=true, $forParserFunctions=true, $flags=0)
 
 init (Parser &$parser)
 
 magic (array &$magicWords, $langCode)
 
 renderTag ($input, array $args, Parser $parser, PPFrame $frame=null)
 
 renderFunction (Parser &$parser)
 
 renderFunctionObj (Parser &$parser, PPFrame $frame, $args)
 
 validateAndRender (array $arguments, $type)
 
 getParamDefinitions ($type=self::TYPE_FUNCTION)
 
 getDescriptionData ($type)
 
 getDescription ()
 
 getMessage ()
 

Protected Member Functions

 getName ()
 
 getParameterInfo ($type)
 
 getDefaultParameters ($type)
 
 msg ()
 
 getParameterTable (array $parameters)
 
 getDescriptionRow (ParamDefinition $parameter)
 
 getServiceParameters ($service)
 
- Protected Member Functions inherited from ParserHook
 getName ()
 
 render (array $parameters)
 
 getNames ()
 
 getFunctionOptions ()
 
 getErrorsToDisplay ()
 
 renderFatalError (ProcessingError $error)
 
 getParameterInfo ($type)
 
 getDefaultParameters ($type)
 
 isTag ()
 
 isFunction ()
 
 parseWikitext ($text)
 

Protected Attributes

 $language
 
- Protected Attributes inherited from ParserHook
 $validator
 
 $parser
 
 $frame
 
 $currentType
 
 $parserHookOptions
 

Additional Inherited Members

- Static Public Member Functions inherited from ParserHook
static getRegisteredParserHooks ()
 
static getHookClassName ($hookName)
 
- Public Attributes inherited from ParserHook
const TYPE_TAG = 0
 
const TYPE_FUNCTION = 1
 
 $forTagExtensions
 
 $forParserFunctions
 
const FH_NO_HASH = 1
 
- Static Protected Attributes inherited from ParserHook
static $registeredHooks = array()
 

Detailed Description

Class for the 'mapsdoc' parser hooks, which displays documentation for a specified mapping service.

Since
1.0

GNU GPL v2+

Author
Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Member Function Documentation

MapsMapsDoc::getDefaultParameters (   $type)
protected

Returns the list of default parameters.

See Also
ParserHook::getDefaultParameters
Since
1.0
Returns
array
MapsMapsDoc::getDescriptionRow ( ParamDefinition  $parameter)
protected

Returns the wikitext for a table row describing a single parameter.

Since
1.0
Parameters
ParamDefinition$parameter
Returns
string
MapsMapsDoc::getMessage ( )
See Also
ParserHook::getDescription()
Since
1.0
MapsMapsDoc::getName ( )
protected

Gets the name of the parser hook.

See Also
ParserHook::getName
Since
1.0
Returns
string
MapsMapsDoc::getParameterInfo (   $type)
protected

Returns an array containing the parameter info.

See Also
ParserHook::getParameterInfo
Since
1.0
Returns
array
MapsMapsDoc::getParameterTable ( array  $parameters)
protected

Returns the wikitext for a table listing the provided parameters.

Since
1.0
Parameters
array$parameters
Returns
string
MapsMapsDoc::msg ( )
protected

Message function that takes into account the language parameter.

Since
1.0.1
Parameters
string$key
...$args
Returns
string
MapsMapsDoc::render ( array  $parameters)

Renders and returns the output.

See Also
ParserHook::render
Since
1.0
Parameters
array$parameters
Returns
string

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