Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * This class introduces component to the system and provides all the | |
30 | * information about it. It needs to extend CRM_Core_Component_Info | |
31 | * abstract class. | |
32 | * | |
33 | * @package CRM | |
06b69b18 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * $Id$ |
36 | * | |
37 | */ | |
38 | class CRM_Report_Info extends CRM_Core_Component_Info { | |
39 | ||
40 | // docs inherited from interface | |
41 | protected $keyword = 'report'; | |
42 | ||
43 | // docs inherited from interface | |
74cf4551 EM |
44 | /** |
45 | * Provides base information about the component. | |
46 | * Needs to be implemented in component's information | |
47 | * class. | |
48 | * | |
49 | * @return array collection of required component settings | |
50 | * @access public | |
51 | * | |
52 | */ | |
53 | /** | |
54 | * @return array | |
55 | */ | |
6a488035 TO |
56 | public function getInfo() { |
57 | return array( | |
58 | 'name' => 'CiviReport', | |
59 | 'translatedName' => ts('CiviReport'), | |
60 | 'title' => 'CiviCRM Report Engine', | |
61 | 'search' => 0, | |
62 | 'showActivitiesInCore' => 1, | |
63 | ); | |
64 | } | |
65 | ||
66 | ||
67 | // docs inherited from interface | |
74cf4551 EM |
68 | /** |
69 | * Provides permissions that are used by component. | |
70 | * Needs to be implemented in component's information | |
71 | * class. | |
72 | * | |
73 | * NOTE: if using conditionally permission return, | |
74 | * implementation of $getAllUnconditionally is required. | |
75 | * | |
76 | * @param bool $getAllUnconditionally | |
77 | * | |
78 | * @return array|null collection of permissions, null if none | |
79 | * @access public | |
80 | */ | |
81 | /** | |
82 | * @param bool $getAllUnconditionally | |
83 | * | |
84 | * @return array|null | |
85 | */ | |
33777e4a | 86 | public function getPermissions($getAllUnconditionally = FALSE) { |
6a488035 TO |
87 | return array('access CiviReport', 'access Report Criteria', 'administer reserved reports', 'administer Reports'); |
88 | } | |
89 | ||
90 | ||
91 | // docs inherited from interface | |
74cf4551 EM |
92 | /** |
93 | * Provides information about user dashboard element | |
94 | * offered by this component. | |
95 | * | |
96 | * @return array|null collection of required dashboard settings, | |
97 | * null if no element offered | |
98 | * @access public | |
99 | * | |
100 | */ | |
101 | /** | |
102 | * @return array|null | |
103 | */ | |
6a488035 TO |
104 | public function getUserDashboardElement() { |
105 | // no dashboard element for this component | |
106 | return NULL; | |
107 | } | |
108 | ||
74cf4551 EM |
109 | /** |
110 | * Provides component's user dashboard page object. | |
111 | * | |
112 | * @return mixed component's User Dashboard applet object | |
113 | * @access public | |
114 | * | |
115 | */ | |
116 | /** | |
117 | * @return mixed | |
118 | */ | |
6a488035 TO |
119 | public function getUserDashboardObject() { |
120 | // no dashboard element for this component | |
121 | return NULL; | |
122 | } | |
123 | ||
124 | // docs inherited from interface | |
74cf4551 EM |
125 | /** |
126 | * Provides information about user dashboard element | |
127 | * offered by this component. | |
128 | * | |
129 | * @return array|null collection of required dashboard settings, | |
130 | * null if no element offered | |
131 | * @access public | |
132 | * | |
133 | */ | |
134 | /** | |
135 | * @return array|null | |
136 | */ | |
6a488035 TO |
137 | public function registerTab() { |
138 | // this component doesn't use contact record tabs | |
139 | return NULL; | |
140 | } | |
141 | ||
142 | // docs inherited from interface | |
74cf4551 EM |
143 | /** |
144 | * Provides information about advanced search pane | |
145 | * offered by this component. | |
146 | * | |
147 | * @return array|null collection of required pane settings, | |
148 | * null if no element offered | |
149 | * @access public | |
150 | * | |
151 | */ | |
152 | /** | |
153 | * @return array|null | |
154 | */ | |
6a488035 TO |
155 | public function registerAdvancedSearchPane() { |
156 | // this component doesn't use advanced search | |
157 | return NULL; | |
158 | } | |
159 | ||
160 | // docs inherited from interface | |
74cf4551 EM |
161 | /** |
162 | * Provides potential activity types that this | |
163 | * component might want to register in activity history. | |
164 | * Needs to be implemented in component's information | |
165 | * class. | |
166 | * | |
167 | * @return array|null collection of activity types | |
168 | * @access public | |
169 | * | |
170 | */ | |
171 | /** | |
172 | * @return array|null | |
173 | */ | |
6a488035 TO |
174 | public function getActivityTypes() { |
175 | return NULL; | |
176 | } | |
177 | ||
178 | // add shortcut to Create New | |
74cf4551 EM |
179 | /** |
180 | * @param $shortCuts | |
181 | */ | |
6a488035 TO |
182 | public function creatNewShortcut(&$shortCuts) {} |
183 | } | |
184 |