Class: CodeGen_PECL_Element

Source Location: /CodeGen_PECL-1.0.0rc1/PECL/Element.php

Class Overview

CodeGen_Element
   |
   --CodeGen_PECL_Element

Abstract base class for all PHP code elements

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005 Hartmut Holzgraefe

Methods

Child classes:

CodeGen_PECL_Element_ClassConstant: Class describing a PHP class constant within a PECL extension

CodeGen_PECL_Element_Class: Class describing a PHP class within a PECL extension

CodeGen_PECL_Element_Test: Class for testfile generation as needed for 'make test'

CodeGen_PECL_Element_Resource: Class for managing PHP internal resource types

CodeGen_PECL_Element_Global: Class describing a thread-global within a PECL extension

CodeGen_PECL_Element_Stream: Class for managing PHP stream wrappers

CodeGen_PECL_Element_Ini: Class describing a PHP ini directive within a PECL extension

CodeGen_PECL_Element_Constant: Class describing a PHP constant within a PECL extension

CodeGen_PECL_Element_Logo: Class that manages internal logo images for the extensions phpinfo block

CodeGen_PECL_Element_Property: Class describing a class property within a PECL extension

CodeGen_PECL_Element_Function: Class describing a function within a PECL extension

CodeGen_PECL_Element_Interface: Class describing a PHP interface within a PECL extension

Inherited Variables

Inherited Methods

Class Details

[line 38]
Abstract base class for all PHP code elements

Author: Hartmut Holzgraefe <hartmut@php.net>
Version: Release: @package_version@
Copyright: 2005 Hartmut Holzgraefe
Link: http://pear.php.net/package/CodeGen
Abstract:
License: PHP License 3.0

[ Top ]

Method Detail

cCodeEditorSettings [line 161]

string cCodeEditorSettings(
)

Generate Editor settings block for C source files

Return: Editor settings comment block
Access: public

[ Top ]

docEditorSettings [line 183]

string docEditorSettings(
[int
$level = 3])

Generate Editor settings block for documentation files

Return: Editor settings comment block
Access: public

Parameters:

int $level — Directory nesting depth of target file (default: 3)

[ Top ]

isKeyword [line 83]

bool isKeyword(
string
$name)

Checks whether a string is a reserved name

Return: true if reserved
Access: public

Parameters:

string $name — name

[ Top ]

isType [line 49]

string isType(
string
$name)

Checks whether a string is a valid PHP type name and returns the official name

Return: The official type name or boolean false if not a type
Access: public

Overridden in child classes as:

CodeGen_PECL_Element_Global::isType(): Overriding type check as we deal with real C types here

Parameters:

string $name — Type name

[ Top ]