CRM/Grant/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_Grant_Info extends CRM_Core_Component_Info {
  39
  40   // docs inherited from interface
  41   protected $keyword = 'grant';
  42
  43   // docs inherited from interface
  44   public function getInfo() {
  45     return array(
  46       'name' => 'CiviGrant',
  47       'translatedName' => ts('CiviGrant'),
  48       'title' => 'CiviCRM Grant Management Engine',
  49       'path' => 'CRM_Grant_',
  50       'search' => 1,
  51       'showActivitiesInCore' => 1,
  52     );
  53   }
  54
  55
  56   // docs inherited from interface
  57   public function getPermissions($getAllUnconditionally = FALSE) {
  58     return array(
  59       'access CiviGrant',
  60       'edit grants',
  61       'delete in CiviGrant',
  62     );
  63   }
  64
  65   // docs inherited from interface
  66   public function getUserDashboardElement() {
  67     // no dashboard element for this component
  68     return NULL;
  69   }
  70
  71   // docs inherited from interface
  72   public function getUserDashboardObject() {
  73     // no dashboard element for this component
  74     return NULL;
  75   }
  76
  77   // docs inherited from interface
  78   public function registerTab() {
  79     return array('title' => ts('Grants'),
  80       'url' => 'grant',
  81       'weight' => 50,
  82     );
  83   }
  84
  85   // docs inherited from interface
  86   public function registerAdvancedSearchPane() {
  87     return array('title' => ts('Grants'),
  88       'weight' => 50,
  89     );
  90   }
  91
  92   // docs inherited from interface
  93   public function getActivityTypes() {
  94     return NULL;
  95   }
  96
  97   // add shortcut to Create New
  98   public function creatNewShortcut(&$shortCuts) {
  99     if (CRM_Core_Permission::check('access CiviGrant') &&
 100       CRM_Core_Permission::check('edit grants')
 101     ) {
 102       $shortCuts = array_merge($shortCuts, array(
 103         array('path' => 'civicrm/grant/add',
 104             'query' => "reset=1&action=add&context=standalone",
 105             'ref' => 'new-grant',
 106             'title' => ts('Grant'),
 107           )));
 108     }
 109   }
 110 }
 111