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

Public Member Functions

 addBreadcrumb ($name, $url)
 
 addTopic (&$topic)
 
getBreadcrumbs ()
 
 getId ()
 
 getParentTopicId ()
 
 getTitle ()
 
getTopics ()
 
 HelpToc ()
 
 setId ($id)
 
 setParentTopicId ($parentTopicId)
 
 setTitle ($title)
 
- 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

 $breadcrumbs
 
 $topics
 
- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Help table of contents class. A HelpToc object is associated with zero or more HelpTopic objects.

See Also
HelpTocDAO

Definition at line 18 of file HelpToc.inc.php.

Member Function Documentation

HelpToc::addBreadcrumb (   $name,
  $url 
)

Set breadcrumbs.

Parameters
$namestring
$urlstring

Definition at line 117 of file HelpToc.inc.php.

HelpToc::addTopic ( $topic)

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

Parameters
$topicHelpTopic

Definition at line 100 of file HelpToc.inc.php.

& HelpToc::getBreadcrumbs ( )

Get breadcrumbs.

Returns
array

Definition at line 108 of file HelpToc.inc.php.

References $breadcrumbs.

HelpToc::getId ( )

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

Returns
string

Definition at line 43 of file HelpToc.inc.php.

References DataObject\getData().

HelpToc::getParentTopicId ( )

Get the ID of the topic one-level up from this one.

Returns
string

Definition at line 75 of file HelpToc.inc.php.

References DataObject\getData().

HelpToc::getTitle ( )

Get toc title.

Returns
string

Definition at line 59 of file HelpToc.inc.php.

References DataObject\getData().

& HelpToc::getTopics ( )

Get the set of topics in this table of contents.

Returns
array the topics in order of appearance

Definition at line 91 of file HelpToc.inc.php.

References $topics.

HelpToc::HelpToc ( )

Constructor.

Definition at line 29 of file HelpToc.inc.php.

HelpToc::setId (   $id)

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

Parameters
$idint

Definition at line 51 of file HelpToc.inc.php.

References DataObject\setData().

HelpToc::setParentTopicId (   $parentTopicId)

Set the ID of the topic one-level up from this one.

Parameters
$parentTopicIdstring

Definition at line 83 of file HelpToc.inc.php.

References DataObject\setData().

HelpToc::setTitle (   $title)

Set toc title.

Parameters
$titlestring

Definition at line 67 of file HelpToc.inc.php.

References DataObject\setData().

Member Data Documentation

HelpToc::$breadcrumbs

The list of breadcrumbs belonging to this toc

Definition at line 24 of file HelpToc.inc.php.

Referenced by getBreadcrumbs().

HelpToc::$topics

The list of topics belonging to this toc

Definition at line 21 of file HelpToc.inc.php.

Referenced by getTopics().


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