0009768: Use ModelConfig for Timetracker models
[tine20] / tine20 / Timetracker / Model / TimeaccountFilter.php
1 <?php
2 /**
3  * Tine 2.0
4  * 
5  * @package     Timetracker
6  * @license     http://www.gnu.org/licenses/agpl.html AGPL Version 3
7  * @author      Philipp Schüle <p.schuele@metaways.de>
8  * @copyright   Copyright (c) 2007-2012 Metaways Infosystems GmbH (http://www.metaways.de)
9  */
10
11 /**
12  * Timeaccount filter Class
13  * 
14  * @package     Timetracker
15  */
16 class Timetracker_Model_TimeaccountFilter extends Tinebase_Model_Filter_FilterGroup implements Tinebase_Model_Filter_AclFilter 
17 {
18     /**
19      * if this is set, the filtergroup will be created using the configurationObject for this model
20      *
21      * @var string
22      */
23         protected $_configuredModel = 'Timetracker_Model_Timeaccount';
24     
25     /**
26      * @var array one of these grants must be met
27      */
28     protected $_requiredGrants = array(
29         Timetracker_Model_TimeaccountGrants::BOOK_OWN
30     );
31     
32     /**
33      * is acl filter resolved?
34      *
35      * @var boolean
36      */
37     protected $_isResolved = FALSE;
38     
39     /**
40      * set options
41      *
42      * @param array $_options
43      */
44     protected function _setOptions(array $_options)
45     {
46         $_options['useTimesheetAcl']    = (isset($_options['useTimesheetAcl']) || array_key_exists('useTimesheetAcl', $_options)) ? $_options['useTimesheetAcl'] : FALSE;
47         parent::_setOptions($_options);
48     }
49     
50     /**
51      * sets the grants this filter needs to assure
52      *
53      * @param array $_grants
54      */
55     public function setRequiredGrants(array $_grants)
56     {
57         $this->_requiredGrants = $_grants;
58         $this->_isResolved = FALSE;
59     }
60     
61     /**
62      * appends custom/acl filters to a given select object
63      * 
64      * @param  Zend_Db_Select                    $_select
65      * @param  Tinebase_Backend_Sql_Abstract     $_backend
66      * @return void
67      */
68     public function appendFilterSql($_select, $_backend)
69     {
70         if ($this->_ignoreAcl) {
71             return;
72         }
73
74         if (Timetracker_Controller_Timesheet::getInstance()->checkRight(Timetracker_Acl_Rights::MANAGE_TIMEACCOUNTS, FALSE, FALSE)) {
75             return;
76         }
77         
78         if (! $this->_isResolved) {
79             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
80                 . " Get all timeaccounts for user with required grants: " . print_r($this->_requiredGrants, TRUE));
81             
82             $result = Timetracker_Model_TimeaccountGrants::getTimeaccountsByAcl($this->_requiredGrants, TRUE);
83             $this->_validTimeaccounts = $result;
84             $this->_isResolved = TRUE;
85             
86             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
87                 . " Got " . count($this->_validTimeaccounts) . ' valid timeaccounts');
88         }
89         
90         $db = Tinebase_Core::getDb();
91         
92         $field = $db->quoteIdentifier('id');
93         $where = $db->quoteInto("$field IN (?)", empty($this->_validTimeaccounts) ? array('') : $this->_validTimeaccounts);
94         
95         $_select->where($where);
96     }
97     
98     /**
99      * returns array with the filter settings of this filter group 
100      *
101      * @param  bool $_valueToJson resolve value for json api?
102      * @return array
103      */
104     public function toArray($_valueToJson = false)
105     {
106         $result = parent::toArray($_valueToJson);
107         
108         foreach ($result as &$filterData) {
109             if (isset($filterData['field']) && $filterData['field'] == 'id' && $_valueToJson == true 
110                 && ! empty($filterData['value']) && ! is_array($filterData['value']))
111             {
112                 try {
113                     $filterData['value'] = Timetracker_Controller_Timeaccount::getInstance()->get($filterData['value'])->toArray();
114                 } catch (Tinebase_Exception_NotFound $nfe) {
115                     if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->INFO(__METHOD__ . '::' . __LINE__
116                         . " could not find and resolve timeaccount {$filterData['value']}");
117                 }
118             }
119         }
120         
121         return $result;
122     }
123 }