Class: CodeGen_PECL_Element_Method

Source Location: /CodeGen_PECL-0.9.0rc5/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 Hartmut Holzgraefe

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::$name
CodeGen_PECL_Element_Function::$optional
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::$testIni
CodeGen_PECL_Element_Function::$testResult
CodeGen_PECL_Element_Function::$testSkipIf
CodeGen_PECL_Element_Function::$varargs

Inherited Methods

Class: CodeGen_PECL_Element_Function

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::defaultval(): Helper for cCode
CodeGen_PECL_Element_Function::docEntry(): Create DocBook reference entry for the function
CodeGen_PECL_Element_Function::getCode(): Code getter
CodeGen_PECL_Element_Function::getName(): name getter
CodeGen_PECL_Element_Function::getRole()
CodeGen_PECL_Element_Function::getTestCode(): testCode 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::isInternalName(): Check whether a function name is already used internally
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::setRole(): role setter
CodeGen_PECL_Element_Function::setSummary(): summary getter
CodeGen_PECL_Element_Function::setTestCode(): testCode 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::writeTest(): Create test case for this function

Class: CodeGen_PECL_Element

CodeGen_PECL_Element::cCodeEditorSettings(): Generate Editor settings block for C source files
CodeGen_PECL_Element::docEditorSettings(): Generate Editor settings block for documentation files
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 Hartmut Holzgraefe
Link: http://pear.php.net/package/CodeGen
License: PHP License 3.0

[ Top ]

Method Detail

__construct (Constructor) [line 43]

CodeGen_PECL_Element_Method __construct(

$classname)

Parameters:

$classname —

[ Top ]

argInfoCode [line 155]

string argInfoCode(
)

Code needed ahead of the method table

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

[ Top ]

cProto [line 231]

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 ]

getProceduralName [line 63]

void getProceduralName(
)

[ Top ]

isAbstract [line 86]

void isAbstract(
)

[ Top ]

isFinal [line 110]

void isFinal(
)

[ Top ]

isInterface [line 98]

void isInterface(
)

[ Top ]

isStatic [line 122]

void isStatic(
)

[ Top ]

methodEntry [line 204]

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 169]

void parseParameterHook(
string
$argc, string
$argString, array
$argPointers)

Hook for parameter parsing API function

Access: protected

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

Parameters:

string	`$argc`	—	C expr. for number of arguments
string	`$argString`	—	Argument string
array	`$argPointers`	—	Argument variable pointers

[ Top ]

setAccess [line 134]

void setAccess(

$access)

Parameters:

$access —

[ Top ]

setProceduralName [line 68]

void setProceduralName(

$name)

Parameters:

$name —

[ Top ]

setProto [line 187]

bool setProto(
string
$proto)

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

[ Top ]