Class: parserTutorial

Source Location: /phpDocumentor/ParserElements.inc

Class Overview [line 2059]

Author(s):

Version:

  • $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods

Inherited Variables

Class: parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited Constants

Inherited Methods

Class: parserPackagePage

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

Class: parserStringWithInlineTags

parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString()
return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
parserStringWithInlineTags::hasInlineTag()
Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource()
Pass source code to any {@source} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))

Class: parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

Class Details

Tags:

[ Top ]

Class Variables

$children =  false

[line 2124]

links to the child tutorials, or false if none

Type: array

Overrides:

[ Top ]

$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

Type: array

Overrides:

[ Top ]

$linked_element

[line 2078]

The documentable element this tutorial is linked to

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

Type: mixed

Overrides:

[ Top ]

$name

[line 2088]

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

Type: string

Overrides:

[ Top ]

$next =  false

[line 2105]

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

Tags:

Type: tutorialLink

Overrides:

[ Top ]

$package =  'default'

[line 2067]

Type: string

Overrides: Array

[ Top ]

$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

Tags:

Type: tutorialLink

Overrides:

[ Top ]

$path

[line 2083]

path to the tutorial page

Type: string

Overrides:

[ Top ]

$prev =  false

[line 2110]

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

Tags:

Type: tutorialLink

Overrides:

[ Top ]

$tutorial_type

[line 2072]

Either cls, pkg, or proc

Type: string

Overrides:

[ Top ]

$type =  'tutorial'

[line 2065]

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

Tags:

  • var - always 'tutorial'

Type: string

Overrides: Array

[ Top ]

$_xml =  true

[line 2090]

Type: boolean

Overrides:

[ Top ]

Class Methods

parserTutorial

parserTutorial parserTutorial( parserXMLDocBookTag $data, information $info)

[line 2136]

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)

[ Top ]

Convert

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

[line 2174]

Overrides parserPackagePage::Convert() (parent method not documented)

Parameters:

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

[ Top ]

getLink

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

[line 2278]

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

[ Top ]

getNext

void getNext( Converter &$c)

[line 2243]

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

Parameters:

[ Top ]

getParent

void getParent( Converter &$c)

[line 2221]

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

Parameters:

[ Top ]

getPrev

void getPrev( Converter &$c)

[line 2265]

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

Parameters:

[ Top ]

getTitle

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

[line 2154]

Retrieve the title of the tutorial, or of any subsection

Tags:

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

Parameters:

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

[ Top ]

isChildOf

boolean isChildOf( array $parents)

[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

Tags:

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

Parameters:

  • array $parents - array of parserTutorials that have child tutorials

[ Top ]

setNext

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

[line 2232]

Tags:

Parameters:

[ Top ]

setParent

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

[line 2184]

Tags:

Parameters:

[ Top ]

setPrev

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

[line 2254]

Tags:

Parameters:

[ Top ]

Class Constants

Documentation generated on Tue, 06 Dec 2011 07:08:23 -0600 by phpDocumentor 1.4.4