927 lines
32 KiB
PHP
927 lines
32 KiB
PHP
<?php
|
|
/*
|
|
+--------------------------------------------------------------------+
|
|
| CiviCRM version 4.7 |
|
|
+--------------------------------------------------------------------+
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
|
+--------------------------------------------------------------------+
|
|
| This file is a part of CiviCRM. |
|
|
| |
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
|
| under the terms of the GNU Affero General Public License |
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
|
| |
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
|
| See the GNU Affero General Public License for more details. |
|
|
| |
|
|
| You should have received a copy of the GNU Affero General Public |
|
|
| License and the CiviCRM Licensing Exception along |
|
|
| with this program; if not, contact CiviCRM LLC |
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
|
+--------------------------------------------------------------------+
|
|
*/
|
|
|
|
/**
|
|
*
|
|
* @package CRM
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
|
*/
|
|
class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP {
|
|
|
|
/**
|
|
* The action links that we need to display for the browse screen.
|
|
*
|
|
* @var array
|
|
*/
|
|
static $_pcpLinks = NULL;
|
|
|
|
/**
|
|
* Class constructor.
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct();
|
|
}
|
|
|
|
/**
|
|
* Add or update either a Personal Campaign Page OR a PCP Block.
|
|
*
|
|
* @param array $params
|
|
* Values to create the pcp.
|
|
*
|
|
* @return object
|
|
*/
|
|
public static function create($params) {
|
|
|
|
$dao = new CRM_PCP_DAO_PCP();
|
|
$dao->copyValues($params);
|
|
|
|
// ensure we set status_id since it is a not null field
|
|
// we should change the schema and allow this to be null
|
|
if (!$dao->id && !isset($dao->status_id)) {
|
|
$dao->status_id = 0;
|
|
}
|
|
|
|
// set currency for CRM-1496
|
|
if (!isset($dao->currency)) {
|
|
$dao->currency = CRM_Core_Config::singleton()->defaultCurrency;
|
|
}
|
|
|
|
$dao->save();
|
|
return $dao;
|
|
}
|
|
|
|
/**
|
|
* Get the Display name of a contact for a PCP.
|
|
*
|
|
* @param int $id
|
|
* Id for the PCP.
|
|
*
|
|
* @return null|string
|
|
* Dispaly name of the contact if found
|
|
*/
|
|
public static function displayName($id) {
|
|
$id = CRM_Utils_Type::escape($id, 'Integer');
|
|
|
|
$query = "
|
|
SELECT civicrm_contact.display_name
|
|
FROM civicrm_pcp, civicrm_contact
|
|
WHERE civicrm_pcp.contact_id = civicrm_contact.id
|
|
AND civicrm_pcp.id = {$id}
|
|
";
|
|
return CRM_Core_DAO::singleValueQuery($query);
|
|
}
|
|
|
|
/**
|
|
* Return PCP Block info for dashboard.
|
|
*
|
|
* @param int $contactId
|
|
*
|
|
* @return array
|
|
* array of Pcp if found
|
|
*/
|
|
public static function getPcpDashboardInfo($contactId) {
|
|
$links = self::pcpLinks();
|
|
|
|
$query = "
|
|
SELECT pcp.*, block.is_tellfriend_enabled FROM civicrm_pcp pcp
|
|
LEFT JOIN civicrm_pcp_block block ON block.id = pcp.pcp_block_id
|
|
WHERE pcp.is_active = 1
|
|
AND pcp.contact_id = %1
|
|
ORDER BY page_type, page_id";
|
|
|
|
$params = array(1 => array($contactId, 'Integer'));
|
|
|
|
$pcpInfoDao = CRM_Core_DAO::executeQuery($query, $params);
|
|
$pcpInfo = array();
|
|
$hide = $mask = array_sum(array_keys($links['all']));
|
|
$contactPCPPages = array();
|
|
|
|
$event = CRM_Event_PseudoConstant::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )");
|
|
$contribute = CRM_Contribute_PseudoConstant::contributionPage();
|
|
$pcpStatus = CRM_Contribute_PseudoConstant::pcpStatus();
|
|
$approved = CRM_Utils_Array::key('Approved', $pcpStatus);
|
|
|
|
while ($pcpInfoDao->fetch()) {
|
|
$mask = $hide;
|
|
if ($links) {
|
|
$replace = array(
|
|
'pcpId' => $pcpInfoDao->id,
|
|
'pcpBlock' => $pcpInfoDao->pcp_block_id,
|
|
'pageComponent' => $pcpInfoDao->page_type,
|
|
);
|
|
}
|
|
|
|
$pcpLink = $links['all'];
|
|
$class = '';
|
|
|
|
if ($pcpInfoDao->status_id != $approved || $pcpInfoDao->is_active != 1) {
|
|
$class = 'disabled';
|
|
if (!$pcpInfoDao->is_tellfriend_enabled) {
|
|
$mask -= CRM_Core_Action::DETACH;
|
|
}
|
|
}
|
|
|
|
if ($pcpInfoDao->is_active == 1) {
|
|
$mask -= CRM_Core_Action::ENABLE;
|
|
}
|
|
else {
|
|
$mask -= CRM_Core_Action::DISABLE;
|
|
}
|
|
$action = CRM_Core_Action::formLink($pcpLink, $mask, $replace, ts('more'),
|
|
FALSE, 'pcp.dashboard.active', 'PCP', $pcpInfoDao->id);
|
|
$component = $pcpInfoDao->page_type;
|
|
$pageTitle = CRM_Utils_Array::value($pcpInfoDao->page_id, $$component);
|
|
|
|
$pcpInfo[] = array(
|
|
'pageTitle' => $pageTitle,
|
|
'pcpId' => $pcpInfoDao->id,
|
|
'pcpTitle' => $pcpInfoDao->title,
|
|
'pcpStatus' => $pcpStatus[$pcpInfoDao->status_id],
|
|
'action' => $action,
|
|
'class' => $class,
|
|
);
|
|
$contactPCPPages[$pcpInfoDao->page_type][] = $pcpInfoDao->page_id;
|
|
}
|
|
|
|
$excludePageClause = $clause = NULL;
|
|
if (!empty($contactPCPPages)) {
|
|
foreach ($contactPCPPages as $component => $entityIds) {
|
|
$excludePageClause[] = "
|
|
( target_entity_type = '{$component}'
|
|
AND target_entity_id NOT IN ( " . implode(',', $entityIds) . ") )";
|
|
}
|
|
|
|
$clause = ' AND ' . implode(' OR ', $excludePageClause);
|
|
}
|
|
|
|
$query = "
|
|
SELECT *
|
|
FROM civicrm_pcp_block block
|
|
LEFT JOIN civicrm_pcp pcp ON pcp.pcp_block_id = block.id
|
|
WHERE block.is_active = 1
|
|
{$clause}
|
|
GROUP BY block.id, pcp.id
|
|
ORDER BY target_entity_type, target_entity_id
|
|
";
|
|
$pcpBlockDao = CRM_Core_DAO::executeQuery($query);
|
|
$pcpBlock = array();
|
|
$mask = 0;
|
|
|
|
while ($pcpBlockDao->fetch()) {
|
|
if ($links) {
|
|
$replace = array(
|
|
'pageId' => $pcpBlockDao->target_entity_id,
|
|
'pageComponent' => $pcpBlockDao->target_entity_type,
|
|
);
|
|
}
|
|
$pcpLink = $links['add'];
|
|
$action = CRM_Core_Action::formLink($pcpLink, $mask, $replace, ts('more'),
|
|
FALSE, 'pcp.dashboard.other', "{$pcpBlockDao->target_entity_type}_PCP", $pcpBlockDao->target_entity_id);
|
|
$component = $pcpBlockDao->target_entity_type;
|
|
if ($pageTitle = CRM_Utils_Array::value($pcpBlockDao->target_entity_id, $$component)) {
|
|
$pcpBlock[] = array(
|
|
'pageId' => $pcpBlockDao->target_entity_id,
|
|
'pageTitle' => $pageTitle,
|
|
'action' => $action,
|
|
);
|
|
}
|
|
}
|
|
|
|
return array($pcpBlock, $pcpInfo);
|
|
}
|
|
|
|
/**
|
|
* Show the total amount for Personal Campaign Page on thermometer.
|
|
*
|
|
* @param array $pcpId
|
|
* Contains the pcp ID.
|
|
*
|
|
* @return float
|
|
* Total amount
|
|
*/
|
|
public static function thermoMeter($pcpId) {
|
|
$query = "
|
|
SELECT SUM(cc.total_amount) as total
|
|
FROM civicrm_pcp pcp
|
|
LEFT JOIN civicrm_contribution_soft cs ON ( pcp.id = cs.pcp_id )
|
|
LEFT JOIN civicrm_contribution cc ON ( cs.contribution_id = cc.id)
|
|
WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
|
|
|
|
$params = array(1 => array($pcpId, 'Integer'));
|
|
return CRM_Core_DAO::singleValueQuery($query, $params);
|
|
}
|
|
|
|
/**
|
|
* Show the amount, nickname on honor roll.
|
|
*
|
|
* @param array $pcpId
|
|
* Contains the pcp ID.
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function honorRoll($pcpId) {
|
|
$query = "
|
|
SELECT cc.id, cs.pcp_roll_nickname, cs.pcp_personal_note,
|
|
cc.total_amount, cc.currency
|
|
FROM civicrm_contribution cc
|
|
LEFT JOIN civicrm_contribution_soft cs ON cc.id = cs.contribution_id
|
|
WHERE cs.pcp_id = {$pcpId}
|
|
AND cs.pcp_display_in_roll = 1
|
|
AND contribution_status_id = 1
|
|
AND is_test = 0";
|
|
$dao = CRM_Core_DAO::executeQuery($query);
|
|
$honor = array();
|
|
while ($dao->fetch()) {
|
|
$honor[$dao->id]['nickname'] = ucwords($dao->pcp_roll_nickname);
|
|
$honor[$dao->id]['total_amount'] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
|
|
$honor[$dao->id]['personal_note'] = $dao->pcp_personal_note;
|
|
}
|
|
return $honor;
|
|
}
|
|
|
|
/**
|
|
* Get action links.
|
|
*
|
|
* @return array
|
|
* (reference) of action links
|
|
*/
|
|
public static function &pcpLinks() {
|
|
if (!(self::$_pcpLinks)) {
|
|
$deleteExtra = ts('Are you sure you want to delete this Personal Campaign Page?') . '\n' . ts('This action cannot be undone.');
|
|
|
|
self::$_pcpLinks['add'] = array(
|
|
CRM_Core_Action::ADD => array(
|
|
'name' => ts('Create a Personal Campaign Page'),
|
|
'class' => 'no-popup',
|
|
'url' => 'civicrm/contribute/campaign',
|
|
'qs' => 'action=add&reset=1&pageId=%%pageId%%&component=%%pageComponent%%',
|
|
'title' => ts('Configure'),
|
|
),
|
|
);
|
|
|
|
self::$_pcpLinks['all'] = array(
|
|
CRM_Core_Action::UPDATE => array(
|
|
'name' => ts('Edit Your Page'),
|
|
'url' => 'civicrm/pcp/info',
|
|
'qs' => 'action=update&reset=1&id=%%pcpId%%&component=%%pageComponent%%',
|
|
'title' => ts('Configure'),
|
|
),
|
|
CRM_Core_Action::DETACH => array(
|
|
'name' => ts('Tell Friends'),
|
|
'url' => 'civicrm/friend',
|
|
'qs' => 'eid=%%pcpId%%&blockId=%%pcpBlock%%&reset=1&pcomponent=pcp&component=%%pageComponent%%',
|
|
'title' => ts('Tell Friends'),
|
|
),
|
|
CRM_Core_Action::VIEW => array(
|
|
'name' => ts('URL for this Page'),
|
|
'url' => 'civicrm/pcp/info',
|
|
'qs' => 'reset=1&id=%%pcpId%%&component=%%pageComponent%%',
|
|
'title' => ts('URL for this Page'),
|
|
),
|
|
CRM_Core_Action::BROWSE => array(
|
|
'name' => ts('Update Contact Information'),
|
|
'url' => 'civicrm/pcp/info',
|
|
'qs' => 'action=browse&reset=1&id=%%pcpId%%&component=%%pageComponent%%',
|
|
'title' => ts('Update Contact Information'),
|
|
),
|
|
CRM_Core_Action::ENABLE => array(
|
|
'name' => ts('Enable'),
|
|
'url' => 'civicrm/pcp',
|
|
'qs' => 'action=enable&reset=1&id=%%pcpId%%&component=%%pageComponent%%',
|
|
'title' => ts('Enable'),
|
|
),
|
|
CRM_Core_Action::DISABLE => array(
|
|
'name' => ts('Disable'),
|
|
'url' => 'civicrm/pcp',
|
|
'qs' => 'action=disable&reset=1&id=%%pcpId%%&component=%%pageComponent%%',
|
|
'title' => ts('Disable'),
|
|
),
|
|
CRM_Core_Action::DELETE => array(
|
|
'name' => ts('Delete'),
|
|
'url' => 'civicrm/pcp',
|
|
'qs' => 'action=delete&reset=1&id=%%pcpId%%&component=%%pageComponent%%',
|
|
'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
|
|
'title' => ts('Delete'),
|
|
),
|
|
);
|
|
}
|
|
return self::$_pcpLinks;
|
|
}
|
|
|
|
/**
|
|
* Delete the campaign page.
|
|
*
|
|
* @param int $id
|
|
* Campaign page id.
|
|
*/
|
|
public static function deleteById($id) {
|
|
CRM_Utils_Hook::pre('delete', 'Campaign', $id, CRM_Core_DAO::$_nullArray);
|
|
|
|
$transaction = new CRM_Core_Transaction();
|
|
|
|
// delete from pcp table
|
|
$pcp = new CRM_PCP_DAO_PCP();
|
|
$pcp->id = $id;
|
|
$pcp->delete();
|
|
|
|
$transaction->commit();
|
|
|
|
CRM_Utils_Hook::post('delete', 'Campaign', $id, $pcp);
|
|
}
|
|
|
|
/**
|
|
* Build the form object.
|
|
*
|
|
* @param CRM_Core_Form $form
|
|
* Form object.
|
|
*/
|
|
public static function buildPCPForm($form) {
|
|
$form->addElement('checkbox', 'pcp_active', ts('Enable Personal Campaign Pages?'), NULL, array('onclick' => "return showHideByValue('pcp_active',true,'pcpFields','block','radio',false);"));
|
|
|
|
$form->addElement('checkbox', 'is_approval_needed', ts('Approval required'));
|
|
|
|
$profile = array();
|
|
$isUserRequired = NULL;
|
|
$config = CRM_Core_Config::singleton();
|
|
if ($config->userFramework != 'Standalone') {
|
|
$isUserRequired = 2;
|
|
}
|
|
CRM_Core_DAO::commonRetrieveAll('CRM_Core_DAO_UFGroup', 'is_cms_user', $isUserRequired, $profiles, array(
|
|
'title',
|
|
'is_active',
|
|
));
|
|
if (!empty($profiles)) {
|
|
foreach ($profiles as $key => $value) {
|
|
if ($value['is_active']) {
|
|
$profile[$key] = $value['title'];
|
|
}
|
|
}
|
|
$form->assign('profile', $profile);
|
|
}
|
|
|
|
$form->add('select', 'supporter_profile_id', ts('Supporter Profile'), array('' => ts('- select -')) + $profile, TRUE);
|
|
|
|
//CRM-15821 - To add new option for PCP "Owner" notification
|
|
$ownerNotifications = CRM_Core_OptionGroup::values('pcp_owner_notify');
|
|
$form->addRadio('owner_notify_id', ts('Owner Email Notification'), $ownerNotifications, NULL, '<br/>', TRUE);
|
|
|
|
$form->addElement('checkbox', 'is_tellfriend_enabled', ts("Allow 'Tell a friend' functionality"), NULL, array('onclick' => "return showHideByValue('is_tellfriend_enabled',true,'tflimit','table-row','radio',false);"));
|
|
|
|
$form->add('text',
|
|
'tellfriend_limit',
|
|
ts("'Tell a friend' maximum recipients limit"),
|
|
CRM_Core_DAO::getAttribute('CRM_PCP_DAO_PCPBlock', 'tellfriend_limit')
|
|
);
|
|
$form->addRule('tellfriend_limit', ts('Please enter a valid limit.'), 'integer');
|
|
|
|
$form->add('text',
|
|
'link_text',
|
|
ts("'Create Personal Campaign Page' link text"),
|
|
CRM_Core_DAO::getAttribute('CRM_PCP_DAO_PCPBlock', 'link_text')
|
|
);
|
|
|
|
$form->add('text', 'notify_email', ts('Notify Email'), CRM_Core_DAO::getAttribute('CRM_PCP_DAO_PCPBlock', 'notify_email'));
|
|
}
|
|
|
|
|
|
/**
|
|
* Add PCP form elements to a form.
|
|
*
|
|
* @param int $pcpId
|
|
* @param CRM_Core_Page $page
|
|
* @param null $elements
|
|
*/
|
|
public static function buildPcp($pcpId, &$page, &$elements = NULL) {
|
|
|
|
$prms = array('id' => $pcpId);
|
|
CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $prms, $pcpInfo);
|
|
if ($pcpSupporter = CRM_PCP_BAO_PCP::displayName($pcpId)) {
|
|
if ($pcpInfo['page_type'] == 'event') {
|
|
$pcp_supporter_text = ts('This event registration is being made thanks to the efforts of <strong>%1</strong>, who supports our campaign. ', array(1 => $pcpSupporter));
|
|
$text = CRM_PCP_BAO_PCP::getPcpBlockStatus($pcpInfo['page_id'], 'event');
|
|
if (!empty($text)) {
|
|
$pcp_supporter_text .= "You can support it as well - once you complete the registration, you will be able to create your own Personal Campaign Page!";
|
|
}
|
|
}
|
|
else {
|
|
$pcp_supporter_text = ts('This contribution is being made thanks to the efforts of <strong>%1</strong>, who supports our campaign. ', array(1 => $pcpSupporter));
|
|
$text = CRM_PCP_BAO_PCP::getPcpBlockStatus($pcpInfo['page_id'], 'contribute');
|
|
if (!empty($text)) {
|
|
$pcp_supporter_text .= "You can support it as well - once you complete the donation, you will be able to create your own Personal Campaign Page!";
|
|
}
|
|
}
|
|
|
|
$page->assign('pcpSupporterText', $pcp_supporter_text);
|
|
}
|
|
$page->assign('pcp', TRUE);
|
|
|
|
// build honor roll fields for registration form if supporter has honor roll enabled for their PCP
|
|
if ($pcpInfo['is_honor_roll']) {
|
|
$page->assign('is_honor_roll', TRUE);
|
|
$page->add('checkbox', 'pcp_display_in_roll', ts('Show my support in the public honor roll'), NULL, NULL,
|
|
array('onclick' => "showHideByValue('pcp_display_in_roll','','nameID|nickID|personalNoteID','block','radio',false); pcpAnonymous( );")
|
|
);
|
|
$extraOption = array('onclick' => "return pcpAnonymous( );");
|
|
$elements = array();
|
|
$elements[] = &$page->createElement('radio', NULL, '', ts('Include my name and message'), 0, $extraOption);
|
|
$elements[] = &$page->createElement('radio', NULL, '', ts('List my support anonymously'), 1, $extraOption);
|
|
$page->addGroup($elements, 'pcp_is_anonymous', NULL, ' ');
|
|
$page->_defaults['pcp_is_anonymous'] = 0;
|
|
|
|
$page->add('text', 'pcp_roll_nickname', ts('Name'), array('maxlength' => 30));
|
|
$page->add('textarea', "pcp_personal_note", ts('Personal Note'), array('style' => 'height: 3em; width: 40em;'));
|
|
}
|
|
else {
|
|
$page->assign('is_honor_roll', FALSE);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Process a PCP contribution.
|
|
*
|
|
* @param int $pcpId
|
|
* @param string $component
|
|
* @param string $entity
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function handlePcp($pcpId, $component, $entity) {
|
|
|
|
self::getPcpEntityTable($component);
|
|
|
|
if (!$pcpId) {
|
|
return FALSE;
|
|
}
|
|
|
|
$approvedId = CRM_Core_OptionGroup::getValue('pcp_status', 'Approved', 'name');
|
|
|
|
$pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
|
|
|
|
$params = array('id' => $pcpId);
|
|
CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
|
|
|
|
$params = array('id' => $pcpInfo['pcp_block_id']);
|
|
CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCPBlock', $params, $pcpBlock);
|
|
|
|
$params = array('id' => $pcpInfo['page_id']);
|
|
$now = time();
|
|
|
|
if ($component == 'event') {
|
|
// figure out where to redirect if an exception occurs below based on target entity
|
|
$urlBase = 'civicrm/event/register';
|
|
|
|
// ignore startDate for events - PCP's can be active long before event start date
|
|
$startDate = 0;
|
|
$endDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('end_date', $entity));
|
|
}
|
|
elseif ($component == 'contribute') {
|
|
$urlBase = 'civicrm/contribute/transact';
|
|
//start and end date of the contribution page
|
|
$startDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('start_date', $entity));
|
|
$endDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('end_date', $entity));
|
|
}
|
|
|
|
// define redirect url back to contrib page or event if needed
|
|
$url = CRM_Utils_System::url($urlBase, "reset=1&id={$pcpBlock['entity_id']}", FALSE, NULL, FALSE, TRUE);
|
|
|
|
if ($pcpBlock['target_entity_id'] != $entity['id']) {
|
|
$statusMessage = ts('This page is not related to the Personal Campaign Page you have just visited. However you can still make a contribution here.');
|
|
CRM_Core_Error::statusBounce($statusMessage, $url);
|
|
}
|
|
elseif ($pcpInfo['status_id'] != $approvedId) {
|
|
$statusMessage = ts('The Personal Campaign Page you have just visited is currently %1. However you can still support the campaign here.', array(1 => $pcpStatus[$pcpInfo['status_id']]));
|
|
CRM_Core_Error::statusBounce($statusMessage, $url);
|
|
}
|
|
elseif (empty($pcpBlock['is_active'])) {
|
|
$statusMessage = ts('Personal Campaign Pages are currently not enabled for this contribution page. However you can still support the campaign here.');
|
|
CRM_Core_Error::statusBounce($statusMessage, $url);
|
|
}
|
|
elseif (empty($pcpInfo['is_active'])) {
|
|
$statusMessage = ts('The Personal Campaign Page you have just visited is currently inactive. However you can still support the campaign here.');
|
|
CRM_Core_Error::statusBounce($statusMessage, $url);
|
|
}
|
|
// Check if we're in range for contribution page start and end dates. for events, check if after event end date
|
|
elseif (($startDate && $startDate > $now) || ($endDate && $endDate < $now)) {
|
|
$customStartDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('start_date', $entity));
|
|
$customEndDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('end_date', $entity));
|
|
if ($startDate && $endDate) {
|
|
$statusMessage = ts('The Personal Campaign Page you have just visited is only active from %1 to %2. However you can still support the campaign here.',
|
|
array(1 => $customStartDate, 2 => $customEndDate)
|
|
);
|
|
CRM_Core_Error::statusBounce($statusMessage, $url);
|
|
}
|
|
elseif ($startDate) {
|
|
$statusMessage = ts('The Personal Campaign Page you have just visited will be active beginning on %1. However you can still support the campaign here.', array(1 => $customStartDate));
|
|
CRM_Core_Error::statusBounce($statusMessage, $url);
|
|
}
|
|
elseif ($endDate) {
|
|
if ($component == 'event') {
|
|
// Target_entity is an event and the event is over, redirect to event info instead of event registration page.
|
|
$url = CRM_Utils_System::url('civicrm/event/info',
|
|
"reset=1&id={$pcpBlock['entity_id']}",
|
|
FALSE, NULL, FALSE, TRUE
|
|
);
|
|
$statusMessage = ts('The event linked to the Personal Campaign Page you have just visited is over (as of %1).', array(1 => $customEndDate));
|
|
CRM_Core_Error::statusBounce($statusMessage, $url);
|
|
}
|
|
else {
|
|
$statusMessage = ts('The Personal Campaign Page you have just visited is no longer active (as of %1). However you can still support the campaign here.', array(1 => $customEndDate));
|
|
CRM_Core_Error::statusBounce($statusMessage, $url);
|
|
}
|
|
}
|
|
}
|
|
|
|
return array(
|
|
'pcpId' => $pcpId,
|
|
'pcpBlock' => $pcpBlock,
|
|
'pcpInfo' => $pcpInfo,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Approve / Reject the campaign page.
|
|
*
|
|
* @param int $id
|
|
* Campaign page id.
|
|
*
|
|
* @param bool $is_active
|
|
*/
|
|
public static function setIsActive($id, $is_active) {
|
|
switch ($is_active) {
|
|
case 0:
|
|
$is_active = 3;
|
|
break;
|
|
|
|
case 1:
|
|
$is_active = 2;
|
|
break;
|
|
}
|
|
|
|
CRM_Core_DAO::setFieldValue('CRM_PCP_DAO_PCP', $id, 'status_id', $is_active);
|
|
|
|
$pcpTitle = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $id, 'title');
|
|
$pcpPageType = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $id, 'page_type');
|
|
|
|
$pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
|
|
$pcpStatus = $pcpStatus[$is_active];
|
|
|
|
CRM_Core_Session::setStatus(ts("%1 status has been updated to %2.", array(
|
|
1 => $pcpTitle,
|
|
2 => $pcpStatus,
|
|
)), 'Status Updated', 'success');
|
|
|
|
// send status change mail
|
|
$result = self::sendStatusUpdate($id, $is_active, FALSE, $pcpPageType);
|
|
|
|
if ($result) {
|
|
CRM_Core_Session::setStatus(ts("A notification email has been sent to the supporter."), ts('Email Sent'), 'success');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Send notification email to supporter.
|
|
*
|
|
* 1. when their PCP status is changed by site admin.
|
|
* 2. when supporter initially creates a Personal Campaign Page ($isInitial set to true).
|
|
*
|
|
* @param int $pcpId
|
|
* Campaign page id.
|
|
* @param int $newStatus
|
|
* Pcp status id.
|
|
* @param bool|int $isInitial is it the first time, campaign page has been created by the user
|
|
*
|
|
* @param string $component
|
|
*
|
|
* @throws Exception
|
|
* @return null
|
|
*/
|
|
public static function sendStatusUpdate($pcpId, $newStatus, $isInitial = FALSE, $component = 'contribute') {
|
|
$pcpStatusName = CRM_Core_OptionGroup::values("pcp_status", FALSE, FALSE, FALSE, NULL, 'name');
|
|
$pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
|
|
$config = CRM_Core_Config::singleton();
|
|
|
|
if (!isset($pcpStatus[$newStatus])) {
|
|
return FALSE;
|
|
}
|
|
|
|
require_once 'Mail/mime.php';
|
|
|
|
//set loginUrl
|
|
$loginURL = $config->userSystem->getLoginURL();
|
|
|
|
// used in subject templates
|
|
$contribPageTitle = self::getPcpPageTitle($pcpId, $component);
|
|
|
|
$tplParams = array(
|
|
'loginUrl' => $loginURL,
|
|
'contribPageTitle' => $contribPageTitle,
|
|
'pcpId' => $pcpId,
|
|
);
|
|
|
|
//get the default domain email address.
|
|
list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain::getNameAndEmail();
|
|
|
|
if (!$domainEmailAddress || $domainEmailAddress == 'info@EXAMPLE.ORG') {
|
|
$fixUrl = CRM_Utils_System::url("civicrm/admin/domain", 'action=update&reset=1');
|
|
CRM_Core_Error::fatal(ts('The site administrator needs to enter a valid \'FROM Email Address\' in <a href="%1">Administer CiviCRM » Communications » FROM Email Addresses</a>. The email address used may need to be a valid mail account with your email service provider.', array(1 => $fixUrl)));
|
|
}
|
|
|
|
$receiptFrom = '"' . $domainEmailName . '" <' . $domainEmailAddress . '>';
|
|
|
|
// get recipient (supporter) name and email
|
|
$params = array('id' => $pcpId);
|
|
CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
|
|
list($name, $address) = CRM_Contact_BAO_Contact_Location::getEmailDetails($pcpInfo['contact_id']);
|
|
|
|
// get pcp block info
|
|
list($blockId, $eid) = self::getPcpBlockEntityId($pcpId, $component);
|
|
$params = array('id' => $blockId);
|
|
CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCPBlock', $params, $pcpBlockInfo);
|
|
|
|
// assign urls required in email template
|
|
if ($pcpStatusName[$newStatus] == 'Approved') {
|
|
$tplParams['isTellFriendEnabled'] = $pcpBlockInfo['is_tellfriend_enabled'];
|
|
if ($pcpBlockInfo['is_tellfriend_enabled']) {
|
|
$pcpTellFriendURL = CRM_Utils_System::url('civicrm/friend',
|
|
"reset=1&eid=$pcpId&blockId=$blockId&pcomponent=pcp",
|
|
TRUE, NULL, FALSE, TRUE
|
|
);
|
|
$tplParams['pcpTellFriendURL'] = $pcpTellFriendURL;
|
|
}
|
|
}
|
|
$pcpInfoURL = CRM_Utils_System::url('civicrm/pcp/info',
|
|
"reset=1&id=$pcpId",
|
|
TRUE, NULL, FALSE, TRUE
|
|
);
|
|
$tplParams['pcpInfoURL'] = $pcpInfoURL;
|
|
$tplParams['contribPageTitle'] = $contribPageTitle;
|
|
if ($emails = CRM_Utils_Array::value('notify_email', $pcpBlockInfo)) {
|
|
$emailArray = explode(',', $emails);
|
|
$tplParams['pcpNotifyEmailAddress'] = $emailArray[0];
|
|
}
|
|
// get appropriate message based on status
|
|
$tplParams['pcpStatus'] = $pcpStatus[$newStatus];
|
|
|
|
$tplName = $isInitial ? 'pcp_supporter_notify' : 'pcp_status_change';
|
|
|
|
list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
|
|
array(
|
|
'groupName' => 'msg_tpl_workflow_contribution',
|
|
'valueName' => $tplName,
|
|
'contactId' => $pcpInfo['contact_id'],
|
|
'tplParams' => $tplParams,
|
|
'from' => $receiptFrom,
|
|
'toName' => $name,
|
|
'toEmail' => $address,
|
|
)
|
|
);
|
|
return $sent;
|
|
}
|
|
|
|
/**
|
|
* Enable / Disable the campaign page.
|
|
*
|
|
* @param int $id
|
|
* Campaign page id.
|
|
*
|
|
* @param bool $is_active
|
|
* @return null
|
|
*/
|
|
public static function setDisable($id, $is_active) {
|
|
return CRM_Core_DAO::setFieldValue('CRM_PCP_DAO_PCP', $id, 'is_active', $is_active);
|
|
}
|
|
|
|
/**
|
|
* Get pcp block is active.
|
|
*
|
|
* @param int $pcpId
|
|
* @param $component
|
|
*
|
|
* @return int
|
|
*/
|
|
public static function getStatus($pcpId, $component) {
|
|
$query = "
|
|
SELECT pb.is_active
|
|
FROM civicrm_pcp pcp
|
|
LEFT JOIN civicrm_pcp_block pb ON ( pcp.page_id = pb.entity_id )
|
|
WHERE pcp.id = %1
|
|
AND pb.entity_table = %2";
|
|
|
|
$entity_table = self::getPcpEntityTable($component);
|
|
|
|
$params = array(1 => array($pcpId, 'Integer'), 2 => array($entity_table, 'String'));
|
|
return CRM_Core_DAO::singleValueQuery($query, $params);
|
|
}
|
|
|
|
/**
|
|
* Get pcp block is enabled for component page.
|
|
*
|
|
* @param int $pageId
|
|
* @param $component
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function getPcpBlockStatus($pageId, $component) {
|
|
$query = "
|
|
SELECT pb.link_text as linkText
|
|
FROM civicrm_pcp_block pb
|
|
WHERE pb.is_active = 1 AND
|
|
pb.entity_id = %1 AND
|
|
pb.entity_table = %2";
|
|
|
|
$entity_table = self::getPcpEntityTable($component);
|
|
|
|
$params = array(1 => array($pageId, 'Integer'), 2 => array($entity_table, 'String'));
|
|
return CRM_Core_DAO::singleValueQuery($query, $params);
|
|
}
|
|
|
|
/**
|
|
* Find out if the PCP block is in use by one or more PCP page.
|
|
*
|
|
* @param int $id
|
|
* Pcp block id.
|
|
*
|
|
* @return Bool
|
|
*/
|
|
public static function getPcpBlockInUse($id) {
|
|
$query = "
|
|
SELECT count(*)
|
|
FROM civicrm_pcp pcp
|
|
WHERE pcp.pcp_block_id = %1";
|
|
|
|
$params = array(1 => array($id, 'Integer'));
|
|
$result = CRM_Core_DAO::singleValueQuery($query, $params);
|
|
return $result > 0;
|
|
}
|
|
|
|
/**
|
|
* Get email is enabled for supporter's profile
|
|
*
|
|
* @param int $profileId
|
|
* Supporter's profile id.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function checkEmailProfile($profileId) {
|
|
$query = "
|
|
SELECT field_name
|
|
FROM civicrm_uf_field
|
|
WHERE field_name like 'email%' And is_active = 1 And uf_group_id = %1";
|
|
|
|
$params = array(1 => array($profileId, 'Integer'));
|
|
$dao = CRM_Core_DAO::executeQuery($query, $params);
|
|
if (!$dao->fetch()) {
|
|
return TRUE;
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
* Obtain the title of page associated with a pcp.
|
|
*
|
|
* @param int $pcpId
|
|
* @param $component
|
|
*
|
|
* @return int
|
|
*/
|
|
public static function getPcpPageTitle($pcpId, $component) {
|
|
if ($component == 'contribute') {
|
|
$query = "
|
|
SELECT cp.title
|
|
FROM civicrm_pcp pcp
|
|
LEFT JOIN civicrm_contribution_page as cp ON ( cp.id = pcp.page_id )
|
|
WHERE pcp.id = %1";
|
|
}
|
|
elseif ($component == 'event') {
|
|
$query = "
|
|
SELECT ce.title
|
|
FROM civicrm_pcp pcp
|
|
LEFT JOIN civicrm_event as ce ON ( ce.id = pcp.page_id )
|
|
WHERE pcp.id = %1";
|
|
}
|
|
|
|
$params = array(1 => array($pcpId, 'Integer'));
|
|
return CRM_Core_DAO::singleValueQuery($query, $params);
|
|
}
|
|
|
|
/**
|
|
* Get pcp block & entity id given pcp id
|
|
*
|
|
* @param int $pcpId
|
|
* @param $component
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function getPcpBlockEntityId($pcpId, $component) {
|
|
$entity_table = self::getPcpEntityTable($component);
|
|
|
|
$query = "
|
|
SELECT pb.id as pcpBlockId, pb.entity_id
|
|
FROM civicrm_pcp pcp
|
|
LEFT JOIN civicrm_pcp_block pb ON ( pb.entity_id = pcp.page_id AND pb.entity_table = %2 )
|
|
WHERE pcp.id = %1";
|
|
|
|
$params = array(1 => array($pcpId, 'Integer'), 2 => array($entity_table, 'String'));
|
|
$dao = CRM_Core_DAO::executeQuery($query, $params);
|
|
if ($dao->fetch()) {
|
|
return array($dao->pcpBlockId, $dao->entity_id);
|
|
}
|
|
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Get pcp entity table given a component.
|
|
*
|
|
* @param $component
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function getPcpEntityTable($component) {
|
|
$entity_table_map = array(
|
|
'event' => 'civicrm_event',
|
|
'civicrm_event' => 'civicrm_event',
|
|
'contribute' => 'civicrm_contribution_page',
|
|
'civicrm_contribution_page' => 'civicrm_contribution_page',
|
|
);
|
|
return isset($entity_table_map[$component]) ? $entity_table_map[$component] : FALSE;
|
|
}
|
|
|
|
/**
|
|
* Get supporter profile id.
|
|
*
|
|
* @param int $component_id
|
|
* @param string $component
|
|
*
|
|
* @return int
|
|
*/
|
|
public static function getSupporterProfileId($component_id, $component = 'contribute') {
|
|
$entity_table = self::getPcpEntityTable($component);
|
|
|
|
$query = "
|
|
SELECT pcp.supporter_profile_id
|
|
FROM civicrm_pcp_block pcp
|
|
INNER JOIN civicrm_uf_group ufgroup
|
|
ON pcp.supporter_profile_id = ufgroup.id
|
|
WHERE pcp.entity_id = %1
|
|
AND pcp.entity_table = %2
|
|
AND ufgroup.is_active = 1";
|
|
|
|
$params = array(1 => array($component_id, 'Integer'), 2 => array($entity_table, 'String'));
|
|
if (!$supporterProfileId = CRM_Core_DAO::singleValueQuery($query, $params)) {
|
|
CRM_Core_Error::fatal(ts('Supporter profile is not set for this Personal Campaign Page or the profile is disabled. Please contact the site administrator if you need assistance.'));
|
|
}
|
|
else {
|
|
return $supporterProfileId;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get owner notification id.
|
|
*
|
|
* @param int $component_id
|
|
* @param $component
|
|
*
|
|
* @return int
|
|
*/
|
|
public static function getOwnerNotificationId($component_id, $component = 'contribute') {
|
|
$entity_table = self::getPcpEntityTable($component);
|
|
$query = "
|
|
SELECT pb.owner_notify_id
|
|
FROM civicrm_pcp_block pb
|
|
WHERE pb.entity_id = %1 AND pb.entity_table = %2";
|
|
$params = array(1 => array($component_id, 'Integer'), 2 => array($entity_table, 'String'));
|
|
if (!$ownerNotificationId = CRM_Core_DAO::singleValueQuery($query, $params)) {
|
|
CRM_Core_Error::fatal(ts('Owner Notification is not set for this Personal Campaign Page. Please contact the site administrator if you need assistance.'));
|
|
}
|
|
else {
|
|
return $ownerNotificationId;
|
|
}
|
|
}
|
|
|
|
}
|