abstract class OMBuilder extends DataModelBuilder
Baseclass for OM-building classes.
OM-building classes are those that build a PHP (or other) class to service a single table. This includes Peer classes, Entity classes, Map classes, Node classes, Nested Set classes, etc.
Methods
__construct(Table $table)
Creates new instance of DataModelBuilder subclass. |
from DataModelBuilder | |
PeerBuilder |
getPeerBuilder()
Returns new or existing Peer builder class for this table. |
from DataModelBuilder |
Pluralizer |
getPluralizer()
Returns new or existing Pluralizer class. |
from DataModelBuilder |
PeerBuilder |
getStubPeerBuilder()
Returns new or existing stub Peer builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getObjectBuilder()
Returns new or existing Object builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getStubObjectBuilder()
Returns new or existing stub Object builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getQueryBuilder()
Returns new or existing Query builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getStubQueryBuilder()
Returns new or existing stub Query builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getTableMapBuilder()
Returns new or existing Object builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getInterfaceBuilder()
Returns new or existing stub Interface builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getMultiExtendObjectBuilder()
Returns new or existing stub child object builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getNodeBuilder()
Returns new or existing node Object builder class for this table. |
from DataModelBuilder |
PeerBuilder |
getNodePeerBuilder()
Returns new or existing node Peer builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getStubNodeBuilder()
Returns new or existing stub node Object builder class for this table. |
from DataModelBuilder |
PeerBuilder |
getStubNodePeerBuilder()
Returns new or existing stub node Peer builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getNestedSetBuilder()
Returns new or existing nested set object builder class for this table. |
from DataModelBuilder |
PeerBuilder |
getNestedSetPeerBuilder()
Returns new or existing nested set Peer builder class for this table. |
from DataModelBuilder |
DataSQLBuilder |
getDataSQLBuilder()
Returns new or existing data sql builder class for this table. |
from DataModelBuilder |
DataModelBuilder |
getNewBuilder(Table $table, string $classname)
Gets a new data model builder class for specified table and classname. |
from DataModelBuilder |
PeerBuilder |
getNewPeerBuilder(Table $table)
Convenience method to return a NEW Peer class builder instance. |
from DataModelBuilder |
PeerBuilder |
getNewStubPeerBuilder(Table $table)
Convenience method to return a NEW Peer stub class builder instance. |
from DataModelBuilder |
ObjectBuilder |
getNewObjectBuilder(Table $table)
Convenience method to return a NEW Object class builder instance. |
from DataModelBuilder |
ObjectBuilder |
getNewStubObjectBuilder(Table $table)
Convenience method to return a NEW Object stub class builder instance. |
from DataModelBuilder |
QueryBuilder |
getNewQueryBuilder(Table $table)
Convenience method to return a NEW query class builder instance. |
from DataModelBuilder |
QueryBuilder |
getNewStubQueryBuilder(Table $table)
Convenience method to return a NEW query stub class builder instance. |
from DataModelBuilder |
ObjectBuilder |
getNewQueryInheritanceBuilder($child)
Returns new Query Inheritance builder class for this table. |
from DataModelBuilder |
ObjectBuilder |
getNewStubQueryInheritanceBuilder($child)
Returns new stub Query Inheritance builder class for this table. |
from DataModelBuilder |
GeneratorConfig |
getGeneratorConfig()
Gets the GeneratorConfig object. |
from DataModelBuilder |
string |
getBuildProperty(string $name)
Get a specific [name transformed] build property. |
from DataModelBuilder |
setGeneratorConfig(GeneratorConfigInterface $v)
Sets the GeneratorConfig object. |
from DataModelBuilder | |
setTable(Table $table)
Sets the table for this builder. |
from DataModelBuilder | |
Table |
getTable()
Returns the current Table object. |
from DataModelBuilder |
PropelPlatformInterface |
getPlatform()
Convenience method to returns the Platform class for this table (database). |
from DataModelBuilder |
setPlatform(PropelPlatformInterface $platform)
Platform setter |
from DataModelBuilder | |
Database |
getDatabase()
Convenience method to returns the database for current table. |
from DataModelBuilder |
array |
getWarnings()
Gets array of warning messages. |
from DataModelBuilder |
string |
quoteIdentifier(string $text)
Wraps call to Platform->quoteIdentifier() with a check to see whether quoting is enabled. |
from DataModelBuilder |
string |
prefixClassname($identifier)
Returns the name of the current class being built, with a possible prefix. |
from DataModelBuilder |
string |
build()
Builds the PHP source for current class and returns it as a string. |
|
string |
buildObjectInstanceCreationCode($objName, $clsName)
Creates a $obj = new Book(); code snippet. |
|
string |
getUnprefixedClassname()
Returns the qualified (prefixed) classname that is being built by the current class. |
|
string |
getClassname()
Returns the prefixed classname that is being built by the current class. |
|
string |
getFullyQualifiedClassname()
Returns the namespaced classname if there is a namespace, and the raw classname otherwise |
|
string |
getClasspath()
Gets the dot-path representation of current class being built. |
|
string |
getClassFilePath()
Gets the full path to the file for the current class. |
|
string |
getPackage()
Gets package name for this table. |
|
string |
getPackagePath()
Returns filesystem path for current package. |
|
string |
getNamespace()
Return the user-defined namespace for this table, or the database namespace otherwise. |
|
declareClassNamespace($class, $namespace = '')
|
||
declareClass($fullyQualifiedClassName)
|
||
declareClassFromBuilder($builder)
|
||
declareClasses()
|
||
getDeclaredClasses($namespace = null)
|
||
getNamespaceStatement()
|
||
getUseStatements($ignoredNamespace = null)
|
||
string |
getPeerClassname()
Shortcut method to return the [stub] peer classname for current table. |
|
string |
getQueryClassname()
Shortcut method to return the [stub] query classname for current table. |
|
string |
getObjectClassname()
Returns the object classname for current table. |
|
string |
getColumnConstant(Column $col, string $classname = null)
Get the column constant name (e.g. |
|
string |
getBasePeer(Table $table)
Gets the basePeer path if specified for table/db. |
|
string |
getFKPhpNameAffix(ForeignKey $fk, boolean $plural = false)
Gets the PHP method name affix to be used for fkeys for the current table (not referrers to this table). |
|
string |
getRefFKPhpNameAffix(ForeignKey $fk, boolean $plural = false)
Gets the PHP method name affix to be used for referencing foreign key methods and variable names (e.g. |
|
boolean |
hasBehaviorModifier(string $hookName, string $modifier)
Checks whether any registered behavior on that table has a modifier for a hook |
|
applyBehaviorModifierBase(string $hookName, string $modifier, string $script, string $tab = ' ')
Checks whether any registered behavior on that table has a modifier for a hook |
||
getBehaviorContentBase(string $contentName, string $modifier)
Checks whether any registered behavior content creator on that table exists a contentName |
||
fixTrailingWhitespaces($matches)
|
Details
in DataModelBuilder at line 180
public
__construct(Table $table)
Creates new instance of DataModelBuilder subclass.
in DataModelBuilder at line 190
public PeerBuilder
getPeerBuilder()
Returns new or existing Peer builder class for this table.
in DataModelBuilder at line 204
public Pluralizer
getPluralizer()
Returns new or existing Pluralizer class.
in DataModelBuilder at line 218
public PeerBuilder
getStubPeerBuilder()
Returns new or existing stub Peer builder class for this table.
in DataModelBuilder at line 232
public ObjectBuilder
getObjectBuilder()
Returns new or existing Object builder class for this table.
in DataModelBuilder at line 246
public ObjectBuilder
getStubObjectBuilder()
Returns new or existing stub Object builder class for this table.
in DataModelBuilder at line 260
public ObjectBuilder
getQueryBuilder()
Returns new or existing Query builder class for this table.
in DataModelBuilder at line 274
public ObjectBuilder
getStubQueryBuilder()
Returns new or existing stub Query builder class for this table.
in DataModelBuilder at line 288
public ObjectBuilder
getTableMapBuilder()
Returns new or existing Object builder class for this table.
in DataModelBuilder at line 302
public ObjectBuilder
getInterfaceBuilder()
Returns new or existing stub Interface builder class for this table.
in DataModelBuilder at line 316
public ObjectBuilder
getMultiExtendObjectBuilder()
Returns new or existing stub child object builder class for this table.
in DataModelBuilder at line 330
public ObjectBuilder
getNodeBuilder()
Returns new or existing node Object builder class for this table.
in DataModelBuilder at line 344
public PeerBuilder
getNodePeerBuilder()
Returns new or existing node Peer builder class for this table.
in DataModelBuilder at line 358
public ObjectBuilder
getStubNodeBuilder()
Returns new or existing stub node Object builder class for this table.
in DataModelBuilder at line 372
public PeerBuilder
getStubNodePeerBuilder()
Returns new or existing stub node Peer builder class for this table.
in DataModelBuilder at line 386
public ObjectBuilder
getNestedSetBuilder()
Returns new or existing nested set object builder class for this table.
in DataModelBuilder at line 400
public PeerBuilder
getNestedSetPeerBuilder()
Returns new or existing nested set Peer builder class for this table.
in DataModelBuilder at line 414
public DataSQLBuilder
getDataSQLBuilder()
Returns new or existing data sql builder class for this table.
in DataModelBuilder at line 431
public DataModelBuilder
getNewBuilder(Table $table, string $classname)
Gets a new data model builder class for specified table and classname.
in DataModelBuilder at line 449
public PeerBuilder
getNewPeerBuilder(Table $table)
Convenience method to return a NEW Peer class builder instance.
This is used very frequently from the peer and object builders to get a peer builder for a RELATED table.
in DataModelBuilder at line 464
public PeerBuilder
getNewStubPeerBuilder(Table $table)
Convenience method to return a NEW Peer stub class builder instance.
This is used from the peer and object builders to get a peer builder for a RELATED table.
in DataModelBuilder at line 479
public ObjectBuilder
getNewObjectBuilder(Table $table)
Convenience method to return a NEW Object class builder instance.
This is used very frequently from the peer and object builders to get an object builder for a RELATED table.
in DataModelBuilder at line 494
public ObjectBuilder
getNewStubObjectBuilder(Table $table)
Convenience method to return a NEW Object stub class builder instance.
This is used from the query builders to get an object builder for a RELATED table.
in DataModelBuilder at line 509
public QueryBuilder
getNewQueryBuilder(Table $table)
Convenience method to return a NEW query class builder instance.
This is used from the query builders to get a query builder for a RELATED table.
in DataModelBuilder at line 524
public QueryBuilder
getNewStubQueryBuilder(Table $table)
Convenience method to return a NEW query stub class builder instance.
This is used from the query builders to get a query builder for a RELATED table.
in DataModelBuilder at line 534
public ObjectBuilder
getNewQueryInheritanceBuilder($child)
Returns new Query Inheritance builder class for this table.
in DataModelBuilder at line 547
public ObjectBuilder
getNewStubQueryInheritanceBuilder($child)
Returns new stub Query Inheritance builder class for this table.
in DataModelBuilder at line 560
public GeneratorConfig
getGeneratorConfig()
Gets the GeneratorConfig object.
in DataModelBuilder at line 572
public string
getBuildProperty(string $name)
Get a specific [name transformed] build property.
in DataModelBuilder at line 586
public
setGeneratorConfig(GeneratorConfigInterface $v)
Sets the GeneratorConfig object.
in DataModelBuilder at line 596
public
setTable(Table $table)
Sets the table for this builder.
in DataModelBuilder at line 606
public Table
getTable()
Returns the current Table object.
in DataModelBuilder at line 616
public PropelPlatformInterface
getPlatform()
Convenience method to returns the Platform class for this table (database).
in DataModelBuilder at line 633
public
setPlatform(PropelPlatformInterface $platform)
Platform setter
in DataModelBuilder at line 643
public Database
getDatabase()
Convenience method to returns the database for current table.
in DataModelBuilder at line 665
public array
getWarnings()
Gets array of warning messages.
in DataModelBuilder at line 681
public string
quoteIdentifier(string $text)
Wraps call to Platform->quoteIdentifier() with a check to see whether quoting is enabled.
All subclasses should call this quoteIdentifier() method rather than calling the Platform method directly. This method is used by both DataSQLBuilder and DDLBuilder, and potentially in the OM builders also, which is why it is defined in this class.
in DataModelBuilder at line 696
public string
prefixClassname($identifier)
Returns the name of the current class being built, with a possible prefix.
at line 43
public string
build()
Builds the PHP source for current class and returns it as a string.
This is the main entry point and defines a basic structure that classes should follow. In most cases this method will not need to be overridden by subclasses. This method does assume that the output language is PHP code, so it will need to be overridden if this is not the case.
at line 91
public string
buildObjectInstanceCreationCode($objName, $clsName)
Creates a $obj = new Book(); code snippet.
Can be used by frameworks, for instance, to extend this behavior, e.g. initialize the object after creating the instance or so.
at line 102
abstract public string
getUnprefixedClassname()
Returns the qualified (prefixed) classname that is being built by the current class.
This method must be implemented by child classes.
at line 110
public string
getClassname()
Returns the prefixed classname that is being built by the current class.
at line 120
public string
getFullyQualifiedClassname()
Returns the namespaced classname if there is a namespace, and the raw classname otherwise
at line 134
public string
getClasspath()
Gets the dot-path representation of current class being built.
at line 150
public string
getClassFilePath()
Gets the full path to the file for the current class.
at line 161
public string
getPackage()
Gets package name for this table.
This is overridden by child classes that have different packages.
at line 176
public string
getPackagePath()
Returns filesystem path for current package.
at line 197
public string
getNamespace()
Return the user-defined namespace for this table, or the database namespace otherwise.
at line 202
public
declareClassNamespace($class, $namespace = '')
at line 210
public
declareClass($fullyQualifiedClassName)
at line 221
public
declareClassFromBuilder($builder)
at line 226
public
declareClasses()
at line 234
public
getDeclaredClasses($namespace = null)
at line 243
public
getNamespaceStatement()
at line 253
public
getUseStatements($ignoredNamespace = null)
at line 278
public string
getPeerClassname()
Shortcut method to return the [stub] peer classname for current table.
This is the classname that is used whenever object or peer classes want to invoke methods of the peer classes.
at line 291
public string
getQueryClassname()
Shortcut method to return the [stub] query classname for current table.
This is the classname that is used whenever object or peer classes want to invoke methods of the query classes.
at line 304
public string
getObjectClassname()
Returns the object classname for current table.
This is the classname that is used whenever object or peer classes want to invoke methods of the object classes.
at line 319
public string
getColumnConstant(Column $col, string $classname = null)
Get the column constant name (e.g.
PeerName::COLUMN_NAME).
at line 345
public string
getBasePeer(Table $table)
Gets the basePeer path if specified for table/db.
If not, will return 'propel.util.BasePeer'
at line 398
public string
getFKPhpNameAffix(ForeignKey $fk, boolean $plural = false)
Gets the PHP method name affix to be used for fkeys for the current table (not referrers to this table).
The difference between this method and the getRefFKPhpNameAffix() method is that in this method the classname in the affix is the foreign table classname.
at line 462
public string
getRefFKPhpNameAffix(ForeignKey $fk, boolean $plural = false)
Gets the PHP method name affix to be used for referencing foreign key methods and variable names (e.g.
set????(), $coll???).
The difference between this method and the getFKPhpNameAffix() method is that in this method the classname in the affix is the classname of the local fkey table.
at line 527
public boolean
hasBehaviorModifier(string $hookName, string $modifier)
Checks whether any registered behavior on that table has a modifier for a hook
at line 547
public
applyBehaviorModifierBase(string $hookName, string $modifier, string $script, string $tab = ' ')
Checks whether any registered behavior on that table has a modifier for a hook
at line 578
public
getBehaviorContentBase(string $contentName, string $modifier)
Checks whether any registered behavior content creator on that table exists a contentName
at line 627
public
fixTrailingWhitespaces($matches)