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

Class: parserPackagePage

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserPackagePage



Author(s):

Version:

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

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Child classes:

Inherited Variables

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

[line 2027]


Tags:

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


[ Top ]


Class Variables

$package =  'default'

[line 2035]


Type:   string


[ 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


constructor parserPackagePage [line 2040]

parserPackagePage parserPackagePage( string $package)



Parameters:

string   $package  

[ Top ]

method Convert [line 2048]

void Convert( Converter &$c)



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:

Converter   &$c  

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:14:35 -0600 by phpDocumentor 1.4.4