Class: CodeGen_MySQL_UDF_Element_Function

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

Class Overview

CodeGen_Element
   |
   --CodeGen_MySQL_UDF_Element_Function

Class describing a function within a UDF extension

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005 Hartmut Holzgraefe

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 38]
Class describing a function within a UDF extension

Author: Hartmut Holzgraefe <hartmut@php.net>
Version: Release: @package_version@
Copyright: 2005 Hartmut Holzgraefe
Link: http://pear.php.net/package/CodeGen_MySQL_UDF
License: PHP License 3.0

[ Top ]

Class Variables

$addCode =

[line 506]

Code snippet for aggregate add function

Access: protected

Type:

string

[ Top ]

$clearCode =

[line 530]

Code snippet for aggregate clear function

Access: protected

Type:

string

[ Top ]

$code = ""

[line 423]

Code snippet

Access: protected

Type:

string

[ Top ]

$dataElements = array()

[line 385]

Private data elements

Access: protected

Type:

array

[ Top ]

$decimals = false

[line 187]

decimal digits for REAL return values

Access: protected

Type:

mixed

[ Top ]

$deinitCode =

[line 463]

Code snippet for deinit function

Access: protected

Type:

string

[ Top ]

$description = ""

[line 112]

A long description

Access: protected

Type:

string

[ Top ]

$initCode =

[line 443]

Code snippet for init function

Access: protected

Type:

string

[ Top ]

$length = false

[line 162]

max. Length of return value

Access: protected

Type:

mixed

[ Top ]

$mandatoryParams = 0

[line 294]

Number of mandatory parameters

Access: protected

Type:

int

[ Top ]

$name = "unknown"

[line 46]

The function name

Access: protected

Type:

string

[ Top ]

$null = 0

[line 212]

Function may return NULL values?

Access: protected

Type:

bool

[ Top ]

$optionalParams = 0

[line 301]

Number of optional parameters

Access: protected

Type:

int

[ Top ]

$params = array()

[line 287]

Function parameters

Access: protected

Type:

array

[ Top ]

$resultCode =

[line 555]

Code snippet for aggregate result function

Access: protected

Type:

string

[ Top ]

$returns = "string"

[line 246]

Function returntype

Access: protected

Type:

string

[ Top ]

$startCode =

[line 483]

Code snippet for aggregate start function

Access: protected

Type:

string

[ Top ]

$summary = ""

[line 90]

A short description

Access: protected

Type:

string

[ Top ]

$totalParams = 0

[line 308]

Total number of parameters

Access: protected

Type:

int

[ Top ]

$type = "normal"

[line 132]

Function type: normal or aggregate

Access: protected

Type:

string

[ Top ]

Method Detail

addDataElement [line 395]

bool addDataElement(
string
$name, string
$type, [stirng
$default = false])

Add an element to the functions private data structure

Return: success status

Parameters:

string	`$name`	—	element name
string	`$type`	—	element type
stirng	`$default`	—	default value

[ Top ]

addParam [line 318]

bool addParam(
string
$name, string
$type, [string
$optional = null])

Add a function parameter to the parameter list

Return: success status

Parameters:

string	`$name`	—	parameter name
string	`$type`	—	parameter type
string	`$optional`	—	optional?

[ Top ]

cCode [line 581]

string cCode(
object Extension
$extension)

Generate code for this user definend function

Return: C code

Parameters:

object Extension $extension — object

[ Top ]

cData [line 884]

string cData(
)

Generate data structure definition for the functions private data

Return: C code

[ Top ]

cPrototype [line 853]

string cPrototype(
)

Generate function prototypes for this user definend function

Return: C code

[ Top ]

createStatement [line 961]

string createStatement(
object Extension
$extension)

Return SQL CREATE FUNCTION statement for this function

Parameters:

object Extension $extension — to generate for

[ Top ]

dropStatement [line 975]

string dropStatement(
object Extension
$extension)

Return SQL DROP FUNCTION statement for this function

Parameters:

object Extension $extension — to generate for

[ Top ]

getName [line 76]

string getName(
)

Name getter

Return: function name

[ Top ]

returnType [line 908]

string returnType(
)

The C return type of this function

Return: C code

[ Top ]

setAddCode [line 514]

bool setAddCode(
string
$code)

Function aggregate add code setter

Return: success status

Parameters:

string $code — C code snippet

[ Top ]

setClearCode [line 538]

bool setClearCode(
string
$code)

Function aggregate clear code setter

Return: success status

Parameters:

string $code — C code snippet

[ Top ]

setCode [line 431]

bool setCode(
string
$text)

Function code setter

Return: success status

Parameters:

string $text — C code snippet

[ Top ]

setDecimals [line 195]

bool setDecimals(
mixed
$decimals)

Decimals setter

Return: success status

Parameters:

mixed $decimals — max. lengt as int or flase if not applicable

[ Top ]

setDeinitCode [line 471]

bool setDeinitCode(
string
$code)

Function deinit code setter

Return: success status

Parameters:

string $code — C code snippet

[ Top ]

setDescription [line 120]

bool setDescription(
string
$text)

Description setter

Return: success status

Parameters:

string $text — function description

[ Top ]

setInitCode [line 451]

bool setInitCode(
string
$code)

Function init code setter

Return: success status

Parameters:

string $code — C code snippet

[ Top ]

setLength [line 170]

bool setLength(
mixed
$length)

Length setter

Return: success status

Parameters:

mixed $length — max. lengt as int or flase if not applicable

[ Top ]

setName [line 54]

bool setName(
string
$name)

Name setter

Return: success status

Parameters:

string $name — function name

[ Top ]

setNull [line 220]

bool setNull(
mixed
$null)

Decimals setter

Return: success status

Parameters:

mixed $null — truth value

[ Top ]

setResultCode [line 563]

bool setResultCode(
string
$code)

Function aggregate result code setter

Return: success status

Parameters:

string $code — C code snippet

[ Top ]

setReturns [line 257]

bool setReturns(
string
$returns)

Return type setter

one of "string", "int", "real", or "datetime"

Return: success status

Parameters:

string $returns — return type

[ Top ]

setStartCode [line 491]

bool setStartCode(
string
$code)

Function aggregate start code setter

Return: success status

Parameters:

string $code — C code snippet

[ Top ]

setSummary [line 98]

bool setSummary(
string
$text)

Summary setter

Return: success status

Parameters:

string $text — function summary

[ Top ]

setType [line 140]

bool setType(
string
$type)

Function type setter

Return: success status

Parameters:

string $type — "normal" or "aggregate"

[ Top ]

signature [line 933]

string signature(
void
0)

Return SQL function signature of this UDF

Parameters:

void 0 —

[ Top ]