EasyRdf API Documentation
Class

EasyRdf_Literal

class EasyRdf_Literal

Class that represents an RDF Literal

Methods

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

Create a new literal object

static  setDatatypeMapping(string $datatype, string $class)

Register an RDF datatype with a PHP class name

static  deleteDatatypeMapping(string $datatype)

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

static string getDatatypeForValue($value)

Get datatype URI for a PHP value.

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

Constructor for creating a new literal

string getValue()

Returns the value of the literal.

string getDatatypeUri()

Returns the full datatype URI of the literal.

string getDatatype()

Returns the shortened datatype URI of the literal.

string getLang()

Returns the language of the literal.

array toRdfPhp()

Returns the properties of the literal as an associative array

string __toString()

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

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

Return pretty-print view of the literal

Details

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)

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)

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)

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 200
public object __construct(string $value, string $lang = null, string $datatype = null)

Constructor for creating a new literal

Parameters

string $value The value of the literal
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:string')

Return Value

object EasyRdf_Literal

at line 239
public string getValue()

Returns the value of the literal.

Return Value

string Value of this literal.

at line 248
public string getDatatypeUri()

Returns the full datatype URI of the literal.

Return Value

string Datatype URI of this 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).

at line 270
public string getLang()

Returns the language of the literal.

Return Value

string Language of this 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

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

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