Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
HelpTopic Class Reference
Inheritance diagram for HelpTopic:
DataObject

Public Member Functions

 addRelatedTopic (&$relatedTopic)
 
 addSection (&$section)
 
 getId ()
 
getRelatedTopics ()
 
getSections ()
 
 getSubTocId ()
 
 getTitle ()
 
 getTocId ()
 
 HelpTopic ()
 
 setId ($id)
 
 setSubTocId ($subTocId)
 
 setTitle ($title)
 
 setTocId ($tocId)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
getSupportedExtractionAdapters ()
 
getSupportedInjectionAdapters ()
 
getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata (&$metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
upcastTo (&$targetObject)
 

Public Attributes

 $relatedTopics
 
 $sections
 
- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

A HelpTopic object is associated with a single HelpToc object and zero or more HelpTopicSection objects.

See Also
HelpTopicDAO

Definition at line 17 of file HelpTopic.inc.php.

Member Function Documentation

HelpTopic::addRelatedTopic ( $relatedTopic)

Add a related topic

Parameters
$sectionHelpTopicSection

Definition at line 131 of file HelpTopic.inc.php.

HelpTopic::addSection ( $section)

Associate a section with this topic. Sections are added in the order they appear in the topic (i.e., FIFO).

Parameters
$sectionHelpTopicSection

Definition at line 115 of file HelpTopic.inc.php.

HelpTopic::getId ( )

Get topic ID (a unique six-digit string).

Returns
string

Definition at line 42 of file HelpTopic.inc.php.

References DataObject\getData().

& HelpTopic::getRelatedTopics ( )

Get the set of related topics.

Returns
array the related topics

Definition at line 123 of file HelpTopic.inc.php.

References $relatedTopics.

& HelpTopic::getSections ( )

Get the set of sections comprising this topic's contents.

Returns
array the sections in order of appearance

Definition at line 106 of file HelpTopic.inc.php.

References $sections.

HelpTopic::getSubTocId ( )

Get the ID of this topic's subtoc.

Returns
string

Definition at line 90 of file HelpTopic.inc.php.

References DataObject\getData().

HelpTopic::getTitle ( )

Get topic title.

Returns
string

Definition at line 58 of file HelpTopic.inc.php.

References DataObject\getData().

HelpTopic::getTocId ( )

Get the ID of this topic's toc.

Returns
string

Definition at line 74 of file HelpTopic.inc.php.

References DataObject\getData().

HelpTopic::HelpTopic ( )

Constructor.

Definition at line 28 of file HelpTopic.inc.php.

HelpTopic::setId (   $id)

Set topic ID (a unique six-digit string).

Parameters
$idstring

Definition at line 50 of file HelpTopic.inc.php.

References DataObject\setData().

HelpTopic::setSubTocId (   $subTocId)

Set the ID of this topic's subtoc.

Parameters
$subTocIdstring

Definition at line 98 of file HelpTopic.inc.php.

References DataObject\setData().

HelpTopic::setTitle (   $title)

Set topic title.

Parameters
$titlestring

Definition at line 66 of file HelpTopic.inc.php.

References DataObject\setData().

HelpTopic::setTocId (   $tocId)

Set the ID of this topic's toc.

Parameters
$tocIdstring

Definition at line 82 of file HelpTopic.inc.php.

References DataObject\setData().

Member Data Documentation

HelpTopic::$relatedTopics

The set of related topics

Definition at line 23 of file HelpTopic.inc.php.

Referenced by getRelatedTopics().

HelpTopic::$sections

The set of sections comprising this topic

Definition at line 20 of file HelpTopic.inc.php.

Referenced by getSections().


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