Class: CodeGen_PECL_Element_Interface

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

Class Overview

CodeGen_Element
   |
   --CodeGen_PECL_Element
      |
      --CodeGen_PECL_Element_Interface

Class describing a PHP interface 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 interface 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

$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 interface?

Access: protected

Type:

string

[ Top ]

$methods = array()

[line 172]

Member Functions

Access: protected

Type:

array

[ Top ]

$name = "unknown"

[line 52]

The class name

Access: protected

Type:

string

[ Top ]

$summary = ""

[line 87]

A short description

Access: protected

Type:

string

[ Top ]

Method Detail

addMethod [line 179]

void addMethod(
CodeGen_PECL_Element_Method
$method)

Add a method to the interface

Parameters:

object $method —

[ Top ]

docEntry [line 294]

string docEntry(

$base)

DocBook documentation fragment

Access: public

Parameters:

$base —

[ Top ]

getName [line 75]

string getName(
)

name get()er

[ Top ]

getPayloadType [line 301]

void getPayloadType(
)

[ Top ]

globalCode [line 229]

string globalCode(

$extension)

Generate global scope code

Access: public

Parameters:

$extension —

[ Top ]

hCode [line 207]

string hCode(
class
$extension)

Create C header entry for interface

Return: C header code snippet
Access: public

Parameters:

class $extension — Extension extension the function is part of

[ Top ]

minitCode [line 282]

string minitCode(

$extension)

MINIT code fragment

Access: public

Parameters:

$extension —

[ Top ]

setDescription [line 115]

void setDescription(
string
$text)

description set()er

Parameters:

string $text —

[ Top ]

setDocumentation [line 137]

void setDocumentation(
string
$text)

description set()er

Parameters:

string $text —

[ Top ]

setExtends [line 156]

void setExtends(
string
$parent)

extends set()er

Parameters:

string $parent —

[ Top ]

setName [line 59]

void setName(
string
$name)

name set()er

Parameters:

string $name —

[ Top ]

setSummary [line 94]

void setSummary(
string
$text)

summary set()er

Parameters:

string $text —

[ Top ]