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

Class: CodeGen_MySQL_UDF_Extension

Source Location: /CodeGen_MySQL_UDF-0.9.2dev/MySQL/UDF/Extension.php

Class Overview

CodeGen_Extension
   |
   --CodeGen_MySQL_UDF_Extension

A class that generates PECL extension soure and documenation files


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2005 Hartmut Holzgraefe

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 55]
A class that generates PECL extension soure and documenation files


[ Top ]


Class Variables

$code = array()

[line 99]

Code snippets
  • Access: protected

Type:   array


[ Top ]

$functions = array()

[line 85]

The public UDF functions defined by this extension
  • Access: protected

Type:   array


[ Top ]

$packageFiles = array()

[line 92]

The package files created by this extension
  • Access: protected

Type:   array


[ Top ]



Method Detail

__construct (Constructor)   [line 111]

CodeGen_MySQL_UDF_Extension __construct( )

The constructor

[ Top ]

addCode   [line 126]

void addCode( object C $type, $code)

Add global code to the extension

Parameters:

object C   $type   —  code snippet
   $code   — 

[ Top ]

addFunction   [line 139]

void addFunction( CodeGen_Mysql_UDF_Element_Function $function)

Add a function to the extension

Parameters:

object a   $function   —  function object

[ Top ]

addPackageFile   [line 157]

void addPackageFile( string $type, string $name)

Add a package file by type and name

Parameters:

string   $type   —  type
string   $name   —  name

[ Top ]

addSourceFile   [line 170]

void addSourceFile( string $name)

Add a source file to be copied to the extension dir

Parameters:

string   $name   —  path

[ Top ]

copyright   [line 73]

string copyright( )

CodeGen_MySQL_UDF Copyright message

[ Top ]

createExtension   [line 229]

void createExtension( [string $dirpath = false], [ $force = false])

Create the extensions including

Parameters:

string   $dirpath   —  Directory to create (default is ./$this->name)
   $force   — 

[ Top ]

generateSource   [line 319]

void generateSource( string $dirpath)

Create the extensions code soure and project files

Parameters:

string   $dirpath   —  Directory to write to

[ Top ]

getLicense   [line 349]

string getLicense( )

Create the license part of the source file header comment
  • Return: code fragment

[ Top ]

successMsg   [line 642]

void successMsg( [string $dirpath = false])

Describe next steps after successfull extension creation

Parameters:

string   $dirpath   —  directory where extension was build

[ Top ]

version   [line 63]

string version( )

Current CodeGen_MySQL_UDF version number

[ Top ]

writeAuthors   [line 566]

void writeAuthors( string $dirpath)

Write authors to the AUTHORS file

Parameters:

string   $dirpath   —  directory to write to

[ Top ]

writeChangelog   [line 728]

void writeChangelog( string $dirpath)

Generate ChangeLog file (custom or default)

Parameters:

string   $dirpath   —  directory to write to

[ Top ]

writeCodeFile   [line 458]

void writeCodeFile( string $dirpath)

Write the complete C code file

Parameters:

string   $dirpath   —  directory to write to

[ Top ]

writeConfig   [line 750]

void writeConfig( string $dirpath)

Generate configure files for this UDF extension

Parameters:

string   $dirpath   —  directory to write to

[ Top ]

writeDotCvsignore   [line 608]

void writeDotCvsignore( string $dirpath)

Write .cvsignore entries

Parameters:

string   $dirpath   —  directory to write to

[ Top ]

writeExperimental   [line 587]

void writeExperimental( string $dirpath)

Write EXPERIMENTAL file for non-stable extensions

Parameters:

string   $dirpath   —  directory to write to

[ Top ]

writeHeaderFile   [line 384]

void writeHeaderFile( string $dirpath)

Write the complete C header file

Parameters:

string   $dirpath   —  directory to write to

[ Top ]

writeInstall   [line 683]

void writeInstall( string $dirpath)

Generate INSTALL file (custom or default)

Parameters:

string   $dirpath   —  directory to write to

[ Top ]

writeNews   [line 706]

void writeNews( string $dirpath)

Generate NEWS file (custom or default)

Parameters:

string   $dirpath   —  directory to write to

[ Top ]

writeReadme   [line 661]

void writeReadme( string $dirpath)

Generate README file (custom or default)

Parameters:

string   $dirpath   —  directory to write to

[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:15:03 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.