/** * Function to set variables up before form is built * * @return void * @access public */ public function preProcess() { $config = CRM_Core_Config::singleton(); $session = CRM_Core_Session::singleton(); // current contribution page id $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this); if (!$this->_id) { // seems like the session is corrupted and/or we lost the id trail // lets just bump this to a regular session error and redirect user to main page $this->controller->invalidKeyRedirect(); } // this was used prior to the cleverer this_>getContactID - unsure now $this->_userID = $session->get('userID'); $this->_contactID = $this->_membershipContactID = $this->getContactID(); $this->_mid = NULL; if ($this->_contactID) { $this->_mid = CRM_Utils_Request::retrieve('mid', 'Positive', $this); if ($this->_mid) { $membership = new CRM_Member_DAO_Membership(); $membership->id = $this->_mid; if ($membership->find(TRUE)) { $this->_defaultMemTypeId = $membership->membership_type_id; if ($membership->contact_id != $this->_contactID) { $validMembership = FALSE; $employers = CRM_Contact_BAO_Relationship::getPermissionedEmployer($this->_userID); if (!empty($employers) && array_key_exists($membership->contact_id, $employers)) { $this->_membershipContactID = $membership->contact_id; $this->assign('membershipContactID', $this->_membershipContactID); $this->assign('membershipContactName', $employers[$this->_membershipContactID]['name']); $validMembership = TRUE; } else { $membershipType = new CRM_Member_BAO_MembershipType(); $membershipType->id = $membership->membership_type_id; if ($membershipType->find(TRUE)) { // CRM-14051 - membership_type.relationship_type_id is a CTRL-A padded string w one or more ID values. // Convert to commma separated list. $inheritedRelTypes = implode(CRM_Utils_Array::explodePadded($membershipType->relationship_type_id), ','); $permContacts = CRM_Contact_BAO_Relationship::getPermissionedContacts($this->_userID, $membershipType->relationship_type_id); if (array_key_exists($membership->contact_id, $permContacts)) { $this->_membershipContactID = $membership->contact_id; $validMembership = TRUE; } } } if (!$validMembership) { CRM_Core_Session::setStatus(ts("Oops. The membership you're trying to renew appears to be invalid. Contact your site administrator if you need assistance. If you continue, you will be issued a new membership."), ts('Membership Invalid'), 'alert'); } } } else { CRM_Core_Session::setStatus(ts("Oops. The membership you're trying to renew appears to be invalid. Contact your site administrator if you need assistance. If you continue, you will be issued a new membership."), ts('Membership Invalid'), 'alert'); } unset($membership); } } // we do not want to display recently viewed items, so turn off $this->assign('displayRecent', FALSE); // Contribution page values are cleared from session, so can't use normal Printer Friendly view. // Use Browser Print instead. $this->assign('browserPrint', TRUE); // action $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add'); $this->assign('action', $this->_action); // current mode $this->_mode = $this->_action == 1024 ? 'test' : 'live'; $this->_values = $this->get('values'); $this->_fields = $this->get('fields'); $this->_bltID = $this->get('bltID'); $this->_paymentProcessor = $this->get('paymentProcessor'); $this->_priceSetId = $this->get('priceSetId'); $this->_priceSet = $this->get('priceSet'); if (!$this->_values) { // get all the values from the dao object $this->_values = array(); $this->_fields = array(); CRM_Contribute_BAO_ContributionPage::setValues($this->_id, $this->_values); // check if form is active if (!CRM_Utils_Array::value('is_active', $this->_values)) { // form is inactive, die a fatal death CRM_Core_Error::fatal(ts('The page you requested is currently unavailable.')); } // also check for billing informatin // get the billing location type $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate'); // CRM-8108 remove ts around Billing location type //$this->_bltID = array_search( ts('Billing'), $locationTypes ); $this->_bltID = array_search('Billing', $locationTypes); if (!$this->_bltID) { CRM_Core_Error::fatal(ts('Please set a location type of %1', array(1 => 'Billing'))); } $this->set('bltID', $this->_bltID); // check for is_monetary status $isMonetary = CRM_Utils_Array::value('is_monetary', $this->_values); $isPayLater = CRM_Utils_Array::value('is_pay_later', $this->_values); //FIXME: to support multiple payment processors if ($isMonetary && (!$isPayLater || CRM_Utils_Array::value('payment_processor', $this->_values))) { $ppID = CRM_Utils_Array::value('payment_processor', $this->_values); if (!$ppID) { CRM_Core_Error::fatal(ts('A payment processor must be selected for this contribution page (contact the site administrator for assistance).')); } $ppIds = explode(CRM_Core_DAO::VALUE_SEPARATOR, $ppID); $this->_paymentProcessors = CRM_Financial_BAO_PaymentProcessor::getPayments($ppIds, $this->_mode); $this->set('paymentProcessors', $this->_paymentProcessors); //set default payment processor if (!empty($this->_paymentProcessors) && empty($this->_paymentProcessor)) { foreach ($this->_paymentProcessors as $ppId => $values) { if ($values['is_default'] == 1 || count($this->_paymentProcessors) == 1) { $defaultProcessorId = $ppId; break; } } } if (isset($defaultProcessorId)) { $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($defaultProcessorId, $this->_mode); $this->assign_by_ref('paymentProcessor', $this->_paymentProcessor); } if (!CRM_Utils_System::isNull($this->_paymentProcessors)) { foreach ($this->_paymentProcessors as $eachPaymentProcessor) { // check selected payment processor is active if (empty($eachPaymentProcessor)) { CRM_Core_Error::fatal(ts('A payment processor configured for this page might be disabled (contact the site administrator for assistance).')); } // ensure that processor has a valid config $this->_paymentObject =& CRM_Core_Payment::singleton($this->_mode, $eachPaymentProcessor, $this); $error = $this->_paymentObject->checkConfig(); if (!empty($error)) { CRM_Core_Error::fatal($error); } } } } // get price info // CRM-5095 CRM_Price_BAO_PriceSet::initSet($this, $this->_id, 'civicrm_contribution_page'); // this avoids getting E_NOTICE errors in php $setNullFields = array('amount_block_is_active', 'honor_block_is_active', 'is_allow_other_amount', 'footer_text'); foreach ($setNullFields as $f) { if (!isset($this->_values[$f])) { $this->_values[$f] = NULL; } } //check if Membership Block is enabled, if Membership Fields are included in profile //get membership section for this contribution page $this->_membershipBlock = CRM_Member_BAO_Membership::getMembershipBlock($this->_id); $this->set('membershipBlock', $this->_membershipBlock); if ($this->_values['custom_pre_id']) { $preProfileType = CRM_Core_BAO_UFField::getProfileType($this->_values['custom_pre_id']); } if ($this->_values['custom_post_id']) { $postProfileType = CRM_Core_BAO_UFField::getProfileType($this->_values['custom_post_id']); } if ((isset($postProfileType) && $postProfileType == 'Membership' || isset($preProfileType) && $preProfileType == 'Membership') && !$this->_membershipBlock['is_active']) { CRM_Core_Error::fatal(ts('This page includes a Profile with Membership fields - but the Membership Block is NOT enabled. Please notify the site administrator.')); } $pledgeBlock = CRM_Pledge_BAO_PledgeBlock::getPledgeBlock($this->_id); if ($pledgeBlock) { $this->_values['pledge_block_id'] = CRM_Utils_Array::value('id', $pledgeBlock); $this->_values['max_reminders'] = CRM_Utils_Array::value('max_reminders', $pledgeBlock); $this->_values['initial_reminder_day'] = CRM_Utils_Array::value('initial_reminder_day', $pledgeBlock); $this->_values['additional_reminder_day'] = CRM_Utils_Array::value('additional_reminder_day', $pledgeBlock); //set pledge id in values $pledgeId = CRM_Utils_Request::retrieve('pledgeId', 'Positive', $this); //authenticate pledge user for pledge payment. if ($pledgeId) { $this->_values['pledge_id'] = $pledgeId; //lets override w/ pledge campaign. $this->_values['campaign_id'] = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_Pledge', $pledgeId, 'campaign_id'); self::authenticatePledgeUser(); } } $this->set('values', $this->_values); $this->set('fields', $this->_fields); } // Handle PCP $pcpId = CRM_Utils_Request::retrieve('pcpId', 'Positive', $this); if ($pcpId) { $pcp = CRM_PCP_BAO_PCP::handlePcp($pcpId, 'contribute', $this->_values); $this->_pcpId = $pcp['pcpId']; $this->_pcpBlock = $pcp['pcpBlock']; $this->_pcpInfo = $pcp['pcpInfo']; } // Link (button) for users to create their own Personal Campaign page if ($linkText = CRM_PCP_BAO_PCP::getPcpBlockStatus($this->_id, 'contribute')) { $linkTextUrl = CRM_Utils_System::url('civicrm/contribute/campaign', "action=add&reset=1&pageId={$this->_id}&component=contribute", FALSE, NULL, TRUE); $this->assign('linkTextUrl', $linkTextUrl); $this->assign('linkText', $linkText); } //set pledge block if block id is set if (CRM_Utils_Array::value('pledge_block_id', $this->_values)) { $this->assign('pledgeBlock', TRUE); } // check if one of the (amount , membership) bloks is active or not $this->_membershipBlock = $this->get('membershipBlock'); if (!$this->_values['amount_block_is_active'] && !$this->_membershipBlock['is_active'] && !$this->_priceSetId) { CRM_Core_Error::fatal(ts('The requested online contribution page is missing a required Contribution Amount section or Membership section or Price Set. Please check with the site administrator for assistance.')); } if ($this->_values['amount_block_is_active']) { $this->set('amount_block_is_active', $this->_values['amount_block_is_active']); } $this->_contributeMode = $this->get('contributeMode'); $this->assign('contributeMode', $this->_contributeMode); //assigning is_monetary and is_email_receipt to template $this->assign('is_monetary', $this->_values['is_monetary']); $this->assign('is_email_receipt', $this->_values['is_email_receipt']); $this->assign('bltID', $this->_bltID); //assign cancelSubscription URL to templates $this->assign('cancelSubscriptionUrl', CRM_Utils_Array::value('cancelSubscriptionUrl', $this->_values)); // assigning title to template in case someone wants to use it, also setting CMS page title if ($this->_pcpId) { $this->assign('title', $this->_pcpInfo['title']); CRM_Utils_System::setTitle($this->_pcpInfo['title']); } else { $this->assign('title', $this->_values['title']); CRM_Utils_System::setTitle($this->_values['title']); } $this->_defaults = array(); $this->_amount = $this->get('amount'); //CRM-6907 $config = CRM_Core_Config::singleton(); $config->defaultCurrency = CRM_Utils_Array::value('currency', $this->_values, $config->defaultCurrency); //lets allow user to override campaign. $campID = CRM_Utils_Request::retrieve('campID', 'Positive', $this); if ($campID && CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Campaign', $campID)) { $this->_values['campaign_id'] = $campID; } //do check for cancel recurring and clean db, CRM-7696 if (CRM_Utils_Request::retrieve('cancel', 'Boolean', CRM_Core_DAO::$_nullObject)) { self::cancelRecurring(); } }
/** * Get a Membership Type. * * This api is used for finding an existing membership type. * Required parameters : id of membership type * * @param array $params an associative array of name/value property values of civicrm_membership_type * * @return Array of all found membership type property values. * @access public */ function crm_get_membership_types($params) { _crm_initialize(); if (!is_array($params)) { return _crm_error('Params is not an array.'); } if (!isset($params['id'])) { return _crm_error('Required parameters missing.'); } require_once 'CRM/Member/BAO/MembershipType.php'; $membershipTypeBAO = new CRM_Member_BAO_MembershipType(); $properties = array_keys($membershipTypeBAO->fields()); foreach ($properties as $name) { if (array_key_exists($name, $params)) { $membershipTypeBAO->{$name} = $params[$name]; } } if ($membershipTypeBAO->find()) { $membershipType = array(); while ($membershipTypeBAO->fetch()) { _crm_object_to_array(clone $membershipTypeBAO, $membershipType); $membershipTypes[$membershipTypeBAO->id] = $membershipType; } } else { return _crm_error('Exact match not found'); } return $membershipTypes; }
/** * Update an existing membership type * * This api is used for updating an existing membership type. * Required parrmeters : id of a membership type * * @param Array $params an associative array of name/value property values of civicrm_membership_type * * @return array of updated membership type property values * @access public */ function &civicrm_membership_type_update(&$params) { if (!is_array($params)) { return civicrm_create_error('Params need to be of type array!'); } if (empty($params)) { return civicrm_create_error('No input parameters present'); } if (!isset($params['id'])) { return civicrm_create_error('Required parameter missing'); } require_once 'CRM/Member/BAO/MembershipType.php'; $membershipTypeBAO = new CRM_Member_BAO_MembershipType(); $membershipTypeBAO->id = $params['id']; if ($membershipTypeBAO->find(true)) { $fields = $membershipTypeBAO->fields(); foreach ($fields as $name => $field) { if (array_key_exists($field['name'], $params)) { $membershipTypeBAO->{$field}['name'] = $params[$field['name']]; } } $membershipTypeBAO->save(); } $membershipType = array(); _civicrm_object_to_array($membershipTypeBAO, $membershipType); $membershipTypeBAO->free(); return $membershipType; }
/** * Get a Membership Type. * * This api is used for finding an existing membership type. * * @param array $params an associative array of name/value property values of civicrm_membership_type * * @return Array of all found membership type property values. * @access public */ function civicrm_membership_type_get(&$params) { _civicrm_initialize(); if (!is_array($params)) { return civicrm_create_error('Params need to be of type array!'); } if (empty($params)) { return civicrm_create_error('No input parameters present'); } require_once 'CRM/Member/BAO/MembershipType.php'; $membershipTypeBAO = new CRM_Member_BAO_MembershipType(); $properties = array_keys($membershipTypeBAO->fields()); foreach ($properties as $name) { if (array_key_exists($name, $params)) { $membershipTypeBAO->{$name} = $params[$name]; } } if ($membershipTypeBAO->find()) { $membershipType = array(); while ($membershipTypeBAO->fetch()) { _civicrm_object_to_array(clone $membershipTypeBAO, $membershipType); $membershipTypes[$membershipTypeBAO->id] = $membershipType; } } else { return civicrm_create_error('Exact match not found'); } return $membershipTypes; }
/** * The function checks and updates the status of all membership records for a given domain using the * calc_membership_status and update_contact_membership APIs. * * IMPORTANT: * It uses the default Domain FROM Name and FROM Email Address as the From email address for emails sent by this api. * Verify that this value has been properly set from Administer > Configure > Domain Information * If you want to use some other FROM email address, modify line 125 and set your valid email address. * * @return array $result * @access public */ static function updateAllMembershipStatus() { require_once 'api/api.php'; //get all active statuses of membership, CRM-3984 $allStatus = CRM_Member_PseudoConstant::membershipStatus(); $statusLabels = CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label'); $allTypes = CRM_Member_PseudoConstant::membershipType(); $contribStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); $query = "\nSELECT civicrm_membership.id as membership_id,\n civicrm_membership.is_override as is_override,\n civicrm_membership.reminder_date as reminder_date,\n civicrm_membership.membership_type_id as membership_type_id,\n civicrm_membership.status_id as status_id,\n civicrm_membership.join_date as join_date,\n civicrm_membership.start_date as start_date,\n civicrm_membership.end_date as end_date,\n civicrm_membership.source as source,\n civicrm_contact.id as contact_id,\n civicrm_contact.is_deceased as is_deceased,\n civicrm_membership.owner_membership_id as owner_membership_id,\n civicrm_membership.contribution_recur_id as recur_id\nFROM civicrm_membership\nINNER JOIN civicrm_contact ON ( civicrm_membership.contact_id = civicrm_contact.id )\nWHERE civicrm_membership.is_test = 0"; $params = array(); $dao = CRM_Core_DAO::executeQuery($query, $params); $today = date("Y-m-d"); $processCount = 0; $updateCount = 0; $reminderCount = 0; $smarty = CRM_Core_Smarty::singleton(); $domainValues = CRM_Core_BAO_Domain::getNameAndEmail(); $domainFromEmail = "{$domainValues['0']} <{$domainValues['1']}>"; //use domain email address as a default From email. $fromEmailAddress = $domainFromEmail; while ($dao->fetch()) { // echo "."; $processCount++; /** $count++; echo $dao->contact_id . ', '. CRM_Utils_System::memory( ) . "<p>\n"; CRM_Core_Error::debug( 'fBegin', count( $GLOBALS['_DB_DATAOBJECT']['RESULTS'] ) ); if ( $count > 2 ) { foreach ( $GLOBALS['_DB_DATAOBJECT']['RESULTS'] as $r ) { CRM_Core_Error::debug( 'r', $r->query ); } // CRM_Core_Error::debug( 'f', $GLOBALS['_DB_DATAOBJECT']['RESULTS'] ); exit( ); } **/ // Put common parameters into array for easy access $memberParams = array('id' => $dao->membership_id, 'status_id' => $dao->status_id, 'contact_id' => $dao->contact_id, 'membership_type_id' => $dao->membership_type_id, 'membership_type' => $allTypes[$dao->membership_type_id], 'join_date' => $dao->join_date, 'start_date' => $dao->start_date, 'end_date' => $dao->end_date, 'reminder_date' => $dao->reminder_date, 'source' => $dao->source, 'skipStatusCal' => TRUE, 'skipRecentView' => TRUE); $smarty->assign_by_ref('memberParams', $memberParams); //update membership record to Deceased if contact is deceased if ($dao->is_deceased) { // check for 'Deceased' membership status, CRM-5636 $deceaseStatusId = array_search('Deceased', $allStatus); if (!$deceaseStatusId) { CRM_Core_Error::fatal(ts("Deceased Membership status is missing or not active. <a href='%1'>Click here to check</a>.", array(1 => CRM_Utils_System::url('civicrm/admin/member/membershipStatus', 'reset=1')))); } //process only when status change. if ($dao->status_id != $deceaseStatusId) { //take all params that need to save. $deceasedMembership = $memberParams; $deceasedMembership['status_id'] = $deceaseStatusId; $deceasedMembership['createActivity'] = TRUE; $deceasedMembership['version'] = 3; //since there is change in status. $statusChange = array('status_id' => $deceaseStatusId); $smarty->append_by_ref('memberParams', $statusChange, TRUE); //process membership record. civicrm_api('membership', 'create', $deceasedMembership); } continue; } //we fetch related, since we need to check for deceased //now further processing is handle w/ main membership record. if ($dao->owner_membership_id) { continue; } //update membership records where status is NOT - Pending OR Cancelled. //as well as membership is not override. //skipping Expired membership records -> reduced extra processing( kiran ) if (!$dao->is_override && !in_array($dao->status_id, array(array_search('Pending', $allStatus), array_search('Cancelled', $allStatus), array_search('Expired', $allStatus)))) { // CRM-7248: added excludeIsAdmin param to the following fn call to prevent moving to admin statuses //get the membership status as per id. $newStatus = civicrm_api('membership_status', 'calc', array('membership_id' => $dao->membership_id, 'version' => 3, 'ignore_admin_only' => FALSE), TRUE); $statusId = CRM_Utils_Array::value('id', $newStatus); //process only when status change. if ($statusId && $statusId != $dao->status_id) { //take all params that need to save. $memParams = $memberParams; $memParams['status_id'] = $statusId; $memParams['createActivity'] = TRUE; $memParams['version'] = 3; //since there is change in status. $statusChange = array('status_id' => $statusId); $smarty->append_by_ref('memberParams', $statusChange, TRUE); //process member record. civicrm_api('membership', 'create', $memParams); $updateCount++; } } //convert date from string format to timestamp format $reminder_date = CRM_Utils_DATE::unixTime($dao->reminder_date); $today_date = CRM_Utils_DATE::unixTime($today); //send reminder for membership renewal if ($dao->reminder_date && $dao->reminder_date != '0000-00-00' && $reminder_date <= $today_date) { $memType = new CRM_Member_BAO_MembershipType(); $memType->id = $dao->membership_type_id; $memType->find(TRUE); $renewalMsgId = $memType->renewal_msg_id; if ($memType->autorenewal_msg_id && $dao->recur_id) { $contribStatusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionRecur', $dao->recur_id, 'contribution_status_id'); if ($contribStatusId != array_search('Cancelled', $contribStatus)) { $renewalMsgId = $memType->autorenewal_msg_id; } } if ($renewalMsgId) { $toEmail = CRM_Contact_BAO_Contact::getPrimaryEmail($dao->contact_id); if ($toEmail) { $sendResult = CRM_Core_BAO_MessageTemplates::sendReminder($dao->contact_id, $toEmail, $renewalMsgId, $fromEmailAddress); if (!$sendResult || is_a($sendResult, 'PEAR_Error')) { // we could not send an email, for now we ignore // CRM-3406 // at some point we might decide to do something } else { $reminderCount++; } //set membership reminder date to NULL since we've sent the reminder. CRM_Core_DAO::setFieldValue('CRM_Member_DAO_Membership', $dao->membership_id, 'reminder_date', 'null'); // insert the activity log record. $config = CRM_Core_Config::singleton(); $activityParams = array(); $activityParams['subject'] = $allTypes[$dao->membership_type_id] . ": Status - " . $statusLabels[$newStatus['id']] . ", End Date - " . CRM_Utils_Date::customFormat(CRM_Utils_Date::isoToMysql($dao->end_date), $config->dateformatFull); $activityParams['source_record_id'] = $dao->membership_id; $session = CRM_Core_Session::singleton(); $activityParams['source_contact_id'] = $session->get('userID') ? $session->get('userID') : $dao->contact_id; $activityParams['assignee_contact_id'] = $dao->contact_id; $activityParams['activity_date_time'] = date('YmdHis'); static $actRelIds = array(); if (!isset($actRelIds['activity_type_id'])) { $actRelIds['activity_type_id'] = CRM_Core_OptionGroup::getValue('activity_type', 'Membership Renewal Reminder', 'name'); } $activityParams['activity_type_id'] = $actRelIds['activity_type_id']; if (!isset($actRelIds['activity_status_id'])) { $actRelIds['activity_status_id'] = CRM_Core_OptionGroup::getValue('activity_status', 'Completed', 'name'); } $activityParams['status_id'] = $actRelIds['activity_status_id']; static $msgTpl = array(); if (!isset($msgTpl[$memType->renewal_msg_id])) { $msgTpl[$memType->renewal_msg_id] = array(); $messageTemplate = new CRM_Core_DAO_MessageTemplates(); $messageTemplate->id = $memType->renewal_msg_id; if ($messageTemplate->find(TRUE)) { $msgTpl[$memType->renewal_msg_id]['subject'] = $messageTemplate->msg_subject; $msgTpl[$memType->renewal_msg_id]['details'] = $messageTemplate->msg_text; } $messageTemplate->free(); } $activityParams['details'] = "Subject: {$msgTpl[$memType->renewal_msg_id]['subject']}\nMessage: {$msgTpl[$memType->renewal_msg_id]['details']}\n"; $activity = CRM_Activity_BAO_Activity::create($activityParams); } } $memType->free(); } // CRM_Core_Error::debug( 'fEnd', count( $GLOBALS['_DB_DATAOBJECT']['RESULTS'] ) ); } $result['is_error'] = 0; $result['messages'] = ts('Processed %1 membership records. Updated %2 records. Sent %3 renewal reminders.', array(1 => $processCount, 2 => $updateCount, 3 => $reminderCount)); return $result; }