Propel 2 API
Class

Propel\Generator\Model\VendorInfo

class VendorInfo extends MappingModel

Object to hold vendor specific information.

Methods

__construct(string $type = null)

Creates a new VendorInfo instance.

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
setType(string $type)

Sets the RDBMS type for this vendor specific information.

string getType()

Returns the RDBMS type for this vendor specific information.

setParameter(string $name, mixed $value)

Sets a parameter value.

mixed getParameter(string $name)

Returns a parameter value.

boolean hasParameter(string $name)

Returns whether or not a parameter exists.

setParameters(array $parameters = array())

Sets an associative array of parameters for vendor specific information.

array getParameters()

Returns an associative array of parameters for vendor specific information.

boolean isEmpty()

Returns whether or not this vendor info is empty.

VendorInfo getMergedVendorInfo(VendorInfo $info)

Returns a new VendorInfo object that combines two VendorInfo objects.

Details

at line 29
public __construct(string $type = null)

Creates a new VendorInfo instance.

Parameters

string $type RDBMS type (optional)

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 145
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 45
public setType(string $type)

Sets the RDBMS type for this vendor specific information.

Parameters

string $type

at line 55
public string getType()

Returns the RDBMS type for this vendor specific information.

Return Value

string

at line 66
public setParameter(string $name, mixed $value)

Sets a parameter value.

Parameters

string $name The parameter name
mixed $value The parameter value

at line 77
public mixed getParameter(string $name)

Returns a parameter value.

Parameters

string $name The parameter name

Return Value

mixed

at line 88
public boolean hasParameter(string $name)

Returns whether or not a parameter exists.

Parameters

string $name

Return Value

boolean

at line 98
public setParameters(array $parameters = array())

Sets an associative array of parameters for vendor specific information.

Parameters

array $parameters Parameter data.

at line 109
public array getParameters()

Returns an associative array of parameters for vendor specific information.

Return Value

array

at line 119
public boolean isEmpty()

Returns whether or not this vendor info is empty.

Return Value

boolean

at line 130
public VendorInfo getMergedVendorInfo(VendorInfo $info)

Returns a new VendorInfo object that combines two VendorInfo objects.

Parameters

VendorInfo $info

Return Value

VendorInfo