Propel API
Class

PropelSchemaReverseTask

class PropelSchemaReverseTask extends PDOTask

This class generates an XML schema of an existing database from the database metadata.

Constants

VALIDATORS_NONE

Zero bit for no validators
VALIDATORS_MAXLENGTH

Bit for maxLength validator
VALIDATORS_MAXVALUE

Bit for maxValue validator
VALIDATORS_TYPE

Bit for type validator
VALIDATORS_REQUIRED

Bit for required validator
VALIDATORS_UNIQUE

Bit for unique validator
VALIDATORS_ALL

Bit for all validators

Methods

string getDbSchema()

Gets the (optional) schema name to use.
setDbSchema(string $dbSchema)

Sets the name of a database schema to use (optional).
string getDbEncoding($v)

Gets the database encoding.
setDbEncoding(string $v)

Sets the database encoding.
string getDatabaseName()

Gets the datasource name.
setDatabaseName(string $v)

Sets the datasource name.
setOutputFile(PhingFile $v)

Sets the output name for the XML file.
setSamePhpName(boolean $v)

Set whether to use the column name as phpName without any translation.
setAddVendorInfo(boolean $v)

Set whether to add vendor info to the schema.
void setAddValidators(string $v)

Sets set validator bitfield from a comma-separated list of "validator bit" names.
boolean isSamePhpName()

Whether to use the column name as phpName without any translation.
main()

Details

at line 188
public string getDbSchema()

Gets the (optional) schema name to use.

Return Value

string

at line 198
public setDbSchema(string $dbSchema)

Sets the name of a database schema to use (optional).

Parameters

string $dbSchema

at line 208
public string getDbEncoding($v)

Gets the database encoding.

Parameters

$v

Return Value

string

at line 218
public setDbEncoding(string $v)

Sets the database encoding.

Parameters

string $v

at line 228
public string getDatabaseName()

Gets the datasource name.

Return Value

string

at line 240
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 250
public setOutputFile(PhingFile $v)

Sets the output name for the XML file.

Parameters

PhingFile $v

at line 260
public setSamePhpName(boolean $v)

Set whether to use the column name as phpName without any translation.

Parameters

boolean $v

at line 270
public setAddVendorInfo(boolean $v)

Set whether to add vendor info to the schema.

Parameters

boolean $v

at line 282
public void setAddValidators(string $v)

Sets set validator bitfield from a comma-separated list of "validator bit" names.

Parameters

string $v The comma-separated list of which validators to add.

Return Value

void

Exceptions

BuildException

at line 321
public boolean isSamePhpName()

Whether to use the column name as phpName without any translation.

Return Value

boolean

at line 329
public main()

Exceptions

BuildException