Class: parserExampleInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class parserExampleInlineTag

Class Overview

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

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

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag
         |
         --parserExampleInlineTag

Author(s):

Gregory Beaver <[email protected]>

API Tags:

See:

parserStringWithInlineTags

Information Tags:

Tutorial:	inline {@example}
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

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserSourceInlineTag

parserSourceInlineTag::$end

parserSourceInlineTag::$inlinetype

parserSourceInlineTag::$source

parserSourceInlineTag::$start

Inherited From parserInlineTag

parserInlineTag::$type

Inherited From parserBase

parserBase::$value

Inherited From parserSourceInlineTag

parserSourceInlineTag::parserSourceInlineTag()

constructor

parserSourceInlineTag::arrayConvert()

converter helper used in PHP 4.3.0+

parserSourceInlineTag::Convert()

convert the tag

parserSourceInlineTag::getString()

gets the source string

parserSourceInlineTag::setSource()

sets the source tag's value

parserSourceInlineTag::stringConvert()

converter helper used in PHP 4.2.3-

parserSourceInlineTag::Strlen()

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

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 ]

Method Summary

mixed	parserExampleInlineTag()	constructor
string	arrayConvert()	converter helper for PHP 4.3.0+
string	getProgramListing()	Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial
void	setSource()	sets the source

[ Top ]

Properties

Methods

Constructor parserExampleInlineTag [line 582]

mixed parserExampleInlineTag(
string
$value, string
$current_path, [bool
$isTutorial = false] 
)

constructor

Parameters:

string	$value:	format "filepath[ start [end]]" where start and end are line numbers with the end line number optional
string	$current_path:	full path to the current file, used to check relative directory locations
bool	$isTutorial:	if true, then this is in a tutorial

Information Tags:

Todo:

replace tokenizer_ext constant with TOKENIZER_EXT for CS rule

[ Top ]

arrayConvert [line 733]

string arrayConvert(
Converter
&$c 
)

converter helper for PHP 4.3.0+

Parameters:

Converter

&$c:

output converter

API Tags:

Uses:

phpDocumentor_HighlightParser - Parses the tokenized source

Redefinition of:

parserSourceInlineTag::arrayConvert(): converter helper used in PHP 4.3.0+

[ Top ]

getProgramListing [line 752]

string getProgramListing(
)

Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial

[ Top ]

setSource [line 719]

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

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

Redefinition of:

parserSourceInlineTag::setSource(): sets the source tag's value

[ Top ]

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

	phpDocumentor InlineTags

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