Class: parserSourceInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class parserSourceInlineTag

Class Overview

represents inline source tag, used for function/method source

Located in /phpDocumentor/InlineTags.inc [line 331]

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Revision: 1.6 $
Tutorial:	inline {@source}

Properties

Methods

[ Top ]

Direct descendents

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

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserInlineTag

parserInlineTag::$type

Inherited From parserBase

parserBase::$value

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()

parserInlineTag::getString()

parserInlineTag::Strlen()

Inherited From parserBase

parserBase::getType()

parserBase::getValue()

parserBase::setValue()

[ Top ]

Property Summary

'*'\|integer	$end	Last line to display
string	$inlinetype	always 'source'
string\|array	$source	tokenized source organized by line numbers for php 4.3.0+, the old
integer	$start	First line of source code to display

[ Top ]

Method Summary

parserSourceInlineTag	parserSourceInlineTag()
void	arrayConvert()
void	Convert()
void	getString()
void	setSource()
void	stringConvert()
void	Strlen()	only used to determine blank lines. {@source} will not be blank,

[ Top ]

Properties

'*'|integer $end = '*' [line 349]

Last line to display

[ Top ]

string $inlinetype = 'source' [line 337]

always 'source'

Redefinition of:

parserInlineTag::$inlinetype: the name of the inline tag (like link)

[ Top ]

string|array $source = false [line 355]

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

{@source} tag used a string

[ Top ]

integer $start = 1 [line 343]

First line of source code to display

API Tags:

See:

parserSourceInlineTag::$end

[ Top ]

Methods

Constructor parserSourceInlineTag [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 
)

Parameters:

Converter

&$c:

API Tags:

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

Redefined in descendants as:

parserExampleInlineTag::arrayConvert()

[ Top ]

Convert [line 420]

void Convert(
Converter
&$c 
)

Parameters:

Converter

&$c:

API Tags:

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

[ Top ]

getString [line 391]

void getString(
)

Redefinition of:

parserInlineTag::getString()

[ Top ]

setSource [line 401]

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

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

Redefined in descendants as:

parserExampleInlineTag::setSource()

[ Top ]

stringConvert [line 448]

void stringConvert(
Converter
&$c 
)

Parameters:

Converter

&$c:

API Tags:

Usedby:	parserSourceInlineTag::Convert() - in PHP 4.2.3-, this method is used to convert
Deprecated:	in favor of PHP 4.3.0+ arrayConvert()
Uses:	Converter::unmangle() - remove the extraneous stuff from http://www.php.net/highlight_string

[ Top ]

Strlen [line 386]

void Strlen(
)

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

probably

Redefinition of:

parserInlineTag::Strlen()

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:23:41 -0500 by phpDocumentor 1.3.1

	phpDocumentor InlineTags

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