ePages 6.17.39 - DE_EPAGES/Object/API/Object/Attribute.pm

Package DE_EPAGES::Object::API::Object::Attribute

object interface for Attribute.

Base
DE_EPAGES::Object::API::Object::Object

Functions

className
dbPackage
defaultValue
existsPreDefAttributeValue
isArray
isCacheable
isObject
package
preDefAttributeValue
type

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $Attribute->className;
Return
$ClassName (String)
class name

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $Attribute->dbPackage;
Return
$DbPackage (String)
database package name

defaultValue

Returns the value of the attribute 'DefaultValue'. This is an optimized version of $Attribute->get('DefaultValue').

Syntax
$DefaultValue = $Attribute->defaultValue;
Return
$DefaultValue (string)
default value

existsPreDefAttributeValue

Returns true if a pre-defined value with the given alias exists for this attribute.

Syntax
$Exists = $Attribute->existsPreDefAttributeValue( $ValueAlias );
Input
$ValueAlias (ref.hash)
alias of the pre-defined attribute value
Return
$Exists (boolean)
true if the value exists

isArray

Returns the value of the attribute 'IsArray'. This is an optimized version of $Attribute->get('IsArray').

Syntax
$IsArray = $Attribute->isArray;
Return
$IsArray (boolean)
true if IsArray is true

isCacheable

Returns the value of the attribute 'IsCacheable'. This is an optimized version of $Attribute->get('IsCacheable').

Syntax
$IsCacheable = $Attribute->isCacheable;
Return
$IsCacheable (boolean)
true if IsCacheable is true

isObject

Returns the value of the attribute 'IsObject'. This is an optimized version of $Attribute->get('IsObject').

Syntax
$IsObject = $Attribute->isObject;
Return
$IsObject (boolean)
true if IsObject is true

package

Returns the package that implements this attribute. This is an optimized version of $Attribute->get('Package').

Syntax
$Package = $Attribute->package;
Return
$Package (string)
package name

preDefAttributeValue

Returns the pre-defined attribute value with the given alias.

Syntax
$Value = $Attribute->preDefAttributeValue( $ValueAlias );
Input
$ValueAlias (ref.hash)
alias of the pre-defined attribute value
Return
$Value (DE_EPAGES::Object::API::Object::PreDefAttribute)
attribute value object

type

Returns the value of the attribute 'Type'. This is an optimized version of $Attribute->get('Type').

Syntax
$Type = $Attribute->type;
Return
$Type (string)
attribute type