Docs For Class parserTutorial

Description

author: Greg Beaver <[email protected]>
version: $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
copyright: 2002-2008 Gregory Beaver
since: 1.2
usedby: XMLPackagePageParser::parse() - using Publisher::PublishEvent(), a new tutorial is created from the file parsed, and passed to the Intermediate Parser

Located in /phpDocumentor/ParserElements.inc (line 2059)

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserPackagePage
         |
         --parserTutorial

Variable Summary

array $children

array $ini

mixed $linked_element

string $name

tutorialLink $next

string $package

tutorialLink $parent

string $path

tutorialLink $prev

string $tutorial_type

string $type

boolean $_xml

Method Summary

parserTutorial parserTutorial (parserXMLDocBookTag $data, information $info)

void Convert (Converter &$c, [boolean $postprocess = true])

string|tutorialLink getLink (Converter &$c, [boolean $pure = false], [string $section = ''])

void getNext (Converter &$c)

void getParent (Converter &$c)

void getPrev (Converter &$c)

void getTitle (Converter &$c, [string $subsection = ''])

boolean isChildOf (array $parents)

void setNext (parserTutorial $next, Converter &$c)

void setParent (parserTutorial $parent, Converter &$c)

void setPrev (parserTutorial $prev, Converter &$c)

Variables

array $children = false (line 2124)

links to the child tutorials, or false if none

array $ini = false (line 2100)

output from tutorialname.ext.ini

an array generated by phpDocumentor_parse_ini_file() containing an index 'Linked Tutorials' with an array of tutorial names in the order they should appear. This is used to generate a linked list of tutorials like phpDocumentor tags

mixed $linked_element (line 2078)

The documentable element this tutorial is linked to

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

string $name (line 2088)

filename minus extension of this tutorial (used for @tutorial tag)

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

string $package = 'default' (line 2067)

Redefinition of:

parserPackagePage::$package

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

string $path (line 2083)

path to the tutorial page

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 $tutorial_type (line 2072)

Either cls, pkg, or proc

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'

Redefinition of:

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

boolean $_xml = true (line 2090)

Inherited Variables

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value

Methods

Constructor parserTutorial (line 2136)

parserTutorial parserTutorial (parserXMLDocBookTag $data, information $info)

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)

Convert (line 2174)

void Convert (Converter &$c, [boolean $postprocess = true])

Converter &$c
boolean $postprocess: determines whether character data is postprocessed to be Converter-friendly or not.

Redefinition of:

parserPackagePage::Convert()

getLink (line 2278)

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

string|tutorialLink getLink (Converter &$c, [boolean $pure = false], [string $section = ''])

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

getNext (line 2243)

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

void getNext (Converter &$c)

Converter &$c

getParent (line 2221)

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

void getParent (Converter &$c)

Converter &$c

getPrev (line 2265)

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

void getPrev (Converter &$c)

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

void getTitle (Converter &$c, [string $subsection = ''])

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

isChildOf (line 2199)

Determine if this parserTutorial object is a child of another

WARNING: This method can enter an infinite loop when run on PHP v5.2.1... see PHP Bug #40608 and PEAR Bug #10289

return: whether or not this tutorial is a child of the any of the parents

boolean isChildOf (array $parents)

array $parents: array of parserTutorials that have child tutorials

setNext (line 2232)

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

void setNext (parserTutorial $next, Converter &$c)

parserTutorial $next
Converter &$c

setParent (line 2184)

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

void setParent (parserTutorial $parent, Converter &$c)

parserTutorial $parent
Converter &$c

setPrev (line 2254)

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

void setPrev (parserTutorial $prev, Converter &$c)

parserTutorial $prev
Converter &$c

Inherited Methods

Inherited From parserPackagePage

parserPackagePage::parserPackagePage()
parserPackagePage::Convert()

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()