SMWPropertyListValue Class Reference
[SMWDataValues]

This datavalue implements special processing suitable for defining the list of properties that is required for SMWRecordValue objects. More...

Inherits SMWDataValue.

List of all members.

Public Member Functions
	getShortWikiText ($linked=null)
	Returns a short textual representation for this data value.
	getShortHTMLText ($linker=null)
	Returns a short textual representation for this data value.
	getLongWikiText ($linked=null)
	Return the long textual description of the value, as printed for example in the factbox.
	getLongHTMLText ($linker=null)
	Return the long textual description of the value, as printed for example in the factbox.
	getWikiValue ()
	Return the plain wiki version of the value, or FALSE if no such version is available.
	getPropertyDataItems ()
Protected Member Functions
	parseUserValue ($value)
	Initialise the datavalue from the given value string.
	loadDataItem (SMWDataItem $dataItem)
	makeOutputText ($type, $linker=null)
	makeValueOutputText ($type, $propertyValue, $linker)
Protected Attributes
	$m_diProperties

---

Detailed Description

This datavalue implements special processing suitable for defining the list of properties that is required for SMWRecordValue objects.

The input is a plain semicolon-separated list of property names, optionally with the namespace prefix.

Author:

Markus Krötzsch

Definition at line 16 of file SMW_DV_PropertyList.php.

---

Member Function Documentation

SMWPropertyListValue::parseUserValue

(

$

value

)

[protected]

Initialise the datavalue from the given value string.

The format of this strings might be any acceptable user input and especially includes the output of getWikiValue().

Parameters:

string

$value

Reimplemented from SMWDataValue.

Definition at line 24 of file SMW_DV_PropertyList.php.

References SMWDataValue::addError(), SMWDIProperty::newFromUserLabel(), and smwfNormalTitleText().

SMWPropertyListValue::loadDataItem

(

SMWDataItem $

dataItem

)

[protected]

See also:

SMWDataValue::loadDataItem()

Parameters:

$dataitem

SMWDataItem

Returns:

boolean

Reimplemented from SMWDataValue.

Definition at line 69 of file SMW_DV_PropertyList.php.

References SMWDataValue::addError(), and SMWDataItem::TYPE_STRING.

SMWPropertyListValue::getShortWikiText

(

$

linked = null

)

Returns a short textual representation for this data value.

If the value was initialised from a user supplied string, then this original string should be reflected in this short version (i.e. no normalisation should normally happen). There might, however, be additional parts such as code for generating tooltips. The output is in wiki text.

The parameter $linked controls linking of values such as titles and should be non-NULL and non-false if this is desired.

Reimplemented from SMWDataValue.

Definition at line 91 of file SMW_DV_PropertyList.php.

References makeOutputText().

SMWPropertyListValue::getShortHTMLText

(

$

linker = null

)

Returns a short textual representation for this data value.

If the value was initialised from a user supplied string, then this original string should be reflected in this short version (i.e. no normalisation should normally happen). There might, however, be additional parts such as code for generating tooltips. The output is in HTML text.

The parameter $linker controls linking of values such as titles and should be some Linker object (or NULL for no linking).

Reimplemented from SMWDataValue.

Definition at line 95 of file SMW_DV_PropertyList.php.

References makeOutputText().

SMWPropertyListValue::getLongWikiText

(

$

linked = null

)

Return the long textual description of the value, as printed for example in the factbox.

If errors occurred, return the error message The result always is a wiki-source string.

The parameter $linked controls linking of values such as titles and should be non-NULL and non-false if this is desired.

Reimplemented from SMWDataValue.

Definition at line 99 of file SMW_DV_PropertyList.php.

References makeOutputText().

SMWPropertyListValue::getLongHTMLText

(

$

linker = null

)

Return the long textual description of the value, as printed for example in the factbox.

If errors occurred, return the error message The result always is an HTML string.

The parameter $linker controls linking of values such as titles and should be some Linker object (or NULL for no linking).

Reimplemented from SMWDataValue.

Definition at line 103 of file SMW_DV_PropertyList.php.

References makeOutputText().

SMWPropertyListValue::getWikiValue

(

)

Return the plain wiki version of the value, or FALSE if no such version is available.

The returned string suffices to reobtain the same DataValue when passing it as an input string to setUserValue().

Reimplemented from SMWDataValue.

Definition at line 107 of file SMW_DV_PropertyList.php.

References makeOutputText().

SMWPropertyListValue::getPropertyDataItems

(

)

Definition at line 111 of file SMW_DV_PropertyList.php.

SMWPropertyListValue::makeOutputText	(	$	type,
		$	linker = null
	)			[protected]

Definition at line 117 of file SMW_DV_PropertyList.php.

References SMWDataValue::getErrorText(), SMWDataValue::isValid(), makeValueOutputText(), and SMWDataValueFactory::newDataItemValue().

Referenced by getLongHTMLText(), getLongWikiText(), getShortHTMLText(), getShortWikiText(), and getWikiValue().

SMWPropertyListValue::makeValueOutputText	(	$	type,
		$	propertyValue,
		$	linker
	)			[protected]

Definition at line 131 of file SMW_DV_PropertyList.php.

Referenced by makeOutputText().

---

Member Data Documentation

SMWPropertyListValue::$m_diProperties [protected]

Definition at line 22 of file SMW_DV_PropertyList.php.

---

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

• SemanticMediaWiki/includes/datavalues/SMW_DV_PropertyList.php