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

Package DE_EPAGES::Forum::API::Object::Forum

object interface for Forum.

Base
DE_EPAGES::Content::API::Object::ContentObject

Functions

checkPostDelay
className
createURI
dbPackage
featureName
requiredChildClass

checkPostDelay

Returns whether the user is allowed to post again.

Syntax
$IsAllowed = $Forum->checkPostDelay($User, $UserIP);
Example
my $IsAllowed = $Forum->checkPostDelay($User, $UserIP);
Input
$User (object)
the user to check for
$RemoteIP (object)
use this ip to check if the user is not defined
Return
$IsAllowed (boolean)
user is allowed to post again

className

Returns the class name, used for DAL access.

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

createURI

Returns a suggestion for a short url.

Syntax
$URI = $Object->createURI($Name, $Parent, $LanguageID);
Return
$URI (string)
suggested URI

dbPackage

Returns the database package, used for DAL access.

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

featureName

Returns the feature name (class name).

Syntax
$FeatureName = $Forum->featureName;
Return
$FeatureName (String)
feature name

requiredChildClass

Returns the name of the class a new child is required to be an instance of or undef if no class is allowed (no children).

Syntax
$RequiredChildClass = $ContentObject->requiredChildClass;
Return
$RequiredChildClass (String)
name of a class, i.e. "Object"