Class parserSourceInlineTag

(line 377)

Description

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag

Located in File: /phpDocumentor/InlineTags.inc

represents inline source tag, used for function/method source


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

$inlinetype = 'source' (line 383)

Data type : string

Overrides: Array

always 'source'

$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

Class Constants

Summary:

Method Detail

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

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

Info

Method Convert (line 481)

string Convert( Converter &$c)

convert the tag

Parameters

Info

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

Info

Method Strlen (line 434)

int Strlen( )

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

only used to determine blank lines. {@source} will not be blank, probably

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserInlineTag

parserInlineTag::$type - Element type

Inherited From Class parserBase

parserBase::$value - set to different things by its descendants

Inherited Methods

Inherited Method Summary

Inherited From Class parserInlineTag

parserInlineTag::parserInlineTag() - sets up the tag

parserInlineTag::getString() - always gets an empty string

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


Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value



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