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

Class: CodeGen_MySQL_Extension

Source Location: /CodeGen_MySQL-1.0.0RC1/MySQL/Extension.php

Class Overview

CodeGen_Extension
   |
   --CodeGen_MySQL_Extension

A generic framework for MySQL source project generation


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2005-2008 Hartmut Holzgraefe

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 54]
A generic framework for MySQL source project generation


[ Top ]


Class Variables

$archivePrefix =  "MySQL"

[line 76]

The prefix for archive files created by "make dist"
  • Access: protected

Type:   string


[ Top ]

$needSource =  false

[line 69]

Is the full source needed to compile this?
  • Access: protected

Type:   bool


[ Top ]

$testcases = array()

[line 62]

Custom test cases
  • Access: protected

Type:   array


[ Top ]



Method Detail

__construct (Constructor)   [line 84]

CodeGen_MySQL_Extension __construct( )

The constructor

[ Top ]

addTest   [line 483]

void addTest( CodeGen_MySQL_Element_Test $test)

add a custom test case
  • Access: public

Parameters:

object a   $test     Test object

[ Top ]

createExtension   [line 231]

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

Create all project files

Parameters:

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

[ Top ]

generateSource   [line 457]

void generateSource( )

Create the extensions code soure and project files
  • Access: protected

[ Top ]

getLicenseComment   [line 114]

string getLicenseComment( )

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

[ Top ]

isValid   [line 523]

void isValid( )


[ Top ]

runExtra   [line 528]

void runExtra( $what)


Parameters:

   $what     

[ Top ]

setNeedSource   [line 98]

void setNeedSource( bool $flag)

Do we need the full source to compile?

Parameters:

bool   $flag     

[ Top ]

testFactory   [line 518]

void testFactory( )


[ Top ]

writeAuthors   [line 147]

void writeAuthors( )

Write authors to the AUTHORS file
  • Access: protected

[ Top ]

writeChangelog   [line 213]

void writeChangelog( )

Generate ChangeLog file (custom or default)
  • Access: protected

[ Top ]

writeConfig   [line 309]

void writeConfig( )

Generate configure files for this extension
  • Access: protected

[ Top ]

writeExperimental   [line 169]

void writeExperimental( )

Write EXPERIMENTAL file for non-stable extensions
  • Access: protected

[ Top ]

writeNews   [line 194]

void writeNews( )

Generate NEWS file (custom or default)
  • Access: protected

[ Top ]

writeTests   [line 500]

void writeTests( )

Create test files

[ Top ]


Documentation generated on Fri, 13 Feb 2009 13:00:58 +0000 by phpDocumentor 1.4.2. PEAR Logo Copyright © PHP Group 2004.