SMW\ParserData Class Reference

Public Member Functions
	__construct (Title $title, ParserOutput $parserOutput)
	getOption ( $key, $default=null)
	setOption ( $key, $value)
	setOrigin ( $origin)
	getTitle ()
	getSubject ()
	getOutput ()
	setParserOptions (ParserOptions $parserOptions)
	addExtraParserKey ( $key)
	isBlocked ()
	hasAnnotationBlock ()
	canUse ()
	getErrors ()
	addError ( $error)
	setSemanticData (SemanticData $semanticData)
	setData (SemanticData $semanticData)
	getSemanticData ()
	getData ()
	setEmptySemanticData ()
	importFromParserOutput (ParserOutput $parserOutput=null)
	copyToParserOutput ()
	pushSemanticDataToParserOutput ()
	markParserOutput ()
	setSemanticDataStateToParserOutputProperty ()
	addDataValue (DataValue $dataValue)
	updateStore ( $opts=[])
	addLimitReport ( $key, $value)

Static Public Member Functions
static	hasSemanticData (ParserOutput $parserOutput)

Public Attributes
const	DATA_ID = 'smwdata'
const	CACHE_NAMESPACE = 'smw:update'
const	OPT_FORCED_UPDATE = 'smw:opt.forced.update'
const	OPT_CREATE_UPDATE_JOB = 'smw:opt.create.update.job'
const	OPT_CHANGE_PROP_UPDATE = 'smw:opt.change.prop.update'
const	NO_QUERY_DEPENDENCY_TRACE = 'no.query.dependency.trace'
const	ANNOTATION_BLOCK = 'smw-blockannotation'

Detailed Description

Handling semantic data exchange with a ParserOutput object

Provides access to a semantic data container that is generated either from the ParserOutput or is a newly created container

GNU GPL v2+

Since

1.9

Author

mwjames

Markus Krötzsch

Constructor & Destructor Documentation

__construct()

SMW\ParserData::__construct	(	Title	$title,
		ParserOutput	$parserOutput
	)

Since

1.9

Parameters

Title	$title
ParserOutput	$parserOutput

Member Function Documentation

addDataValue()

SMW\ParserData::addDataValue

(

DataValue

$dataValue

)

See also

SemanticData::addDataValue

Since

1.9

Parameters

DataValue

$dataValue

addError()

SMW\ParserData::addError

(

$error

)

Since

1.9

addExtraParserKey()

SMW\ParserData::addExtraParserKey

(

$key

)

Since

3.0

Returns

ParserOptions|null

addLimitReport()

SMW\ParserData::addLimitReport	(		$key,
			$value
	)

Note

ParserOutput::setLimitReportData

Since

2.4

Parameters

string	$key
string	$value

canUse()

SMW\ParserData::canUse

(

)

Since

3.0

Returns

boolean

copyToParserOutput()

SMW\ParserData::copyToParserOutput

(

)

Since

3.0

getData()

SMW\ParserData::getData

(

)

Deprecated:

since 2.0, use getSemanticData

getErrors()

SMW\ParserData::getErrors

(

)

Returns collected errors occurred during processing

Since

1.9

Returns

array

getOption()

SMW\ParserData::getOption	(		$key,
			$default = null
	)

Since

2.5

Parameters

string	$key
mixed	$default

Returns

mixed

getOutput()

SMW\ParserData::getOutput

(

)

Since

1.9

Returns

ParserOutput

getSemanticData()

SMW\ParserData::getSemanticData

(

)

Since

1.9

Returns

SemanticData

getSubject()

SMW\ParserData::getSubject

(

)

Since

1.9

Returns

DIWikiPage

getTitle()

SMW\ParserData::getTitle

(

)

Since

1.9

Returns

Title

hasAnnotationBlock()

SMW\ParserData::hasAnnotationBlock

(

)

Since

3.1

Returns

boolean

hasSemanticData()

static SMW\ParserData::hasSemanticData ( ParserOutput  $parserOutput )

static

Since

2.5

Parameters

ParserOutput

$parserOutput

Returns

boolean

importFromParserOutput()

SMW\ParserData::importFromParserOutput

(

ParserOutput

$parserOutput = null

)

Since

2.1

Parameters

ParserOutput|null

isBlocked()

SMW\ParserData::isBlocked

(

)

Since

2.4

Returns

boolean

markParserOutput()

SMW\ParserData::markParserOutput

(

)

Since

3.0

pushSemanticDataToParserOutput()

SMW\ParserData::pushSemanticDataToParserOutput

(

)

Deprecated:

since 3.0, use copyToParserOutput

setData()

SMW\ParserData::setData

(

SemanticData

$semanticData

)

Deprecated:

since 2.0, use setSemanticData

setEmptySemanticData()

SMW\ParserData::setEmptySemanticData

(

)

Since

2.1

setOption()

SMW\ParserData::setOption	(		$key,
			$value
	)

Since

2.5

Parameters

string	$key
string	$value

setOrigin()

SMW\ParserData::setOrigin

(

$origin

)

Since

2.5

Parameters

string

$origin

setParserOptions()

SMW\ParserData::setParserOptions

(

ParserOptions

$parserOptions

)

Since

3.0

Parameters

ParserOptions

$parserOptions

setSemanticData()

SMW\ParserData::setSemanticData

(

SemanticData

$semanticData

)

Since

1.9

Parameters

SemanticData

$semanticData

setSemanticDataStateToParserOutputProperty()

SMW\ParserData::setSemanticDataStateToParserOutputProperty

(

)

Deprecated:

since 3.0, use pushSemanticDataToParserOutput

updateStore()

SMW\ParserData::updateStore

(

$opts = []

)

This method is not for public use

Since

1.9

Returns

boolean

Member Data Documentation

ANNOTATION_BLOCK

const SMW\ParserData::ANNOTATION_BLOCK = 'smw-blockannotation'

Indicates that no #ask dependency tracking should occur

CACHE_NAMESPACE

const SMW\ParserData::CACHE_NAMESPACE = 'smw:update'

Identifies the cache namespace for update markers

DATA_ID

const SMW\ParserData::DATA_ID = 'smwdata'

Identifies the extension data

NO_QUERY_DEPENDENCY_TRACE

const SMW\ParserData::NO_QUERY_DEPENDENCY_TRACE = 'no.query.dependency.trace'

Indicates that no #ask dependency tracking should occur

OPT_CHANGE_PROP_UPDATE

const SMW\ParserData::OPT_CHANGE_PROP_UPDATE = 'smw:opt.change.prop.update'

Indicates that an update was caused by a change propagation request

OPT_CREATE_UPDATE_JOB

const SMW\ParserData::OPT_CREATE_UPDATE_JOB = 'smw:opt.create.update.job'

Option whether creation of iteratibe update jobs are allowed

OPT_FORCED_UPDATE

const SMW\ParserData::OPT_FORCED_UPDATE = 'smw:opt.forced.update'

Option that allows to force an update even in cases where an update marker exists

---

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

• ParserData.php