Docs For Class parserExampleTag

Description

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserFileSourceTag
            |
            --parserExampleTag

Located in File: /phpDocumentor/DocBlockTags.inc

represents "@example"

tutorial: - @example
author: - Greg Beaver <[email protected]>
version: - Release: @VER@
copyright: - 2002-2008 Gregory Beaver
link: - http://pear.php.net/PhpDocumentor
link: - http://www.phpdoc.org
todo: - CS cleanup - change package to PhpDocumentor
todo: - CS cleanup - change classname to PhpDocumentor_*
license: - LGPL

Class Variables

Summary:

string $keyword

$keyword = 'example' (line 1186)

Data type : string

Overrides: Array

always "example"

Class Constants

Summary:

Method Detail

Summary:

parserExampleTag parserExampleTag (parserStringWithInlineTags $value, string $current_path)

void ConvertSource (Converter &$c)

string getSourceLink (Converter &$c)

Constructor parserExampleTag (line 1203)

parserExampleTag parserExampleTag( parserStringWithInlineTags $value, string $current_path)

Reads and parses the example file indicated

The example tag takes one parameter: the full path to a php file that should be parsed and included as an example.

Parameters

parserStringWithInlineTags $value: tag value
string $current_path: path of file containing this @example tag

Info

todo - does this "x = y = z = false" still work as expected in PHP5?
todo - CS cleanup - rename constant to TOKENIZER_EXT
uses - phpDocumentorTWordParser::getFileSource() - uses to parse an example and retrieve all tokens by line number

Method ConvertSource (line 1353)

void ConvertSource( Converter &$c)

Overrides : parserFileSourceTag::ConvertSource() convert the source code

convert the source code

Parameters

Converter &$c: the output converter

Info

todo - CS cleanup - rename to convertSource for camelCase rule
todo - what's up with all the "return" statements? can they _all_ be removed?
uses - parserFileSourceTag::writeSource()
uses - phpDocumentor_HighlightParser - highlights source code

Method getSourceLink (line 1389)

string getSourceLink( Converter &$c)

Overrides : parserFileSourceTag::getSourceLink() gets path to the sourcecode file

Retrieve a converter-specific link to the example

Parameters

Converter &$c: the output converter

Info

uses - Converter::getExampleLink() - retrieve the link to the example

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserFileSourceTag

parserFileSourceTag::$path -

parserFileSourceTag::$source -

Inherited From Class parserTag

parserTag::$type - Type is used by many functions to skip the hassle of

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

Inherited From Class parserFileSourceTag

parserFileSourceTag::parserFileSourceTag() - Set $source to $value, and set up path

parserFileSourceTag::Convert() - Return a link to the highlighted source and generate the source

parserFileSourceTag::ConvertSource() - convert the source code

parserFileSourceTag::getSourceLink() - gets path to the sourcecode file

parserFileSourceTag::writeSource() - have the output converter write the source code

Inherited From Class parserTag

parserTag::parserTag() - Set up the tag

parserTag::Convert() - Perform the output conversion on this parserTag using the output converter that is passed in

parserTag::getString() - Returns the text minus any inline tags

parserTag::HandleEvent() - Called by the parserDescParser when processing a description.

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

Class parserExampleTag

Description

represents "@example"

Class Variables

$keyword = 'example' (line 1186)

Data type : string

always "example"

Class Constants

Method Detail

Constructor parserExampleTag (line 1203)

parserExampleTag parserExampleTag( parserStringWithInlineTags $value, string $current_path)

Reads and parses the example file indicated

Parameters

Info

Method ConvertSource (line 1353)

void ConvertSource( Converter &$c)

convert the source code

Parameters

Info

Method getSourceLink (line 1389)

string getSourceLink( Converter &$c)

Retrieve a converter-specific link to the example

Parameters

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserFileSourceTag

parserFileSourceTag::$path -

parserFileSourceTag::$source -

Inherited From Class parserTag

parserTag::$type - Type is used by many functions to skip the hassle of

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

Inherited From Class parserFileSourceTag

parserFileSourceTag::parserFileSourceTag() - Set $source to $value, and set up path

parserFileSourceTag::Convert() - Return a link to the highlighted source and generate the source

parserFileSourceTag::ConvertSource() - convert the source code

parserFileSourceTag::getSourceLink() - gets path to the sourcecode file

parserFileSourceTag::writeSource() - have the output converter write the source code

Inherited From Class parserTag

parserTag::parserTag() - Set up the tag

parserTag::Convert() - Perform the output conversion on this parserTag using the output converter that is passed in

parserTag::getString() - Returns the text minus any inline tags

parserTag::HandleEvent() - Called by the parserDescParser when processing a description.

Inherited From Class 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 Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value