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

Class: parserSourceInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag

represents inline source tag, used for function/method source


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Child classes:

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

Inherited Variables

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



[ 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


[ 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


[ Top ]

$start =  1

[line 389]

First line of source code to display



Tags:


Type:   integer


[ Top ]



Class Methods


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

[ Top ]

method arrayConvert [line 497]

string arrayConvert( Converter &$c)

converter helper used in PHP 4.3.0+



Tags:

usedby:  parserSourceInlineTag::Convert() - in PHP 4.3.0+, this method is used to convert
uses:  phpDocumentor_HighlightParser - Parses the tokenized source


Overridden in child classes as:

parserExampleInlineTag::arrayConvert()
converter helper for PHP 4.3.0+

Parameters:

Converter   &$c   the output converter object

[ Top ]

method Convert [line 481]

string Convert( Converter &$c)

convert the tag



Tags:

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


Parameters:

Converter   &$c   the output converter object

[ Top ]

method getString [line 444]

string getString( )

gets the source string



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

[ Top ]

method setSource [line 459]

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

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 ]

method stringConvert [line 520]

string stringConvert( Converter &$c)

converter helper used in PHP 4.2.3-



Tags:

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


Parameters:

Converter   &$c   the output converter object

[ Top ]

method Strlen [line 434]

int Strlen( )

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



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

[ Top ]


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