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

Class: CodeGen_MySQL_Plugin_Element_Storage

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

Version:

  • Release: @package_version@

Copyright:

  • 2005-2008 Hartmut Holzgraefe

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

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


[ Top ]


Class Variables

$classExtra =  ""

[line 386]

  • Access: protected

Type:   mixed


[ Top ]

$fileExtensions = array()

[line 74]

  • Access: protected

Type:   mixed


[ Top ]

$functions = array()

[line 60]

Storage array for function handlers
  • Access: protected

Type:   array


[ Top ]

$haFlags = array()

[line 97]

Handler flags
  • Access: protected

Type:   array


[ Top ]

$requiredFunctions = array("open", 
                                         "close", 
                                         "rnd_init", 
                                         "rnd_next", 
                                         "rnd_pos", 
                                         "position", 
                                         "info", 
                                         "create", 
                                         "store_lock"
                                         )

[line 63]

  • Access: protected

Type:   mixed


[ Top ]



Method Detail

__construct (Constructor)   [line 49]

CodeGen_MySQL_Plugin_Element_Storage __construct( )

Constructor

Overrides CodeGen_MySQL_Plugin_Element::__construct() (Constructor)
[ Top ]

addFileExtension   [line 76]

void addFileExtension( $param)


Parameters:

   $param     

[ Top ]

funcName   [line 156]

bool funcName( string $name)

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

Parameters:

string   $name     handler name

[ Top ]

getFunctionHead   [line 323]

void getFunctionHead( $name)


Parameters:

   $name     

[ Top ]

getPluginCode   [line 218]

void getPluginCode( )


Overrides CodeGen_MySQL_Plugin_Element::getPluginCode() (parent method not documented)
[ Top ]

getPluginHeader   [line 276]

void getPluginHeader( )


Overrides CodeGen_MySQL_Plugin_Element::getPluginHeader() (parent method not documented)
[ Top ]

getPluginType   [line 172]

string getPluginType( void 0)

Plugin type specifier is needed for plugin registration

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

Parameters:

void   0     

[ Top ]

isName   [line 185]

bool isName( string $name)

Check for valid handler function names
  • Return: true for valid handler names, else false

Parameters:

string   $name     handler name

[ Top ]

isValid   [line 356]

void isValid( )


Overrides CodeGen_MySQL_Plugin_Element::isValid() (parent method not documented)
[ Top ]

setClassExtra   [line 388]

void setClassExtra( $code)


Parameters:

   $code     

[ Top ]

setFunction   [line 132]

void setFunction( Handler $name, Code $code)

Set function handler code

Parameters:

Handler   $name     name
Code   $code     snippet

[ Top ]

setHaFlag   [line 106]

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 ]


Documentation generated on Mon, 16 Feb 2009 09:30:05 +0000 by phpDocumentor 1.4.2. PEAR Logo Copyright © PHP Group 2004.