Inherited Methods
Class: parserSourceInlineTag
- parserSourceInlineTag::parserSourceInlineTag()
- constructor
- parserSourceInlineTag::arrayConvert()
- converter helper used in PHP 4.3.0+
- parserSourceInlineTag::Convert()
- convert the tag
- parserSourceInlineTag::getString()
- gets the source string
- parserSourceInlineTag::setSource()
- sets the source tag's value
- parserSourceInlineTag::stringConvert()
- converter helper used in PHP 4.2.3-
- parserSourceInlineTag::Strlen()
- only used to determine blank lines. {@source} will not be blank, probably
Class: parserInlineTag
- parserInlineTag::parserInlineTag()
- sets up the tag
- parserInlineTag::getString()
- always gets an empty string
- parserInlineTag::Strlen()
- get length of the tag
Class: parserBase
- parserBase::getType()
- gets the type
- parserBase::getValue()
- gets the value
- parserBase::setValue()
- sets the given value
Class Details
Represents the example inline tag, used to display an example file inside a docblock or tutorial
Tags:
- tutorial - inline {@example}
- author - Gregory Beaver <[email protected]>
- version - Release: @VER@
- copyright - 2002-2008 Gregory Beaver
- see - parserStringWithInlineTags
- link - http://www.phpdoc.org
- link - http://pear.php.net/PhpDocumentor
- todo - CS cleanup - change classname to PhpDocumentor_*
- todo - CS cleanup - change package to PhpDocumentor
- license - LGPL
[ Top ]
Class Variables
Class Methods
parserExampleInlineTag
mixed parserExampleInlineTag(
string
$value, string
$current_path, [bool
$isTutorial = false])
[line 582]
constructor
Tags:
- todo - replace tokenizer_ext constant with TOKENIZER_EXT for CS rule
Parameters:
- string $value - format "filepath[ start [end]]" where start and end are line numbers with the end line number optional
- string $current_path - full path to the current file, used to check relative directory locations
- bool $isTutorial - if true, then this is in a tutorial
[ Top ]
arrayConvert
string arrayConvert(
Converter
&$c)
[line 733]
converter helper for PHP 4.3.0+
Tags:
- uses - phpDocumentor_HighlightParser - Parses the tokenized source
Overrides parserSourceInlineTag::arrayConvert() (converter helper used in PHP 4.3.0+)
Parameters:
- Converter &$c - output converter
[ Top ]
getProgramListing
string getProgramListing(
)
[line 752]
Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial
Parameters:
[ Top ]
setSource
void setSource(
string|array
$source, [string|bool
$class = false])
[line 719]
sets the source
Overrides parserSourceInlineTag::setSource() (sets the source tag's value)
Parameters:
- string|array $source - source code
- string|bool $class - class name if this is a method, boolean in php 4.3.0, if this is a method this will be true
[ Top ]