Purtle
Fast streaming RDF serializer for PHP
Loading...
Searching...
No Matches
Wikimedia\Purtle\TurtleRdfWriter Class Reference

RdfWriter implementation for generating Turtle output. More...

+ Inheritance diagram for Wikimedia\Purtle\TurtleRdfWriter:
+ Collaboration diagram for Wikimedia\Purtle\TurtleRdfWriter:

Public Member Functions

 getTrustIRIs ()
 
 setTrustIRIs ( $trustIRIs)
 
 __construct ( $role=parent::DOCUMENT_ROLE, BNodeLabeler $labeler=null, N3Quoter $quoter=null)
 
 getMimeType ()
 
- 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)
 

Protected Member Functions

 writeSubject ( $base, $local=null)
 @inheritDoc
 
 writePredicate ( $base, $local=null)
 @inheritDoc
 
 writeResource ( $base, $local=null)
 @inheritDoc
 
 newSubWriter ( $role, BNodeLabeler $labeler)
 
- Protected Member Functions inherited from Wikimedia\Purtle\N3RdfWriterBase
 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
 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.
 
 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.
 

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'
 
- Protected Attributes inherited from Wikimedia\Purtle\N3RdfWriterBase
 $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
 

Detailed Description

RdfWriter implementation for generating Turtle output.

@license GPL-2.0-or-later

Author
Daniel Kinzler

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Purtle\TurtleRdfWriter::__construct ( $role = parent::DOCUMENT_ROLE,
BNodeLabeler $labeler = null,
N3Quoter $quoter = null )
Parameters
string$role
BNodeLabeler | null$labeler
N3Quoter | null$quoter

Reimplemented from Wikimedia\Purtle\N3RdfWriterBase.

Member Function Documentation

◆ getMimeType()

Wikimedia\Purtle\TurtleRdfWriter::getMimeType ( )
Returns
string a MIME type

Implements Wikimedia\Purtle\RdfWriter.

◆ getTrustIRIs()

Wikimedia\Purtle\TurtleRdfWriter::getTrustIRIs ( )
Returns
bool

◆ newSubWriter()

Wikimedia\Purtle\TurtleRdfWriter::newSubWriter ( $role,
BNodeLabeler $labeler )
protected
Parameters
string$role
BNodeLabeler$labeler
Returns
RdfWriterBase

Reimplemented from Wikimedia\Purtle\RdfWriterBase.

◆ setTrustIRIs()

Wikimedia\Purtle\TurtleRdfWriter::setTrustIRIs ( $trustIRIs)
Parameters
bool$trustIRIs

◆ writePredicate()

Wikimedia\Purtle\TurtleRdfWriter::writePredicate ( $base,
$local = null )
protected

@inheritDoc

Reimplemented from Wikimedia\Purtle\RdfWriterBase.

◆ writeResource()

Wikimedia\Purtle\TurtleRdfWriter::writeResource ( $base,
$local = null )
protected

@inheritDoc

Reimplemented from Wikimedia\Purtle\RdfWriterBase.

◆ writeSubject()

Wikimedia\Purtle\TurtleRdfWriter::writeSubject ( $base,
$local = null )
protected

@inheritDoc

Reimplemented from Wikimedia\Purtle\RdfWriterBase.


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