SMWDIUri Class Reference
[SMWDataItems]

This class implements URI data items. More...

Inherits SMWDataItem.

List of all members.

Public Member Functions
	__construct ($scheme, $hierpart, $query, $fragment)
	Initialise a URI by providing its scheme (e.g.
	getDIType ()
	Convenience method that returns a constant that defines the concrete class that implements this data item.
	getURI ()
	getScheme ()
	getHierpart ()
	getQuery ()
	getFragment ()
	getSortKey ()
	Return a value that can be used for sorting data of this type.
	getSerialization ()
	Get a UTF-8 encoded string serialization of this data item.
Static Public Member Functions
static	doUnserialize ($serialization)
	Create a data item from the provided serialization string and type ID.
Protected Attributes
	$m_scheme
	$m_hierpart
	$m_query
	$m_fragment

---

Detailed Description

This class implements URI data items.

Since:

1.6

Author:

Markus Krötzsch

Definition at line 15 of file SMW_DI_URI.php.

---

Constructor & Destructor Documentation

SMWDIUri::__construct	(	$	scheme,
		$	hierpart,
		$	query,
		$	fragment
	)

Initialise a URI by providing its scheme (e.g.

"html"), 'hierpart' following "scheme:" (e.g. "//username.org/path), query (e.g. "q=Search+term", and fragment (e.g. "section-one"). The complete URI with these examples would be http://username@example.org/path?q=Search+term#section-one

Parameters:

	$scheme	string for the scheme
	$hierpart	string for the "hierpart"
	$query	string for the query
	$fragment	string for the fragment

Todo:

Implement more validation here.

Definition at line 51 of file SMW_DI_URI.php.

---

Member Function Documentation

SMWDIUri::getDIType

(

)

Convenience method that returns a constant that defines the concrete class that implements this data item.

Used to switch when processing data items.

Returns:

integer that specifies the basic type of data item

Reimplemented from SMWDataItem.

Definition at line 64 of file SMW_DI_URI.php.

References SMWDataItem::TYPE_URI.

SMWDIUri::getURI

(

)

Todo:

This should be changed to the spelling getUri().

Definition at line 69 of file SMW_DI_URI.php.

Referenced by getSerialization(), and getSortKey().

SMWDIUri::getScheme

(

)

Definition at line 83 of file SMW_DI_URI.php.

SMWDIUri::getHierpart

(

)

Definition at line 87 of file SMW_DI_URI.php.

SMWDIUri::getQuery

(

)

Definition at line 91 of file SMW_DI_URI.php.

SMWDIUri::getFragment

(

)

Definition at line 95 of file SMW_DI_URI.php.

SMWDIUri::getSortKey

(

)

Return a value that can be used for sorting data of this type.

If the data is of a numerical type, the sorting must be done in numerical order. If the data is a string, the data must be sorted alphabetically.

Note:

Every data item returns a sort key, even if there is no natural linear order for the type. SMW must order listed data in some way in any case. If there is a natural order (e.g. for Booleans where false < true), then the sortkey must agree with this order (e.g. for Booleans where false maps to 0, and true maps to 1).

Wiki pages are a special case in SMW. They are ordered by a sortkey that is assigned to them as a property value. When pages are sorted, this data should be used if possible.

Returns:

float or string

Reimplemented from SMWDataItem.

Definition at line 99 of file SMW_DI_URI.php.

References getURI().

SMWDIUri::getSerialization

(

)

Get a UTF-8 encoded string serialization of this data item.

The serialisation should be concise and need not be pretty, but it must allow unserialization. Each subclass of SMWDataItem implements a static method doUnserialize() for this purpose.

Returns:

string

Reimplemented from SMWDataItem.

Definition at line 103 of file SMW_DI_URI.php.

References getURI().

static SMWDIUri::doUnserialize

(

$

serialization

)

[static]

Create a data item from the provided serialization string and type ID.

Returns:

SMWDIUri

Definition at line 112 of file SMW_DI_URI.php.

Referenced by SMWCompatibilityHelpers::dataItemFromDBKeys().

---

Member Data Documentation

SMWDIUri::$m_scheme [protected]

Definition at line 21 of file SMW_DI_URI.php.

SMWDIUri::$m_hierpart [protected]

Definition at line 26 of file SMW_DI_URI.php.

SMWDIUri::$m_query [protected]

Definition at line 31 of file SMW_DI_URI.php.

SMWDIUri::$m_fragment [protected]

Definition at line 36 of file SMW_DI_URI.php.

---

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

• SemanticMediaWiki/includes/dataitems/SMW_DI_URI.php