SMWDIBlob Class Reference
[SMWDataItems]

This class implements blob (long string) data items. More...

Inherits SMWDataItem.

Inherited by SMWDIString.

List of all members.

Public Member Functions

 __construct ($string)
 getDIType ()
 Convenience method that returns a constant that defines the concrete class that implements this data item.
 getString ()
 getSortKey ()
 Return a value that can be used for sorting data of this type.
 getSortKeyDataItem ()
 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_string


Detailed Description

This class implements blob (long string) data items.

Since:
1.6
Author:
Markus Krötzsch

Definition at line 15 of file SMW_DI_Blob.php.


Constructor & Destructor Documentation

SMWDIBlob::__construct ( string  ) 

Reimplemented in SMWDIString.

Definition at line 23 of file SMW_DI_Blob.php.


Member Function Documentation

SMWDIBlob::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.

Reimplemented in SMWDIString.

Definition at line 27 of file SMW_DI_Blob.php.

References SMWDataItem::TYPE_BLOB.

SMWDIBlob::getString (  ) 

Definition at line 31 of file SMW_DI_Blob.php.

SMWDIBlob::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 35 of file SMW_DI_Blob.php.

SMWDIBlob::getSortKeyDataItem (  ) 

See also:
SMWDataItem::getSortKeyDataItem()
Returns:
SMWDataItem

Reimplemented from SMWDataItem.

Definition at line 43 of file SMW_DI_Blob.php.

SMWDIBlob::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 47 of file SMW_DI_Blob.php.

static SMWDIBlob::doUnserialize ( serialization  )  [static]

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

Returns:
SMWDIBlob

Reimplemented in SMWDIString.

Definition at line 56 of file SMW_DI_Blob.php.


Member Data Documentation

SMWDIBlob::$m_string [protected]

Definition at line 21 of file SMW_DI_Blob.php.


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

Generated on Sun Mar 18 07:15:43 2012 for Semantic MediaWiki by  doxygen 1.5.6