Propel API
Class

ColumnDefaultValue

class ColumnDefaultValue

A class for holding a column default value.

Constants

TYPE_VALUE

TYPE_EXPR

Methods

__construct(string $value, string $type = null)

Creates a new DefaultValue object.

string getType()

setType(string $type)

boolean isExpression()

Convenience method to indicate whether the value in this object is an expression (as opposed to simple value).

string getValue()

setValue(string $value)

boolean equals(ColumnDefaultValue $other)

A method to compare if two Default values match

Details

at line 40
public __construct(string $value, string $type = null)

Creates a new DefaultValue object.

Parameters

string $value The default value, as specified in the schema.
string $type The type of default value (DefaultValue::TYPE_VALUE or DefaultValue::TYPE_EXPR)

at line 51
public string getType()

Return Value

string The type of default value (DefaultValue::TYPE_VALUE or DefaultValue::TYPE_EXPR)

at line 59
public setType(string $type)

Parameters

string $type The type of default value (DefaultValue::TYPE_VALUE or DefaultValue::TYPE_EXPR)

at line 69
public boolean isExpression()

Convenience method to indicate whether the value in this object is an expression (as opposed to simple value).

Return Value

boolean Whether value this object holds is an expression.

at line 77
public string getValue()

Return Value

string The value, as specified in the schema.

at line 85
public setValue(string $value)

Parameters

string $value The value, as specified in the schema.

at line 97
public boolean equals(ColumnDefaultValue $other)

A method to compare if two Default values match

Parameters

ColumnDefaultValue $other The value to compare to

Return Value

boolean Wheter this object represents same default value as $other