CRM/Member/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_Member_Info extends CRM_Core_Component_Info {
  39
  40   /**
  41    * @inheritDoc
  42    */
  43   protected $keyword = 'member';
  44
  45   /**
  46    * @inheritDoc
  47    * Provides base information about the component.
  48    * Needs to be implemented in component's information
  49    * class.
  50    *
  51    * @return array
  52    *   collection of required component settings
  53    */
  54   /**
  55    * @return array
  56    */
  57   public function getInfo() {
  58     return array(
  59       'name' => 'CiviMember',
  60       'translatedName' => ts('CiviMember'),
  61       'title' => 'CiviCRM Membership Engine',
  62       'search' => 1,
  63       'showActivitiesInCore' => 1,
  64     );
  65   }
  66
  67
  68   /**
  69    * @inheritDoc
  70    * Provides permissions that are used by component.
  71    * Needs to be implemented in component's information
  72    * class.
  73    *
  74    * NOTE: if using conditionally permission return,
  75    * implementation of $getAllUnconditionally is required.
  76    *
  77    * @param bool $getAllUnconditionally
  78    *
  79    * @return array|null
  80    *   collection of permissions, null if none
  81    */
  82   /**
  83    * @param bool $getAllUnconditionally
  84    *
  85    * @return array|null
  86    */
  87   public function getPermissions($getAllUnconditionally = FALSE) {
  88     return array(
  89       'access CiviMember',
  90       'edit memberships',
  91       'delete in CiviMember',
  92     );
  93   }
  94
  95   /**
  96    * @inheritDoc
  97    * Provides information about user dashboard element
  98    * offered by this component.
  99    *
 100    * @return array|null
 101    *   collection of required dashboard settings,
 102    *                    null if no element offered
 103    */
 104   /**
 105    * @return array|null
 106    */
 107   public function getUserDashboardElement() {
 108     return array(
 109       'name' => ts('Memberships'),
 110       'title' => ts('Your Membership(s)'),
 111       // this is CiviContribute specific permission, since
 112       // there is no permission that could be checked for
 113       // CiviMember
 114       'perm' => array('make online contributions'),
 115       'weight' => 30,
 116     );
 117   }
 118
 119   /**
 120    * @inheritDoc
 121    * Provides information about user dashboard element
 122    * offered by this component.
 123    *
 124    * @return array|null
 125    *   collection of required dashboard settings,
 126    *                    null if no element offered
 127    */
 128   /**
 129    * @return array|null
 130    */
 131   public function registerTab() {
 132     return array(
 133       'title' => ts('Memberships'),
 134       'url' => 'membership',
 135       'weight' => 30,
 136     );
 137   }
 138
 139   /**
 140    * @inheritDoc
 141    * Provides information about advanced search pane
 142    * offered by this component.
 143    *
 144    * @return array|null
 145    *   collection of required pane settings,
 146    *                    null if no element offered
 147    */
 148   /**
 149    * @return array|null
 150    */
 151   public function registerAdvancedSearchPane() {
 152     return array(
 153       'title' => ts('Memberships'),
 154       'weight' => 30,
 155     );
 156   }
 157
 158   /**
 159    * @inheritDoc
 160    * Provides potential activity types that this
 161    * component might want to register in activity history.
 162    * Needs to be implemented in component's information
 163    * class.
 164    *
 165    * @return array|null
 166    *   collection of activity types
 167    */
 168   /**
 169    * @return array|null
 170    */
 171   public function getActivityTypes() {
 172     return NULL;
 173   }
 174
 175   /**
 176    * add shortcut to Create New.
 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 }