Docs For Class parserExampleInlineTag

Description

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

Located in /phpDocumentor/InlineTags.inc (line 567)

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

Method Summary

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

string arrayConvert (Converter &$c)

string getProgramListing ()

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

Variables

Inherited Variables

Inherited from parserSourceInlineTag

parserSourceInlineTag::$end
parserSourceInlineTag::$inlinetype
parserSourceInlineTag::$source
parserSourceInlineTag::$start

Inherited from parserInlineTag

parserInlineTag::$type

Inherited from parserBase

parserBase::$value

Methods

Constructor parserExampleInlineTag (line 582)

constructor

todo: replace tokenizer_ext constant with TOKENIZER_EXT for CS rule

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

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

arrayConvert (line 733)

converter helper for PHP 4.3.0+

uses: phpDocumentor_HighlightParser - Parses the tokenized source

string arrayConvert (Converter &$c)

Converter &$c: output converter

Redefinition of:

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

getProgramListing (line 752)

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

string getProgramListing ()

setSource (line 719)

sets the source

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

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

Redefinition of:

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

Inherited Methods

Inherited From parserSourceInlineTag

parserSourceInlineTag::parserSourceInlineTag()
parserSourceInlineTag::arrayConvert()
parserSourceInlineTag::Convert()
parserSourceInlineTag::getString()
parserSourceInlineTag::setSource()
parserSourceInlineTag::stringConvert()
parserSourceInlineTag::Strlen()

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()
parserInlineTag::getString()
parserInlineTag::Strlen()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()