ePages 6.10 - DE_EPAGES/Presentation/API/Object/Form.pm

Package DE_EPAGES::Presentation::API::Object::Form

object interface for Form.

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

Functions

className
dbPackage
findXML
formData
id
primaryKey

className

Returns the class name, used for DAL access.

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

dbPackage

Returns the database package, used for DAL access.

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

findXML

find an form from an XML file by class and name.

Syntax
$ObjectID = DE_EPAGES::Object::API::Object::Object->findXML($Handler, $hElement, $Class, $hAttributes);
Input
$Handler (object)
xml import handler with support function addObject
$hElement (ref.hash)
XML element structure, see XML::SAX
$Class (object)
class object; the new object will be an instance of this class
$hAttributes (ref.hash)
attributes hash
Return
$ObjectID (string)
the existing object id or undef

formData

Return form fields and loops.

Syntax
my $hFormData = $Form->formData;
Return
$hFormData (ref.hash)
collected form data, keys
  • FormName | name of form | string
  • Loops | loops info with loop fields keys: loop names | ref.hash.hash
  • LoopInfo | Loops info with out Fields | ref.hash.hash
  • Fields | field infos keys: field names| ref.hash.hash

id

Returns the Form id.

Syntax
$FormID = $Form->id;
Return
$FormID (int)
form id

primaryKey

Returns the name of the primary key.

Syntax
$PrimaryKey = $Form->primaryKey;
Return
$PrimaryKey (String)
primimary key