1. class
  2. EasyRdf
  3. \
  4. Literal
  5. \
  6. Decimal

Decimal

class Decimal extends Literal

Class that represents an RDF Literal of datatype xsd:decimal

Constants

DECIMAL_REGEX

written according to http://www.w3.org/TR/xmlschema-2/#decimal

Properties

protected $value from  Literal
protected $lang from  Literal
protected $datatype from  Literal

Methods

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

Create a new literal object

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

Register an RDF datatype with a PHP class name

from  Literal
static 
deleteDatatypeMapping(string $datatype)

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

from  Literal
static string
getDatatypeForValue(mixed $value)

Get datatype URI for a PHP value.

from  Literal
Literal
__construct(string $value, string $lang = null, string $datatype = null)

Constructor for creating a new decimal literal

string
getValue()

Return the value of the literal cast to a PHP string

string
getDatatypeUri()

Returns the full datatype URI of the literal.

from  Literal
string
getDatatype()

Returns the shortened datatype URI of the literal.

from  Literal
string
getLang()

Returns the language of the literal.

from  Literal
array
toRdfPhp()

Returns the properties of the literal as an associative array

from  Literal
string
__toString()

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

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

Return pretty-print view of the literal

from  Literal
static 
validate(string $value)

No description

static string
canonicalise(string $value)

Converts valid xsd:decimal literal to Canonical representation see http://www.w3.org/TR/xmlschema-2/#decimal

Details

in Literal at line 81
static Literal 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

Literal

in Literal at line 132
static 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: EasyRdf\Literal::registerDatatype('xsd:dateTime', 'My_DateTime_Class');

Parameters

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

Exceptions

InvalidArgumentException

in Literal at line 157
static 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)

Exceptions

InvalidArgumentException

in Literal at line 184
static string getDatatypeForValue(mixed $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

mixed $value

Return Value

string

at line 63
Literal __construct(string $value, string $lang = null, string $datatype = null)

Constructor for creating a new decimal 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

Literal

Exceptions

UnexpectedValueException

at line 83
string getValue()

Return the value of the literal cast to a PHP string

Return Value

string

in Literal at line 257
string getDatatypeUri()

Returns the full datatype URI of the literal.

Return Value

string

in Literal at line 266
string getDatatype()

Returns the shortened datatype URI of the literal.

Return Value

string

in Literal at line 279
string getLang()

Returns the language of the literal.

Return Value

string

in Literal at line 291
array toRdfPhp()

Returns the properties of the literal as an associative array

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

Return Value

array

in Literal at line 313
string __toString()

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

Return Value

string

in Literal at line 325
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 93
static validate(string $value)

Parameters

string $value

Exceptions

UnexpectedValueException

at line 108
static string canonicalise(string $value)

Converts valid xsd:decimal literal to Canonical representation see http://www.w3.org/TR/xmlschema-2/#decimal

Parameters

string $value Valid xsd:decimal literal

Return Value

string