Class: parserTutorial

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

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

Author(s):

Greg Beaver <[email protected]>

Version:

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

Copyright:

2002-2008 Gregory Beaver

Inherited Variables

Class: parserStringWithInlineTags

parserStringWithInlineTags::$value

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

Tags:

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

[ Top ]

Class Variables

$children = false

[line 2124]

links to the child tutorials, or false if none

Type:

array

[ 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

[ 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

[ Top ]

$name =

[line 2088]

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

Type:

string

[ Top ]

$next = false

[line 2105]

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

Tags:

usedby:

parserTutorial::setNext() - creates a link to the documentation for the next tutorial

Type:

tutorialLink

[ 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:

usedby:

parserTutorial::setParent() - creates a link to the documentation for the parent tutorial

Type:

tutorialLink

[ Top ]

$path =

[line 2083]

path to the tutorial page

Type:

string

[ Top ]

$prev = false

[line 2110]

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

Tags:

usedby:

parserTutorial::setPrev() - creates a link to the documentation for the previous tutorial

Type:

tutorialLink

[ Top ]

$tutorial_type =

[line 2072]

Either cls, pkg, or proc

Type:

string

[ 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

[ Top ]

Class Methods

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)

[ Top ]

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.

[ Top ]

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

[ Top ]

method getNext [line 2243]

void getNext(
Converter
&$c)

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

Parameters:

Converter

&$c

[ Top ]

method getParent [line 2221]

void getParent(
Converter
&$c)

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

Parameters:

Converter

&$c

[ Top ]

method getPrev [line 2265]

void getPrev(
Converter
&$c)

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

Parameters:

Converter

&$c

[ Top ]

method getTitle [line 2154]

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

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 ]

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

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 ]

method setNext [line 2232]

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

Tags:

uses:

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

Parameters:

parserTutorial	$next
Converter	&$c

[ Top ]

method setParent [line 2184]

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

Tags:

uses:

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

Parameters:

parserTutorial	$parent
Converter	&$c

[ Top ]

method setPrev [line 2254]

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

Tags:

uses:

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

Parameters:

parserTutorial	$prev
Converter	&$c

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:14:35 -0600 by phpDocumentor 1.4.4