SMWStringValue Class Reference
[SMWDataValues]

This datavalue implements String-Datavalues suitable for defining String-types of properties. 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)
	getLongWikiText ($linked=null)
	Return the long textual description of the value, as printed for example in the factbox.
	getLongHTMLText ($linker=null)
	getWikiValue ()
	Return the plain wiki version of the value, or FALSE if no such version is available.
	getInfolinks ()
	Return an array of SMWLink objects that provide additional resources for the given value.
Protected Member Functions
	parseUserValue ($value)
	Initialise the datavalue from the given value string.
	loadDataItem (SMWDataItem $dataItem)
	getServiceLinkParams ()
	Overwritten by callers to supply an array of parameters that can be used for creating servicelinks.
	getAbbValue ($linked, $value)
	Make a possibly shortened printout string for displaying the value.
	getCodeDisplay ($value, $scroll=false)
	Special features for Type:Code formatting.

---

Detailed Description

This datavalue implements String-Datavalues suitable for defining String-types of properties.

Author:

Nikolas Iwan

Markus Krötzsch

Definition at line 15 of file SMW_DV_String.php.

---

Member Function Documentation

SMWStringValue::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 17 of file SMW_DV_String.php.

References SMWDataValue::addError(), and getCodeDisplay().

SMWStringValue::loadDataItem

(

SMWDataItem $

dataItem

)

[protected]

See also:

SMWDataValue::loadDataItem()

Parameters:

$dataitem

SMWDataItem

Returns:

boolean

Reimplemented from SMWDataValue.

Definition at line 42 of file SMW_DV_String.php.

References getCodeDisplay(), SMWDataItem::TYPE_BLOB, and SMWDataItem::TYPE_STRING.

SMWStringValue::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 57 of file SMW_DV_String.php.

Referenced by getShortHTMLText().

SMWStringValue::getShortHTMLText

(

$

linker = null

)

Todo:

Rather parse input to obtain properly formatted HTML.

Reimplemented from SMWDataValue.

Definition at line 64 of file SMW_DV_String.php.

References getShortWikiText(), and smwfXMLContentEncode().

SMWStringValue::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 68 of file SMW_DV_String.php.

References getAbbValue(), SMWDataValue::getErrorText(), and SMWDataValue::isValid().

SMWStringValue::getLongHTMLText

(

$

linker = null

)

Todo:

Rather parse input to obtain properly formatted HTML.

Reimplemented from SMWDataValue.

Definition at line 75 of file SMW_DV_String.php.

References getAbbValue(), SMWDataValue::getErrorText(), SMWDataValue::isValid(), and smwfXMLContentEncode().

SMWStringValue::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 79 of file SMW_DV_String.php.

SMWStringValue::getInfolinks

(

)

Return an array of SMWLink objects that provide additional resources for the given value.

Captions can contain some HTML markup which is admissible for wiki text, but no more. Result might have no entries but is always an array.

Reimplemented from SMWDataValue.

Definition at line 83 of file SMW_DV_String.php.

SMWStringValue::getServiceLinkParams

(

)

[protected]

Overwritten by callers to supply an array of parameters that can be used for creating servicelinks.

The number and content of values in the parameter array may vary, depending on the concrete datatype.

Reimplemented from SMWDataValue.

Definition at line 91 of file SMW_DV_String.php.

SMWStringValue::getAbbValue	(	$	linked,
		$	value
	)			[protected]

Make a possibly shortened printout string for displaying the value.

The value must be specified as an input since necessary HTML escaping must be applied to it first, if desired. The result of getAbbValue() may contain wiki-compatible HTML mark-up that should not be escaped.

Todo:

The method abbreviates very long strings for display by simply taking substrings. This is not in all cases a good idea, since it may break XML entities and mark-up.

Definition at line 111 of file SMW_DV_String.php.

References getCodeDisplay(), and SMWOutputs::requireResource().

Referenced by getLongHTMLText(), and getLongWikiText().

SMWStringValue::getCodeDisplay	(	$	value,
		$	scroll = false
	)			[protected]

Special features for Type:Code formatting.

Definition at line 130 of file SMW_DV_String.php.

References SMWOutputs::requireResource().

Referenced by getAbbValue(), loadDataItem(), and parseUserValue().

---

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

• SemanticMediaWiki/includes/datavalues/SMW_DV_String.php