SMWDIError Class Reference
[SMWDataItems]

This class implements error list data items. More...

Inherits SMWDataItem.

List of all members.

Public Member Functions
	__construct ($errors)
	getDIType ()
	Convenience method that returns a constant that defines the concrete class that implements this data item.
	getErrors ()
	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_errors

---

Detailed Description

This class implements error list data items.

These data items are used to pass around lists of error messages within the application. They are not meant to be stored or exported, but they can be useful to a user.

Since:

1.6

Author:

Markus Krötzsch

Definition at line 17 of file SMW_DI_Error.php.

---

Constructor & Destructor Documentation

SMWDIError::__construct

(

$

errors

)

Definition at line 25 of file SMW_DI_Error.php.

---

Member Function Documentation

SMWDIError::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 29 of file SMW_DI_Error.php.

References SMWDataItem::TYPE_ERROR.

SMWDIError::getErrors

(

)

Definition at line 33 of file SMW_DI_Error.php.

SMWDIError::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 37 of file SMW_DI_Error.php.

SMWDIError::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 41 of file SMW_DI_Error.php.

static SMWDIError::doUnserialize

(

$

serialization

)

[static]

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

Todo:

Be more careful with unserialization. It can create E_NOTICEs.

Returns:

SMWDIError

Definition at line 51 of file SMW_DI_Error.php.

---

Member Data Documentation

SMWDIError::$m_errors [protected]

Definition at line 23 of file SMW_DI_Error.php.

---

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

• SemanticMediaWiki/includes/dataitems/SMW_DI_Error.php