array $children = false (line 2124)

links to the child tutorials, or false if none

mixed $linked_element (line 2078)

The documentable element this tutorial is linked to

Can be a parserData, parserClass, or nothing for package/subpackage docs

tutorialLink $next = false (line 2105)

link to the next tutorial in a document series, or false if none

• usedby: parserTutorial::setNext() - creates a link to the documentation for the next tutorial

tutorialLink $parent = false (line 2119)

link to the parent tutorial in a document series, or false if none

This is used to generate an "Up" or "Home" link like the php manual. The parent is defined as a tutorial that has a parenttutorialname.ext.ini file and is not contained by any other tutorial's tutorialname.ext.ini

• usedby: parserTutorial::setParent() - creates a link to the documentation for the parent tutorial

tutorialLink $prev = false (line 2110)

link to the previous tutorial in a document series, or false if none

• usedby: parserTutorial::setPrev() - creates a link to the documentation for the previous tutorial

string $type = 'tutorial' (line 2065)

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

• var: always 'tutorial'

parserPackagePage::$type

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

Constructor parserTutorial (line 2136)

• parserXMLDocBookTag $data: top-level tag (<refentry> for 1.2.0)
• information $info:

  about the tutorial file. Format:

   array('tutename' => tutorial name,
         'path' => relative path of tutorial to tutorials/ directory
         'ini' => contents of the tutorial .ini file, if any)

getLink (line 2278)

Get a link to this tutorial, or to any subsection of this tutorial

• Converter &$c
• boolean $pure: if true, returns a tutorialLink instead of a string
• string $section: section name to link to

getParent (line 2221)

Retrieve converter-specific link to the parent tutorial's documentation

• Converter &$c

getTitle (line 2154)

Retrieve the title of the tutorial, or of any subsection

• uses: parserXMLDocBookTag::getSubSection() - retrieve the subsection to to get a title from

• Converter &$c
• string $subsection: which subsection to retrieve the title from, if any

setNext (line 2232)

• uses: parserTutorial::$next - creates a link to the documentation for the next tutorial

• parserTutorial $next
• Converter &$c

setPrev (line 2254)

• uses: parserTutorial::$prev - creates a link to the documentation for the previous tutorial

• parserTutorial $prev
• Converter &$c