Class: parserExampleTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserExampleTag

Class Overview

represents "@example"

The example tag

Located in /phpDocumentor/DocBlockTags.inc [line 802]

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

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: DocBlockTags.inc,v 1.8 2006/10/24 04:18:14 cellog Exp $
Tutorial:	@example

Properties

$keyword

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserFileSourceTag

parserFileSourceTag::$path

parserFileSourceTag::$source

Inherited From parserTag

parserTag::$type

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

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

parserFileSourceTag::getSourceLink()

parserFileSourceTag::writeSource()

Inherited From parserTag

parserTag::parserTag()

Set up the tag

parserTag::Convert()

parserTag::getString()

parserTag::HandleEvent()

Called by the parserDescParser when processing a description.

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

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 parserBase

parserBase::getType()

parserBase::getValue()

parserBase::setValue()

[ Top ]

Property Summary

string

$keyword

always "example"

[ Top ]

Method Summary

parserExampleTag	parserExampleTag()	Reads and parses the example file indicated
void	ConvertSource()
void	getSourceLink()	Retrieve a converter-specific link to the example

[ Top ]

Properties

string $keyword = 'example' [line 808]

always "example"

Redefinition of:

parserFileSourceTag::$keyword: Always "filesource"

[ Top ]

Methods

Constructor parserExampleTag [line 819]

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:
string	$current_path:	path of file containing this @example tag

API Tags:

Uses:

phpDocumentorTWordParser::getFileSource() - uses to parse an example and retrieve all tokens by line number

[ Top ]

ConvertSource [line 966]

void ConvertSource(
Converter
&$c 
)

Parameters:

Converter

&$c:

API Tags:

Uses:	parserFileSourceTag::writeSource()
Uses:	phpDocumentor_HighlightParser - highlights source code

Redefinition of:

parserFileSourceTag::ConvertSource()

[ Top ]

getSourceLink [line 995]

void getSourceLink(
Converter
&$c 
)

Retrieve a converter-specific link to the example

Parameters:

Converter

&$c:

API Tags:

Uses:

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

Redefinition of:

parserFileSourceTag::getSourceLink()

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:22:14 -0500 by phpDocumentor 1.3.1

	phpDocumentor DocBlockTags

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]