Description
parserBase
|
--parserElement
|
--parserFunction
|
--parserMethod
Located in File: /phpDocumentor/ParserElements.inc
- 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
Method Detail
Summary:
void
addParam
(
string $name,
string $value, [
boolean $has_default =
true], [
null|string $typehint =
null])
Constructor parserMethod (line 1646)
parserMethod parserMethod(
string
$class)
Parameters
Info
Method addParam (line 1657)
void addParam(
string
$name, string
$value, [boolean
$has_default = true], [null|string
$typehint = null])
Overrides : parserFunction::addParam() parent method not documented
Parameters
- string $name:
- string $value: default value parsed from function definition
- boolean $has_default: indicates whether this parameter has a default value
- null|string $typehint: class type hint
Info
Method getClass (line 1690)
string getClass(
)
Return name of the class that contains this method
Info
Method getFunctionCall (line 1671)
string getFunctionCall(
)
Overrides : parserFunction::getFunctionCall() Get a human-friendly description of the function call
adds "constructor " to start of function call if $isConstructor is true
Info
Method getImplements (line 1805)
mixed getImplements(
Converter
&$c)
Parameters
Info
Method getIntricateFunctionCall (line 1678)
void getIntricateFunctionCall(
$converter,
$paramtags)
Overrides : parserFunction::getIntricateFunctionCall() Like getFunctionCall(), but has no English or pre-determined formatting.
Parameters
Info
Method getLink (line 1915)
mixed getLink(
Converter
$c, [string
$text = false], [
$returnobj = false])
Overrides : parserFunction::getLink() quick way to link to this element
quick way to link to this element
Parameters
- Converter $c:
- string $text: text to display for the link or false for default text
- $returnobj:
Info
- return - converter-specific link to this method
Method getModifiers (line 1699)
string getModifiers(
)
Return name of the class that contains this method
Info
Method getOverrides (line 1718)
mixed getOverrides(
Converter
&$c)
Parameters
Info
- return - parserMethod representing method this method overrides from the parent class, or false if none
Method getOverridingMethods (line 1944)
array getOverridingMethods(
Converter
&$c)
Parameters
Info
Method getOverridingMethodsForClass (line 1956)
array getOverridingMethodsForClass(
Converter
&$c, parserClass
&$class)
Parameters
Info
- return - an array of parserMethods from ALL child classes that override this method in the given class
Method setConstructor (line 1927)
void setConstructor(
)
Use this method to tell the parser that this method is the class constructor
Info
Method setDestructor (line 1935)
void setDestructor(
)
Use this method to tell the parser that this method is the class constructor
Info
Method setModifiers (line 1708)
string setModifiers(
$m)
Return name of the class that contains this method
Parameters
Info