Class: parserExampleTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserExampleTag

Class Overview

represents "@example"

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

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

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Tutorial:	@example
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

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

convert the source code

parserFileSourceTag::getSourceLink()

gets path to the sourcecode file

parserFileSourceTag::writeSource()

have the output converter write the source code

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

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

string

$keyword

always "example"

[ Top ]

Method Summary

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

[ Top ]

Properties

string $keyword = 'example' [line 1186]

always "example"

Redefinition of:

parserFileSourceTag::$keyword: Always "filesource"

[ Top ]

Methods

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

API Tags:

Uses:

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

Information Tags:

Todo:	does this "x = y = z = false" still work as expected in PHP5?
Todo:	CS cleanup - rename constant to TOKENIZER_EXT

[ Top ]

ConvertSource [line 1353]

void ConvertSource(
Converter
&$c 
)

convert the source code

Parameters:

Converter

&$c:

the output converter

API Tags:

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

Information Tags:

Todo:	CS cleanup - rename to convertSource for camelCase rule
Todo:	what's up with all the "return" statements? can they _all_ be removed?

Redefinition of:

parserFileSourceTag::ConvertSource(): convert the source code

[ Top ]

getSourceLink [line 1389]

string getSourceLink(
Converter
&$c 
)

Retrieve a converter-specific link to the example

Parameters:

Converter

&$c:

the output converter

API Tags:

Uses:

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

Redefinition of:

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

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:18:08 -0600 by phpDocumentor 1.4.4

	phpDocumentor DocBlockTags

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