Propel API
Class

Inheritance

class Inheritance extends XMLElement

A Class for information regarding possible objects representing a table

Methods

loadFromXML(array $attributes)

This is the entry point method for loading data from XML.

 from XMLElement
array getAttributes()

Returns the assoc array of attributes.

 from XMLElement
mixed getAttribute(string $name, mixed $defaultValue = null)

Gets a particular attribute by [case-insensitive] name.

 from XMLElement
appendXml(DOMNode $node)

VendorInfo addVendorInfo(mixed $data)

Sets an associated VendorInfo object.

 from XMLElement
VendorInfo getVendorInfoForType($type)

Gets the any associated VendorInfo object.

 from XMLElement
string getConfiguredBehavior(string $bname)

Find the best class name for a given behavior Looks in build.properties for path like propel.behavior.[bname].class If not found, tries to autoload [Bname]Behavior If no success, returns 'Behavior'

 from XMLElement
toString()

String representation of the current object.

 from XMLElement
__toString()

Magic string method

 from XMLElement
value getKey()

Get the value of key.
setKey(v $v)

Set the value of key.
value getColumn()

Get the value of parent.
setColumn(Column $v)

Set the value of parent.
value getClassName()

Get the value of className.
setClassName(v $v)

Set the value of className.
value getPackage()

Get the value of package.
setPackage(v $v)

Set the value of package.
value getAncestor()

Get the value of ancestor.
setAncestor(v $v)

Set the value of ancestor.

Details

in XMLElement at line 47
public loadFromXML(array $attributes)

This is the entry point method for loading data from XML.

It calls a setupObject() method that must be implemented by the child class.

Parameters

array $attributes The attributes for the XML tag.

in XMLElement at line 58
public array getAttributes()

Returns the assoc array of attributes.

All attribute names (keys) are lowercase.

Return Value

array

in XMLElement at line 70
public mixed getAttribute(string $name, mixed $defaultValue = null)

Gets a particular attribute by [case-insensitive] name.

If attribute is not set then the $defaultValue is returned.

Parameters

string $name The [case-insensitive] name of the attribute to lookup.
mixed $defaultValue The default value to use in case the attribute is not set.

Return Value

mixed The value of the attribute or $defaultValue if not set.

at line 135
public appendXml(DOMNode $node)

Parameters

DOMNode $node

See also

XMLElement::appendXml(DOMNode)

in XMLElement at line 127
public VendorInfo addVendorInfo(mixed $data)

Sets an associated VendorInfo object.

Parameters

mixed $data VendorInfo object or XML attrib data (array)

Return Value

VendorInfo

in XMLElement at line 146
public VendorInfo getVendorInfoForType($type)

Gets the any associated VendorInfo object.

Parameters

$type

Return Value

VendorInfo

in XMLElement at line 166
public string getConfiguredBehavior(string $bname)

Find the best class name for a given behavior Looks in build.properties for path like propel.behavior.[bname].class If not found, tries to autoload [Bname]Behavior If no success, returns 'Behavior'

Parameters

string $bname behavior name, e.g. 'timestampable'

Return Value

string behavior class name, e.g. 'TimestampableBehavior'

Exceptions

InvalidArgumentException

in XMLElement at line 189
public toString()

String representation of the current object.

This is an xml representation with the XML declaration removed.

See also

appendXml()

in XMLElement at line 203
public __toString()

Magic string method

See also

toString()

at line 46
public value getKey()

Get the value of key.

Return Value

value of key.

at line 55
public setKey(v $v)

Set the value of key.

Parameters

v $v Value to assign to key.

at line 64
public value getColumn()

Get the value of parent.

Return Value

value of parent.

at line 73
public setColumn(Column $v)

Set the value of parent.

Parameters

Column $v Value to assign to parent.

at line 82
public value getClassName()

Get the value of className.

Return Value

value of className.

at line 91
public setClassName(v $v)

Set the value of className.

Parameters

v $v Value to assign to className.

at line 100
public value getPackage()

Get the value of package.

Return Value

value of package.

at line 109
public setPackage(v $v)

Set the value of package.

Parameters

v $v Value to assign to package.

at line 118
public value getAncestor()

Get the value of ancestor.

Return Value

value of ancestor.

at line 127
public setAncestor(v $v)

Set the value of ancestor.

Parameters

v $v Value to assign to ancestor.