Propel API
Class

PropelDataSQLTask

class PropelDataSQLTask extends AbstractPropelDataModelTask

Task that transforms XML datadump files into files containing SQL INSERT statements.

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
void setSqlDbMap(PhingFile $sqldbmap)

Set the file that maps between SQL files and databases.
PhingFile getSqlDbMap()

Get the file that maps between SQL files and databases.
void setDataDbMap(PhingFile $datadbmap)

Set the file that maps between data XML files and databases.
PhingFile getDataDbMap()

Get the file that maps between data XML files and databases.
setSrcDir(PhingFile $srcDir)

Set the src directory for the data xml files listed in the datadbmap file.
PhingFile getSrcDir()

Get the src directory for the data xml files listed in the datadbmap file.
void main()

Main method parses the XML files and creates SQL files.

Details

in AbstractPropelDataModelTask at line 147
public List getDataModels()

Return the data models that have been processed.

Return Value

List data models

in AbstractPropelDataModelTask at line 161
public Hashtable getDataModelDbMap()

Return the data model to database name map.

Return Value

Hashtable data model name to database name map.

in AbstractPropelDataModelTask at line 175
public addSchemaFileset(Fileset $set)

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

Parameters

Fileset $set a Set of xml schema files

in AbstractPropelDataModelTask at line 185
public String getTargetDatabase()

Get the current target database.

Return Value

String target database(s)

in AbstractPropelDataModelTask at line 195
public setTargetDatabase(v $v)

Set the current target database.

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

Parameters

v $v target database(s)

in AbstractPropelDataModelTask at line 205
public string getTargetPackage()

Get the current target package.

Return Value

string target PHP package.

in AbstractPropelDataModelTask at line 216
public setTargetPackage(string $v)

Set the current target package.

This is where generated PHP classes will
live.

Parameters

string $v target PHP package.

in AbstractPropelDataModelTask at line 226
public setPackageObjectModel(boolean $v)

Set the packageObjectModel switch on/off

Parameters

boolean $v The build.property packageObjectModel

in AbstractPropelDataModelTask at line 235
public setValidate(boolean $v)

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

Parameters

boolean $v

in AbstractPropelDataModelTask at line 244
public setXsd(PhingFile $v)

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

Parameters

PhingFile $v PhingFile

in AbstractPropelDataModelTask at line 253
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

in AbstractPropelDataModelTask at line 265
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

BuildException

in AbstractPropelDataModelTask at line 285
public setDbEncoding(v $v)

Set the current target database encoding.

Parameters

v $v target database encoding

in AbstractPropelDataModelTask at line 295
public setUrl(string $url)

Set the DB connection url.

Parameters

string $url connection url

in AbstractPropelDataModelTask at line 305
public setUserid(string $userId)

Set the user name for the DB connection.

Parameters

string $userId database user

in AbstractPropelDataModelTask at line 315
public setPassword(string $password)

Set the password for the DB connection.

Parameters

string $password database password

in AbstractPropelDataModelTask at line 324
public string getOutputDirectory()

Get the output directory.

Return Value

string

in AbstractPropelDataModelTask at line 335
public Mapper createMapper()

Nested creator, creates one Mapper for this task.

Return Value

Mapper The created Mapper type object.

Exceptions

BuildException

in AbstractPropelDataModelTask at line 374
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 53
public void setSqlDbMap(PhingFile $sqldbmap)

Set the file that maps between SQL files and databases.

Parameters

PhingFile $sqldbmap the sql -> db map.

Return Value

void

at line 63
public PhingFile getSqlDbMap()

Get the file that maps between SQL files and databases.

Return Value

PhingFile sqldbmap.

at line 74
public void setDataDbMap(PhingFile $datadbmap)

Set the file that maps between data XML files and databases.

Parameters

PhingFile $datadbmap

Return Value

void

at line 84
public PhingFile getDataDbMap()

Get the file that maps between data XML files and databases.

Return Value

PhingFile $datadbmap.

at line 93
public setSrcDir(PhingFile $srcDir)

Set the src directory for the data xml files listed in the datadbmap file.

Parameters

PhingFile $srcDir data xml source directory

at line 103
public PhingFile getSrcDir()

Get the src directory for the data xml files listed in the datadbmap file.

Return Value

PhingFile data xml source directory

at line 130
public void main()

Main method parses the XML files and creates SQL files.

Return Value

void

Exceptions

Exception If there is an error parsing the data xml.
BuildException