Docs For Class jDaoGenerator

Class jDaoGenerator

Description

This is a generator which creates php class from dao xml file.

It is called by jDaoCompiler

see: jDaoCompiler

Located in /dao/jDaoGenerator.class.php (line 28)

Direct descendents

Class	Description
mysqlDaoBuilder	driver for jDaoCompiler
intuitionDaoBuilder	driver for jDaoCompiler
ociDaoBuilder	driver for jDaoCompiler
sqliteDaoBuilder	driver for jDaoCompiler
pgsqlDaoBuilder	driver for jDaoCompiler

Variable Summary

mixed $aliasWord

mixed $falseValue

mixed $propertiesListForInsert

mixed $trueValue

string $_DaoClassName

string $_DaoRecordClassName

jDaoParser $_dataParser

Method Summary

jDaoGenerator __construct ( $factoryClassName, $recordClassName, jDaoParser $daoDefinition)

void buildClasses ()

void genEndOfClass ()

void genOuterJoins ( &$tables, $primaryTableName)

void genSelectPattern ( $pattern, $table, $fieldname, $propname)

void genUpdateAutoIncrementPK ( $pkai, $pTableRealName)

void getBooleanValue ( $value)

string _buildConditions (jDaoConditions $cond, array $fields, [array $params = array()], [boolean $withPrefix = true], [array $groupby = null])

string _buildSimpleConditions ( &$fields, [string $fieldPrefix = ''], [boolean $forSelect = true], array $fields)

string _buildSQLCondition ( $condition, array $fields, array $params, boolean $withPrefix, [boolean $principal = false], jDaoCondition $cond)

void _captureAll ( &$field)

void _captureBinaryField ( &$field)

void _captureFieldToUpdate ( &$field)

void _captureFieldToUpdateOnUpdate ( &$field)

void _capturePkFields ( &$field)

void _capturePrimaryFieldsExcludeAutoIncrement ( &$field)

void _capturePrimaryFieldsExcludePk ( &$field)

void _capturePrimaryTable ( &$field)

void _encloseName ( $name)

void _getAutoIncrementPKField ([ $using = null])

array _getFromClause ()

void _getPropertiesBy ( $captureMethod)

void _getSelectClause ([ $distinct = false])

void _preparePHPExpr ( $expr, $field, [ $checknull = true], [ $forCondition = ''])

void _preparePHPValue ( $value, $fieldType, [ $checknull = true])

void _prepareValues ( $fieldList, [ $pattern = ''], [ $prefixfield = ''])

void _writeFieldNamesWith ([ $start = ''], [ $end = ''], [ $beetween = ''], [ $using = null])

void _writeFieldsInfoWith (string $info, [string $start = ''], [string $end = ''], [string $beetween = ''], [array $using = null])

Variables

mixed $aliasWord = ' AS ' (line 50)

access: protected

Redefined in descendants as:

ociDaoBuilder::$aliasWord

mixed $falseValue = 0 (line 53)

access: protected

Redefined in descendants as:

pgsqlDaoBuilder::$falseValue

mixed $propertiesListForInsert = 'PrimaryTable' (line 48)

access: protected

Redefined in descendants as:

mixed $trueValue = 1 (line 52)

access: protected

Redefined in descendants as:

pgsqlDaoBuilder::$trueValue

string $_DaoClassName = null (line 46)

the DAO classname

access: protected

string $_DaoRecordClassName = null (line 40)

The DaoRecord ClassName

access: protected

jDaoParser $_dataParser = null (line 34)

the dao definition.

access: protected

Methods

Constructor __construct (line 59)

constructor

jDaoGenerator __construct ( $factoryClassName, $recordClassName, jDaoParser $daoDefinition)

jDaoParser $daoDefinition
$factoryClassName
$recordClassName

Redefined in descendants as:

buildClasses (line 68)

build all classes

access: public

void buildClasses ()

genEndOfClass (line 546)

access: protected

void genEndOfClass ()

Redefined in descendants as:

pgsqlDaoBuilder::genEndOfClass()

genOuterJoins (line 488)

access: protected

void genOuterJoins ( &$tables, $primaryTableName)

&$tables
$primaryTableName

Redefined in descendants as:

ociDaoBuilder::genOuterJoins()

genSelectPattern (line 533)

access: protected

void genSelectPattern ( $pattern, $table, $fieldname, $propname)

$pattern
$table
$fieldname
$propname

Redefined in descendants as:

genUpdateAutoIncrementPK (line 979)

access: protected

void genUpdateAutoIncrementPK ( $pkai, $pTableRealName)

$pkai
$pTableRealName

Redefined in descendants as:

getBooleanValue (line 983)

access: protected

void getBooleanValue ( $value)

$value

_buildConditions (line 734)

build 'where' clause from conditions declared with condition tag in a user method

return: a WHERE clause (without the WHERE keyword) with eventually an ORDER clause
access: protected

