EasyRdf API Documentation
Class

EasyRdf_Literal_XML

class EasyRdf_Literal_XML extends EasyRdf_Literal

Class that represents an RDF Literal of datatype rdf:XMLLiteral

Methods

static object create(mixed $value, string $lang = null, string $datatype = null)

Create a new literal object

from EasyRdf_Literal
static  setDatatypeMapping(string $datatype, string $class)

Register an RDF datatype with a PHP class name

from EasyRdf_Literal
static  deleteDatatypeMapping(string $datatype)

Remove the mapping between an RDF datatype and a PHP class name

from EasyRdf_Literal
static string getDatatypeForValue($value)

Get datatype URI for a PHP value.

from EasyRdf_Literal
object __construct(mixed $value, string $lang = null, string $datatype = null)

Constructor for creating a new rdf:XMLLiteral literal

string getValue()

Returns the value of the literal.

from EasyRdf_Literal
string getDatatypeUri()

Returns the full datatype URI of the literal.

from EasyRdf_Literal
string getDatatype()

Returns the shortened datatype URI of the literal.

from EasyRdf_Literal
string getLang()

Returns the language of the literal.

from EasyRdf_Literal
array toRdfPhp()

Returns the properties of the literal as an associative array

from EasyRdf_Literal
string __toString()

Magic method to return the value of a literal as a string

from EasyRdf_Literal
string dumpValue(string $format = 'html', string $color = 'black')

Return pretty-print view of the literal

from EasyRdf_Literal
object domParse()

Parse the XML literal into a DOMDocument

Details

in EasyRdf_Literal at line 79
static public object create(mixed $value, string $lang = null, string $datatype = null)

Create a new literal object

PHP values of type bool, int or float, will automatically be converted to the corresponding datatype and PHP sub-class.

If a registered datatype is given, then the registered subclass of EasyRdf_Literal will instantiated.

Note that literals are not required to have a language or datatype. Literals cannot have both a language and a datatype.

Parameters

mixed $value The value of the literal or an associative array
string $lang The natural language of the literal or null (e.g. 'en')
string $datatype The datatype of the literal or null (e.g. 'xsd:integer')

Return Value

object EasyRdfLiteral (or subclass of EasyRdfLiteral)

in EasyRdf_Literal at line 128
static public setDatatypeMapping(string $datatype, string $class)

Register an RDF datatype with a PHP class name

When parsing registered class will be used whenever the datatype is seen.

When serialising a registered class, the mapping will be used to set the datatype in the RDF.

Example: EasyRdfLiteral::registerDatatype('xsd:dateTime', 'MyDateTime_Class');

Parameters

string $datatype The RDF datatype (e.g. xsd:dateTime)
string $class The PHP class name (e.g. MyDateTimeClass)

in EasyRdf_Literal at line 151
static public deleteDatatypeMapping(string $datatype)

Remove the mapping between an RDF datatype and a PHP class name

Parameters

string $datatype The RDF datatype (e.g. xsd:dateTime)

in EasyRdf_Literal at line 176
static public string getDatatypeForValue($value)

Get datatype URI for a PHP value.

This static function is intended for internal use. Given a PHP value, it will return an XSD datatype URI for that value, for example: http://www.w3.org/2001/XMLSchema#integer

Parameters

$value

Return Value

string A URI for the datatype of $value.

at line 55
public object __construct(mixed $value, string $lang = null, string $datatype = null)

Constructor for creating a new rdf:XMLLiteral literal

Parameters

mixed $value The XML fragment
string $lang Should be null (literals with a datatype can't have a language)
string $datatype Optional datatype (default 'rdf:XMLLiteral')

Return Value

object EasyRdfLiteralXML

in EasyRdf_Literal at line 239
public string getValue()

Returns the value of the literal.

Return Value

string Value of this literal.

in EasyRdf_Literal at line 248
public string getDatatypeUri()

Returns the full datatype URI of the literal.

Return Value

string Datatype URI of this literal.

in EasyRdf_Literal at line 257
public string getDatatype()

Returns the shortened datatype URI of the literal.

Return Value

string Datatype of this literal (e.g. xsd:integer).

in EasyRdf_Literal at line 270
public string getLang()

Returns the language of the literal.

Return Value

string Language of this literal.

in EasyRdf_Literal at line 282
public array toRdfPhp()

Returns the properties of the literal as an associative array

For example: array('type' => 'literal', 'value' => 'string value')

Return Value

array The properties of the literal

in EasyRdf_Literal at line 304
public string __toString()

Magic method to return the value of a literal as a string

Return Value

string The value of the literal

in EasyRdf_Literal at line 315
public string dumpValue(string $format = 'html', string $color = 'black')

Return pretty-print view of the literal

Parameters

string $format Either 'html' or 'text'
string $color The colour of the text

Return Value

string

at line 65
public object domParse()

Parse the XML literal into a DOMDocument

Return Value

object DOMDocument