Inherited Methods
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
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.
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))
Class: parserBase
- parserBase::getType()
- gets the type
- parserBase::getValue()
- gets the value
- parserBase::setValue()
- sets the given value
Class Details
represents "@example"
Tags:
- 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
[ Top ]
Class Variables
$keyword = 'example'
[ Top ]
Class Methods
parserExampleTag
parserExampleTag parserExampleTag(
parserStringWithInlineTags
$value, string
$current_path)
[line 1203]
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.
Tags:
- 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
Parameters:
- parserStringWithInlineTags $value - tag value
- string $current_path - path of file containing this @example tag
[ Top ]
ConvertSource
void ConvertSource(
Converter
&$c)
[line 1353]
convert the source code
Tags:
- 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
Overrides parserFileSourceTag::ConvertSource() (convert the source code)
Parameters:
- Converter &$c - the output converter
[ Top ]
getSourceLink
string getSourceLink(
Converter
&$c)
[line 1389]
Retrieve a converter-specific link to the example
Tags:
- uses - Converter::getExampleLink() - retrieve the link to the example
Overrides parserFileSourceTag::getSourceLink() (gets path to the sourcecode file)
Parameters:
- Converter &$c - the output converter
[ Top ]