Package DE_EPAGES::Core::API::Object::BaseObject
base class for all objects
Functions
- _deleteAttribute
- _existsAttribute
- default
- definedAttributes
- delete
- deleteSelf
- deleteXML
- deleteXMLEnd
- exportXML
- exportXMLAttributes
- exportXMLElements
- exportableAttributes
- get
- importXML
- importXMLEnd
- new
- recursiveGet
- set
- template
- tleHash
_deleteAttribute
delete attribute if exists.
Syntax |
$Object->_deleteAttribute($Name); |
Input |
|
_existsAttribute
Returns true if attribute exists (not if it's defined).
Syntax |
$hValues = $Object->_existsAttribute($Name); |
Input |
|
Return |
|
default
Returns default attribute values for new objects. Used by DE_EPAGES::Object::Object::Class::defaultAttributes
Syntax |
$hValues = #Package::API::Object::#Name->default( $Parent, $aNames, $hInfo ); |
Example |
$hDefaults = $Class->defaultAttributes($Parent, $hInfo); # for insert a new object $hDefaults = $Object->class->defaultAttributes($Object->parent, $hValues); # for an existing object |
Input |
|
Return |
|
definedAttributes
Returns all defined attribute values.
Syntax |
$hValues = $Object->definedAttributes; |
Return |
|
delete
calls $self->deleteSelf.
Syntax |
$Object->delete; |
deleteSelf
deletes an basic object (this dummy function does nothing)
Syntax |
$Object->deleteSelf; |
deleteXML
place holder to delete xml data see DE_EPAGES::Object::API::Object::Object::deleteXML. This function will be called at start tag. The end tag calls deleteXMLEnd.
Syntax |
$Object = DE_EPAGES::Object::API::BaseObject->deleteXML($Handler, $hElement, $hAttributes); |
Input |
|
Return |
|
deleteXMLEnd
place holder to delete xml data see DE_EPAGES::Object::API::Object::Object::deleteXML. This function will be called at end tag. The object will be created on start tag.
Syntax |
$Object->deleteXMLEnd($Handler, $hElement, $hAttributes); |
Input |
|
exportXML
Returns all attributes of object to XML export driver. This base function adds plain and localized attributes in the Attributes hash.
Syntax |
$Object->exportXML($Driver); |
Input |
|
Return |
|
exportXMLAttributes
Returns plain attribute values of the object to XML export driver, i.e. all attributes that are not localizable, objects, hashes or arrays.
Syntax |
$hAttributes = $Object->exportXMLAttributes( $hAttributes, $hAllAttributes ); |
Input |
|
Return |
|
exportXMLElements
place holder to export xml data to export sub elements of this object.
Syntax |
$Object->exportXMLElements($Driver, $hAllAttributes); |
Input |
|
exportableAttributes
Returns all defined attribute values (used for export object).
Syntax |
$hValues = $Object->exportableAttributes; |
Return |
|
get
Returns one or more attribute values.
Syntax |
$Value = $Object->get( $Name ); $hValues = $Object->get( $aNames ); |
Example |
$Password = $Object->get( 'Password' ); $Password = $Object->get( ['Login', 'Password'] )->{'Password'}; |
Input |
|
Return |
|
importXML
place holder to import xml data see DE_EPAGES::Object::API::Object::Object::importXML. This function will be called at start tag. The end tag calls importXMLEnd.
Syntax |
$Object = DE_EPAGES::Object::API::BaseObject->importXML($Handler, $hElement, $Class, $hAttributes); |
Input |
|
Return |
|
importXMLEnd
place holder to import xml data see DE_EPAGES::Object::API::Object::Object::importXML. This function will be called at end tag. The object will be created on start tag.
Syntax |
$Object->importXMLEnd($Handler, $hElement, $hAttributes); |
Input |
|
new
creates an basic object, which is not saved at database as object.
Syntax |
$Object = DE_EPAGES::Core::API::BaseObject->new('ObjectID' => $ObjectID ); |
Input |
|
Return |
|
recursiveGet
Obsolete. Do not use.
set
Sets attribute values of an object.
Syntax |
$Object->set( $Key, $Value ); $Object->set( $hValues ); |
Example |
$Object->set( 'Login', 'ich'); $Object->set( { Login => 'ich', Password => 'geheim' } ); |
Input |
|
template
this function can overwrite the given template name.
Syntax |
$Name = $Object->template($Name); |
Input |
|
Return |
|
tleHash
returns the tied hash for tle compiler
Syntax |
$Object->tleHash; |