Docs For Class parserFileSourceTag

Description

represents "@filesource"

Use this to create a link to a highlighted phpxref-style source file listing

tutorial: @filesource
author: Greg Beaver <cellog@php.net>
version: Release: 1.4.2
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

Located in /PEAR/PhpDocumentor/phpDocumentor/DocBlockTags.inc (line 1059)

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

Direct descendents

Class	Description
parserExampleTag	represents "@example"

Variable Summary

string $keyword

string $path

array $source

Method Summary

parserFileSourceTag parserFileSourceTag (string $filepath, array $value)

string Convert (Converter &$c)

void ConvertSource (Converter &$c)

output getSourceLink (Converter &$c)

void writeSource (Converter &$c, string $source)

Variables

string $keyword = 'filesource' (line 1065)

Always "filesource"

Redefinition of:

parserTag::$keyword: tag name (see, access, etc.)

Redefined in descendants as:

parserExampleTag::$keyword : always "example"

string $path (line 1073)

array $source (line 1069)

Inherited Variables

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value

Methods

Constructor parserFileSourceTag (line 1088)

Set $source to $value, and set up path

parserFileSourceTag parserFileSourceTag (string $filepath, array $value)

string $filepath: the file's path
array $value: output from phpDocumentorTWordParser::getFileSource()

Convert (line 1104)

Return a link to the highlighted source and generate the source

return: output from getSourceLink()
todo: CS cleanup - rename to convert for camelCase rule
uses: parserFileSourceTag::ConvertSource() - generate source code and write it out

string Convert (Converter &$c)

Converter &$c: the output converter

Redefinition of:

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

ConvertSource (line 1122)

convert the source code

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

void ConvertSource (Converter &$c)

Converter &$c: the output converter

Redefined in descendants as:

parserExampleTag::ConvertSource() : convert the source code

getSourceLink (line 1156)

gets path to the sourcecode file

return: from getSourceLink()
uses: Converter::getSourceLink()

output getSourceLink (Converter &$c)

Converter &$c: the output converter

Redefined in descendants as:

parserExampleTag::getSourceLink() : Retrieve a converter-specific link to the example

writeSource (line 1143)

have the output converter write the source code

usedby: parserExampleTag::ConvertSource()
usedby: parserFileSourceTag::ConvertSource()
uses: Converter::writeSource() - export highlighted file source

void writeSource (Converter &$c, string $source)

Converter &$c: the output converter
string $source: highlighted source code

Inherited Methods

Inherited From parserTag

parserTag::parserTag()
parserTag::Convert()
parserTag::getString()
parserTag::HandleEvent()

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()