Class

PHP5ObjectNoCollectionBuilder

class PHP5ObjectNoCollectionBuilder extends PHP5ObjectBuilder

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

This class produces the base object class (e.g. BaseMyTable) which contains all the custom-built accessor and setter methods.

This class overrides PHP5BaseObject to use Peer methods and Criteria instead of Query objects for fetching foreign keys. This can be useful if some legacy Propel 1.4 code assumes that the getters returns arrays instead of collections.

This class is not used by default. You must override the propel.builder.object.class setting in build.properties to use it: propel.builder.object.class = builder.om.PHP5ObjectNoCollectionBuilder

Methods

string getPackage()

Gets the package for the [base] object classes.

from PHP5ObjectBuilder
getNamespace()

from PHP5ObjectBuilder
string getDefaultKeyType()

Returns default key type.

from PHP5ObjectBuilder
string getUnprefixedClassname()

Returns the name of the current class being built.

from PHP5ObjectBuilder
addTemporalAccessorComment(string $script, Column $col)

Adds the comment for a temporal accessor

from PHP5ObjectBuilder
addTemporalAccessorOpen(string $script, Column $col)

Adds the function declaration for a temporal accessor

from PHP5ObjectBuilder
addDefaultAccessorComment(string $script, Column $col)

Add the comment for a default accessor method (a getter)

from PHP5ObjectBuilder
addDefaultAccessorOpen(string $script, Column $col)

Adds the function declaration for a default accessor

from PHP5ObjectBuilder
addMutatorComment(string $script, Column $col)

Adds the comment for a mutator

from PHP5ObjectBuilder
addMutatorOpenOpen(string $script, Column $col)

Adds the mutator function declaration

from PHP5ObjectBuilder
addTemporalMutatorComment($script, Column $col)

from PHP5ObjectBuilder
addBooleanMutatorComment($script, Column $col)

from PHP5ObjectBuilder
string getFKVarName(ForeignKey $fk)

Constructs variable name for fkey-related objects.

from PHP5ObjectBuilder
string getRefFKCollVarName(ForeignKey $fk)

Constructs variable name for objects which referencing current table by specified foreign key.

from PHP5ObjectBuilder
string getPKRefFKVarName(ForeignKey $fk)

Constructs variable name for single object which references current table by specified foreign key which is ALSO a primary key (hence one-to-one relationship).

from PHP5ObjectBuilder

Details

in PHP5ObjectBuilder at line 30
public string getPackage()

Gets the package for the [base] object classes.

Return Value

string

in PHP5ObjectBuilder at line 35
public getNamespace()

in PHP5ObjectBuilder at line 51
public string getDefaultKeyType()

Returns default key type.

if not presented in configuration default will be 'TYPE_PHPNAME'

Return Value

string

in PHP5ObjectBuilder at line 63
public string getUnprefixedClassname()

Returns the name of the current class being built.

Return Value

string

in PHP5ObjectBuilder at line 821
public addTemporalAccessorComment(string $script, Column $col)

Adds the comment for a temporal accessor

Parameters

string $script The script will be modified in this method.
Column $col The current column.

See also

addTemporalAccessor

in PHP5ObjectBuilder at line 877
public addTemporalAccessorOpen(string $script, Column $col)

Adds the function declaration for a temporal accessor

Parameters

string $script The script will be modified in this method.
Column $col The current column.

See also

addTemporalAccessor

in PHP5ObjectBuilder at line 1250
public addDefaultAccessorComment(string $script, Column $col)

Add the comment for a default accessor method (a getter)

Parameters

string $script The script will be modified in this method.
Column $col The current column.

See also

addDefaultAccessor()

in PHP5ObjectBuilder at line 1275
public addDefaultAccessorOpen(string $script, Column $col)

Adds the function declaration for a default accessor

Parameters

string $script The script will be modified in this method.
Column $col The current column.

See also

addDefaultAccessor()

in PHP5ObjectBuilder at line 1489
public addMutatorComment(string $script, Column $col)

Adds the comment for a mutator

Parameters

string $script The script will be modified in this method.
Column $col The current column.

See also

addMutatorOpen()

in PHP5ObjectBuilder at line 1509
public addMutatorOpenOpen(string $script, Column $col)

Adds the mutator function declaration

Parameters

string $script The script will be modified in this method.
Column $col The current column.

See also

addMutatorOpen()

in PHP5ObjectBuilder at line 1725
public addTemporalMutatorComment($script, Column $col)

Parameters

$script
Column $col

in PHP5ObjectBuilder at line 1954
public addBooleanMutatorComment($script, Column $col)

Parameters

$script
Column $col

in PHP5ObjectBuilder at line 3298
public string getFKVarName(ForeignKey $fk)

Constructs variable name for fkey-related objects.

Parameters

ForeignKey $fk

Return Value

string

in PHP5ObjectBuilder at line 3310
public string getRefFKCollVarName(ForeignKey $fk)

Constructs variable name for objects which referencing current table by specified foreign key.

Parameters

ForeignKey $fk

Return Value

string

in PHP5ObjectBuilder at line 3323
public string getPKRefFKVarName(ForeignKey $fk)

Constructs variable name for single object which references current table by specified foreign key which is ALSO a primary key (hence one-to-one relationship).

Parameters

ForeignKey $fk

Return Value

string