abstract class ObjectBuilder extends OMBuilder
Base class for Peer-building classes.
This class is designed so that it can be extended by a PHP4PeerBuilder in addition
to the "standard" PHP5PeerBuilder and PHP5ComplexOMPeerBuilder. Hence, this class
should not have any actual template code in it -- simply basic logic & utility
methods.
Methods
string |
build()
Builds the PHP source for current class and returns it as a string. |
from OMBuilder |
string |
buildObjectInstanceCreationCode($objName, $clsName)
Creates a $obj = new Book(); code snippet. |
from OMBuilder |
string |
getUnprefixedClassname()
Returns the qualified (prefixed) classname that is being built by the current class. |
from OMBuilder |
string |
getClassname()
Returns the prefixed classname that is being built by the current class. |
from OMBuilder |
string |
getFullyQualifiedClassname()
Returns the namespaced classname if there is a namespace, and the raw classname otherwise |
from OMBuilder |
string |
getClasspath()
Gets the dot-path representation of current class being built. |
from OMBuilder |
string |
getClassFilePath()
Gets the full path to the file for the current class. |
from OMBuilder |
string |
getPackage()
Gets package name for this table. |
from OMBuilder |
string |
getPackagePath()
Returns filesystem path for current package. |
from OMBuilder |
string |
getNamespace()
Return the user-defined namespace for this table, or the database namespace otherwise. |
from OMBuilder |
declareClassNamespace($class, $namespace = '') | from OMBuilder | |
declareClass($fullyQualifiedClassName) | from OMBuilder | |
declareClassFromBuilder($builder) | from OMBuilder | |
declareClasses() | from OMBuilder | |
getDeclaredClasses($namespace = null) | from OMBuilder | |
getNamespaceStatement() | from OMBuilder | |
getUseStatements($ignoredNamespace = null) | from OMBuilder | |
string |
getPeerClassname()
Shortcut method to return the [stub] peer classname for current table. |
from OMBuilder |
string |
getQueryClassname()
Shortcut method to return the [stub] query classname for current table. |
from OMBuilder |
string |
getObjectClassname()
Returns the object classname for current table. |
from OMBuilder |
string |
getColumnConstant(Column $col, string $classname = null)
Get the column constant name (e.g. |
from OMBuilder |
string |
getBasePeer(Table $table)
Gets the basePeer path if specified for table/db. |
from OMBuilder |
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). |
from OMBuilder |
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. |
from OMBuilder |
boolean |
hasBehaviorModifier($hookName, $modifier = null)
Checks whether any registered behavior on that table has a modifier for a hook |
|
applyBehaviorModifierBase($hookName, $modifier, $script, $tab = ' ')
Checks whether any registered behavior on that table has a modifier for a hook |
from OMBuilder | |
getBehaviorContentBase(string $contentName, string $modifier)
Checks whether any registered behavior content creator on that table exists a contentName |
from OMBuilder | |
__construct(Table $table)
Constructs a new PeerBuilder subclass. |
||
applyBehaviorModifier($hookName, $script, $tab = ' ')
Checks whether any registered behavior on that table has a modifier for a hook |
||
getBehaviorContent(string $contentName)
Checks whether any registered behavior content creator on that table exists a contentName |
Details
in OMBuilder at line 42
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.
in OMBuilder at line 86
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.
in OMBuilder at line 96
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.
in OMBuilder at line 103
public string
getClassname()
Returns the prefixed classname that is being built by the current class.
in OMBuilder at line 112
public string
getFullyQualifiedClassname()
Returns the namespaced classname if there is a namespace, and the raw classname otherwise
in OMBuilder at line 125
public string
getClasspath()
Gets the dot-path representation of current class being built.
in OMBuilder at line 140
public string
getClassFilePath()
Gets the full path to the file for the current class.
in OMBuilder at line 150
public string
getPackage()
Gets package name for this table.
This is overridden by child classes that have different packages.
in OMBuilder at line 164
public string
getPackagePath()
Returns filesystem path for current package.
in OMBuilder at line 185
public string
getNamespace()
Return the user-defined namespace for this table, or the database namespace otherwise.
in OMBuilder at line 190
public
declareClassNamespace($class, $namespace = '')
in OMBuilder at line 199
public
declareClass($fullyQualifiedClassName)
in OMBuilder at line 210
public
declareClassFromBuilder($builder)
in OMBuilder at line 215
public
declareClasses()
in OMBuilder at line 223
public
getDeclaredClasses($namespace = null)
in OMBuilder at line 232
public
getNamespaceStatement()
in OMBuilder at line 242
public
getUseStatements($ignoredNamespace = null)
in OMBuilder at line 266
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.
in OMBuilder at line 278
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.
in OMBuilder at line 290
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.
in OMBuilder at line 305
public string
getColumnConstant(Column $col, string $classname = null)
Get the column constant name (e.g.
PeerName::COLUMN_NAME).
in OMBuilder at line 330
public string
getBasePeer(Table $table)
Gets the basePeer path if specified for table/db.
If not, will return 'propel.util.BasePeer'
in OMBuilder at line 380
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.
in OMBuilder at line 443
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 190
public boolean
hasBehaviorModifier($hookName, $modifier = null)
Checks whether any registered behavior on that table has a modifier for a hook
in OMBuilder at line 524
public
applyBehaviorModifierBase($hookName, $modifier, $script, $tab = ' ')
Checks whether any registered behavior on that table has a modifier for a hook
in OMBuilder at line 552
public
getBehaviorContentBase(string $contentName, string $modifier)
Checks whether any registered behavior content creator on that table exists a contentName
at line 30
public
__construct(Table $table)
Constructs a new PeerBuilder subclass.
at line 200
public
applyBehaviorModifier($hookName, $script, $tab = ' ')
Checks whether any registered behavior on that table has a modifier for a hook
at line 209
public
getBehaviorContent(string $contentName)
Checks whether any registered behavior content creator on that table exists a contentName