Description
parserBase | --parserStringWithInlineTags | --parserPackagePage | --parserTutorial
Located in File: /phpDocumentor/ParserElements.inc
- 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
Class Variables
Summary:
array
$children
array
$ini
mixed
$linked_element
string
$name
string
$package
string
$path
string
$tutorial_type
string
$type
boolean
$_xml
$children = false (line 2124)
Data type : array
links to the child tutorials, or false if none
$ini = false (line 2100)
Data type : array
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
$linked_element (line 2078)
Data type : mixed
The documentable element this tutorial is linked to
Can be a parserData, parserClass, or nothing for package/subpackage docs
$name (line 2088)
Data type : string
filename minus extension of this tutorial (used for @tutorial tag)
$next = false (line 2105)
Data type : tutorialLink
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
$package = 'default' (line 2067)
Data type : string
Overrides: Array
$parent = false (line 2119)
Data type : tutorialLink
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
$path (line 2083)
Data type : string
path to the tutorial page
$prev = false (line 2110)
Data type : tutorialLink
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
$tutorial_type (line 2072)
Data type : string
Either cls, pkg, or proc
$type = 'tutorial' (line 2065)
Data type : string
Overrides: Array
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
- var: - always 'tutorial'
$_xml = true (line 2090)
Data type : boolean
Class Constants
Summary:Method Detail
Summary:
Constructor parserTutorial (line 2136)
parserTutorial parserTutorial( parserXMLDocBookTag $data, information $info)
Parameters
- 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)
Info
Method Convert (line 2174)
void Convert( Converter &$c, [boolean $postprocess = true])
Overrides : parserPackagePage::Convert() parent method not documented
Parameters
- Converter &$c:
- boolean $postprocess: determines whether character data is postprocessed to be Converter-friendly or not.
Info
Method getLink (line 2278)
string|tutorialLink getLink( Converter &$c, [boolean $pure = false], [string $section = ''])
Get a link to this tutorial, or to any subsection of this tutorial
Parameters
- Converter &$c:
- boolean $pure: if true, returns a tutorialLink instead of a string
- string $section: section name to link to
Info
Method getNext (line 2243)
void getNext( Converter &$c)
Retrieve converter-specific link to the next tutorial's documentation
Parameters
- Converter &$c:
Info
Method getParent (line 2221)
void getParent( Converter &$c)
Retrieve converter-specific link to the parent tutorial's documentation
Parameters
- Converter &$c:
Info
Method getPrev (line 2265)
void getPrev( Converter &$c)
Retrieve converter-specific link to the previous tutorial's documentation
Parameters
- Converter &$c:
Info
Method getTitle (line 2154)
void getTitle( Converter &$c, [string $subsection = ''])
Retrieve the title of the tutorial, or of any subsection
Parameters
- Converter &$c:
- string $subsection: which subsection to retrieve the title from, if any
Info
- uses - parserXMLDocBookTag::getSubSection() - retrieve the subsection to to get a title from
Method isChildOf (line 2199)
boolean isChildOf( array $parents)
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
Parameters
- array $parents: array of parserTutorials that have child tutorials
Info
- return - whether or not this tutorial is a child of the any of the parents
Method setNext (line 2232)
void setNext( parserTutorial $next, Converter &$c)
Parameters
- parserTutorial $next:
- Converter &$c:
Info
- uses - parserTutorial::$next - creates a link to the documentation for the next tutorial
Method setParent (line 2184)
void setParent( parserTutorial $parent, Converter &$c)
Parameters
- parserTutorial $parent:
- Converter &$c:
Info
- uses - parserTutorial::$parent - creates a link to the documentation for the parent tutorial
Method setPrev (line 2254)
void setPrev( parserTutorial $prev, Converter &$c)
Parameters
- parserTutorial $prev:
- Converter &$c:
Info
- uses - parserTutorial::$prev - creates a link to the documentation for the previous tutorial