CRM/Grant/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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   /**
  44    * docs inherited from interface
  45    * @return array
  46    */
  47   public function getInfo() {
  48     return array(
  49       'name' => 'CiviGrant',
  50       'translatedName' => ts('CiviGrant'),
  51       'title' => 'CiviCRM Grant Management Engine',
  52       'path' => 'CRM_Grant_',
  53       'search' => 1,
  54       'showActivitiesInCore' => 1,
  55     );
  56   }
  57
  58
  59   /**
  60    * docs inherited from interface
  61    * @param bool $getAllUnconditionally
  62    *
  63    * @return array
  64    */
  65   public function getPermissions($getAllUnconditionally = FALSE) {
  66     return array(
  67       'access CiviGrant',
  68       'edit grants',
  69       'delete in CiviGrant',
  70     );
  71   }
  72
  73   /**
  74    * docs inherited from interface
  75    * @return null
  76    */
  77   public function getUserDashboardElement() {
  78     // no dashboard element for this component
  79     return NULL;
  80   }
  81
  82   /**
  83    * docs inherited from interface
  84    * @return null
  85    */
  86   public function getUserDashboardObject() {
  87     // no dashboard element for this component
  88     return NULL;
  89   }
  90
  91   /**
  92    * docs inherited from interface
  93    * @return array
  94    */
  95   public function registerTab() {
  96     return array(
  97       'title' => ts('Grants'),
  98       'url' => 'grant',
  99       'weight' => 50,
 100     );
 101   }
 102
 103   /**
 104    * docs inherited from interface
 105    * @return array
 106    */
 107   public function registerAdvancedSearchPane() {
 108     return array(
 109       'title' => ts('Grants'),
 110       'weight' => 50,
 111     );
 112   }
 113
 114   /**
 115    * docs inherited from interface
 116    * @return null
 117    */
 118   public function getActivityTypes() {
 119     return NULL;
 120   }
 121
 122   /**
 123    * add shortcut to Create New
 124    * @param $shortCuts
 125    */
 126   public function creatNewShortcut(&$shortCuts) {
 127     if (CRM_Core_Permission::check('access CiviGrant') &&
 128       CRM_Core_Permission::check('edit grants')
 129     ) {
 130       $shortCuts = array_merge($shortCuts, array(
 131         array(
 132           'path' => 'civicrm/grant/add',
 133           'query' => "reset=1&action=add&context=standalone",
 134           'ref' => 'new-grant',
 135           'title' => ts('Grant'),
 136         )
 137       ));
 138     }
 139   }
 140 }