class Database extends ScopedElement
A class for holding application data structures.
Methods
value |
getNamespace()
Get the value of the namespace. |
from ScopedElement |
setNamespace($v $v)
Set the value of the namespace. |
from ScopedElement | |
value |
getPackage()
Get the value of package. |
from ScopedElement |
setPackage($v $v)
Set the value of package. |
from ScopedElement | |
value |
getSchema()
Get the value of schema. |
from ScopedElement |
setSchema($v $v)
Set the value of schema. |
from ScopedElement | |
__construct(string $name = null)
Constructs a new Database object. |
||
PropelPlatformInterface |
getPlatform()
Returns the PropelPlatformInterface implementation for this database. |
|
setPlatform(PropelPlatformInterface $platform)
Sets the PropelPlatformInterface implementation for this database. |
||
getName()
Get the name of the Database |
||
setName($name)
Set the name of the Database |
||
string |
getBaseClass()
Get the value of baseClass. |
|
setBaseClass(string $v)
Set the value of baseClass. |
||
string |
getBasePeer()
Get the value of basePeer. |
|
setBasePeer(string $v)
Set the value of basePeer. |
||
string |
getDefaultIdMethod()
Get the value of defaultIdMethod. |
|
setDefaultIdMethod(string $v)
Set the value of defaultIdMethod. |
||
string |
getDefaultPhpNamingMethod()
Get the value of defaultPHPNamingMethod which specifies the method for converting schema names for table and column to PHP names. |
|
setDefaultPhpNamingMethod(string $v)
Set the value of defaultPHPNamingMethod. |
||
string |
getDefaultTranslateMethod()
Get the value of defaultTranslateMethod which specifies the method for translate validator error messages. |
|
setDefaultStringFormat(string $defaultStringFormat)
Set the default string format for ActiveRecord objects in this Db. |
||
string |
getDefaultStringFormat()
Get the default string format for ActiveRecord objects in this Db. |
|
setDefaultTranslateMethod(string $v)
Set the value of defaultTranslateMethod. |
||
boolean |
isHeavyIndexing()
Get the value of heavyIndexing. |
|
boolean |
getHeavyIndexing()
Get the value of heavyIndexing. |
|
setHeavyIndexing(boolean $v)
Set the value of heavyIndexing. |
||
Table[] |
getTables()
Return the list of all tables |
|
integer |
countTables()
Return the number of tables in the database |
|
array |
getTablesForSql()
Return the list of all tables that have a SQL representation |
|
boolean |
hasTable(string $name, boolean $caseInsensitive = false)
Check whether the database has a table. |
|
Table |
getTable(string $name, boolean $caseInsensitive = false)
Return the table with the specified name. |
|
boolean |
hasTableByPhpName(string $phpName)
Check whether the database has a table. |
|
Table |
getTableByPhpName(string $phpName)
Return the table with the specified phpName. |
|
addTable($data)
An utility method to add a new table from an xml attribute. |
||
setAppData(AppData $parent)
Set the parent of the database |
||
AppData |
getAppData()
Get the parent of the table |
|
Domain |
addDomain(Domain|string $data)
Adds Domain object from |
|
Domain |
getDomain($domainName)
Get already configured Domain object by name. |
|
getGeneratorConfig()
|
||
getBuildProperty($key)
|
||
Behavior |
addBehavior($bdata)
Adds a new Behavior to the database |
|
Array |
getBehaviors()
Get the database behaviors |
|
boolean |
hasBehavior(string $name)
check if the database has a behavior by name |
|
Behavior |
getBehavior(string $name)
Get one database behavior by name |
|
string |
getTablePrefix()
Get the table prefix for this database |
|
Behavior |
getNextTableBehavior()
Get the next behavior on all tables, ordered by behavior priority, and skipping the ones that were already executed, |
|
doFinalInitialization()
|
||
appendXml(DOMNode $node)
|
Details
in ScopedElement at line 73
public value
getNamespace()
Get the value of the namespace.
in ScopedElement at line 83
public
setNamespace($v $v)
Set the value of the namespace.
in ScopedElement at line 100
public value
getPackage()
Get the value of package.
in ScopedElement at line 110
public
setPackage($v $v)
Set the value of package.
in ScopedElement at line 124
public value
getSchema()
Get the value of schema.
in ScopedElement at line 134
public
setSchema($v $v)
Set the value of schema.
at line 92
public
__construct(string $name = null)
Constructs a new Database object.
at line 121
public PropelPlatformInterface
getPlatform()
Returns the PropelPlatformInterface implementation for this database.
at line 131
public
setPlatform(PropelPlatformInterface $platform)
Sets the PropelPlatformInterface implementation for this database.
at line 139
public
getName()
Get the name of the Database
at line 147
public
setName($name)
Set the name of the Database
at line 157
public string
getBaseClass()
Get the value of baseClass.
at line 167
public
setBaseClass(string $v)
Set the value of baseClass.
at line 177
public string
getBasePeer()
Get the value of basePeer.
at line 187
public
setBasePeer(string $v)
Set the value of basePeer.
at line 197
public string
getDefaultIdMethod()
Get the value of defaultIdMethod.
at line 207
public
setDefaultIdMethod(string $v)
Set the value of defaultIdMethod.
at line 218
public string
getDefaultPhpNamingMethod()
Get the value of defaultPHPNamingMethod which specifies the method for converting schema names for table and column to PHP names.
at line 228
public
setDefaultPhpNamingMethod(string $v)
Set the value of defaultPHPNamingMethod.
at line 239
public string
getDefaultTranslateMethod()
Get the value of defaultTranslateMethod which specifies the method for translate validator error messages.
at line 249
public
setDefaultStringFormat(string $defaultStringFormat)
Set the default string format for ActiveRecord objects in this Db.
at line 259
public string
getDefaultStringFormat()
Get the default string format for ActiveRecord objects in this Db.
at line 269
public
setDefaultTranslateMethod(string $v)
Set the value of defaultTranslateMethod.
at line 282
public boolean
isHeavyIndexing()
Get the value of heavyIndexing.
This is a synonym for getHeavyIndexing().
at line 292
public boolean
getHeavyIndexing()
Get the value of heavyIndexing.
at line 302
public
setHeavyIndexing(boolean $v)
Set the value of heavyIndexing.
at line 312
public Table[]
getTables()
Return the list of all tables
at line 322
public integer
countTables()
Return the number of tables in the database
at line 339
public array
getTablesForSql()
Return the list of all tables that have a SQL representation
at line 359
public boolean
hasTable(string $name, boolean $caseInsensitive = false)
Check whether the database has a table.
at line 376
public Table
getTable(string $name, boolean $caseInsensitive = false)
Return the table with the specified name.
at line 396
public boolean
hasTableByPhpName(string $phpName)
Check whether the database has a table.
at line 408
public Table
getTableByPhpName(string $phpName)
Return the table with the specified phpName.
at line 420
public
addTable($data)
An utility method to add a new table from an xml attribute.
at line 462
public
setAppData(AppData $parent)
Set the parent of the database
at line 472
public AppData
getAppData()
Get the parent of the table
at line 484
public Domain
addDomain(Domain|string $data)
Adds Domain object from
at line 506
public Domain
getDomain($domainName)
Get already configured Domain object by name.
at line 515
public
getGeneratorConfig()
at line 524
public
getBuildProperty($key)
at line 538
public Behavior
addBehavior($bdata)
Adds a new Behavior to the database
at line 560
public Array
getBehaviors()
Get the database behaviors
at line 572
public boolean
hasBehavior(string $name)
check if the database has a behavior by name
at line 584
public Behavior
getBehavior(string $name)
Get one database behavior by name
at line 594
public string
getTablePrefix()
Get the table prefix for this database
at line 605
public Behavior
getNextTableBehavior()
Get the next behavior on all tables, ordered by behavior priority, and skipping the ones that were already executed,
at line 624
public
doFinalInitialization()
at line 671
public
appendXml(DOMNode $node)