Propel API
Class

PropelSQLTask

class PropelSQLTask extends AbstractPropelDataModelTask

The task for building SQL DDL based on the XML datamodel.

This class uses the new DDLBuilder classes instead of the Capsule PHP templates.

Methods

List getDataModels()

Return the data models that have been processed.

from AbstractPropelDataModelTask
Hashtable getDataModelDbMap()

Return the data model to database name map.

from AbstractPropelDataModelTask
addSchemaFileset(Fileset $set)

Adds a set of xml schema files (nested fileset attribute).

from AbstractPropelDataModelTask
String getTargetDatabase()

Get the current target database.

from AbstractPropelDataModelTask
setTargetDatabase(v $v)

Set the current target database.

from AbstractPropelDataModelTask
string getTargetPackage()

Get the current target package.

from AbstractPropelDataModelTask
setTargetPackage(string $v)

Set the current target package.

from AbstractPropelDataModelTask
setPackageObjectModel(boolean $v)

Set the packageObjectModel switch on/off

from AbstractPropelDataModelTask
setValidate(boolean $v)

Set whether to perform validation on the datamodel schema.xml file(s).

from AbstractPropelDataModelTask
setXsd(PhingFile $v)

Set the XSD schema to use for validation of any datamodel schema.xml file(s).

from AbstractPropelDataModelTask
setXsl(PhingFile $v)

Set the normalization XSLT to use to transform datamodel schema.xml file(s) before validation and parsing.

from AbstractPropelDataModelTask
void setOutputDirectory(PhingFile $outputDirectory)

[REQUIRED] Set the output directory.

from AbstractPropelDataModelTask
setDbEncoding(v $v)

Set the current target database encoding.

from AbstractPropelDataModelTask
setUrl(string $url)

Set the DB connection url.

from AbstractPropelDataModelTask
setUserid(string $userId)

Set the user name for the DB connection.

from AbstractPropelDataModelTask
setPassword(string $password)

Set the password for the DB connection.

from AbstractPropelDataModelTask
string getOutputDirectory()

Get the output directory.

from AbstractPropelDataModelTask
Mapper createMapper()

Nested creator, creates one Mapper for this task.

from AbstractPropelDataModelTask
PDO getConnection()

Gets the PDO connection, if URL specified.

from AbstractPropelDataModelTask
setSqlDbMap(PhingFile $sqldbmap)

Set the sqldbmap.

PhingFile getSqlDbMap()

Get the sqldbmap.

setDatabase(string $database)

Set the database name.

string getDatabase()

Get the database name.

main()

getWarnings(Database $database, PropelPLatformInterface $platform)

Details

public List getDataModels()

Return the data models that have been processed.

Return Value

List data models

public Hashtable getDataModelDbMap()

Return the data model to database name map.

Return Value

Hashtable data model name to database name map.

public addSchemaFileset(Fileset $set)

Adds a set of xml schema files (nested fileset attribute).

Parameters

Fileset $set a Set of xml schema files

public String getTargetDatabase()

Get the current target database.

Return Value

String target database(s)

public setTargetDatabase(v $v)

Set the current target database.

(e.g. mysql, oracle, ..)

Parameters

v $v target database(s)

public string getTargetPackage()

Get the current target package.

Return Value

string target PHP package.

public setTargetPackage(string $v)

Set the current target package.

This is where generated PHP classes will
live.

Parameters

string $v target PHP package.

public setPackageObjectModel(boolean $v)

Set the packageObjectModel switch on/off

Parameters

boolean $v The build.property packageObjectModel

public setValidate(boolean $v)

Set whether to perform validation on the datamodel schema.xml file(s).

Parameters

boolean $v

public setXsd(PhingFile $v)

Set the XSD schema to use for validation of any datamodel schema.xml file(s).

Parameters

PhingFile $v PhingFile

public setXsl(PhingFile $v)

Set the normalization XSLT to use to transform datamodel schema.xml file(s) before validation and parsing.

Parameters

PhingFile $v PhingFile

public void setOutputDirectory(PhingFile $outputDirectory)

[REQUIRED] Set the output directory.

It will be
created if it doesn't exist.

Parameters

PhingFile $outputDirectory

Return Value

void

Exceptions

Exception

public setDbEncoding(v $v)

Set the current target database encoding.

Parameters

v $v target database encoding

public setUrl(string $url)

Set the DB connection url.

Parameters

string $url connection url

public setUserid(string $userId)

Set the user name for the DB connection.

Parameters

string $userId database user

public setPassword(string $password)

Set the password for the DB connection.

Parameters

string $password database password

public string getOutputDirectory()

Get the output directory.

Return Value

string

public Mapper createMapper()

Nested creator, creates one Mapper for this task.

Return Value

Mapper The created Mapper type object.

Exceptions

BuildException

public PDO getConnection()

Gets the PDO connection, if URL specified.

Return Value

PDO Connection to use (for quoting, Platform class, etc.) or NULL if no connection params were specified.

at line 39
public setSqlDbMap(PhingFile $sqldbmap)

Set the sqldbmap.

Parameters

PhingFile $sqldbmap The db map.

at line 48
public PhingFile getSqlDbMap()

Get the sqldbmap.

Return Value

PhingFile $sqldbmap.

at line 57
public setDatabase(string $database)

Set the database name.

Parameters

string $database

at line 66
public string getDatabase()

Get the database name.

Return Value

string

at line 121
public main()

at line 174
public getWarnings(Database $database, PropelPLatformInterface $platform)

Parameters

Database $database
PropelPLatformInterface $platform