Class: parserSourceInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview [line 377]

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag

Variables

Constants

Methods


Child classes:

parserExampleInlineTag
Represents the example inline tag, used to display an example file inside a docblock or tutorial

Inherited Variables

Inherited Constants

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:

[ 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'

[line 383]

always 'source'

Type: string

Overrides: Array

[ Top ]

$source =  false

[line 401]

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

[email protected]} tag used a string

Type: string|array

Overrides:

[ Top ]

$start =  1

[line 389]

First line of source code to display

Tags:

Type: integer

Overrides:

[ 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:

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:

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:

Parameters:

  • Converter &$c - the output converter object

[ Top ]

Strlen

int Strlen( )

[line 434]

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

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

Parameters:

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:07:37 -0600 by phpDocumentor 1.4.4