CRM/Report/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   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       'view report sql' => array(
 103         ts('view report sql'),
 104         ts('View sql used in CiviReports'),
 105       ),
 106     );
 107
 108     if (!$descriptions) {
 109       foreach ($permissions as $name => $attr) {
 110         $permissions[$name] = array_shift($attr);
 111       }
 112     }
 113
 114     return $permissions;
 115   }
 116
 117
 118   /**
 119    * @inheritDoc
 120    * Provides information about user dashboard element
 121    * offered by this component.
 122    *
 123    * @return array|null
 124    *   collection of required dashboard settings,
 125    *                    null if no element offered
 126    */
 127   /**
 128    * @return array|null
 129    */
 130   public function getUserDashboardElement() {
 131     // no dashboard element for this component
 132     return NULL;
 133   }
 134
 135   /**
 136    * Provides component's user dashboard page object.
 137    *
 138    * @return mixed
 139    *   component's User Dashboard applet object
 140    */
 141   /**
 142    * @return mixed
 143    */
 144   public function getUserDashboardObject() {
 145     // no dashboard element for this component
 146     return NULL;
 147   }
 148
 149   /**
 150    * @inheritDoc
 151    * Provides information about user dashboard element
 152    * offered by this component.
 153    *
 154    * @return array|null
 155    *   collection of required dashboard settings,
 156    *                    null if no element offered
 157    */
 158   /**
 159    * @return array|null
 160    */
 161   public function registerTab() {
 162     // this component doesn't use contact record tabs
 163     return NULL;
 164   }
 165
 166   /**
 167    * @inheritDoc
 168    * Provides information about advanced search pane
 169    * offered by this component.
 170    *
 171    * @return array|null
 172    *   collection of required pane settings,
 173    *                    null if no element offered
 174    */
 175   /**
 176    * @return array|null
 177    */
 178   public function registerAdvancedSearchPane() {
 179     // this component doesn't use advanced search
 180     return NULL;
 181   }
 182
 183   /**
 184    * @inheritDoc
 185    * Provides potential activity types that this
 186    * component might want to register in activity history.
 187    * Needs to be implemented in component's information
 188    * class.
 189    *
 190    * @return array|null
 191    *   collection of activity types
 192    */
 193   /**
 194    * @return array|null
 195    */
 196   public function getActivityTypes() {
 197     return NULL;
 198   }
 199
 200   /**
 201    * add shortcut to Create New.
 202    * @param $shortCuts
 203    */
 204   public function creatNewShortcut(&$shortCuts) {
 205   }
 206
 207 }