SMWConceptValue Class Reference
[SMWDataValues]

This datavalue is used as a container for concept descriptions as used on Concept pages with the concept parserfunction. 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.
 descriptionToExpData ($desc, &$exact)
 getConceptText ()
 Return the concept's defining text (in SMW query syntax).
 getDocu ()
 Return the optional concept documentation.
 getSize ()
 Return the concept's size (a metric used to estimate computation complexity).
 getDepth ()
 Return the concept's depth (a metric used to estimate computation complexity).
 getQueryFeatures ()
 Return the concept's query feature bit field (a metric used to estimate computation complexity).

Protected Member Functions

 parseUserValue ($value)
 Initialise the datavalue from the given value string.
 loadDataItem (SMWDataItem $dataItem)
 clear ()

Private Member Functions

 getExportData ()
 Function not called anywhere but code kept for reference before migrating it to SMWExporter.


Detailed Description

This datavalue is used as a container for concept descriptions as used on Concept pages with the concept parserfunction.

It has a somewhat non-standard interface as compared to other datavalues, but this is not an issue.

Author:
Markus Krötzsch

Definition at line 16 of file SMW_DV_Concept.php.


Member Function Documentation

SMWConceptValue::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 18 of file SMW_DV_Concept.php.

SMWConceptValue::loadDataItem ( SMWDataItem dataItem  )  [protected]

See also:
SMWDataValue::loadDataItem()
Parameters:
$dataitem SMWDataItem
Returns:
boolean

Reimplemented from SMWDataValue.

Definition at line 27 of file SMW_DV_Concept.php.

References SMWDataItem::TYPE_CONCEPT.

SMWConceptValue::clear (  )  [protected]

Definition at line 37 of file SMW_DV_Concept.php.

SMWConceptValue::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 41 of file SMW_DV_Concept.php.

Referenced by getShortHTMLText().

SMWConceptValue::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 45 of file SMW_DV_Concept.php.

References getShortWikiText().

SMWConceptValue::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 49 of file SMW_DV_Concept.php.

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

SMWConceptValue::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 57 of file SMW_DV_Concept.php.

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

SMWConceptValue::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 65 of file SMW_DV_Concept.php.

SMWConceptValue::getExportData (  )  [private]

Function not called anywhere but code kept for reference before migrating it to SMWExporter.

Definition at line 74 of file SMW_DV_Concept.php.

References descriptionToExpData(), SMWExporter::getSpecialNsResource(), and SMWDataValue::isValid().

SMWConceptValue::descriptionToExpData ( desc,
&$  exact 
)

SMWConceptValue::getConceptText (  ) 

Return the concept's defining text (in SMW query syntax).

Definition at line 166 of file SMW_DV_Concept.php.

SMWConceptValue::getDocu (  ) 

Return the optional concept documentation.

Definition at line 171 of file SMW_DV_Concept.php.

SMWConceptValue::getSize (  ) 

Return the concept's size (a metric used to estimate computation complexity).

Definition at line 176 of file SMW_DV_Concept.php.

SMWConceptValue::getDepth (  ) 

Return the concept's depth (a metric used to estimate computation complexity).

Definition at line 181 of file SMW_DV_Concept.php.

SMWConceptValue::getQueryFeatures (  ) 

Return the concept's query feature bit field (a metric used to estimate computation complexity).

Definition at line 186 of file SMW_DV_Concept.php.


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

Generated on Thu Feb 9 07:15:40 2012 for Semantic MediaWiki by  doxygen 1.5.6