Docs For Class parserPackagePage

Description

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserPackagePage

author: - Greg Beaver <[email protected]>
version: - $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
copyright: - 2002-2008 Gregory Beaver
since: - 1.0rc1

Classes extended from parserPackagePage:

parserTutorial

Class Variables

Summary:

string $package

string $type

Overrides: Array

var: - always 'packagepage'

Class Constants

Summary:

Method Detail

Summary:

parserPackagePage parserPackagePage (string $package)

void Convert (Converter &$c)

string $package:

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

Converter &$c:

Inherited Variables

Inherited Methods

Class parserPackagePage

Description

Class Variables

Class Constants

Method Detail

Inherited Variables

Inherited Methods

Class parserPackagePage

Description

Class Variables

$package = 'default' (line 2035)

Data type : string

$type = 'packagepage' (line 2033)

Data type : string

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

Class Constants

Method Detail

Constructor parserPackagePage (line 2040)

parserPackagePage parserPackagePage( string $package)

Parameters

Info

Method Convert (line 2048)

void Convert( Converter &$c)

Parameters

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

Inherited From 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))

Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value