Class: parserPackagePage

Source Location: /phpDocumentor/ParserElements.inc

Class Overview [line 2027]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserPackagePage

Author(s):

Version:

  • $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods


Child classes:

parserTutorial

Inherited Variables

Inherited Constants

Inherited Methods

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

Tags:

[ Top ]


Class Variables

$package =  'default'

[line 2035]

Type: string

Overrides:

[ Top ]

$type =  'packagepage'

[line 2033]

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

Tags:

  • var - always 'packagepage'

Type: string

Overrides: Array

[ Top ]


Class Methods

parserPackagePage

parserPackagePage parserPackagePage( string $package)

[line 2040]

Parameters:

  • string $package -

[ Top ]

Convert

void Convert( Converter &$c)

[line 2048]

Overridden in child classes as:

parserTutorial::Convert()

Overrides parserStringWithInlineTags::Convert() (Use to convert the string to a real string with all inline tags parsed and linked)

Parameters:

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:23 -0600 by phpDocumentor 1.4.4