| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.6 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 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 |
| 34 | * @copyright CiviCRM LLC (c) 2004-2015 |
| 35 | * $Id$ |
| 36 | * |
| 37 | */ |
| 38 | class CRM_Report_Info extends CRM_Core_Component_Info { |
| 39 | |
| 40 | /** |
| 41 | * @inheritDoc |
| 42 | */ |
| 43 | protected $keyword = 'report'; |
| 44 | |
| 45 | /** |
| 46 | * @inheritDoc |
| 47 | * Provides base information about the component. |
| 48 | * Needs to be implemented in component's information |
| 49 | * class. |
| 50 | * |
| 51 | * @return array |
| 52 | * collection of required component settings |
| 53 | */ |
| 54 | /** |
| 55 | * @return array |
| 56 | */ |
| 57 | public function getInfo() { |
| 58 | return array( |
| 59 | 'name' => 'CiviReport', |
| 60 | 'translatedName' => ts('CiviReport'), |
| 61 | 'title' => 'CiviCRM Report Engine', |
| 62 | 'search' => 0, |
| 63 | 'showActivitiesInCore' => 1, |
| 64 | ); |
| 65 | } |
| 66 | |
| 67 | |
| 68 | /** |
| 69 | * @inheritDoc |
| 70 | * Provides permissions that are used by component. |
| 71 | * Needs to be implemented in component's information |
| 72 | * class. |
| 73 | * |
| 74 | * NOTE: if using conditionally permission return, |
| 75 | * implementation of $getAllUnconditionally is required. |
| 76 | * |
| 77 | * @param bool $getAllUnconditionally |
| 78 | * @param bool $descriptions |
| 79 | * Whether to return permission descriptions |
| 80 | * |
| 81 | * @return array|null |
| 82 | * collection of permissions, null if none |
| 83 | */ |
| 84 | public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) { |
| 85 | $permissions = array( |
| 86 | 'access CiviReport' => array( |
| 87 | ts('access CiviReport'), |
| 88 | ts('View reports'), |
| 89 | ), |
| 90 | 'access Report Criteria' => array( |
| 91 | ts('access Report Criteria'), |
| 92 | ts('Change report search criteria'), |
| 93 | ), |
| 94 | 'administer reserved reports' => array( |
| 95 | ts('administer reserved reports'), |
| 96 | ts('Edit all reports that have been marked as reserved'), |
| 97 | ), |
| 98 | 'administer Reports' => array( |
| 99 | ts('administer Reports'), |
| 100 | ts('Manage report templates'), |
| 101 | ), |
| 102 | ); |
| 103 | |
| 104 | if (!$descriptions) { |
| 105 | foreach ($permissions as $name => $attr) { |
| 106 | $permissions[$name] = array_shift($attr); |
| 107 | } |
| 108 | } |
| 109 | |
| 110 | return $permissions; |
| 111 | } |
| 112 | |
| 113 | |
| 114 | /** |
| 115 | * @inheritDoc |
| 116 | * Provides information about user dashboard element |
| 117 | * offered by this component. |
| 118 | * |
| 119 | * @return array|null |
| 120 | * collection of required dashboard settings, |
| 121 | * null if no element offered |
| 122 | */ |
| 123 | /** |
| 124 | * @return array|null |
| 125 | */ |
| 126 | public function getUserDashboardElement() { |
| 127 | // no dashboard element for this component |
| 128 | return NULL; |
| 129 | } |
| 130 | |
| 131 | /** |
| 132 | * Provides component's user dashboard page object. |
| 133 | * |
| 134 | * @return mixed |
| 135 | * component's User Dashboard applet object |
| 136 | */ |
| 137 | /** |
| 138 | * @return mixed |
| 139 | */ |
| 140 | public function getUserDashboardObject() { |
| 141 | // no dashboard element for this component |
| 142 | return NULL; |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * @inheritDoc |
| 147 | * Provides information about user dashboard element |
| 148 | * offered by this component. |
| 149 | * |
| 150 | * @return array|null |
| 151 | * collection of required dashboard settings, |
| 152 | * null if no element offered |
| 153 | */ |
| 154 | /** |
| 155 | * @return array|null |
| 156 | */ |
| 157 | public function registerTab() { |
| 158 | // this component doesn't use contact record tabs |
| 159 | return NULL; |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * @inheritDoc |
| 164 | * Provides information about advanced search pane |
| 165 | * offered by this component. |
| 166 | * |
| 167 | * @return array|null |
| 168 | * collection of required pane settings, |
| 169 | * null if no element offered |
| 170 | */ |
| 171 | /** |
| 172 | * @return array|null |
| 173 | */ |
| 174 | public function registerAdvancedSearchPane() { |
| 175 | // this component doesn't use advanced search |
| 176 | return NULL; |
| 177 | } |
| 178 | |
| 179 | /** |
| 180 | * @inheritDoc |
| 181 | * Provides potential activity types that this |
| 182 | * component might want to register in activity history. |
| 183 | * Needs to be implemented in component's information |
| 184 | * class. |
| 185 | * |
| 186 | * @return array|null |
| 187 | * collection of activity types |
| 188 | */ |
| 189 | /** |
| 190 | * @return array|null |
| 191 | */ |
| 192 | public function getActivityTypes() { |
| 193 | return NULL; |
| 194 | } |
| 195 | |
| 196 | /** |
| 197 | * add shortcut to Create New. |
| 198 | * @param $shortCuts |
| 199 | */ |
| 200 | public function creatNewShortcut(&$shortCuts) { |
| 201 | } |
| 202 | |
| 203 | } |