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
sqlite3DaoBuilder	driver for jDaoCompiler
ociDaoBuilder	driver for jDaoCompiler
mysqliDaoBuilder	driver for jDaoCompiler
sqliteDaoBuilder	driver for jDaoCompiler
pgsqlDaoBuilder	driver for jDaoCompiler
mssqlDaoBuilder	driver for jDaoCompiler

Variable Summary

mixed $aliasWord

mixed $propertiesListForInsert

mixed $sqlFromClause

mixed $sqlSelectClause

mixed $sqlWhereClause

mixed $tableRealName

mixed $tableRealNameEsc

jDbTools $tools

string $_DaoClassName

mixed $_daoId

mixed $_daoPath

string $_DaoRecordClassName

jDaoParser $_dataParser

mixed $_dbType

Method Summary

jDaoGenerator __construct ( $selector, $tools, $daoParser, jDaoParser $daoDefinition)

void buildClasses ()

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

void buildCountUserQuery ( $method, &$src, &$allField)

void buildDeleteUserQuery ( $method, &$src, &$primaryFields)

void buildEndOfClass ()

void buildFromWhereClause ()

string buildInsertMethod ( $pkFields)

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

array buildOuterJoins ( &$tables, $primaryTableName)

string buildSelectClause ([ $distinct = false])

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

void buildSelectUserQuery ( $method, &$src, &$allField)

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

void buildUpdateAutoIncrementPK ( $pkai)

string buildUpdateMethod ( $pkFields)

void buildUpdateUserQuery ( $method, &$src, &$primaryFields)

string buildUserMethods ()

void getAutoIncrementPKField ([ $using = null])

void _captureAll ( &$field)

void _captureBinaryField ( &$field)

void _captureFieldToUpdate ( &$field)

void _captureFieldToUpdateOnUpdate ( &$field)

void _capturePrimaryFieldsExcludeAutoIncrement ( &$field)

void _capturePrimaryFieldsExcludePk ( &$field)

void _capturePrimaryTable ( &$field)

void _encloseName ( $name)

void _getPrimaryFieldsList ()

void _getPropertiesBy ( $captureMethod)

void _preparePHPCallbackExpr ( $field)

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

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 $propertiesListForInsert = 'PrimaryTable' (line 48)

access: protected

Redefined in descendants as:

mixed $sqlFromClause = '' (line 74)

access: protected

mixed $sqlSelectClause = '' (line 76)

access: protected

mixed $sqlWhereClause = '' (line 72)

access: protected

mixed $tableRealName = '' (line 64)

the real name of the main table

access: protected

mixed $tableRealNameEsc = '' (line 70)

the real name of the main table, escaped in SQL so it is ready to include into a SQL query.

access: protected

jDbTools $tools (line 55)

access: protected

string $_DaoClassName = null (line 46)

the DAO classname

access: protected

mixed $_daoId (line 57)

access: protected

mixed $_daoPath (line 58)

access: protected

string $_DaoRecordClassName = null (line 40)

The DaoRecord ClassName

access: protected

jDaoParser $_dataParser = null (line 34)

the dao definition.

access: protected

mixed $_dbType (line 59)

access: protected

Methods

Constructor __construct (line 82)

constructor

jDaoGenerator __construct ( $selector, $tools, $daoParser, jDaoParser $daoDefinition)

jDaoParser $daoDefinition
$selector
$tools
$daoParser

buildClasses (line 95)

build all classes

access: public

void buildClasses ()

buildConditions (line 865)

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

buildCountUserQuery (line 521)

access: protected

void buildCountUserQuery ( $method, &$src, &$allField)

$method
&$src
&$allField

Redefined in descendants as:

buildDeleteUserQuery (line 466)

access: protected

void buildDeleteUserQuery ( $method, &$src, &$primaryFields)

$method
&$src
&$primaryFields

buildEndOfClass (line 663)

access: protected

void buildEndOfClass ()

Redefined in descendants as:

pgsqlDaoBuilder::buildEndOfClass()

buildFromWhereClause (line 571)

