Wikimedia\Purtle\N3RdfWriterBase Class Reference

Base class for RdfWriter implementations that output an N3 dialect. More...

Inheritance diagram for Wikimedia\Purtle\N3RdfWriterBase:

Collaboration diagram for Wikimedia\Purtle\N3RdfWriterBase:

Public Member Functions
	__construct ( $role=parent::DOCUMENT_ROLE, BNodeLabeler $labeler=null, N3Quoter $quoter=null)
Public Member Functions inherited from Wikimedia\Purtle\RdfWriterBase
	__construct ( $role, BNodeLabeler $labeler=null)
	prefix ( $prefix, $iri)
	Registers a prefix.
	getPrefixes ()
	Returns the prefix map.
	sub ()
	getRole ()
	blank ( $label=null)
	start ()
	finish ()
	drain ()
	about ( $base, $local=null)
	a ( $typeBase, $typeLocal=null)
	say ( $base, $local=null)
	is ( $base, $local=null)
	text ( $text, $language=null)
	value ( $value, $typeBase=null, $typeLocal=null)
Public Member Functions inherited from Wikimedia\Purtle\RdfWriter
	getMimeType ()
	Returns the MIME type of the RDF serialization the writer produces.

Protected Member Functions
	writeRef ( $base, $local=null)
	writeIRI ( $iri, $trustIRI=false)
	writeText ( $text, $language=null)
	@inheritDoc
	writeValue ( $value, $typeBase, $typeLocal=null)
Protected Member Functions inherited from Wikimedia\Purtle\RdfWriterBase
	newSubWriter ( $role, BNodeLabeler $labeler)
	registerShorthand ( $shorthand, $prefix, $local)
	Registers a shorthand that can be used instead of a qname, like 'a' can be used instead of 'rdf:type'.
	isShorthand ( $shorthand)
	Determines whether $shorthand can be used as a shorthand.
	isPrefix ( $prefix)
	Determines whether $shorthand can legally be used as a prefix.
	isValidLanguageCode ( $languageCode)
	write ( $w)
	Appends string to the output buffer.
	expandShorthand (&$base, &$local)
	If $base is a shorthand, $base and $local are updated to hold whatever qname the shorthand was associated with.
	expandQName (&$base, &$local)
	If $base is a registered prefix, $base will be replaced by the base IRI associated with that prefix, with $local appended.
	state ( $newState)
	Perform a state transition.
	writeSubject ( $base, $local=null)
	Must be implemented to generate output that starts a statement (or set of statements) about a subject.
	writePredicate ( $base, $local=null)
	Must be implemented to generate output that represents the association of a predicate with a subject that was previously defined by a call to writeSubject().
	writeResource ( $base, $local=null)
	Must be implemented to generate output that represents a resource used as the object of a statement.
	expandSubject (&$base, &$local)
	Perform any expansion (shorthand to qname, qname to IRI) desired for subject identifiers.
	expandPredicate (&$base, &$local)
	Perform any expansion (shorthand to qname, qname to IRI) desired for predicate identifiers.
	expandResource (&$base, &$local)
	Perform any expansion (shorthand to qname, qname to IRI) desired for resource identifiers.
	expandType (&$base, &$local)
	Perform any expansion (shorthand to qname, qname to IRI) desired for type identifiers.

Protected Attributes
	$quoter
Protected Attributes inherited from Wikimedia\Purtle\RdfWriterBase
const	STATE_START = 0
const	STATE_DOCUMENT = 5
const	STATE_SUBJECT = 10
const	STATE_PREDICATE = 11
const	STATE_OBJECT = 12
const	STATE_FINISH = 666
	$prefixes = []
	$currentSubject = [ null, null ]
	$currentPredicate = [ null, null ]
	$role
	$transitionTable

Additional Inherited Members
Public Attributes inherited from Wikimedia\Purtle\RdfWriterBase
const	DOCUMENT_ROLE = 'document'
	Role ID for writers that will generate a full RDF document.
const	SUBDOCUMENT_ROLE = 'sub'

Detailed Description

Base class for RdfWriter implementations that output an N3 dialect.

@license GPL-2.0-or-later

Author

Daniel Kinzler

Constructor & Destructor Documentation

__construct()

Wikimedia\Purtle\N3RdfWriterBase::__construct	(		$role = parent::DOCUMENT_ROLE,
		BNodeLabeler	$labeler = null,
		N3Quoter	$quoter = null )

Parameters

string	$role
BNodeLabeler | null	$labeler
N3Quoter | null	$quoter

Reimplemented in Wikimedia\Purtle\NTriplesRdfWriter, and Wikimedia\Purtle\TurtleRdfWriter.

Member Function Documentation

writeIRI()

Wikimedia\Purtle\N3RdfWriterBase::writeIRI ( $iri, $trustIRI = false )

protected

Parameters

string	$iri
bool	$trustIRI

writeRef()

Wikimedia\Purtle\N3RdfWriterBase::writeRef ( $base, $local = null )

protected

Parameters

string	$base
string | null	$local

writeText()

Wikimedia\Purtle\N3RdfWriterBase::writeText ( $text, $language = null )

protected

@inheritDoc

Reimplemented from Wikimedia\Purtle\RdfWriterBase.

Reimplemented in Wikimedia\Purtle\NTriplesRdfWriter.

writeValue()

Wikimedia\Purtle\N3RdfWriterBase::writeValue ( $value, $typeBase, $typeLocal = null )

protected

Parameters

string	$value
string | null	$typeBase
string | null	$typeLocal

Reimplemented from Wikimedia\Purtle\RdfWriterBase.

Reimplemented in Wikimedia\Purtle\NTriplesRdfWriter.

---

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

• src/N3RdfWriterBase.php