phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: parserTutorial

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserElements.inc

Class Overview

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



Author(s):

Version:

  • $Id$

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

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

[line 2071]
  • Author: Greg Beaver <cellog@php.net>
  • Version: $Id$
  • 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


[ Top ]


Class Variables

$children =  false

[line 2136]

links to the child tutorials, or false if none

Type:   array


[ Top ]

$ini =  false

[line 2112]

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 2090]

The documentable element this tutorial is linked to

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


Type:   mixed


[ Top ]

$name =

[line 2100]

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

Type:   string


[ Top ]

$next =  false

[line 2117]

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

Type:   tutorialLink


[ Top ]

$package =  'default'

[line 2079]


Type:   string
Overrides:   Array


[ Top ]

$parent =  false

[line 2131]

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 2095]

path to the tutorial page

Type:   string


[ Top ]

$prev =  false

[line 2122]

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

Type:   tutorialLink


[ Top ]

$tutorial_type =

[line 2084]

Either cls, pkg, or proc

Type:   string


[ Top ]

$type =  'tutorial'

[line 2077]

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

Type:   string
Overrides:   Array


[ Top ]



Method Detail

parserTutorial (Constructor)   [line 2148]

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)


[ Top ]

Convert   [line 2186]

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.

[ Top ]

getLink   [line 2290]

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

[ Top ]

getNext   [line 2255]

void getNext( Converter &$c)

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

Parameters:

Converter   &$c     

[ Top ]

getParent   [line 2233]

void getParent( Converter &$c)

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

Parameters:

Converter   &$c     

[ Top ]

getPrev   [line 2277]

void getPrev( Converter &$c)

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

Parameters:

Converter   &$c     

[ Top ]

getTitle   [line 2166]

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

Retrieve the title of the tutorial, or of any subsection
  • 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   [line 2211]

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

  • 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   [line 2244]

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


Parameters:

parserTutorial   $next     
Converter   &$c     

[ Top ]

setParent   [line 2196]

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


Parameters:

parserTutorial   $parent     
Converter   &$c     

[ Top ]

setPrev   [line 2266]

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


Parameters:

parserTutorial   $prev     
Converter   &$c     

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:02:41 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.