3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
37 * This class generates form components for Payment-Instrument
39 class CRM_Member_Form_MembershipView
extends CRM_Core_Form
{
42 * The action links that we need to display for the browse screen.
46 public static $_links = NULL;
49 * The id of the membership being viewed.
53 private $membershipID;
63 * Add context information at the end of a link.
66 * extra query parameters
68 public function addContext() {
70 foreach (['context', 'selectedChild'] as $arg) {
71 if ($value = CRM_Utils_Request
::retrieve($arg, 'String', $this)) {
72 $extra .= "&{$arg}={$value}";
82 * (reference) of action links
84 public function &links() {
85 if (!(self
::$_links)) {
87 CRM_Core_Action
::DELETE
=> [
88 'name' => ts('Delete'),
89 'url' => 'civicrm/contact/view/membership',
90 'qs' => 'action=view&id=%%id%%&cid=%%cid%%&relAction=delete&mid=%%mid%%&reset=1' . $this->addContext(),
91 'title' => ts('Cancel Related Membership'),
93 CRM_Core_Action
::ADD
=> [
94 'name' => ts('Create'),
95 'url' => 'civicrm/contact/view/membership',
96 'qs' => 'action=view&id=%%id%%&cid=%%cid%%&relAction=create&rid=%%rid%%&reset=1' . $this->addContext(),
97 'title' => ts('Create Related Membership'),
101 return self
::$_links;
105 * Perform create or delete action on related memberships.
107 * @param string $action
109 * @param array $owner
110 * Primary membership info (membership_id, contact_id, membership_type ...).
112 public function relAction($action, $owner) {
115 $id = CRM_Utils_Request
::retrieve('mid', 'Positive', $this);
116 $relatedContactId = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
117 $relatedDisplayName = CRM_Contact_BAO_Contact
::displayName($relatedContactId);
118 CRM_Member_BAO_Membership
::del($id);
119 CRM_Core_Session
::setStatus(ts('Related membership for %1 has been deleted.', [1 => $relatedDisplayName]),
120 ts('Membership Deleted'), 'success');
126 'contact_id' => CRM_Utils_Request
::retrieve('rid', 'Positive', $this),
127 'membership_type_id' => $owner['membership_type_id'],
128 'owner_membership_id' => $owner['id'],
129 'join_date' => CRM_Utils_Date
::processDate($owner['join_date'], NULL, TRUE, 'Ymd'),
130 'start_date' => CRM_Utils_Date
::processDate($owner['start_date'], NULL, TRUE, 'Ymd'),
131 'end_date' => CRM_Utils_Date
::processDate($owner['end_date'], NULL, TRUE, 'Ymd'),
132 'source' => ts('Manual Assignment of Related Membership'),
133 'is_test' => $owner['is_test'],
134 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $owner),
135 'status_id' => $owner['status_id'],
136 'skipStatusCal' => TRUE,
137 'createActivity' => TRUE,
139 CRM_Member_BAO_Membership
::create($params, $ids);
140 $relatedDisplayName = CRM_Contact_BAO_Contact
::displayName($params['contact_id']);
141 CRM_Core_Session
::setStatus(ts('Related membership for %1 has been created.', [1 => $relatedDisplayName]),
142 ts('Membership Added'), 'success');
146 CRM_Core_Error
::fatal(ts("Invalid action specified in URL"));
149 // Redirect back to membership view page for the owner, without the relAction parameters
150 CRM_Utils_System
::redirect(
151 CRM_Utils_System
::url(
152 'civicrm/contact/view/membership',
153 "action=view&reset=1&id={$owner['membership_id']}&cid={$owner['contact_id']}" . $this->addContext()
159 * Set variables up before form is built.
163 public function preProcess() {
165 $this->membershipID
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
166 $this->contactID
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
168 // Make sure context is assigned to template for condition where we come here view civicrm/membership/view
169 $context = CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this);
170 $this->assign('context', $context);
172 if ($this->membershipID
) {
173 $params = ['id' => $this->membershipID
];
174 CRM_Member_BAO_Membership
::retrieve($params, $values);
175 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
176 $finTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $values['membership_type_id'], 'financial_type_id');
177 $finType = CRM_Contribute_PseudoConstant
::financialType($finTypeId);
178 if (!CRM_Core_Permission
::check('view contributions of type ' . $finType)) {
179 CRM_Core_Error
::statusBounce(ts('You do not have permission to access this page.'));
183 $this->assign('noACL', TRUE);
185 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($values['membership_type_id']);
187 // Do the action on related Membership if needed
188 $relAction = CRM_Utils_Request
::retrieve('relAction', 'String', $this);
190 $this->relAction($relAction, $values);
193 // build associated contributions
194 $this->assign('accessContribution', FALSE);
195 if (CRM_Core_Permission
::access('CiviContribute')) {
196 $this->assign('accessContribution', TRUE);
197 CRM_Member_Page_Tab
::associatedContribution($values['contact_id'], $this->membershipID
);
200 //Provide information about membership source when it is the result of a relationship (CRM-1901)
201 $values['owner_membership_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
203 'owner_membership_id'
206 if (isset($values['owner_membership_id'])) {
207 $values['owner_contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
208 $values['owner_membership_id'],
213 $values['owner_display_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
214 $values['owner_contact_id'],
219 $direction = strrev($membershipType['relationship_direction']);
220 // To display relationship type in view membership page
221 $relTypeIds = str_replace(CRM_Core_DAO
::VALUE_SEPARATOR
, ",", $membershipType['relationship_type_id']);
223 SELECT relationship_type_id,
225 WHEN contact_id_a = {$values['owner_contact_id']} AND contact_id_b = {$values['contact_id']} THEN 'b_a'
226 WHEN contact_id_b = {$values['owner_contact_id']} AND contact_id_a = {$values['contact_id']} THEN 'a_b'
228 FROM civicrm_relationship
229 WHERE relationship_type_id IN ($relTypeIds)";
230 $dao = CRM_Core_DAO
::executeQuery($sql);
231 $values['relationship'] = NULL;
232 while ($dao->fetch()) {
233 $typeId = $dao->relationship_type_id
;
234 $direction = $dao->relType
;
235 if ($direction && $typeId) {
236 if ($values['relationship']) {
237 $values['relationship'] .= ',';
239 $values['relationship'] .= CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType',
248 $this->assign('has_related', FALSE);
249 // if membership can be granted, and we are the owner of the membership
250 if (!empty($membershipType['relationship_type_id']) && empty($values['owner_membership_id'])) {
251 // display related contacts/membership block
252 $this->assign('has_related', TRUE);
253 $this->assign('max_related', CRM_Utils_Array
::value('max_related', $values, ts('Unlimited')));
254 // split the relations in 2 arrays based on direction
255 $relTypeId = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_type_id']);
256 $relDirection = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_direction']);
257 foreach ($relTypeId as $rid) {
258 $relTypeDir[substr($relDirection[0], 0, 1)][] = $rid;
260 // build query in 2 parts with a UNION if necessary
261 // _x and _y are replaced with _a and _b first, then vice-versa
262 // comment is a qualifier for the relationship - now just job_title
264 SELECT r.id, c.id as cid, c.display_name as name, c.job_title as comment,
265 rt.name_x_y as relation, r.start_date, r.end_date,
266 m.id as mid, ms.is_current_member, ms.label as status
267 FROM civicrm_relationship r
268 LEFT JOIN civicrm_relationship_type rt ON rt.id = r.relationship_type_id
269 LEFT JOIN civicrm_contact c ON c.id = r.contact_id_x
270 LEFT JOIN civicrm_membership m ON (m.owner_membership_id = {$values['id']}
271 AND m.contact_id = r.contact_id_x AND m.is_test = 0)
272 LEFT JOIN civicrm_membership_status ms ON ms.id = m.status_id
273 WHERE r.contact_id_y = {$values['contact_id']} AND r.is_active = 1 AND c.is_deleted = 0";
275 foreach (['a', 'b'] as $dir) {
276 if (isset($relTypeDir[$dir])) {
277 $query .= ($query ?
' UNION ' : '')
278 . str_replace('_y', '_' . $dir, str_replace('_x', '_' . ($dir == 'a' ?
'b' : 'a'), $select))
279 . ' AND r.relationship_type_id IN (' . implode(',', $relTypeDir[$dir]) . ')';
282 $query .= " ORDER BY is_current_member DESC";
283 $dao = CRM_Core_DAO
::executeQuery($query);
285 $relatedRemaining = CRM_Utils_Array
::value('max_related', $values, PHP_INT_MAX
);
299 while ($dao->fetch()) {
301 foreach ($rowElememts as $field) {
302 $row[$field] = $dao->$field;
304 if ($row['mid'] && ($row['is_current_member'] == 1)) {
306 $row['action'] = CRM_Core_Action
::formLink(self
::links(), CRM_Core_Action
::DELETE
,
308 'id' => CRM_Utils_Request
::retrieve('id', 'Positive', $this),
309 'cid' => $row['cid'],
310 'mid' => $row['mid'],
314 'membership.relationship.action',
316 CRM_Utils_Request
::retrieve('id', 'Positive', $this)
320 if ($relatedRemaining > 0) {
321 $row['action'] = CRM_Core_Action
::formLink(self
::links(), CRM_Core_Action
::ADD
,
323 'id' => CRM_Utils_Request
::retrieve('id', 'Positive', $this),
324 'cid' => $row['cid'],
325 'rid' => $row['cid'],
329 'membership.relationship.action',
331 CRM_Utils_Request
::retrieve('id', 'Positive', $this)
337 $this->assign('related', $related);
338 if ($relatedRemaining <= 0) {
339 $this->assign('related_text', ts('None available'));
342 if ($relatedRemaining < 100000) {
343 $this->assign('related_text', ts('%1 available', [1 => $relatedRemaining]));
346 $this->assign('related_text', ts('Unlimited', [1 => $relatedRemaining]));
351 $displayName = CRM_Contact_BAO_Contact
::displayName($values['contact_id']);
352 $this->assign('displayName', $displayName);
354 // Check if this is default domain contact CRM-10482
355 if (CRM_Contact_BAO_Contact
::checkDomainContact($values['contact_id'])) {
356 $displayName .= ' (' . ts('default organization') . ')';
359 // omitting contactImage from title for now since the summary overlay css doesn't work outside crm-container
360 CRM_Utils_System
::setTitle(ts('View Membership for') . ' ' . $displayName);
362 // add viewed membership to recent items list
363 $recentTitle = $displayName . ' - ' . ts('Membership Type:') . ' ' . $values['membership_type'];
364 $url = CRM_Utils_System
::url('civicrm/contact/view/membership',
365 "action=view&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
369 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::UPDATE
)) {
370 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
371 "action=update&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
374 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::DELETE
)) {
375 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
376 "action=delete&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
379 CRM_Utils_Recent
::add($recentTitle,
383 $values['contact_id'],
388 CRM_Member_Page_Tab
::setContext($this, $values['contact_id']);
390 $memType = CRM_Core_DAO
::getFieldValue("CRM_Member_DAO_Membership", $this->membershipID
, "membership_type_id");
392 $groupTree = CRM_Core_BAO_CustomGroup
::getTree('Membership', NULL, $this->membershipID
, 0, $memType);
393 CRM_Core_BAO_CustomGroup
::buildCustomDataView($this, $groupTree, FALSE, NULL, NULL, NULL, $this->membershipID
);
395 $isRecur = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->membershipID
, 'contribution_recur_id');
397 $autoRenew = $isRecur ?
TRUE : FALSE;
400 if (!empty($values['is_test'])) {
401 $values['membership_type'] = CRM_Core_TestEntity
::appendTestText($values['membership_type']);
404 $subscriptionCancelled = CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->membershipID
);
405 $values['auto_renew'] = ($autoRenew && !$subscriptionCancelled) ?
'Yes' : 'No';
407 //do check for campaigns
408 if ($campaignId = CRM_Utils_Array
::value('campaign_id', $values)) {
409 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
410 $values['campaign'] = $campaigns[$campaignId];
413 $this->assign($values);
417 * Build the form object.
421 public function buildQuickForm() {
425 'name' => ts('Done'),
426 'spacing' => ' ',