Description
parserBase | --parserInlineTag | --parserSourceInlineTag | --parserExampleInlineTag
Located in File: /phpDocumentor/InlineTags.inc
Represents the example inline tag, used to display an example file inside a docblock or tutorial
- 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
Class Variables
Summary:Class Constants
Summary:Method Detail
Summary:
string
getProgramListing
()
Constructor parserExampleInlineTag (line 582)
mixed parserExampleInlineTag( string $value, string $current_path, [bool $isTutorial = false])
constructor
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
Info
- todo - replace tokenizer_ext constant with TOKENIZER_EXT for CS rule
Method arrayConvert (line 733)
string arrayConvert( Converter &$c)
Overrides : parserSourceInlineTag::arrayConvert() converter helper used in PHP 4.3.0+
converter helper for PHP 4.3.0+
Parameters
- Converter &$c: output converter
Info
- uses - phpDocumentor_HighlightParser - Parses the tokenized source
Method getProgramListing (line 752)
string getProgramListing( )
Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial
Info
Method setSource (line 719)
void setSource( string|array $source, [string|bool $class = false])
Overrides : parserSourceInlineTag::setSource() sets the source tag's value
sets the source
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
