Docs For Class parserSourceInlineTag

Description

represents inline source tag, used for function/method source

tutorial: inline {@source}
author: Gregory Beaver <[email protected]>
version: Release: @VER@
copyright: 2002-2008 Gregory Beaver
see: parserStringWithInlineTags
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

Located in /phpDocumentor/InlineTags.inc (line 377)

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag

Direct descendents

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

Variable Summary

'*'|integer $end

string $inlinetype

string|array $source

integer $start

Method Summary

parserSourceInlineTag parserSourceInlineTag (string $value)

string arrayConvert (Converter &$c)

string Convert (Converter &$c)

string getString ()

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

string stringConvert (Converter &$c)

int Strlen ()

Variables

'*'|integer $end = '*' (line 395)

Last line to display

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

string $inlinetype = 'source' (line 383)

always 'source'

Redefinition of:

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

string|array $source = false (line 401)

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

{@source} tag used a string

integer $start = 1 (line 389)

First line of source code to display

see: parserSourceInlineTag::$end

Inherited Variables

Inherited from parserInlineTag

parserInlineTag::$type

Inherited from parserBase

parserBase::$value

Methods

Constructor parserSourceInlineTag (line 414)

constructor

parserSourceInlineTag parserSourceInlineTag (string $value)

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

arrayConvert (line 497)

converter helper used in PHP 4.3.0+

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

string arrayConvert (Converter &$c)

Converter &$c: the output converter object

Redefined in descendants as:

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

Convert (line 481)

convert the tag

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

string Convert (Converter &$c)

Converter &$c: the output converter object

getString (line 444)

gets the source string

string getString ()

Redefinition of:

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

setSource (line 459)

sets the source tag's value

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

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

stringConvert (line 520)

converter helper used in PHP 4.2.3-

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

string stringConvert (Converter &$c)

Converter &$c: the output converter object

Strlen (line 434)

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

int Strlen ()

Redefinition of:

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

Inherited Methods

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()
parserInlineTag::getString()
parserInlineTag::Strlen()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()