Child classes:
- parserExampleInlineTag
- Represents the example inline tag, used to display an example file inside a docblock or tutorial
Inherited Methods
Class: parserInlineTag
- parserInlineTag::parserInlineTag()
- sets up the tag
- parserInlineTag::getString()
- always gets an empty string
- parserInlineTag::Strlen()
- get length of the tag
Class: parserBase
- parserBase::getType()
- gets the type
- parserBase::getValue()
- gets the value
- parserBase::setValue()
- sets the given value
Class Details
represents inline source tag, used for function/method source
Tags:
- tutorial - inline {@source}
- author - Gregory Beaver <[email protected]>
- version - Release: @VER@
- copyright - 2002-2008 Gregory Beaver
- see - parserStringWithInlineTags
- link - http://www.phpdoc.org
- link - http://pear.php.net/PhpDocumentor
- todo - CS cleanup - change classname to PhpDocumentor_*
- todo - CS cleanup - change package to PhpDocumentor
- license - LGPL
[ Top ]
Class Variables
$end = '*'
[line 395]
Last line to display
Tags:
- var - If '*' then the whole source will be used, otherwise the $start to $end line numbers will be displayed
Type: '*'|integer
Overrides:
[ Top ]
$inlinetype = 'source'
[ Top ]
$source = false
[line 401]
tokenized source organized by line numbers for php 4.3.0+, the old
{@source} tag used a string
Type: string|array
Overrides:
[ Top ]
$start = 1
[ Top ]
Class Methods
parserSourceInlineTag
parserSourceInlineTag parserSourceInlineTag(
string
$value)
[line 414]
constructor
Parameters:
- string $value - format "start [end]", where start and end are line numbers with the end line number optional
[ Top ]
arrayConvert
string arrayConvert(
Converter
&$c)
[line 497]
converter helper used in PHP 4.3.0+
Tags:
- usedby - parserSourceInlineTag::Convert() - in PHP 4.3.0+, this method is used to convert
- uses - phpDocumentor_HighlightParser - Parses the tokenized source
Overridden in child classes as:
- parserExampleInlineTag::arrayConvert()
- converter helper for PHP 4.3.0+
Parameters:
- Converter &$c - the output converter object
[ Top ]
Convert
string Convert(
Converter
&$c)
[line 481]
convert the tag
Tags:
- todo - CS cleanup - rename to convert for camelCase rule
- uses - parserSourceInlineTag::stringConvert() - in PHP 4.2.3-, this method is used to convert
- uses - parserSourceInlineTag::arrayConvert() - in PHP 4.3.0+, this method is used to convert
Parameters:
- Converter &$c - the output converter object
[ Top ]
getString
string getString(
)
[line 444]
gets the source string
Overrides parserInlineTag::getString() (always gets an empty string)
Parameters:
[ Top ]
setSource
void setSource(
string|array
$source, [string|bool
$class = false])
[line 459]
sets the source tag's value
Overridden in child classes as:
- parserExampleInlineTag::setSource()
- sets the source
Parameters:
- string|array $source - source code
- string|bool $class - class name if this is a method, boolean in php 4.3.0, if this is a method this will be true
[ Top ]
stringConvert
string stringConvert(
Converter
&$c)
[line 520]
converter helper used in PHP 4.2.3-
Tags:
- deprecated - in favor of PHP 4.3.0+ arrayConvert()
- usedby - parserSourceInlineTag::Convert() - in PHP 4.2.3-, this method is used to convert
- uses - Converter::unmangle() - remove the extraneous stuff from http://www.php.net/highlight_string
Parameters:
- Converter &$c - the output converter object
[ Top ]
Strlen
int Strlen(
)
[line 434]
only used to determine blank lines. {@source} will not be blank, probably
Overrides parserInlineTag::Strlen() (get length of the tag)
Parameters:
[ Top ]