CRM/Report/Info.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.3                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2013                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28 */
  29
  30 /**
  31  * This class introduces component to the system and provides all the
  32  * information about it. It needs to extend CRM_Core_Component_Info
  33  * abstract class.
  34  *
  35  * @package CRM
  36  * @copyright CiviCRM LLC (c) 2004-2013
  37  * $Id$
  38  *
  39  */
  40 class CRM_Report_Info extends CRM_Core_Component_Info {
  41
  42   // docs inherited from interface
  43   protected $keyword = 'report';
  44
  45   // docs inherited from interface
  46   public function getInfo() {
  47     return array(
  48       'name' => 'CiviReport',
  49       'translatedName' => ts('CiviReport'),
  50       'title' => 'CiviCRM Report Engine',
  51       'search' => 0,
  52       'showActivitiesInCore' => 1,
  53     );
  54   }
  55
  56
  57   // docs inherited from interface
  58   public function getPermissions($getAllUnconditionally = FALSE) {
  59     return array('access CiviReport', 'access Report Criteria', 'administer reserved reports', 'administer Reports');
  60   }
  61
  62
  63   // docs inherited from interface
  64   public function getUserDashboardElement() {
  65     // no dashboard element for this component
  66     return NULL;
  67   }
  68
  69   public function getUserDashboardObject() {
  70     // no dashboard element for this component
  71     return NULL;
  72   }
  73
  74   // docs inherited from interface
  75   public function registerTab() {
  76     // this component doesn't use contact record tabs
  77     return NULL;
  78   }
  79
  80   // docs inherited from interface
  81   public function registerAdvancedSearchPane() {
  82     // this component doesn't use advanced search
  83     return NULL;
  84   }
  85
  86   // docs inherited from interface
  87   public function getActivityTypes() {
  88     return NULL;
  89   }
  90
  91   // add shortcut to Create New
  92   public function creatNewShortcut(&$shortCuts) {}
  93 }
  94