CRM/Report/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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
  44   public function getInfo() {
  45     return array(
  46       'name' => 'CiviReport',
  47       'translatedName' => ts('CiviReport'),
  48       'title' => 'CiviCRM Report Engine',
  49       'search' => 0,
  50       'showActivitiesInCore' => 1,
  51     );
  52   }
  53
  54
  55   // docs inherited from interface
  56   public function getPermissions($getAllUnconditionally = FALSE) {
  57     return array('access CiviReport', 'access Report Criteria', 'administer reserved reports', 'administer Reports');
  58   }
  59
  60
  61   // docs inherited from interface
  62   public function getUserDashboardElement() {
  63     // no dashboard element for this component
  64     return NULL;
  65   }
  66
  67   public function getUserDashboardObject() {
  68     // no dashboard element for this component
  69     return NULL;
  70   }
  71
  72   // docs inherited from interface
  73   public function registerTab() {
  74     // this component doesn't use contact record tabs
  75     return NULL;
  76   }
  77
  78   // docs inherited from interface
  79   public function registerAdvancedSearchPane() {
  80     // this component doesn't use advanced search
  81     return NULL;
  82   }
  83
  84   // docs inherited from interface
  85   public function getActivityTypes() {
  86     return NULL;
  87   }
  88
  89   // add shortcut to Create New
  90   public function creatNewShortcut(&$shortCuts) {}
  91 }
  92