Class: CodeGen_PECL_Element_Class

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

Class Overview

CodeGen_Element
   |
   --CodeGen_PECL_Element
      |
      --CodeGen_PECL_Element_Class

Class describing a PHP class within a PECL extension

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005-2008 Hartmut Holzgraefe

Variables

Methods

Inherited Variables

Inherited Methods

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 43]
Class describing a PHP class within a PECL extension

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

$constants = array()

[line 221]

Constants

Access: protected

Type:

array

[ Top ]

$description = ""

[line 108]

A long description

Access: protected

Type:

string

[ Top ]

$documentation = ""

[line 130]

Documentation

TODO: isn't this in Element base class already?

Access: protected

Type:

string

[ Top ]

$extends = ""

[line 149]

Extents which class?

Access: protected

Type:

string

[ Top ]

$implements = array()

[line 171]

Implemented Interfaces

Access: protected

Type:

array

[ Top ]

$isAbstract = false

[line 272]

Is this an abstract class?

Access: protected

Type:

bool

[ Top ]

$isFinal = false

[line 289]

Is this class final?

Access: protected

Type:

bool

[ Top ]

$isInterface = false

[line 306]

Is this an interface?

Access: protected

Type:

bool

[ Top ]

$methods = array()

[line 245]

Member Functions

Access: protected

Type:

array

[ Top ]

$name = "unknown"

[line 52]

The class name

Access: protected

Type:

string

[ Top ]

$payloadAlloc = true

[line 353]

Allocate storage space for payload data?

Access: protected

Type:

bool

[ Top ]

$payloadCtor = ""

[line 370]

Payload init code snippet

Access: protected

Type:

mixed

[ Top ]

$payloadDtor = ""

[line 406]

Payload dtor code snippet

Access: protected

Type:

mixed

[ Top ]

$payloadType = ""

[line 324]

Class payload data type

Var: C type name class payload data
Access: protected

Type:

string

[ Top ]

$properties = array()

[line 197]

Properties

Access: protected

Type:

array

[ Top ]

$summary = ""

[line 87]

A short description

Access: protected

Type:

string

[ Top ]

Method Detail

addConstant [line 228]

void addConstant(
CodeGen_PECL_Element_ClassConstant
$constant)

Add a constant to a class

Parameters:

object a $constant — class constant object

[ Top ]

addInterface [line 178]

void addInterface(
string
$interface)

Add an interface that this class implements

Parameters:

string $interface — interface name

[ Top ]

addMethod [line 252]

void addMethod(
CodeGen_PECL_Element_Method
$method)

Add a method definition to the class

Parameters:

object class $method — method object

[ Top ]

addProperty [line 204]

void addProperty(
CodeGen_PECL_Element_Property
$property)

Add a class property

Parameters:

object a $property — class property object

[ Top ]

docEntry [line 629]

string docEntry(

$base)

DocBook documentation fragment

Access: public

Parameters:

$base —

[ Top ]

functionAliasEntries [line 652]

void functionAliasEntries(
)

Return function alias entries for all methods

[ Top ]

getName [line 75]

string getName(
)

class name getter

Return: Classname

[ Top ]

getPayloadCtor [line 387]

string getPayloadCtor(

$extension)

Payload init code getter

Return: code snippet

Parameters:

$extension —

[ Top ]

getPayloadDtor [line 423]

string getPayloadDtor(

$extension)

Payload dtor code getter

Return: code snippet

Parameters:

$extension —

[ Top ]

getPayloadType [line 342]

string getPayloadType(
)

Payload type getter

[ Top ]

globalCode [line 472]

string globalCode(

$extension)

Generate global scope code

Access: public

Parameters:

$extension —

[ Top ]

hCode [line 440]

string hCode(
class
$extension)

Create C header entry for clas

Return: C header code snippet
Access: public

Parameters:

class $extension — Extension extension the function is part of

[ Top ]

isAbstract [line 277]

void isAbstract(
)

Make class abstract

[ Top ]

isFinal [line 294]

void isFinal(
)

Make class final

[ Top ]

isInterface [line 311]

void isInterface(
)

Make class an interface

[ Top ]

minitCode [line 615]

string minitCode(

$extension)

MINIT code fragment

Access: public

Parameters:

$extension —

[ Top ]

setDescription [line 115]

void setDescription(
string
$text)

Class description setter

Parameters:

string $text — Class description

[ Top ]

setDocumentation [line 137]

void setDocumentation(
string
$text)

Class documentation setter

Parameters:

string $text — Class documentation

[ Top ]

setExtends [line 156]

void setExtends(
string
$parent)

Set parent class that this class inherits from

Parameters:

string $parent — parent class name

[ Top ]

setName [line 59]

void setName(
string
$name)

class name setter

Parameters:

string $name — Classname

[ Top ]

setPayloadAlloc [line 360]

void setPayloadAlloc(
string
$alloc)

Payload alloc setter

Parameters:

string $alloc —

[ Top ]

setPayloadCtor [line 377]

void setPayloadCtor(
string
$code)

Payload init code setter

Parameters:

string $code — code snippet

[ Top ]

setPayloadDtor [line 413]

void setPayloadDtor(
string
$code)

Payload dtor code setter

Parameters:

string $code — code snippet

[ Top ]

setPayloadType [line 331]

void setPayloadType(
string
$type)

Payload type setter

Parameters:

string $type —

[ Top ]

setSummary [line 94]

void setSummary(
string
$text)

Description summary setter

Parameters:

string $text — Description summary

[ Top ]

writeTests [line 641]

void writeTests(
CodeGen_PECL_Extension
$extension)

Write method test cases

Parameters:

object Extension $extension — to write tests for

[ Top ]