Class: parserTutorial

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/ParserElements.inc

Class Overview

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

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: ParserElements.inc,v 1.33 2003/01/14 08:40:36 CelloG Exp $

Inherited Variables

Class: parserStringWithInlineTags

parserStringWithInlineTags::$cache
parserStringWithInlineTags::$value

Inherited Methods

Class: parserPackagePage

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

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
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen(): equivalent to trim(strlen($string))

Class: parserBase

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

Class Details

[line 1254]

Usedby: XMLPackagePageParser::parse()
Version: $Id: ParserElements.inc,v 1.33 2003/01/14 08:40:36 CelloG Exp $
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>
Since: 1.2

[ Top ]

Class Variables

$children = false

[line 1319]

links to the child tutorials, or false if none

Type:

array

[ Top ]

$ini = false

[line 1295]

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

[ Top ]

$linked_element =

[line 1273]

The documentable element this tutorial is linked to

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

Type:

mixed

[ Top ]

$name =

[line 1283]

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

Type:

string

[ Top ]

$next = false

[line 1300]

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

Type:

tutorialLink

[ Top ]

$package = 'default'

[line 1262]

Type:	string
Overrides:	Array

[ Top ]

$parent = false

[line 1314]

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

Type:

tutorialLink

[ Top ]

$path =

[line 1278]

path to the tutorial page

Type:

string

[ Top ]

$prev = false

[line 1305]

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

Type:

tutorialLink

[ Top ]

$tutorial_type =

[line 1267]

Either cls, pkg, or proc

Type:

string

[ Top ]

$type = 'tutorial'

[line 1260]

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

Var: always 'tutorial'

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserTutorial (Constructor) [line 1321]

parserTutorial parserTutorial(
mixed
$data, mixed
$info)

[ Top ]

Convert [line 1347]

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

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

[ Top ]

getLink [line 1408]

void getLink(
mixed
&$c, [mixed
$pure = false], [mixed
$section = ''])

[ Top ]

getNext [line 1389]

void getNext(
mixed
&$c)

[ Top ]

getParent [line 1376]

void getParent(
mixed
&$c)

[ Top ]

getPrev [line 1402]

void getPrev(
mixed
&$c)

[ Top ]

getTitle [line 1332]

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

[ Top ]

isChildOf [line 1361]

void isChildOf(
array
$parents)

Parameters:

array $parents — array of parserTutorials that have child tutorials

[ Top ]

setNext [line 1382]

void setNext(
mixed
$next, mixed
&$c)

[ Top ]

setParent [line 1352]

void setParent(
mixed
$parent, mixed
&$c)

[ Top ]

setPrev [line 1395]

void setPrev(
mixed
$prev, mixed
&$c)

[ Top ]