Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
67.53% covered (warning)
67.53%
156 / 231
54.55% covered (warning)
54.55%
12 / 22
CRAP
0.00% covered (danger)
0.00%
0 / 1
SeedDMS_Core_Group
67.53% covered (warning)
67.53%
156 / 231
54.55% covered (warning)
54.55%
12 / 22
367.23
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
1
 getInstance
92.86% covered (success)
92.86%
13 / 14
0.00% covered (danger)
0.00%
0 / 1
6.01
 getAllInstances
90.91% covered (success)
90.91%
10 / 11
0.00% covered (danger)
0.00%
0 / 1
5.02
 isType
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 setDMS
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getDMS
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getID
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getName
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 setName
100.00% covered (success)
100.00%
9 / 9
100.00% covered (success)
100.00%
1 / 1
3
 getComment
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 setComment
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
2
 getUsers
100.00% covered (success)
100.00%
15 / 15
100.00% covered (success)
100.00%
1 / 1
5
 getManagers
92.86% covered (success)
92.86%
13 / 14
0.00% covered (danger)
0.00%
0 / 1
4.01
 addUser
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
3
 removeUser
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
2
 isMember
69.23% covered (warning)
69.23%
9 / 13
0.00% covered (danger)
0.00%
0 / 1
11.36
 toggleManager
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
4
 remove
0.00% covered (danger)
0.00%
0 / 48
0.00% covered (danger)
0.00%
0 / 1
156
 getReviewStatus
91.30% covered (success)
91.30%
21 / 23
0.00% covered (danger)
0.00%
0 / 1
8.04
 getApprovalStatus
90.91% covered (success)
90.91%
20 / 22
0.00% covered (danger)
0.00%
0 / 1
8.05
 getWorkflowStatus
0.00% covered (danger)
0.00%
0 / 14
0.00% covered (danger)
0.00%
0 / 1
56
 getNotifications
