CodeGen_MySQL_Plugin
[ class tree: CodeGen_MySQL_Plugin ] [ index: CodeGen_MySQL_Plugin ] [ all elements ]
Packages:
CodeGen_MySQL_Plugin


Classes:
CodeGen_MySQL_Plugin_Element
CodeGen_MySQL_Plugin_Element_Daemon
CodeGen_MySQL_Plugin_Element_Fulltext
CodeGen_MySQL_Plugin_Element_InformationSchema
CodeGen_MySQL_Plugin_Element_StatusVariable
CodeGen_MySQL_Plugin_Element_Storage
CodeGen_MySQL_Plugin_Element_Test
CodeGen_MySQL_Plugin_Extension
CodeGen_MySQL_Plugin_ExtensionParser
Files:
Daemon.php
Element.php
Extension.php
ExtensionParser.php
Fulltext.php
InformationSchema.php
StatusVariable.php
Storage.php
Test.php

Class: CodeGen_MySQL_Plugin_Element

Source Location: /CodeGen_MySQL_Plugin-0.9.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):

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


[ Top ]

Class Variables

$deinitCode =  "return 0;"

[line 75]

Plugin shutdown code
  • Access: protected

Type:   string


[ Top ]

$deinitPrefix =  ""

[line 61]

Plugin shutdown code prefix
  • Access: protected

Type:   string


[ Top ]

$initCode =  "return 0;"

[line 68]

Plugin initialization code
  • Access: protected

Type:   string


[ Top ]

$initPrefix =  ""

[line 54]

Plugin initialization code prefix
  • Access: protected

Type:   string


[ Top ]

$requiresSource =  false

[line 82]

Do we require MySQL source or can we do with public headers only?
  • Access: protected

Type:   bool


[ Top ]

$statusVariables = array()

[line 89]

Status variables for this plugin
  • Access: protected

Type:   array


[ Top ]


Method Detail

__construct (Constructor)   [line 94]

CodeGen_MySQL_Plugin_Element __construct( )

Constructor

Overridden in child classes as:

CodeGen_MySQL_Plugin_Element_InformationSchema::__construct()
CodeGen_MySQL_Plugin_Element_Fulltext::__construct()
Constructor
CodeGen_MySQL_Plugin_Element_Storage::__construct()
Constructor

[ Top ]

addStatusVariable   [line 154]

void addStatusVariable( $var)


Parameters:

   $var   — 

[ Top ]

getPluginCode   [line 254]

void getPluginCode( )


Overridden in child classes as:

CodeGen_MySQL_Plugin_Element_InformationSchema::getPluginCode()
CodeGen_MySQL_Plugin_Element_Fulltext::getPluginCode()
CodeGen_MySQL_Plugin_Element_Storage::getPluginCode()

[ Top ]

getPluginDeclaration   [line 197]

void getPluginDeclaration( CodeGen_MySQL_Plugin_Extension $ext)


Parameters:

CodeGen_MySQL_Plugin_Extension   $ext   — 

[ Top ]

getPluginHeader   [line 271]

void getPluginHeader( )


Overridden in child classes as:

CodeGen_MySQL_Plugin_Element_Storage::getPluginHeader()

[ Top ]

getPluginRegistration   [line 179]

string getPluginRegistration( CodeGen_MySQL_Plugin_Extension $ext)

Plugin registration

Parameters:

void   $ext   — 

[ Top ]

getPluginType   [line 171]

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()
Plugin type specifier is needed for plugin registration
CodeGen_MySQL_Plugin_Element_Daemon::getPluginType()
Plugin type specifier is needed for plugin registration

Parameters:

void   0   — 

[ Top ]

getRequiresSource   [line 104]

bool getRequiresSource( )

requiresSource getter

[ Top ]

indentCode   [line 276]

void indentCode( $code, [ $level = 2])


Parameters:

   $code   — 
   $level   — 

[ Top ]

installStatement   [line 285]

void installStatement( $extension)


Parameters:

   $extension   — 

[ Top ]

isValid   [line 295]

void isValid( )


Overridden in child classes as:

CodeGen_MySQL_Plugin_Element_Storage::isValid()

[ Top ]

setDeinitCode   [line 147]

bool setDeinitCode( string $code)

Deinit Code setter
  • Return: success status

Parameters:

string   $code   —  code snippet

[ Top ]

setInitCode   [line 135]

bool setInitCode( string $code)

Init Code setter
  • Return: success status

Parameters:

string   $code   —  code snippet

[ Top ]

setName   [line 115]

bool setName( string $name)

Name setter
  • Return: success status

Overridden in child classes as:

CodeGen_MySQL_Plugin_Element_InformationSchema::setName()

Parameters:

string   $name   —  function name

[ Top ]

uninstallStatement   [line 290]

void uninstallStatement( $extension)


Parameters:

   $extension   — 

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