Class parserFileSourceTag

Description
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 1067)

Always "filesource"


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

Redefined in descendants as:
string $path (line 1075)
array $source (line 1071)

Inherited Variables

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value
Methods
Constructor parserFileSourceTag (line 1090)

Set $source to $value, and set up path

parserFileSourceTag parserFileSourceTag (string $filepath, array $value)
Convert (line 1106)

Return a link to the highlighted source and generate the source

string Convert (Converter &$c)

Redefinition of:
parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
ConvertSource (line 1124)

convert the source code

void ConvertSource (Converter &$c)

Redefined in descendants as:
getSourceLink (line 1158)

gets path to the sourcecode file

output getSourceLink (Converter &$c)

Redefined in descendants as:
writeSource (line 1145)

have the output converter write the source code

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

Documentation generated on Mon, 05 Dec 2011 21:15:06 -0600 by phpDocumentor 1.4.4