class QueryInheritanceBuilder extends OMBuilder
Generates the empty PHP5 stub query class for use with single table inheritance.
This class produces the empty stub class that can be customized with application business logic, custom behavior, etc.
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 name of the current class being built. |
|
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 the package for the [base] object classes. |
|
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. |
|
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(string $hookName, string $modifier)
Checks whether any registered behavior on that table has a modifier for a hook |
from OMBuilder |
applyBehaviorModifierBase(string $hookName, string $modifier, string $script, string $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 | |
fixTrailingWhitespaces($matches)
|
from OMBuilder | |
setChild(Inheritance $child)
Set the child object that we're operating on currently. |
||
Inheritance |
getChild()
Returns the child object we're operating on currently. |
Details
in OMBuilder 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.
in OMBuilder 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 37
public string
getUnprefixedClassname()
Returns the name of the current class being built.
in OMBuilder at line 110
public string
getClassname()
Returns the prefixed classname that is being built by the current class.
in OMBuilder at line 120
public string
getFullyQualifiedClassname()
Returns the namespaced classname if there is a namespace, and the raw classname otherwise
in OMBuilder at line 134
public string
getClasspath()
Gets the dot-path representation of current class being built.
in OMBuilder at line 150
public string
getClassFilePath()
Gets the full path to the file for the current class.
at line 47
public string
getPackage()
Gets the package for the [base] object classes.
in OMBuilder at line 176
public string
getPackagePath()
Returns filesystem path for current package.
at line 52
public string
getNamespace()
Return the user-defined namespace for this table, or the database namespace otherwise.
in OMBuilder at line 202
public
declareClassNamespace($class, $namespace = '')
in OMBuilder at line 210
public
declareClass($fullyQualifiedClassName)
in OMBuilder at line 221
public
declareClassFromBuilder($builder)
in OMBuilder at line 226
public
declareClasses()
in OMBuilder at line 234
public
getDeclaredClasses($namespace = null)
in OMBuilder at line 243
public
getNamespaceStatement()
in OMBuilder at line 253
public
getUseStatements($ignoredNamespace = null)
in OMBuilder 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.
in OMBuilder 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.
in OMBuilder 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.
in OMBuilder at line 319
public string
getColumnConstant(Column $col, string $classname = null)
Get the column constant name (e.g.
PeerName::COLUMN_NAME).
in OMBuilder at line 345
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 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.
in OMBuilder 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.
in OMBuilder at line 527
public boolean
hasBehaviorModifier(string $hookName, string $modifier)
Checks whether any registered behavior on that table has a modifier for a hook
in OMBuilder 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
in OMBuilder at line 578
public
getBehaviorContentBase(string $contentName, string $modifier)
Checks whether any registered behavior content creator on that table exists a contentName
in OMBuilder at line 627
public
fixTrailingWhitespaces($matches)
at line 68
public
setChild(Inheritance $child)
Set the child object that we're operating on currently.
at line 79
public Inheritance
getChild()
Returns the child object we're operating on currently.