Propel API
Class

PropelSQLDiffTask

class PropelSQLDiffTask extends AbstractPropelDataModelTask

This Task creates the OM classes based on the XML schema file.

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
setDatabaseName(string $v)

Sets the datasource name.

string getDatabaseName()

Gets the datasource name.

setEditorCmd(string $editorCmd)

Setter for the editorCmd property

string getEditorCmd()

Getter for the editorCmd property

setCaseInsensitive(boolean $isCaseInsensitive)

Defines whether the comparison is case insensitive

boolean isCaseInsensitive()

Checks whether the comparison is case insensitive

main()

Main method builds all the targets for a typical propel project.

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 36
public setDatabaseName(string $v)

Sets the datasource name.

This will be used as the <database name=""> value in the generated schema.xml

Parameters

string $v

at line 46
public string getDatabaseName()

Gets the datasource name.

Return Value

string

at line 56
public setEditorCmd(string $editorCmd)

Setter for the editorCmd property

Parameters

string $editorCmd

at line 66
public string getEditorCmd()

Getter for the editorCmd property

Return Value

string

at line 76
public setCaseInsensitive(boolean $isCaseInsensitive)

Defines whether the comparison is case insensitive

Parameters

boolean $isCaseInsensitive

at line 86
public boolean isCaseInsensitive()

Checks whether the comparison is case insensitive

Return Value

boolean

at line 94
public main()

Main method builds all the targets for a typical propel project.