create FROM clause and WHERE clause for all SELECT query

access: protected

void buildFromWhereClause ()

buildInsertMethod (line 215)

build the insert() method in the final class

return: the source of the method
access: protected

string buildInsertMethod ( $pkFields)

$pkFields

buildOneSQLCondition (line 924)

build a condition for the SQL WHERE clause.

this method call itself recursively.

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

string buildOneSQLCondition ( $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

buildOuterJoins (line 605)

generates the part of the FROM clause for outer joins

return: [0]=> the part of the FROM clause, [1]=> the part to add to the WHERE clause when needed
access: protected

array buildOuterJoins ( &$tables, $primaryTableName)

&$tables
$primaryTableName

Redefined in descendants as:

ociDaoBuilder::buildOuterJoins()

buildSelectClause (line 632)

build a SELECT clause for all SELECT queries

return: the select clause.
access: protected

string buildSelectClause ([ $distinct = false])

$distinct

buildSelectPattern (line 651)

build an item for the select clause

access: protected

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

$pattern
$table
$fieldname
$propname

Redefined in descendants as:

buildSelectUserQuery (line 545)

access: protected

void buildSelectUserQuery ( $method, &$src, &$allField)

$method
&$src
&$allField

buildSimpleConditions (line 802)

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

buildUpdateAutoIncrementPK (line 1084)

access: protected

void buildUpdateAutoIncrementPK ( $pkai)

$pkai

Redefined in descendants as:

buildUpdateMethod (line 304)

build the update() method for the final class

return: the source of the method
access: protected

string buildUpdateMethod ( $pkFields)

$pkFields

buildUpdateUserQuery (line 479)

access: protected

void buildUpdateUserQuery ( $method, &$src, &$primaryFields)

$method
&$src
&$primaryFields

buildUserMethods (line 365)

build all methods defined by the developer in the dao file

return: the source of the methods
access: protected

string buildUserMethods ()

getAutoIncrementPKField (line 771)

get autoincrement PK field

access: protected

void getAutoIncrementPKField ([ $using = null])

$using

Redefined in descendants as:

pgsqlDaoBuilder::getAutoIncrementPKField()

_captureAll (line 746)

access: protected

void _captureAll ( &$field)

&$field

_captureBinaryField (line 764)

access: protected

void _captureBinaryField ( &$field)

&$field

_captureFieldToUpdate (line 750)

access: protected

void _captureFieldToUpdate ( &$field)

&$field

_captureFieldToUpdateOnUpdate (line 757)

access: protected

void _captureFieldToUpdateOnUpdate ( &$field)

&$field

_capturePrimaryFieldsExcludeAutoIncrement (line 734)

access: protected

void _capturePrimaryFieldsExcludeAutoIncrement ( &$field)

&$field

_capturePrimaryFieldsExcludePk (line 738)

access: protected

void _capturePrimaryFieldsExcludePk ( &$field)

&$field

_capturePrimaryTable (line 742)

access: protected

void _capturePrimaryTable ( &$field)

&$field

_encloseName (line 1080)

access: protected

void _encloseName ( $name)

$name

Redefined in descendants as:

mssqlDaoBuilder::_encloseName()

_getPrimaryFieldsList (line 700)

access: protected

void _getPrimaryFieldsList ()

_getPropertiesBy (line 722)

gets fields that match a condition returned by the $captureMethod

access: protected

void _getPropertiesBy ( $captureMethod)

$captureMethod

_preparePHPCallbackExpr (line 1059)

access: protected

void _preparePHPCallbackExpr ( $field)

$field

_preparePHPExpr (line 1000)

access: protected

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

$expr
$field
$checknull
$forCondition

_prepareValues (line 829)

access: protected

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

$fieldList
$pattern
$prefixfield

_writeFieldNamesWith (line 696)

format field names with start, end and between strings.

access: protected

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

$start
$end
$beetween
$using

_writeFieldsInfoWith (line 679)

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 Mon, 26 Oct 2015 21:52:41 +0100 by phpDocumentor 1.4.3