Description
parserBase | --parserStringWithInlineTags | --parserTag | --parserFileSourceTag
Located in File: /phpDocumentor/DocBlockTags.inc
represents "@filesource"
Use this to create a link to a highlighted phpxref-style source file listing
- tutorial: - @filesource
- 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_*
- since: - 1.2
- license: - LGPL
Classes extended from parserFileSourceTag:
- parserExampleTag
- represents "@example"
$keyword = 'filesource' (line Class Constants
Summary:Method Detail
Summary:
Constructor parserFileSourceTag (line 1090)
parserFileSourceTag parserFileSourceTag( string $filepath, array $value)
Set $source to $value, and set up path
Parameters
- string $filepath: the file's path
- array $value: output from phpDocumentorTWordParser::getFileSource()
Info
Method Convert (line 1106)
string Convert( Converter &$c)
Overrides : parserTag::Convert() Perform the output conversion on this parserTag using the output converter that is passed in
Return a link to the highlighted source and generate the source
Parameters
- Converter &$c: the output converter
Info
- return - output from getSourceLink()
- todo - CS cleanup - rename to convert for camelCase rule
- uses - parserFileSourceTag::ConvertSource() - generate source code and write it out
Method ConvertSource (line 1124)
void ConvertSource( Converter &$c)
Overridden in child classes as:
- parserExampleTag::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?
- usedby - parserFileSourceTag::Convert() - generate source code and write it out
- uses - parserFileSourceTag::writeSource()
- uses - phpDocumentor_HighlightParser - highlights source code
Method getSourceLink (line 1158)
output getSourceLink( Converter &$c)
Overridden in child classes as:
- parserExampleTag::getSourceLink()
- Retrieve a converter-specific link to the example
gets path to the sourcecode file
Parameters
- Converter &$c: the output converter
Info
- return - from getSourceLink()
- uses - Converter::getSourceLink()
Method writeSource (line 1145)
void writeSource( Converter &$c, string $source)
have the output converter write the source code
Parameters
- Converter &$c: the output converter
- string $source: highlighted source code
Info
- usedby - parserExampleTag::ConvertSource()
- usedby - parserFileSourceTag::ConvertSource()
- uses - Converter::writeSource() - export highlighted file source