Class: CodeGen_PECL_Element_Method

Source Location: /CodeGen_PECL-1.1.3/PECL/Element/Method.php

Class Overview

CodeGen_Element
   |
   --CodeGen_PECL_Element
      |
      --CodeGen_PECL_Element_Function
         |
         --CodeGen_PECL_Element_Method

Class that describes a member function within a PHP class

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005-2008 Hartmut Holzgraefe

Variables

Methods

Inherited Variables

Class: CodeGen_PECL_Element_Function

CodeGen_PECL_Element_Function::$code
CodeGen_PECL_Element_Function::$codeFile
CodeGen_PECL_Element_Function::$codeLine
CodeGen_PECL_Element_Function::$description
CodeGen_PECL_Element_Function::$hasRefArgs
CodeGen_PECL_Element_Function::$name
CodeGen_PECL_Element_Function::$params
CodeGen_PECL_Element_Function::$proto
CodeGen_PECL_Element_Function::$returns
CodeGen_PECL_Element_Function::$role
CodeGen_PECL_Element_Function::$summary
CodeGen_PECL_Element_Function::$testCode
CodeGen_PECL_Element_Function::$testDescription
CodeGen_PECL_Element_Function::$testIni
CodeGen_PECL_Element_Function::$testResult
CodeGen_PECL_Element_Function::$testSkipIf
CodeGen_PECL_Element_Function::$varargs
CodeGen_PECL_Element_Function::$varargsType

Inherited Methods

Class: CodeGen_PECL_Element_Function

CodeGen_PECL_Element_Function::addParam()
CodeGen_PECL_Element_Function::argInfoCode(): Code needed ahead of the function table
CodeGen_PECL_Element_Function::argInfoName(): Name for ARG_INFO definition
CodeGen_PECL_Element_Function::cCode(): Create C code implementing the PHP userlevel function
CodeGen_PECL_Element_Function::cProto(): C function signature
CodeGen_PECL_Element_Function::createTest(): Create test case for this function
CodeGen_PECL_Element_Function::defaultval(): Helper for cCode
CodeGen_PECL_Element_Function::docEntry(): Create DocBook reference entry for the function
CodeGen_PECL_Element_Function::functionEntry(): Generate registration entry for extension function table
CodeGen_PECL_Element_Function::getCode(): Code getter
CodeGen_PECL_Element_Function::getFullName(): distinguishable name getter
CodeGen_PECL_Element_Function::getName(): name getter
CodeGen_PECL_Element_Function::getRole()
CodeGen_PECL_Element_Function::getTestCode(): testCode getter
CodeGen_PECL_Element_Function::getTestDescription(): testDescription getter
CodeGen_PECL_Element_Function::getTestIni(): testIni getter
CodeGen_PECL_Element_Function::getTestResult(): testResult getter
CodeGen_PECL_Element_Function::getTestSkipIf(): testSkipIf getter
CodeGen_PECL_Element_Function::getVarargs()
CodeGen_PECL_Element_Function::hCode(): Create C header entry for userlevel function
CodeGen_PECL_Element_Function::ifConditionEnd()
CodeGen_PECL_Element_Function::ifConditionStart()
CodeGen_PECL_Element_Function::isInternalName(): Check whether a function name is already used internally
CodeGen_PECL_Element_Function::localVariables(): Generate local variable declarations
CodeGen_PECL_Element_Function::minPhpVersion(): Return minimal PHP version required to support the requested features
CodeGen_PECL_Element_Function::newSetProto(): Set parameter and return value information from PHP style prototype
CodeGen_PECL_Element_Function::newSetProto2(): Set parameter and return value information from PHP style prototype
CodeGen_PECL_Element_Function::oldSetProto()
CodeGen_PECL_Element_Function::parseParameterHook(): Hook for parameter parsing API function
CodeGen_PECL_Element_Function::setCode(): Code setter
CodeGen_PECL_Element_Function::setDescription(): description setter
CodeGen_PECL_Element_Function::setName(): name setter
CodeGen_PECL_Element_Function::setProto(): Set parameter and return value information from PHP style prototype
CodeGen_PECL_Element_Function::setReturns()
CodeGen_PECL_Element_Function::setRole(): role setter
CodeGen_PECL_Element_Function::setSummary(): summary getter
CodeGen_PECL_Element_Function::setTestCode(): testCode setter
CodeGen_PECL_Element_Function::setTestDescription(): testDescritpion setter
CodeGen_PECL_Element_Function::setTestIni(): testIni setter
CodeGen_PECL_Element_Function::setTestResult(): testResult setter
CodeGen_PECL_Element_Function::setTestSkipIf(): testSkipIf setter
CodeGen_PECL_Element_Function::setVarargs()
CodeGen_PECL_Element_Function::setVarargsType()
CodeGen_PECL_Element_Function::writeTest(): write test case for this function

Class: CodeGen_PECL_Element

CodeGen_PECL_Element::isKeyword(): Checks whether a string is a reserved name
CodeGen_PECL_Element::isType(): Checks whether a string is a valid PHP type name and returns the official name

Class Details

[line 40]
Class that describes a member function within a PHP class

Author: Hartmut Holzgraefe <hartmut@php.net>
Version: Release: @package_version@
Copyright: 2005-2008 Hartmut Holzgraefe
Link: http://pear.php.net/package/CodeGen
License: PHP License 3.0

[ Top ]

