Class: parserExampleTag

Source Location: /PhpDocumentor-1.4.0RC1/phpDocumentor/DocBlockTags.inc

Class Overview

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

represents "@example"

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $

Variables

$keyword

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()
parserFileSourceTag::getSourceLink()
parserFileSourceTag::writeSource()

Class: parserTag

parserTag::parserTag(): Set up the tag
parserTag::Convert()
parserTag::getString()
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
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()
parserBase::getValue()
parserBase::setValue()

Class Details

[line 878]
represents "@example"

The example tag

Tutorial: @example
Author: Greg Beaver <cellog@php.net>
Version: $Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $

[ Top ]

Class Variables

$keyword = 'example'

[line 884]

always "example"

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserExampleTag (Constructor) [line 895]

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.

Uses: phpDocumentorTWordParser::getFileSource() - uses to parse an example and retrieve all tokens by line number

Parameters:

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

[ Top ]

ConvertSource [line 1042]

void ConvertSource(
Converter
&$c)

Uses: parserFileSourceTag::writeSource()
Uses: phpDocumentor_HighlightParser - highlights source code

Overrides parserFileSourceTag::ConvertSource() (parent method not documented)

Parameters:

Converter &$c —

[ Top ]

getSourceLink [line 1071]

void getSourceLink(
Converter
&$c)

Retrieve a converter-specific link to the example

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

Overrides parserFileSourceTag::getSourceLink() (parent method not documented)

Parameters:

Converter &$c —

[ Top ]