ePages 6.10 - DE_EPAGES/Object/API/Object/BaseObject.pm

Package DE_EPAGES::Object::API::Object::BaseObject

object interface for BaseObjects.

Base
DE_EPAGES::Core::API::Object::BaseObject

Functions

class
defaultAttributes
id
instanceOf
onDeleteClass
recursiveGet
reset
tleHash

class

Returns the class of an object

Syntax
$Class = $BaseObject->class;
Return
$Class (object)
class object, see DE_EPAGES::Object::API::Object::Class

defaultAttributes

default for old base objects.

Syntax
$Object->defaultAttributes;

id

Returns the base-object id.

Syntax
$BaseObjectID = $BaseObject->id;
Return
$BaseObjectID (int)
object id

instanceOf

Returns true if the object is an instance of the class or one of its sub classes.

Syntax
$IsInstance = $BaseObject->instanceOf( $Class )
$IsInstance = $BaseObject->instanceOf( $ClassName )
Example
my $ClassProduct = LoadClassByAlias( 'Product' );
if( $Object->instanceOf( $ClassProduct ) ) { ... }
if( $Object->instanceOf('Product' ) ) { ... }
Input
$ClassName (object)
name of class (or object of class) | string
Return
$IsInstance (boolean)
true if the object is an instance of the class

onDeleteClass

Called before the class of this object is deleted. The default implementation calls $self->delete.

Syntax
$BaseObject->onDeleteClass;

recursiveGet

Obsolete. Do not use.

reset

Removes internal cache key class.

Syntax
$Object->reset;

tleHash

Returns a tied hash for the TLE compiler.

Syntax
$BaseObject->tleHash;