3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This class introduces component to the system and provides all the
30 * information about it. It needs to extend CRM_Core_Component_Info
34 * @copyright CiviCRM LLC (c) 2004-2014
38 class CRM_Report_Info
extends CRM_Core_Component_Info
{
40 // docs inherited from interface
41 protected $keyword = 'report';
43 // docs inherited from interface
45 * Provides base information about the component.
46 * Needs to be implemented in component's information
49 * @return array collection of required component settings
56 public function getInfo() {
58 'name' => 'CiviReport',
59 'translatedName' => ts('CiviReport'),
60 'title' => 'CiviCRM Report Engine',
62 'showActivitiesInCore' => 1,
67 // docs inherited from interface
69 * Provides permissions that are used by component.
70 * Needs to be implemented in component's information
73 * NOTE: if using conditionally permission return,
74 * implementation of $getAllUnconditionally is required.
76 * @param bool $getAllUnconditionally
78 * @return array|null collection of permissions, null if none
82 * @param bool $getAllUnconditionally
86 public function getPermissions($getAllUnconditionally = FALSE) {
87 return array('access CiviReport', 'access Report Criteria', 'administer reserved reports', 'administer Reports');
91 // docs inherited from interface
93 * Provides information about user dashboard element
94 * offered by this component.
96 * @return array|null collection of required dashboard settings,
97 * null if no element offered
104 public function getUserDashboardElement() {
105 // no dashboard element for this component
110 * Provides component's user dashboard page object.
112 * @return mixed component's User Dashboard applet object
119 public function getUserDashboardObject() {
120 // no dashboard element for this component
124 // docs inherited from interface
126 * Provides information about user dashboard element
127 * offered by this component.
129 * @return array|null collection of required dashboard settings,
130 * null if no element offered
137 public function registerTab() {
138 // this component doesn't use contact record tabs
142 // docs inherited from interface
144 * Provides information about advanced search pane
145 * offered by this component.
147 * @return array|null collection of required pane settings,
148 * null if no element offered
155 public function registerAdvancedSearchPane() {
156 // this component doesn't use advanced search
160 // docs inherited from interface
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
167 * @return array|null collection of activity types
174 public function getActivityTypes() {
178 // add shortcut to Create New
182 public function creatNewShortcut(&$shortCuts) {}