string _buildConditions (jDaoConditions $cond, array $fields, [array $params = array()], [boolean $withPrefix = true], [array $groupby = null])

jDaoConditions $cond: the condition object which contains conditions data
array $fields: array of jDaoProperty
array $params: list of parameters name of the method
boolean $withPrefix: true if the field name should be preceded by the table name/table alias
array $groupby: list of properties to use in a groupby

_buildSimpleConditions (line 675)

build a WHERE clause with conditions on given properties : conditions are equality between a variable and the field.

the variable name is the name of the property, made with an optional prefix given in $fieldPrefix parameter. This method is called to generate WHERE clause for primary keys.

return: the WHERE clause (without the WHERE keyword)
access: protected

string _buildSimpleConditions ( &$fields, [string $fieldPrefix = ''], [boolean $forSelect = true], array $fields)

array $fields: list of jDaoPropery objects
string $fieldPrefix: an optional prefix to prefix variable names
boolean $forSelect: if true, the table name or table alias will prefix the field name in the query
&$fields

_buildSQLCondition (line 793)

build SQL WHERE clause

Used by _buildConditions. And this method call itself recursively

return: a WHERE clause (without the WHERE keyword)
see: jDaoGenerator::_buildConditions
access: protected

string _buildSQLCondition ( $condition, array $fields, array $params, boolean $withPrefix, [boolean $principal = false], jDaoCondition $cond)

jDaoCondition $cond: a condition object which contains conditions data
array $fields: array of jDaoProperty
array $params: list of parameters name of the method
boolean $withPrefix: true if the field name should be preceded by the table name/table alias
boolean $principal: should be true for the first call, and false for recursive call
$condition

_captureAll (line 617)

access: protected

void _captureAll ( &$field)

&$field

_captureBinaryField (line 637)

access: protected

void _captureBinaryField ( &$field)

&$field

_captureFieldToUpdate (line 621)

access: protected

void _captureFieldToUpdate ( &$field)

&$field

_captureFieldToUpdateOnUpdate (line 629)

access: protected

void _captureFieldToUpdateOnUpdate ( &$field)

&$field

_capturePkFields (line 600)

access: protected

void _capturePkFields ( &$field)

&$field

_capturePrimaryFieldsExcludeAutoIncrement (line 604)

access: protected

void _capturePrimaryFieldsExcludeAutoIncrement ( &$field)

&$field

_capturePrimaryFieldsExcludePk (line 609)

access: protected

void _capturePrimaryFieldsExcludePk ( &$field)

&$field

_capturePrimaryTable (line 613)

access: protected

void _capturePrimaryTable ( &$field)

&$field

_encloseName (line 975)

access: protected

void _encloseName ( $name)

$name

Redefined in descendants as:

_getAutoIncrementPKField (line 644)

get autoincrement PK field

access: protected

void _getAutoIncrementPKField ([ $using = null])

$using

Redefined in descendants as:

pgsqlDaoBuilder::_getAutoIncrementPKField()

_getFromClause (line 452)

create FROM clause for all SELECT query

return: FROM string and WHERE string
access: protected

array _getFromClause ()

_getPropertiesBy (line 588)

gets fields that match a condition returned by the $captureMethod

access: protected

void _getPropertiesBy ( $captureMethod)

$captureMethod

_getSelectClause (line 517)

build SELECT clause for all SELECT queries

access: protected

void _getSelectClause ([ $distinct = false])

$distinct

_preparePHPExpr (line 911)

access: protected

void _preparePHPExpr ( $expr, $field, [ $checknull = true], [ $forCondition = ''])

$expr
$field
$checknull
$forCondition

_preparePHPValue (line 881)

prepare a string ready to be included in a PHP script

we assume that if the value is "NULL", all things has been take care of before the call of this method The method generates something like (including quotes) '.some PHP code.' (we do break "simple quoted strings")

access: protected

void _preparePHPValue ( $value, $fieldType, [ $checknull = true])

$value
$fieldType
$checknull

_prepareValues (line 702)

access: protected

void _prepareValues ( $fieldList, [ $pattern = ''], [ $prefixfield = ''])

$fieldList
$pattern
$prefixfield

_writeFieldNamesWith (line 579)

format field names with start, end and between strings.

access: protected

void _writeFieldNamesWith ([ $start = ''], [ $end = ''], [ $beetween = ''], [ $using = null])

$start
$end
$beetween
$using

_writeFieldsInfoWith (line 562)

format field names with start, end and between strings.

will write the field named info. eg info == name echo $field->name

see: jDaoProperty
access: protected

void _writeFieldsInfoWith (string $info, [string $start = ''], [string $end = ''], [string $beetween = ''], [array $using = null])

string $info: property to get from objects in $using
string $start: string to add before the info
string $end: string to add after the info
string $beetween: string to add between each info
array $using: list of CopixPropertiesForDAO object. if null, get default fields list

Documentation generated on Thu, 22 Mar 2012 22:14:47 +0100 by phpDocumentor 1.4.3