Class parserSourceInlineTag

Description

represents inline source tag, used for function/method source

Located in /phpDocumentor/InlineTags.inc (line 377)

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag
Direct descendents
Class Description
parserExampleInlineTag Represents the example inline tag, used to display an example file inside a docblock or tutorial
Variable Summary
'*'|integer $end
string $inlinetype
string|array $source
integer $start
Method Summary
parserSourceInlineTag parserSourceInlineTag (string $value)
string arrayConvert (Converter &$c)
string Convert (Converter &$c)
string getString ()
void setSource (string|array $source, [string|bool $class = false])
string stringConvert (Converter &$c)
int Strlen ()
Variables
'*'|integer $end = '*' (line 395)

Last line to display

  • var: If '*' then the whole source will be used, otherwise the $start to $end line numbers will be displayed
string $inlinetype = 'source' (line 383)

always 'source'


Redefinition of:
parserInlineTag::$inlinetype
the name of the inline tag (like link)
string|array $source = false (line 401)

tokenized source organized by line numbers for php 4.3.0+, the old

[email protected]} tag used a string

integer $start = 1 (line 389)

First line of source code to display

Inherited Variables

Inherited from parserInlineTag

parserInlineTag::$type

Inherited from parserBase

parserBase::$value
Methods
Constructor parserSourceInlineTag (line 414)

constructor

parserSourceInlineTag parserSourceInlineTag (string $value)
  • string $value: format "start [end]", where start and end are line numbers with the end line number optional
arrayConvert (line 497)

converter helper used in PHP 4.3.0+

string arrayConvert (Converter &$c)

Redefined in descendants as:
Convert (line 481)

convert the tag

string Convert (Converter &$c)
getString (line 444)

gets the source string

string getString ()

Redefinition of:
parserInlineTag::getString()
always gets an empty string
setSource (line 459)

sets the source tag's value

void setSource (string|array $source, [string|bool $class = false])
  • 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

Redefined in descendants as:
stringConvert (line 520)

converter helper used in PHP 4.2.3-

string stringConvert (Converter &$c)
Strlen (line 434)

only used to determine blank lines. [email protected]} will not be blank, probably

int Strlen ()

Redefinition of:
parserInlineTag::Strlen()
get length of the tag

Inherited Methods

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()
parserInlineTag::getString()
parserInlineTag::Strlen()

Inherited From parserBase

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

Documentation generated on Mon, 05 Dec 2011 21:16:55 -0600 by phpDocumentor 1.4.4