Class: CodeGen_MySQL_Plugin_Element

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

Class Overview

CodeGen_Element
   |
   --CodeGen_MySQL_Plugin_Element

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

Child classes:

CodeGen_MySQL_Plugin_Element_InformationSchema: A class that generates Plugin extension soure and documenation files

CodeGen_MySQL_Plugin_Element_Fulltext: A class that generates Plugin extension soure and documenation files

CodeGen_MySQL_Plugin_Element_Storage: A class that generates Plugin extension soure and documenation files

CodeGen_MySQL_Plugin_Element_Daemon: A class that generates Plugin extension soure and documenation files

Inherited Variables

Inherited Methods

Class Details

[line 46]
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
Abstract:
License: PHP License 3.0

[ Top ]

Class Variables

$deinitCode =

[line 61]

Plugin shutdown code

Access: protected

Type:

string

[ Top ]

$initCode =

[line 54]

Plugin initialization code

Access: protected

Type:

string

[ Top ]

$requiresSource = false

[line 68]

Do we require MySQL source or can we do with public headers only?

Access: protected

Type:

bool

[ Top ]

$statusVariables = array()

[line 75]

Status variables for this plugin

Access: protected

Type:

array

[ Top ]

Method Detail

__construct (Constructor) [line 80]

CodeGen_MySQL_Plugin_Element __construct(
)

Constructor

Overridden in child classes as:

CodeGen_MySQL_Plugin_Element_Fulltext::__construct(): Constructor

CodeGen_MySQL_Plugin_Element_Storage::__construct(): Constructor

[ Top ]

addStatusVariable [line 142]

void addStatusVariable(

$var)

Parameters:

$var —

[ Top ]

getPluginCode [line 242]

void getPluginCode(
)

Overridden in child classes as:

CodeGen_MySQL_Plugin_Element_Fulltext::getPluginCode()

CodeGen_MySQL_Plugin_Element_Storage::getPluginCode()

[ Top ]

getPluginRegistration [line 167]

string getPluginRegistration(
CodeGen_MySQL_Plugin_Extension
$ext)

Plugin registration

Parameters:

void $ext —

[ Top ]

getPluginType [line 159]

string getPluginType(
void
0)

Plugin type specifier is needed for plugin registration

Abstract:

Overridden in child classes as:

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

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

CodeGen_MySQL_Plugin_Element_Storage::getPluginType(): Return function name for handler if implemented, else "NULL"

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

Parameters:

void 0 —

[ Top ]

getRequiresSource [line 92]

bool getRequiresSource(
)

requiresSource getter

[ Top ]

indentCode [line 257]

void indentCode(

$code, [
$level = 2])

Parameters:

	`$code`	—
	`$level`	—

[ Top ]

installStatement [line 266]

void installStatement(

$extension)

Parameters:

$extension —

[ Top ]

setDeinitCode [line 135]

bool setDeinitCode(
string
$code)

Deinit Code setter

Return: success status

Parameters:

string $code — code snippet

[ Top ]

setInitCode [line 123]

bool setInitCode(
string
$code)

Init Code setter

Return: success status

Parameters:

string $code — code snippet

[ Top ]

setName [line 103]

bool setName(
string
$name)

Name setter

Return: success status

Parameters:

string $name — function name

[ Top ]

uninstallStatement [line 270]

void uninstallStatement(

$extension)

Parameters:

$extension —

[ Top ]