INFRA-132 - Comment grammar cleanup
[civicrm-core.git] / CRM / Member / Page / UserDashboard.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 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2014
32 * $Id$
33 *
34 */
35
36 /**
37 * This class is for building membership block on user dashboard
38 */
39 class CRM_Member_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
40
41 /**
42 * List memberships for the UF user
43 *
44 * return null
45 */
46 public function listMemberships() {
47 $membership = array();
48 $dao = new CRM_Member_DAO_Membership();
49 $dao->contact_id = $this->_contactId;
50 $dao->is_test = 0;
51 $dao->find();
52
53 while ($dao->fetch()) {
54 $membership[$dao->id] = array();
55 CRM_Core_DAO::storeValues($dao, $membership[$dao->id]);
56
57 //get the membership status and type values.
58 $statusANDType = CRM_Member_BAO_Membership::getStatusANDTypeValues($dao->id);
59 foreach (array(
60 'status', 'membership_type') as $fld) {
61 $membership[$dao->id][$fld] = CRM_Utils_Array::value($fld, $statusANDType[$dao->id]);
62 }
63 if (!empty($statusANDType[$dao->id]['is_current_member'])) {
64 $membership[$dao->id]['active'] = TRUE;
65 }
66
67 $membership[$dao->id]['renewPageId'] = CRM_Member_BAO_Membership::getContributionPageId($dao->id);
68 if (!$membership[$dao->id]['renewPageId']) {
69 // Membership payment was not done via online contribution page or free membership. Check for default membership renewal page from CiviMember Settings
70 $defaultRenewPageId = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MEMBER_PREFERENCES_NAME,
71 'default_renewal_contribution_page'
72 );
73 if ($defaultRenewPageId) {
74 //CRM-14831 - check if membership type is present in contrib page
75 $memBlock = CRM_Member_BAO_Membership::getMembershipBlock($defaultRenewPageId);
76 if (!empty($memBlock['membership_types'])) {
77 $memTypes = explode(',', $memBlock['membership_types']);
78 if (in_array($dao->membership_type_id, $memTypes)) {
79 $membership[$dao->id]['renewPageId'] = $defaultRenewPageId;
80 }
81 }
82 }
83 }
84 }
85
86 $activeMembers = CRM_Member_BAO_Membership::activeMembers($membership);
87 $inActiveMembers = CRM_Member_BAO_Membership::activeMembers($membership, 'inactive');
88
89 $this->assign('activeMembers', $activeMembers);
90 $this->assign('inActiveMembers', $inActiveMembers);
91 }
92
93 /**
94 * the main function that is called when the page
95 * loads, it decides the which action has to be taken for the page.
96 *
97 * return null
98 */
99 public function run() {
100 parent::preProcess();
101 $this->listMemberships();
102 }
103 }