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 377]

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag

Author(s):

Gregory Beaver <[email protected]>

API Tags:

See:

parserStringWithInlineTags

Information Tags:

Tutorial:	inline {@source}
Version:	Release: @VER@
Copyright:	2002-2008 Gregory Beaver
Link:	http://www.phpdoc.org
Link:	http://pear.php.net/PhpDocumentor
Todo:	CS cleanup - change classname to PhpDocumentor_*
Todo:	CS cleanup - change package to PhpDocumentor
License:	LGPL

Properties

Methods

[ Top ]

Descendants

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

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

sets up the tag

parserInlineTag::getString()

always gets an empty string

parserInlineTag::Strlen()

get length of the tag

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ 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()	constructor
string	arrayConvert()	converter helper used in PHP 4.3.0+
string	Convert()	convert the tag
string	getString()	gets the source string
void	setSource()	sets the source tag's value
string	stringConvert()	converter helper used in PHP 4.2.3-
int	Strlen()	only used to determine blank lines. {@source} will not be blank, probably

[ Top ]

Properties

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

Last line to display

[ Top ]

string $inlinetype = 'source' [line 383]

always 'source'

Redefinition of:

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

[ Top ]

string|array $source = false [line 401]

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

{@source} tag used a string

[ Top ]

integer $start = 1 [line 389]

First line of source code to display

API Tags:

See:

parserSourceInlineTag::$end

[ Top ]

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 ]

arrayConvert [line 497]

string arrayConvert(
Converter
&$c 
)

converter helper used in PHP 4.3.0+

Parameters:

Converter

&$c:

the output converter object

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() : converter helper for PHP 4.3.0+

[ Top ]

Convert [line 481]

string Convert(
Converter
&$c 
)

convert the tag

Parameters:

Converter

&$c:

the output converter object

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

Information Tags:

Todo:

CS cleanup - rename to convert for camelCase rule

[ Top ]

getString [line 444]

string getString(
)

gets the source string

Redefinition of:

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

[ Top ]

setSource [line 459]

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

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

Redefined in descendants as:

parserExampleInlineTag::setSource() : sets the source

[ Top ]

stringConvert [line 520]

string stringConvert(
Converter
&$c 
)

converter helper used in PHP 4.2.3-

Parameters:

Converter

&$c:

the output converter object

API 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

[ Top ]

Strlen [line 434]

int Strlen(
)

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

Redefinition of:

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

[ Top ]

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

	phpDocumentor InlineTags

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