CodeGen
[ class tree: CodeGen ] [ index: CodeGen ] [ all elements ]
Packages:
CodeGen_PECL
CodeGen


Classes:
CodeGen_PECL_Command
CodeGen_PECL_Dependency_Extension
CodeGen_PECL_Dependency_With
CodeGen_PECL_Element
CodeGen_PECL_Element_Class
CodeGen_PECL_Element_ClassConstant
CodeGen_PECL_Element_Constant
CodeGen_PECL_Element_Function
CodeGen_PECL_Element_Global
CodeGen_PECL_Element_Ini
CodeGen_PECL_Element_Interface
CodeGen_PECL_Element_Logo
CodeGen_PECL_Element_Method
CodeGen_PECL_Element_Property
CodeGen_PECL_Element_Resource
CodeGen_PECL_Element_Stream
CodeGen_PECL_ExtensionParser
CodeGen_PECL_Maintainer
CodeGen_PECL_Release
Files:
Class.php
ClassConstant.php
Command.php
Constant.php
Element.php
Extension.php
ExtensionParser.php
Function.php
Global.php
Ini.php
Interface.php
Logo.php
Maintainer.php
Method.php
Property.php
Release.php
Resource.php
Stream.php
With.php

Class: CodeGen_PECL_Element_Constant

Source Location: /CodeGen_PECL-1.0.3/PECL/Element/Constant.php

Class Overview

CodeGen_Element
   |
   --CodeGen_PECL_Element
      |
      --CodeGen_PECL_Element_Constant

Class describing a PHP constant within a PECL extension


Author(s):

Version:

  • Release: @package_version@

Copyright:

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


[ Top ]

Class Variables

$define =  false

[line 81]

Create a C #define for this constant
  • Access: protected

Type:   bool


[ Top ]

$desc =

[line 72]

The constants description text
  • Access: protected

Type:   string


[ Top ]

$name =

[line 48]

The constants name
  • Access: protected

Type:   string


[ Top ]

$type =  "string"

[line 56]

The constants PHP data type
  • Access: protected

Type:   string


[ Top ]

$value =

[line 64]

The constants value
  • Access: protected

Type:   string


[ Top ]


Method Detail

cCode   [line 207]

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

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

string docFooter( string 0)

Generate DocBook XML section block footer
  • Return: DocBook XML snippet
  • Access: public

Parameters:

string   0   —  Extension name

[ Top ]

docHeader   [line 250]

string docHeader( string $name)

Generate DocBook XML section block header
  • Return: DocBook XML snippet
  • Access: public

Parameters:

string   $name   —  Extension name

[ Top ]

getName   [line 113]

void getName( string 0)

Get constant name
  • Access: public

Parameters:

string   0   — 

[ Top ]

getValue   [line 160]

string getValue( )

Get constant value
  • Return: the value
  • Access: public

[ Top ]

hCode   [line 227]

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

bool setDefine( string $value)

Set define flag
  • Return: true on success
  • Access: public

Parameters:

string   $value   —  the value

[ Top ]

setDesc   [line 172]

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

bool setType( string $type)

Set constant type
  • Return: true on success
  • Access: public

Parameters:

string   $type   —  the type

[ Top ]

setValue   [line 143]

bool setValue( string $value)

Set constant value
  • Return: true on success
  • Access: public

Parameters:

string   $value   —  the value

[ Top ]
Documentation generated on Mon, 11 Mar 2019 14:43:06 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.