\SeedDMS_Core_Group

Class to represent a user group in the document management system

Summary

Methods
Properties
Constants
SeedDMS_Core_Group()
setDMS()
getID()
getName()
setName()
getComment()
setComment()
getUsers()
getManagers()
addUser()
removeUser()
isMember()
toggleManager()
remove()
getReviewStatus()
getApprovalStatus()
No public properties found
No constants found
No protected methods found
$_id
$_name
$_dms
N/A
No private methods found
No private properties found
N/A

Properties

$_id

$_id : integer

The id of the user group

Type

integer

$_name

$_name : string

The name of the user group

Type

string

$_dms

$_dms : object

Back reference to DMS this user group belongs to

Type

object

Methods

SeedDMS_Core_Group()

SeedDMS_Core_Group( $id,  $name,  $comment)

Parameters

$id
$name
$comment

setDMS()

setDMS( $dms)

Parameters

$dms

getID()

getID()

getName()

getName()

setName()

setName( $newName)

Parameters

$newName

getComment()

getComment()

setComment()

setComment( $newComment)

Parameters

$newComment

getUsers()

getUsers()

getManagers()

getManagers()

addUser()

addUser( $user,  $asManager)

Parameters

$user
$asManager

removeUser()

removeUser( $user)

Parameters

$user

isMember()

isMember( $user,  $asManager)

Parameters

$user
$asManager

toggleManager()

toggleManager( $user)

Parameters

$user

remove()

remove(object $user) : boolean

Delete user group This function deletes the user group and all it references, like access control lists, notifications, as a child of other groups, etc.

Parameters

object $user

the user doing the removal (needed for entry in

   review log.

Returns

boolean —

true on success or false in case of an error

getReviewStatus()

getReviewStatus( $documentID,  $version)

Parameters

$documentID
$version

getApprovalStatus()

getApprovalStatus( $documentID,  $version)

Parameters

$documentID
$version