Propel API
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:
<code>
propel.builder.object.class = builder.om.PHP5ObjectNoCollectionBuilder
</code>

Methods

string getPackage()

Gets the package for the [base] object classes.

from PHP5ObjectBuilder
getNamespace()

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 29
public string getPackage()

Gets the package for the [base] object classes.

Return Value

string

in PHP5ObjectBuilder at line 34
public getNamespace()

in PHP5ObjectBuilder at line 49
public string getUnprefixedClassname()

Returns the name of the current class being built.

Return Value

string

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

Adds the comment for a temporal accessor

Parameters

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

See also

addTemporalAccessor

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

Adds the function declaration for a temporal accessor

Parameters

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

See also

addTemporalAccessor

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

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

Parameters

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

See also

addDefaultAccessor()

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

Adds the function declaration for a default accessor

Parameters

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

See also

addDefaultAccessor()

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

Adds the comment for a mutator

Parameters

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

See also

addMutatorOpen()

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

Adds the mutator function declaration

Parameters

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

See also

addMutatorOpen()

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

Parameters

$script
Column $col

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

Parameters

$script
Column $col

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

Constructs variable name for fkey-related objects.

Parameters

ForeignKey $fk

Return Value

string

in PHP5ObjectBuilder at line 2905
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 2916
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