Class: CodeGen_MySQL_Plugin_Element_Storage

Source Location: /CodeGen_MySQL_Plugin-0.1.1dev/MySQL/Plugin/Element/Storage.php

Class Overview

CodeGen_Element
   |
   --CodeGen_MySQL_Plugin_Element
      |
      --CodeGen_MySQL_Plugin_Element_Storage

A class that generates Plugin extension soure and documenation files

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005 Hartmut Holzgraefe

Variables

Methods

Inherited Variables

Class: CodeGen_MySQL_Plugin_Element

CodeGen_MySQL_Plugin_Element::$deinitCode
CodeGen_MySQL_Plugin_Element::$initCode
CodeGen_MySQL_Plugin_Element::$requiresSource
CodeGen_MySQL_Plugin_Element::$statusVariables

Inherited Methods

Class: CodeGen_MySQL_Plugin_Element

CodeGen_MySQL_Plugin_Element::__construct(): Constructor
CodeGen_MySQL_Plugin_Element::addStatusVariable()
CodeGen_MySQL_Plugin_Element::getPluginCode()
CodeGen_MySQL_Plugin_Element::getPluginRegistration(): Plugin registration
CodeGen_MySQL_Plugin_Element::getPluginType(): Plugin type specifier is needed for plugin registration
CodeGen_MySQL_Plugin_Element::getRequiresSource(): requiresSource getter
CodeGen_MySQL_Plugin_Element::indentCode()
CodeGen_MySQL_Plugin_Element::installStatement()
CodeGen_MySQL_Plugin_Element::setDeinitCode(): Deinit Code setter
CodeGen_MySQL_Plugin_Element::setInitCode(): Init Code setter
CodeGen_MySQL_Plugin_Element::setName(): Name setter
CodeGen_MySQL_Plugin_Element::uninstallStatement()

Class Details

[line 43]
A class that generates Plugin extension soure and documenation files

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

[ Top ]

Class Variables

$functions = array()

[line 60]

Storage array for function handlers

Access: protected

Type:

array

[ Top ]

$haFlags = array()

[line 68]

Handler flags

Access: protected

Type:

array

[ Top ]

Method Detail

__construct (Constructor) [line 49]

CodeGen_MySQL_Plugin_Element_Storage __construct(
)

Constructor

Overrides CodeGen_MySQL_Plugin_Element::__construct() (Constructor)

[ Top ]

getPluginCode [line 184]

void getPluginCode(
)

Overrides CodeGen_MySQL_Plugin_Element::getPluginCode() (parent method not documented)

[ Top ]

getPluginType [line 138]

bool getPluginType(
string
0, void
1)

Return function name for handler if implemented, else "NULL"

Return: function name if implemented, else "NULL" Plugin type specifier is needed for plugin registration

Overrides CodeGen_MySQL_Plugin_Element::getPluginType() (Plugin type specifier is needed for plugin registration)

Parameters:

string	`0`	—	handler name
void	`1`	—

[ Top ]

isName [line 151]

bool isName(
string
$name)

Check for valid handler function names

Return: true for valid handler names, else false

Parameters:

string $name — handler name

[ Top ]

setFunction [line 103]

void setFunction(
Handler
$name, Code
$code)

Set function handler code

Parameters:

Handler	`$name`	—	name
Code	`$code`	—	snippet

[ Top ]

setHaFlag [line 77]

bool setHaFlag(
string
$name, [bool
$value = true])

Set Hander flag by name

Return: success status

Parameters:

string	`$name`	—	flag name
bool	`$value`	—	flag value (default=true)

[ Top ]