Class

PHP5PeerBuilder

class PHP5PeerBuilder extends PeerBuilder

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

This class produces the base peer class (e.g. BaseMyPeer) which contains all the custom-built query and manipulator methods.

Methods

__construct(Table $table)

Constructs a new PeerBuilder subclass.

 from PeerBuilder
string getRetrieveMethodName()

Returns the retrieveByPK method name to use for this table.

 from PeerBuilder
static string getColumnName(Column $col, string $phpName = null)

COMPATIBILITY: Get the column constant name (e.g.

 from PeerBuilder
boolean hasBehaviorModifier(string $hookName, string $modifier = null)

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

 from PeerBuilder
applyBehaviorModifier($hookName, $script, $tab = ' ')

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

 from PeerBuilder
getBehaviorContent(string $contentName)

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

 from PeerBuilder
string getBasePeerClassname()

Get the BasePeer class name for the current table (e.g.

 from PeerBuilder
string getUnprefixedClassname()

Returns the name of the current class being built.
string getPackage()

Gets the package for the [base] peer classes.
getNamespace()

getTableMapClass()

getTablePhpName()

addInheritanceColumnConstants(string $script)

Adds the CLASSKEY* and CLASSNAME* constants used for inheritance.
string getInstancePoolKeySnippet(array $pkphp)

Adds the PHP code to return a instance pool key for the passed-in primary key variable names.
addCriteriaJoin($fk, $table, $joinTable, $joinedTablePeerBuilder)

Details

in PeerBuilder at line 33
public __construct(Table $table)

Constructs a new PeerBuilder subclass.

Parameters

Table $table

in PeerBuilder at line 248
public string getRetrieveMethodName()

Returns the retrieveByPK method name to use for this table.

If the table is an alias then the method name looks like "retrieveTablenameByPK" otherwise simply "retrieveByPK".

Return Value

string

in PeerBuilder at line 272
static public string getColumnName(Column $col, string $phpName = null)

COMPATIBILITY: Get the column constant name (e.g.

PeerName::COLUMN_NAME).

This method exists simply because it belonged to the 'PeerBuilder' that this class is replacing (because of name conflict more than actual functionality overlap). When the new builder model is finished this method will be removed.

Parameters

Column $col The column we need a name for.
string $phpName The PHP Name of the peer class. The 'Peer' is appended automatically.

Return Value

string If $phpName is provided, then will return {$phpName}Peer::COLUMNNAME; if not, just COLUMNNAME.

in PeerBuilder at line 294
public boolean hasBehaviorModifier(string $hookName, string $modifier = null)

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

Parameters

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

Return Value

boolean

in PeerBuilder at line 305
public applyBehaviorModifier($hookName, $script, $tab = ' ')

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

Parameters

$hookName
$script
$tab

in PeerBuilder at line 315
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"

in PeerBuilder at line 325
public string getBasePeerClassname()

Get the BasePeer class name for the current table (e.g.

'BasePeer')

Return Value

string The Base Peer Class name

at line 60
public string getUnprefixedClassname()

Returns the name of the current class being built.

Return Value

string

at line 70
public string getPackage()

Gets the package for the [base] peer classes.

Return Value

string

at line 75
public getNamespace()

at line 183
public getTableMapClass()

at line 195
public getTablePhpName()

at line 611
public addInheritanceColumnConstants(string $script)

Adds the CLASSKEY* and CLASSNAME* constants used for inheritance.

Parameters

string $script The script will be modified in this method.

at line 888
public string getInstancePoolKeySnippet(array $pkphp)

Adds the PHP code to return a instance pool key for the passed-in primary key variable names.

Parameters

array $pkphp An array of PHP var names / method calls representing complete pk.

Return Value

string

at line 2221
public addCriteriaJoin($fk, $table, $joinTable, $joinedTablePeerBuilder)

Parameters

$fk
$table
$joinTable
$joinedTablePeerBuilder