Propel API
Class

QueryBuilder

class QueryBuilder extends OMBuilder

Generates a PHP5 base Query class for user object model (OM).

This class produces the base query class (e.g. BaseBookQuery) which contains all
the custom-built query 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 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
getNamespace()

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
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.

Return Value

string The resulting PHP sourcecode.

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.

Parameters

$objName
$clsName

Return Value

string Some code

at line 49
public string getUnprefixedClassname()

Returns the name of the current class being built.

Return Value

string

in OMBuilder at line 103
public string getClassname()

Returns the prefixed classname that is being built by the current class.

Return Value

string

See also

DataModelBuilder#prefixClassname()

in OMBuilder at line 112
public string getFullyQualifiedClassname()

Returns the namespaced classname if there is a namespace, and the raw classname otherwise

Return Value

string

in OMBuilder at line 125
public string getClasspath()

Gets the dot-path representation of current class being built.

Return Value

string

in OMBuilder at line 139
public string getClassFilePath()

Gets the full path to the file for the current class.

Return Value

string

at line 29
public string getPackage()

Gets the package for the [base] object classes.

Return Value

string

in OMBuilder at line 162
public string getPackagePath()

Returns filesystem path for current package.

Return Value

string

at line 34
public getNamespace()

in OMBuilder at line 184
public declareClassNamespace($class, $namespace = '')

Parameters

$class
$namespace

in OMBuilder at line 193
public declareClass($fullyQualifiedClassName)

Parameters

$fullyQualifiedClassName

in OMBuilder at line 204
public declareClassFromBuilder($builder)

Parameters

$builder

in OMBuilder at line 209
public declareClasses()

in OMBuilder at line 217
public getDeclaredClasses($namespace = null)

Parameters

$namespace

in OMBuilder at line 226
public getNamespaceStatement()

in OMBuilder at line 236
public getUseStatements($ignoredNamespace = null)

Parameters

$ignoredNamespace

in OMBuilder at line 259
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.

Return Value

string (e.g. 'MyPeer')

See also

StubPeerBuilder::getClassname()

in OMBuilder at line 270
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.

Return Value

string (e.g. 'Myquery')

See also

StubQueryBuilder::getClassname()

in OMBuilder at line 281
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.

Return Value

string (e.g. 'My')

See also

StubPeerBuilder::getClassname()

in OMBuilder at line 293
public string getColumnConstant(Column $col, string $classname = null)

Get the column constant name (e.g.

PeerName::COLUMN_NAME).

Parameters

Column $col The column we need a name for.
string $classname The Peer classname to use.

Return Value

string If $classname is provided, then will return $classname::COLUMN_NAME; if not, then the peername is looked up for current table to yield $currTablePeer::COLUMN_NAME.

in OMBuilder at line 317
public string getBasePeer(Table $table)

Gets the basePeer path if specified for table/db.

If not, will return 'propel.util.BasePeer'

Parameters

Table $table

Return Value

string

in OMBuilder at line 364
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.

Parameters

ForeignKey $fk The local FK that we need a name for.
boolean $plural Whether the php name should be plural (e.g. initRelatedObjs() vs. addRelatedObj()

Return Value

string

in OMBuilder at line 424
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.

Parameters

ForeignKey $fk The referrer FK that we need a name for.
boolean $plural Whether the php name should be plural (e.g. initRelatedObjs() vs. addRelatedObj()

Return Value

string

at line 1393
public boolean hasBehaviorModifier($hookName, $modifier = null)

Checks whether any registered behavior on that table has a modifier for a hook

Parameters

$hookName
$modifier

Return Value

boolean

in OMBuilder at line 503
public applyBehaviorModifierBase($hookName, $modifier, $script, $tab = ' ')

Checks whether any registered behavior on that table has a modifier for a hook

Parameters

$hookName
$modifier
$script
$tab

in OMBuilder at line 531
public getBehaviorContentBase(string $contentName, string $modifier)

Checks whether any registered behavior content creator on that table exists a contentName

Parameters

string $contentName The name of the content as called from one of this class methods, e.g. "parentClassname"
string $modifier The name of the modifier object providing the method in the behavior

at line 1403
public applyBehaviorModifier($hookName, $script, $tab = ' ')

Checks whether any registered behavior on that table has a modifier for a hook

Parameters

$hookName
$script
$tab

at line 1412
public getBehaviorContent(string $contentName)

Checks whether any registered behavior content creator on that table exists a contentName

Parameters

string $contentName The name of the content as called from one of this class methods, e.g. "parentClassname"