Kartographer\State Class Reference

Stores information about map tags on page in ParserOutput. More...

Inheritance diagram for Kartographer\State:

Collaboration diagram for Kartographer\State:

Public Member Functions
	hasValidTags ()
	setValidTags ()
	hasBrokenTags ()
	setBrokenTags ()
	useMaplink ()
	Increment the number of maplinks by one.
	getMaplinks ()
	useMapframe ()
	Increment the number of mapframes by one.
	getMapframes ()
	addInteractiveGroups (array $groups)
	getInteractiveGroups ()
	addRequestedGroups (array $groups)
	getRequestedGroups ()
	getCounters ()
	setCounters (stdClass $counters)
	addData ( $key, array $data)
	getData ()
	jsonSerialize ()

Static Public Member Functions
static	getState (ParserOutput $output)
	Retrieves an instance of self from ParserOutput, if present. More...
static	getOrCreate (ParserOutput $output)
	Retrieves an instance of self from ParserOutput if possible, otherwise creates a new instance. More...
static	setState (ParserOutput $output, State $state)
	Stores an instance of self in the ParserOutput. More...
static	newFromJson (array $data)

Public Attributes
const	DATA_KEY = 'kartographer'

Detailed Description

Stores information about map tags on page in ParserOutput.

Member Function Documentation

addData()

Kartographer\State::addData	(		$key,
		array	$data
	)

Parameters

string	$key
array	$data	A JSON-serializable structure

addInteractiveGroups()

Kartographer\State::addInteractiveGroups

(

array

$groups

)

Parameters

string[]

$groups

addRequestedGroups()

Kartographer\State::addRequestedGroups

(

array

$groups

)

Parameters

string[]

$groups

getCounters()

Kartographer\State::getCounters

(

)

Returns

stdClass

getData()

Kartographer\State::getData

(

)

Returns

array[] Associative key-value array, build up by {

See also

addData}

getInteractiveGroups()

Kartographer\State::getInteractiveGroups

(

)

Returns

string[]

getMapframes()

Kartographer\State::getMapframes

(

)

Returns

int Number of mapframes.

getMaplinks()

Kartographer\State::getMaplinks

(

)

Returns

int Number of maplinks.

getOrCreate()

static Kartographer\State::getOrCreate ( ParserOutput  $output )

static

Retrieves an instance of self from ParserOutput if possible, otherwise creates a new instance.

Parameters

ParserOutput

$output

Returns

State

getRequestedGroups()

Kartographer\State::getRequestedGroups

(

)

Returns

int[] Group name => original index map (flipped version of addRequestedGroups)

getState()

static Kartographer\State::getState ( ParserOutput  $output )

static

Retrieves an instance of self from ParserOutput, if present.

Parameters

ParserOutput

$output

Returns

self|null

hasBrokenTags()

Kartographer\State::hasBrokenTags

(

)

Returns

bool

hasValidTags()

Kartographer\State::hasValidTags

(

)

Returns

bool

jsonSerialize()

Kartographer\State::jsonSerialize

(

)

Returns

array A JSON serializable associative array

newFromJson()

static Kartographer\State::newFromJson ( array  $data )

static

Parameters

array

$data

A JSON serializable associative array, as returned by jsonSerialize()

Returns

State

setCounters()

Kartographer\State::setCounters

(

stdClass

$counters

)

Parameters

stdClass

$counters

A JSON-serializable structure

setState()

static Kartographer\State::setState ( ParserOutput  $output, State  $state  )

static

Stores an instance of self in the ParserOutput.

Parameters

ParserOutput	$output
State	$state

---

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

• includes/State.php