3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
21 * This class generates form components for Payment-Instrument
23 class CRM_Member_Form_MembershipView
extends CRM_Core_Form
{
26 * The action links that we need to display for the browse screen.
30 public static $_links = NULL;
33 * The id of the membership being viewed.
37 private $membershipID;
47 * Add context information at the end of a link.
50 * extra query parameters
52 public function addContext() {
54 foreach (['context', 'selectedChild'] as $arg) {
55 if ($value = CRM_Utils_Request
::retrieve($arg, 'String', $this)) {
56 $extra .= "&{$arg}={$value}";
66 * (reference) of action links
68 public function &links() {
69 if (!(self
::$_links)) {
71 CRM_Core_Action
::DELETE
=> [
72 'name' => ts('Delete'),
73 'url' => 'civicrm/contact/view/membership',
74 'qs' => 'action=view&id=%%id%%&cid=%%cid%%&relAction=delete&mid=%%mid%%&reset=1' . $this->addContext(),
75 'title' => ts('Cancel Related Membership'),
77 CRM_Core_Action
::ADD
=> [
78 'name' => ts('Create'),
79 'url' => 'civicrm/contact/view/membership',
80 'qs' => 'action=view&id=%%id%%&cid=%%cid%%&relAction=create&rid=%%rid%%&reset=1' . $this->addContext(),
81 'title' => ts('Create Related Membership'),
89 * Perform create or delete action on related memberships.
91 * @param string $action
94 * Primary membership info (membership_id, contact_id, membership_type ...).
96 * @throws \CRM_Core_Exception
97 * @throws \CiviCRM_API3_Exception
99 public function relAction($action, $owner) {
102 $id = CRM_Utils_Request
::retrieve('mid', 'Positive', $this);
103 $relatedContactId = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
104 $relatedDisplayName = CRM_Contact_BAO_Contact
::displayName($relatedContactId);
105 CRM_Member_BAO_Membership
::del($id);
106 CRM_Core_Session
::setStatus(ts('Related membership for %1 has been deleted.', [1 => $relatedDisplayName]),
107 ts('Membership Deleted'), 'success');
112 'contact_id' => CRM_Utils_Request
::retrieve('rid', 'Positive', $this),
113 'membership_type_id' => $owner['membership_type_id'],
114 'owner_membership_id' => $owner['id'],
115 'join_date' => CRM_Utils_Date
::processDate($owner['join_date'], NULL, TRUE, 'Ymd'),
116 'start_date' => CRM_Utils_Date
::processDate($owner['start_date'], NULL, TRUE, 'Ymd'),
117 'end_date' => CRM_Utils_Date
::processDate($owner['end_date'], NULL, TRUE, 'Ymd'),
118 'source' => ts('Manual Assignment of Related Membership'),
119 'is_test' => $owner['is_test'],
120 'campaign_id' => $owner['campaign_id'] ??
NULL,
121 'status_id' => $owner['status_id'],
122 'skipStatusCal' => TRUE,
123 'createActivity' => TRUE,
125 CRM_Member_BAO_Membership
::create($params);
126 $relatedDisplayName = CRM_Contact_BAO_Contact
::displayName($params['contact_id']);
127 CRM_Core_Session
::setStatus(ts('Related membership for %1 has been created.', [1 => $relatedDisplayName]),
128 ts('Membership Added'), 'success');
132 throw new CRM_Core_Exception(ts('Invalid action specified in URL'));
135 // Redirect back to membership view page for the owner, without the relAction parameters
136 CRM_Utils_System
::redirect(
137 CRM_Utils_System
::url(
138 'civicrm/contact/view/membership',
139 "action=view&reset=1&id={$owner['membership_id']}&cid={$owner['contact_id']}" . $this->addContext()
145 * Set variables up before form is built.
149 public function preProcess() {
151 $this->membershipID
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
152 $this->contactID
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
154 // Make sure context is assigned to template for condition where we come here view civicrm/membership/view
155 $context = CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this);
156 $this->assign('context', $context);
158 if ($this->membershipID
) {
159 $params = ['id' => $this->membershipID
];
160 CRM_Member_BAO_Membership
::retrieve($params, $values);
161 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
162 $finTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $values['membership_type_id'], 'financial_type_id');
163 $finType = CRM_Contribute_PseudoConstant
::financialType($finTypeId);
164 if (!CRM_Core_Permission
::check('view contributions of type ' . $finType)) {
165 CRM_Core_Error
::statusBounce(ts('You do not have permission to access this page.'));
169 $this->assign('noACL', TRUE);
171 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($values['membership_type_id']);
173 // Do the action on related Membership if needed
174 $relAction = CRM_Utils_Request
::retrieve('relAction', 'String', $this);
176 $this->relAction($relAction, $values);
179 // build associated contributions
180 $this->assign('accessContribution', FALSE);
181 if (CRM_Core_Permission
::access('CiviContribute')) {
182 $this->assign('accessContribution', TRUE);
183 CRM_Member_Page_Tab
::associatedContribution($values['contact_id'], $this->membershipID
);
186 //Provide information about membership source when it is the result of a relationship (CRM-1901)
187 $values['owner_membership_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
189 'owner_membership_id'
192 if (isset($values['owner_membership_id'])) {
193 $values['owner_contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
194 $values['owner_membership_id'],
199 $values['owner_display_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
200 $values['owner_contact_id'],
205 $direction = strrev($membershipType['relationship_direction']);
206 // To display relationship type in view membership page
207 $relTypeIds = str_replace(CRM_Core_DAO
::VALUE_SEPARATOR
, ",", $membershipType['relationship_type_id']);
209 SELECT relationship_type_id,
211 WHEN contact_id_a = {$values['owner_contact_id']} AND contact_id_b = {$values['contact_id']} THEN 'b_a'
212 WHEN contact_id_b = {$values['owner_contact_id']} AND contact_id_a = {$values['contact_id']} THEN 'a_b'
214 FROM civicrm_relationship
215 WHERE relationship_type_id IN ($relTypeIds)";
216 $dao = CRM_Core_DAO
::executeQuery($sql);
217 $values['relationship'] = NULL;
218 while ($dao->fetch()) {
219 $typeId = $dao->relationship_type_id
;
220 $direction = $dao->relType
;
221 if ($direction && $typeId) {
222 if ($values['relationship']) {
223 $values['relationship'] .= ',';
225 $values['relationship'] .= CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType',
234 $this->assign('has_related', FALSE);
235 // if membership can be granted, and we are the owner of the membership
236 if (!empty($membershipType['relationship_type_id']) && empty($values['owner_membership_id'])) {
237 // display related contacts/membership block
238 $this->assign('has_related', TRUE);
239 $this->assign('max_related', CRM_Utils_Array
::value('max_related', $values, ts('Unlimited')));
240 // split the relations in 2 arrays based on direction
241 $relTypeId = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_type_id']);
242 $relDirection = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_direction']);
243 foreach ($relTypeId as $rid) {
244 $relTypeDir[substr($relDirection[0], 0, 1)][] = $rid;
246 // build query in 2 parts with a UNION if necessary
247 // _x and _y are replaced with _a and _b first, then vice-versa
248 // comment is a qualifier for the relationship - now just job_title
250 SELECT r.id, c.id as cid, c.display_name as name, c.job_title as comment,
251 rt.name_x_y as relation, r.start_date, r.end_date,
252 m.id as mid, ms.is_current_member, ms.label as status
253 FROM civicrm_relationship r
254 LEFT JOIN civicrm_relationship_type rt ON rt.id = r.relationship_type_id
255 LEFT JOIN civicrm_contact c ON c.id = r.contact_id_x
256 LEFT JOIN civicrm_membership m ON (m.owner_membership_id = {$values['id']}
257 AND m.contact_id = r.contact_id_x AND m.is_test = 0)
258 LEFT JOIN civicrm_membership_status ms ON ms.id = m.status_id
259 WHERE r.contact_id_y = {$values['contact_id']} AND r.is_active = 1 AND c.is_deleted = 0";
261 foreach (['a', 'b'] as $dir) {
262 if (isset($relTypeDir[$dir])) {
263 $query .= ($query ?
' UNION ' : '')
264 . str_replace('_y', '_' . $dir, str_replace('_x', '_' . ($dir == 'a' ?
'b' : 'a'), $select))
265 . ' AND r.relationship_type_id IN (' . implode(',', $relTypeDir[$dir]) . ')';
268 $query .= " ORDER BY is_current_member DESC";
269 $dao = CRM_Core_DAO
::executeQuery($query);
271 $relatedRemaining = CRM_Utils_Array
::value('max_related', $values, PHP_INT_MAX
);
285 while ($dao->fetch()) {
287 foreach ($rowElememts as $field) {
288 $row[$field] = $dao->$field;
290 if ($row['mid'] && ($row['is_current_member'] == 1)) {
292 $row['action'] = CRM_Core_Action
::formLink(self
::links(), CRM_Core_Action
::DELETE
,
294 'id' => CRM_Utils_Request
::retrieve('id', 'Positive', $this),
295 'cid' => $row['cid'],
296 'mid' => $row['mid'],
300 'membership.relationship.action',
302 CRM_Utils_Request
::retrieve('id', 'Positive', $this)
306 if ($relatedRemaining > 0) {
307 $row['action'] = CRM_Core_Action
::formLink(self
::links(), CRM_Core_Action
::ADD
,
309 'id' => CRM_Utils_Request
::retrieve('id', 'Positive', $this),
310 'cid' => $row['cid'],
311 'rid' => $row['cid'],
315 'membership.relationship.action',
317 CRM_Utils_Request
::retrieve('id', 'Positive', $this)
323 $this->assign('related', $related);
324 if ($relatedRemaining <= 0) {
325 $this->assign('related_text', ts('None available'));
328 if ($relatedRemaining < 100000) {
329 $this->assign('related_text', ts('%1 available', [1 => $relatedRemaining]));
332 $this->assign('related_text', ts('Unlimited', [1 => $relatedRemaining]));
337 $displayName = CRM_Contact_BAO_Contact
::displayName($values['contact_id']);
338 $this->assign('displayName', $displayName);
340 // Check if this is default domain contact CRM-10482
341 if (CRM_Contact_BAO_Contact
::checkDomainContact($values['contact_id'])) {
342 $displayName .= ' (' . ts('default organization') . ')';
345 // omitting contactImage from title for now since the summary overlay css doesn't work outside crm-container
346 CRM_Utils_System
::setTitle(ts('View Membership for') . ' ' . $displayName);
348 // add viewed membership to recent items list
349 $recentTitle = $displayName . ' - ' . ts('Membership Type:') . ' ' . $values['membership_type'];
350 $url = CRM_Utils_System
::url('civicrm/contact/view/membership',
351 "action=view&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
355 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::UPDATE
)) {
356 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
357 "action=update&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
360 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::DELETE
)) {
361 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
362 "action=delete&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
365 CRM_Utils_Recent
::add($recentTitle,
369 $values['contact_id'],
374 CRM_Member_Page_Tab
::setContext($this, $values['contact_id']);
376 $memType = CRM_Core_DAO
::getFieldValue("CRM_Member_DAO_Membership", $this->membershipID
, "membership_type_id");
378 $groupTree = CRM_Core_BAO_CustomGroup
::getTree('Membership', NULL, $this->membershipID
, 0, $memType);
379 CRM_Core_BAO_CustomGroup
::buildCustomDataView($this, $groupTree, FALSE, NULL, NULL, NULL, $this->membershipID
);
381 $isRecur = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->membershipID
, 'contribution_recur_id');
383 $autoRenew = (bool) $isRecur;
386 if (!empty($values['is_test'])) {
387 $values['membership_type'] = CRM_Core_TestEntity
::appendTestText($values['membership_type']);
390 $subscriptionCancelled = CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->membershipID
);
391 $values['auto_renew'] = ($autoRenew && !$subscriptionCancelled) ?
'Yes' : 'No';
393 //do check for campaigns
394 if ($campaignId = CRM_Utils_Array
::value('campaign_id', $values)) {
395 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
396 $values['campaign'] = $campaigns[$campaignId];
399 $this->assign($values);
403 * Build the form object.
407 public function buildQuickForm() {
411 'name' => ts('Done'),
412 'spacing' => ' ',