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

Class: parserExampleTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserFileSourceTag
            |
            --parserExampleTag

represents "@example"


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods

Class: parserFileSourceTag

parserFileSourceTag::parserFileSourceTag()
Set $source to $value, and set up path
parserFileSourceTag::Convert()
Return a link to the highlighted source and generate the source
parserFileSourceTag::ConvertSource()
convert the source code
parserFileSourceTag::getSourceLink()
gets path to the sourcecode file
parserFileSourceTag::writeSource()
have the output converter write the source code

Class: parserTag

parserTag::parserTag()
Set up the tag
parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
parserTag::getString()
Returns the text minus any inline tags
parserTag::HandleEvent()
Called by the parserDescParser when processing a description.

Class: parserStringWithInlineTags

parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString()
return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
parserStringWithInlineTags::hasInlineTag()
Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource()
Pass source code to any [email protected]} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))

Class: parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

Class Details



[ Top ]


Class Variables

$keyword =  'example'

[line 1186]

always "example"


Type:   string
Overrides:   Array


[ Top ]



Class Methods


constructor parserExampleTag [line 1203]

parserExampleTag parserExampleTag( parserStringWithInlineTags $value, string $current_path)

Reads and parses the example file indicated

The example tag takes one parameter: the full path to a php file that should be parsed and included as an example.




Tags:

todo:  does this "x = y = z = false" still work as expected in PHP5?
todo:  CS cleanup - rename constant to TOKENIZER_EXT
uses:  phpDocumentorTWordParser::getFileSource() - uses to parse an example and retrieve all tokens by line number


Parameters:

parserStringWithInlineTags   $value   tag value
string   $current_path   path of file containing this @example tag

[ Top ]

method ConvertSource [line 1353]

void ConvertSource( Converter &$c)

convert the source code



Tags:

todo:  CS cleanup - rename to convertSource for camelCase rule
todo:  what's up with all the "return" statements? can they _all_ be removed?
uses:  parserFileSourceTag::writeSource()
uses:  phpDocumentor_HighlightParser - highlights source code


Overrides parserFileSourceTag::ConvertSource() (convert the source code)

Parameters:

Converter   &$c   the output converter

[ Top ]

method getSourceLink [line 1389]

string getSourceLink( Converter &$c)

Retrieve a converter-specific link to the example



Tags:

uses:  Converter::getExampleLink() - retrieve the link to the example


Overrides parserFileSourceTag::getSourceLink() (gets path to the sourcecode file)

Parameters:

Converter   &$c   the output converter

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:11:57 -0600 by phpDocumentor 1.4.4