Class: parserTutorial

Source Location: /phpDocumentor/ParserElements.inc

Class parserTutorial

Class Overview

Located in /phpDocumentor/ParserElements.inc [line 2059]

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

Author(s):

Greg Beaver <[email protected]>

API Tags:

Usedby:

XMLPackagePageParser::parse() - using Publisher::PublishEvent(), a new tutorial is created from the file parsed, and passed to the Intermediate Parser

Information Tags:

Version:	$Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
Copyright:	2002-2008 Gregory Beaver
Since:	1.2

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited From parserPackagePage

parserPackagePage::parserPackagePage()

parserPackagePage::Convert()

Inherited From 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))

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

array	$children	links to the child tutorials, or false if none
array	$ini	output from tutorialname.ext.ini
mixed	$linked_element	The documentable element this tutorial is linked to
string	$name	filename minus extension of this tutorial (used for @tutorial tag)
tutorialLink	$next	link to the next tutorial in a document series, or false if none
string	$package
tutorialLink	$parent	link to the parent tutorial in a document series, or false if none
string	$path	path to the tutorial page
tutorialLink	$prev	link to the previous tutorial in a document series, or false if none
string	$tutorial_type	Either cls, pkg, or proc
string	$type	Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
boolean	$_xml

[ Top ]

Method Summary

parserTutorial	parserTutorial()
void	Convert()
string\|tutorialLink	getLink()	Get a link to this tutorial, or to any subsection of this tutorial
void	getNext()	Retrieve converter-specific link to the next tutorial's documentation
void	getParent()	Retrieve converter-specific link to the parent tutorial's documentation
void	getPrev()	Retrieve converter-specific link to the previous tutorial's documentation
void	getTitle()	Retrieve the title of the tutorial, or of any subsection
boolean	isChildOf()	Determine if this parserTutorial object is a child of another
void	setNext()
void	setParent()
void	setPrev()

[ Top ]

Properties

array $children = false [line 2124]

links to the child tutorials, or false if none

[ Top ]

array $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

[ Top ]

mixed $linked_element [line 2078]

The documentable element this tutorial is linked to

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

[ Top ]

string $name [line 2088]

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

[ Top ]

tutorialLink $next = false [line 2105]

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

API Tags:

Usedby:

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

[ Top ]

string $package = 'default' [line 2067]

Redefinition of:

parserPackagePage::$package

[ Top ]

tutorialLink $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

API Tags:

Usedby:

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

[ Top ]

string $path [line 2083]

path to the tutorial page

[ Top ]

tutorialLink $prev = false [line 2110]

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

API Tags:

Usedby:

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

[ Top ]

string $tutorial_type [line 2072]

Either cls, pkg, or proc

[ Top ]

string $type = 'tutorial' [line 2065]

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

Redefinition of:

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

[ Top ]

boolean $_xml = true [line 2090]

[ Top ]

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 ]

Convert [line 2174]

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

Parameters:

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

Redefinition of:

parserPackagePage::Convert()

[ Top ]

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 ]

getNext [line 2243]

void getNext(
Converter
&$c 
)

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

Parameters:

Converter

&$c:

[ Top ]

getParent [line 2221]

void getParent(
Converter
&$c 
)

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

Parameters:

Converter

&$c:

[ Top ]

getPrev [line 2265]

void getPrev(
Converter
&$c 
)

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

Parameters:

Converter

&$c:

[ Top ]

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

API Tags:

Uses:

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

[ Top ]

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

API Tags:

Return:

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

[ Top ]

setNext [line 2232]

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

Parameters:

parserTutorial	$next:
Converter	&$c:

API Tags:

Uses:

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

[ Top ]

setParent [line 2184]

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

Parameters:

parserTutorial	$parent:
Converter	&$c:

API Tags:

Uses:

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

[ Top ]

setPrev [line 2254]

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

Parameters:

parserTutorial	$prev:
Converter	&$c:

API Tags:

Uses:

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

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:49 -0600 by phpDocumentor 1.4.4

	phpDocumentor ParserElements

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