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

Class: parserExampleTag

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

Class Overview

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

represents "@example"


Author(s):

Version:

  • Release: 1.5.0a1

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 {@source} 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

[line 1180]
represents "@example"


[ Top ]


Class Variables

$keyword =  'example'

[line 1186]

always "example"

Type:   string
Overrides:   Array


[ Top ]



Method Detail

parserExampleTag (Constructor)   [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.

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

ConvertSource   [line 1353]

void ConvertSource( Converter &$c)

convert the source code

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

Parameters:

Converter   &$c     the output converter

[ Top ]

getSourceLink   [line 1389]

string getSourceLink( Converter &$c)

Retrieve a converter-specific link to the example
  • 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 Sun, 02 Sep 2012 00:01:27 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.