Docs For Class CodeGen_PECL_Element

Class: CodeGen_PECL_Element_Constant

Class Overview

CodeGen_Element
   |
   --CodeGen_PECL_Element
      |
      --CodeGen_PECL_Element_Constant

Class describing a PHP constant within a PECL extension

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005 Hartmut Holzgraefe

Methods

Inherited Variables

Inherited Methods

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

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

Method Detail

cCode [line 185]

sting cCode(
class
$extension)

Create C code snippet to register this constant

Return: C code snippet
Access: public

Parameters:

class $extension — Extension extension we are owned by

[ Top ]

docEntry [line 251]

string docEntry(
string
$base)

Generate DocBook XML entry for this constant

Return: DocBook XML snippet
Access: public

Parameters:

string $base — Extension name (currently unused)

[ Top ]

docFooter [line 271]

string docFooter(
string
0)

Generate DocBook XML section block footer

Return: DocBook XML snippet
Access: public

Parameters:

string 0 — Extension name

[ Top ]

docHeader [line 228]

string docHeader(
string
$name)

Generate DocBook XML section block header

Return: DocBook XML snippet
Access: public

Parameters:

string $name — Extension name

[ Top ]

hCode [line 205]

sting hCode(
class
$extension)

Create C header snippet to register this constant

Return: C code snippet
Access: public

Parameters:

class $extension — Extension extension we are owned by

[ Top ]

setDefine [line 164]

bool setDefine(
string
$value)

Set define flag

Return: true on success
Access: public

Parameters:

string $value — the value

[ Top ]

setDesc [line 150]

bool setDesc(
string
$desc)

Set constant descriptive text

Return: true on success
Access: public

Parameters:

string $desc — the name

[ Top ]

setName [line 91]

bool setName(
string
$name)

Set constant name

Return: true on success
Access: public

Parameters:

string $name — the name

[ Top ]

setType [line 114]

bool setType(
string
$type)

Set constant name

Return: true on success
Access: public

Parameters:

string $type — the type

[ Top ]

setValue [line 132]

bool setValue(
string
$value)

Set constant value

Return: true on success
Access: public

Parameters:

string $value — the value

[ Top ]