CRM/Member/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   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_Member_Info extends CRM_Core_Component_Info {
  39
  40   // docs inherited from interface
  41   protected $keyword = 'member';
  42
  43   // docs inherited from interface
  44   public function getInfo() {
  45     return array(
  46       'name' => 'CiviMember',
  47       'translatedName' => ts('CiviMember'),
  48       'title' => 'CiviCRM Membership Engine',
  49       'search' => 1,
  50       'showActivitiesInCore' => 1,
  51     );
  52   }
  53
  54
  55   // docs inherited from interface
  56   public function getPermissions($getAllUnconditionally = FALSE) {
  57     return array(
  58       'access CiviMember',
  59       'edit memberships',
  60       'delete in CiviMember',
  61     );
  62   }
  63
  64   // docs inherited from interface
  65   public function getUserDashboardElement() {
  66     return array('name' => ts('Memberships'),
  67       'title' => ts('Your Membership(s)'),
  68       // this is CiviContribute specific permission, since
  69       // there is no permission that could be checked for
  70       // CiviMember
  71       'perm' => array('make online contributions'),
  72       'weight' => 30,
  73     );
  74   }
  75
  76   // docs inherited from interface
  77   public function registerTab() {
  78     return array('title' => ts('Memberships'),
  79       'url' => 'membership',
  80       'weight' => 30,
  81     );
  82   }
  83
  84   // docs inherited from interface
  85   public function registerAdvancedSearchPane() {
  86     return array('title' => ts('Memberships'),
  87       'weight' => 30,
  88     );
  89   }
  90
  91   // docs inherited from interface
  92   public function getActivityTypes() {
  93     return NULL;
  94   }
  95
  96   // add shortcut to Create New
  97   public function creatNewShortcut(&$shortCuts, $newCredit) {
  98     if (CRM_Core_Permission::check('access CiviMember') &&
  99       CRM_Core_Permission::check('edit memberships')
 100     ) {
 101       $shortCuts = array_merge($shortCuts, array(
 102         array('path' => 'civicrm/member/add',
 103             'query' => "reset=1&action=add&context=standalone",
 104             'ref' => 'new-membership',
 105             'title' => ts('Membership'),
 106           )));
 107       if ($newCredit) {
 108         $title = ts('Membership') . '<br />&nbsp;&nbsp;(' . ts('credit card') . ')';
 109         $shortCuts = array_merge($shortCuts, array(
 110           array('path' => 'civicrm/member/add',
 111               'query' => "reset=1&action=add&context=standalone&mode=live",
 112               'ref' => 'new-membership-cc',
 113               'title' => $title,
 114             )));
 115       }
 116     }
 117   }
 118 }
 119