phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: parserSourceInlineTag

Source Location: /PhpDocumentor-1.4.0RC2/phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag

represents inline source tag, used for function/method source


Author(s):

Version:

  • $Revision: 1.7 $

Variables

Methods


Child classes:

parserExampleInlineTag
Represents the example inline tag, used to display an example file

Inherited Variables

Inherited Methods


Class Details

[line 331]
represents inline source tag, used for function/method source


[ Top ]


Class Variables

$end =  '*'

[line 349]

Last line to display
  • Var: If '*' then the whole source will be used, otherwise the $start to $end line numbers will be displayed

Type:   '*'|integer


[ Top ]

$inlinetype =  'source'

[line 337]

always 'source'

Type:   string
Overrides:   Array


[ Top ]

$source =  false

[line 355]

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

{@source} tag used a string


Type:   string|array


[ Top ]

$start =  1

[line 343]

First line of source code to display

Type:   integer


[ Top ]



Method Detail

parserSourceInlineTag (Constructor)   [line 364]

parserSourceInlineTag parserSourceInlineTag( string $value)


Parameters:

string   $value   —  format "start [end]" where start and end are line numbers with the end line number optional

[ Top ]

arrayConvert   [line 430]

void arrayConvert( Converter &$c)


Overridden in child classes as:

parserExampleInlineTag::arrayConvert()

Parameters:

Converter   &$c   — 

[ Top ]

Convert   [line 420]

void Convert( Converter &$c)


Parameters:

Converter   &$c   — 

[ Top ]

getString   [line 391]

void getString( )


Overrides parserInlineTag::getString() (parent method not documented)
[ Top ]

setSource   [line 401]

void setSource( string|array $source, [boolean $class = false], string 2)


Overridden in child classes as:

parserExampleInlineTag::setSource()

Parameters:

string   2   —  class name if this is a method
string|array   $source   —  source code
boolean   $class   —  in php 4.3.0, if this is a method this will be true

[ Top ]

stringConvert   [line 448]

void stringConvert( Converter &$c)


Parameters:

Converter   &$c   — 

[ Top ]

Strlen   [line 386]

void Strlen( )

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

probably


Overrides parserInlineTag::Strlen() (parent method not documented)
[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:07:22 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.