Kartographer
Extension that adds maps to wiki pages
Loading...
Searching...
No Matches
Kartographer\Tag\TagHandler Class Reference

Base class for all <map...> tags. More...

+ Inheritance diagram for Kartographer\Tag\TagHandler:

Static Public Member Functions

static entryPoint ( $input, array $args, Parser $parser, PPFrame $frame)
 Entry point for all tags.
 
static finalParseStep (State $state, ParserOutput $parserOutput, $isPreview, Parser $parser)
 Handles the last step of parse process.
 

Public Attributes

const TAG = null
 

Protected Member Functions

 parseArgs ()
 Parses tag attributes in $this->args.
 
 render ()
 When overridden in a descendant class, returns tag HTML.
 
 getInt ( $name, $default=false)
 
 getText ( $name, $default, $regexp=false)
 Returns value of a named tag attribute with optional validation.
 
 getLanguage ()
 

Protected Attributes

 $lat
 
 $lon
 
 $zoom
 
 $mapStyle
 
 $specifiedLangCode
 
 $resolvedLangCode
 
 $showGroups = []
 
 $counter = null
 
 $config
 
 $parser
 
 $frame
 
 $state
 
 $markerProperties
 

Detailed Description

Base class for all <map...> tags.

Member Function Documentation

◆ entryPoint()

static Kartographer\Tag\TagHandler::entryPoint ( $input,
array $args,
Parser $parser,
PPFrame $frame )
static

Entry point for all tags.

Parameters
string | null$input
array$args
Parser$parser
PPFrame$frame
Returns
string

@phan-suppress-next-line PhanTypeInstantiateAbstractStatic

◆ finalParseStep()

static Kartographer\Tag\TagHandler::finalParseStep ( State $state,
ParserOutput $parserOutput,
$isPreview,
Parser $parser )
static

Handles the last step of parse process.

Parameters
State$state
ParserOutput$parserOutputto exclusively write to; nothing is read from this object
bool$isPreview
Parser$parserrequired to properly add tracking categories

◆ getInt()

Kartographer\Tag\TagHandler::getInt ( $name,
$default = false )
protected
Parameters
string$name
string | false | null$default
Returns
int|false|null

◆ getLanguage()

Kartographer\Tag\TagHandler::getLanguage ( )
protected
Returns
Language|StubUserLang

◆ getText()

Kartographer\Tag\TagHandler::getText ( $name,
$default,
$regexp = false )
protected

Returns value of a named tag attribute with optional validation.

Parameters
string$nameAttribute name
string | false | null$defaultDefault value or false to trigger error if absent
string | false$regexpRegular expression to validate against or false to not validate
Returns
string|false|null

◆ parseArgs()

Kartographer\Tag\TagHandler::parseArgs ( )
protected

Parses tag attributes in $this->args.

Reimplemented in Kartographer\Tag\MapFrame, and Kartographer\Tag\MapLink.

◆ render()

Kartographer\Tag\TagHandler::render ( )
abstractprotected

When overridden in a descendant class, returns tag HTML.

Returns
string

Reimplemented in Kartographer\Tag\MapFrame, and Kartographer\Tag\MapLink.


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