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

Package DE_EPAGES::ImageGallery::API::Object::ImageGallery

object interface for ImageGallery.

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

Functions

addImage
addImagesFromDirectory
className
createURI
dbPackage
deleteFiles
featureName
requiredChildClass

addImage

Adds the image to the image gallery and generates all preview images.

Syntax
$ImageGallery->addImage($File, $Position);
Input
$File (string)
path of the file to add, relative to Site root
$Position (int)
child position (optional)

addImagesFromDirectory

Updates the content of the image gallery by looking into $ImageDirectory, which must be underneath the MediaGallery root. The file list is not recursive, due to preview image directories, that are created in the same directory.

Syntax
$ImageGallery->addImagesFromDirectory($ImageDirectory);
Input
$ImageDirectory (string)
directory to add images from, default is ImageDirectory
attribute from image gallery (optional)
$IgnoreErrors (boolean)
skip errornuous files, default is false (optional)

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $ImageGallery->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 = $ImageGallery->dbPackage;
Return
$DbPackage (String)
database package name

deleteFiles

Deletes the directories PublicPath, PrivatePath. If Site.IsFilePathPartUsed and defined FilePathPart the directories will not deleted. Delete the directory StaticPath.

Syntax
$Object->deleteFiles;

featureName

Returns the feature name ('ImageGallery').

Syntax
$FeatureName = $ImageGallery->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"