CRM/Member/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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_Member_Info extends CRM_Core_Component_Info {
  39
  40   // docs inherited from interface
  41   protected $keyword = 'member';
  42
  43   // docs inherited from interface
  44   /**
  45    * Provides base information about the component.
  46    * Needs to be implemented in component's information
  47    * class.
  48    *
  49    * @return array collection of required component settings
  50    * @access public
  51    *
  52    */
  53   /**
  54    * @return array
  55    */
  56   public function getInfo() {
  57     return array(
  58       'name' => 'CiviMember',
  59       'translatedName' => ts('CiviMember'),
  60       'title' => 'CiviCRM Membership Engine',
  61       'search' => 1,
  62       'showActivitiesInCore' => 1,
  63     );
  64   }
  65
  66
  67   // docs inherited from interface
  68   /**
  69    * Provides permissions that are used by component.
  70    * Needs to be implemented in component's information
  71    * class.
  72    *
  73    * NOTE: if using conditionally permission return,
  74    * implementation of $getAllUnconditionally is required.
  75    *
  76    * @param bool $getAllUnconditionally
  77    *
  78    * @return array|null collection of permissions, null if none
  79    * @access public
  80    */
  81   /**
  82    * @param bool $getAllUnconditionally
  83    *
  84    * @return array|null
  85    */
  86   public function getPermissions($getAllUnconditionally = FALSE) {
  87     return array(
  88       'access CiviMember',
  89       'edit memberships',
  90       'delete in CiviMember',
  91     );
  92   }
  93
  94   // docs inherited from interface
  95   /**
  96    * Provides information about user dashboard element
  97    * offered by this component.
  98    *
  99    * @return array|null collection of required dashboard settings,
 100    *                    null if no element offered
 101    * @access public
 102    *
 103    */
 104   /**
 105    * @return array|null
 106    */
 107   public function getUserDashboardElement() {
 108     return array('name' => ts('Memberships'),
 109       'title' => ts('Your Membership(s)'),
 110       // this is CiviContribute specific permission, since
 111       // there is no permission that could be checked for
 112       // CiviMember
 113       'perm' => array('make online contributions'),
 114       'weight' => 30,
 115     );
 116   }
 117
 118   // docs inherited from interface
 119   /**
 120    * Provides information about user dashboard element
 121    * offered by this component.
 122    *
 123    * @return array|null collection of required dashboard settings,
 124    *                    null if no element offered
 125    * @access public
 126    *
 127    */
 128   /**
 129    * @return array|null
 130    */
 131   public function registerTab() {
 132     return array('title' => ts('Memberships'),
 133       'url' => 'membership',
 134       'weight' => 30,
 135     );
 136   }
 137
 138   // docs inherited from interface
 139   /**
 140    * Provides information about advanced search pane
 141    * offered by this component.
 142    *
 143    * @return array|null collection of required pane settings,
 144    *                    null if no element offered
 145    * @access public
 146    *
 147    */
 148   /**
 149    * @return array|null
 150    */
 151   public function registerAdvancedSearchPane() {
 152     return array('title' => ts('Memberships'),
 153       'weight' => 30,
 154     );
 155   }
 156
 157   // docs inherited from interface
 158   /**
 159    * Provides potential activity types that this
 160    * component might want to register in activity history.
 161    * Needs to be implemented in component's information
 162    * class.
 163    *
 164    * @return array|null collection of activity types
 165    * @access public
 166    *
 167    */
 168   /**
 169    * @return array|null
 170    */
 171   public function getActivityTypes() {
 172     return NULL;
 173   }
 174
 175   // add shortcut to Create New
 176   /**
 177    * @param $shortCuts
 178    * @param $newCredit
 179    */
 180   public function creatNewShortcut(&$shortCuts, $newCredit) {
 181     if (CRM_Core_Permission::check('access CiviMember') &&
 182       CRM_Core_Permission::check('edit memberships')
 183     ) {
 184       $shortCut[] = array(
 185         'path' => 'civicrm/member/add',
 186         'query' => "reset=1&action=add&context=standalone",
 187         'ref' => 'new-membership',
 188         'title' => ts('Membership'),
 189       );
 190       if ($newCredit) {
 191         $title = ts('Membership') . '<br />&nbsp;&nbsp;(' . ts('credit card') . ')';
 192         $shortCut[0]['shortCuts'][] = array(
 193           'path' => 'civicrm/member/add',
 194           'query' => "reset=1&action=add&context=standalone&mode=live",
 195           'ref' => 'new-membership-cc',
 196           'title' => $title,
 197         );
 198       }
 199       $shortCuts = array_merge($shortCuts, $shortCut);
 200     }
 201   }
 202 }
 203