Description
parserBase | --parserInlineTag | --parserSourceInlineTag
Located in File: /phpDocumentor/InlineTags.inc
represents inline source tag, used for function/method source
- 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
Classes extended from parserSourceInlineTag:
- parserExampleInlineTag
- Represents the example inline tag, used to display an example file inside a docblock or tutorial
Class Variables
Summary:
'*'|integer
$end
string
$inlinetype
string|array
$source
integer
$start
$end = '*' (line 395)
Data type : '*'|integer
Last line to display
- var: - If '*' then the whole source will be used, otherwise the $start to $end line numbers will be displayed
$source = false (line 401)
Data type : string|array
tokenized source organized by line numbers for php 4.3.0+, the old
{@source} tag used a string
$start = 1 (line 389)
Data type : integer
First line of source code to display
- see: - parserSourceInlineTag::$end
Class Constants
Summary:Method Detail
Summary:
Constructor parserSourceInlineTag (line 414)
parserSourceInlineTag parserSourceInlineTag( string $value)
constructor
Parameters
- string $value: format "start [end]", where start and end are line numbers with the end line number optional
Info
Method arrayConvert (line 497)
string arrayConvert( Converter &$c)
Overridden in child classes as:
- parserExampleInlineTag::arrayConvert()
- converter helper for PHP 4.3.0+
converter helper used in PHP 4.3.0+
Parameters
- Converter &$c: the output converter object
Info
- usedby - parserSourceInlineTag::Convert() - in PHP 4.3.0+, this method is used to convert
- uses - phpDocumentor_HighlightParser - Parses the tokenized source
Method Convert (line 481)
string Convert( Converter &$c)
convert the tag
Parameters
- Converter &$c: the output converter object
Info
- 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
Method getString (line 444)
string getString( )
Overrides : parserInlineTag::getString() always gets an empty string
gets the source string
Info
Method setSource (line 459)
void setSource( string|array $source, [string|bool $class = false])
Overridden in child classes as:
- parserExampleInlineTag::setSource()
- sets the source
sets the source tag's value
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
Info
Method stringConvert (line 520)
string stringConvert( Converter &$c)
converter helper used in PHP 4.2.3-
Parameters
- Converter &$c: the output converter object
Info
- 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
Method Strlen (line 434)
int Strlen( )
Overrides : parserInlineTag::Strlen() get length of the tag