92.86% covered (success)
92.86%
13 / 14
0.00% covered (danger)
0.00%
0 / 1
5.01
1<?php
2/**
3 * Implementation of the group object in the document management system
4 *
5 * @category   DMS
6 * @package    SeedDMS_Core
7 * @license    GPL 2
8 * @version    @version@
9 * @author     Uwe Steinmann <uwe@steinmann.cx>
10 * @copyright  Copyright (C) 2002-2005 Markus Westphal, 2006-2008 Malcolm Cowe,
11 *             2010 Uwe Steinmann
12 * @version    Release: @package_version@
13 */
14
15/**
16 * Class to represent a user group in the document management system
17 *
18 * @category   DMS
19 * @package    SeedDMS_Core
20 * @author     Markus Westphal, Malcolm Cowe, Uwe Steinmann <uwe@steinmann.cx>
21 * @copyright  Copyright (C) 2002-2005 Markus Westphal, 2006-2008 Malcolm Cowe, 2010 Uwe Steinmann
22 * @version    Release: @package_version@
23 */
24class SeedDMS_Core_Group { /* {{{ */
25    /**
26     * The id of the user group
27     *
28     * @var integer
29     */
30    protected $_id;
31
32    /**
33     * The name of the user group
34     *
35     * @var string
36     */
37    protected $_name;
38
39    /**
40     * @var SeedDMS_Core_User[]
41     */
42    protected $_users;
43
44    /**
45     * The comment of the user group
46     *
47     * @var string
48     */
49    protected $_comment;
50
51    /**
52     * Back reference to DMS this user group belongs to
53     *
54     * @var SeedDMS_Core_DMS
55     */
56    protected $_dms;
57
58    function __construct($id, $name, $comment) { /* {{{ */
59        $this->_id = $id;
60        $this->_name = $name;
61        $this->_comment = $comment;
62        $this->_dms = null;
63    } /* }}} */
64
65    /**
66     * Return an instance of a group object
67     *
68     * @param string|integer $id Id, name of group, depending
69     * on the 3rd parameter.
70     * @param SeedDMS_Core_DMS $dms instance of dms
71     * @param string $by search by group name if set to 'name'. 
72     * Search by Id of group if left empty.
73     * @return SeedDMS_Core_Group|bool instance of class SeedDMS_Core_Group if group was
74     * found, null if group was not found, false in case of error
75     */
76    public static function getInstance($id, $dms, $by='') { /* {{{ */
77        $db = $dms->getDB();
78
79        switch($by) {
80        case 'name':
81            $queryStr = "SELECT * FROM `tblGroups` WHERE `name` = ".$db->qstr($id);
82            break;
83        default:
84            $queryStr = "SELECT * FROM `tblGroups` WHERE `id` = " . (int) $id;
85        }
86
87        $resArr = $db->getResultArray($queryStr);
88        if (is_bool($resArr) && $resArr == false)
89            return false;
90        else if (count($resArr) != 1) //wenn, dann wohl eher 0 als > 1 ;-)
91            return null;
92
93        $resArr = $resArr[0];
94
95        $group = new self($resArr["id"], $resArr["name"], $resArr["comment"]);
96        $group->setDMS($dms);
97        return $group;
98    } /* }}} */
99
100    /**
101     * @param $orderby
102     * @param SeedDMS_Core_DMS $dms
103     * @return array|bool
104     */
105    public static function getAllInstances($orderby, $dms) { /* {{{ */
106        $db = $dms->getDB();
107
108        switch($orderby) {
109        default:
110            $queryStr = "SELECT * FROM `tblGroups` ORDER BY `name`";
111        }
112        $resArr = $db->getResultArray($queryStr);
113
114        if (is_bool($resArr) && $resArr == false)
115            return false;
116
117        $groups = array();
118        for ($i = 0; $i < count($resArr); $i++) {
119            $group = new self($resArr[$i]["id"], $resArr[$i]["name"], $resArr[$i]["comment"]);
120            $group->setDMS($dms);
121            $groups[$i] = $group;
122        }
123
124        return $groups;
125    } /* }}} */
126
127    /**
128     * Check if this object is of type 'group'.
129     *
130     * @param string $type type of object
131     */
132    public function isType($type) { /* {{{ */
133        return $type == 'group';
134    } /* }}} */
135
136    /**
137     * @param SeedDMS_Core_DMS $dms
138     */
139    function setDMS($dms) { /* {{{ */
140        $this->_dms = $dms;
141    } /* }}} */
142
143    /**
144     * @return SeedDMS_Core_DMS $dms
145     */
146    function getDMS() {
147        return $this->_dms;
148    }
149
150    /**
151     * @return int
152     */
153    function getID() { return $this->_id; }
154
155    /**
156     * @return string
157     */
158    function getName() { return $this->_name; }
159
160    /**
161     * @param $newName
162     * @return bool
163     */
164    function setName($newName) { /* {{{ */
165        $newName = trim($newName);
166        if(!$newName)
167            return false;
168
169        $db = $this->_dms->getDB();
170
171        $queryStr = "UPDATE `tblGroups` SET `name` = ".$db->qstr($newName)." WHERE `id` = " . $this->_id;
172        if (!$db->getResult($queryStr))
173            return false;
174
175        $this->_name = $newName;
176        return true;
177    } /* }}} */
178
179    /**
180     * @return string
181     */
182    function getComment() { return $this->_comment; }
183
184    /**
185     * @param $newComment
186     * @return bool
187     */
188    function setComment($newComment) { /* {{{ */
189        $db = $this->_dms->getDB();
190
191        $queryStr = "UPDATE `tblGroups` SET `comment` = ".$db->qstr($newComment)." WHERE `id` = " . $this->_id;
192        if (!$db->getResult($queryStr))
193            return false;
194
195        $this->_comment = $newComment;
196        return true;
197    } /* }}} */
198
199    /**
200     * @return SeedDMS_Core_User[]|bool
201     */
202    function getUsers() { /* {{{ */
203        $db = $this->_dms->getDB();
204
205        if (!isset($this->_users)) {
206            $queryStr = "SELECT `tblUsers`.* FROM `tblUsers` ".
207                "LEFT JOIN `tblGroupMembers` ON `tblGroupMembers`.`userID`=`tblUsers`.`id` ".
208                "WHERE `tblGroupMembers`.`groupID` = '". $this->_id ."'";
209            $resArr = $db->getResultArray($queryStr);
210            if (is_bool($resArr) && $resArr == false)
211                return false;
212
213            $this->_users = array();
214
215            $classname = $this->_dms->getClassname('user');
216            foreach ($resArr as $row) {
217                /** @var SeedDMS_Core_User $user */
218                $user = new $classname($row["id"], $row["login"], $row["pwd"], $row["fullName"], $row["email"], $row["language"], $row["theme"], $row["comment"], $row["role"], $row['hidden']);
219                $user->setDMS($this->_dms);
220                array_push($this->_users, $user);
221            }
222        }
223        return $this->_users;
224    } /* }}} */
225
226    /**
227     * @return SeedDMS_Core_User[]|bool
228     */
229    function getManagers() { /* {{{ */
230        $db = $this->_dms->getDB();
231
232        $queryStr = "SELECT `tblUsers`.* FROM `tblUsers` ".
233            "LEFT JOIN `tblGroupMembers` ON `tblGroupMembers`.`userID`=`tblUsers`.`id` ".
234            "WHERE `tblGroupMembers`.`groupID` = '". $this->_id ."' AND `tblGroupMembers`.`manager` = 1";
235        $resArr = $db->getResultArray($queryStr);
236        if (is_bool($resArr) && $resArr == false)
237            return false;
238
239        $managers = array();
240
241        $classname = $this->_dms->getClassname('user');
242        foreach ($resArr as $row) {
243            /** @var SeedDMS_Core_User $user */
244            $user = new $classname($row["id"], $row["login"], $row["pwd"], $row["fullName"], $row["email"], $row["language"], $row["theme"], $row["comment"], $row["role"], $row['hidden']);
245            $user->setDMS($this->_dms);
246            array_push($managers, $user);
247        }
248        return $managers;
249    } /* }}} */
250
251    /**
252     * @param SeedDMS_Core_User $user
253     * @param bool $asManager
254     * @return bool
255     */
256    function addUser($user,$asManager=false) { /* {{{ */
257        $db = $this->_dms->getDB();
258
259        $queryStr = "INSERT INTO `tblGroupMembers` (`groupID`, `userID`, `manager`) VALUES (".$this->_id.", ".$user->getID(). ", " . ($asManager?"1":"0") ." )";
260        $res = $db->getResult($queryStr);
261
262        if (!$res) return false;
263
264        unset($this->_users);
265        return true;
266    } /* }}} */
267
268    /**
269     * @param SeedDMS_Core_User $user
270     * @return bool
271     */
272    function removeUser($user) { /* {{{ */
273        $db = $this->_dms->getDB();
274
275        $queryStr = "DELETE FROM `tblGroupMembers` WHERE `groupID` = ".$this->_id." AND `userID` = ".$user->getID();
276        $res = $db->getResult($queryStr);
277
278        if (!$res) return false;
279        unset($this->_users);
280        return true;
281    } /* }}} */
282
283    /**
284     * Check if user is member of group
285     *
286     * @param SeedDMS_Core_User $user user to be checked
287     * @param boolean $asManager also check whether user is manager of group if
288     * set to true, otherwise does not care about manager status
289     * @return boolean true if user is member, otherwise false
290     */
291    function isMember($user, $asManager=false) { /* {{{ */
292        if (isset($this->_users)&&!$asManager) {
293            foreach ($this->_users as $usr)
294                if ($usr->getID() == $user->getID())
295                    return true;
296            return false;
297        }
298
299        $db = $this->_dms->getDB();
300        $queryStr = "SELECT * FROM `tblGroupMembers` WHERE `groupID` = " . $this->_id . " AND `userID` = " . $user->getID();
301        if ($asManager)
302             $queryStr .= " AND `manager` = 1";
303
304        $resArr = $db->getResultArray($queryStr);
305
306        if (is_bool($resArr) && $resArr == false) return false;
307        if (count($resArr) != 1) return false;
308
309        return true;
310    } /* }}} */
311
312    /**
313     * Toggle manager status of user
314     *
315     * @param SeedDMS_Core_User $user
316     * @return boolean true if operation was successful, otherwise false
317     */
318    function toggleManager($user) { /* {{{ */
319        $db = $this->_dms->getDB();
320
321        if (!$this->isMember($user)) return false;
322
323        if ($this->isMember($user,true)) $queryStr = "UPDATE `tblGroupMembers` SET `manager` = 0 WHERE `groupID` = ".$this->_id." AND `userID` = ".$user->getID();
324        else $queryStr = "UPDATE `tblGroupMembers` SET `manager` = 1 WHERE `groupID` = ".$this->_id." AND `userID` = ".$user->getID();
325
326        if (!$db->getResult($queryStr)) return false;
327        return true;
328    } /* }}} */
329
330    /**
331     * Delete user group
332     * This function deletes the user group and all it references, like access
333     * control lists, notifications, as a child of other groups, etc.
334     *
335     * @param SeedDMS_Core_User $user the user doing the removal (needed for entry in
336     *        review log.
337     * @return boolean true on success or false in case of an error
338     */
339    function remove($user) { /* {{{ */
340        $db = $this->_dms->getDB();
341
342        $db->startTransaction();
343
344        $queryStr = "DELETE FROM `tblGroupMembers` WHERE `groupID` = " . $this->_id;
345        if (!$db->getResult($queryStr)) {
346            $db->rollbackTransaction();
347            return false;
348        }
349        $queryStr = "DELETE FROM `tblACLs` WHERE `groupID` = " . $this->_id;
350        if (!$db->getResult($queryStr)) {
351            $db->rollbackTransaction();
352            return false;
353        }
354        $queryStr = "DELETE FROM `tblNotify` WHERE `groupID` = " . $this->_id;
355        if (!$db->getResult($queryStr)) {
356            $db->rollbackTransaction();
357            return false;
358        }
359        $queryStr = "DELETE FROM `tblMandatoryReviewers` WHERE `reviewerGroupID` = " . $this->_id;
360        if (!$db->getResult($queryStr)) {
361            $db->rollbackTransaction();
362            return false;
363        }
364        $queryStr = "DELETE FROM `tblMandatoryApprovers` WHERE `approverGroupID` = " . $this->_id;
365        if (!$db->getResult($queryStr)) {
366            $db->rollbackTransaction();
367            return false;
368        }
369        $queryStr = "DELETE FROM `tblWorkflowTransitionGroups` WHERE `groupid` = " . $this->_id;
370        if (!$db->getResult($queryStr)) {
371            $db->rollbackTransaction();
372            return false;
373        }
374        $queryStr = "DELETE FROM `tblGroups` WHERE `id` = " . $this->_id;
375        if (!$db->getResult($queryStr)) {
376            $db->rollbackTransaction();
377            return false;
378        }
379
380        // TODO : update document status if reviewer/approver has been deleted
381
382
383        $reviewStatus = $this->getReviewStatus();
384        foreach ($reviewStatus as $r) {
385            $queryStr = "INSERT INTO `tblDocumentReviewLog` (`reviewID`, `status`, `comment`, `date`, `userID`) ".
386                "VALUES ('". $r["reviewID"] ."', '-2', 'Review group removed from process', ".$db->getCurrentDatetime().", '". $user->getID() ."')";
387            $res=$db->getResult($queryStr);
388            if(!$res) {
389                $db->rollbackTransaction();
390                return false;
391            }
392        }
393
394        $approvalStatus = $this->getApprovalStatus();
395        foreach ($approvalStatus as $a) {
396            $queryStr = "INSERT INTO `tblDocumentApproveLog` (`approveID`, `status`, `comment`, `date`, `userID`) ".
397                "VALUES ('". $a["approveID"] ."', '-2', 'Approval group removed from process', ".$db->getCurrentDatetime().", '". $user->getID() ."')";
398            $res=$db->getResult($queryStr);
399            if(!$res) {
400                $db->rollbackTransaction();
401                return false;
402            }
403        }
404
405        $db->commitTransaction();
406
407        return true;
408    } /* }}} */
409
410    function getReviewStatus($documentID=null, $version=null) { /* {{{ */
411        $db = $this->_dms->getDB();
412
413        if (!$db->createTemporaryTable("ttreviewid")) {
414            return false;
415        }
416
417        $status = array();
418
419        // See if the group is assigned as a reviewer.
420        $queryStr = "SELECT `tblDocumentReviewers`.*, `tblDocumentReviewLog`.`status`, ".
421            "`tblDocumentReviewLog`.`comment`, `tblDocumentReviewLog`.`date`, ".
422            "`tblDocumentReviewLog`.`userID` ".
423            "FROM `tblDocumentReviewers` ".
424            "LEFT JOIN `tblDocumentReviewLog` USING (`reviewID`) ".
425            "LEFT JOIN `ttreviewid` on `ttreviewid`.`maxLogID` = `tblDocumentReviewLog`.`reviewLogID` ".
426            "WHERE `ttreviewid`.`maxLogID`=`tblDocumentReviewLog`.`reviewLogID` ".
427            ($documentID==null ? "" : "AND `tblDocumentReviewers`.`documentID` = '". (int) $documentID ."' ").
428            ($version==null ? "" : "AND `tblDocumentReviewers`.`version` = '". (int) $version ."' ").
429            "AND `tblDocumentReviewers`.`type`='1' ".
430            "AND `tblDocumentReviewers`.`required`='". $this->_id ."' ".
431            "ORDER BY `tblDocumentReviewLog`.`reviewLogID` DESC";
432        $resArr = $db->getResultArray($queryStr);
433        if (is_bool($resArr) && $resArr == false)
434            return false;
435        if (count($resArr)>0) {
436            foreach ($resArr as $res)
437                $status[] = $res;
438        }
439        return $status;
440    } /* }}} */
441
442    function getApprovalStatus($documentID=null, $version=null) { /* {{{ */
443        $db = $this->_dms->getDB();
444
445        if (!$db->createTemporaryTable("ttapproveid")) {
446            return false;
447        }
448
449        $status = array();
450
451        // See if the group is assigned as an approver.
452        $queryStr = "SELECT `tblDocumentApprovers`.*, `tblDocumentApproveLog`.`status`, ".
453            "`tblDocumentApproveLog`.`comment`, `tblDocumentApproveLog`.`date`, ".
454            "`tblDocumentApproveLog`.`userID` ".
455            "FROM `tblDocumentApprovers` ".
456            "LEFT JOIN `tblDocumentApproveLog` USING (`approveID`) ".
457            "LEFT JOIN `ttapproveid` on `ttapproveid`.`maxLogID` = `tblDocumentApproveLog`.`approveLogID` ".
458            "WHERE `ttapproveid`.`maxLogID`=`tblDocumentApproveLog`.`approveLogID` ".
459            ($documentID==null ? "" : "AND `tblDocumentApprovers`.`documentID` = '". (int) $documentID ."' ").
460            ($version==null ? "" : "AND `tblDocumentApprovers`.`version` = '". (int) $version ."' ").
461            "AND `tblDocumentApprovers`.`type`='1' ".
462            "AND `tblDocumentApprovers`.`required`='". $this->_id ."' ";
463        $resArr = $db->getResultArray($queryStr);
464        if (is_bool($resArr) && $resArr == false)
465            return false;
466        if (count($resArr)>0) {
467            foreach ($resArr as $res)
468                $status[] = $res;
469        }
470
471        return $status;
472    } /* }}} */
473
474    /**
475     * Get a list of documents with a workflow
476     *
477     * @param int $documentID optional document id for which to retrieve the
478     *        reviews
479     * @param int $version optional version of the document
480     * @return bool|array list of all workflows
481     */
482    function getWorkflowStatus($documentID=null, $version=null) { /* {{{ */
483        $db = $this->_dms->getDB();
484
485        $queryStr = 'select distinct d.*, c.`groupid` from `tblWorkflowTransitions` a left join `tblWorkflows` b on a.`workflow`=b.`id` left join `tblWorkflowTransitionGroups` c on a.`id`=c.`transition` left join `tblWorkflowDocumentContent` d on b.`id`=d.`workflow` where d.`document` is not null and a.`state`=d.`state` and c.`groupid`='.$this->_id;
486        if($documentID) {
487            $queryStr .= ' AND d.`document`='.(int) $documentID;
488            if($version)
489                $queryStr .= ' AND d.`version`='.(int) $version;
490        }
491        $resArr = $db->getResultArray($queryStr);
492        if (is_bool($resArr) && $resArr == false)
493            return false;
494        $result = array();
495        if (count($resArr)>0) {
496            foreach ($resArr as $res) {
497                $result[] = $res;
498            }
499        }
500        return $result;
501    } /* }}} */
502
503    /**
504     * Get all notifications of group
505     *
506     * @param integer $type type of item (T_DOCUMENT or T_FOLDER)
507     * @return SeedDMS_Core_Notification[]|bool array of notifications
508     */
509    function getNotifications($type=0) { /* {{{ */
510        $db = $this->_dms->getDB();
511        $queryStr = "SELECT `tblNotify`.* FROM `tblNotify` ".
512         "WHERE `tblNotify`.`groupID` = ". $this->_id;
513        if($type) {
514            $queryStr .= " AND `tblNotify`.`targetType` = ". (int) $type;
515        }
516
517        $resArr = $db->getResultArray($queryStr);
518        if (is_bool($resArr) && !$resArr)
519            return false;
520
521        $notifications = array();
522        foreach ($resArr as $row) {
523            $not = new SeedDMS_Core_Notification($row["target"], $row["targetType"], $row["userID"], $row["groupID"]);
524            $not->setDMS($this->_dms);
525            array_push($notifications, $not);
526        }
527
528        return $notifications;
529    } /* }}} */
530
531} /* }}} */