Class Variables

$access = "public"

[line 162]

Visibility of this property

Access: protected

Type:

string

[ Top ]

$class =

[line 54]

The class this method belongs to

Access: protected

Type:

object

[ Top ]

$classname =

[line 61]

Name of class this method belongs to

Access: protected

Type:

string

[ Top ]

$isAbstract = false

[line 105]

Is this an abstract method?

Access: protected

Type:

bool

[ Top ]

$isFinal = false

[line 134]

Is this a final method?

Access: protected

Type:

bool

[ Top ]

$isInterface = false

[line 119]

Is this an interface method?

Access: protected

Type:

bool

[ Top ]

$isStatic = false

[line 148]

Is this a static method?

Access: protected

Type:

bool

[ Top ]

$proceduralName = ""

[line 70]

Name for procedural alias of this method

Access: protected

Type:

string

[ Top ]

Method Detail

__construct (Constructor) [line 43]

CodeGen_PECL_Element_Method __construct(
Codegen_PECL_Element_ObjectInterface
$class)

Parameters:

Codegen_PECL_Element_ObjectInterface $class —

[ Top ]

argInfoCode [line 455]

string argInfoCode(
array
$params)

Code needed ahead of the method table

Abstract/Interface methods need to define their argument list ahead of the method table

Overrides CodeGen_PECL_Element_Function::argInfoCode() (Code needed ahead of the function table)

Parameters:

array $params —

[ Top ]

argInfoName [line 466]

string argInfoName(
)

Name for ARG_INFO definition

Overrides CodeGen_PECL_Element_Function::argInfoName() (Name for ARG_INFO definition)

[ Top ]

cCode [line 345]

string cCode(
class
$extension)

Create C code implementing the PHP userlevel function

Return: C code implementing the function
Access: public

Overrides CodeGen_PECL_Element_Function::cCode() (Create C code implementing the PHP userlevel function)

Parameters:

class $extension — Extension extension the function is part of

[ Top ]

cProto [line 328]

string cProto(
string
0)

Create proto line for method

Return: C code snippet

Overrides CodeGen_PECL_Element_Function::cProto() (C function signature)

Parameters:

string 0 — Name of class owning this method

[ Top ]

createTest [line 432]

object generated createTest(
CodeGen_PECL_Extension
$extension)

Create test case for this function

Return: test case
Access: public

Overrides CodeGen_PECL_Element_Function::createTest() (Create test case for this function)

Parameters:

object extension $extension — the function is part of

[ Top ]

functionAliasEntry [line 313]

string functionAliasEntry(
string
0)

Create registration line for method table

Return: C code snippet

Parameters:

string 0 — Name of class owning this method

[ Top ]

getFullName [line 95]

string getFullName(
)

distinguishable name getter

Overrides CodeGen_PECL_Element_Function::getFullName() (distinguishable name getter)

[ Top ]

getProceduralName [line 72]

void getProceduralName(
)

[ Top ]

isAbstract [line 107]

void isAbstract(
)

[ Top ]

isFinal [line 136]

void isFinal(
)

[ Top ]

isInterface [line 121]

void isInterface(
)

[ Top ]

isStatic [line 150]

void isStatic(
)

[ Top ]

localVariables [line 221]

string localVariables(

$extension)

Generate local variable declarations

Return: C code snippet

Overrides CodeGen_PECL_Element_Function::localVariables() (Generate local variable declarations)

Parameters:

$extension —

[ Top ]

methodEntry [line 269]

string methodEntry(
string
0)

Create registration line for method table

Return: C code snippet

Parameters:

string 0 — Name of class owning this method

[ Top ]

parseParameterHook [line 184]

void parseParameterHook(
string
$argString, array
$argPointers, int
&$count)

Hook for parameter parsing API function

Access: protected

Overrides CodeGen_PECL_Element_Function::parseParameterHook() (Hook for parameter parsing API function)

Parameters:

string	`$argString`	—	Argument string
array	`$argPointers`	—	Argument variable pointers
int	`&$count`	—	Return value for number of arguments

[ Top ]

setAccess [line 164]

void setAccess(

$access)

Parameters:

$access —

[ Top ]

setCode [line 394]

void setCode(
string
$code)

Code addition must be validated here

Overrides CodeGen_PECL_Element_Function::setCode() (Code setter)

Parameters:

string $code — code snippet

[ Top ]

setName [line 409]

void setName(
string
$name)

Method name checking is less strict

Method names can't clash with PHP standard functions so we can just check for syntax and keywords here

Overrides CodeGen_PECL_Element_Function::setName() (name setter)

Parameters:

string $name — method name

[ Top ]

setProceduralName [line 77]

void setProceduralName(

$name)

Parameters:

$name —

[ Top ]

setProto [line 245]

bool setProto(
string
$proto, 
$extension)

Set parameter and return value information from PHP style prototype

Return: Success status
Access: public

Overrides CodeGen_PECL_Element_Function::setProto() (Set parameter and return value information from PHP style prototype)

Parameters:

string	`$proto`	—	PHP style prototype
	`$extension`	—

[ Top ]

setRole [line 384]

exception setRole(
string
$role)

The role attribute doesn't apply here

Overrides CodeGen_PECL_Element_Function::setRole() (role setter)

Parameters:

string $role —

[ Top ]

validate [line 359]

true validate(
)

Validate settings, spot conflicts

Return: or exception

[ Top ]