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

Class: parserExampleInlineTag

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/InlineTags.inc

Class Overview

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

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


Author(s):

Version:

  • Release: 1.5.0a1

Copyright:

  • 2002-2008 Gregory Beaver

Methods


Inherited Variables

Inherited Methods

Class: 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

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

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


[ Top ]


Method Detail

parserExampleInlineTag (Constructor)   [line 582]

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

constructor
  • Todo: replace tokenizer_ext constant with TOKENIZER_EXT for CS rule

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

[ Top ]

arrayConvert   [line 733]

string arrayConvert( Converter &$c)

converter helper for PHP 4.3.0+

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

Parameters:

Converter   &$c     output converter

[ 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

Overrides parserSourceInlineTag::setSource() (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

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:01:59 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.