SMWDIConcept Class Reference
[SMWDataItems]

This class implements Concept data items. More...

Inherits SMWDataItem.

List of all members.

Public Member Functions
	__construct ($concept, $docu, $queryfeatures, $size, $depth)
	Initialise the concept data.
	getDIType ()
	Convenience method that returns a constant that defines the concrete class that implements this data item.
	getConceptQuery ()
	getDocumentation ()
	getQueryFeatures ()
	getSize ()
	getDepth ()
	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_concept
	$m_docu
	$m_features
	$m_size
	$m_depth

---

Detailed Description

This class implements Concept data items.

These special data items for storing concept declaration data in SMW may well vanish at some point since Container values could encode this data just as well.

Since:

1.6

Author:

Markus Krötzsch

Definition at line 18 of file SMW_DI_Concept.php.

---

Constructor & Destructor Documentation

SMWDIConcept::__construct	(	$	concept,
		$	docu,
		$	queryfeatures,
		$	size,
		$	depth
	)

Initialise the concept data.

Parameters:

	$concept	the concept query string
	$docu	string with user documentation
	$queryefeatures	integer flags about query features
	$size	integer concept query size
	$depth	integer concept query depth

Definition at line 54 of file SMW_DI_Concept.php.

---

Member Function Documentation

SMWDIConcept::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 62 of file SMW_DI_Concept.php.

References SMWDataItem::TYPE_CONCEPT.

SMWDIConcept::getConceptQuery

(

)

Definition at line 66 of file SMW_DI_Concept.php.

SMWDIConcept::getDocumentation

(

)

Definition at line 70 of file SMW_DI_Concept.php.

SMWDIConcept::getQueryFeatures

(

)

Definition at line 74 of file SMW_DI_Concept.php.

SMWDIConcept::getSize

(

)

Definition at line 78 of file SMW_DI_Concept.php.

SMWDIConcept::getDepth

(

)

Definition at line 82 of file SMW_DI_Concept.php.

SMWDIConcept::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 86 of file SMW_DI_Concept.php.

SMWDIConcept::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 90 of file SMW_DI_Concept.php.

static SMWDIConcept::doUnserialize

(

$

serialization

)

[static]

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

Returns:

SMWDIConcept

Definition at line 99 of file SMW_DI_Concept.php.

---

Member Data Documentation

SMWDIConcept::$m_concept [protected]

Definition at line 24 of file SMW_DI_Concept.php.

SMWDIConcept::$m_docu [protected]

Definition at line 29 of file SMW_DI_Concept.php.

SMWDIConcept::$m_features [protected]

Definition at line 34 of file SMW_DI_Concept.php.

SMWDIConcept::$m_size [protected]

Definition at line 39 of file SMW_DI_Concept.php.

SMWDIConcept::$m_depth [protected]

Definition at line 44 of file SMW_DI_Concept.php.

---

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

• SemanticMediaWiki/includes/dataitems/SMW_DI_Concept.php