Class: parserSourceTag

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/DocBlockTags.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserSourceTag

represents "@source"

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: DocBlockTags.inc,v 1.3 2003/01/18 07:25:19 CelloG Exp $

Variables

Methods

Child classes:

parserFileSourceTag: represents "@filesource"

parserExampleTag: represents "@example"

Inherited Variables

Inherited Methods

Class: parserTag

parserTag::parserTag()
parserTag::Convert()
parserTag::getString()
parserTag::HandleEvent()

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
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen(): equivalent to trim(strlen($string))

Class: parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setLineNum()
parserBase::setValue()

Class Details

[line 459]
represents "@source"

The @source tag is unimplemented and may not be implemented

Version: $Id: DocBlockTags.inc,v 1.3 2003/01/18 07:25:19 CelloG Exp $
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>
Todo: implement support in PDF Converter
Tutorial: @example

[ Top ]

Class Variables

$keyword = 'source'

[line 461]

Type:	mixed
Overrides:	Array

[ Top ]

$path =

[line 463]

Type:

mixed

[ Top ]

$source =

[line 462]

Type:

mixed

[ Top ]

$writesource = 'writeSourceFragment'

[line 464]

Type:

mixed

[ Top ]

Method Detail

parserSourceTag (Constructor) [line 465]

parserSourceTag parserSourceTag(
mixed
$filepath, mixed
$value)

[ Top ]

Convert [line 471]

void Convert(
mixed
&$c)

Overrides parserTag::Convert() (parent method not documented)

[ Top ]

ConvertSource [line 485]

void ConvertSource(
mixed
&$c)

Todo: find and link to documentation of file source

[ Top ]

getSourceLink [line 477]

void getSourceLink(
mixed
&$c)

Overridden in child classes as:

parserFileSourceTag::getSourceLink()

parserExampleTag::getSourceLink()

[ Top ]

writeSource [line 507]

void writeSource(
mixed
&$c, mixed
$source)

Overridden in child classes as:

parserFileSourceTag::writeSource()

parserExampleTag::writeSource()

[ Top ]