62817c7914b0a05b17dc3c18eca9c38b27a3f844
[tine20] / tine20 / Calendar / Model / EventFilter.php
1 <?php
2 /**
3  * Tine 2.0
4  * 
5  * @package     Calendar
6  * @license     http://www.gnu.org/licenses/agpl.html AGPL Version 3
7  * @author      Cornelius Weiss <c.weiss@metaways.de>
8  * @copyright   Copyright (c) 2009-2012 Metaways Infosystems GmbH (http://www.metaways.de)
9  *
10  */
11
12 /**
13  * Calendar Event Filter
14  * 
15  * @package Calendar
16  */
17 class Calendar_Model_EventFilter extends Tinebase_Model_Filter_FilterGroup 
18 {
19     /**
20      * @var string application of this filter group
21      */
22     protected $_applicationName = 'Calendar';
23     
24     /**
25      * @var string name of model this filter group is designed for
26      */
27     protected $_modelName = 'Calendar_Model_Event';
28     
29     /**
30      * @var string class name of this filter group
31      *      this is needed to overcome the static late binding
32      *      limitation in php < 5.3
33      */
34     protected $_className = 'Calendar_Model_EventFilter';
35     
36     /**
37      * @var array filter model fieldName => definition
38      */
39     protected $_filterModel = array(
40         'id'                    => array('filter' => 'Tinebase_Model_Filter_Id', 'options' => array('modelName' => 'Calendar_Model_Event')),
41         'uid'                   => array('filter' => 'Tinebase_Model_Filter_Text'),
42         'container_id'          => array('filter' => 'Calendar_Model_CalendarFilter', 'options' => array('applicationName' => 'Calendar')),
43         'query'                 => array('filter' => 'Tinebase_Model_Filter_Query', 'options' => array('fields' => array('summary', 'description', 'location'))),
44         'period'                => array('filter' => 'Calendar_Model_PeriodFilter'),
45         'attender'              => array('filter' => 'Calendar_Model_AttenderFilter'),
46         'attender_status'       => array('filter' => 'Calendar_Model_AttenderStatusFilter'),
47         'attender_role'         => array('filter' => 'Calendar_Model_AttenderRoleFilter'),
48         'organizer'             => array('filter' => 'Addressbook_Model_ContactIdFilter', 'options' => array('modelName' => 'Addressbook_Model_Contact')),
49         //'class'               => array('filter' => 'Tinebase_Model_Filter_Text'),
50         //'status'              => array('filter' => 'Tinebase_Model_Filter_Text'),
51         'tag'                   => array('filter' => 'Tinebase_Model_Filter_Tag', 'options' => array(
52             'idProperty' => 'cal_events.id',
53             'applicationName' => 'Calendar',
54         )),
55         'grants'                => array('filter' => 'Calendar_Model_GrantFilter'),
56         // NOTE using dtstart and dtend filters may not lead to the desired result. 
57         //      you need to use the period filter to filter for events in a given period
58         'dtstart'               => array('filter' => 'Tinebase_Model_Filter_DateTime'),
59         'dtend'                 => array('filter' => 'Tinebase_Model_Filter_DateTime'),
60         'transp'                => array('filter' => 'Tinebase_Model_Filter_Text'),
61         'rrule'                 => array('filter' => 'Tinebase_Model_Filter_Text'),
62         'recurid'               => array('filter' => 'Tinebase_Model_Filter_Text'),
63         'rrule_until'           => array('filter' => 'Tinebase_Model_Filter_DateTime'),
64         'last_modified_time'    => array('filter' => 'Tinebase_Model_Filter_DateTime'),
65         'summary'               => array('filter' => 'Tinebase_Model_Filter_Text'),
66         'location'              => array('filter' => 'Tinebase_Model_Filter_Text'),
67         'description'           => array('filter' => 'Tinebase_Model_Filter_Text'),
68     );
69 }