Propel API
Class

ScopedElement

abstract class ScopedElement extends XMLElement

Data about an element with a name and optional namespace/schema/package attributes

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)

Appends DOM elements to represent this object in XML.

 from XMLElement
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 getNamespace()

Get the value of the namespace.
setNamespace(v $v)

Set the value of the namespace.
value getPackage()

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

Set the value of package.
value getSchema()

Get the value of schema.
setSchema(v $v)

Set the value of schema.

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.

in XMLElement at line 119
abstract public appendXml(DOMNode $node)

Appends DOM elements to represent this object in XML.

Parameters

DOMNode $node

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 71
public value getNamespace()

Get the value of the namespace.

Return Value

value of namespace.

at line 80
public setNamespace(v $v)

Set the value of the namespace.

Parameters

v $v Value to assign to namespace.

at line 96
public value getPackage()

Get the value of package.

Return Value

value of package.

at line 105
public setPackage(v $v)

Set the value of package.

Parameters

v $v Value to assign to package.

at line 118
public value getSchema()

Get the value of schema.

Return Value

value of schema.

at line 127
public setSchema(v $v)

Set the value of schema.

Parameters

v $v Value to assign to schema.