Propel 2 API
Class

Propel\Generator\Model\Inheritance

class Inheritance extends MappingModel

A class for information regarding possible objects representing a table.

Methods

__construct()

from MappingModel
loadMapping(array $attributes)

Loads a mapping definition from an array.

from MappingModel
array getAttributes()

Returns all definition attributes.

from MappingModel
mixed getAttribute(string $name, mixed $default = null)

Returns a particular attribute by a case-insensitive name.

from MappingModel
appendXml(DOMNode $node)

Appends DOM elements to represent this object in XML.

VendorInfo addVendorInfo(VendorInfo|array $vendor)

Adds a new VendorInfo instance to this current model object.

from MappingModel
VendorInfo getVendorInfoForType(string $type)

Returns a VendorInfo object by its type.

from MappingModel
string getConfiguredBehavior(string $behavior)

Returns the best class name for a given behavior.

from MappingModel
string toString()

String representation of the current object.

from MappingModel
string __toString()

String representation of the current object.

from MappingModel
string getKey()

Returns a key name.

setKey(string $key)

Sets a key name.

Column getColumn()

Returns the parent column.

setColumn(Column $column)

Sets the parent column

string getClassName()

Returns the class name.

setClassName(string $name)

Sets the class name.

string getPackage()

Returns the package.

setPackage(string $package)

Sets the package.

string getAncestor()

Returns the ancestor value.

setAncestor(string $ancestor)

Sets the ancestor.

Details

in MappingModel at line 27
public __construct()

in MappingModel at line 38
public loadMapping(array $attributes)

Loads a mapping definition from an array.

Parameters

array $attributes

in MappingModel at line 58
public array getAttributes()

Returns all definition attributes.

All attribute names (keys) are lowercase.

Return Value

array

in MappingModel at line 73
public mixed getAttribute(string $name, mixed $default = null)

Returns a particular attribute by a case-insensitive name.

If the attribute is not set, then the second default value is
returned instead.

Parameters

string $name
mixed $default

Return Value

mixed

at line 136
public appendXml(DOMNode $node)

Appends DOM elements to represent this object in XML.

Parameters

DOMNode $node

in MappingModel at line 138
public VendorInfo addVendorInfo(VendorInfo|array $vendor)

Adds a new VendorInfo instance to this current model object.

Parameters

VendorInfo|array $vendor

Return Value

VendorInfo

in MappingModel at line 158
public VendorInfo getVendorInfoForType(string $type)

Returns a VendorInfo object by its type.

Parameters

string $type

Return Value

VendorInfo

in MappingModel at line 176
public string getConfiguredBehavior(string $behavior)

Returns the best class name for a given behavior.

If not found, the method tries to autoload \Propel\Generator\Behavior\[Bname]\[Bname]Behavior

Parameters

string $behavior The behavior name (ie: timestampable)

Return Value

string $class The behavior fully qualified class name

Exceptions

BehaviorNotFoundException

in MappingModel at line 198
public string toString()

String representation of the current object.

Return Value

string

in MappingModel at line 213
public string __toString()

String representation of the current object.

Return Value

string

at line 33
public string getKey()

Returns a key name.

Return Value

string

at line 43
public setKey(string $key)

Sets a key name.

Parameters

string $key

at line 53
public Column getColumn()

Returns the parent column.

Return Value

Column

at line 63
public setColumn(Column $column)

Sets the parent column

Parameters

Column $column

at line 73
public string getClassName()

Returns the class name.

Return Value

string

at line 83
public setClassName(string $name)

Sets the class name.

Parameters

string $name

at line 93
public string getPackage()

Returns the package.

Return Value

string

at line 103
public setPackage(string $package)

Sets the package.

Parameters

string $package

at line 113
public string getAncestor()

Returns the ancestor value.

Return Value

string

at line 123
public setAncestor(string $ancestor)

Sets the ancestor.

Parameters

string $ancestor