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

Class: parserPackagePage

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserPackagePage



Author(s):

Version:

  • $Id$

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 2038]
  • Author: Greg Beaver <cellog@php.net>
  • Version: $Id$
  • Copyright: 2002-2008 Gregory Beaver
  • Since: 1.0rc1


[ Top ]


Class Variables

$package =  'default'

[line 2046]


Type:   string


[ Top ]

$type =  'packagepage'

[line 2044]

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

Type:   string
Overrides:   Array


[ Top ]



Method Detail

parserPackagePage (Constructor)   [line 2051]

parserPackagePage parserPackagePage( string $package)


Parameters:

string   $package     

[ Top ]

Convert   [line 2059]

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 Sun, 02 Sep 2012 00:02:41 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.