Class: LLModule

Class:LLModule
Description:Basic class for all modules
File:/include/llmodule.php
CVS Version:1.20
CVS Modification:2004-08-14 18:26
Variables:
NameTypeDefaultDescription
sTitleString
sDescriptionString
iModuleIdInteger0
iModuleTypeIdInteger0
iWorkspaceIdInteger0
iWorkspaceStructIdInteger0
iUserIdInteger0
iUserStructIdInteger0
bSingleUserSharedBooleanfalse
sIdentifierString

LLModule

Description:Constructor
Returns: [Undefined]
Arguments:
NameTypeOptionalDescription

bGetByIdentifier

Description:Get the module by the identifier-string The identifier contains all the information the module needs
Returns: [Boolean] true if the identifier is valid
Arguments:
NameTypeOptionalDescription
sIdentifierStringidentifier-string

bGetBySingleUserIdentifier

Description:
Returns: [Boolean]
Arguments:
NameTypeOptionalDescription
oUserObject reference
sFolderString

aGetUserAccess

Description:Get access-array with rights This array consists of 4
Returns: [Array] Access-array
Arguments:
NameTypeOptionalDescription
oUserObject referenceCurrent User-object

sGetDatadir

Description:Get the path to the data-directory (create the directory if it does not exists)
Returns: [String] Directory
Arguments:
NameTypeOptionalDescription

bClearDataDir

Description:Removes or clears the modules data-directory
Returns: [Boolean] true
Arguments:
NameTypeOptionalDescription
bRemoveDirBoolean YES [false] [optional] default false Remove the directory completly

bDeleteModulesFiles

Description:Deletes files in the data directory uploaded to the module by users
Returns: [Boolean] true
Arguments:
NameTypeOptionalDescription
moduleIdNrDateA digit from the identifier ( this->$iModuleId)

bUpdateModule

Description:Updates the modules title and other parameters
Returns: [Boolean]
Arguments:
NameTypeOptionalDescription
iUpdateUserIdInteger YES [0]

bDelete

Description:Delete the module and all related information (and data-directory)
Returns: [Boolean] true on success
Arguments:
NameTypeOptionalDescription

getSQLUsersWithAccess

Description:
Returns: [String]
Arguments:
NameTypeOptionalDescription
sRightString