Class: parserExampleInlineTag

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

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag
         |
         --parserExampleInlineTag

Represents the example inline tag, used to display an example file inside a docblock or tutorial

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

[line 567]
Represents the example inline tag, used to display an example file inside a docblock or tutorial

[ Top ]

mixed parserExampleInlineTag(
string
$value, string
$current_path, [bool
$isTutorial = false])

constructor

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 ]

string arrayConvert(
Converter
&$c)

converter helper for PHP 4.3.0+

Overrides parserSourceInlineTag::arrayConvert() (converter helper used in PHP 4.3.0+)

Converter &$c — output converter

[ Top ]

string getProgramListing(
)

Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial

[ Top ]

void setSource(
string|array
$source, [string|bool
$class = false])

sets the source

Overrides parserSourceInlineTag::setSource() (sets the source tag's value)

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 ]