Child classes:
- parserExampleTag
- represents "@example"
Inherited Methods
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 "@filesource"
Use this to create a link to a highlighted phpxref-style source file listing
Tags:
- 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
[ Top ]
Class Variables
$keyword = 'filesource'
[ Top ]
$path
[ Top ]
$source
[ Top ]
Class Methods
parserFileSourceTag
parserFileSourceTag parserFileSourceTag(
string
$filepath, array
$value)
[line 1090]
Set $source to $value, and set up path
Parameters:
- string $filepath - the file's path
- array $value - output from phpDocumentorTWordParser::getFileSource()
[ Top ]
Convert
string Convert(
Converter
&$c)
[line 1106]
Return a link to the highlighted source and generate the source
Tags:
- return - output from getSourceLink()
- todo - CS cleanup - rename to convert for camelCase rule
- uses - parserFileSourceTag::ConvertSource() - generate source code and write it out
Overrides parserTag::Convert() (Perform the output conversion on this parserTag using the output converter that is passed in)
Parameters:
- Converter &$c - the output converter
[ Top ]
ConvertSource
void ConvertSource(
Converter
&$c)
[line 1124]
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?
- usedby - parserFileSourceTag::Convert() - generate source code and write it out
- uses - parserFileSourceTag::writeSource()
- uses - phpDocumentor_HighlightParser - highlights source code
Overridden in child classes as:
- parserExampleTag::ConvertSource()
- convert the source code
Parameters:
- Converter &$c - the output converter
[ Top ]
getSourceLink
output getSourceLink(
Converter
&$c)
[line 1158]
gets path to the sourcecode file
Tags:
- return - from getSourceLink()
- uses - Converter::getSourceLink()
Overridden in child classes as:
- parserExampleTag::getSourceLink()
- Retrieve a converter-specific link to the example
Parameters:
- Converter &$c - the output converter
[ Top ]
writeSource
void writeSource(
Converter
&$c, string
$source)
[line 1145]
have the output converter write the source code
Tags:
- usedby - parserExampleTag::ConvertSource()
- usedby - parserFileSourceTag::ConvertSource()
- uses - Converter::writeSource() - export highlighted file source
Parameters:
- Converter &$c - the output converter
- string $source - highlighted source code
[ Top ]