Propel API
Class

PHP5NodePeerBuilder

class PHP5NodePeerBuilder extends PeerBuilder

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

This class produces the base tree node object class (e.g. BaseMyTable) which contains all
the custom-built accessor and setter 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($hookName, $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 getPackage()

Gets the package for the [base] object classes.
string getUnprefixedClassname()

Returns the name of the current class being built.

Details

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

Constructs a new PeerBuilder subclass.

Parameters

Table $table

in PeerBuilder at line 234
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 258
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::COLUMN_NAME; if not, just COLUMN_NAME.

in PeerBuilder at line 277
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 PeerBuilder at line 287
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 296
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 306
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 29
public string getPackage()

Gets the package for the [base] object classes.

Return Value

string

at line 38
public string getUnprefixedClassname()

Returns the name of the current class being built.

Return Value

string