Propel API
Class

AlternativeCodingStandardsBehavior

class AlternativeCodingStandardsBehavior extends Behavior

Changes the coding standard of Propel generated Model classes - Opening brackets always use newline, e.g.

if ($foo) {
...
} else {
...
}
Becomes:
if ($foo)
{
...
}
else
{
...
}
- closing comments are removed, e.g.
} // save()
Becomes:
}
- tabs are replaced by 2 whitespaces
- comments are stripped (optional)

Methods

setName(string $name)

Sets the name of the Behavior

 from Behavior
string getName()

Returns the name of the Behavior

 from Behavior
setTable(Table $table)

Sets the table this behavior is applied to

 from Behavior
Table getTable()

Returns the table this behavior is applied to

 from Behavior
setDatabase(Database $database)

Sets the database this behavior is applied to

 from Behavior
Database getDatabase()

Returns the table this behavior is applied to if behavior is applied to <database> element.

 from Behavior
addParameter(array $attribute)

Add a parameter Expects an associative array looking like array('name' => 'foo', 'value' => bar)

 from Behavior
setParameters(array $parameters)

Overrides the behavior parameters Expects an associative array looking like array('foo' => 'bar')

 from Behavior
array getParameters()

Get the associative array of parameters

 from Behavior
getParameter($name)

from Behavior
setTableModificationOrder($tableModificationOrder $tableModificationOrder)

Define when this behavior must execute its modifyTable() relative to other behaviors.

 from Behavior
integer getTableModificationOrder()

Get when this behavior must execute its modifyTable() relative to other behaviors.

 from Behavior
modifyDatabase()

This method is automatically called on database behaviors when the database model is finished Propagate the behavior to the tables of the database Override this method to have a database behavior do something special

 from Behavior
modifyTable()

This method is automatically called on table behaviors when the database model is finished Override it to add columns to the current table

 from Behavior
setTableModified($bool)

from Behavior
isTableModified()

from Behavior
string renderTemplate(string $filename, array $vars = array(), string $templateDir = '/templates/')

Use Propel's simple templating system to render a PHP file using variables passed as arguments.

 from Behavior
ColumnMap getColumnForParameter(string $param)

Retrieve a column object using a name stored in the behavior parameters Useful for table behaviors

 from Behavior
appendXml(DOMNode $node)

from Behavior
getTableModifier()

from Behavior
getObjectBuilderModifier()

from Behavior
getQueryBuilderModifier()

from Behavior
getPeerBuilderModifier()

from Behavior
getTableMapBuilderModifier()

from Behavior
hasAdditionalBuilders()

from Behavior
getAdditionalBuilders()

from Behavior
objectFilter($script)

extensionObjectFilter($script)

queryFilter($script)

extensionQueryFilter($script)

peerFilter($script)

extensionPeerFilter($script)

tableMapFilter($script)

static string stripComments(string $code)

Remove inline and codeblock comments from a PHP code string

Details

in Behavior at line 38
public setName(string $name)

Sets the name of the Behavior

Parameters

string $name the name of the behavior

in Behavior at line 48
public string getName()

Returns the name of the Behavior

Return Value

string

in Behavior at line 58
public setTable(Table $table)

Sets the table this behavior is applied to

Parameters

Table $table the table this behavior is applied to

in Behavior at line 68
public Table getTable()

Returns the table this behavior is applied to

Return Value

Table

in Behavior at line 78
public setDatabase(Database $database)

Sets the database this behavior is applied to

Parameters

Database $database the database this behavior is applied to

in Behavior at line 88
public Database getDatabase()

Returns the table this behavior is applied to if behavior is applied to <database> element.

Return Value

Database

in Behavior at line 99
public addParameter(array $attribute)

Add a parameter Expects an associative array looking like array('name' => 'foo', 'value' => bar)

Parameters

array $attribute associative array with name and value keys

in Behavior at line 111
public setParameters(array $parameters)

Overrides the behavior parameters Expects an associative array looking like array('foo' => 'bar')

Parameters

array $parameters associative array

in Behavior at line 120
public array getParameters()

Get the associative array of parameters

Return Value

array

in Behavior at line 125
public getParameter($name)

Parameters

$name

in Behavior at line 136
public setTableModificationOrder($tableModificationOrder $tableModificationOrder)

Define when this behavior must execute its modifyTable() relative to other behaviors.

The bigger the value, the later the behavior is executed. Default is 50.

Parameters

$tableModificationOrder $tableModificationOrder integer

in Behavior at line 147
public integer getTableModificationOrder()

Get when this behavior must execute its modifyTable() relative to other behaviors.

The bigger the value, the later the behavior is executed. Default is 50.

Return Value

integer

in Behavior at line 157
public modifyDatabase()

This method is automatically called on database behaviors when the database model is finished Propagate the behavior to the tables of the database Override this method to have a database behavior do something special

in Behavior at line 170
public modifyTable()

This method is automatically called on table behaviors when the database model is finished Override it to add columns to the current table

in Behavior at line 174
public setTableModified($bool)

Parameters

$bool

in Behavior at line 179
public isTableModified()

in Behavior at line 194
public string renderTemplate(string $filename, array $vars = array(), string $templateDir = '/templates/')

Use Propel's simple templating system to render a PHP file using variables passed as arguments.

Parameters

string $filename The template file name, relative to the behavior's dirname
array $vars An associative array of argumens to be rendered
string $templateDir The name of the template subdirectory

Return Value

string The rendered template

in Behavior at line 235
public ColumnMap getColumnForParameter(string $param)

Retrieve a column object using a name stored in the behavior parameters Useful for table behaviors

Parameters

string $param Name of the parameter storing the column name

Return Value

ColumnMap The column of the table supporting the behavior

in Behavior at line 252
public appendXml(DOMNode $node)

Parameters

DOMNode $node

See also

parent::appendXml(DOMNode)

in Behavior at line 266
public getTableModifier()

in Behavior at line 271
public getObjectBuilderModifier()

in Behavior at line 276
public getQueryBuilderModifier()

in Behavior at line 281
public getPeerBuilderModifier()

in Behavior at line 286
public getTableMapBuilderModifier()

in Behavior at line 291
public hasAdditionalBuilders()

in Behavior at line 296
public getAdditionalBuilders()

at line 50
public objectFilter($script)

Parameters

$script

at line 55
public extensionObjectFilter($script)

Parameters

$script

at line 60
public queryFilter($script)

Parameters

$script

at line 65
public extensionQueryFilter($script)

Parameters

$script

at line 70
public peerFilter($script)

Parameters

$script

at line 75
public extensionPeerFilter($script)

Parameters

$script

at line 80
public tableMapFilter($script)

Parameters

$script

at line 119
static public string stripComments(string $code)

Remove inline and codeblock comments from a PHP code string

Parameters

string $code The input code

Return Value

string The input code, without comments