-
civicrm/campaign/add
New Campaign
diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php
index d8aa69d2e82b..d6d3c55cd9d4 100644
--- a/CRM/Case/BAO/Case.php
+++ b/CRM/Case/BAO/Case.php
@@ -3019,33 +3019,47 @@ public static function buildOptions($fieldName, $context = NULL, $props = []) {
* @inheritDoc
*/
public function addSelectWhereClause(string $entityName = NULL, int $userId = NULL, array $conditions = []): array {
+ $administerCases = CRM_Core_Permission::check('administer CiviCase', $userId);
+ $viewMyCases = CRM_Core_Permission::check('access my cases and activities', $userId);
+ $viewAllCases = CRM_Core_Permission::check('access all cases and activities', $userId);
+
// We always return an array with these keys, even if they are empty,
// because this tells the query builder that we have considered these fields for acls
$clauses = [
'id' => [],
// Only case admins can view deleted cases
- 'is_deleted' => CRM_Core_Permission::check('administer CiviCase') ? [] : ["= 0"],
+ 'is_deleted' => $administerCases ? [] : ['= 0'],
];
- // Ensure the user has permission to view the case client
- $contactClause = CRM_Utils_SQL::mergeSubquery('Contact');
- if ($contactClause) {
- $contactClause = implode(' AND contact_id ', $contactClause);
- $clauses['id'][] = "IN (SELECT case_id FROM civicrm_case_contact WHERE contact_id $contactClause)";
- }
- // The api gatekeeper ensures the user has at least "access my cases and activities"
- // so if they do not have permission to see all cases we'll assume they can only access their own
- if (!CRM_Core_Permission::check('access all cases and activities')) {
- $user = (int) CRM_Core_Session::getLoggedInContactID();
- $clauses['id'][] = "IN (
- SELECT r.case_id FROM civicrm_relationship r, civicrm_case_contact cc WHERE r.is_active = 1 AND cc.case_id = r.case_id AND (
- (r.contact_id_a = cc.contact_id AND r.contact_id_b = $user) OR (r.contact_id_b = cc.contact_id AND r.contact_id_a = $user)
- )
- )";
+
+ // No CiviCase access
+ if (!$viewAllCases && !$viewMyCases) {
+ $clauses['id'][] = 'IS NULL';
+ }
+ else {
+ // Enforce permission to view the case client
+ $contactClause = CRM_Utils_SQL::mergeSubquery('Contact');
+ if ($contactClause) {
+ $contactClause = implode(' AND contact_id ', $contactClause);
+ $clauses['id'][] = "IN (SELECT case_id FROM civicrm_case_contact WHERE contact_id $contactClause)";
+ }
+ // User can only access their own cases
+ if (!$viewAllCases) {
+ $clauses['id'][] = self::getAccessMyCasesClause($userId);
+ }
}
CRM_Utils_Hook::selectWhereClause($this, $clauses, $userId, $conditions);
return $clauses;
}
+ private static function getAccessMyCasesClause(int $userId = NULL): string {
+ $user = $userId ?? (int) CRM_Core_Session::getLoggedInContactID();
+ return "IN (
+ SELECT r.case_id FROM civicrm_relationship r, civicrm_case_contact cc WHERE r.is_active = 1 AND cc.case_id = r.case_id AND (
+ (r.contact_id_a = cc.contact_id AND r.contact_id_b = $user) OR (r.contact_id_b = cc.contact_id AND r.contact_id_a = $user)
+ )
+ )";
+ }
+
/**
* CRM-20308: Method to get the contact id to use as from contact for email copy
* 1. Activity Added by Contact's email address
diff --git a/CRM/Case/DAO/Case.php b/CRM/Case/DAO/Case.php
index 08d048818b67..cc6544671c1e 100644
--- a/CRM/Case/DAO/Case.php
+++ b/CRM/Case/DAO/Case.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Case/Case.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:83be6db09d4f5220f74ccc72149dcab6)
+ * (GenCodeChecksum:b5dbbb96b15e9ff288890017d324b984)
*/
/**
@@ -45,6 +45,15 @@ class CRM_Case_DAO_Case extends CRM_Core_DAO {
*/
public static $_log = TRUE;
+ /**
+ * Paths for accessing this entity in the UI.
+ *
+ * @var string[]
+ */
+ protected static $_paths = [
+ 'view' => 'civicrm/contact/view/case?action=view&reset=1&id=[id]',
+ ];
+
/**
* Unique Case ID
*
diff --git a/CRM/Case/Form/Activity.php b/CRM/Case/Form/Activity.php
index e959a9423291..6a82870900c9 100644
--- a/CRM/Case/Form/Activity.php
+++ b/CRM/Case/Form/Activity.php
@@ -203,10 +203,7 @@ public function setDefaultValues() {
}
$this->assign('targetContactValues', empty($targetContactValues) ? FALSE : $targetContactValues);
- if (isset($this->_encounterMedium)) {
- $this->_defaults['medium_id'] = $this->_encounterMedium;
- }
- elseif (empty($this->_defaults['medium_id'])) {
+ if (empty($this->_defaults['medium_id'])) {
// set default encounter medium CRM-4816
$medium = CRM_Core_OptionGroup::values('encounter_medium', FALSE, FALSE, FALSE, 'AND is_default = 1');
if (count($medium) == 1) {
@@ -266,22 +263,13 @@ public function buildQuickForm() {
$this->assign('urlPath', 'civicrm/case/activity');
- $encounterMediums = CRM_Case_PseudoConstant::encounterMedium();
-
if ($this->_activityTypeFile == 'OpenCase' && $this->_action == CRM_Core_Action::UPDATE) {
$this->getElement('activity_date_time')->freeze();
-
- if ($this->_activityId) {
- // Fixme: what's the justification for this? It seems like it is just re-adding an option in case it is the default and disabled.
- // Is that really a big problem?
- $this->_encounterMedium = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $this->_activityId, 'medium_id');
- if (!array_key_exists($this->_encounterMedium, $encounterMediums)) {
- $encounterMediums[$this->_encounterMedium] = CRM_Core_PseudoConstant::getLabel('CRM_Activity_BAO_Activity', 'medium_id', $this->_encounterMedium);
- }
- }
}
- $this->add('select', 'medium_id', ts('Medium'), $encounterMediums, TRUE);
+ $this->addSelect('medium_id');
+
+ // Related contacts
$i = 0;
foreach ($this->_caseId as $key => $val) {
$this->_relatedContacts[] = $rgc = CRM_Case_BAO_Case::getRelatedAndGlobalContacts($val);
@@ -394,7 +382,7 @@ public function postProcess($params = NULL) {
// store the submitted values in an array
// Explanation for why we only check the is_unittest element: Prior to adding that check, there was no check and so any $params passed in would have been overwritten. Just in case somebody is passing in some non-null params and that broken code would have inadvertently been working, we can maintain backwards compatibility by only checking for the is_unittest parameter, and so that broken code will still work. At the same time this allows unit tests to pass in a $params without it getting overwritten. See also PR #2077 for some discussion of when the $params parameter was added as a passed in variable.
if (empty($params['is_unittest'])) {
- $params = $this->controller->exportValues($this->_name);
+ $params = $this->getSubmittedValues();
}
//set parent id if its edit mode
diff --git a/CRM/Case/Form/CaseView.php b/CRM/Case/Form/CaseView.php
index 24c0f4552c7a..6ef33b6d899c 100644
--- a/CRM/Case/Form/CaseView.php
+++ b/CRM/Case/Form/CaseView.php
@@ -49,6 +49,8 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form {
*/
public $_contactID;
+ private $_caseClients;
+
/**
* ID of case being viewed
*
@@ -100,9 +102,21 @@ public function preProcess() {
$this->_hasAccessToAllCases = CRM_Core_Permission::check('access all cases and activities');
$this->assign('hasAccessToAllCases', $this->_hasAccessToAllCases);
- $this->assign('contactID', $this->_contactID = (int) $this->get('cid'));
$this->assign('caseID', $this->_caseID = (int) $this->get('id'));
+ $this->_caseClients = CRM_Case_BAO_Case::getContactNames($this->_caseID);
+
+ $cid = $this->get('cid');
+
+ // If no cid supplied, use first case client
+ if (!$cid) {
+ $cid = array_keys($this->_caseClients)[0];
+ }
+ elseif (!isset($this->_caseClients[$cid])) {
+ CRM_Core_Error::statusBounce("Contact $cid not a client of case " . $this->_caseID);
+ }
+ $this->assign('contactID', $this->_contactID = (int) $cid);
+
// Access check.
if (!CRM_Case_BAO_Case::accessCase($this->_caseID, FALSE)) {
CRM_Core_Error::statusBounce(ts('You do not have permission to access this case.'));
@@ -147,7 +161,7 @@ public function preProcess() {
"action=view&reset=1&id={$this->_caseID}&cid={$this->_contactID}&context=home"
);
- $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactID);
+ $displayName = $this->_caseClients[$this->_contactID]['display_name'];
$this->assign('displayName', $displayName);
$this->setTitle($displayName . ' - ' . $caseType);
@@ -366,7 +380,7 @@ public function buildQuickForm() {
$this->assign('caseRelationships', $caseRelationships);
//also add client as role. CRM-4438
- $caseRoles['client'] = CRM_Case_BAO_Case::getContactNames($this->_caseID);
+ $caseRoles['client'] = $this->_caseClients;
$this->assign('caseRoles', $caseRoles);
@@ -443,16 +457,16 @@ public function buildQuickForm() {
'entity_table' => 'civicrm_case',
'tag_id.parent_id.is_tagset' => 1,
'options' => ['limit' => 0],
- 'return' => ["tag_id.parent_id", "tag_id.parent_id.name", "tag_id.name"],
+ 'return' => ["tag_id.parent_id", "tag_id.parent_id.label", "tag_id.label"],
]);
foreach ($tagSetItems['values'] as $tag) {
$tagSetTags += [
$tag['tag_id.parent_id'] => [
- 'name' => $tag['tag_id.parent_id.name'],
+ 'label' => $tag['tag_id.parent_id.label'],
'items' => [],
],
];
- $tagSetTags[$tag['tag_id.parent_id']]['items'][] = $tag['tag_id.name'];
+ $tagSetTags[$tag['tag_id.parent_id']]['items'][] = $tag['tag_id.label'];
}
}
$this->assign('tagSetTags', $tagSetTags);
diff --git a/CRM/Case/Page/Tab.php b/CRM/Case/Page/Tab.php
index 8c91b6ffb5ea..3dc37a7e6bb6 100644
--- a/CRM/Case/Page/Tab.php
+++ b/CRM/Case/Page/Tab.php
@@ -61,11 +61,6 @@ public function preProcess() {
CRM_Contact_Page_View::checkUserPermission($this);
}
}
- else {
- if ($this->_action & CRM_Core_Action::VIEW) {
- CRM_Core_Error::statusBounce(ts('Contact Id is required for view action.'));
- }
- }
$activityTypes = CRM_Case_PseudoConstant::caseActivityType();
diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php
index b9b83e95d819..fc3435e30f4f 100644
--- a/CRM/Contact/BAO/Contact.php
+++ b/CRM/Contact/BAO/Contact.php
@@ -119,7 +119,10 @@ public static function add(&$params) {
// CRM-7925
throw new CRM_Core_Exception(ts('The Contact Sub Type does not match the Contact type for this record'));
}
- $params['contact_sub_type'] = CRM_Utils_Array::implodePadded($params['contact_sub_type']);
+ // Ensure value is an array so it can be handled properly by `copyValues()`
+ if (is_string($params['contact_sub_type'])) {
+ $params['contact_sub_type'] = CRM_Core_DAO::unSerializeField($params['contact_sub_type'], self::fields()['contact_sub_type']['serialize']);
+ }
}
}
@@ -2925,8 +2928,8 @@ public static function contextMenu($contactId = NULL) {
'key' => 'note',
'tab' => 'note',
'class' => 'medium-popup',
- 'href' => CRM_Utils_System::url('civicrm/contact/view/note',
- 'reset=1&action=add'
+ 'href' => CRM_Utils_System::url('civicrm/note',
+ 'reset=1&action=add&entity_table=civicrm_contact&entity_id=' . $contactId
),
'permissions' => ['edit all contacts'],
],
@@ -3581,6 +3584,7 @@ public static function getEntityRefCreateLinks($appendProfiles = []) {
public static function getEntityRefFilters() {
return [
['key' => 'contact_type', 'value' => ts('Contact Type')],
+ ['key' => 'email', 'value' => ts('Email'), 'entity' => 'Email', 'type' => 'text'],
['key' => 'group', 'value' => ts('Group'), 'entity' => 'GroupContact'],
['key' => 'tag', 'value' => ts('Tag'), 'entity' => 'EntityTag'],
['key' => 'city', 'value' => ts('City'), 'type' => 'text', 'entity' => 'Address'],
diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php
index 477bb09d06f8..de18235c9644 100644
--- a/CRM/Contact/BAO/ContactType.php
+++ b/CRM/Contact/BAO/ContactType.php
@@ -69,7 +69,7 @@ public static function basicTypeInfo($includeInactive = FALSE) {
* @throws \CRM_Core_Exception
* @throws \Civi\API\Exception\UnauthorizedException
*/
- public static function basicTypes($all = FALSE) {
+ public static function basicTypes($all = FALSE): array {
return array_keys(self::basicTypeInfo($all));
}
@@ -849,15 +849,26 @@ public static function getAllContactTypes() {
$contactTypes[$name]['parent_label'] = $contactType['parent_id'] ? $parents[$contactType['parent_id']]['label'] : NULL;
// Cast int/bool types.
$contactTypes[$name]['id'] = (int) $contactType['id'];
- $contactTypes[$name]['parent_id'] = $contactType['parent_id'] ? (int) $contactType['parent_id'] : NULL;
+ $contactTypes[$name]['parent_id'] = ((int) $contactType['parent_id']) ?: NULL;
$contactTypes[$name]['is_active'] = (bool) $contactType['is_active'];
$contactTypes[$name]['is_reserved'] = (bool) $contactType['is_reserved'];
+ $contactTypes[$name]['icon'] = $contactType['icon'] ?? $parents[$contactType['parent_id']]['icon'] ?? NULL;
}
$cache->set($cacheKey, $contactTypes);
}
return $contactTypes;
}
+ /**
+ * Get contact type by name
+ *
+ * @param string $name
+ * @return array|null
+ */
+ public static function getContactType(string $name): ?array {
+ return self::getAllContactTypes()[$name] ?? NULL;
+ }
+
/**
* @param string $entityName
* @param string $action
diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php
index 3a5b8b7b8196..7c777557d7c5 100644
--- a/CRM/Contact/BAO/Group.php
+++ b/CRM/Contact/BAO/Group.php
@@ -344,9 +344,11 @@ public static function create(&$params) {
'parents' => NULL,
];
+ // Fill title and frontend_title if not supplied
+ if (empty($params['id']) && empty($params['title'])) {
+ $params['title'] = $params['frontend_title'] ?? $params['name'];
+ }
if (empty($params['id']) && empty($params['frontend_title'])) {
- // If we were calling writeRecord it would handle this, but we need
- // to migrate the other bits of magic.
$params['frontend_title'] = $params['title'];
}
$hook = empty($params['id']) ? 'create' : 'edit';
@@ -388,6 +390,8 @@ public static function create(&$params) {
// form the name only if missing: CRM-627
$nameParam = $params['name'] ?? NULL;
+ // If we were calling writeRecord it would handle this, but we need
+ // to migrate the other bits of magic.
if (!$nameParam && empty($params['id'])) {
$params['name'] = CRM_Utils_String::titleToVar($params['title']);
}
diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php
index f480e44566e5..4e3f17cee7fa 100644
--- a/CRM/Contact/BAO/GroupNesting.php
+++ b/CRM/Contact/BAO/GroupNesting.php
@@ -27,7 +27,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting {
*/
public static function create($params) {
$hook = empty($params['id']) ? 'create' : 'edit';
- CRM_Utils_Hook::pre($hook, 'GroupNesting', CRM_Utils_Array::value('id', $params), $params);
+ CRM_Utils_Hook::pre($hook, 'GroupNesting', $params['id'] ?? NULL, $params);
$dao = new CRM_Contact_BAO_GroupNesting();
$dao->copyValues($params);
if (empty($params['id'])) {
diff --git a/CRM/Contact/BAO/Individual.php b/CRM/Contact/BAO/Individual.php
index 7d4ea9875a47..200c7b54d780 100644
--- a/CRM/Contact/BAO/Individual.php
+++ b/CRM/Contact/BAO/Individual.php
@@ -31,12 +31,12 @@ public function __construct() {
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
- * @param CRM_Contact_BAO_Contact $contact
+ * @param CRM_Contact_DAO_Contact $contact
* Contact object.
*
- * @return CRM_Contact_BAO_Contact
+ * @return CRM_Contact_DAO_Contact
*/
- public static function format(&$params, &$contact) {
+ public static function format(&$params, $contact) {
if (!self::dataExists($params)) {
return NULL;
}
@@ -59,13 +59,8 @@ public static function format(&$params, &$contact) {
$formalTitle = CRM_Utils_Array::value('formal_title', $params, '');
// get prefix and suffix names
- $prefix = $suffix = NULL;
- if ($prefix_id) {
- $params['individual_prefix'] = $prefix = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'prefix_id', $prefix_id);
- }
- if ($suffix_id) {
- $params['individual_suffix'] = $suffix = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'suffix_id', $suffix_id);
- }
+ $params['prefix_id:label'] = $prefix = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'prefix_id', $prefix_id);
+ $params['suffix_id:label'] = $suffix = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'suffix_id', $suffix_id);
$individual = NULL;
if ($contact->id) {
@@ -87,12 +82,12 @@ public static function format(&$params, &$contact) {
}
}
- foreach (['prefix', 'suffix'] as $name) {
- $dbName = "{$name}_id";
- $value = $individual->$dbName;
- if ($value && !empty($params['preserveDBName'])) {
- $useDBNames[] = $name;
- }
+ if ($individual->suffix_id && !empty($params['preserveDBName'])) {
+ $useDBNames[] = 'suffix_id';
+ }
+
+ if ($individual->prefix_id && !empty($params['preserveDBName'])) {
+ $useDBNames[] = 'prefix_id';
}
if ($individual->formal_title && !empty($params['preserveDBName'])) {
@@ -168,8 +163,8 @@ public static function format(&$params, &$contact) {
'middle_name' => $middleName,
'last_name' => $lastName,
'nick_name' => $nickName,
- 'individual_suffix' => $suffix,
- 'individual_prefix' => $prefix,
+ 'suffix_id:label' => $suffix,
+ 'prefix_id:label' => $prefix,
'prefix_id' => $prefix_id,
'suffix_id' => $suffix_id,
'formal_title' => $formalTitle,
diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php
index 23499c9219b4..6fb4936ad15f 100644
--- a/CRM/Contact/BAO/Query.php
+++ b/CRM/Contact/BAO/Query.php
@@ -583,10 +583,10 @@ public function initialize($apiEntity = NULL) {
// Unit test coverage in api_v3_FinancialTypeACLTest::testGetACLContribution.
$clauses = [];
if ($component === 'contribution') {
- $clauses = CRM_Contribute_BAO_Contribution::getSelectWhereClause();
+ $clauses = array_filter(CRM_Contribute_BAO_Contribution::getSelectWhereClause());
}
if ($component === 'membership') {
- $clauses = CRM_Member_BAO_Membership::getSelectWhereClause();
+ $clauses = array_filter(CRM_Member_BAO_Membership::getSelectWhereClause());
}
if ($clauses) {
$this->_whereClause .= ' AND ' . implode(' AND ', $clauses);
@@ -4247,7 +4247,7 @@ public function relationship(&$values) {
if (!empty($relQill)) {
$relQill .= ' OR ';
}
- $relQill .= CRM_Utils_Array::value($rel, $allRelationshipType);
+ $relQill .= $allRelationshipType[$rel] ?? '';
}
$this->_qill[$grouping][] = 'Relationship Type(s) ' . $relQill . " ( " . implode(", ", $qillNames) . " )";
}
@@ -5077,27 +5077,12 @@ public function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
}
}
+ // Add ACL permission clause generated by the BAO. This is the same clause used by API::get.
+ // TODO: Why only activities?
if (isset($this->_tables['civicrm_activity'])) {
- $bao = new CRM_Activity_BAO_Activity();
- $clauses = $subclauses = [];
- foreach ($bao->addSelectWhereClause() as $field => $vals) {
- if ($vals && $field !== 'id') {
- foreach ($vals as $val) {
- $clauses[] = $bao->tableName() . ".$field " . $val;
- }
- }
- elseif ($vals) {
- $subclauses[] = "$field " . implode(" AND $field ", (array) $vals);
- }
- }
- if ($subclauses) {
- $clauses[] = $bao->tableName() . '.`id` IN (SELECT `id` FROM `' . $bao->tableName() . '` WHERE ' . implode(' AND ', $subclauses) . ')';
- }
- if (!empty($clauses) && $this->_permissionWhereClause) {
- $this->_permissionWhereClause .= ' AND (' . implode(' AND ', $clauses) . ')';
- }
- elseif (!empty($clauses)) {
- $this->_permissionWhereClause .= '(' . implode(' AND ', $clauses) . ')';
+ $clauses = array_filter(CRM_Activity_BAO_Activity::getSelectWhereClause());
+ if ($clauses) {
+ $this->_permissionWhereClause .= ($this->_permissionWhereClause ? ' AND ' : '') . '(' . implode(' AND ', $clauses) . ')';
}
}
}
@@ -6217,7 +6202,7 @@ public static function buildQillForFieldValue(
$pseudoOptions = CRM_Core_PseudoConstant::worldRegion();
}
elseif ($daoName == 'CRM_Event_DAO_Event' && $fieldName == 'id') {
- $checkPermission = CRM_Utils_Array::value('check_permission', $pseudoExtraParam, TRUE);
+ $checkPermission = $pseudoExtraParam['check_permission'] ?? TRUE;
$pseudoOptions = CRM_Event_BAO_Event::getEvents(0, $fieldValue, TRUE, $checkPermission, TRUE);
}
elseif ($fieldName == 'contribution_product_id') {
@@ -6452,7 +6437,7 @@ protected function prepareOrderBy($sort, $sortOrder) {
// is not declared for them.
// @todo so far only integer fields are being handled. If we add string fields we need to look at
// escaping.
- $pseudoConstantMetadata = CRM_Utils_Array::value('pseudoconstant', $fieldSpec, FALSE);
+ $pseudoConstantMetadata = $fieldSpec['pseudoconstant'] ?? FALSE;
if (!empty($pseudoConstantMetadata)
) {
if (!empty($pseudoConstantMetadata['optionGroupName'])
diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php
index 6405520474f7..9d231e0fe40e 100644
--- a/CRM/Contact/BAO/Relationship.php
+++ b/CRM/Contact/BAO/Relationship.php
@@ -1807,14 +1807,9 @@ public static function membershipTypeToRelationshipTypes(&$params, $direction =
}
/**
- * Wrapper for contact relationship selector.
+ * @deprecated since 5.68. Will be removed around 5.74.
*
- * @param array $params
- * Associated array for params record id.
- *
- * @return array
- * associated array of contact relationships
- * @throws \Exception
+ * Only-used-by-user-dashboard.
*/
public static function getContactRelationshipSelector(&$params) {
// format the params
@@ -1957,7 +1952,9 @@ public static function getContactRelationshipSelector(&$params) {
}
/**
- * @return array
+ * @deprecated since 5.68. Will be removed around 5.74.
+ *
+ * Only-used-by-user-dashboard.
*/
public static function getColumnHeaders() {
return [
diff --git a/CRM/Contact/DAO/Contact.php b/CRM/Contact/DAO/Contact.php
index edae63298bea..af30aab877b0 100644
--- a/CRM/Contact/DAO/Contact.php
+++ b/CRM/Contact/DAO/Contact.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Contact/Contact.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:4066902548c1bc5ba4358b9e0195a3fa)
+ * (GenCodeChecksum:0470d0df786c3ac33a435555a3d026fb)
*/
/**
@@ -604,7 +604,6 @@ public static function &fields() {
],
'where' => 'civicrm_contact.contact_type',
'export' => TRUE,
- 'contactType' => NULL,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
diff --git a/CRM/Contact/DAO/DashboardContact.php b/CRM/Contact/DAO/DashboardContact.php
index 3e298084bb58..aff797b875d6 100644
--- a/CRM/Contact/DAO/DashboardContact.php
+++ b/CRM/Contact/DAO/DashboardContact.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Contact/DashboardContact.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:73ab6a9a4f5d372c85b888aae2abe826)
+ * (GenCodeChecksum:2b31333980964ba3394f0c71cc764a9d)
*/
/**
@@ -67,7 +67,7 @@ class CRM_Contact_DAO_DashboardContact extends CRM_Core_DAO {
/**
* Is this widget active?
*
- * @var bool|string|null
+ * @var bool|string
* (SQL type: tinyint)
* Note that values will be retrieved from the database as a string.
*/
@@ -219,6 +219,7 @@ public static function &fields() {
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Dashlet is Active?'),
'description' => ts('Is this widget active?'),
+ 'required' => TRUE,
'usage' => [
'import' => FALSE,
'export' => FALSE,
diff --git a/CRM/Contact/DAO/Relationship.php b/CRM/Contact/DAO/Relationship.php
index 32b8f3e61be2..ea5624a36f46 100644
--- a/CRM/Contact/DAO/Relationship.php
+++ b/CRM/Contact/DAO/Relationship.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Contact/Relationship.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:053ca157abcac8e7f4c8ab55425df5ff)
+ * (GenCodeChecksum:e6e709da33773d09d7e788d21c64437b)
*/
/**
@@ -423,6 +423,11 @@ public static function &fields() {
],
'pseudoconstant' => [
'callback' => 'CRM_Core_SelectValues::getPermissionedRelationshipOptions',
+ 'suffixes' => [
+ 'name',
+ 'label',
+ 'icon',
+ ],
],
'add' => '2.1',
],
@@ -449,6 +454,11 @@ public static function &fields() {
],
'pseudoconstant' => [
'callback' => 'CRM_Core_SelectValues::getPermissionedRelationshipOptions',
+ 'suffixes' => [
+ 'name',
+ 'label',
+ 'icon',
+ ],
],
'add' => '2.1',
],
diff --git a/CRM/Contact/DAO/RelationshipCache.php b/CRM/Contact/DAO/RelationshipCache.php
index 060f18063798..5486d1c3b90f 100644
--- a/CRM/Contact/DAO/RelationshipCache.php
+++ b/CRM/Contact/DAO/RelationshipCache.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Contact/RelationshipCache.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:422520600ff998c1a9203004ae958e8c)
+ * (GenCodeChecksum:9170513963860f5b9cadce190a68b8bf)
*/
/**
@@ -43,6 +43,7 @@ class CRM_Contact_DAO_RelationshipCache extends CRM_Core_DAO {
* @var string[]
*/
protected static $_paths = [
+ 'add' => 'civicrm/contact/view/rel?cid=[near_contact_id]&action=add&reset=1',
'view' => 'civicrm/contact/view/rel?action=view&reset=1&cid=[near_contact_id]&id=[relationship_id]',
'update' => 'civicrm/contact/view/rel?action=update&reset=1&cid=[near_contact_id]&id=[relationship_id]&rtype=[orientation]',
'delete' => 'civicrm/contact/view/rel?action=delete&reset=1&cid=[near_contact_id]&id=[relationship_id]',
diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php
index b1395a93c85c..0b0aec7ab16f 100644
--- a/CRM/Contact/Form/Contact.php
+++ b/CRM/Contact/Form/Contact.php
@@ -501,10 +501,7 @@ public function blockSetDefaults(&$defaults) {
// make we require one primary block, CRM-5505
if ($updateMode) {
if (!$hasPrimary) {
- $hasPrimary = CRM_Utils_Array::value(
- 'is_primary',
- CRM_Utils_Array::value($instance, $defaults[$name])
- );
+ $hasPrimary = !empty($defaults[$name][$instance]['is_primary']);
}
continue;
}
@@ -892,7 +889,7 @@ public function buildQuickForm() {
'isDefault' => TRUE,
],
];
- if (CRM_Core_Permission::check('add contacts')) {
+ if (!$this->_contactId && CRM_Core_Permission::check('add contacts')) {
$buttons[] = [
'type' => 'upload',
'name' => ts('Save and New'),
@@ -987,7 +984,7 @@ public function postProcess() {
}
//get the submitted values in an array
- $params = $this->controller->exportValues($this->_name);
+ $params = $this->getSubmittedValues();
if (!isset($params['preferred_communication_method'])) {
// If this field is empty QF will trim it so we have to add it in.
$params['preferred_communication_method'] = 'null';
@@ -1060,7 +1057,7 @@ public function postProcess() {
if (array_key_exists('CommunicationPreferences', $this->_editOptions)) {
// this is a chekbox, so mark false if we dont get a POST value
- $params['is_opt_out'] = CRM_Utils_Array::value('is_opt_out', $params, FALSE);
+ $params['is_opt_out'] = $params['is_opt_out'] ?? FALSE;
CRM_Utils_Array::formatArrayKeys($params['preferred_communication_method']);
}
@@ -1294,15 +1291,15 @@ public static function checkDuplicateContacts(&$fields, &$errors, $contactID, $c
for ($i = 0; $i < count($contactLinks['rows']); $i++) {
$row .= '
';
$row .= ' | ';
- $row .= CRM_Utils_Array::value('display_name', $contactLinks['rows'][$i]);
+ $row .= $contactLinks['rows'][$i]['display_name'] ?? '';
$row .= ' | ';
$row .= ' ';
- $row .= CRM_Utils_Array::value('primary_email', $contactLinks['rows'][$i]);
+ $row .= $contactLinks['rows'][$i]['primary_email'] ?? '';
$row .= ' | ';
$row .= ' ';
- $row .= CRM_Utils_Array::value('view', $contactLinks['rows'][$i]);
- $row .= CRM_Utils_Array::value('edit', $contactLinks['rows'][$i]);
- $row .= CRM_Utils_Array::value('merge', $contactLinks['rows'][$i]);
+ $row .= $contactLinks['rows'][$i]['view'] ?? '';
+ $row .= $contactLinks['rows'][$i]['edit'] ?? '';
+ $row .= $contactLinks['rows'][$i]['merge'] ?? '';
$row .= ' | ';
$row .= '
';
}
@@ -1413,7 +1410,7 @@ public static function parseAddress(&$params) {
$streetAddress .= ' ';
}
}
- $streetAddress .= CRM_Utils_Array::value($fld, $address);
+ $streetAddress .= $address[$fld] ?? '';
}
$address['street_address'] = trim($streetAddress);
$parseSuccess[$instance] = TRUE;
diff --git a/CRM/Contact/Form/Edit/Address.php b/CRM/Contact/Form/Edit/Address.php
index 8b88bb49c286..4c82a7ff5134 100644
--- a/CRM/Contact/Form/Edit/Address.php
+++ b/CRM/Contact/Form/Edit/Address.php
@@ -296,7 +296,7 @@ public static function setDefaultValues(&$defaults, &$form) {
$streetAddress .= ' ';
}
}
- $streetAddress .= CRM_Utils_Array::value($fld, $address);
+ $streetAddress .= $address[$fld] ?? '';
}
$streetAddress = trim($streetAddress);
if (!empty($streetAddress)) {
diff --git a/CRM/Contact/Form/Inline/CommunicationPreferences.php b/CRM/Contact/Form/Inline/CommunicationPreferences.php
index 6452b0b02e47..f65942b56ffe 100644
--- a/CRM/Contact/Form/Inline/CommunicationPreferences.php
+++ b/CRM/Contact/Form/Inline/CommunicationPreferences.php
@@ -65,7 +65,7 @@ public function postProcess() {
// Process / save communication preferences
// this is a chekbox, so mark false if we dont get a POST value
- $params['is_opt_out'] = CRM_Utils_Array::value('is_opt_out', $params, FALSE);
+ $params['is_opt_out'] = $params['is_opt_out'] ?? FALSE;
$params['contact_type'] = $this->_contactType;
$params['contact_id'] = $this->_contactId;
diff --git a/CRM/Contact/Form/Inline/CustomData.php b/CRM/Contact/Form/Inline/CustomData.php
index d8e92f86bbfb..96247fa48459 100644
--- a/CRM/Contact/Form/Inline/CustomData.php
+++ b/CRM/Contact/Form/Inline/CustomData.php
@@ -72,7 +72,7 @@ public function setDefaultValues() {
public function postProcess() {
// Process / save custom data
// Get the form values and groupTree
- $params = $this->controller->exportValues($this->_name);
+ $params = $this->getSubmittedValues();
CRM_Core_BAO_CustomValueTable::postProcess($params,
'civicrm_contact',
$this->_contactId,
diff --git a/CRM/Contact/Form/Relationship.php b/CRM/Contact/Form/Relationship.php
index 47116d7d1759..7001592c6bc0 100644
--- a/CRM/Contact/Form/Relationship.php
+++ b/CRM/Contact/Form/Relationship.php
@@ -403,10 +403,6 @@ public function postProcess() {
// Refresh contact tabs which might have been affected
$this->ajaxResponse = [
'reloadBlocks' => ['#crm-contactinfo-content'],
- 'updateTabs' => [
- '#tab_member' => CRM_Contact_BAO_Contact::getCountComponent('membership', $this->_contactId),
- '#tab_contribute' => CRM_Contact_BAO_Contact::getCountComponent('contribution', $this->_contactId),
- ],
];
}
@@ -493,7 +489,7 @@ public static function getRelationshipTypeMetadata($relationshipList) {
$jsData[$id] = array_filter(array_intersect_key($allRelationshipNames[$id], $whatWeWant));
// Add user-friendly placeholder
foreach (['a', 'b'] as $x) {
- $type = !empty($jsData[$id]["contact_sub_type_$x"]) ? $jsData[$id]["contact_sub_type_$x"] : CRM_Utils_Array::value("contact_type_$x", $jsData[$id]);
+ $type = !empty($jsData[$id]["contact_sub_type_$x"]) ? $jsData[$id]["contact_sub_type_$x"] : (CRM_Utils_Array::value("contact_type_$x", $jsData[$id]));
$jsData[$id]["placeholder_$x"] = $type ? ts('- select %1 -', [strtolower($contactTypes[$type]['label'])]) : ts('- select contact -');
}
}
@@ -579,8 +575,8 @@ private function preparePostProcessParameters($values) {
}
// If this is a b_a relationship these form elements are flipped
- $params['is_permission_a_b'] = CRM_Utils_Array::value("is_permission_{$a}_{$b}", $values, 0);
- $params['is_permission_b_a'] = CRM_Utils_Array::value("is_permission_{$b}_{$a}", $values, 0);
+ $params['is_permission_a_b'] = $values["is_permission_{$a}_{$b}"] ?? 0;
+ $params['is_permission_b_a'] = $values["is_permission_{$b}_{$a}"] ?? 0;
return [$params, $a];
}
diff --git a/CRM/Contact/Form/Search.php b/CRM/Contact/Form/Search.php
index 575b3d38c25e..ac69d0ce9b15 100644
--- a/CRM/Contact/Form/Search.php
+++ b/CRM/Contact/Form/Search.php
@@ -530,7 +530,7 @@ public function preProcess() {
$this->_amtgID = CRM_Utils_Request::retrieve('amtgID', 'Positive', $this);
$this->_ssID = CRM_Utils_Request::retrieve('ssID', 'Positive', $this);
$this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter', 'String', $this);
- $this->_ufGroupID = CRM_Utils_Request::retrieve('id', 'Positive', $this);
+ $ufGroupID = CRM_Utils_Request::retrieve('uf_group_id', 'Positive', $this);
$this->_componentMode = CRM_Utils_Request::retrieve('component_mode', 'Positive', $this, FALSE, CRM_Contact_BAO_Query::MODE_CONTACTS, $_REQUEST);
$this->_operator = CRM_Utils_Request::retrieve('operator', 'String', $this, FALSE, CRM_Contact_BAO_Query::SEARCH_OPERATOR_AND, 'REQUEST');
@@ -547,10 +547,10 @@ public function preProcess() {
// if we dont get this from the url, use default if one exsts
$config = CRM_Core_Config::singleton();
- if ($this->_ufGroupID == NULL &&
+ if ($ufGroupID == NULL &&
$config->defaultSearchProfileID != NULL
) {
- $this->_ufGroupID = $config->defaultSearchProfileID;
+ $ufGroupID = $config->defaultSearchProfileID;
}
// assign context to drive the template display, make sure context is valid
@@ -579,9 +579,9 @@ public function preProcess() {
$this->_returnProperties = &$this->returnProperties();
// also get the uf group id directly from the post value
- $this->_ufGroupID = CRM_Utils_Array::value('uf_group_id', $_POST, $this->_ufGroupID);
- $this->_formValues['uf_group_id'] = $this->_ufGroupID;
- $this->set('id', $this->_ufGroupID);
+ $ufGroupID = $_POST['uf_group_id'] ?? $ufGroupID;
+ $this->_formValues['uf_group_id'] = $ufGroupID;
+ $this->set('uf_group_id', $ufGroupID);
// also get the object mode directly from the post value
$this->_componentMode = CRM_Utils_Array::value('component_mode', $_POST, $this->_componentMode);
@@ -595,8 +595,8 @@ public function preProcess() {
$this->_formValues = $this->get('formValues');
$this->_params = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields);
$this->_returnProperties = &$this->returnProperties();
- if (!empty($this->_ufGroupID)) {
- $this->set('id', $this->_ufGroupID);
+ if ($ufGroupID) {
+ $this->set('uf_group_id', $ufGroupID);
}
}
@@ -623,9 +623,9 @@ public function preProcess() {
$this->_returnProperties = &$this->returnProperties();
}
else {
- if (isset($this->_ufGroupID)) {
+ if ($ufGroupID) {
// also set the uf group id if not already present
- $this->_formValues['uf_group_id'] = $this->_ufGroupID;
+ $this->_formValues['uf_group_id'] = $ufGroupID;
}
if (isset($this->_componentMode)) {
$this->_formValues['component_mode'] = $this->_componentMode;
@@ -667,9 +667,7 @@ public function preProcess() {
}
}
}
- $this->assign('id',
- CRM_Utils_Array::value('uf_group_id', $this->_formValues)
- );
+ $this->assign('id', $ufGroupID);
$operator = CRM_Utils_Array::value('operator', $this->_formValues, CRM_Contact_BAO_Query::SEARCH_OPERATOR_AND);
$this->set('queryOperator', $operator);
if ($operator == CRM_Contact_BAO_Query::SEARCH_OPERATOR_OR) {
@@ -768,10 +766,7 @@ public function postProcess() {
//get the button name
$buttonName = $this->controller->getButtonName();
-
- if (isset($this->_ufGroupID) && empty($this->_formValues['uf_group_id'])) {
- $this->_formValues['uf_group_id'] = $this->_ufGroupID;
- }
+ $this->_formValues['uf_group_id'] = $this->_formValues['uf_group_id'] ?? $this->get('uf_group_id');
if (isset($this->_componentMode) && empty($this->_formValues['component_mode'])) {
$this->_formValues['component_mode'] = $this->_componentMode;
diff --git a/CRM/Contact/Form/Search/Advanced.php b/CRM/Contact/Form/Search/Advanced.php
index fb00ab8809a9..7b9d471ef349 100644
--- a/CRM/Contact/Form/Search/Advanced.php
+++ b/CRM/Contact/Form/Search/Advanced.php
@@ -226,6 +226,10 @@ public function postProcess() {
$this->set('isAdvanced', '1');
$this->setFormValues();
+ if (is_numeric($_POST['id'] ?? NULL)) {
+ $this->_formValues['contact_id'] = (int) $_POST['id'];
+ }
+ $this->set('formValues', $this->_formValues);
// get user submitted values
// get it from controller only if form has been submitted, else preProcess has set this
if (!empty($_POST)) {
@@ -238,13 +242,7 @@ public function postProcess() {
}
}
- // set the group if group is submitted
- if (!empty($this->_formValues['uf_group_id'])) {
- $this->set('id', $this->_formValues['uf_group_id']);
- }
- else {
- $this->set('id', '');
- }
+ $this->set('uf_group_id', $this->_formValues['uf_group_id'] ?? '');
}
// retrieve ssID values only if formValues is null, i.e. form has never been posted
diff --git a/CRM/Contact/Form/Search/Builder.php b/CRM/Contact/Form/Search/Builder.php
index c65dc87d0c73..a0a1e70f0f73 100644
--- a/CRM/Contact/Form/Search/Builder.php
+++ b/CRM/Contact/Form/Search/Builder.php
@@ -365,14 +365,7 @@ public function postProcess() {
// get it from controller only if form has been submitted, else preProcess has set this
if (!empty($_POST)) {
$this->_formValues = $this->controller->exportValues($this->_name);
-
- // set the group if group is submitted
- if (!empty($this->_formValues['uf_group_id'])) {
- $this->set('id', $this->_formValues['uf_group_id']);
- }
- else {
- $this->set('id', '');
- }
+ $this->set('uf_group_id', $this->_formValues['uf_group_id'] ?? '');
}
// we dont want to store the sortByCharacter in the formValue, it is more like
diff --git a/CRM/Contact/Form/Search/Criteria.php b/CRM/Contact/Form/Search/Criteria.php
index ac6b93820377..0a96629033ab 100644
--- a/CRM/Contact/Form/Search/Criteria.php
+++ b/CRM/Contact/Form/Search/Criteria.php
@@ -98,8 +98,8 @@ public static function basic(&$form) {
$form->addElement('text', 'job_title', ts('Job Title'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'job_title'));
//added internal ID
- $form->add('number', 'contact_id', ts('Contact ID'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'id') + ['min' => 1]);
- $form->addRule('contact_id', ts('Please enter valid Contact ID'), 'positiveInteger');
+ $form->add('number', 'id', ts('Contact ID'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'id') + ['min' => 1]);
+ $form->addRule('id', ts('Please enter valid Contact ID'), 'positiveInteger');
//added external ID
$form->addElement('text', 'external_identifier', ts('External ID'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'external_identifier'));
@@ -461,7 +461,7 @@ public static function location(&$form) {
}
if ($addressOptions['postal_code']) {
- $attr = ['class' => 'six'] + (array) CRM_Utils_Array::value('postal_code', $attributes);
+ $attr = ['class' => 'six'] + ($attributes['postal_code'] ?? []);
$form->addElement('text', 'postal_code_low', NULL, $attr + ['placeholder' => ts('From')]);
$form->addElement('text', 'postal_code_high', NULL, $attr + ['placeholder' => ts('To')]);
}
diff --git a/CRM/Contact/Form/Task.php b/CRM/Contact/Form/Task.php
index 6d21f77a261e..f7eb5479687b 100644
--- a/CRM/Contact/Form/Task.php
+++ b/CRM/Contact/Form/Task.php
@@ -262,7 +262,7 @@ protected static function legacyGetContactIds($form) {
$queryOperator = 'AND';
}
$dao = $selector->contactIDQuery($params, $sortID,
- CRM_Utils_Array::value('display_relationship_type', $fv),
+ $fv['display_relationship_type'] ?? NULL,
$queryOperator
);
diff --git a/CRM/Contact/Form/Task/EmailTrait.php b/CRM/Contact/Form/Task/EmailTrait.php
index 1755bbc2327f..3a97596024e4 100644
--- a/CRM/Contact/Form/Task/EmailTrait.php
+++ b/CRM/Contact/Form/Task/EmailTrait.php
@@ -384,7 +384,7 @@ public function submit($formValues): void {
$cc,
$bcc,
$additionalDetails,
- CRM_Utils_Array::value('campaign_id', $formValues),
+ $formValues['campaign_id'] ?? NULL,
$this->getCaseID()
);
diff --git a/CRM/Contact/Form/Task/Label.php b/CRM/Contact/Form/Task/Label.php
index e303d62dd13f..0b8455968456 100644
--- a/CRM/Contact/Form/Task/Label.php
+++ b/CRM/Contact/Form/Task/Label.php
@@ -250,7 +250,7 @@ public function postProcess($params = NULL) {
if (!empty($fv['location_type_id'])) {
foreach ($valuesothers as $vals) {
if (($vals['location_type_id'] ?? NULL) ==
- CRM_Utils_Array::value('location_type_id', $fv)
+ ($fv['location_type_id'] ?? NULL)
) {
foreach ($vals as $k => $v) {
if (in_array($k, [
diff --git a/CRM/Contact/Form/Task/PDFTrait.php b/CRM/Contact/Form/Task/PDFTrait.php
index 521e02664f08..9e8219c27d7a 100644
--- a/CRM/Contact/Form/Task/PDFTrait.php
+++ b/CRM/Contact/Form/Task/PDFTrait.php
@@ -151,7 +151,6 @@ public function addPDFElementsToForm(): void {
$form->assign('totalSelectedContacts', !is_null($form->_contactIds) ? count($form->_contactIds) : 0);
$form->add('select', 'document_type', ts('Document Type'), CRM_Core_SelectValues::documentFormat());
-
$documentTypes = implode(',', CRM_Core_SelectValues::documentApplicationType());
$form->addElement('file', "document_file", 'Upload Document', 'size=30 maxlength=255 accept="' . $documentTypes . '"');
$form->addUploadElement("document_file");
diff --git a/CRM/Contact/Page/AJAX.php b/CRM/Contact/Page/AJAX.php
index 99181e9276a9..9cacb36776d2 100644
--- a/CRM/Contact/Page/AJAX.php
+++ b/CRM/Contact/Page/AJAX.php
@@ -951,7 +951,7 @@ public static function getAddressDisplay() {
public static function toggleDedupeSelect() {
$pnid = $_REQUEST['pnid'];
$isSelected = CRM_Utils_Type::escape($_REQUEST['is_selected'], 'Boolean');
- $cacheKeyString = CRM_Utils_Request::retrieve('cacheKey', 'Alphanumeric', $null, FALSE);
+ $cacheKeyString = CRM_Utils_Request::retrieve('cacheKey', 'Alphanumeric', NULL, FALSE);
$params = [
1 => [$isSelected, 'Boolean'],
@@ -979,7 +979,9 @@ public static function toggleDedupeSelect() {
}
/**
- * Retrieve contact relationships.
+ * @deprecated since 5.68. Will be removed around 5.74.
+ *
+ * Only-used-by-user-dashboard.
*/
public static function getContactRelationships() {
$contactID = CRM_Utils_Type::escape($_GET['cid'], 'Integer');
diff --git a/CRM/Contact/Page/DedupeMerge.php b/CRM/Contact/Page/DedupeMerge.php
index 559ab66764ae..70a7bd91aaab 100644
--- a/CRM/Contact/Page/DedupeMerge.php
+++ b/CRM/Contact/Page/DedupeMerge.php
@@ -42,7 +42,7 @@ public static function getRunner() {
$limit = CRM_Utils_Request::retrieveValue('limit', 'Positive');
$action = CRM_Utils_Request::retrieveValue('action', 'String');
$mode = CRM_Utils_Request::retrieveValue('mode', 'String', 'safe');
- $criteria = CRM_Utils_Request::retrieve('criteria', 'Json', $null, FALSE, '{}');
+ $criteria = CRM_Utils_Request::retrieve('criteria', 'Json', NULL, FALSE, '{}');
$urlQry = [
'reset' => 1,
diff --git a/CRM/Contact/Page/DedupeRules.php b/CRM/Contact/Page/DedupeRules.php
index 84461909a3c2..d0a345fde389 100644
--- a/CRM/Contact/Page/DedupeRules.php
+++ b/CRM/Contact/Page/DedupeRules.php
@@ -52,6 +52,7 @@ public function &links() {
'url' => 'civicrm/contact/dedupefind',
'qs' => 'reset=1&rgid=%%id%%&action=preview',
'title' => ts('Use DedupeRule'),
+ 'weight' => CRM_Core_Action::getWeight(CRM_Core_Action::VIEW),
];
}
if (CRM_Core_Permission::check('administer dedupe rules')) {
@@ -60,6 +61,7 @@ public function &links() {
'url' => 'civicrm/contact/deduperules',
'qs' => 'action=update&id=%%id%%',
'title' => ts('Edit DedupeRule'),
+ 'weight' => CRM_Core_Action::getWeight(CRM_Core_Action::UPDATE),
];
$links[CRM_Core_Action::DELETE] = [
'name' => ts('Delete'),
@@ -67,6 +69,7 @@ public function &links() {
'qs' => 'action=delete&id=%%id%%',
'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
'title' => ts('Delete DedupeRule'),
+ 'weight' => CRM_Core_Action::getWeight(CRM_Core_Action::DELETE),
];
}
@@ -129,7 +132,7 @@ public function browse() {
// form all action links
$action = array_sum(array_keys($this->links()));
- $links = self::links();
+ $links = $this->links();
if ($dao->is_reserved) {
unset($links[CRM_Core_Action::DELETE]);
diff --git a/CRM/Contact/Page/View/Note.php b/CRM/Contact/Page/View/Note.php
deleted file mode 100644
index 8375a2760601..000000000000
--- a/CRM/Contact/Page/View/Note.php
+++ /dev/null
@@ -1,311 +0,0 @@
-addSelect('*', 'privacy:label')
- ->addWhere('id', '=', $this->_id)
- ->execute()
- ->single();
- $note['privacy'] = $note['privacy:label'];
- $this->assign('note', $note);
-
- $comments = CRM_Core_BAO_Note::getNoteTree($this->_id, 1);
- $this->assign('comments', $comments);
-
- // add attachments part
- $currentAttachmentInfo = CRM_Core_BAO_File::getEntityFile('civicrm_note', $this->_id);
- $this->assign('currentAttachmentInfo', $currentAttachmentInfo);
-
- }
-
- /**
- * called when action is browse.
- */
- public function browse(): void {
- $note = new CRM_Core_DAO_Note();
- $note->entity_table = 'civicrm_contact';
- $note->entity_id = $this->getContactID();
-
- $note->orderBy('modified_date desc');
-
- //CRM-4418, handling edit and delete separately.
- $permissions = [$this->_permission];
- if ($this->_permission == CRM_Core_Permission::EDIT) {
- //previously delete was subset of edit
- //so for consistency lets grant delete also.
- $permissions[] = CRM_Core_Permission::DELETE;
- }
- $mask = CRM_Core_Action::mask($permissions);
-
- $this->assign('canAddNotes', CRM_Core_Permission::check('add contact notes'));
-
- $links = self::links();
- $action = array_sum(array_keys($links)) & $mask;
-
- $note->find();
- while ($note->fetch()) {
- if (!CRM_Core_BAO_Note::getNotePrivacyHidden($note)) {
- CRM_Core_DAO::storeValues($note, $this->values[$note->id]);
-
- $this->values[$note->id]['action'] = CRM_Core_Action::formLink($links,
- $action,
- [
- 'id' => $note->id,
- 'cid' => $this->getContactID(),
- ],
- ts('more'),
- FALSE,
- 'note.selector.row',
- 'Note',
- $note->id
- );
- if (!empty($note->contact_id)) {
- $contact = new CRM_Contact_DAO_Contact();
- $contact->id = $note->contact_id;
- $contact->find();
- $contact->fetch();
- $this->values[$note->id]['createdBy'] = $contact->display_name;
- }
- $this->values[$note->id]['comment_count'] = CRM_Core_BAO_Note::getChildCount($note->id);
-
- // paper icon view for attachments part
- $paperIconAttachmentInfo = CRM_Core_BAO_File::paperIconAttachment('civicrm_note', $note->id);
- $this->values[$note->id]['attachment'] = $paperIconAttachmentInfo;
- }
- }
- $this->assign('notes', $this->values);
-
- $commentLinks = self::commentLinks();
-
- $action = array_sum(array_keys($commentLinks)) & $mask;
-
- $commentAction = CRM_Core_Action::formLink($commentLinks,
- $action,
- [
- 'id' => $note->id,
- 'pid' => $note->entity_id,
- 'cid' => $note->entity_id,
- ],
- ts('more'),
- FALSE,
- 'note.comment.action',
- 'Note',
- $note->id
- );
- $this->assign('commentAction', $commentAction);
-
- $this->ajaxResponse['tabCount'] = CRM_Contact_BAO_Contact::getCountComponent('note', $this->getContactID());
- }
-
- /**
- * called when action is update or new.
- */
- public function edit() {
- $controller = new CRM_Core_Controller_Simple('CRM_Note_Form_Note', ts('Contact Notes'), $this->_action);
- $controller->setEmbedded(TRUE);
-
- // set the userContext stack
- $session = CRM_Core_Session::singleton();
- $contactID = $this->getContactID();
- $url = CRM_Utils_System::url('civicrm/contact/view',
- 'action=browse&selectedChild=note&cid=' . $contactID
- );
- $session->pushUserContext($url);
-
- if (CRM_Utils_Request::retrieve('confirmed', 'Boolean')) {
- $this->delete();
- CRM_Utils_System::redirect($url);
- }
-
- $controller->reset();
- $controller->set('entityTable', 'civicrm_contact');
- $controller->set('entityId', $this->_contactId);
- $controller->set('id', $this->_id);
-
- $controller->process();
- $controller->run();
- }
-
- public function preProcess() {
- $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
-
- if ($this->_id && CRM_Core_BAO_Note::getNotePrivacyHidden($this->_id)) {
- CRM_Core_Error::statusBounce(ts('You do not have access to this note.'));
- }
-
- $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
- $this->assign('contactId', $this->_contactId);
-
- // check logged in url permission
- CRM_Contact_Page_View::checkUserPermission($this);
-
- $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId);
- CRM_Utils_System::setTitle(ts('Notes for') . ' ' . $displayName);
-
- $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
- $this->assign('action', $this->_action);
- }
-
- /**
- * the main function that is called when the page loads,
- * it decides the which action has to be taken for the page.
- *
- * @return null
- */
- public function run() {
- $this->preProcess();
-
- if ($this->_action & CRM_Core_Action::VIEW) {
- $this->view();
- }
- elseif ($this->_action & CRM_Core_Action::ADD) {
- if (
- $this->_permission != CRM_Core_Permission::EDIT &&
- !CRM_Core_Permission::check('add contact notes')
- ) {
- CRM_Core_Error::statusBounce(ts('You do not have access to add notes.'));
- }
-
- $this->edit();
- }
- elseif ($this->_action & CRM_Core_Action::UPDATE) {
- if ($this->_permission != CRM_Core_Permission::EDIT) {
- CRM_Core_Error::statusBounce(ts('You do not have access to edit this note.'));
- }
-
- $this->edit();
- }
- elseif ($this->_action & CRM_Core_Action::DELETE) {
- if ($this->_permission != CRM_Core_Permission::EDIT) {
- CRM_Core_Error::statusBounce(ts('You do not have access to delete this note.'));
- }
- // we use the edit screen the confirm the delete
- $this->edit();
- }
-
- $this->browse();
- return parent::run();
- }
-
- /**
- * Delete the note object from the db and set a status msg.
- */
- public function delete() {
- CRM_Core_BAO_Note::deleteRecord(['id' => $this->_id]);
- $status = ts('Selected Note has been deleted successfully.');
- CRM_Core_Session::setStatus($status, ts('Deleted'), 'success');
- }
-
- /**
- * Get action links.
- *
- * @return array[]
- */
- public static function links() {
- return [
- CRM_Core_Action::VIEW => [
- 'name' => ts('View'),
- 'url' => 'civicrm/contact/view/note',
- 'qs' => 'action=view&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
- 'title' => ts('View Note'),
- 'weight' => -20,
- ],
- CRM_Core_Action::UPDATE => [
- 'name' => ts('Edit'),
- 'url' => 'civicrm/contact/view/note',
- 'qs' => 'action=update&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
- 'title' => ts('Edit Note'),
- 'weight' => -10,
- ],
- CRM_Core_Action::ADD => [
- 'name' => ts('Comment'),
- 'url' => 'civicrm/contact/view/note',
- 'qs' => 'action=add&reset=1&cid=%%cid%%&parentId=%%id%%&selectedChild=note',
- 'title' => ts('Add Comment'),
- 'weight' => -5,
- ],
- CRM_Core_Action::DELETE => [
- 'name' => ts('Delete'),
- 'url' => 'civicrm/contact/view/note',
- 'qs' => 'action=delete&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
- 'title' => ts('Delete Note'),
- 'weight' => 100,
- ],
- ];
- }
-
- /**
- * Get action links for comments.
- *
- * @return array[]
- */
- public static function commentLinks(): array {
- return [
- CRM_Core_Action::VIEW => [
- 'name' => ts('View'),
- 'url' => 'civicrm/contact/view/note',
- 'qs' => 'action=view&reset=1&cid=%%cid%%&id={id}&selectedChild=note',
- 'title' => ts('View Comment'),
- 'weight' => -20,
- ],
- CRM_Core_Action::UPDATE => [
- 'name' => ts('Edit'),
- 'url' => 'civicrm/contact/view/note',
- 'qs' => 'action=update&reset=1&cid=%%cid%%&id={id}&parentId=%%pid%%&selectedChild=note',
- 'title' => ts('Edit Comment'),
- 'weight' => -10,
- ],
- CRM_Core_Action::DELETE => [
- 'name' => ts('Delete'),
- 'url' => 'civicrm/contact/view/note',
- 'qs' => 'action=delete&reset=1&cid=%%cid%%&id={id}&selectedChild=note',
- 'title' => ts('Delete Comment'),
- 'weight' => 100,
- ],
- ];
- }
-
- /**
- * Get the relevant contact ID.
- *
- * @api supported to be accessed from outside of core.
- *
- * @return int
- *
- * @noinspection PhpUnhandledExceptionInspection
- * @noinspection PhpDocMissingThrowsInspection
- */
- public function getContactID(): int {
- return (int) CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
- }
-
-}
diff --git a/CRM/Contact/Page/View/Relationship.php b/CRM/Contact/Page/View/Relationship.php
index f0d6e4d804f3..ec6ad2f88de7 100644
--- a/CRM/Contact/Page/View/Relationship.php
+++ b/CRM/Contact/Page/View/Relationship.php
@@ -139,19 +139,6 @@ public function view() {
);
}
- /**
- * called when action is browse.
- *
- */
- public function browse() {
- // do nothing :) we are using datatable for rendering relationship selectors
- $columnHeaders = CRM_Contact_BAO_Relationship::getColumnHeaders();
- $selector = NULL;
- $contactRelationships = [];
- CRM_Utils_Hook::searchColumns('relationship.columns', $columnHeaders, $contactRelationships, $selector);
- $this->assign('columnHeaders', $columnHeaders);
- }
-
/**
* called when action is update or new.
*
@@ -215,11 +202,6 @@ public function run() {
$this->edit();
}
- // if this is called from case view, suppress browse relationships form
- else {
- $this->browse();
- }
-
return parent::run();
}
@@ -245,7 +227,9 @@ public function delete() {
}
/**
- * Get action links.
+ * @deprecated since 5.68. Will be removed around 5.74.
+ *
+ * Only-used-by-user-dashboard.
*
* @return array
* (reference) of action links
diff --git a/CRM/Contact/Page/View/Summary.php b/CRM/Contact/Page/View/Summary.php
index 585bf193fcb8..f1387457232c 100644
--- a/CRM/Contact/Page/View/Summary.php
+++ b/CRM/Contact/Page/View/Summary.php
@@ -304,13 +304,6 @@ public static function basicTabs() {
'weight' => 70,
'icon' => 'crm-i fa-tasks',
],
- [
- 'id' => 'rel',
- 'title' => ts('Relationships'),
- 'class' => 'livePage',
- 'weight' => 80,
- 'icon' => 'crm-i fa-handshake-o',
- ],
[
'id' => 'group',
'title' => ts('Groups'),
@@ -318,13 +311,6 @@ public static function basicTabs() {
'weight' => 90,
'icon' => 'crm-i fa-users',
],
- [
- 'id' => 'note',
- 'title' => ts('Notes'),
- 'class' => 'livePage',
- 'weight' => 100,
- 'icon' => 'crm-i fa-sticky-note-o',
- ],
[
'id' => 'tag',
'title' => ts('Tags'),
diff --git a/CRM/Contact/Page/View/UserDashBoard.php b/CRM/Contact/Page/View/UserDashBoard.php
index c93b161213f3..5eee298b7536 100644
--- a/CRM/Contact/Page/View/UserDashBoard.php
+++ b/CRM/Contact/Page/View/UserDashBoard.php
@@ -126,7 +126,10 @@ public function buildUserDashBoard() {
}
}
- // CRM-16512 - Hide related contact table if user lacks permission to view self
+ // Relationship section
+ // FIXME - this used to share code with the contact summary "Relationships" tab
+ // now that tab has been switched to use SearchKit, and this ought to be switched as well;
+ // then remove all code commented with "only-used-by-user-dashboard"
if (!empty($dashboardOptions['Permissioned Orgs']) && CRM_Core_Permission::check('view my contact')) {
$columnHeaders = CRM_Contact_BAO_Relationship::getColumnHeaders();
$contactRelationships = $selector = NULL;
diff --git a/CRM/Contact/Page/View/Vcard.php b/CRM/Contact/Page/View/Vcard.php
index 9d98552cf35c..29ff266df677 100644
--- a/CRM/Contact/Page/View/Vcard.php
+++ b/CRM/Contact/Page/View/Vcard.php
@@ -45,10 +45,10 @@ public function run() {
if ($defaults['contact_type'] == 'Individual') {
$vcard->setName(CRM_Utils_Array::value('last_name', $defaults),
- CRM_Utils_Array::value('first_name', $defaults),
- CRM_Utils_Array::value('middle_name', $defaults),
- CRM_Utils_Array::value('prefix', $defaults),
- CRM_Utils_Array::value('suffix', $defaults)
+ $defaults['first_name'] ?? NULL,
+ $defaults['middle_name'] ?? NULL,
+ $defaults['prefix'] ?? NULL,
+ $defaults['suffix'] ?? NULL
);
$organizationName = $defaults['organization_name'] ?? NULL;
if ($organizationName !== NULL) {
diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php
index 2a9eaccc6e7d..a04da212f21c 100644
--- a/CRM/Contribute/BAO/Contribution.php
+++ b/CRM/Contribute/BAO/Contribution.php
@@ -409,6 +409,8 @@ protected static function getBillingAddressParams($params, $billingLocationTypeI
$billingFirstName = $params['billing_first_name'] ?? NULL;
$billingMiddleName = $params['billing_middle_name'] ?? NULL;
$billingLastName = $params['billing_last_name'] ?? NULL;
+ // Note this is NOT used when creating a billing address. It is probably passed
+ // the the payment processor - which is horrible & could maybe change.
$addressParams['address_name'] = "{$billingFirstName}" . CRM_Core_DAO::VALUE_SEPARATOR . "{$billingMiddleName}" . CRM_Core_DAO::VALUE_SEPARATOR . "{$billingLastName}";
foreach ($billingFields as $value) {
@@ -1029,6 +1031,7 @@ protected static function getContributionTransactionInformation($contributionId,
'class' => 'medium-popup',
'qs' => "reset=1&id=%%id%%&contribution_id=%%contribution_id%%",
'title' => ts('Edit Payment'),
+ 'weight' => CRM_Core_Action::getWeight(CRM_Core_Action::UPDATE),
],
];
$paymentEditLink = CRM_Core_Action::formLink(
@@ -1655,16 +1658,21 @@ public static function getContributionDetails($exportMode, $componentIds) {
* thought).
*
* @param array $params
- * @param int $billingLocationTypeID
*
* @return int
* address id
*/
- public static function createAddress($params, $billingLocationTypeID) {
+ public static function createAddress($params) {
+ $billingLocationTypeID = CRM_Core_BAO_LocationType::getBilling();
[$hasBillingField, $addressParams] = self::getBillingAddressParams($params, $billingLocationTypeID);
if ($hasBillingField) {
- $address = CRM_Core_BAO_Address::writeRecord($addressParams);
- return $address->id;
+ $nameFields = [
+ $params['billing_first_name'] ?? NULL,
+ $params['billing_middle_name'] ?? NULL,
+ $params['billing_last_name'] ?? NULL,
+ ];
+ $addressParams['name'] = implode(' ', array_filter($nameFields));
+ return (int) CRM_Core_BAO_Address::writeRecord($addressParams)->id;
}
return NULL;
@@ -1714,35 +1722,18 @@ public static function deleteAddress($contributionId = NULL, $contactId = NULL)
* Online Event Registration or Online Membership signup.
*
* @param int $componentId
- * Participant/membership id.
- * @param string $componentName
- * Event/Membership.
+ * Participant id.
*
* @return int
* pending contribution id.
*/
- public static function checkOnlinePendingContribution($componentId, $componentName) {
+ public static function checkOnlinePendingContribution($componentId) {
$contributionId = NULL;
- if (!$componentId ||
- !in_array($componentName, ['Event', 'Membership'])
- ) {
- return $contributionId;
- }
-
- if ($componentName === 'Event') {
- $idName = 'participant_id';
- $componentTable = 'civicrm_participant';
- $paymentTable = 'civicrm_participant_payment';
- $source = ts('Online Event Registration');
- }
-
- if ($componentName === 'Membership') {
- $idName = 'membership_id';
- $componentTable = 'civicrm_membership';
- $paymentTable = 'civicrm_membership_payment';
- $source = ts('Online Contribution');
- }
+ $idName = 'participant_id';
+ $componentTable = 'civicrm_participant';
+ $paymentTable = 'civicrm_participant_payment';
+ $source = ts('Online Event Registration');
$pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'));
$query = "
@@ -3375,7 +3366,7 @@ public static function recordFinancialAccounts(&$params, CRM_Contribute_DAO_Cont
}
// record line items and financial items
if (empty($params['skipLineItem'])) {
- CRM_Price_BAO_LineItem::processPriceSet($entityId, CRM_Utils_Array::value('line_item', $params), $params['contribution'], $entityTable, $isUpdate);
+ CRM_Price_BAO_LineItem::processPriceSet($entityId, $params['line_item'] ?? NULL, $params['contribution'], $entityTable, $isUpdate);
}
// create batch entry if batch_id is passed and
@@ -3499,7 +3490,7 @@ public static function buildOptions($fieldName, $context = NULL, $props = []) {
'version' => 3,
'id' => ($props['contribution_page_id']),
]);
- $types = (array) CRM_Utils_Array::value('payment_processor', $page, 0);
+ $types = (array) $page['payment_processor'] ?? 0;
$params['condition'] = 'id IN (' . implode(',', $types) . ')';
}
break;
@@ -3963,7 +3954,7 @@ public static function generateFromEmailAndName($input, $contribution) {
// if we are still empty see if we can use anything from a contribution page.
if (!empty($pageValues['receipt_from_email'])) {
return [
- CRM_Utils_Array::value('receipt_from_name', $pageValues),
+ $pageValues['receipt_from_name'] ?? NULL,
$pageValues['receipt_from_email'],
];
}
@@ -4308,6 +4299,7 @@ public static function getContributionPaymentLinks(int $id, string $contribution
'is_refund' => 0,
],
'extra' => '',
+ 'weight' => 0,
];
if (CRM_Core_Config::isEnabledBackOfficeCreditCardPayments()) {
@@ -4325,6 +4317,7 @@ public static function getContributionPaymentLinks(int $id, string $contribution
'mode' => 'live',
],
'extra' => '',
+ 'weight' => 0,
];
}
if ($contributionStatus !== 'Pending') {
@@ -4341,6 +4334,7 @@ public static function getContributionPaymentLinks(int $id, string $contribution
'is_refund' => 1,
],
'extra' => '',
+ 'weight' => 0,
];
}
diff --git a/CRM/Contribute/BAO/ContributionPage.php b/CRM/Contribute/BAO/ContributionPage.php
index 72fec24e8437..a2a5ce289d62 100644
--- a/CRM/Contribute/BAO/ContributionPage.php
+++ b/CRM/Contribute/BAO/ContributionPage.php
@@ -261,7 +261,7 @@ public static function sendMail($contactID, $values, $isTest = FALSE, $returnMes
if ($gId) {
$email = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify');
if ($email) {
- $val = CRM_Core_BAO_UFGroup::checkFieldsEmptyValues($gId, $contactID, CRM_Utils_Array::value($key, $params), TRUE);
+ $val = CRM_Core_BAO_UFGroup::checkFieldsEmptyValues($gId, $contactID, $params[$key] ?? NULL, TRUE);
CRM_Core_BAO_UFGroup::commonSendMail($contactID, $val);
}
}
diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php
index 797d3dce9bf5..2a2885c95f34 100644
--- a/CRM/Contribute/BAO/ContributionSoft.php
+++ b/CRM/Contribute/BAO/ContributionSoft.php
@@ -30,7 +30,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
*/
public static function add(&$params) {
$hook = empty($params['id']) ? 'create' : 'edit';
- CRM_Utils_Hook::pre($hook, 'ContributionSoft', CRM_Utils_Array::value('id', $params), $params);
+ CRM_Utils_Hook::pre($hook, 'ContributionSoft', $params['id'] ?? NULL, $params);
$contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
$contributionSoft->copyValues($params);
diff --git a/CRM/Contribute/BAO/FinancialProcessor.php b/CRM/Contribute/BAO/FinancialProcessor.php
index 475caa8165cc..73056b55dafe 100644
--- a/CRM/Contribute/BAO/FinancialProcessor.php
+++ b/CRM/Contribute/BAO/FinancialProcessor.php
@@ -81,7 +81,7 @@ private static function createFinancialItemsForLine($params, $context, $fields,
if ($params['contribution']->currency) {
$currency = $params['contribution']->currency;
}
- $previousLineItemTotal = CRM_Utils_Array::value('line_total', CRM_Utils_Array::value($fieldValueId, $previousLineItems), 0);
+ $previousLineItemTotal = CRM_Utils_Array::value('line_total', $previousLineItems[$fieldValueId] ?? NULL, 0);
$itemParams = [
'transaction_date' => $receiveDate,
'contact_id' => $params['prevContribution']->contact_id,
@@ -101,10 +101,10 @@ private static function createFinancialItemsForLine($params, $context, $fields,
$taxAmount = (float) $lineItemDetails['tax_amount'];
if ($context === 'changeFinancialType' && $lineItemDetails['tax_amount'] === 'null') {
// reverse the Sale Tax amount if there is no tax rate associated with new Financial Type
- $taxAmount = CRM_Utils_Array::value('tax_amount', CRM_Utils_Array::value($fieldValueId, $previousLineItems), 0);
+ $taxAmount = CRM_Utils_Array::value('tax_amount', $previousLineItems[$fieldValueId] ?? NULL, 0);
}
elseif ($previousLineItemTotal != $lineItemDetails['line_total']) {
- $taxAmount -= CRM_Utils_Array::value('tax_amount', CRM_Utils_Array::value($fieldValueId, $previousLineItems), 0);
+ $taxAmount -= CRM_Utils_Array::value('tax_amount', $previousLineItems[$fieldValueId] ?? NULL, 0);
}
if ($taxAmount != 0) {
$itemParams['amount'] = CRM_Contribute_BAO_FinancialProcessor::getMultiplier($params['contribution']->contribution_status_id, $context) * $taxAmount;
diff --git a/CRM/Contribute/BAO/Premium.php b/CRM/Contribute/BAO/Premium.php
index 2f648474de4b..f79715f40a2f 100644
--- a/CRM/Contribute/BAO/Premium.php
+++ b/CRM/Contribute/BAO/Premium.php
@@ -114,6 +114,7 @@ public static function buildPremiumBlock(&$form, $pageID, $formItems = FALSE, $s
else {
CRM_Core_DAO::storeValues($productDAO, $products[$productDAO->id]);
}
+ $products[$productDAO->id] += ['thumbnail' => '', 'image' => ''];
}
$options = $temp = [];
$temp = explode(',', $productDAO->options);
@@ -127,10 +128,10 @@ public static function buildPremiumBlock(&$form, $pageID, $formItems = FALSE, $s
if (count($products)) {
$form->assign('showPremium', $formItems);
$form->assign('showSelectOptions', $formItems);
- $form->assign('products', $products);
$form->assign('premiumBlock', $premiumBlock);
}
}
+ $form->assign('products', $products ?? NULL);
}
/**
diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php
index 68e86322e4a1..6b9b5472ef3c 100644
--- a/CRM/Contribute/Form/AbstractEditPayment.php
+++ b/CRM/Contribute/Form/AbstractEditPayment.php
@@ -529,7 +529,7 @@ public static function formatCreditCardDetails(&$params) {
}
$tplParams['credit_card_exp_date'] = isset($params['credit_card_exp_date']) ? CRM_Utils_Date::mysqlToIso(CRM_Utils_Date::format($params['credit_card_exp_date'])) : NULL;
- $tplParams['credit_card_type'] = CRM_Utils_Array::value('credit_card_type', $params);
+ $tplParams['credit_card_type'] = $params['credit_card_type'] ?? NULL;
$tplParams['credit_card_number'] = CRM_Utils_System::mungeCreditCard(CRM_Utils_Array::value('credit_card_number', $params));
return $tplParams;
}
diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php
index 86b0e9457265..7f1d5e393fd0 100644
--- a/CRM/Contribute/Form/AdditionalInfo.php
+++ b/CRM/Contribute/Form/AdditionalInfo.php
@@ -147,9 +147,11 @@ public static function buildAdditionalDetail(&$form) {
*
* Build the form object for PaymentReminders Information.
*
+ * @deprecated since 5.68 will be removed around 5.78.
* @param CRM_Core_Form $form
*/
public static function buildPaymentReminders(&$form) {
+ CRM_Core_Error::deprecatedFunctionWarning('no alternative, will be removed around 5.78');
//PaymentReminders section
$form->add('hidden', 'hidden_PaymentReminders', 1);
$form->add('text', 'initial_reminder_day', ts('Send Initial Reminder'), ['size' => 3]);
diff --git a/CRM/Contribute/Form/ContributeFormTrait.php b/CRM/Contribute/Form/ContributeFormTrait.php
new file mode 100644
index 000000000000..b5f23429e9fe
--- /dev/null
+++ b/CRM/Contribute/Form/ContributeFormTrait.php
@@ -0,0 +1,91 @@
+isDefined('Contribution')) {
+ return $this->lookup('Contribution', $fieldName);
+ }
+ $id = $this->getContributionID();
+ if ($id) {
+ $this->define('Contribution', 'Contribution', ['id' => $id]);
+ return $this->lookup('Contribution', $fieldName);
+ }
+ return NULL;
+ }
+
+ /**
+ * Get the selected Contribution ID.
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
+ * @noinspection PhpUnhandledExceptionInspection
+ */
+ public function getContributionID(): ?int {
+ throw new CRM_Core_Exception('`getContributionID` must be implemented');
+ }
+
+ /**
+ * Get id of contribution page being acted on.
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
+ * @noinspection PhpUnhandledExceptionInspection
+ */
+ public function getContributionPageID(): ?int {
+ throw new CRM_Core_Exception('`ContributionPageID` must be implemented');
+ }
+
+ /**
+ * Get a value from the contribution being acted on.
+ *
+ * All values returned in apiv4 format. Escaping may be required.
+ *
+ * @param string $fieldName
+ *
+ * @return mixed
+ * @noinspection PhpUnhandledExceptionInspection
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
+ */
+ public function getContributionPageValue(string $fieldName) {
+ if ($this->isDefined('ContributionPage')) {
+ return $this->lookup('ContributionPage', $fieldName);
+ }
+ $id = $this->getContributionPageID();
+ if ($id) {
+ $this->define('ContributionPage', 'ContributionPage', ['id' => $id]);
+ return $this->lookup('ContributionPage', $fieldName);
+ }
+ return NULL;
+ }
+
+}
diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php
index bfad7aa6ae19..8227fb63af04 100644
--- a/CRM/Contribute/Form/Contribution.php
+++ b/CRM/Contribute/Form/Contribution.php
@@ -18,6 +18,7 @@
*/
class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditPayment {
use CRM_Contact_Form_ContactFormTrait;
+ use CRM_Contribute_Form_ContributeFormTrait;
/**
* The id of the contribution that we are processing.
@@ -208,6 +209,11 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP
*/
public $payment_instrument_id;
+ /**
+ * @var bool
+ */
+ private $_payNow;
+
/**
* Explicitly declare the form context.
*/
@@ -215,6 +221,14 @@ public function getDefaultContext() {
return 'create';
}
+ public function __get($name) {
+ if ($name === '_contributionID') {
+ CRM_Core_Error::deprecatedWarning('_contributionID is not a form property - use getContributionID()');
+ return $this->getContributionID();
+ }
+ return NULL;
+ }
+
/**
* Set variables up before form is built.
*
@@ -240,8 +254,7 @@ public function preProcess(): void {
$this->assign('action', $this->_action);
// Get the contribution id if update
- $this->_id = CRM_Utils_Request::retrieve('id', 'Positive');
- $this->assign('isUsePaymentBlock', !empty($this->_id));
+ $this->assign('isUsePaymentBlock', (bool) $this->getContributionID());
if (!empty($this->_id)) {
$this->assignPaymentInfoBlock();
$this->assign('contribID', $this->_id);
@@ -306,7 +319,6 @@ public function preProcess(): void {
// Set title
if ($this->_mode && $this->_id) {
$this->_payNow = TRUE;
- $this->assign('payNow', $this->_payNow);
$this->setTitle(ts('Pay with Credit Card'));
}
elseif ($this->_values['is_template']) {
@@ -318,6 +330,7 @@ public function preProcess(): void {
else {
$this->setPageTitle($this->_ppID ? ts('Pledge Payment') : ts('Contribution'));
}
+ $this->assign('payNow', $this->_payNow);
}
private function preProcessPledge(): void {
@@ -605,8 +618,7 @@ public function buildQuickForm() {
$getOnlyPriceSetElements = FALSE;
}
- $this->set('priceSetId', $this->_priceSetId);
- CRM_Price_BAO_PriceSet::buildPriceSet($this, 'contribution', FALSE);
+ $this->buildPriceSet();
// get only price set form elements.
if ($getOnlyPriceSetElements) {
@@ -670,7 +682,7 @@ public function buildQuickForm() {
}
}
if ($buildRecurBlock) {
- CRM_Contribute_Form_Contribution_Main::buildRecur($this);
+ $this->buildRecur();
$this->setDefaults(['is_recur' => 0]);
$this->assign('buildRecurBlock', TRUE);
}
@@ -872,24 +884,27 @@ public function buildQuickForm() {
$mailingInfo = Civi::settings()->get('mailing_backend');
$this->assign('outBound_option', $mailingInfo['outBound_option']);
- $this->addButtons([
+ $buttons = [
[
'type' => 'upload',
'name' => ts('Save'),
'js' => $js,
'isDefault' => TRUE,
],
- [
+ ];
+ if (!$this->_id) {
+ $buttons[] = [
'type' => 'upload',
'name' => ts('Save and New'),
'js' => $js,
'subName' => 'new',
- ],
- [
- 'type' => 'cancel',
- 'name' => ts('Cancel'),
- ],
- ]);
+ ];
+ }
+ $buttons[] = [
+ 'type' => 'cancel',
+ 'name' => ts('Cancel'),
+ ];
+ $this->addButtons($buttons);
// if contribution is related to membership or participant freeze Financial Type, Amount
if ($this->_id) {
@@ -922,6 +937,49 @@ public function buildQuickForm() {
}
}
+ /**
+ * Build the price set form.
+ */
+ private function buildPriceSet(): void {
+ $priceSetId = $this->getPriceSetID();
+ $form = $this;
+ $component = 'contribution';
+ $priceSet = CRM_Price_BAO_PriceSet::getSetDetail($priceSetId, TRUE, FALSE);
+ $form->_priceSet = $priceSet[$priceSetId] ?? NULL;
+ $validPriceFieldIds = array_keys($form->_priceSet['fields']);
+
+ $form->_priceSet['id'] = $form->_priceSet['id'] ?? $priceSetId;
+ $form->assign('priceSet', $form->_priceSet);
+
+ $feeBlock = &$form->_priceSet['fields'];
+
+ // Call the buildAmount hook.
+ CRM_Utils_Hook::buildAmount($component ?? 'contribution', $form, $feeBlock);
+
+ $hideAdminValues = !CRM_Core_Permission::check('edit contributions');
+ // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
+ $adminFieldVisible = CRM_Core_Permission::check('administer CiviCRM');
+ $checklifetime = FALSE;
+ foreach ($feeBlock as $id => $field) {
+ $options = $field['options'] ?? NULL;
+
+ if (!is_array($options) || !in_array($id, $validPriceFieldIds)) {
+ continue;
+ }
+
+ if (!empty($options)) {
+ CRM_Price_BAO_PriceField::addQuickFormElement($form,
+ 'price_' . $field['id'],
+ $field['id'],
+ FALSE,
+ $field['is_required'] ?? FALSE,
+ NULL,
+ $options
+ );
+ }
+ }
+ }
+
/**
* Global form rule.
*
@@ -1028,7 +1086,7 @@ public function postProcess() {
return;
}
// Get the submitted form values.
- $submittedValues = $this->controller->exportValues($this->_name);
+ $submittedValues = $this->getSubmittedValues();
if ($this->_values['is_template']) {
// If we are a template contribution we don't allow the contribution_status_id to be set
// on the form but we need it for the submit function.
@@ -1207,7 +1265,7 @@ protected function processCreditCard($submittedValues, $lineItem, $contactID) {
$contributionParams,
$financialType,
$this->_bltID,
- CRM_Utils_Array::value('is_recur', $this->_params)
+ $this->_params['is_recur'] ?? NULL
);
$paymentParams['contributionID'] = $contribution->id;
@@ -1332,7 +1390,7 @@ private function processFormContribution(
// add these values for the recurringContrib function ,CRM-10188
$params['financial_type_id'] = $financialType->id;
- $contributionParams['address_id'] = CRM_Contribute_BAO_Contribution::createAddress($params, $billingLocationID);
+ $contributionParams['address_id'] = CRM_Contribute_BAO_Contribution::createAddress($params);
//@todo - this is being set from the form to resolve CRM-10188 - an
// eNotice caused by it not being set @ the front end
@@ -1346,7 +1404,7 @@ private function processFormContribution(
// We may no longer need to set params['is_recur'] - it used to be used in processRecurringContribution
$params['is_recur'] = $isRecur;
$params['payment_instrument_id'] = $contributionParams['payment_instrument_id'] ?? NULL;
- $recurringContributionID = !$isRecur ? NULL : CRM_Contribute_Form_Contribution_Confirm::processRecurringContribution($form, $params, [
+ $recurringContributionID = !$isRecur ? NULL : $this->processRecurringContribution($form, $params, [
'contact_id' => $contactID,
'financial_type_id' => $financialType->id,
]);
@@ -1391,9 +1449,6 @@ private function processFormContribution(
$smarty->assign('dataArray', $dataArray);
$smarty->assign('totalTaxAmount', $params['tax_amount'] ?? NULL);
}
-
- // lets store it in the form variable so postProcess hook can get to this and use it
- $form->_contributionID = $contribution->id;
}
// process soft credit / pcp params first
@@ -1429,6 +1484,51 @@ private function processFormContribution(
return $contribution;
}
+ /**
+ * Create the recurring contribution record.
+ *
+ * @param self $form
+ * @param array $params
+ * @param array $recurParams
+ *
+ * @return int|null
+ */
+ private function processRecurringContribution($form, $params, $recurParams) {
+ // @todo - previously shared code - many items may be irrelevant.
+ $recurParams['amount'] = $params['amount'] ?? NULL;
+ $recurParams['auto_renew'] = $params['auto_renew'] ?? NULL;
+ $recurParams['frequency_unit'] = $params['frequency_unit'] ?? NULL;
+ $recurParams['frequency_interval'] = $params['frequency_interval'] ?? NULL;
+ $recurParams['installments'] = $params['installments'] ?? NULL;
+ $recurParams['currency'] = $params['currency'] ?? NULL;
+ $recurParams['payment_instrument_id'] = $params['payment_instrument_id'];
+
+ $recurParams['is_test'] = 0;
+ if (($form->_action & CRM_Core_Action::PREVIEW) ||
+ (isset($form->_mode) && ($form->_mode == 'test'))
+ ) {
+ $recurParams['is_test'] = 1;
+ }
+
+ $recurParams['start_date'] = $recurParams['create_date'] = $recurParams['modified_date'] = date('YmdHis');
+ if (!empty($params['receive_date'])) {
+ $recurParams['start_date'] = date('YmdHis', strtotime($params['receive_date']));
+ }
+ $recurParams['invoice_id'] = $params['invoiceID'] ?? NULL;
+ $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', 'Pending');
+ $recurParams['payment_processor_id'] = $params['payment_processor_id'] ?? NULL;
+ $recurParams['is_email_receipt'] = (bool) ($params['is_email_receipt'] ?? FALSE);
+ // We set trxn_id=invoiceID specifically for paypal IPN. It is reset this when paypal sends us the real trxn id, CRM-2991
+ $recurParams['processor_id'] = $recurParams['trxn_id'] = ($params['trxn_id'] ?? $params['invoiceID']);
+
+ $campaignId = $params['campaign_id'] ?? $form->_values['campaign_id'] ?? NULL;
+ $recurParams['campaign_id'] = $campaignId;
+ $recurring = CRM_Contribute_BAO_ContributionRecur::add($recurParams);
+ $form->_params['contributionRecurID'] = $recurring->id;
+
+ return $recurring->id;
+ }
+
/**
* Generate the data to construct a snippet based pane.
*
@@ -1481,8 +1581,20 @@ protected function generatePane($type, $defaults) {
*
* @throws \CRM_Core_Exception
* @throws \Civi\Payment\Exception\PaymentProcessorException
+ *
+ * @deprecated since 5.68 will be removed around 5.80.
+ *
+ * Try something like
+ * use use \Civi\Test\FormTrait;
+ * $form = $this->getTestForm('CRM_Contribute_Form_Contribution', $submittedValues, [
+ * 'id' => 4;
+ * 'action' => 'update',
+ * ]);
+ * $form->processForm();
*/
public function testSubmit($params, $action, $creditCardMode = NULL) {
+ // Note that this is really used from tests - so adding noisy deprecations would make them
+ // fail straight away.
$defaults = [
'soft_credit_contact_id' => [],
'receive_date' => date('Y-m-d H:i:s'),
@@ -1528,7 +1640,6 @@ public function testSubmit($params, $action, $creditCardMode = NULL) {
$this->_fields = [];
return $this->submit(array_merge($defaults, $params), $action, CRM_Utils_Array::value('pledge_payment_id', $params));
-
}
/**
@@ -1555,7 +1666,7 @@ protected function submit($submittedValues, $action, $pledgePaymentID) {
if ($this->getPriceSetID() && $action & CRM_Core_Action::UPDATE) {
$line = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'contribution');
$lineID = key($line);
- $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array::value('price_field_id', $line[$lineID]), 'price_set_id');
+ $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $line[$lineID]['price_field_id'] ?? NULL, 'price_set_id');
$quickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
// Why do we do this? Seems like a like a wrapper for old functionality - but single line price sets & quick
// config should be treated the same.
@@ -1658,7 +1769,7 @@ protected function submit($submittedValues, $action, $pledgePaymentID) {
$componentDetails = CRM_Contribute_BAO_Contribution::getComponentDetails($this->_id);
if (empty($componentDetails['membership']) && empty($componentDetails['participant'])) {
if (!($this->_action & CRM_Core_Action::UPDATE && (($this->_defaults['contribution_status_id'] != $submittedValues['contribution_status_id'])))) {
- $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule::cleanMoney(CRM_Utils_Array::value('total_amount', $submittedValues));
+ $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = $this->getSubmittedValue('total_amount');
}
}
@@ -1704,7 +1815,7 @@ protected function submit($submittedValues, $action, $pledgePaymentID) {
$submittedValues['total_amount'] = $this->_values['total_amount'] ?? NULL;
// Avoid tax amount deduction on edit form and keep it original, because this will lead to error described in CRM-20676
if (!$this->_id) {
- $submittedValues['total_amount'] -= CRM_Utils_Array::value('tax_amount', $this->_values, 0);
+ $submittedValues['total_amount'] -= $this->_values['tax_amount'] ?? 0;
}
}
$this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ? $lineItem : FALSE);
@@ -1892,9 +2003,9 @@ protected function submit($submittedValues, $action, $pledgePaymentID) {
$contribution->id,
($formValues['option_type'] ?? 0) == 2,
$formValues['total_amount'],
- CRM_Utils_Array::value('total_amount', $this->_defaults),
+ $this->_defaults['total_amount'] ?? NULL,
$formValues['contribution_status_id'],
- CRM_Utils_Array::value('contribution_status_id', $this->_defaults)
+ $this->_defaults['contribution_status_id'] ?? NULL
);
return $contribution;
}
@@ -1916,7 +2027,7 @@ protected function invoicingPostProcessHook($submittedValues, $action, $lineItem
foreach ($lineItem as $key => $value) {
foreach ($value as $v) {
if (isset($taxRate[(string) CRM_Utils_Array::value('tax_rate', $v)])) {
- $taxRate[(string) $v['tax_rate']] = $taxRate[(string) $v['tax_rate']] + CRM_Utils_Array::value('tax_amount', $v);
+ $taxRate[(string) $v['tax_rate']] = $taxRate[(string) $v['tax_rate']] + ($v['tax_amount'] ?? 0);
}
else {
if (isset($v['tax_rate'])) {
@@ -2055,12 +2166,32 @@ public function setUserContext(): void {
}
/**
- * Get the contribution ID.
+ * Get the selected Contribution ID.
*
- * @return int|null
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
+ * @noinspection PhpUnhandledExceptionInspection
*/
- protected function getContributionID(): ?int {
- return $this->_id;
+ public function getContributionID(): ?int {
+ if (!$this->_id) {
+ $this->_id = CRM_Utils_Request::retrieve('id', 'Positive');
+ }
+ return $this->_id ? (int) $this->_id : NULL;
+ }
+
+ /**
+ * Get id of contribution page being acted on.
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
+ * @noinspection PhpUnhandledExceptionInspection
+ */
+ public function getContributionPageID(): ?int {
+ return $this->getContributionID() ? $this->getContributionValue('contribution_page_id') : NULL;
}
/**
@@ -2220,4 +2351,91 @@ public function getPledgePaymentID(): ?int {
return $this->_ppID ? (int) $this->_ppID : NULL;
}
+ /**
+ * Build elements to collect information for recurring contributions.
+ *
+ * Previously shared function.
+ */
+ private function buildRecur(): void {
+ $form = $this;
+ $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionRecur');
+ $className = 'CRM_Contribute_Form_Contribution';
+
+ $form->assign('is_recur_interval', $form->_values['is_recur_interval'] ?? NULL);
+ $form->assign('is_recur_installments', $form->_values['is_recur_installments'] ?? NULL);
+ $paymentObject = $form->getVar('_paymentObject');
+ if ($paymentObject) {
+ $form->assign('recurringHelpText', $paymentObject->getText('contributionPageRecurringHelp', [
+ 'is_recur_installments' => !empty($form->_values['is_recur_installments']),
+ 'is_email_receipt' => !empty($form->_values['is_email_receipt']),
+ ]));
+ }
+
+ $frUnits = $form->_values['recur_frequency_unit'] ?? NULL;
+ $frequencyUnits = CRM_Core_OptionGroup::values('recur_frequency_units', FALSE, FALSE, TRUE);
+ if (empty($frUnits) &&
+ $className == 'CRM_Contribute_Form_Contribution'
+ ) {
+ $frUnits = implode(CRM_Core_DAO::VALUE_SEPARATOR,
+ CRM_Core_OptionGroup::values('recur_frequency_units', FALSE, FALSE, FALSE, NULL, 'value')
+ );
+ }
+
+ $unitVals = explode(CRM_Core_DAO::VALUE_SEPARATOR, $frUnits);
+
+ // FIXME: Ideally we should freeze select box if there is only
+ // one option but looks there is some problem /w QF freeze.
+ //if ( count( $units ) == 1 ) {
+ //$frequencyUnit->freeze( );
+ //}
+
+ $form->add('text', 'installments', ts('installments'),
+ $attributes['installments'] + ['class' => 'two']
+ );
+ $form->addRule('installments', ts('Number of installments must be a whole number.'), 'integer');
+
+ $is_recur_label = ts('I want to contribute this amount every');
+
+ // CRM 10860, display text instead of a dropdown if there's only 1 frequency unit
+ if (count($unitVals) == 1) {
+ $form->assign('one_frequency_unit', TRUE);
+ $form->add('hidden', 'frequency_unit', $unitVals[0]);
+ if (!empty($form->_values['is_recur_interval']) || $className == 'CRM_Contribute_Form_Contribution') {
+ $unit = CRM_Contribute_BAO_Contribution::getUnitLabelWithPlural($unitVals[0]);
+ $form->assign('frequency_unit', $unit);
+ }
+ else {
+ $is_recur_label = ts('I want to contribute this amount every %1',
+ [1 => $frequencyUnits[$unitVals[0]]]
+ );
+ $form->assign('all_text_recur', TRUE);
+ }
+ }
+ else {
+ $form->assign('one_frequency_unit', FALSE);
+ $units = [];
+ foreach ($unitVals as $key => $val) {
+ if (array_key_exists($val, $frequencyUnits)) {
+ $units[$val] = $frequencyUnits[$val];
+ if (!empty($form->_values['is_recur_interval']) || $className == 'CRM_Contribute_Form_Contribution') {
+ $units[$val] = CRM_Contribute_BAO_Contribution::getUnitLabelWithPlural($val);
+ $unit = ts('Every');
+ }
+ }
+ }
+ $frequencyUnit = &$form->add('select', 'frequency_unit', NULL, $units, FALSE, ['aria-label' => ts('Frequency Unit'), 'class' => 'crm-select2 eight']);
+ }
+
+ if (!empty($form->_values['is_recur_interval']) || $className == 'CRM_Contribute_Form_Contribution') {
+ $form->add('text', 'frequency_interval', $unit, $attributes['frequency_interval'] + ['aria-label' => ts('Every'), 'class' => 'two']);
+ $form->addRule('frequency_interval', ts('Frequency must be a whole number (EXAMPLE: Every 3 months).'), 'integer');
+ }
+ else {
+ // make sure frequency_interval is submitted as 1 if given no choice to user.
+ $form->add('hidden', 'frequency_interval', 1);
+ }
+
+ $form->add('checkbox', 'is_recur', $is_recur_label, NULL);
+ }
+
}
diff --git a/CRM/Contribute/Form/Contribution/Confirm.php b/CRM/Contribute/Form/Contribution/Confirm.php
index e43d107f1c7f..daf64aa0f6c7 100644
--- a/CRM/Contribute/Form/Contribution/Confirm.php
+++ b/CRM/Contribute/Form/Contribution/Confirm.php
@@ -328,7 +328,7 @@ public function preProcess() {
[$field, $locType] = explode('-', $loc);
}
- if (in_array($field, $addressBlocks)) {
+ if (in_array($field, $addressBlocks) && !empty($value)) {
if ($locType === 'Primary') {
$defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
$locType = $defaultLocationType->id;
@@ -565,20 +565,11 @@ public function buildQuickForm() {
$this->assign('is_separate_payment', $this->isSeparateMembershipPayment());
$this->assign('priceSetID', $this->_priceSetId);
-
- // The concept of contributeMode is deprecated.
- if ($this->_contributeMode === 'notify' ||
- $this->_amount <= 0.0 || $this->_params['is_pay_later']
- ) {
- $contribButton = ts('Continue');
- }
- elseif (!empty($this->_ccid)) {
- $contribButton = ts('Make Payment');
- }
- else {
- $contribButton = ts('Make Contribution');
- }
- $this->assign('button', $contribButton);
+ $contributionButtonText = $this->getPaymentProcessorObject()->getText('contributionPageButtonText', [
+ 'is_payment_to_existing' => !empty($this->_ccid),
+ 'amount' => $this->_amount,
+ ]);
+ $this->assign('button', $contributionButtonText);
$this->assign('continueText',
$this->getPaymentProcessorObject()->getText('contributionPageContinueText', [
@@ -586,11 +577,17 @@ public function buildQuickForm() {
'amount' => $this->_amount,
])
);
+ $this->assign('confirmText',
+ $this->getPaymentProcessorObject()->getText('contributionPageConfirmText', [
+ 'is_payment_to_existing' => !empty($this->_ccid),
+ 'amount' => $this->_amount,
+ ])
+ );
$this->addButtons([
[
'type' => 'next',
- 'name' => $contribButton,
+ 'name' => $contributionButtonText,
'spacing' => ' ',
'isDefault' => TRUE,
],
@@ -802,22 +799,6 @@ private function buildMembershipBlock($cid, $selectedMembershipTypeID = NULL, $i
return $separateMembershipPayment;
}
- /**
- * Overwrite action.
- *
- * Since we are only showing elements in frozen mode no help display needed.
- *
- * @return int
- */
- public function getAction() {
- if ($this->_action & CRM_Core_Action::PREVIEW) {
- return CRM_Core_Action::VIEW | CRM_Core_Action::PREVIEW;
- }
- else {
- return CRM_Core_Action::VIEW;
- }
- }
-
/**
* Set default values for the form.
*
@@ -1047,7 +1028,7 @@ protected function processFormContribution(
// add these values for the recurringContrib function ,CRM-10188
$params['financial_type_id'] = $financialType->id;
- $contributionParams['address_id'] = CRM_Contribute_BAO_Contribution::createAddress($params, $billingLocationID);
+ $contributionParams['address_id'] = CRM_Contribute_BAO_Contribution::createAddress($params);
//@todo - this is being set from the form to resolve CRM-10188 - an
// eNotice caused by it not being set @ the front end
@@ -1061,7 +1042,7 @@ protected function processFormContribution(
// We may no longer need to set params['is_recur'] - it used to be used in processRecurringContribution
$params['is_recur'] = $isRecur;
$params['payment_instrument_id'] = $contributionParams['payment_instrument_id'] ?? NULL;
- $recurringContributionID = !$isRecur ? NULL : self::processRecurringContribution($form, $params, [
+ $recurringContributionID = !$isRecur ? NULL : $this->processRecurringContribution($params, [
'contact_id' => $contactID,
'financial_type_id' => $financialType->id,
]);
@@ -1167,13 +1148,12 @@ protected function processFormContribution(
/**
* Create the recurring contribution record.
*
- * @param CRM_Core_Form $form
* @param array $params
* @param array $recurParams
*
* @return int|null
*/
- public static function processRecurringContribution($form, $params, $recurParams) {
+ private function processRecurringContribution(array $params, array $recurParams) {
$recurParams['amount'] = $params['amount'] ?? NULL;
$recurParams['auto_renew'] = $params['auto_renew'] ?? NULL;
@@ -1185,20 +1165,20 @@ public static function processRecurringContribution($form, $params, $recurParams
// CRM-14354: For an auto-renewing membership with an additional contribution,
// if separate payments is not enabled, make sure only the membership fee recurs
- if (!empty($form->_membershipBlock)
- && $form->_membershipBlock['is_separate_payment'] === '0'
+ if (!empty($this->_membershipBlock)
+ && $this->_membershipBlock['is_separate_payment'] === '0'
&& isset($params['selectMembership'])
- && $form->_values['is_allow_other_amount'] == '1'
+ && $this->_values['is_allow_other_amount'] == '1'
// CRM-16331
- && !empty($form->_membershipTypeValues)
- && !empty($form->_membershipTypeValues[$params['selectMembership']]['minimum_fee'])
+ && !empty($this->_membershipTypeValues)
+ && !empty($this->_membershipTypeValues[$params['selectMembership']]['minimum_fee'])
) {
- $recurParams['amount'] = $form->_membershipTypeValues[$params['selectMembership']]['minimum_fee'];
+ $recurParams['amount'] = $this->_membershipTypeValues[$params['selectMembership']]['minimum_fee'];
}
$recurParams['is_test'] = 0;
- if (($form->_action & CRM_Core_Action::PREVIEW) ||
- (isset($form->_mode) && ($form->_mode == 'test'))
+ if (($this->_action & CRM_Core_Action::PREVIEW) ||
+ (isset($this->_mode) && ($this->_mode === 'test'))
) {
$recurParams['is_test'] = 1;
}
@@ -1208,29 +1188,16 @@ public static function processRecurringContribution($form, $params, $recurParams
$recurParams['start_date'] = date('YmdHis', strtotime($params['receive_date']));
}
$recurParams['invoice_id'] = $params['invoiceID'] ?? NULL;
- $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
+ $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', 'Pending');
$recurParams['payment_processor_id'] = $params['payment_processor_id'] ?? NULL;
$recurParams['is_email_receipt'] = (bool) ($params['is_email_receipt'] ?? FALSE);
// We set trxn_id=invoiceID specifically for paypal IPN. It is reset this when paypal sends us the real trxn id, CRM-2991
$recurParams['processor_id'] = $recurParams['trxn_id'] = ($params['trxn_id'] ?? $params['invoiceID']);
- $campaignId = $params['campaign_id'] ?? $form->_values['campaign_id'] ?? NULL;
+ $campaignId = $params['campaign_id'] ?? $this->_values['campaign_id'] ?? NULL;
$recurParams['campaign_id'] = $campaignId;
$recurring = CRM_Contribute_BAO_ContributionRecur::add($recurParams);
- if (is_a($recurring, 'CRM_Core_Error')) {
- CRM_Core_Error::displaySessionError($recurring);
- $urlString = 'civicrm/contribute/transact';
- $urlParams = '_qf_Main_display=true';
- if (get_class($form) == 'CRM_Contribute_Form_Contribution') {
- $urlString = 'civicrm/contact/view/contribution';
- $urlParams = "action=add&cid={$form->_contactID}";
- if ($form->_mode) {
- $urlParams .= "&mode={$form->_mode}";
- }
- }
- CRM_Utils_System::redirect(CRM_Utils_System::url($urlString, $urlParams));
- }
- $form->_params['contributionRecurID'] = $recurring->id;
+ $this->_params['contributionRecurID'] = $recurring->id;
return $recurring->id;
}
@@ -1471,13 +1438,11 @@ protected function postProcessMembership(
$membershipParams, $contactID, $premiumParams,
$customFieldsFormatted, $membershipDetails, $membershipTypeIDs, $isPaidMembership, $membershipID,
$isProcessSeparateMembershipTransaction, $financialTypeID, $unprocessedLineItems) {
- // Assign $this to $form while we eliminate it.
- $form = $this;
$membershipContribution = NULL;
$isTest = $membershipParams['is_test'] ?? FALSE;
$errors = $paymentResults = [];
- $form->_values['isMembership'] = TRUE;
- $isRecurForFirstTransaction = $form->_params['is_recur'] ?? $membershipParams['is_recur'] ?? NULL;
+ $this->_values['isMembership'] = TRUE;
+ $isRecurForFirstTransaction = $this->_params['is_recur'] ?? $membershipParams['is_recur'] ?? NULL;
$totalAmount = $membershipParams['amount'];
@@ -1515,14 +1480,14 @@ protected function postProcessMembership(
$membershipContribution = $paymentResult['contribution'];
// Save the contribution ID so that I can be used in email receipts
// For example, if you need to generate a tax receipt for the donation only.
- $form->_values['contribution_other_id'] = $membershipContribution->id;
+ $this->_values['contribution_other_id'] = $membershipContribution->id;
}
}
if ($isProcessSeparateMembershipTransaction) {
try {
- $form->_lineItem = $unprocessedLineItems;
- if (empty($form->_params['auto_renew']) && !empty($membershipParams['is_recur'])) {
+ $this->_lineItem = $unprocessedLineItems;
+ if (empty($this->_params['auto_renew']) && !empty($membershipParams['is_recur'])) {
unset($membershipParams['is_recur']);
}
[$membershipContribution, $secondPaymentResult] = $this->processSecondaryFinancialTransaction($contactID, array_merge($membershipParams, ['skipLineItem' => 1]),
@@ -1543,7 +1508,7 @@ protected function postProcessMembership(
//@todo - why is this nested so deep? it seems like it could be just set on the calling function on the form layer
if (isset($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])) {
- $form->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
+ $this->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
}
//@todo it should no longer be possible for it to get to this point & membership to not be an array
if (is_array($membershipTypeIDs) && !empty($membershipContributionID)) {
@@ -1559,7 +1524,7 @@ protected function postProcessMembership(
}
$i = 1;
- $form->_params['createdMembershipIDs'] = [];
+ $this->_params['createdMembershipIDs'] = [];
foreach ($membershipTypeIDs as $memType) {
$membershipLineItems = [];
if ($i < count($membershipTypeIDs)) {
@@ -1571,22 +1536,22 @@ protected function postProcessMembership(
}
$i++;
$numTerms = $typesTerms[$memType] ?? 1;
- $contributionRecurID = $form->_params['contributionRecurID'] ?? NULL;
+ $contributionRecurID = $this->_params['contributionRecurID'] ?? NULL;
$membershipSource = NULL;
- if (!empty($form->_params['membership_source'])) {
- $membershipSource = $form->_params['membership_source'];
+ if (!empty($this->_params['membership_source'])) {
+ $membershipSource = $this->_params['membership_source'];
}
- elseif ((isset($form->_values['title']) && !empty($form->_values['title'])) || (isset($form->_values['frontend_title']) && !empty($form->_values['frontend_title']))) {
- $title = $form->_values['frontend_title'];
+ elseif ((isset($this->_values['title']) && !empty($this->_values['title'])) || (isset($this->_values['frontend_title']) && !empty($this->_values['frontend_title']))) {
+ $title = $this->_values['frontend_title'];
$membershipSource = ts('Online Contribution:') . ' ' . $title;
}
$isPayLater = NULL;
- if (isset($form->_params)) {
- $isPayLater = $form->_params['is_pay_later'] ?? NULL;
+ if (isset($this->_params)) {
+ $isPayLater = $this->_params['is_pay_later'] ?? NULL;
}
$memParams = [
- 'campaign_id' => $form->_params['campaign_id'] ?? ($form->_values['campaign_id'] ?? NULL),
+ 'campaign_id' => $this->_params['campaign_id'] ?? ($this->_values['campaign_id'] ?? NULL),
];
// @todo Move this into CRM_Member_BAO_Membership::processMembership
@@ -1594,15 +1559,6 @@ protected function postProcessMembership(
$pending = $membershipContribution->contribution_status_id == CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
}
else {
- // The concept of contributeMode is deprecated.
- // the is_monetary concept probably should be too as it can be calculated from
- // the existence of 'amount' & seems fragile.
- if (((isset($this->_contributeMode)) || !empty($this->_params['is_pay_later'])
- ) &&
- (($this->_values['is_monetary'] && $this->_amount > 0.0))
- ) {
- $pending = TRUE;
- }
$pending = FALSE;
}
@@ -1615,10 +1571,10 @@ protected function postProcessMembership(
$membershipLineItems
);
- $form->set('renewal_mode', $renewalMode);
+ $this->set('renewal_mode', $renewalMode);
if (!empty($dates)) {
- $form->assign('mem_start_date', CRM_Utils_Date::customFormat($dates['start_date'], '%Y%m%d'));
- $form->assign('mem_end_date', CRM_Utils_Date::customFormat($dates['end_date'], '%Y%m%d'));
+ $this->assign('mem_start_date', CRM_Utils_Date::customFormat($dates['start_date'], '%Y%m%d'));
+ $this->assign('mem_end_date', CRM_Utils_Date::customFormat($dates['end_date'], '%Y%m%d'));
}
if (!empty($membershipContribution)) {
@@ -1631,17 +1587,17 @@ protected function postProcessMembership(
civicrm_api3('MembershipPayment', 'create', $membershipPaymentParams);
}
if ($membership) {
- CRM_Core_BAO_CustomValueTable::postProcess($form->_params, 'civicrm_membership', $membership->id, 'Membership');
- $form->_params['createdMembershipIDs'][] = $membership->id;
- $form->_params['membershipID'] = $membership->id;
+ CRM_Core_BAO_CustomValueTable::postProcess($this->_params, 'civicrm_membership', $membership->id, 'Membership');
+ $this->_params['createdMembershipIDs'][] = $membership->id;
+ $this->_params['membershipID'] = $membership->id;
//CRM-15232: Check if membership is created and on the basis of it use
//membership receipt template to send payment receipt
- $form->_values['isMembership'] = TRUE;
+ $this->_values['isMembership'] = TRUE;
}
}
- if ($form->_priceSetId && !empty($form->_useForMember) && !empty($form->_lineItem)) {
- foreach ($form->_lineItem[$form->_priceSetId] as & $priceFieldOp) {
+ if ($this->_priceSetId && !empty($this->_useForMember) && !empty($this->_lineItem)) {
+ foreach ($this->_lineItem[$this->_priceSetId] as & $priceFieldOp) {
if (!empty($priceFieldOp['membership_type_id']) && $membership->membership_type_id == $priceFieldOp['membership_type_id']) {
$membershipOb = $membership;
$priceFieldOp['start_date'] = $membershipOb->start_date ? CRM_Utils_Date::formatDateOnlyLong($membershipOb->start_date) : '-';
@@ -1651,8 +1607,8 @@ protected function postProcessMembership(
$priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
}
}
- $form->_values['lineItem'] = $form->_lineItem;
- $form->assign('lineItem', $form->_lineItem);
+ $this->_values['lineItem'] = $this->_lineItem;
+ $this->assign('lineItem', $this->_lineItem);
}
}
@@ -1662,25 +1618,25 @@ protected function postProcessMembership(
}
if (isset($membershipContributionID)) {
- $form->_values['contribution_id'] = $membershipContributionID;
+ $this->_values['contribution_id'] = $membershipContributionID;
}
- if (empty($form->_params['is_pay_later']) && $form->_paymentProcessor) {
+ if (empty($this->_params['is_pay_later']) && $this->_paymentProcessor) {
// the is_monetary concept probably should be deprecated as it can be calculated from
// the existence of 'amount' & seems fragile.
- if ($form->_values['is_monetary'] && $form->_amount > 0.0 && !$form->_params['is_pay_later']) {
+ if ($this->_values['is_monetary'] && $this->_amount > 0.0 && !$this->_params['is_pay_later']) {
// call postProcess hook before leaving
- $form->postProcessHook();
+ $this->postProcessHook();
}
- $payment = Civi\Payment\System::singleton()->getByProcessor($form->_paymentProcessor);
+ $payment = Civi\Payment\System::singleton()->getByProcessor($this->_paymentProcessor);
// The contribution_other_id is effectively the ID for the only contribution or the non-membership contribution.
// Since we have called the membership contribution (in a 2 contribution scenario) this is out
// primary-contribution compared to that - but let's face it - it's all just too hard & confusing at the moment!
- $paymentParams = array_merge($form->_params, ['contributionID' => $form->_values['contribution_other_id']]);
+ $paymentParams = array_merge($this->_params, ['contributionID' => $this->_values['contribution_other_id']]);
// CRM-19792 : set necessary fields for payment processor
- CRM_Core_Payment_Form::mapParams($form->_bltID, $paymentParams, $paymentParams, TRUE);
+ CRM_Core_Payment_Form::mapParams($this->_bltID, $paymentParams, $paymentParams, TRUE);
// If this is a single membership-related contribution, it won't have
// be performed yet, so do it now.
@@ -1718,9 +1674,9 @@ protected function postProcessMembership(
return;
}
- $emailValues = array_merge($membershipParams, $form->_values);
+ $emailValues = array_merge($membershipParams, $this->_values);
$emailValues['membership_assign'] = 1;
- $emailValues['useForMember'] = !empty($form->_useForMember);
+ $emailValues['useForMember'] = !empty($this->_useForMember);
// Finally send an email receipt for pay-later scenario (although it might sometimes be caught above!)
if ($totalAmount == 0) {
@@ -1732,7 +1688,7 @@ protected function postProcessMembership(
// also it reset any payment processor selection result into pending free membership
// so its a kind of hack to complete free membership at this point since there is no $form->_paymentProcessor info
if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
- if (empty($form->_paymentProcessor)) {
+ if (empty($this->_paymentProcessor)) {
// @todo this can maybe go now we are setting payment_processor_id = 0 more reliably.
$paymentProcessorIDs = explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_values['payment_processor'] ?? NULL);
$this->_paymentProcessor['id'] = $paymentProcessorIDs[0];
diff --git a/CRM/Contribute/Form/Contribution/Main.php b/CRM/Contribute/Form/Contribution/Main.php
index 0c4c36bef11e..5f7d9aa04ab0 100644
--- a/CRM/Contribute/Form/Contribution/Main.php
+++ b/CRM/Contribute/Form/Contribution/Main.php
@@ -126,14 +126,14 @@ public function setDefaultValues() {
// remove component related fields
foreach ($this->_fields as $name => $fieldInfo) {
//don't set custom data Used for Contribution (CRM-1344)
- if (substr($name, 0, 7) == 'custom_') {
+ if (substr($name, 0, 7) === 'custom_') {
$id = substr($name, 7);
if (!CRM_Core_BAO_CustomGroup::checkCustomField($id, ['Contribution', 'Membership'])) {
continue;
}
// ignore component fields
}
- elseif (array_key_exists($name, $contribFields) || (substr($name, 0, 11) == 'membership_') || (substr($name, 0, 13) == 'contribution_')) {
+ elseif (array_key_exists($name, $contribFields) || (substr($name, 0, 11) === 'membership_') || (substr($name, 0, 13) == 'contribution_')) {
continue;
}
$fields[$name] = $fieldInfo;
@@ -146,8 +146,9 @@ public function setDefaultValues() {
$billingDefaults = $this->getProfileDefaults('Billing', $contactID);
$this->_defaults = array_merge($this->_defaults, $billingDefaults);
}
- if (!empty($this->_ccid) && !empty($this->_pendingAmount)) {
- $this->_defaults['total_amount'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($this->_pendingAmount);
+ $balance = $this->getContributionBalance();
+ if ($balance) {
+ $this->_defaults['total_amount'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($balance);
}
/*
@@ -254,7 +255,11 @@ public function setDefaultValues() {
//set custom field defaults
foreach ($this->_fields as $name => $field) {
if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) {
- if (!isset($this->_defaults[$name])) {
+ // check if the custom field is on a membership, we only want to load
+ // defaults for membership custom fields here, not contact fields
+ if (!isset($this->_defaults[$name])
+ && !CRM_Core_BAO_CustomGroup::checkCustomField($customFieldID, ['Membership'])
+ ) {
CRM_Core_BAO_CustomField::setProfileDefaults($customFieldID, $name, $this->_defaults,
$entityId, CRM_Profile_Form::MODE_REGISTER
);
@@ -287,7 +292,7 @@ public function buildQuickForm() {
// CRM-18399: used by template to pass pre profile id as a url arg
$this->assign('custom_pre_id', $this->_values['custom_pre_id']);
- $this->buildComponentForm($this->_id, $this);
+ $this->buildComponentForm();
}
// Build payment processor form
@@ -345,12 +350,12 @@ public function buildQuickForm() {
// build price set form.
$this->set('priceSetId', $this->_priceSetId);
if (empty($this->_ccid)) {
- CRM_Price_BAO_PriceSet::buildPriceSet($this, $this->getFormContext());
+ $this->buildPriceSet($this, $this->getFormContext());
}
if ($this->_values['is_monetary'] &&
$this->_values['is_recur'] && empty($this->_values['pledge_id'])
) {
- self::buildRecur($this);
+ $this->buildRecur();
}
}
@@ -362,7 +367,7 @@ public function buildQuickForm() {
//don't build pledge block when mid is passed
if (!$this->getRenewalMembershipID() && empty($this->_ccid)) {
if (CRM_Core_Component::isEnabled('CiviPledge') && !empty($this->_values['pledge_block_id'])) {
- CRM_Pledge_BAO_PledgeBlock::buildPledgeBlock($this);
+ $this->buildPledgeBlock();
}
}
@@ -397,10 +402,9 @@ public function buildQuickForm() {
CRM_Core_BAO_CMSUser::buildForm($this, $profileID, TRUE);
}
}
- if ($this->_pcpId && empty($this->_ccid)) {
+ if ($this->getPcpID() && empty($this->_ccid)) {
if (CRM_PCP_BAO_PCP::displayName($this->_pcpId)) {
$pcp_supporter_text = CRM_PCP_BAO_PCP::getPcpSupporterText($this->_pcpId, $this->_id, 'contribute');
- $this->assign('pcpSupporterText', $pcp_supporter_text);
}
$prms = ['id' => $this->_pcpId];
CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $prms, $pcpInfo);
@@ -416,6 +420,7 @@ public function buildQuickForm() {
$this->addField('pcp_personal_note', ['entity' => 'ContributionSoft', 'context' => 'create', 'style' => 'height: 3em; width: 40em;']);
}
}
+ $this->assign('pcpSupporterText', $pcp_supporter_text ?? NULL);
if (empty($this->_values['fee']) && empty($this->_ccid)) {
throw new CRM_Core_Exception(ts('This page does not have any price fields configured or you may not have permission for them. Please contact the site administrator for more details.'));
}
@@ -464,6 +469,122 @@ public function buildQuickForm() {
$this->addFormRule(['CRM_Contribute_Form_Contribution_Main', 'formRule'], $this);
}
+ /**
+ * Build the price set form.
+ *
+ * @param CRM_Core_Form $form
+ * @param string|null $component
+ *
+ * @return void
+ * @throws \CRM_Core_Exception
+ */
+ private function buildPriceSet(&$form, $component = NULL) {
+ $validPriceFieldIds = array_keys($this->getPriceFieldMetaData());
+ $form->assign('priceSet', $form->_priceSet);
+
+ // @todo - this hook wrangling can be done earlier if we set the form on $this->>order.
+ $feeBlock = &$form->_values['fee'];
+ // Call the buildAmount hook.
+ CRM_Utils_Hook::buildAmount($component ?? 'contribution', $form, $feeBlock);
+
+ // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
+ $adminFieldVisible = CRM_Core_Permission::check('administer CiviCRM');
+ $checklifetime = FALSE;
+ foreach ($this->getPriceFieldMetaData() as $id => $field) {
+ if ($field['visibility_id:name'] === 'public' ||
+ ($field['visibility_id:name'] === 'admin' && $adminFieldVisible)
+ ) {
+ $options = $field['options'] ?? NULL;
+ if ($this->_membershipContactID && $options) {
+ $contactsLifetimeMemberships = CRM_Member_BAO_Membership::getAllContactMembership($this->_membershipContactID, FALSE, TRUE);
+ $contactsLifetimeMembershipTypes = array_column($contactsLifetimeMemberships, 'membership_type_id');
+ $memTypeIdsInPriceField = array_column($options, 'membership_type_id');
+ $isCurrentMember = (bool) array_intersect($memTypeIdsInPriceField, $contactsLifetimeMembershipTypes);
+ $checklifetime = $checklifetime ?: $isCurrentMember;
+ }
+
+ if (!is_array($options) || !in_array($id, $validPriceFieldIds)) {
+ continue;
+ }
+ if (!CRM_Core_Permission::check('edit contributions')) {
+ foreach ($options as $key => $currentOption) {
+ if ($currentOption['visibility_id:name'] === 'admin') {
+ unset($options[$key]);
+ }
+ }
+ }
+ if (!empty($options)) {
+ $label = (!empty($this->_membershipBlock) && $field['name'] === 'contribution_amount') ? ts('Additional Contribution') : $field['label'];
+ $extra = [];
+ $fieldID = (int) $field['id'];
+ if ($fieldID === $this->getPriceFieldOtherID()) {
+ $extra = [
+ 'onclick' => 'useAmountOther("price_' . $this->getPriceFieldMainID() . '");',
+ 'autocomplete' => 'off',
+ ];
+ }
+ if ($fieldID === $this->getPriceFieldMainID()) {
+ $extra = [
+ 'onclick' => 'clearAmountOther("price_' . $this->getPriceFieldOtherID() . '");',
+ ];
+ }
+
+ CRM_Price_BAO_PriceField::addQuickFormElement($form,
+ 'price_' . $fieldID,
+ $field['id'],
+ FALSE,
+ $field['is_required'] ?? FALSE,
+ $label,
+ $options,
+ [],
+ $extra
+ );
+ }
+ }
+ }
+ $form->assign('hasExistingLifetimeMembership', $checklifetime);
+ }
+
+ /**
+ * Get the idea of the other amount field if the form is configured to offer it.
+ *
+ * The other amount field is an alternative to the configured radio options,
+ * specific to this form.
+ *
+ * @return int|null
+ */
+ private function getPriceFieldOtherID(): ?int {
+ if (!$this->isQuickConfig()) {
+ return NULL;
+ }
+ foreach ($this->order->getPriceFieldsMetadata() as $field) {
+ if ($field['name'] === 'other_amount') {
+ return (int) $field['id'];
+ }
+ }
+ return NULL;
+ }
+
+ /**
+ * Get the idea of the other amount field if the form is configured to offer an other amount.
+ *
+ * The other amount field is an alternative to the configured radio options,
+ * specific to this form.
+ *
+ * @return int|null
+ */
+ private function getPriceFieldMainID(): ?int {
+ if (!$this->isQuickConfig() || !$this->getPriceFieldOtherID()) {
+ return NULL;
+ }
+ foreach ($this->order->getPriceFieldsMetadata() as $field) {
+ if ($field['name'] !== 'other_amount') {
+ return (int) $field['id'];
+ }
+ }
+ return NULL;
+ }
+
/**
* Build Membership Block in Contribution Pages.
* @todo this was shared on CRM_Contribute_Form_ContributionBase but we are refactoring and simplifying for each
@@ -476,7 +597,7 @@ public function buildQuickForm() {
*/
private function buildMembershipBlock() {
$cid = $this->_membershipContactID;
- $isTest = (bool) ($this->_action & CRM_Core_Action::PREVIEW);
+ $isTest = (bool) ($this->getAction() & CRM_Core_Action::PREVIEW);
$separateMembershipPayment = FALSE;
$this->addOptionalQuickFormElement('auto_renew');
if ($this->_membershipBlock) {
@@ -491,7 +612,7 @@ private function buildMembershipBlock() {
$separateMembershipPayment = $this->_membershipBlock['is_separate_payment'] ?? NULL;
- foreach ($this->_priceSet['fields'] as $pField) {
+ foreach ($this->getPriceFieldMetaData() as $pField) {
if (empty($pField['options'])) {
continue;
}
@@ -567,7 +688,7 @@ private function buildMembershipBlock() {
if ($membership["membership_type_id.duration_unit:name"] === 'lifetime') {
unset($radio[$memType['id']]);
unset($radioOptAttrs[$memType['id']]);
- $this->assign('islifetime', TRUE);
+ $this->assign('hasExistingLifetimeMembership', TRUE);
continue;
}
$this->assign('renewal_mode', TRUE);
@@ -618,15 +739,14 @@ private function buildMembershipBlock() {
/**
* Build elements to collect information for recurring contributions.
*
- *
- * @param CRM_Core_Form $form
+ * Previously shared function.
*/
- public static function buildRecur(&$form) {
+ private function buildRecur(): void {
+ $form = $this;
$attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionRecur');
- $className = get_class($form);
- $form->assign('is_recur_interval', CRM_Utils_Array::value('is_recur_interval', $form->_values));
- $form->assign('is_recur_installments', CRM_Utils_Array::value('is_recur_installments', $form->_values));
+ $form->assign('is_recur_interval', $this->getContributionPageValue('is_recur_interval'));
+ $form->assign('is_recur_installments', $this->getContributionPageValue('is_recur_installments'));
$paymentObject = $form->getVar('_paymentObject');
if ($paymentObject) {
$form->assign('recurringHelpText', $paymentObject->getText('contributionPageRecurringHelp', [
@@ -637,13 +757,6 @@ public static function buildRecur(&$form) {
$frUnits = $form->_values['recur_frequency_unit'] ?? NULL;
$frequencyUnits = CRM_Core_OptionGroup::values('recur_frequency_units', FALSE, FALSE, TRUE);
- if (empty($frUnits) &&
- $className == 'CRM_Contribute_Form_Contribution'
- ) {
- $frUnits = implode(CRM_Core_DAO::VALUE_SEPARATOR,
- CRM_Core_OptionGroup::values('recur_frequency_units', FALSE, FALSE, FALSE, NULL, 'value')
- );
- }
$unitVals = explode(CRM_Core_DAO::VALUE_SEPARATOR, $frUnits);
@@ -664,7 +777,7 @@ public static function buildRecur(&$form) {
if (count($unitVals) == 1) {
$form->assign('one_frequency_unit', TRUE);
$form->add('hidden', 'frequency_unit', $unitVals[0]);
- if (!empty($form->_values['is_recur_interval']) || $className == 'CRM_Contribute_Form_Contribution') {
+ if (!empty($form->_values['is_recur_interval'])) {
$unit = CRM_Contribute_BAO_Contribution::getUnitLabelWithPlural($unitVals[0]);
$form->assign('frequency_unit', $unit);
}
@@ -681,7 +794,7 @@ public static function buildRecur(&$form) {
foreach ($unitVals as $key => $val) {
if (array_key_exists($val, $frequencyUnits)) {
$units[$val] = $frequencyUnits[$val];
- if (!empty($form->_values['is_recur_interval']) || $className == 'CRM_Contribute_Form_Contribution') {
+ if (!empty($form->_values['is_recur_interval'])) {
$units[$val] = CRM_Contribute_BAO_Contribution::getUnitLabelWithPlural($val);
$unit = ts('Every');
}
@@ -690,7 +803,7 @@ public static function buildRecur(&$form) {
$frequencyUnit = &$form->add('select', 'frequency_unit', NULL, $units, FALSE, ['aria-label' => ts('Frequency Unit'), 'class' => 'crm-select2 eight']);
}
- if (!empty($form->_values['is_recur_interval']) || $className == 'CRM_Contribute_Form_Contribution') {
+ if (!empty($form->_values['is_recur_interval'])) {
$form->add('text', 'frequency_interval', $unit, $attributes['frequency_interval'] + ['aria-label' => ts('Every'), 'class' => 'two']);
$form->addRule('frequency_interval', ts('Frequency must be a whole number (EXAMPLE: Every 3 months).'), 'integer');
}
@@ -716,7 +829,7 @@ public static function buildRecur(&$form) {
*/
public static function formRule($fields, $files, $self) {
$errors = [];
- $amount = self::computeAmount($fields, $self->_values);
+ $amount = $self->computeAmount($fields, $self->_values);
if (!empty($fields['auto_renew']) && empty($fields['payment_processor_id'])) {
$errors['auto_renew'] = ts('You cannot have auto-renewal on if you are paying later.');
}
@@ -908,7 +1021,7 @@ public static function formRule($fields, $files, $self) {
}
if (isset($fields['selectProduct']) &&
- $fields['selectProduct'] != 'no_thanks'
+ $fields['selectProduct'] !== 'no_thanks'
) {
$productDAO = new CRM_Contribute_DAO_Product();
$productDAO->id = $fields['selectProduct'];
@@ -1028,7 +1141,7 @@ public static function formRule($fields, $files, $self) {
*
* @return int|mixed|null|string
*/
- public static function computeAmount($params, $formValues) {
+ private function computeAmount($params, $formValues) {
$amount = 0;
// First clean up the other amount field if present.
if (isset($params['amount_other'])) {
@@ -1131,13 +1244,13 @@ public function submit($params) {
}
}
}
-
- if (!empty($this->_ccid) && !empty($this->_pendingAmount)) {
- $params['amount'] = $this->_pendingAmount;
+ $balance = $this->getContributionBalance();
+ if ($balance) {
+ $params['amount'] = $balance;
}
else {
// from here on down, $params['amount'] holds a monetary value (or null) rather than an option ID
- $params['amount'] = self::computeAmount($params, $this->_values);
+ $params['amount'] = $this->computeAmount($params, $this->_values);
}
$params['separate_amount'] = $params['amount'];
@@ -1177,11 +1290,11 @@ public function submit($params) {
$this->set('amount_level', CRM_Utils_Array::value('amount_level', $params));
}
- $priceSetId = $params['priceSetId'] ?? NULL;
+ $priceSetID = $this->getPriceSetID();
if (!empty($this->_ccid)) {
$this->set('lineItem', [$this->getPriceSetID() => $this->getExistingContributionLineItems()]);
}
- elseif ($priceSetId) {
+ elseif ($priceSetID) {
$lineItem = [];
if ($this->isQuickConfig()) {
foreach ($this->_values['fee'] as $key => & $val) {
@@ -1201,17 +1314,17 @@ public function submit($params) {
}
if ($this->_membershipBlock) {
- $this->processAmountAndGetAutoRenew($this->_values['fee'], $params, $lineItem[$priceSetId], $priceSetId);
+ $this->processAmountAndGetAutoRenew($this->_values['fee'], $params, $lineItem[$priceSetID]);
}
else {
- CRM_Price_BAO_PriceSet::processAmount($this->_values['fee'], $params, $lineItem[$priceSetId], $priceSetId);
+ CRM_Price_BAO_PriceSet::processAmount($this->_values['fee'], $params, $lineItem[$priceSetID], $priceSetID);
}
if ($proceFieldAmount) {
- $lineItem[$params['priceSetId']][$fieldOption]['unit_price'] = $proceFieldAmount;
- $lineItem[$params['priceSetId']][$fieldOption]['line_total'] = $proceFieldAmount;
- if (isset($lineItem[$params['priceSetId']][$fieldOption]['tax_amount'])) {
- $proceFieldAmount += $lineItem[$params['priceSetId']][$fieldOption]['tax_amount'];
+ $lineItem[$priceSetID][$fieldOption]['unit_price'] = $proceFieldAmount;
+ $lineItem[$priceSetID][$fieldOption]['line_total'] = $proceFieldAmount;
+ if (isset($lineItem[$priceSetID][$fieldOption]['tax_amount'])) {
+ $proceFieldAmount += $lineItem[$priceSetID][$fieldOption]['tax_amount'];
}
if (!$this->_membershipBlock['is_separate_payment']) {
//require when separate membership not used
@@ -1333,24 +1446,11 @@ public function assignFormVariablesByContributionID(): void {
}
}
$this->assign('dummyTitle', $dummyTitle);
-
+ $this->assign('pendingAmount', $this->getContributionBalance());
if (empty($this->getExistingContributionID())) {
return;
}
- if (!$this->getContactID()) {
- CRM_Core_Error::statusBounce(ts("Returning since there is no contact attached to this contribution id."));
- }
-
- $paymentBalance = CRM_Contribute_BAO_Contribution::getContributionBalance($this->_ccid);
- //bounce if the contribution is not pending.
- if ((float) $paymentBalance <= 0) {
- CRM_Core_Error::statusBounce(ts("Returning since contribution has already been handled."));
- }
- if (!empty($paymentBalance)) {
- $this->_pendingAmount = $paymentBalance;
- $this->assign('pendingAmount', $this->_pendingAmount);
- }
-
+ // @todo - all this stuff is likely obsolete.
if ($taxAmount = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_ccid, 'tax_amount')) {
$this->assign('taxAmount', $taxAmount);
}
@@ -1361,6 +1461,29 @@ public function assignFormVariablesByContributionID(): void {
$this->assign('priceSetID', $this->getPriceSetID());
}
+ /**
+ * Get the balance amount if an existing contribution is being paid.
+ *
+ * @return float|null
+ *
+ * @throws \CRM_Core_Exception
+ */
+ private function getContributionBalance(): ?float {
+ if (empty($this->getExistingContributionID())) {
+ return NULL;
+ }
+ if (!$this->getContactID()) {
+ CRM_Core_Error::statusBounce(ts('Returning since there is no contact attached to this contribution id.'));
+ }
+
+ $paymentBalance = CRM_Contribute_BAO_Contribution::getContributionBalance($this->_ccid);
+ //bounce if the contribution is not pending.
+ if ((float) $paymentBalance <= 0) {
+ CRM_Core_Error::statusBounce(ts('Returning since contribution has already been handled.'));
+ }
+ return $paymentBalance;
+ }
+
/**
* Function for unit tests on the postProcess function.
*
@@ -1382,7 +1505,7 @@ public function testSubmit($params) {
*
* @param array $params
*
- * @return mixed
+ * @return bool
* @throws \CRM_Core_Exception
*/
protected function hasSeparateMembershipPaymentAmount($params) {
@@ -1407,4 +1530,354 @@ protected function getCurrentPaymentProcessor(): ?int {
return NULL;
}
+ /**
+ * Add onbehalf/honoree profile fields and native module fields.
+ *
+ * @throws \CRM_Core_Exception
+ */
+ private function buildComponentForm(): void {
+
+ foreach (['soft_credit', 'on_behalf'] as $module) {
+ if ($module === 'soft_credit') {
+ $this->addSoftCreditFields();
+ }
+ else {
+ $this->addOnBehalfFields();
+ }
+ }
+
+ }
+
+ /**
+ * Add soft credit fields.
+ *
+ * @throws \CRM_Core_Exception
+ */
+ private function addSoftCreditFields(): void {
+ if (!empty($this->_values['honoree_profile_id'])) {
+ if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $this->_values['honoree_profile_id'], 'is_active')) {
+ CRM_Core_Error::statusBounce(ts('This contribution page has been configured for contribution on behalf of honoree and the selected honoree profile is either disabled or not found.'));
+ }
+
+ $profileContactType = CRM_Core_BAO_UFGroup::getContactType($this->_values['honoree_profile_id']);
+ $requiredProfileFields = [
+ 'Individual' => ['first_name', 'last_name'],
+ 'Organization' => ['organization_name', 'email'],
+ 'Household' => ['household_name', 'email'],
+ ];
+ $validProfile = CRM_Core_BAO_UFGroup::checkValidProfile($this->_values['honoree_profile_id'], $requiredProfileFields[$profileContactType]);
+ if (!$validProfile) {
+ CRM_Core_Error::statusBounce(ts('This contribution page has been configured for contribution on behalf of honoree and the required fields of the selected honoree profile are disabled or doesn\'t exist.'));
+ }
+
+ $softCreditTypes = CRM_Core_OptionGroup::values("soft_credit_type", FALSE);
+
+ // radio button for Honor Type
+ foreach ($this->_values['soft_credit_types'] as $value) {
+ $honorTypes[$value] = $softCreditTypes[$value];
+ }
+ $this->addRadio('soft_credit_type_id', NULL, $honorTypes, ['allowClear' => TRUE]);
+
+ $honoreeProfileFields = CRM_Core_BAO_UFGroup::getFields(
+ $this->_values['honoree_profile_id'], FALSE,
+ NULL, NULL,
+ NULL, FALSE,
+ NULL, TRUE,
+ NULL, CRM_Core_Permission::CREATE
+ );
+
+ // add the form elements
+ foreach ($honoreeProfileFields as $name => $field) {
+ // If soft credit type is not chosen then make omit requiredness from honoree profile fields
+ if (count($this->_submitValues) &&
+ empty($this->_submitValues['soft_credit_type_id']) &&
+ !empty($field['is_required'])
+ ) {
+ $field['is_required'] = FALSE;
+ }
+ CRM_Core_BAO_UFGroup::buildProfile($this, $field, CRM_Profile_Form::MODE_CREATE, NULL, FALSE, FALSE, NULL, 'honor');
+ }
+ }
+ $this->assign('honoreeProfileFields', $honoreeProfileFields ?? NULL);
+ $this->assign('honor_block_title', $this->_values['honor_block_title'] ?? NULL);
+ $this->assign('honor_block_text', $this->_values['honor_block_text'] ?? NULL);
+ }
+
+ /**
+ * Add the on behalf fields.
+ *
+ * @throws \CRM_Core_Exception
+ */
+ private function addOnBehalfFields(): void {
+ $contactID = $this->getContactID();
+ if (!empty($this->_values['onbehalf_profile_id'])) {
+
+ if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $this->_values['onbehalf_profile_id'], 'is_active')) {
+ CRM_Core_Error::statusBounce(ts('This contribution page has been configured for contribution on behalf of an organization and the selected onbehalf profile is either disabled or not found.'));
+ }
+
+ $member = CRM_Member_BAO_Membership::getMembershipBlock($this->getContributionPageID());
+ if (empty($member['is_active'])) {
+ $msg = ts('Mixed profile not allowed for on behalf of registration/sign up.');
+ $onBehalfProfile = CRM_Core_BAO_UFGroup::profileGroups($this->_values['onbehalf_profile_id']);
+ foreach (
+ [
+ 'Individual',
+ 'Organization',
+ 'Household',
+ ] as $contactType
+ ) {
+ if (in_array($contactType, $onBehalfProfile) &&
+ (in_array('Membership', $onBehalfProfile) ||
+ in_array('Contribution', $onBehalfProfile)
+ )
+ ) {
+ CRM_Core_Error::statusBounce($msg);
+ }
+ }
+ }
+
+ if ($contactID) {
+ // retrieve all permissioned organizations of contact $contactID
+ $organizations = CRM_Contact_BAO_Relationship::getPermissionedContacts($contactID, NULL, NULL, 'Organization');
+
+ if (count($organizations)) {
+ // Related org url - pass checksum if needed
+ $args = [
+ 'ufID' => $this->_values['onbehalf_profile_id'],
+ 'cid' => '',
+ ];
+ if (!empty($_GET['cs'])) {
+ $args = [
+ 'ufID' => $this->_values['onbehalf_profile_id'],
+ 'uid' => $this->_contactID,
+ 'cs' => $_GET['cs'],
+ 'cid' => '',
+ ];
+ }
+ $locDataURL = CRM_Utils_System::url('civicrm/ajax/permlocation', $args, FALSE, NULL, FALSE);
+ }
+ if (count($organizations) > 0) {
+ $this->add('select', 'onbehalfof_id', '', CRM_Utils_Array::collect('name', $organizations));
+
+ $orgOptions = [
+ 0 => ts('Select an existing organization'),
+ 1 => ts('Enter a new organization'),
+ ];
+ $this->addRadio('org_option', ts('options'), $orgOptions);
+ $this->setDefaults(['org_option' => 0]);
+ }
+ }
+
+ if (!empty($this->_values['is_for_organization'])) {
+ if ((int) $this->_values['is_for_organization'] !== 2) {
+ $this->addElement('checkbox', 'is_for_organization',
+ $this->_values['for_organization'],
+ NULL
+ );
+ }
+ }
+
+ $profileFields = CRM_Core_BAO_UFGroup::getFields(
+ $this->_values['onbehalf_profile_id'],
+ FALSE, CRM_Core_Action::VIEW, NULL,
+ NULL, FALSE, NULL, FALSE, NULL,
+ CRM_Core_Permission::CREATE, NULL
+ );
+
+ $fieldTypes = ['Contact', 'Organization'];
+ if (!empty($this->_membershipBlock)) {
+ $fieldTypes = array_merge($fieldTypes, ['Membership']);
+ }
+ $contactSubType = CRM_Contact_BAO_ContactType::subTypes('Organization');
+ $fieldTypes = array_merge($fieldTypes, $contactSubType);
+
+ foreach ($profileFields as $name => $field) {
+ if (in_array($field['field_type'], $fieldTypes)) {
+ [$prefixName, $index] = CRM_Utils_System::explode('-', $name, 2);
+ if (in_array($prefixName, ['organization_name', 'email']) && empty($field['is_required'])) {
+ $field['is_required'] = 1;
+ }
+ if (count($this->_submitValues) &&
+ empty($this->_submitValues['is_for_organization']) &&
+ $this->_values['is_for_organization'] == 1 &&
+ !empty($field['is_required'])
+ ) {
+ $field['is_required'] = FALSE;
+ }
+ CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, NULL, FALSE, 'onbehalf', NULL, 'onbehalf');
+ }
+ }
+ }
+ $this->assign('onBehalfRequired', (int) ($this->_values['is_for_organization'] ?? 0) === 2);
+ $this->assign('locDataURL', $locDataURL ?? NULL);
+ $this->assign('onBehalfOfFields', $profileFields ?? NULL);
+ $this->assign('fieldSetTitle', empty($this->_values['onbehalf_profile_id']) ? NULL : CRM_Core_BAO_UFGroup::getFrontEndTitle($this->_values['onbehalf_profile_id']));
+ // @todo - this is horrible - we are accessing a value in the POST rather than via QF. _submitValues is 'raw'
+ $this->assign('submittedOnBehalf', $this->_submitValues['onbehalfof_id'] ?? NULL);
+ $this->assign('submittedOnBehalfInfo', empty($this->_submitValues['onbehalf']) ? NULL : json_encode(str_replace('"', '\"', $this->_submitValues['onbehalf']), JSON_HEX_APOS));
+ }
+
+ /**
+ * Build Pledge Block in Contribution Pages.
+ *
+ * @throws \CRM_Core_Exception
+ */
+ private function buildPledgeBlock() {
+ //build pledge payment fields.
+ if (!empty($this->_values['pledge_id'])) {
+ //get all payments required details.
+ $allPayments = [];
+ $returnProperties = [
+ 'status_id',
+ 'scheduled_date',
+ 'scheduled_amount',
+ 'currency',
+ ];
+ CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'pledge_id',
+ $this->_values['pledge_id'], $allPayments, $returnProperties
+ );
+ // get all status
+ $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
+
+ $nextPayment = [];
+ $isNextPayment = FALSE;
+ $overduePayments = [];
+ foreach ($allPayments as $payID => $value) {
+ if ($allStatus[$value['status_id']] == 'Overdue') {
+ $overduePayments[$payID] = [
+ 'id' => $payID,
+ 'scheduled_amount' => CRM_Utils_Rule::cleanMoney($value['scheduled_amount']),
+ 'scheduled_amount_currency' => $value['currency'],
+ 'scheduled_date' => CRM_Utils_Date::customFormat($value['scheduled_date'],
+ '%B %d'
+ ),
+ ];
+ }
+ elseif (!$isNextPayment &&
+ $allStatus[$value['status_id']] == 'Pending'
+ ) {
+ // get the next payment.
+ $nextPayment = [
+ 'id' => $payID,
+ 'scheduled_amount' => CRM_Utils_Rule::cleanMoney($value['scheduled_amount']),
+ 'scheduled_amount_currency' => $value['currency'],
+ 'scheduled_date' => CRM_Utils_Date::customFormat($value['scheduled_date'],
+ '%B %d'
+ ),
+ ];
+ $isNextPayment = TRUE;
+ }
+ }
+
+ // build check box array for payments.
+ $payments = [];
+ if (!empty($overduePayments)) {
+ foreach ($overduePayments as $id => $payment) {
+ $label = ts("%1 - due on %2 (overdue)", [
+ 1 => CRM_Utils_Money::format(CRM_Utils_Array::value('scheduled_amount', $payment), CRM_Utils_Array::value('scheduled_amount_currency', $payment)),
+ 2 => $payment['scheduled_date'] ?? NULL,
+ ]);
+ $paymentID = $payment['id'] ?? NULL;
+ $payments[] = $this->createElement('checkbox', $paymentID, NULL, $label, ['amount' => CRM_Utils_Array::value('scheduled_amount', $payment)]);
+ }
+ }
+
+ if (!empty($nextPayment)) {
+ $label = ts("%1 - due on %2", [
+ 1 => CRM_Utils_Money::format(CRM_Utils_Array::value('scheduled_amount', $nextPayment), CRM_Utils_Array::value('scheduled_amount_currency', $nextPayment)),
+ 2 => $nextPayment['scheduled_date'] ?? NULL,
+ ]);
+ $paymentID = $nextPayment['id'] ?? NULL;
+ $payments[] = $this->createElement('checkbox', $paymentID, NULL, $label, ['amount' => CRM_Utils_Array::value('scheduled_amount', $nextPayment)]);
+ }
+ // give error if empty or build form for payment.
+ if (empty($payments)) {
+ throw new CRM_Core_Exception(ts('Oops. It looks like there is no valid payment status for online payment.'));
+ }
+ $this->addGroup($payments, 'pledge_amount', ts('Make Pledge Payment(s):'), '
');
+ }
+ else {
+ $pledgeBlock = [];
+
+ $dao = new CRM_Pledge_DAO_PledgeBlock();
+ $dao->entity_table = 'civicrm_contribution_page';
+ $dao->entity_id = $pageID;
+ if ($dao->find(TRUE)) {
+ CRM_Core_DAO::storeValues($dao, $pledgeBlock);
+ }
+ // build form for pledge creation.
+ $pledgeOptions = [
+ '0' => ts('I want to make a one-time contribution'),
+ '1' => ts('I pledge to contribute this amount every'),
+ ];
+ $this->addRadio('is_pledge', ts('Pledge Frequency Interval'), $pledgeOptions,
+ NULL, ['
']
+ );
+ $this->addElement('text', 'pledge_installments', ts('Installments'), ['size' => 3, 'aria-label' => ts('Installments')]);
+
+ if (!empty($pledgeBlock['is_pledge_interval'])) {
+ $this->addElement('text', 'pledge_frequency_interval', NULL, ['size' => 3, 'aria-label' => ts('Frequency Intervals')]);
+ }
+ else {
+ $this->add('hidden', 'pledge_frequency_interval', 1);
+ }
+ // Frequency unit drop-down label suffixes switch from *ly to *(s)
+ $freqUnitVals = explode(CRM_Core_DAO::VALUE_SEPARATOR, $pledgeBlock['pledge_frequency_unit']);
+ $freqUnits = [];
+ $frequencyUnits = CRM_Core_OptionGroup::values('recur_frequency_units');
+ foreach ($freqUnitVals as $key => $val) {
+ if (array_key_exists($val, $frequencyUnits)) {
+ $freqUnits[$val] = !empty($pledgeBlock['is_pledge_interval']) ? "{$frequencyUnits[$val]}(s)" : $frequencyUnits[$val];
+ }
+ }
+ $this->addElement('select', 'pledge_frequency_unit', NULL, $freqUnits, ['aria-label' => ts('Frequency Units')]);
+ // CRM-18854
+ if (!empty($pledgeBlock['is_pledge_start_date_visible'])) {
+ if (!empty($pledgeBlock['pledge_start_date'])) {
+ $defaults = [];
+ $date = (array) json_decode($pledgeBlock['pledge_start_date']);
+ foreach ($date as $field => $value) {
+ switch ($field) {
+ case 'contribution_date':
+ $this->add('datepicker', 'start_date', ts('First installment payment'), [], FALSE, ['time' => FALSE]);
+ $paymentDate = $value = date('Y-m-d');
+ $defaults['start_date'] = $value;
+ $this->assign('is_date', TRUE);
+ break;
+
+ case 'calendar_date':
+ $this->add('datepicker', 'start_date', ts('First installment payment'), [], FALSE, ['time' => FALSE]);
+ $defaults['start_date'] = $value;
+ $this->assign('is_date', TRUE);
+ $paymentDate = $value;
+ break;
+
+ case 'calendar_month':
+ $month = CRM_Utils_Date::getCalendarDayOfMonth();
+ $this->add('select', 'start_date', ts('Day of month installments paid'), $month);
+ $paymentDate = CRM_Pledge_BAO_Pledge::getPaymentDate($value);
+ $defaults['start_date'] = $paymentDate;
+ break;
+
+ default:
+ break;
+
+ }
+ $this->setDefaults($defaults);
+ $this->assign('start_date_display', $paymentDate);
+ $this->assign('start_date_editable', FALSE);
+ if (!empty($pledgeBlock['is_pledge_start_date_editable'])) {
+ $this->assign('start_date_editable', TRUE);
+ if ($field == 'calendar_month') {
+ $this->assign('is_date', FALSE);
+ $this->setDefaults(['start_date' => $value]);
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
}
diff --git a/CRM/Contribute/Form/ContributionBase.php b/CRM/Contribute/Form/ContributionBase.php
index ac9a967edbc3..46fb52bf9d64 100644
--- a/CRM/Contribute/Form/ContributionBase.php
+++ b/CRM/Contribute/Form/ContributionBase.php
@@ -15,11 +15,14 @@
* @copyright CiviCRM LLC https://civicrm.org/licensing
*/
+use Civi\Api4\PriceSet;
+
/**
* This class generates form components for processing a contribution.
*/
class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form {
use CRM_Financial_Form_FrontEndPaymentFormTrait;
+ use CRM_Contribute_Form_ContributeFormTrait;
/**
* The id of the contribution page that we are processing.
@@ -114,6 +117,8 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form {
* Pcp id
*
* @var int
+ *
+ * @internal use getPcpID().
*/
public $_pcpId;
@@ -268,11 +273,41 @@ public function getPriceSetID(): ?int {
else {
$this->_priceSetId = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $this->_id);
}
+ if (!$this->_priceSetId) {
+ if ($this->isShowMembershipBlock()) {
+ $this->_priceSetId = PriceSet::get(FALSE)
+ ->addWhere('name', '=', 'default_membership_type_amount')
+ ->execute()
+ ->first()['id'];
+ }
+ }
$this->set('priceSetId', $this->_priceSetId);
}
return $this->_priceSetId ?: NULL;
}
+ /**
+ * Get id of contribution page being acted on.
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
+ * @return int
+ */
+ public function getContributionPageID(): int {
+ if (!$this->_id) {
+ /** @noinspection PhpUnhandledExceptionInspection */
+ $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();
+ }
+ }
+ return $this->_id;
+ }
+
/**
* Set variables up before form is built.
*
@@ -282,13 +317,8 @@ public function getPriceSetID(): ?int {
public function preProcess() {
// current contribution page id
- $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
+ $this->getContributionPageID();
$this->_ccid = CRM_Utils_Request::retrieve('ccid', '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->_emailExists = $this->get('emailExists');
$this->_contactID = $this->_membershipContactID = $this->getContactID();
@@ -354,6 +384,7 @@ public function preProcess() {
if ($this->getPriceSetID()) {
$this->order = new CRM_Financial_BAO_Order();
$this->order->setPriceSetID($this->getPriceSetID());
+ $this->order->setIsExcludeExpiredFields(TRUE);
}
else {
CRM_Core_Error::deprecatedFunctionWarning('forms require a price set ID');
@@ -366,11 +397,6 @@ public function preProcess() {
$this->_fields = [];
CRM_Contribute_BAO_ContributionPage::setValues($this->_id, $this->_values);
- if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()
- && !CRM_Core_Permission::check('add contributions of type ' . CRM_Contribute_PseudoConstant::financialType($this->_values['financial_type_id']))
- ) {
- CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
- }
if (empty($this->_values['is_active'])) {
throw new CRM_Contribute_Exception_InactiveContributionPageException(ts('The page you requested is currently unavailable.'), $this->_id);
}
@@ -455,10 +481,9 @@ public function preProcess() {
$this->set('membershipBlock', $this->getMembershipBlock());
// Handle PCP
- $pcpId = CRM_Utils_Request::retrieve('pcpId', 'Positive', $this);
- if ($pcpId) {
+ $pcpId = $this->getPcpID();
+ if ($this->getPcpID()) {
$pcp = CRM_PCP_BAO_PCP::handlePcp($pcpId, 'contribute', $this->_values);
- $this->_pcpId = $pcp['pcpId'];
$this->_pcpBlock = $pcp['pcpBlock'];
$this->_pcpInfo = $pcp['pcpInfo'];
}
@@ -473,10 +498,7 @@ public function preProcess() {
$this->assign('linkText', $linkText);
}
- //set pledge block if block id is set
- if (!empty($this->_values['pledge_block_id'])) {
- $this->assign('pledgeBlock', TRUE);
- }
+ $this->assign('pledgeBlock', !empty($this->_values['pledge_block_id']));
// @todo - move this check to `getMembershipBlock`
if (!$this->isFormSupportsNonMembershipContributions() &&
@@ -490,7 +512,6 @@ public function preProcess() {
$this->set('amount_block_is_active', $this->isFormSupportsNonMembershipContributions());
$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']);
@@ -499,7 +520,7 @@ public function preProcess() {
//assign cancelSubscription URL to templates
$this->assign('cancelSubscriptionUrl',
- CRM_Utils_Array::value('cancelSubscriptionUrl', $this->_values)
+ $this->_values['cancelSubscriptionUrl'] ?? NULL
);
$title = $this->_values['frontend_title'];
@@ -543,19 +564,45 @@ private function initSet($form) {
if ($priceSetId) {
if ($form->_action & CRM_Core_Action::UPDATE) {
$form->_values['line_items'] = CRM_Price_BAO_LineItem::getLineItems($form->_id, 'contribution');
- $required = FALSE;
- }
- else {
- $required = TRUE;
}
-
- $priceSet = CRM_Price_BAO_PriceSet::getSetDetail($priceSetId, $required);
- $form->_priceSet = $priceSet[$priceSetId] ?? NULL;
- $form->_values['fee'] = $form->_priceSet['fields'] ?? NULL;
+ $form->_priceSet = $this->order->getPriceSetMetadata();
+ $this->setPriceFieldMetaData($this->order->getPriceFieldsMetadata());
$form->set('priceSet', $form->_priceSet);
}
}
+ /**
+ * Set price field metadata.
+ *
+ * @param array $metadata
+ */
+ public function setPriceFieldMetaData(array $metadata): void {
+ $this->_values['fee'] = $this->_priceSet['fields'] = $metadata;
+ }
+
+ /**
+ * Get price field metadata.
+ *
+ * The returned value is an array of arrays where each array
+ * is an id-keyed price field and an 'options' key has been added to that
+ * arry for any options.
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
+ * @return array
+ */
+ public function getPriceFieldMetaData(): array {
+ if (!empty($this->_values['fee'])) {
+ return $this->_values['fee'];
+ }
+ if (!empty($this->_priceSet['fields'])) {
+ return $this->_priceSet['fields'];
+ }
+ return $this->order->getPriceFieldsMetadata();
+ }
+
/**
* Set the default values.
*/
@@ -791,8 +838,6 @@ public function buildCustom($id, $name, $viewOnly = FALSE, $profileContactType =
}
}
- $this->assign($name, $fields);
-
if ($profileContactType && count($viewOnlyFileValues[$profileContactType])) {
$this->assign('viewOnlyPrefixFileValues', $viewOnlyFileValues);
}
@@ -801,6 +846,7 @@ public function buildCustom($id, $name, $viewOnly = FALSE, $profileContactType =
}
}
}
+ $this->assign($name, $fields ?? NULL);
}
/**
@@ -860,195 +906,6 @@ public function assignPaymentFields() {
}
}
- /**
- * Add onbehalf/honoree profile fields and native module fields.
- *
- * @param int $id
- * @param CRM_Core_Form $form
- *
- * @throws \CRM_Core_Exception
- */
- public function buildComponentForm($id, $form): void {
- if (empty($id)) {
- return;
- }
-
- $contactID = $this->getContactID();
-
- foreach (['soft_credit', 'on_behalf'] as $module) {
- if ($module === 'soft_credit') {
- if (empty($form->_values['honoree_profile_id'])) {
- continue;
- }
-
- if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values['honoree_profile_id'], 'is_active')) {
- CRM_Core_Error::statusBounce(ts('This contribution page has been configured for contribution on behalf of honoree and the selected honoree profile is either disabled or not found.'));
- }
-
- $profileContactType = CRM_Core_BAO_UFGroup::getContactType($form->_values['honoree_profile_id']);
- $requiredProfileFields = [
- 'Individual' => ['first_name', 'last_name'],
- 'Organization' => ['organization_name', 'email'],
- 'Household' => ['household_name', 'email'],
- ];
- $validProfile = CRM_Core_BAO_UFGroup::checkValidProfile($form->_values['honoree_profile_id'], $requiredProfileFields[$profileContactType]);
- if (!$validProfile) {
- CRM_Core_Error::statusBounce(ts('This contribution page has been configured for contribution on behalf of honoree and the required fields of the selected honoree profile are disabled or doesn\'t exist.'));
- }
-
- foreach (['honor_block_title', 'honor_block_text'] as $name) {
- $form->assign($name, $form->_values[$name]);
- }
-
- $softCreditTypes = CRM_Core_OptionGroup::values("soft_credit_type", FALSE);
-
- // radio button for Honor Type
- foreach ($form->_values['soft_credit_types'] as $value) {
- $honorTypes[$value] = $softCreditTypes[$value];
- }
- $form->addRadio('soft_credit_type_id', NULL, $honorTypes, ['allowClear' => TRUE]);
-
- $honoreeProfileFields = CRM_Core_BAO_UFGroup::getFields(
- $this->_values['honoree_profile_id'], FALSE,
- NULL, NULL,
- NULL, FALSE,
- NULL, TRUE,
- NULL, CRM_Core_Permission::CREATE
- );
- $form->assign('honoreeProfileFields', $honoreeProfileFields);
-
- // add the form elements
- foreach ($honoreeProfileFields as $name => $field) {
- // If soft credit type is not chosen then make omit requiredness from honoree profile fields
- if (count($form->_submitValues) &&
- empty($form->_submitValues['soft_credit_type_id']) &&
- !empty($field['is_required'])
- ) {
- $field['is_required'] = FALSE;
- }
- CRM_Core_BAO_UFGroup::buildProfile($form, $field, CRM_Profile_Form::MODE_CREATE, NULL, FALSE, FALSE, NULL, 'honor');
- }
- }
- else {
- if (empty($form->_values['onbehalf_profile_id'])) {
- continue;
- }
-
- if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values['onbehalf_profile_id'], 'is_active')) {
- CRM_Core_Error::statusBounce(ts('This contribution page has been configured for contribution on behalf of an organization and the selected onbehalf profile is either disabled or not found.'));
- }
-
- $member = CRM_Member_BAO_Membership::getMembershipBlock($form->_id);
- if (empty($member['is_active'])) {
- $msg = ts('Mixed profile not allowed for on behalf of registration/sign up.');
- $onBehalfProfile = CRM_Core_BAO_UFGroup::profileGroups($form->_values['onbehalf_profile_id']);
- foreach (
- [
- 'Individual',
- 'Organization',
- 'Household',
- ] as $contactType
- ) {
- if (in_array($contactType, $onBehalfProfile) &&
- (in_array('Membership', $onBehalfProfile) ||
- in_array('Contribution', $onBehalfProfile)
- )
- ) {
- CRM_Core_Error::statusBounce($msg);
- }
- }
- }
-
- if ($contactID) {
- // retrieve all permissioned organizations of contact $contactID
- $organizations = CRM_Contact_BAO_Relationship::getPermissionedContacts($contactID, NULL, NULL, 'Organization');
-
- if (count($organizations)) {
- // Related org url - pass checksum if needed
- $args = [
- 'ufID' => $form->_values['onbehalf_profile_id'],
- 'cid' => '',
- ];
- if (!empty($_GET['cs'])) {
- $args = [
- 'ufID' => $form->_values['onbehalf_profile_id'],
- 'uid' => $this->_contactID,
- 'cs' => $_GET['cs'],
- 'cid' => '',
- ];
- }
- $locDataURL = CRM_Utils_System::url('civicrm/ajax/permlocation', $args, FALSE, NULL, FALSE);
- $form->assign('locDataURL', $locDataURL);
- }
- if (count($organizations) > 0) {
- $form->add('select', 'onbehalfof_id', '', CRM_Utils_Array::collect('name', $organizations));
-
- $orgOptions = [
- 0 => ts('Select an existing organization'),
- 1 => ts('Enter a new organization'),
- ];
- $form->addRadio('org_option', ts('options'), $orgOptions);
- $form->setDefaults(['org_option' => 0]);
- }
- }
-
- $form->assign('fieldSetTitle', CRM_Core_BAO_UFGroup::getFrontEndTitle($form->_values['onbehalf_profile_id']));
-
- if (!empty($form->_values['is_for_organization'])) {
- if ($form->_values['is_for_organization'] == 2) {
- $form->assign('onBehalfRequired', TRUE);
- }
- else {
- $form->addElement('checkbox', 'is_for_organization',
- $form->_values['for_organization'],
- NULL
- );
- }
- }
-
- $profileFields = CRM_Core_BAO_UFGroup::getFields(
- $form->_values['onbehalf_profile_id'],
- FALSE, CRM_Core_Action::VIEW, NULL,
- NULL, FALSE, NULL, FALSE, NULL,
- CRM_Core_Permission::CREATE, NULL
- );
-
- $form->assign('onBehalfOfFields', $profileFields);
- if (!empty($form->_submitValues['onbehalf'])) {
- if (!empty($form->_submitValues['onbehalfof_id'])) {
- $form->assign('submittedOnBehalf', $form->_submitValues['onbehalfof_id']);
- }
- $form->assign('submittedOnBehalfInfo', json_encode(str_replace('"', '\"', $form->_submitValues['onbehalf']), JSON_HEX_APOS));
- }
-
- $fieldTypes = ['Contact', 'Organization'];
- if (!empty($form->_membershipBlock)) {
- $fieldTypes = array_merge($fieldTypes, ['Membership']);
- }
- $contactSubType = CRM_Contact_BAO_ContactType::subTypes('Organization');
- $fieldTypes = array_merge($fieldTypes, $contactSubType);
-
- foreach ($profileFields as $name => $field) {
- if (in_array($field['field_type'], $fieldTypes)) {
- [$prefixName, $index] = CRM_Utils_System::explode('-', $name, 2);
- if (in_array($prefixName, ['organization_name', 'email']) && empty($field['is_required'])) {
- $field['is_required'] = 1;
- }
- if (count($form->_submitValues) &&
- empty($form->_submitValues['is_for_organization']) &&
- $form->_values['is_for_organization'] == 1 &&
- !empty($field['is_required'])
- ) {
- $field['is_required'] = FALSE;
- }
- CRM_Core_BAO_UFGroup::buildProfile($form, $field, NULL, NULL, FALSE, 'onbehalf', NULL, 'onbehalf');
- }
- }
- }
- }
-
- }
-
/**
* Check template file exists.
*
@@ -1245,10 +1102,9 @@ protected function getMainContributionAmount($params) {
* Params reflecting form input e.g with fields 'price_5' => 7, 'price_8' => array(7, 8)
* @param $lineItems
* Line item array to be altered.
- * @param int $priceSetID
*/
- public function processAmountAndGetAutoRenew($fields, &$params, &$lineItems, $priceSetID = NULL) {
- CRM_Price_BAO_PriceSet::processAmount($fields, $params, $lineItems, $priceSetID);
+ public function processAmountAndGetAutoRenew($fields, &$params, &$lineItems) {
+ CRM_Price_BAO_PriceSet::processAmount($fields, $params, $lineItems, $this->getPriceSetID());
$autoRenew = [];
$autoRenew[0] = $autoRenew[1] = $autoRenew[2] = 0;
foreach ($lineItems as $lineItem) {
@@ -1397,4 +1253,37 @@ protected function getExistingContributionLineItems(): array {
return $lineItems;
}
+ /**
+ * Get the PCP ID being contributed to.
+ *
+ * @return int|null
+ */
+ protected function getPcpID(): ?int {
+ if ($this->_pcpId === NULL) {
+ $this->_pcpId = CRM_Utils_Request::retrieve('pcpId', 'Positive', $this);
+ }
+ return $this->_pcpId ? (int) $this->_pcpId : NULL;
+ }
+
+ /**
+ * Get the selected Contribution ID.
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
+ * @noinspection PhpUnhandledExceptionInspection
+ */
+ public function getContributionID(): ?int {
+ if ($this->getExistingContributionID()) {
+ return $this->getExistingContributionID();
+ }
+ if (property_exists($this, '_contributionID')) {
+ // Available on Confirm form (which is tested), so this avoids
+ // accessing that directly & will work for ThankYou in time.
+ return $this->_contributionID;
+ }
+ return NULL;
+ }
+
}
diff --git a/CRM/Contribute/Form/ContributionCharts.php b/CRM/Contribute/Form/ContributionCharts.php
index 5b2005f74641..666546e0ca81 100644
--- a/CRM/Contribute/Form/ContributionCharts.php
+++ b/CRM/Contribute/Form/ContributionCharts.php
@@ -97,7 +97,7 @@ public function postProcess() {
$abbrMonthNames = CRM_Utils_Date::getAbbrMonthNames();
foreach ($abbrMonthNames as $monthKey => $monthName) {
- $val = CRM_Utils_Array::value($monthKey, $chartInfoMonthly['By Month'], 0);
+ $val = $chartInfoMonthly['By Month'][$monthKey] ?? 0;
// don't include zero value month.
if (!$val && ($chartType != 'bvg')) {
diff --git a/CRM/Contribute/Form/ContributionPage.php b/CRM/Contribute/Form/ContributionPage.php
index f09086dfd020..3b8f5a1d6fc0 100644
--- a/CRM/Contribute/Form/ContributionPage.php
+++ b/CRM/Contribute/Form/ContributionPage.php
@@ -34,13 +34,6 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form {
*/
protected $_pledgeBlockID;
- /**
- * Are we in single form mode or wizard mode?
- *
- * @var bool
- */
- protected $_single;
-
/**
* Is this the first page?
*
@@ -48,19 +41,12 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form {
*/
protected $_first = FALSE;
- /**
- * Is this the last page?
- *
- * @var bool
- */
- protected $_last = FALSE;
-
/**
* Store price set id.
*
* @var int
*/
- protected $_priceSetID = NULL;
+ protected $_priceSetID;
protected $_values;
@@ -82,11 +68,7 @@ public function getDefaultContext() {
* Set variables up before form is built.
*/
public function preProcess() {
- // current contribution page id
- $this->_id = CRM_Utils_Request::retrieve('id', 'Positive',
- $this, FALSE, NULL, 'REQUEST'
- );
- $this->assign('contributionPageID', $this->_id);
+ $this->assign('contributionPageID', $this->getContributionPageID());
// get the requested action
$this->_action = CRM_Utils_Request::retrieve('action', 'String',
@@ -97,16 +79,9 @@ public function preProcess() {
// setting title and 3rd level breadcrumb for html page if contrib page exists
if ($this->_id) {
$title = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $this->_id, 'title');
-
- if ($this->_action == CRM_Core_Action::UPDATE) {
- $this->_single = TRUE;
- }
}
- // CRM-16776 - show edit/copy/create buttons on Profiles Tab if user has required permission.
- if (CRM_Core_Permission::check('administer CiviCRM')) {
- $this->assign('perm', TRUE);
- }
+ $this->assign('perm', (bool) CRM_Core_Permission::check('administer CiviCRM'));
// set up tabs
CRM_Contribute_Form_ContributionPage_TabHeader::build($this);
@@ -166,57 +141,18 @@ public function buildQuickForm() {
$this->addElement('hidden', 'cancelURL', $this->_cancelURL);
}
- if ($this->_single) {
- $buttons = [
- [
- 'type' => 'next',
- 'name' => ts('Save'),
- 'spacing' => ' ',
- 'isDefault' => TRUE,
- ],
- [
- 'type' => 'upload',
- 'name' => ts('Save and Done'),
- 'spacing' => ' ',
- 'subName' => 'done',
- ],
- ];
- if (!$this->_last) {
- $buttons[] = [
- 'type' => 'submit',
- 'name' => ts('Save and Next'),
- 'spacing' => ' ',
- 'subName' => 'savenext',
- ];
- }
- $buttons[] = [
- 'type' => 'cancel',
- 'name' => ts('Cancel'),
- ];
- $this->addButtons($buttons);
- }
- else {
- $buttons = [];
- if (!$this->_first) {
- $buttons[] = [
- 'type' => 'back',
- 'name' => ts('Previous'),
- 'spacing' => ' ',
- ];
- }
- $buttons[] = [
+ $buttons = [
+ [
'type' => 'next',
- 'name' => ts('Continue'),
- 'spacing' => ' ',
+ 'name' => ts('Save'),
'isDefault' => TRUE,
- ];
- $buttons[] = [
+ ],
+ [
'type' => 'cancel',
'name' => ts('Cancel'),
- ];
-
- $this->addButtons($buttons);
- }
+ ],
+ ];
+ $this->addButtons($buttons);
$session->replaceUserContext($this->_cancelURL);
@@ -315,10 +251,8 @@ public function setDefaultValues() {
// get price set of type contributions
//this is the value for stored in db if price set extends contribution
- $usedFor = 2;
- $this->_priceSetID = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $this->_id, $usedFor, 1);
- if ($this->_priceSetID) {
- $defaults['price_set_id'] = $this->_priceSetID;
+ if ($this->getPriceSetID()) {
+ $defaults['price_set_id'] = $this->getPriceSetID();
}
}
else {
@@ -463,4 +397,36 @@ public function getTemplateFileName() {
}
}
+ /**
+ * Get the price set ID for the event.
+ *
+ * @return int|null
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ */
+ public function getContributionPageID(): ?int {
+ if (!$this->_id) {
+ $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
+ }
+ return $this->_id ? (int) $this->_id : NULL;
+ }
+
+ /**
+ * Get the price set ID for the contribution page.
+ *
+ * @return int|null
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ */
+ public function getPriceSetID(): ?int {
+ if (!$this->_priceSetID && $this->getContributionPageID()) {
+ $this->_priceSetID = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $this->getContributionPageID());
+ }
+ return $this->_priceSetID ? (int) $this->_priceSetID : NULL;
+ }
+
}
diff --git a/CRM/Contribute/Form/ContributionPage/Amount.php b/CRM/Contribute/Form/ContributionPage/Amount.php
index 910d57e1a9e0..03df84064ade 100644
--- a/CRM/Contribute/Form/ContributionPage/Amount.php
+++ b/CRM/Contribute/Form/ContributionPage/Amount.php
@@ -98,9 +98,7 @@ public function buildQuickForm() {
if (count($recurringPaymentProcessor)) {
$this->assign('recurringPaymentProcessor', $recurringPaymentProcessor);
}
- if (count($futurePaymentProcessor)) {
- $this->assign('futurePaymentProcessor', $futurePaymentProcessor);
- }
+ $this->assign('futurePaymentProcessor', json_encode($futurePaymentProcessor ?? [], TRUE));
if (count($paymentProcessor)) {
$this->assign('paymentProcessor', $paymentProcessor);
}
@@ -144,7 +142,7 @@ public function buildQuickForm() {
else {
$this->assign('price', TRUE);
}
-
+ $this->assign('isQuick', $this->isQuickConfig());
$this->addSelect('price_set_id', [
'entity' => 'PriceSet',
'option_url' => 'civicrm/admin/price',
@@ -208,12 +206,10 @@ public function setDefaultValues() {
if (empty($defaults['pay_later_text'])) {
$defaults['pay_later_text'] = ts('I will send payment by check');
}
-
if (!empty($defaults['amount_block_is_active'])) {
if ($priceSetId = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $this->_id, NULL)) {
- if ($isQuick = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config')) {
- $this->assign('isQuick', $isQuick);
+ if ($this->isQuickConfig()) {
//$priceField = CRM_Core_DAO::getFieldValue( 'CRM_Price_DAO_PriceField', $priceSetId, 'id', 'price_set_id' );
$options = $pFIDs = [];
$priceFieldParams = ['price_set_id' => $priceSetId];
@@ -447,7 +443,7 @@ public function postProcess() {
if (array_key_exists(CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessor', 'AuthNet',
'id', 'payment_processor_type_id'
),
- CRM_Utils_Array::value('payment_processor', $params)
+ ($params['payment_processor'] ?? NULL)
)) {
CRM_Core_Session::setStatus(ts(' Please note that the Authorize.net payment processor only allows recurring contributions and auto-renew memberships with payment intervals from 7-365 days or 1-12 months (i.e. not greater than 1 year).'), '', 'alert');
}
@@ -501,8 +497,8 @@ public function postProcess() {
$params['recur_frequency_unit'] = implode(CRM_Core_DAO::VALUE_SEPARATOR,
array_keys($params['recur_frequency_unit'])
);
- $params['is_recur_interval'] = CRM_Utils_Array::value('is_recur_interval', $params, FALSE);
- $params['is_recur_installments'] = CRM_Utils_Array::value('is_recur_installments', $params, FALSE);
+ $params['is_recur_interval'] = $params['is_recur_interval'] ?? FALSE;
+ $params['is_recur_installments'] = $params['is_recur_installments'] ?? FALSE;
}
if (!empty($params['adjust_recur_start_date'])) {
@@ -818,7 +814,7 @@ public function postProcess() {
}
if ($deleteAmountBlk) {
- $priceField = !empty($params['price_field_id']) ? $params['price_field_id'] : CRM_Utils_Array::value('price_field_other', $params);
+ $priceField = !empty($params['price_field_id']) ? $params['price_field_id'] : $params['price_field_other'] ?? NULL;
if ($priceField) {
$priceSetID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $priceField, 'price_set_id');
CRM_Price_BAO_PriceSet::setIsQuickConfig($priceSetID, 0);
@@ -828,6 +824,15 @@ public function postProcess() {
parent::endPostProcess();
}
+ /**
+ * Is the price set quick config.
+ *
+ * @return bool
+ */
+ private function isQuickConfig(): bool {
+ return $this->getPriceSetID() && CRM_Price_BAO_PriceSet::isQuickConfig($this->getPriceSetID());
+ }
+
/**
* Return a descriptive name for the page, used in wizard header
*
diff --git a/CRM/Contribute/Form/ContributionPage/Premium.php b/CRM/Contribute/Form/ContributionPage/Premium.php
index 7683f3d90015..258c4e1cbafe 100644
--- a/CRM/Contribute/Form/ContributionPage/Premium.php
+++ b/CRM/Contribute/Form/ContributionPage/Premium.php
@@ -127,8 +127,8 @@ public function postProcess() {
$params['id'] = $premiumID;
}
- $params['premiums_active'] = CRM_Utils_Array::value('premiums_active', $params, FALSE);
- $params['premiums_display_min_contribution'] = CRM_Utils_Array::value('premiums_display_min_contribution', $params, FALSE);
+ $params['premiums_active'] = $params['premiums_active'] ?? FALSE;
+ $params['premiums_display_min_contribution'] = $params['premiums_display_min_contribution'] ?? FALSE;
$params['entity_table'] = 'civicrm_contribution_page';
$params['entity_id'] = $this->_id;
diff --git a/CRM/Contribute/Form/ContributionPage/Settings.php b/CRM/Contribute/Form/ContributionPage/Settings.php
index ebf7b9cc7828..a91499ab6a5f 100644
--- a/CRM/Contribute/Form/ContributionPage/Settings.php
+++ b/CRM/Contribute/Form/ContributionPage/Settings.php
@@ -69,8 +69,8 @@ public function setDefaultValues() {
$defaults['honoree_profile'] = $ufGroupDAO->id;
}
$defaults['soft_credit_types'] = [
- CRM_Utils_Array::value('in_honor_of', $soft_credit_types),
- CRM_Utils_Array::value('in_memory_of', $soft_credit_types),
+ $soft_credit_types['in_honor_of'] ?? NULL,
+ $soft_credit_types['in_memory_of'] ?? NULL,
];
}
else {
@@ -92,8 +92,8 @@ public function setDefaultValues() {
$defaults['honoree_profile'] = $ufGroupDAO->id;
}
$defaults['soft_credit_types'] = [
- CRM_Utils_Array::value('in_honor_of', $soft_credit_types),
- CRM_Utils_Array::value('in_memory_of', $soft_credit_types),
+ $soft_credit_types['in_honor_of'] ?? NULL,
+ $soft_credit_types['in_memory_of'] ?? NULL,
];
}
@@ -311,11 +311,11 @@ public function postProcess() {
$params['currency'] = $config->defaultCurrency;
}
- $params['is_confirm_enabled'] = CRM_Utils_Array::value('is_confirm_enabled', $params, FALSE);
- $params['is_share'] = CRM_Utils_Array::value('is_share', $params, FALSE);
- $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
- $params['is_credit_card_only'] = CRM_Utils_Array::value('is_credit_card_only', $params, FALSE);
- $params['honor_block_is_active'] = CRM_Utils_Array::value('honor_block_is_active', $params, FALSE);
+ $params['is_confirm_enabled'] = $params['is_confirm_enabled'] ?? FALSE;
+ $params['is_share'] = $params['is_share'] ?? FALSE;
+ $params['is_active'] = $params['is_active'] ?? FALSE;
+ $params['is_credit_card_only'] = $params['is_credit_card_only'] ?? FALSE;
+ $params['honor_block_is_active'] = $params['honor_block_is_active'] ?? FALSE;
$params['is_for_organization'] = !empty($params['is_organization']) ? CRM_Utils_Array::value('is_for_organization', $params, FALSE) : 0;
$params['goal_amount'] = CRM_Utils_Rule::cleanMoney($params['goal_amount']);
@@ -389,15 +389,6 @@ public function postProcess() {
if ($this->_action & CRM_Core_Action::ADD) {
$url = 'civicrm/admin/contribute/amount';
$urlParams = "action=update&reset=1&id={$dao->id}";
- // special case for 'Save and Done' consistency.
- if ($this->controller->getButtonName('submit') == '_qf_Amount_upload_done') {
- $url = 'civicrm/admin/contribute';
- $urlParams = 'reset=1';
- CRM_Core_Session::setStatus(ts("'%1' information has been saved.",
- [1 => $this->getTitle()]
- ), ts('Saved'), 'success');
- }
-
CRM_Utils_System::redirect(CRM_Utils_System::url($url, $urlParams));
}
parent::endPostProcess();
diff --git a/CRM/Contribute/Form/ContributionPage/ThankYou.php b/CRM/Contribute/Form/ContributionPage/ThankYou.php
index f8cc668f0701..2b325bc60b61 100644
--- a/CRM/Contribute/Form/ContributionPage/ThankYou.php
+++ b/CRM/Contribute/Form/ContributionPage/ThankYou.php
@@ -100,7 +100,7 @@ public function postProcess() {
$params = $this->controller->exportValues($this->_name);
$params['id'] = $this->_id;
- $params['is_email_receipt'] = CRM_Utils_Array::value('is_email_receipt', $params, FALSE);
+ $params['is_email_receipt'] = $params['is_email_receipt'] ?? FALSE;
if (!$params['is_email_receipt']) {
$params['receipt_from_name'] = NULL;
$params['receipt_from_email'] = NULL;
diff --git a/CRM/Contribute/Form/ContributionPage/Widget.php b/CRM/Contribute/Form/ContributionPage/Widget.php
index 937d7457c35a..a8b838cbb4bc 100644
--- a/CRM/Contribute/Form/ContributionPage/Widget.php
+++ b/CRM/Contribute/Form/ContributionPage/Widget.php
@@ -241,7 +241,7 @@ public function postProcess() {
$params['id'] = $this->_widget->id;
}
$params['contribution_page_id'] = $this->_id;
- $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
+ $params['is_active'] = $params['is_active'] ?? FALSE;
$params['url_homepage'] = 'null';
$widget = new CRM_Contribute_DAO_Widget();
diff --git a/CRM/Contribute/Form/ContributionView.php b/CRM/Contribute/Form/ContributionView.php
index e3fa74ea259d..d68c4d30876d 100644
--- a/CRM/Contribute/Form/ContributionView.php
+++ b/CRM/Contribute/Form/ContributionView.php
@@ -21,6 +21,7 @@
* This class generates form components for Payment-Instrument.
*/
class CRM_Contribute_Form_ContributionView extends CRM_Core_Form {
+ use CRM_Contribute_Form_ContributeFormTrait;
/**
* Set variables up before form is built.
@@ -28,7 +29,7 @@ class CRM_Contribute_Form_ContributionView extends CRM_Core_Form {
* @throws \CRM_Core_Exception
*/
public function preProcess() {
- $id = $this->getID();
+ $id = $this->getContributionID();
// Check permission for action.
$actionMapping = [
@@ -82,11 +83,11 @@ public function preProcess() {
$values['contribution_page_title'] = '';
if (!empty($values['contribution_page_id'])) {
$contribPages = CRM_Contribute_PseudoConstant::contributionPage(NULL, TRUE);
- $values['contribution_page_title'] = CRM_Utils_Array::value(CRM_Utils_Array::value('contribution_page_id', $values), $contribPages);
+ $values['contribution_page_title'] = $contribPages[$values['contribution_page_id']] ?? '';
}
// get received into i.e to_financial_account_id from last trxn
- $financialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($this->getID(), 'DESC');
+ $financialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($this->getContributionID(), 'DESC');
$values['to_financial_account'] = '';
$values['payment_processor_name'] = '';
if (!empty($financialTrxnId['financialTrxnId'])) {
@@ -176,7 +177,7 @@ public function preProcess() {
}
//assign soft credit record if exists.
- $SCRecords = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->getID(), TRUE);
+ $SCRecords = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->getContributionID(), TRUE);
$this->assign('softContributions', empty($SCRecords['soft_credit']) ? NULL : $SCRecords['soft_credit']);
// unset doesn't complain if array member missing
unset($SCRecords['soft_credit']);
@@ -266,7 +267,7 @@ public function preProcess() {
$urlParams = "reset=1&id={$id}&cid={$values['contact_id']}&action=update&context={$context}&key={$searchKey}";
}
if (!$contribution['is_template']) {
- foreach (CRM_Contribute_BAO_Contribution::getContributionPaymentLinks($this->getID(), $contributionStatus) as $paymentButton) {
+ foreach (CRM_Contribute_BAO_Contribution::getContributionPaymentLinks($this->getContributionID(), $contributionStatus) as $paymentButton) {
$paymentButton['icon'] = 'fa-plus-circle';
$linkButtons[] = $paymentButton;
}
@@ -378,7 +379,7 @@ private function isHasAccess(string $action): bool {
try {
return Contribution::checkAccess()
->setAction($action)
- ->addValue('id', $this->getID())
+ ->addValue('id', $this->getContributionID())
->execute()->first()['access'];
}
catch (CRM_Core_Exception $e) {
@@ -387,16 +388,33 @@ private function isHasAccess(string $action): bool {
}
/**
- * Get the contribution ID.
+ * Get the selected Contribution ID.
*
- * @return int
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
+ * @noinspection PhpUnhandledExceptionInspection
*/
- private function getID(): int {
+ public function getContributionID(): ?int {
$id = $this->get('id');
- if (empty($id)) {
- CRM_Core_Error::statusBounce('Contribution ID is required');
+ if (!$id) {
+ $id = CRM_Utils_Request::retrieve('id', 'Positive');
}
- return $id;
+ return (int) $id;
+ }
+
+ /**
+ * Get id of contribution page being acted on.
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
+ * @noinspection PhpUnhandledExceptionInspection
+ */
+ public function getContributionPageID(): ?int {
+ return $this->getContributionID() ? $this->getContributionValue('contribution_page_id') : NULL;
}
}
diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php
index c43a24be99b1..f8b885edcbb6 100644
--- a/CRM/Contribute/Form/Task/Invoice.php
+++ b/CRM/Contribute/Form/Task/Invoice.php
@@ -287,12 +287,12 @@ public static function printPDF($contribIDs, &$params, $contactIds) {
$lineItem = CRM_Price_BAO_LineItem::getLineItemsByContributionID($contributionID);
foreach ($lineItem as $taxRate) {
if (isset($dataArray[(string) $taxRate['tax_rate']])) {
- $dataArray[(string) $taxRate['tax_rate']] = $dataArray[(string) $taxRate['tax_rate']] + CRM_Utils_Array::value('tax_amount', $taxRate);
+ $dataArray[(string) $taxRate['tax_rate']] = $dataArray[(string) $taxRate['tax_rate']] + ($taxRate['tax_amount'] ?? 0);
}
else {
$dataArray[(string) $taxRate['tax_rate']] = $taxRate['tax_amount'] ?? NULL;
}
- $subTotal += CRM_Utils_Array::value('subTotal', $taxRate);
+ $subTotal += $taxRate['subTotal'] ?? 0;
}
// to email the invoice
diff --git a/CRM/Contribute/Form/Task/PDFLetter.php b/CRM/Contribute/Form/Task/PDFLetter.php
index 833bc44be9a4..1718cca1a701 100644
--- a/CRM/Contribute/Form/Task/PDFLetter.php
+++ b/CRM/Contribute/Form/Task/PDFLetter.php
@@ -241,7 +241,7 @@ public function postProcess() {
$contactIds = array_keys($contacts);
// CRM-16725 Skip creation of activities if user is previewing their PDF letter(s)
if ($this->isLiveMode()) {
- $this->createActivities($html_message, $contactIds, CRM_Utils_Array::value('subject', $formValues, ts('Thank you letter')), CRM_Utils_Array::value('campaign_id', $formValues), $contactHtml);
+ $this->createActivities($html_message, $contactIds, CRM_Utils_Array::value('subject', $formValues, ts('Thank you letter')), $formValues['campaign_id'] ?? NULL, $contactHtml);
}
$html = array_diff_key($html, $emailedHtml);
diff --git a/CRM/Contribute/Page/ContributionRecur.php b/CRM/Contribute/Page/ContributionRecur.php
index 644c4144b976..4236ae3a582a 100644
--- a/CRM/Contribute/Page/ContributionRecur.php
+++ b/CRM/Contribute/Page/ContributionRecur.php
@@ -51,7 +51,7 @@ public function view() {
}
$contributionRecur['payment_processor'] = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessorName(
- CRM_Utils_Array::value('payment_processor_id', $contributionRecur)
+ $contributionRecur['payment_processor_id'] ?? NULL
);
$idFields = ['contribution_status_id', 'campaign_id', 'financial_type_id'];
foreach ($idFields as $idField) {
diff --git a/CRM/Contribute/Page/DashBoard.php b/CRM/Contribute/Page/DashBoard.php
index b7df27e2f79d..aa8cdbbc413d 100644
--- a/CRM/Contribute/Page/DashBoard.php
+++ b/CRM/Contribute/Page/DashBoard.php
@@ -68,7 +68,7 @@ public function preProcess() {
}
//for contribution tabular View
- $buildTabularView = CRM_Utils_Array::value('showtable', $_GET, FALSE);
+ $buildTabularView = $_GET['showtable'] ?? FALSE;
$this->assign('buildTabularView', $buildTabularView);
if ($buildTabularView) {
return;
diff --git a/CRM/Contribute/Page/ManagePremiums.php b/CRM/Contribute/Page/ManagePremiums.php
index f1b2b7c86ae6..0c08a37687d2 100644
--- a/CRM/Contribute/Page/ManagePremiums.php
+++ b/CRM/Contribute/Page/ManagePremiums.php
@@ -53,28 +53,33 @@ public function &links() {
'url' => 'civicrm/admin/contribute/managePremiums',
'qs' => 'action=update&id=%%id%%&reset=1',
'title' => ts('Edit Premium'),
+ 'weight' => CRM_Core_Action::getWeight(CRM_Core_Action::UPDATE),
],
CRM_Core_Action::PREVIEW => [
'name' => ts('Preview'),
'url' => 'civicrm/admin/contribute/managePremiums',
'qs' => 'action=preview&id=%%id%%',
'title' => ts('Preview Premium'),
+ 'weight' => CRM_Core_Action::getWeight(CRM_Core_Action::PREVIEW),
],
CRM_Core_Action::DISABLE => [
'name' => ts('Disable'),
'ref' => 'crm-enable-disable',
'title' => ts('Disable Premium'),
+ 'weight' => CRM_Core_Action::getWeight(CRM_Core_Action::DISABLE),
],
CRM_Core_Action::ENABLE => [
'name' => ts('Enable'),
'ref' => 'crm-enable-disable',
'title' => ts('Enable Premium'),
+ 'weight' => CRM_Core_Action::getWeight(CRM_Core_Action::ENABLE),
],
CRM_Core_Action::DELETE => [
'name' => ts('Delete'),
'url' => 'civicrm/admin/contribute/managePremiums',
'qs' => 'action=delete&id=%%id%%',
'title' => ts('Delete Premium'),
+ 'weight' => CRM_Core_Action::getWeight(CRM_Core_Action::DELETE),
],
];
}
@@ -125,7 +130,7 @@ public function browse() {
$action -= CRM_Core_Action::DISABLE;
}
- $premiums[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(),
+ $premiums[$dao->id]['action'] = CRM_Core_Action::formLink($this->links(),
$action,
['id' => $dao->id],
ts('more'),
diff --git a/CRM/Contribute/Page/Tab.php b/CRM/Contribute/Page/Tab.php
index 641bb6ee4f01..b9ed69a9ba76 100644
--- a/CRM/Contribute/Page/Tab.php
+++ b/CRM/Contribute/Page/Tab.php
@@ -428,7 +428,7 @@ public function preProcess() {
$this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
$this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
- if ($context == 'standalone') {
+ if ($context === 'standalone') {
$this->_action = CRM_Core_Action::ADD;
}
else {
@@ -439,11 +439,11 @@ public function preProcess() {
'return' => 'contact_id',
]);
}
- $this->assign('contactId', $this->_contactId);
// check logged in url permission
CRM_Contact_Page_View::checkUserPermission($this);
}
+ $this->assign('contactId', $this->_contactId);
$this->assign('action', $this->_action);
if ($this->_permission == CRM_Core_Permission::EDIT && !CRM_Core_Permission::check('edit contributions')) {
diff --git a/CRM/Contribute/Page/UserDashboard.php b/CRM/Contribute/Page/UserDashboard.php
index 96b94a18d73b..cdb2745468a7 100644
--- a/CRM/Contribute/Page/UserDashboard.php
+++ b/CRM/Contribute/Page/UserDashboard.php
@@ -32,7 +32,9 @@ public function listContribution(): void {
// which the tpl can iterate through - this should allow us to cope with competing attempts to add new buttons
// and allow extensions to assign new ones through the pageRun hook
// We could check for balance_amount > 0 here? It feels more correct but this seems to be working.
- if (in_array($row['contribution_status_id:name'], ['Pending', 'Partially paid'], TRUE)) {
+ if (in_array($row['contribution_status_id:name'], ['Pending', 'Partially paid'], TRUE)
+ && Civi::settings()->get('default_invoice_page')
+ ) {
$row['buttons']['pay'] = [
'class' => 'button',
'label' => ts('Pay Now'),
diff --git a/CRM/Contribute/Tokens.php b/CRM/Contribute/Tokens.php
index 5af208998fcd..625496528f87 100644
--- a/CRM/Contribute/Tokens.php
+++ b/CRM/Contribute/Tokens.php
@@ -10,8 +10,8 @@
+--------------------------------------------------------------------+
*/
-use Civi\Api4\ContributionPage;
-use Civi\Api4\ContributionRecur;
+use Civi\Api4\Address;
+use Civi\Token\TokenRow;
/**
* Class CRM_Contribute_Tokens
@@ -61,35 +61,61 @@ protected function getRelatedTokens(): array {
if (!array_key_exists('Contribution', \Civi::service('action_object_provider')->getEntities())) {
return $tokens;
}
+ $tokens += $this->getRelatedTokensForEntity('Address', 'address_id', ['name', 'id']);
+
+ $tokens['address_id.name']['title'] = ts('Billing Address Name');
+ $tokens['address_id.display'] = [
+ 'title' => ts('Billing Address'),
+ 'name' => 'address_id.display',
+ 'type' => 'mapped',
+ 'input_type' => 'Text',
+ 'audience' => 'user',
+ 'data_type' => 'String',
+ ];
+
// Ideally we would derive this from 'usage' - but it looks like adding the usage data
// was quite a bit of work & didn't leave the energy to implement - esp expose for
// where clauses (also, it feels like 'hidden+token' would be a good usage.
- $tokenList = ['frontend_title', 'pay_later_text', 'pay_later_receipt', 'is_share', 'receipt_text'];
- $contributionPageTokens = ContributionPage::getFields(FALSE)->addWhere('name', 'IN', $tokenList)->execute();
- foreach ($contributionPageTokens as $contributionPageToken) {
- $tokens['contribution_page_id.' . $contributionPageToken['name']] = [
- 'title' => $contributionPageToken['title'],
- 'name' => 'contribution_page_id.' . $contributionPageToken['name'],
- 'type' => 'mapped',
- 'data_type' => $contributionPageToken['data_type'],
- 'input_type' => $contributionPageToken['input_type'],
- 'audience' => $contributionPageToken['name'] === 'is_share' ? 'hidden' : 'user',
- ];
- }
+ $contributionPageTokens = ['frontend_title', 'pay_later_text', 'pay_later_receipt', 'is_share', 'receipt_text'];
+ $tokens += $this->getRelatedTokensForEntity('ContributionPage', 'contribution_page_id', $contributionPageTokens, ['is_share']);
+
$hiddenTokens = ['modified_date', 'create_date', 'trxn_id', 'invoice_id', 'is_test', 'payment_token_id', 'payment_processor_id', 'payment_instrument_id', 'cycle_day', 'installments', 'processor_id', 'next_sched_contribution_date', 'failure_count', 'failure_retry_date', 'auto_renew', 'is_email_receipt', 'contribution_status_id'];
- $contributionRecurFields = ContributionRecur::getFields(FALSE)->setLoadOptions(TRUE)->execute();
- foreach ($contributionRecurFields as $contributionRecurField) {
- $tokens['contribution_recur_id.' . $contributionRecurField['name']] = [
- 'title' => $contributionRecurField['title'],
- 'name' => 'contribution_recur_id.' . $contributionRecurField['name'],
- 'type' => 'mapped',
- 'options' => $contributionRecurField['options'] ?? NULL,
- 'data_type' => $contributionRecurField['data_type'],
- 'input_type' => $contributionRecurField['input_type'],
- 'audience' => in_array($contributionRecurField['name'], $hiddenTokens) ? 'hidden' : 'user',
- ];
- }
+ $tokens += $this->getRelatedTokensForEntity('ContributionRecur', 'contribution_recur_id', ['*'], $hiddenTokens);
return $tokens;
}
+ /**
+ * @param \Civi\Token\TokenRow $row
+ * @param string $field
+ * @return string|int
+ */
+ protected function getFieldValue(TokenRow $row, string $field) {
+ $entityName = $this->getEntityName();
+ if (isset($row->context[$entityName][$field])) {
+ return $row->context[$entityName][$field];
+ }
+ if ($field === 'address_id.display') {
+ $addressID = $this->getFieldValue($row, 'address_id.id');
+ // We possibly could figure out how to load in a cleverer way
+ // or as part of apiv4 but this is tested so that can easily happen later...
+ $address = Address::get(FALSE)
+ ->addWhere('id', '=', $addressID)
+ ->addSelect('*', 'state_province_id:label', 'country_id:label')
+ ->execute()->first();
+ // We have name in the address_id.name token.
+ unset($address['name']);
+ return \CRM_Utils_Address::format($address);
+ }
+ return parent::getFieldValue($row, $field);
+ }
+
+ /**
+ * Get fields which need to be returned to render another token.
+ *
+ * @return array
+ */
+ public function getDependencies(): array {
+ return ['address_id.display' => 'address_id.id'];
+ }
+
}
diff --git a/CRM/Contribute/WorkflowMessage/Contribution/BasicContribution.php b/CRM/Contribute/WorkflowMessage/Contribution/BasicContribution.php
index d3477bb3da10..4c5bdc364fca 100644
--- a/CRM/Contribute/WorkflowMessage/Contribution/BasicContribution.php
+++ b/CRM/Contribute/WorkflowMessage/Contribution/BasicContribution.php
@@ -143,6 +143,10 @@ private function addExampleData(GenericWorkflowMessage $messageTemplate, $exampl
$this->setLineItem($mockOrder, $priceField, $priceFieldValue, $index);
}
+ $contribution['address_id.name'] = 'Barbara Johnson';
+ $contribution['address_id.display'] = '790L Lincoln St S
+Baltimore, New York 10545
+United States';
$contribution['total_amount'] = $mockOrder->getTotalAmount();
$contribution['tax_amount'] = $mockOrder->getTotalTaxAmount() ? round($mockOrder->getTotalTaxAmount(), 2) : 0;
$messageTemplate->setContribution($contribution);
diff --git a/CRM/Contribute/WorkflowMessage/ContributionTrait.php b/CRM/Contribute/WorkflowMessage/ContributionTrait.php
index 81e32f49b423..b7baed4edb37 100644
--- a/CRM/Contribute/WorkflowMessage/ContributionTrait.php
+++ b/CRM/Contribute/WorkflowMessage/ContributionTrait.php
@@ -30,6 +30,18 @@ trait CRM_Contribute_WorkflowMessage_ContributionTrait {
*/
public $isShowTax;
+ /**
+ * Is it a good idea to show the line item subtotal.
+ *
+ * This would be true if at least one line has a quantity > 1.
+ * Otherwise it is very repetitive.
+ *
+ * @var bool
+ *
+ * @scope tplParams
+ */
+ public $isShowLineSubtotal;
+
/**
* Line items associated with the contribution.
*
@@ -109,6 +121,25 @@ public function getIsShowLineItems(): bool {
return FALSE;
}
return !$this->order->getPriceSetMetadata()['is_quick_config'];
+ return $this->isShowLineItems;
+ }
+
+ /**
+ * Is it a good idea to show the line item subtotal.
+ *
+ * This would be true if at least one line has a quantity > 1.
+ * Otherwise it is very repetitive.
+ *
+ * @return bool
+ * @throws \CRM_Core_Exception
+ */
+ public function getIsShowLineSubtotal(): bool {
+ foreach ($this->getLineItems() as $lineItem) {
+ if ((int) $lineItem['qty'] > 1) {
+ return TRUE;
+ }
+ }
+ return FALSE;
}
/**
diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php
index d7391167e735..139f0ea6a958 100644
--- a/CRM/Core/BAO/Address.php
+++ b/CRM/Core/BAO/Address.php
@@ -1283,8 +1283,13 @@ public static function addGeocoderData(&$params) {
catch (CRM_Core_Exception $e) {
$providerExists = FALSE;
}
- if ($providerExists) {
- $provider::format($params);
+ try {
+ if ($providerExists) {
+ $provider::format($params);
+ }
+ }
+ catch (CRM_Core_Exception $e) {
+ \Civi::log()->error('Geocoding error:' . $e->getMessage(), ['geocoder' => get_class($provider), 'input' => $params]);
}
// dev/core#2379 - Limit geocode length to 14 characters to avoid validation error on save in UI.
foreach (['geo_code_1', 'geo_code_2'] as $geocode) {
@@ -1312,7 +1317,7 @@ public static function legacyCreate(array $params, bool $fixAddress) {
}
CRM_Core_BAO_Block::sortPrimaryFirst($params['address']);
- $updateBlankLocInfo = CRM_Utils_Array::value('updateBlankLocInfo', $params, FALSE);
+ $updateBlankLocInfo = $params['updateBlankLocInfo'] ?? FALSE;
$contactId = $params['contact_id'];
//get all the addresses for this contact
$addresses = self::allAddress($contactId);
diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php
index bd80441e142d..fe5df456d309 100644
--- a/CRM/Core/BAO/Block.php
+++ b/CRM/Core/BAO/Block.php
@@ -208,8 +208,8 @@ public static function create($blockName, $params) {
$contactId = $params['contact_id'];
- $updateBlankLocInfo = CRM_Utils_Array::value('updateBlankLocInfo', $params, FALSE);
- $isIdSet = CRM_Utils_Array::value('isIdSet', $params[$blockName], FALSE);
+ $updateBlankLocInfo = $params['updateBlankLocInfo'] ?? FALSE;
+ $isIdSet = $params[$blockName]['isIdSet'] ?? FALSE;
//get existing block ids.
$blockIds = self::getBlockIds($blockName, $contactId, $entityElements);
diff --git a/CRM/Core/BAO/CMSUser.php b/CRM/Core/BAO/CMSUser.php
index e43a7b499876..c5f01e496a56 100644
--- a/CRM/Core/BAO/CMSUser.php
+++ b/CRM/Core/BAO/CMSUser.php
@@ -40,9 +40,12 @@ public static function create(&$params, $mailParam) {
$ufID = $config->userSystem->createUser($params, $mailParam);
- //if contact doesn't already exist create UF Match
- if ($ufID !== FALSE &&
- isset($params['contactID'])
+ // Create UF Match if we have contactID unless we're Standalone
+ // since in Standalone uf_match is the same table as User.
+ if (
+ CIVICRM_UF !== 'Standalone'
+ && $ufID !== FALSE
+ && isset($params['contactID'])
) {
// create the UF Match record
$ufmatch['uf_id'] = $ufID;
diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php
index 79ef2f16f7d3..e6f4b68d31b0 100644
--- a/CRM/Core/BAO/CustomField.php
+++ b/CRM/Core/BAO/CustomField.php
@@ -856,11 +856,12 @@ public static function getViewableCustomFields(string $extends, array $extendsEn
&& $field['custom_group_id.is_public']
&& (
!empty($entityValueMatches)
+ || empty($entityFilters)
|| empty($field['custom_group_id.extends_entity_column_id'])
)
&& (
$field['custom_group_id.extends'] === $extends
- || ($field['extends'] === 'Contact' && in_array($extends, ['Individual', 'Organization', 'Household']))
+ || ($field['custom_group_id.extends'] === 'Contact' && in_array($extends, ['Individual', 'Organization', 'Household']))
)
) {
\Civi::$statics[__CLASS__][__FUNCTION__][$cacheKey][(int) $field['id']] = $field;
@@ -1132,6 +1133,10 @@ public static function addQuickFormElement(
$qf->assign('customUrls', $customUrls);
break;
+
+ case 'Hidden':
+ $element = $qf->add('hidden', $elementName);
+ break;
}
switch ($field->data_type) {
@@ -1148,21 +1153,21 @@ public static function addQuickFormElement(
case 'Float':
if ($field->is_search_range && $search) {
- $qf->addRule($elementName . '_from', ts('%1 From must be a number (with or without decimal point).', [1 => $label]), 'numeric');
- $qf->addRule($elementName . '_to', ts('%1 To must be a number (with or without decimal point).', [1 => $label]), 'numeric');
+ $qf->addRule($elementName . '_from', ts('%1 From must be a number (with or without decimals).', [1 => $label]), 'money');
+ $qf->addRule($elementName . '_to', ts('%1 To must be a number (with or without decimals).', [1 => $label]), 'money');
}
elseif ($widget == 'Text') {
- $qf->addRule($elementName, ts('%1 must be a number (with or without decimal point).', [1 => $label]), 'numeric');
+ $qf->addRule($elementName, ts('%1 must be a number (with or without decimals).', [1 => $label]), 'money');
}
break;
case 'Money':
if ($field->is_search_range && $search) {
- $qf->addRule($elementName . '_from', ts('%1 From must in proper money format. (decimal point/comma/space is allowed).', [1 => $label]), 'money');
- $qf->addRule($elementName . '_to', ts('%1 To must in proper money format. (decimal point/comma/space is allowed).', [1 => $label]), 'money');
+ $qf->addRule($elementName . '_from', ts('%1 From must in money format (a number with or without decimals, ex: %2).', [1 => $label, 2 => Civi::format()->number(123.98)]), 'money');
+ $qf->addRule($elementName . '_to', ts('%1 To must in money format (a number with or without decimals, ex: %2).', [1 => $label, 2 => Civi::format()->number(123.98)]), 'money');
}
elseif ($widget == 'Text') {
- $qf->addRule($elementName, ts('%1 must be in proper money format. (decimal point/comma/space is allowed).', [1 => $label]), 'money');
+ $qf->addRule($elementName, ts('%1 must be in money format (a number with or without decimals, ex: %2).', [1 => $label, 2 => Civi::format()->number(123.98)]), 'money');
}
break;
@@ -1321,7 +1326,7 @@ private static function formatDisplayValue($value, $field, $entityId = NULL) {
// In such cases we could just get intval($value) and fetch matching
// option again, but this would not work if key is float like 5.6.
// So we need to truncate trailing zeros to make it work as expected.
- if ($display === '' && strpos(($value ?? ''), '.') !== FALSE) {
+ if ($display === '' && is_numeric($value) && strpos(($value ?? ''), '.') !== FALSE) {
// Use round() to truncate trailing zeros, e.g:
// 10.00 -> 10, 10.60 -> 10.6, 10.69 -> 10.69.
$value = (string) round($value, 5);
@@ -2221,7 +2226,7 @@ protected static function prepareCreate($params) {
// create any option group & values if required
$allowedOptionTypes = ['String', 'Int', 'Float', 'Money'];
- if ($htmlType !== 'Text' && in_array($dataType, $allowedOptionTypes, TRUE)) {
+ if (!in_array($htmlType, ['Text', 'Hidden'], TRUE) && in_array($dataType, $allowedOptionTypes, TRUE)) {
//CRM-16659: if option_value then create an option group for this custom field.
// An option_type of 2 would be a 'message' from the form layer not to handle
// the option_values key. If not set then it is not ignored.
@@ -2749,30 +2754,22 @@ public static function validateCustomData($params) {
switch ($dataType) {
case 'Int':
$ruleName = 'integer';
- $errorMsg = ts('%1 must be an integer (whole number).',
- [1 => $fieldTitle]
- );
+ $errorMsg = ts('%1 must be an integer (whole number).', [1 => $fieldTitle]);
break;
case 'Money':
$ruleName = 'money';
- $errorMsg = ts('%1 must in proper money format. (decimal point/comma/space is allowed).',
- [1 => $fieldTitle]
- );
+ $errorMsg = ts('%1 must be in money format (a number with or without decimals, ex: %2).', [1 => $fieldTitle, 2 => Civi::format()->number(123.98)]);
break;
case 'Float':
$ruleName = 'numeric';
- $errorMsg = ts('%1 must be a number (with or without decimal point).',
- [1 => $fieldTitle]
- );
+ $errorMsg = ts('%1 must be a number (with or without decimals).', [1 => $fieldTitle]);
break;
case 'Link':
$ruleName = 'wikiURL';
- $errorMsg = ts('%1 must be valid Website.',
- [1 => $fieldTitle]
- );
+ $errorMsg = ts('%1 must be valid Website.', [1 => $fieldTitle]);
break;
}
diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php
index e7b561a07c8d..69acff737844 100644
--- a/CRM/Core/BAO/CustomGroup.php
+++ b/CRM/Core/BAO/CustomGroup.php
@@ -550,6 +550,7 @@ public static function getTree(
$cacheString .= "_Inline";
}
+ $multipleFieldGroups = [];
$cacheKey = "CRM_Core_DAO_CustomGroup_Query " . md5($cacheString);
$multipleFieldGroupCacheKey = "CRM_Core_DAO_CustomGroup_QueryMultipleFields " . md5($cacheString);
$cache = CRM_Utils_Cache::singleton();
@@ -837,6 +838,7 @@ public static function buildCustomFieldData($dao, &$groupTree, $table, $groupID,
'qs' => 'reset=1&id=%%id%%&eid=%%eid%%&fid=%%fid%%&action=delete&fcs=%%fcs%%',
'extra' => 'onclick = "if (confirm( \'' . $deleteExtra
. '\' ) ) this.href+=\'&confirmed=1\'; else return false;"',
+ 'weight' => CRM_Core_Action::getWeight(CRM_Core_Action::DELETE),
],
];
$customValue['deleteURL'] = CRM_Core_Action::formLink($deleteURL,
@@ -2061,7 +2063,7 @@ public static function getExtendedObjectTypes(&$types = []) {
* @param array $params
* @return array
*/
- public static function getExtendsEntityColumnValueOptions($context, $params) {
+ public static function getExtendsEntityColumnValueOptions($context, $params): array {
$props = $params['values'] ?? [];
// Requesting this option list only makes sense if the value of 'extends' is known or can be looked up
if (!empty($props['id']) || !empty($props['name']) || !empty($props['extends']) || !empty($props['extends_entity_column_id'])) {
@@ -2397,18 +2399,51 @@ public static function checkGroupAccess($groupId, $operation = CRM_Core_Permissi
return in_array($groupId, $allowedGroups);
}
+ /**
+ * Given the name of a custom group, gets the name of the API entity the group extends.
+ *
+ * Sort of the inverse of this function:
+ * @see \Civi\Api4\Utils\CoreUtil::getCustomGroupExtends
+ *
+ * @param string $groupName
+ * @return string
+ * @throws \CRM_Core_Exception
+ */
+ public static function getEntityForGroup(string $groupName): string {
+ $extends = \CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $groupName, 'extends', 'name');
+ if (!$extends) {
+ throw new \CRM_Core_Exception("Custom group $groupName not found");
+ }
+ return self::getEntityFromExtends($extends);
+ }
+
+ /**
+ * Translate CustomGroup.extends to entity name.
+ *
+ * CustomGroup.extends pretty much maps 1-1 with entity names, except for Individual, Organization & Household.
+ * @param string $extends
+ * @return string
+ * @see self::getCustomGroupExtendsOptions
+ */
+ public static function getEntityFromExtends(string $extends): string {
+ if ($extends === 'Contact' || in_array($extends, \CRM_Contact_BAO_ContactType::basicTypes(TRUE))) {
+ return 'Contact';
+ }
+ return $extends;
+ }
+
/**
* List all possible values for `CustomGroup.extends`.
*
- * This includes the fake entities "Individual", "Organization", "Household"
- * but not the extra options from `custom_data_type` used on the form ("ParticipantStatus", etc).
+ * This includes the pseudo-entities "Individual", "Organization", "Household".
*
* Returns a mix of hard-coded array and `cg_extend_objects` OptionValues.
- * The 'id' return key maps to the 'value' in `cg_extend_objects`.
- * The 'grouping' key refers to the entity field used to select a sub-type.
- * The 'table_name' key is for internal use (is not returned by getFields.loadOptions), and
- * maps to the 'name' in `cg_extend_objects`. We don't return it as the 'name' in getFields because
- * it is not always unique (since contact types are pseudo-entities in this list).
+ * - 'id' return key (maps to `cg_extend_objects.value`).
+ * - 'grouping' key refers to the entity field used to select a sub-type.
+ * - 'is_multiple' (@internal, not returned by getFields.loadOptions) (maps to `cg_extend_objects.filter`)
+ * controls whether the entity supports multi-record custom groups.
+ * - 'table_name' (@internal, not returned by getFields.loadOptions) (maps to `cg_extend_objects.name`).
+ * We don't return it as the 'name' in getFields because it is not always unique (since contact types are pseudo-entities).
*
* @return array{id: string, label: string, grouping: string, table_name: string}[]
*/
@@ -2419,81 +2454,100 @@ public static function getCustomGroupExtendsOptions() {
'label' => ts('Activities'),
'grouping' => 'activity_type_id',
'table_name' => 'civicrm_activity',
+ 'is_multiple' => FALSE,
],
[
'id' => 'Relationship',
'label' => ts('Relationships'),
'grouping' => 'relationship_type_id',
'table_name' => 'civicrm_relationship',
+ 'is_multiple' => FALSE,
],
+ // TODO: Move to civi_contribute extension (example: OptionValue_cg_extends_objects_grant.mgd.php)
[
'id' => 'Contribution',
'label' => ts('Contributions'),
'grouping' => 'financial_type_id',
'table_name' => 'civicrm_contribution',
+ 'is_multiple' => FALSE,
],
[
'id' => 'ContributionRecur',
'label' => ts('Recurring Contributions'),
'grouping' => NULL,
'table_name' => 'civicrm_contribution_recur',
+ 'is_multiple' => FALSE,
],
[
'id' => 'Group',
'label' => ts('Groups'),
'grouping' => NULL,
'table_name' => 'civicrm_group',
+ 'is_multiple' => FALSE,
],
+ // TODO: Move to civi_member extension (example: OptionValue_cg_extends_objects_grant.mgd.php)
[
'id' => 'Membership',
'label' => ts('Memberships'),
'grouping' => 'membership_type_id',
'table_name' => 'civicrm_membership',
+ 'is_multiple' => FALSE,
],
+ // TODO: Move to civi_event extension (example: OptionValue_cg_extends_objects_grant.mgd.php)
[
'id' => 'Event',
'label' => ts('Events'),
'grouping' => 'event_type_id',
'table_name' => 'civicrm_event',
+ 'is_multiple' => FALSE,
],
[
'id' => 'Participant',
'label' => ts('Participants'),
'grouping' => NULL,
'table_name' => 'civicrm_participant',
+ 'is_multiple' => FALSE,
],
+ // TODO: Move to civi_pledge extension (example: OptionValue_cg_extends_objects_grant.mgd.php)
[
'id' => 'Pledge',
'label' => ts('Pledges'),
'grouping' => NULL,
'table_name' => 'civicrm_pledge',
+ 'is_multiple' => FALSE,
],
[
'id' => 'Address',
'label' => ts('Addresses'),
'grouping' => NULL,
'table_name' => 'civicrm_address',
+ 'is_multiple' => FALSE,
],
+ // TODO: Move to civi_campaign extension (example: OptionValue_cg_extends_objects_grant.mgd.php)
[
'id' => 'Campaign',
'label' => ts('Campaigns'),
'grouping' => 'campaign_type_id',
'table_name' => 'civicrm_campaign',
+ 'is_multiple' => FALSE,
],
[
'id' => 'Contact',
'label' => ts('Contacts'),
'grouping' => NULL,
'table_name' => 'civicrm_contact',
+ 'is_multiple' => TRUE,
],
];
// `CustomGroup.extends` stores contact type as if it were an entity.
- foreach (CRM_Contact_BAO_ContactType::basicTypePairs(TRUE) as $contactType => $contactTypeLabel) {
+ foreach (CRM_Contact_BAO_ContactType::basicTypeInfo(TRUE) as $contactType => $contactInfo) {
$options[] = [
'id' => $contactType,
- 'label' => $contactTypeLabel,
+ 'label' => $contactInfo['label'],
'grouping' => 'contact_sub_type',
'table_name' => 'civicrm_contact',
+ 'is_multiple' => TRUE,
+ 'icon' => $contactInfo['icon'],
];
}
$ogId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'cg_extend_objects', 'id', 'name');
@@ -2504,8 +2558,12 @@ public static function getCustomGroupExtendsOptions() {
'label' => $ogValue['label'],
'grouping' => $ogValue['grouping'] ?? NULL,
'table_name' => $ogValue['name'],
+ 'is_multiple' => !empty($ogValue['filter']),
];
}
+ foreach ($options as &$option) {
+ $option['icon'] = $option['icon'] ?? \Civi\Api4\Utils\CoreUtil::getInfoItem($option['id'], 'icon');
+ }
return $options;
}
diff --git a/CRM/Core/BAO/CustomValue.php b/CRM/Core/BAO/CustomValue.php
index f801e1296fb8..485b231cc4ba 100644
--- a/CRM/Core/BAO/CustomValue.php
+++ b/CRM/Core/BAO/CustomValue.php
@@ -211,18 +211,19 @@ public static function deleteCustomValue($customValueID, $customGroupID) {
}
/**
- * ACL clause for an APIv4 custom pseudo-entity (aka multi-record custom group extending Contact).
+ * ACL clause for an APIv4 custom pseudo-entity (aka multi-record custom group).
* @param string|null $entityName
* @param int|null $userId
* @param array $conditions
* @return array
*/
public function addSelectWhereClause(string $entityName = NULL, int $userId = NULL, array $conditions = []): array {
- // To-date, custom-value-based entities are only supported for contacts.
- // If this changes, $entityName variable contains the name of this custom group,
- // and could be used to lookup the type of entity this custom group joins to.
+ // Some legacy code omits $entityName, in which case fall-back on 'Contact' which until 2023
+ // was the only type of entity that could be extended by multi-record custom groups.
+ $groupName = \Civi\Api4\Utils\CoreUtil::getCustomGroupName((string) $entityName);
+ $joinEntity = $groupName ? CRM_Core_BAO_CustomGroup::getEntityForGroup($groupName) : 'Contact';
$clauses = [
- 'entity_id' => CRM_Utils_SQL::mergeSubquery('Contact'),
+ 'entity_id' => CRM_Utils_SQL::mergeSubquery($joinEntity),
];
CRM_Utils_Hook::selectWhereClause($entityName ?? $this, $clauses);
return $clauses;
@@ -232,7 +233,7 @@ public function addSelectWhereClause(string $entityName = NULL, int $userId = NU
* Special checkAccess function for multi-record custom pseudo-entities
*
* @param string $entityName
- * Ex: 'Contact' or 'Custom_Foobar'
+ * APIv4-style entity name e.g. 'Custom_Foobar'
* @param string $action
* @param array $record
* @param int $userID
@@ -243,8 +244,9 @@ public function addSelectWhereClause(string $entityName = NULL, int $userId = NU
public static function _checkAccess(string $entityName, string $action, array $record, int $userID): ?bool {
// This check implements two rules: you must have access to the specific custom-data-group - and to the underlying record (e.g. Contact).
- $groupName = substr($entityName, 0, 7) === 'Custom_' ? substr($entityName, 7) : NULL;
- $extends = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $groupName, 'extends', 'name');
+ // Expecting APIv4-style entity name
+ $groupName = \Civi\Api4\Utils\CoreUtil::getCustomGroupName($entityName);
+ $extends = \CRM_Core_BAO_CustomGroup::getEntityForGroup($groupName);
$id = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $groupName, 'id', 'name');
if (!$groupName) {
// $groupName is required but the function signature has to match the parent.
@@ -267,17 +269,8 @@ public static function _checkAccess(string $entityName, string $action, array $r
}
// Do we have access to the target record?
- if ($extends === 'Contact' || in_array($extends, CRM_Contact_BAO_ContactType::basicTypes(TRUE), TRUE)) {
- return \Civi\Api4\Utils\CoreUtil::checkAccessDelegated('Contact', 'update', ['id' => $eid], $userID);
- }
- elseif (\Civi\Api4\Utils\CoreUtil::getApiClass($extends)) {
- // For most entities (Activity, Relationship, Contribution, ad nauseum), we acn just use an eponymous API.
- return \Civi\Api4\Utils\CoreUtil::checkAccessDelegated($extends, 'update', ['id' => $eid], $userID);
- }
- else {
- // Do you need to add a special case for some oddball custom-group type?
- throw new CRM_Core_Exception("Cannot assess delegated permissions for group {$groupName}.");
- }
+ $delegatedAction = $action === 'get' ? 'get' : 'update';
+ return \Civi\Api4\Utils\CoreUtil::checkAccessDelegated($extends, $delegatedAction, ['id' => $eid], $userID);
}
}
diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php
index 548baffdc68a..6e4049562fae 100644
--- a/CRM/Core/BAO/Domain.php
+++ b/CRM/Core/BAO/Domain.php
@@ -164,9 +164,11 @@ public static function create($params) {
}
/**
+ * @deprecated
* @return bool
*/
public static function multipleDomains() {
+ CRM_Core_Error::deprecatedFunctionWarning('API');
$session = CRM_Core_Session::singleton();
$numberDomains = $session->get('numberDomains');
@@ -231,12 +233,12 @@ public static function getFromEmail(): string {
/**
* @param int $contactID
- *
- * @return bool|null|object|string
- *
+ * @return bool|int
+ * @deprecated
* @throws \CRM_Core_Exception
*/
public static function addContactToDomainGroup($contactID) {
+ CRM_Core_Error::deprecatedFunctionWarning('CRM_Contact_BAO_GroupContact::addContactsToGroup');
$groupID = self::getGroupId();
if ($groupID) {
diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php
index c48246775db4..97c94866d95d 100644
--- a/CRM/Core/BAO/EntityTag.php
+++ b/CRM/Core/BAO/EntityTag.php
@@ -301,7 +301,7 @@ public static function create(&$params, $entityTable, $entityID) {
public static function getContactTags($contactID, $count = FALSE) {
$contactTags = [];
if (!$count) {
- $select = "SELECT ct.id, ct.name ";
+ $select = "SELECT ct.id, ct.label ";
}
else {
$select = "SELECT count(*) as cnt";
@@ -322,7 +322,7 @@ public static function getContactTags($contactID, $count = FALSE) {
}
while ($dao->fetch()) {
- $contactTags[$dao->id] = $dao->name;
+ $contactTags[$dao->id] = $dao->label;
}
return $contactTags;
diff --git a/CRM/Core/BAO/MailSettings.php b/CRM/Core/BAO/MailSettings.php
index 1519394d031b..2d8b6b85ef6d 100644
--- a/CRM/Core/BAO/MailSettings.php
+++ b/CRM/Core/BAO/MailSettings.php
@@ -19,7 +19,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings {
/**
* Get a list of setup-actions.
*
- * @return array
+ * @return array{array{title:string, callback: mixed, url: string}}
* List of available actions. See description in the hook-docs.
* @see CRM_Utils_Hook::mailSetupActions()
*/
@@ -31,6 +31,13 @@ public static function getSetupActions() {
];
CRM_Utils_Hook::mailSetupActions($setupActions);
+
+ foreach ($setupActions as $key => &$setupAction) {
+ if (!isset($setupAction['url'])) {
+ $setupAction['url'] = (string) Civi::url('//civicrm/ajax/setupMailAccount')->addQuery(['type' => $key]);
+ }
+ }
+
return $setupActions;
}
@@ -129,8 +136,8 @@ public static function add(&$params) {
}
if (empty($params['id'])) {
- $params['is_ssl'] = CRM_Utils_Array::value('is_ssl', $params, FALSE);
- $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
+ $params['is_ssl'] = $params['is_ssl'] ?? FALSE;
+ $params['is_default'] = $params['is_default'] ?? FALSE;
}
//handle is_default.
diff --git a/CRM/Core/BAO/Managed.php b/CRM/Core/BAO/Managed.php
index 420435010538..38fc061a7ca7 100644
--- a/CRM/Core/BAO/Managed.php
+++ b/CRM/Core/BAO/Managed.php
@@ -50,11 +50,14 @@ public static function on_hook_civicrm_managed(\Civi\Core\Event\GenericHookEvent
* @param \Civi\Core\Event\PostEvent $event
*/
public static function on_hook_civicrm_post(\Civi\Core\Event\PostEvent $event) {
- // When an entity is deleted, delete the corresponding Managed record
+ // When an entity is deleted by the user, nullify 'entity_id' from corresponding Managed record
+ // This tells the ManagedEntity system that the entity was manually deleted,
+ // and should be recreated at the discretion of the `update` policy.
if ($event->action === 'delete' && $event->id && self::isApi4ManagedType($event->entity)) {
- \Civi\Api4\Managed::delete(FALSE)
+ \Civi\Api4\Managed::update(FALSE)
->addWhere('entity_type', '=', $event->entity)
->addWhere('entity_id', '=', $event->id)
+ ->addValue('entity_id', NULL)
->execute();
}
// When an entity is updated, update the timestamp in corresponding Managed record
diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php
index 5357b6f7d4a9..9a5bb862a260 100644
--- a/CRM/Core/BAO/Navigation.php
+++ b/CRM/Core/BAO/Navigation.php
@@ -74,10 +74,9 @@ public static function setIsActive($id, $is_active) {
* @return CRM_Core_DAO_Navigation
*/
public static function add(&$params) {
- $navigation = new CRM_Core_DAO_Navigation();
if (empty($params['id'])) {
- $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
- $params['has_separator'] = CRM_Utils_Array::value('has_separator', $params, FALSE);
+ $params['is_active'] = $params['is_active'] ?? FALSE;
+ $params['has_separator'] = $params['has_separator'] ?? FALSE;
$params['domain_id'] = CRM_Utils_Array::value('domain_id', $params, CRM_Core_Config::domainID());
}
@@ -98,14 +97,7 @@ public static function add(&$params) {
$params['weight'] = self::calculateWeight(CRM_Utils_Array::value('parent_id', $params));
}
- if (array_key_exists('permission', $params) && is_array($params['permission'])) {
- $params['permission'] = implode(',', $params['permission']);
- }
-
- $navigation->copyValues($params);
-
- $navigation->save();
- return $navigation;
+ return self::writeRecord($params);
}
/**
@@ -513,11 +505,11 @@ public static function processNavigation(&$params) {
break;
case "rename":
- self::processRename($nodeID, $label);
+ self::writeRecord(['id' => $nodeID, 'label' => $label]);
break;
case "delete":
- self::processDelete($nodeID);
+ self::deleteRecord(['id' => $nodeID]);
break;
}
@@ -578,8 +570,6 @@ public static function processMove($nodeID, $referenceID, $position) {
$incrementOtherNodes = FALSE;
}
- $transaction = new CRM_Core_Transaction();
-
// now update the existing nodes to weight + 1, if required.
if ($incrementOtherNodes) {
$query = "UPDATE civicrm_navigation SET weight = weight + 1
@@ -588,11 +578,8 @@ public static function processMove($nodeID, $referenceID, $position) {
CRM_Core_DAO::executeQuery($query);
}
- // finally set the weight of current node
- $query = "UPDATE civicrm_navigation SET weight = {$newWeight}, parent_id = {$newParentID} WHERE id = {$nodeID}";
- CRM_Core_DAO::executeQuery($query);
-
- $transaction->commit();
+ // finally set the weight and parent of current node
+ self::writeRecord(['id' => $nodeID, 'weight' => $newWeight, 'parent_id' => $newParentID]);
}
/**
@@ -600,19 +587,22 @@ public static function processMove($nodeID, $referenceID, $position) {
*
* @param int $nodeID
* @param $label
+ * @deprecated - use API
*/
public static function processRename($nodeID, $label) {
- CRM_Core_DAO::setFieldValue('CRM_Core_DAO_Navigation', $nodeID, 'label', $label);
+ CRM_Core_Error::deprecatedFunctionWarning('writeRecord');
+ self::writeRecord(['id' => $nodeID, 'label' => $label]);
}
/**
* Process delete action for tree.
*
* @param int $nodeID
+ * @deprecated - use API
*/
public static function processDelete($nodeID) {
- $query = "DELETE FROM civicrm_navigation WHERE id = {$nodeID}";
- CRM_Core_DAO::executeQuery($query);
+ CRM_Core_Error::deprecatedFunctionWarning('writeRecord');
+ self::deleteRecord(['id' => $nodeID]);
}
/**
diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php
index 46e7a9052c6f..f1e54f06f7ba 100644
--- a/CRM/Core/BAO/Note.php
+++ b/CRM/Core/BAO/Note.php
@@ -171,19 +171,19 @@ public static function add(&$params, $ids = []) {
$recentOther = [];
if ($noteActions) {
$recentOther = [
- 'editUrl' => CRM_Utils_System::url('civicrm/contact/view/note',
- "reset=1&action=update&cid={$note->entity_id}&id={$note->id}&context=home"
+ 'editUrl' => CRM_Utils_System::url('civicrm/note',
+ "reset=1&action=update&id={$note->id}&context=home"
),
- 'deleteUrl' => CRM_Utils_System::url('civicrm/contact/view/note',
- "reset=1&action=delete&cid={$note->entity_id}&id={$note->id}&context=home"
+ 'deleteUrl' => CRM_Utils_System::url('civicrm/note',
+ "reset=1&action=delete&id={$note->id}&context=home"
),
];
}
// add the recently created Note
CRM_Utils_Recent::add($displayName . ' - ' . $note->subject,
- CRM_Utils_System::url('civicrm/contact/view/note',
- "reset=1&action=view&cid={$note->entity_id}&id={$note->id}&context=home"
+ CRM_Utils_System::url('civicrm/note',
+ "reset=1&action=view&id={$note->id}&context=home"
),
$note->id,
'Note',
@@ -376,7 +376,7 @@ public static function getContactNoteCount($contactID) {
*
* @return array
* Nested associative array beginning with direct children of given note.
- *
+ * @deprecated only called by deprecated APIv3
*/
public static function getNoteTree($parentId, $maxDepth = 0, $snippet = FALSE) {
return self::buildNoteTree($parentId, $maxDepth, $snippet);
@@ -422,6 +422,7 @@ public static function getChildCount($id) {
*
* @return array
* Nested associative array beginning with direct children of given note.
+ * @deprecated only called by deprecated APIv3
*/
private static function buildNoteTree($parentId, $maxDepth = 0, $snippet = FALSE, &$tree = [], $depth = 0) {
if ($maxDepth && $depth > $maxDepth) {
diff --git a/CRM/Core/BAO/RecurringEntity.php b/CRM/Core/BAO/RecurringEntity.php
index 9a8aa744927a..cc1d7c1f8eca 100644
--- a/CRM/Core/BAO/RecurringEntity.php
+++ b/CRM/Core/BAO/RecurringEntity.php
@@ -39,24 +39,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity implemen
protected $recursion = NULL;
protected $recursion_start_date = NULL;
- public static $_entitiesToBeDeleted = [];
-
public static $status = NULL;
- public static $_recurringEntityHelper
- = [
- 'civicrm_event' => [
- 'helper_class' => 'CRM_Event_DAO_Event',
- 'delete_func' => 'delete',
- 'pre_delete_func' => 'CRM_Event_Form_ManageEvent_Repeat::checkRegistrationForEvents',
- ],
- 'civicrm_activity' => [
- 'helper_class' => 'CRM_Activity_DAO_Activity',
- 'delete_func' => 'delete',
- 'pre_delete_func' => '',
- ],
- ];
-
public static $_dateColumns
= [
'civicrm_event' => [
diff --git a/CRM/Core/BAO/Tag.php b/CRM/Core/BAO/Tag.php
index cd2a0522e05e..a86f4b1785ce 100644
--- a/CRM/Core/BAO/Tag.php
+++ b/CRM/Core/BAO/Tag.php
@@ -311,7 +311,7 @@ public static function getColorTags($usedFor = NULL, $allowSelectingNonSelectabl
'sort' => "name ASC",
],
'is_tagset' => 0,
- 'return' => ['name', 'description', 'parent_id', 'color', 'is_selectable', 'used_for'],
+ 'return' => ['label', 'description', 'parent_id', 'color', 'is_selectable', 'used_for'],
];
if ($usedFor) {
$params['used_for'] = ['LIKE' => "%$usedFor%"];
@@ -322,7 +322,7 @@ public static function getColorTags($usedFor = NULL, $allowSelectingNonSelectabl
$allTags = [];
foreach (CRM_Utils_Array::value('values', civicrm_api3('Tag', 'get', $params)) as $id => $tag) {
$allTags[$id] = [
- 'text' => $tag['name'],
+ 'text' => $tag['label'],
'id' => $id,
'description' => $tag['description'] ?? NULL,
'parent_id' => $tag['parent_id'] ?? NULL,
@@ -366,8 +366,16 @@ public static function del($id) {
*/
public static function add(&$params, $ids = []) {
$id = $params['id'] ?? $ids['tag'] ?? NULL;
- if (!$id && !self::dataExists($params)) {
- return NULL;
+ if (!$id) {
+ // Make label from name if missing.
+ if (CRM_Utils_System::isNull($params['label'] ?? NULL)) {
+ // If name is also missing, cannot create object.
+ if (CRM_Utils_System::isNull($params['name'] ?? NULL)) {
+ // FIXME: Throw exception
+ return NULL;
+ }
+ $params['label'] = $params['name'];
+ }
}
// Check permission to create or modify reserved tag
@@ -401,7 +409,6 @@ public static function add(&$params, $ids = []) {
// save creator id and time
if (!$id) {
$params['created_id'] = $params['created_id'] ?? CRM_Core_Session::getLoggedInContactID();
- $params['created_date'] = $params['created_date'] ?? date('YmdHis');
}
$tag = self::writeRecord($params);
@@ -422,23 +429,6 @@ public static function add(&$params, $ids = []) {
return $tag;
}
- /**
- * Check if there is data to create the object.
- *
- * @param array $params
- *
- * @return bool
- */
- public static function dataExists($params) {
- // Disallow empty values except for the number zero.
- // TODO: create a utility for this since it's needed in many places
- if (!empty($params['name']) || (string) $params['name'] === '0') {
- return TRUE;
- }
-
- return FALSE;
- }
-
/**
* Get the tag sets for a entity object.
*
@@ -450,7 +440,7 @@ public static function dataExists($params) {
*/
public static function getTagSet($entityTable) {
$tagSets = [];
- $query = "SELECT name, id FROM civicrm_tag
+ $query = "SELECT label, id FROM civicrm_tag
WHERE is_tagset=1 AND parent_id IS NULL and used_for LIKE %1";
$dao = CRM_Core_DAO::executeQuery($query, [
1 => [
@@ -459,7 +449,7 @@ public static function getTagSet($entityTable) {
],
], TRUE, NULL, FALSE, FALSE);
while ($dao->fetch()) {
- $tagSets[$dao->id] = $dao->name;
+ $tagSets[$dao->id] = $dao->label;
}
return $tagSets;
}
diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php
index 88ef83cfe107..0212831e838d 100644
--- a/CRM/Core/BAO/UFField.php
+++ b/CRM/Core/BAO/UFField.php
@@ -248,7 +248,7 @@ public static function autoWeight($params) {
$oldWeight = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFField', !empty($params['id']) ? $params['id'] : $params['field_id'], 'weight', 'id');
}
$fieldValues = ['uf_group_id' => !empty($params['uf_group_id']) ? $params['uf_group_id'] : $params['group_id']];
- return CRM_Utils_Weight::updateOtherWeights('CRM_Core_DAO_UFField', $oldWeight, CRM_Utils_Array::value('weight', $params, 0), $fieldValues);
+ return CRM_Utils_Weight::updateOtherWeights('CRM_Core_DAO_UFField', $oldWeight, $params['weight'] ?? 0, $fieldValues);
}
/**
diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php
index 645dfcb6d3cd..fae355c2e705 100644
--- a/CRM/Core/BAO/UFGroup.php
+++ b/CRM/Core/BAO/UFGroup.php
@@ -1808,7 +1808,7 @@ public static function buildProfile(
$view = $field['is_view'];
$required = ($mode == CRM_Profile_Form::MODE_SEARCH) ? FALSE : $field['is_required'];
$search = $mode == CRM_Profile_Form::MODE_SEARCH;
- $isShared = CRM_Utils_Array::value('is_shared', $field, 0);
+ $isShared = $field['is_shared'] ?? 0;
// do not display view fields in drupal registration form
// CRM-4632
@@ -1958,7 +1958,7 @@ public static function buildProfile(
], $required);
}
elseif ($fieldName === 'contact_sub_type') {
- $gId = $form->get('gid') ? $form->get('gid') : CRM_Utils_Array::value('group_id', $field);
+ $gId = $form->get('gid') ?: $field['group_id'] ?? NULL;
if ($usedFor == 'onbehalf') {
$profileType = 'Organization';
}
@@ -1992,7 +1992,7 @@ public static function buildProfile(
}
elseif (in_array($fieldName, CRM_Contact_BAO_Contact::$_greetingTypes)) {
// Get contact type for greeting selector
- $gId = $form->get('gid') ?: CRM_Utils_Array::value('group_id', $field);
+ $gId = $form->get('gid') ?: $field['group_id'] ?? NULL;
$profileType = CRM_Core_BAO_UFField::getProfileType($gId, TRUE, FALSE, TRUE);
if (!$profileType || in_array($profileType, ['Contact', 'Contribution', 'Participant', 'Membership'])) {
diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php
index 5a2406b5c173..6290430fd0d7 100644
--- a/CRM/Core/BAO/UFMatch.php
+++ b/CRM/Core/BAO/UFMatch.php
@@ -539,8 +539,7 @@ public static function getAllowedToLogin($openId) {
}
/**
- * Get the next unused uf_id value, since the standalone UF doesn't
- * have id's (it uses OpenIDs, which go in a different field).
+ * Get the next unused uf_id value
*
* @deprecated
* @return int
diff --git a/CRM/Core/CodeGen/Util/MessageTemplates.php b/CRM/Core/CodeGen/Util/MessageTemplates.php
new file mode 100644
index 000000000000..2df31656427e
--- /dev/null
+++ b/CRM/Core/CodeGen/Util/MessageTemplates.php
@@ -0,0 +1,82 @@
+ ts('Message Template Workflow for Cases', ['escape' => 'sql']),
+ 'contribution' => ts('Message Template Workflow for Contributions', ['escape' => 'sql']),
+ 'event' => ts('Message Template Workflow for Events', ['escape' => 'sql']),
+ 'friend' => ts('Message Template Workflow for Tell-a-Friend', ['escape' => 'sql']),
+ 'membership' => ts('Message Template Workflow for Memberships', ['escape' => 'sql']),
+ 'meta' => ts('Message Template Workflow for Meta Templates', ['escape' => 'sql']),
+ 'pledge' => ts('Message Template Workflow for Pledges', ['escape' => 'sql']),
+ 'uf' => ts('Message Template Workflow for Profiles', ['escape' => 'sql']),
+ 'petition' => ts('Message Template Workflow for Petition', ['escape' => 'sql']),
+ ];
+ $ovNames = [
+ 'case' => [
+ 'case_activity' => ts('Cases - Send Copy of an Activity', ['escape' => 'sql']),
+ ],
+ 'contribution' => [
+ 'contribution_dupalert' => ts('Contributions - Duplicate Organization Alert', ['escape' => 'sql']),
+ 'contribution_offline_receipt' => ts('Contributions - Receipt (off-line)', ['escape' => 'sql']),
+ 'contribution_online_receipt' => ts('Contributions - Receipt (on-line)', ['escape' => 'sql']),
+ 'contribution_invoice_receipt' => ts('Contributions - Invoice', ['escape' => 'sql']),
+ 'contribution_recurring_notify' => ts('Contributions - Recurring Start and End Notification', ['escape' => 'sql']),
+ 'contribution_recurring_cancelled' => ts('Contributions - Recurring Cancellation Notification', ['escape' => 'sql']),
+ 'contribution_recurring_billing' => ts('Contributions - Recurring Billing Updates', ['escape' => 'sql']),
+ 'contribution_recurring_edit' => ts('Contributions - Recurring Updates', ['escape' => 'sql']),
+ 'pcp_notify' => ts('Personal Campaign Pages - Admin Notification', ['escape' => 'sql']),
+ 'pcp_status_change' => ts('Personal Campaign Pages - Supporter Status Change Notification', ['escape' => 'sql']),
+ 'pcp_supporter_notify' => ts('Personal Campaign Pages - Supporter Welcome', ['escape' => 'sql']),
+ 'pcp_owner_notify' => ts('Personal Campaign Pages - Owner Notification', ['escape' => 'sql']),
+ 'payment_or_refund_notification' => ts('Additional Payment Receipt or Refund Notification', ['escape' => 'sql']),
+ ],
+ 'event' => [
+ 'event_offline_receipt' => ts('Events - Registration Confirmation and Receipt (off-line)', ['escape' => 'sql']),
+ 'event_online_receipt' => ts('Events - Registration Confirmation and Receipt (on-line)', ['escape' => 'sql']),
+ 'event_registration_receipt' => ts('Events - Receipt only', ['escape' => 'sql']),
+ 'participant_cancelled' => ts('Events - Registration Cancellation Notice', ['escape' => 'sql']),
+ 'participant_confirm' => ts('Events - Registration Confirmation Invite', ['escape' => 'sql']),
+ 'participant_expired' => ts('Events - Pending Registration Expiration Notice', ['escape' => 'sql']),
+ 'participant_transferred' => ts('Events - Registration Transferred Notice', ['escape' => 'sql']),
+ ],
+ 'friend' => [
+ 'friend' => ts('Tell-a-Friend Email', ['escape' => 'sql']),
+ ],
+ 'membership' => [
+ 'membership_offline_receipt' => ts('Memberships - Signup and Renewal Receipts (off-line)', ['escape' => 'sql']),
+ 'membership_online_receipt' => ts('Memberships - Receipt (on-line)', ['escape' => 'sql']),
+ 'membership_autorenew_cancelled' => ts('Memberships - Auto-renew Cancellation Notification', ['escape' => 'sql']),
+ 'membership_autorenew_billing' => ts('Memberships - Auto-renew Billing Updates', ['escape' => 'sql']),
+ ],
+ 'meta' => [
+ 'test_preview' => ts('Test-drive - Receipt Header', ['escape' => 'sql']),
+ ],
+ 'pledge' => [
+ 'pledge_acknowledge' => ts('Pledges - Acknowledgement', ['escape' => 'sql']),
+ 'pledge_reminder' => ts('Pledges - Payment Reminder', ['escape' => 'sql']),
+ ],
+ 'uf' => [
+ 'uf_notify' => ts('Profiles - Admin Notification', ['escape' => 'sql']),
+ ],
+ 'petition' => [
+ 'petition_sign' => ts('Petition - signature added', ['escape' => 'sql']),
+ 'petition_confirmation_needed' => ts('Petition - need verification', ['escape' => 'sql']),
+ ],
+ ];
+ $smarty->assign('ogNames', $ogNames);
+ $smarty->assign('ovNames', $ovNames);
+ $dir = $smarty->get_template_vars()['gencodeXmlDir'] . '/templates/message_templates/sample';
+ $templates = [];
+ foreach (preg_grep('/\.tpl$/', scandir($dir)) as $filename) {
+ $templates[] = ['name' => basename($filename, '.tpl'), 'filename' => "$dir/$filename"];
+ }
+ $smarty->assign('templates', $templates);
+ }
+
+}
diff --git a/CRM/Core/CodeGen/Util/Smarty.php b/CRM/Core/CodeGen/Util/Smarty.php
index d45989504d55..a1eb1f29c963 100644
--- a/CRM/Core/CodeGen/Util/Smarty.php
+++ b/CRM/Core/CodeGen/Util/Smarty.php
@@ -59,9 +59,9 @@ public function createSmarty() {
require_once 'CRM/Core/Smarty/plugins/block.localize.php';
$smarty->register_block('localize', 'smarty_block_localize');
-
$smarty->assign('gencodeXmlDir', dirname(dirname(dirname(dirname(__DIR__)))) . '/xml');
-
+ require_once 'CRM/Core/CodeGen/Util/MessageTemplates.php';
+ CRM_Core_CodeGen_Util_MessageTemplates::assignSmartyVariables($smarty);
return $smarty;
}
diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php
index bd7147725b03..554d89b11f7e 100644
--- a/CRM/Core/DAO.php
+++ b/CRM/Core/DAO.php
@@ -780,6 +780,10 @@ public function copyValues($params) {
}
}
elseif (is_array($value) && !empty($field['serialize'])) {
+ if (!empty($field['pseudoconstant'])) {
+ // Pseudoconstant implies 1-1 option matching; duplicates would not make sense
+ $value = array_unique($value);
+ }
$this->$dbName = CRM_Core_DAO::serializeField($value, $field['serialize']);
$allNull = FALSE;
}
@@ -3142,7 +3146,16 @@ protected static function getDynamicFkAclClauses(string $entityTableField, strin
// Prevent infinite recursion
$subquery = $table === static::getTableName() ? NULL : CRM_Utils_SQL::mergeSubquery($ent);
if ($subquery) {
- $relatedClauses[] = "= '$table' AND {{$entityIdField}} " . implode(" AND {{$entityIdField}} ", $subquery);
+ foreach ($subquery as $index => $condition) {
+ // Join OR clauses
+ if (is_array($condition)) {
+ $subquery[$index] = "(({{$entityIdField}} " . implode(") OR ({{$entityIdField}} ", $condition) . '))';
+ }
+ else {
+ $subquery[$index] = "{{$entityIdField}} $condition";
+ }
+ }
+ $relatedClauses[] = "= '$table' AND " . implode(" AND ", $subquery);
}
// If it's the only value with no conditions, don't need to add it
elseif (!$entityTableValues || count($relatedEntities) > 1) {
diff --git a/CRM/Core/DAO/ActionSchedule.php b/CRM/Core/DAO/ActionSchedule.php
index f75590e0648b..1f00ac68b866 100644
--- a/CRM/Core/DAO/ActionSchedule.php
+++ b/CRM/Core/DAO/ActionSchedule.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Core/ActionSchedule.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:7cd61559377e23d6ad4c833616f22a12)
+ * (GenCodeChecksum:e6121895aa480e9b4fdbf171b01b91dc)
*/
/**
@@ -57,10 +57,10 @@ class CRM_Core_DAO_ActionSchedule extends CRM_Core_DAO {
public $id;
/**
- * Name of the action(reminder)
+ * Name of the scheduled action
*
* @var string
- * (SQL type: varchar(64))
+ * (SQL type: varchar(128))
* Note that values will be retrieved from the database as a string.
*/
public $name;
@@ -491,10 +491,10 @@ public static function &fields() {
'name' => 'name',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Name'),
- 'description' => ts('Name of the action(reminder)'),
+ 'description' => ts('Name of the scheduled action'),
'required' => TRUE,
- 'maxlength' => 64,
- 'size' => CRM_Utils_Type::BIG,
+ 'maxlength' => 128,
+ 'size' => CRM_Utils_Type::HUGE,
'usage' => [
'import' => FALSE,
'export' => FALSE,
diff --git a/CRM/Core/DAO/AllCoreTables.php b/CRM/Core/DAO/AllCoreTables.php
index 4c22ee769bc1..ba28171ba925 100644
--- a/CRM/Core/DAO/AllCoreTables.php
+++ b/CRM/Core/DAO/AllCoreTables.php
@@ -358,7 +358,7 @@ public static function getTableForClass($className) {
*
* @param string $briefName
*
- * @return FALSE|string
+ * @return string
*/
public static function getTableForEntityName($briefName): string {
self::init();
diff --git a/CRM/Core/DAO/CustomGroup.php b/CRM/Core/DAO/CustomGroup.php
index 17c0bd892208..f1efcc5ca554 100644
--- a/CRM/Core/DAO/CustomGroup.php
+++ b/CRM/Core/DAO/CustomGroup.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Core/CustomGroup.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:7a53822fedde32eeb1089f09654a2d88)
+ * (GenCodeChecksum:05aa9cfdd47acd56178a0a33a2f6ffc1)
*/
/**
@@ -87,7 +87,7 @@ class CRM_Core_DAO_CustomGroup extends CRM_Core_DAO {
public $extends;
/**
- * FK to civicrm_option_value.id (for option group custom_data_type.)
+ * FK to civicrm_option_value.value (for option group custom_data_type)
*
* @var int|string|null
* (SQL type: int unsigned)
@@ -384,6 +384,7 @@ public static function &fields() {
'name',
'label',
'grouping',
+ 'icon',
],
],
'add' => '1.1',
@@ -392,7 +393,7 @@ public static function &fields() {
'name' => 'extends_entity_column_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Custom Group Subtype List'),
- 'description' => ts('FK to civicrm_option_value.id (for option group custom_data_type.)'),
+ 'description' => ts('FK to civicrm_option_value.value (for option group custom_data_type)'),
'usage' => [
'import' => FALSE,
'export' => FALSE,
diff --git a/CRM/Core/DAO/EntityTag.php b/CRM/Core/DAO/EntityTag.php
index 3f57d572bdec..df3e79bd2ae8 100644
--- a/CRM/Core/DAO/EntityTag.php
+++ b/CRM/Core/DAO/EntityTag.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Core/EntityTag.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:2fccc138a26fe391325fd641c891cd91)
+ * (GenCodeChecksum:5bca5ff1c4ba7d85034410408464f0ac)
*/
/**
@@ -200,7 +200,8 @@ public static function &fields() {
'pseudoconstant' => [
'table' => 'civicrm_tag',
'keyColumn' => 'id',
- 'labelColumn' => 'name',
+ 'labelColumn' => 'label',
+ 'nameColumn' => 'name',
'condition' => 'is_tagset != 1',
],
'add' => '1.1',
diff --git a/CRM/Core/DAO/Managed.php b/CRM/Core/DAO/Managed.php
index a82a5cae3619..d23d84643e13 100644
--- a/CRM/Core/DAO/Managed.php
+++ b/CRM/Core/DAO/Managed.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Core/Managed.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:1f1273f734c559351767e25b05b3925e)
+ * (GenCodeChecksum:4ff1b19106d4bc7810d4aa9eb2a73f65)
*/
/**
@@ -40,10 +40,10 @@ class CRM_Core_DAO_Managed extends CRM_Core_DAO {
public $id;
/**
- * Name of the module which declared this object
+ * Name of the module which declared this object (soft FK to civicrm_extension.full_name)
*
* @var string
- * (SQL type: varchar(127))
+ * (SQL type: varchar(255))
* Note that values will be retrieved from the database as a string.
*/
public $module;
@@ -51,8 +51,8 @@ class CRM_Core_DAO_Managed extends CRM_Core_DAO {
/**
* Symbolic name used by the module to identify the object
*
- * @var string|null
- * (SQL type: varchar(127))
+ * @var string
+ * (SQL type: varchar(255))
* Note that values will be retrieved from the database as a string.
*/
public $name;
@@ -67,9 +67,9 @@ class CRM_Core_DAO_Managed extends CRM_Core_DAO {
public $entity_type;
/**
- * Foreign key to the referenced item.
+ * Soft foreign key to the referenced item.
*
- * @var int|string
+ * @var int|string|null
* (SQL type: int unsigned)
* Note that values will be retrieved from the database as a string.
*/
@@ -78,8 +78,8 @@ class CRM_Core_DAO_Managed extends CRM_Core_DAO {
/**
* Policy on when to cleanup entity (always, never, unused)
*
- * @var string|null
- * (SQL type: varchar(32))
+ * @var string
+ * (SQL type: varchar(16))
* Note that values will be retrieved from the database as a string.
*/
public $cleanup;
@@ -146,9 +146,9 @@ public static function &fields() {
'name' => 'module',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Module'),
- 'description' => ts('Name of the module which declared this object'),
+ 'description' => ts('Name of the module which declared this object (soft FK to civicrm_extension.full_name)'),
'required' => TRUE,
- 'maxlength' => 127,
+ 'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'usage' => [
'import' => FALSE,
@@ -161,6 +161,9 @@ public static function &fields() {
'entity' => 'Managed',
'bao' => 'CRM_Core_BAO_Managed',
'localizable' => 0,
+ 'pseudoconstant' => [
+ 'callback' => 'CRM_Core_BAO_Managed::getBaseModules',
+ ],
'add' => '4.2',
],
'name' => [
@@ -168,7 +171,8 @@ public static function &fields() {
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Name'),
'description' => ts('Symbolic name used by the module to identify the object'),
- 'maxlength' => 127,
+ 'required' => TRUE,
+ 'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'usage' => [
'import' => FALSE,
@@ -208,8 +212,7 @@ public static function &fields() {
'name' => 'entity_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Entity ID'),
- 'description' => ts('Foreign key to the referenced item.'),
- 'required' => TRUE,
+ 'description' => ts('Soft foreign key to the referenced item.'),
'usage' => [
'import' => FALSE,
'export' => FALSE,
@@ -228,8 +231,9 @@ public static function &fields() {
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Cleanup Setting'),
'description' => ts('Policy on when to cleanup entity (always, never, unused)'),
- 'maxlength' => 32,
- 'size' => CRM_Utils_Type::MEDIUM,
+ 'required' => TRUE,
+ 'maxlength' => 16,
+ 'size' => CRM_Utils_Type::TWELVE,
'usage' => [
'import' => FALSE,
'export' => FALSE,
@@ -237,6 +241,7 @@ public static function &fields() {
'token' => FALSE,
],
'where' => 'civicrm_managed.cleanup',
+ 'default' => 'always',
'table_name' => 'civicrm_managed',
'entity' => 'Managed',
'bao' => 'CRM_Core_BAO_Managed',
diff --git a/CRM/Core/DAO/MessageTemplate.php b/CRM/Core/DAO/MessageTemplate.php
index b39d92c08373..fd7f5cafd221 100644
--- a/CRM/Core/DAO/MessageTemplate.php
+++ b/CRM/Core/DAO/MessageTemplate.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Core/MessageTemplate.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:65e3ae090a60b085f252019d3d113ceb)
+ * (GenCodeChecksum:6dc7072586d725f18dd3c984091820f0)
*/
/**
@@ -23,6 +23,13 @@ class CRM_Core_DAO_MessageTemplate extends CRM_Core_DAO {
*/
public static $_tableName = 'civicrm_msg_template';
+ /**
+ * Field to show when displaying a record.
+ *
+ * @var string
+ */
+ public static $_labelField = 'msg_title';
+
/**
* Should CiviCRM log any modifications to this table in the civicrm_log table.
*
diff --git a/CRM/Core/DAO/Note.php b/CRM/Core/DAO/Note.php
index dff8197327fd..5fa11086cafb 100644
--- a/CRM/Core/DAO/Note.php
+++ b/CRM/Core/DAO/Note.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Core/Note.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:c04c2c1404af638e1adf973fe845d0ac)
+ * (GenCodeChecksum:9036c8c92bb1abbbd67b08f5c06f7ea3)
*/
/**
@@ -37,6 +37,18 @@ class CRM_Core_DAO_Note extends CRM_Core_DAO {
*/
public static $_log = TRUE;
+ /**
+ * Paths for accessing this entity in the UI.
+ *
+ * @var string[]
+ */
+ protected static $_paths = [
+ 'add' => 'civicrm/note?reset=1&action=add&entity_table=[entity_table]&entity_id=[entity_id]',
+ 'view' => 'civicrm/note?reset=1&action=view&id=[id]',
+ 'update' => 'civicrm/note?reset=1&action=update&id=[id]',
+ 'delete' => 'civicrm/note?reset=1&action=delete&id=[id]',
+ ];
+
/**
* Note ID
*
diff --git a/CRM/Core/DAO/Tag.php b/CRM/Core/DAO/Tag.php
index b84fa0d5e4e1..b6c5a2f1a4d4 100644
--- a/CRM/Core/DAO/Tag.php
+++ b/CRM/Core/DAO/Tag.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Core/Tag.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:f8d8698f48fbd60b8d8e0bf8eff40c47)
+ * (GenCodeChecksum:ded9d6a9f9c08146a0205da83c838c91)
*/
/**
@@ -35,7 +35,7 @@ class CRM_Core_DAO_Tag extends CRM_Core_DAO {
*
* @var string
*/
- public static $_labelField = 'name';
+ public static $_labelField = 'label';
/**
* Should CiviCRM log any modifications to this table in the civicrm_log table.
@@ -54,7 +54,7 @@ class CRM_Core_DAO_Tag extends CRM_Core_DAO {
public $id;
/**
- * Name of Tag.
+ * Unique machine name
*
* @var string
* (SQL type: varchar(64))
@@ -62,6 +62,15 @@ class CRM_Core_DAO_Tag extends CRM_Core_DAO {
*/
public $name;
+ /**
+ * User-facing tag name
+ *
+ * @var string
+ * (SQL type: varchar(64))
+ * Note that values will be retrieved from the database as a string.
+ */
+ public $label;
+
/**
* Optional verbose description of the tag.
*
@@ -206,7 +215,7 @@ public static function &fields() {
'name' => 'name',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Tag Name'),
- 'description' => ts('Name of Tag.'),
+ 'description' => ts('Unique machine name'),
'required' => TRUE,
'maxlength' => 64,
'size' => CRM_Utils_Type::BIG,
@@ -223,6 +232,30 @@ public static function &fields() {
'localizable' => 0,
'add' => '1.1',
],
+ 'label' => [
+ 'name' => 'label',
+ 'type' => CRM_Utils_Type::T_STRING,
+ 'title' => ts('Tag Label'),
+ 'description' => ts('User-facing tag name'),
+ 'required' => TRUE,
+ 'maxlength' => 64,
+ 'size' => CRM_Utils_Type::BIG,
+ 'usage' => [
+ 'import' => FALSE,
+ 'export' => FALSE,
+ 'duplicate_matching' => FALSE,
+ 'token' => FALSE,
+ ],
+ 'where' => 'civicrm_tag.label',
+ 'table_name' => 'civicrm_tag',
+ 'entity' => 'Tag',
+ 'bao' => 'CRM_Core_BAO_Tag',
+ 'localizable' => 0,
+ 'html' => [
+ 'type' => 'Text',
+ ],
+ 'add' => '5.68',
+ ],
'description' => [
'name' => 'description',
'type' => CRM_Utils_Type::T_STRING,
@@ -267,7 +300,8 @@ public static function &fields() {
'pseudoconstant' => [
'table' => 'civicrm_tag',
'keyColumn' => 'id',
- 'labelColumn' => 'name',
+ 'labelColumn' => 'label',
+ 'nameColumn' => 'name',
],
'add' => '1.1',
],
@@ -375,6 +409,7 @@ public static function &fields() {
'localizable' => 0,
'FKClassName' => 'CRM_Contact_DAO_Contact',
'html' => [
+ 'type' => 'EntityRef',
'label' => ts("Created By"),
],
'add' => '3.4',
@@ -412,10 +447,17 @@ public static function &fields() {
'token' => FALSE,
],
'where' => 'civicrm_tag.created_date',
+ 'default' => 'CURRENT_TIMESTAMP',
'table_name' => 'civicrm_tag',
'entity' => 'Tag',
'bao' => 'CRM_Core_BAO_Tag',
'localizable' => 0,
+ 'html' => [
+ 'type' => 'Select Date',
+ 'formatType' => 'activityDateTime',
+ 'label' => ts("Created Date"),
+ ],
+ 'readonly' => TRUE,
'add' => '3.4',
],
];
diff --git a/CRM/Core/DAO/UFMatch.php b/CRM/Core/DAO/UFMatch.php
index 38744177fa9a..aaa71a8278f2 100644
--- a/CRM/Core/DAO/UFMatch.php
+++ b/CRM/Core/DAO/UFMatch.php
@@ -6,7 +6,7 @@
*
* Generated from xml/schema/CRM/Core/UFMatch.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:03d955dcec4176dec67ec9fbc818e490)
+ * (GenCodeChecksum:ddf0ceeb22715a1ee0b7b93c90df31f2)
*/
/**
@@ -214,7 +214,7 @@ public static function &fields() {
'entity' => 'UFMatch',
'bao' => 'CRM_Core_BAO_UFMatch',
'localizable' => 0,
- 'add' => '1.9.kabissa',
+ 'add' => '1.9',
],
'contact_id' => [
'name' => 'contact_id',
diff --git a/CRM/Core/EntityTokens.php b/CRM/Core/EntityTokens.php
index 070b903b0183..ce76c40e2350 100644
--- a/CRM/Core/EntityTokens.php
+++ b/CRM/Core/EntityTokens.php
@@ -99,7 +99,7 @@ public function evaluateToken(TokenRow $row, $entity, $field, $prefetch = NULL)
$fieldValue = $this->getFieldValue($row, $field);
if (is_array($fieldValue)) {
// eg. role_id for participant would be an array here.
- $fieldValue = implode(',', $fieldValue);
+ $fieldValue = implode(', ', $fieldValue);
}
if ($this->isPseudoField($field)) {
@@ -701,4 +701,35 @@ protected function getCacheKey(): string {
return $cacheKey;
}
+ /**
+ * Get metadata for tokens for a related entity joined by a field on the main entity.
+ *
+ * @param string $entity
+ * @param string $joinField
+ * @param array $tokenList
+ * @param array $hiddenTokens
+ *
+ * @return array
+ * @throws \CRM_Core_Exception
+ */
+ protected function getRelatedTokensForEntity(string $entity, string $joinField, array $tokenList, $hiddenTokens = []): array {
+ $apiParams = ['checkPermissions' => FALSE];
+ if ($tokenList !== ['*']) {
+ $apiParams['where'] = [['name', 'IN', $tokenList]];
+ }
+ $relatedTokens = civicrm_api4($entity, 'getFields', $apiParams);
+ $tokens = [];
+ foreach ($relatedTokens as $relatedToken) {
+ $tokens[$joinField . '.' . $relatedToken['name']] = [
+ 'title' => $relatedToken['title'],
+ 'name' => $joinField . '.' . $relatedToken['name'],
+ 'type' => 'mapped',
+ 'data_type' => $relatedToken['data_type'],
+ 'input_type' => $relatedToken['input_type'],
+ 'audience' => in_array($relatedToken['name'], $hiddenTokens, TRUE) ? 'hidden' : 'user',
+ ];
+ }
+ return $tokens;
+ }
+
}
diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php
index fd6ae04c1475..bdc6e6d03e8d 100644
--- a/CRM/Core/Error.php
+++ b/CRM/Core/Error.php
@@ -655,7 +655,9 @@ public static function debug_query_result($query) {
*/
public static function createDebugLogger($prefix = '') {
self::generateLogFileName($prefix);
- return Log::singleton('file', \Civi::$statics[__CLASS__]['logger_file' . $prefix], '');
+ return Log::singleton('file', \Civi::$statics[__CLASS__]['logger_file' . $prefix], '', [
+ 'timeFormat' => '%Y-%m-%d %H:%M:%S%z',
+ ]);
}
/**
diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php
index d0f17d883d0e..2172fff642a1 100644
--- a/CRM/Core/Form.php
+++ b/CRM/Core/Form.php
@@ -202,6 +202,10 @@ public function getContext() {
* to combine fields from the various screens & save the resulting 'submitted_values'
* to the UserJob.
*
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
* @return array
*/
public function getSubmittedValues(): array {
@@ -219,6 +223,10 @@ public function getSubmittedValues(): array {
* Contribution_Main and Contribution_Confirm) accessible you can override
* this function as CRM_Import_Forms does.
*
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
+ *
* @return string[]
*/
protected function getSubmittableFields(): array {
@@ -478,13 +486,9 @@ public function &add(
// Like select but accepts rich array data (with nesting, colors, icons, etc) as option list.
if ($inputType === 'select2') {
$type = 'text';
- $options = [];
- foreach ($attributes as $option) {
- // Transform options from api4.getFields format
- $option['text'] = $option['text'] ?? $option['label'];
- unset($option['label']);
- $options[] = $option;
- }
+ // Options stored in $attributes. Transform from api4.getFields format if needed.
+ $options = CRM_Utils_Array::formatForSelect2($attributes ?: []);
+ // Attributes stored in $extra
$attributes = ($extra ?: []) + ['class' => ''];
$attributes['class'] = ltrim($attributes['class'] . ' crm-select2 crm-form-select2');
$attributes['data-select-params'] = json_encode(['data' => $options, 'multiple' => !empty($attributes['multiple'])]);
@@ -785,7 +789,7 @@ public function addButtons($params) {
$this->submitOnce = TRUE;
}
- $attrs = ['class' => 'crm-form-submit'] + (array) CRM_Utils_Array::value('js', $button);
+ $attrs = ['class' => 'crm-form-submit'] + ($button['js'] ?? []);
// A lot of forms use the hacky method of looking at
// `$params['button name']` (dating back to them being inputs with a
@@ -1840,7 +1844,7 @@ public function addField($name, $props = [], $required = FALSE, $legacyDate = TR
}
if ($context == 'search') {
$widget = $widget == 'Select2' ? $widget : 'Select';
- $props['multiple'] = CRM_Utils_Array::value('multiple', $props, TRUE);
+ $props['multiple'] = $props['multiple'] ?? TRUE;
}
elseif (!empty($fieldSpec['serialize'])) {
$props['multiple'] = TRUE;
@@ -3004,6 +3008,8 @@ public function setSelectedChild($default = NULL) {
* they have permission to (setContactID does do that) and can be used to check if the user is
* accessing their own record.
*
+ * @deprecated use getAuthenticatedContactID()
+ *
* @return int|false
* @throws \CRM_Core_Exception
*/
@@ -3020,14 +3026,20 @@ protected function getContactIDIfAccessingOwnRecord() {
}
/**
- * Get values submitted by the user.
+ * Get value submitted by the user.
*
* These values have been validated against the fields added to the form.
* https://pear.php.net/manual/en/package.html.html-quickform.html-quickform.exportvalues.php
*
+ * Any money processing has also been done.
+ *
* @param string $fieldName
*
* @return mixed|null
+ *
+ * @api This function will not change in a minor release and is supported for
+ * use outside of core. This annotation / external support for properties
+ * is only given where there is specific test cover.
*/
public function getSubmittedValue(string $fieldName) {
if (empty($this->exportedValues)) {
@@ -3037,6 +3049,15 @@ public function getSubmittedValue(string $fieldName) {
if (in_array($fieldName, $this->submittableMoneyFields, TRUE)) {
return CRM_Utils_Rule::cleanMoney($value);
}
+ else {
+ // Numeric fields are not in submittableMoneyFields (for now)
+ $fieldRules = $this->_rules[$fieldName] ?? [];
+ foreach ($fieldRules as $rule) {
+ if ('money' === $rule['type']) {
+ return CRM_Utils_Rule::cleanMoney($value);
+ }
+ }
+ }
return $value;
}
diff --git a/CRM/Core/Form/EntityFormTrait.php b/CRM/Core/Form/EntityFormTrait.php
index f6173a4e640e..3941da88d68c 100644
--- a/CRM/Core/Form/EntityFormTrait.php
+++ b/CRM/Core/Form/EntityFormTrait.php
@@ -176,11 +176,9 @@ public function buildQuickEntityForm() {
$this->entityFields[$index] = array_replace_recursive([
'template' => '',
'help' => ['id' => '', 'file' => ''],
- 'pre_html_text' => '',
'post_html_text' => '',
'description' => '',
'documentation_link' => ['page' => '', 'resource' => ''],
- 'place_holder' => '',
], $fields);
}
$this->assign('entityFields', $this->entityFields);
diff --git a/CRM/Core/Form/RecurringEntity.php b/CRM/Core/Form/RecurringEntity.php
index 6390726a755f..ce86c7a42ab2 100644
--- a/CRM/Core/Form/RecurringEntity.php
+++ b/CRM/Core/Form/RecurringEntity.php
@@ -20,6 +20,12 @@
* This class generates form components for processing Entity.
*/
class CRM_Core_Form_RecurringEntity {
+
+ private static $preDeleteFunction = [
+ 'Event' => 'CRM_Event_Form_ManageEvent_Repeat::checkRegistrationForEvents',
+ 'Activity' => NULL,
+ ];
+
/**
* Current entity id
* @var int
@@ -317,6 +323,7 @@ public static function formRule($values) {
*
* @param array $params
* @param string $type
+ * Redundant - always the same as `$params['entity_table']`
* @param array $linkedEntities
*
* @throws \CRM_Core_Exception
@@ -393,59 +400,22 @@ public static function postProcess($params, $type, $linkedEntities = []) {
}
}
- // FIXME: This is the worst way possible to convert a table name to an api entity name
- $apiEntityType = explode("_", $type);
- if (!empty($apiEntityType[1])) {
- $apiType = $apiEntityType[1];
- }
- //Delete relations if any from recurring entity tables before inserting new relations for this entity id
+ // Delete relations if any from recurring entity tables before inserting new relations for this entity id
if ($params['entity_id']) {
- //If entity has any pre delete function, consider that first
- if (!empty(CRM_Core_BAO_RecurringEntity::$_recurringEntityHelper[$params['entity_table']]['pre_delete_func']) &&
- !empty(CRM_Core_BAO_RecurringEntity::$_recurringEntityHelper[$params['entity_table']]['helper_class'])
- ) {
- // FIXME: This calls `CRM_Event_Form_ManageEvent_Repeat::checkRegistrationForEvents`
- // which then sets the static variable `CRM_Core_BAO_RecurringEntity::$_entitiesToBeDeleted`
- // which is then accessed below and used to delete events with no registrations.
- // I can't think of a worse way to pass a variable back from a function.
- call_user_func_array(CRM_Core_BAO_RecurringEntity::$_recurringEntityHelper[$params['entity_table']]['pre_delete_func'], [$params['entity_id']]);
+ $entityType = CRM_Core_DAO_AllCoreTables::getEntityNameForTable($type);
+ // Use pre-delete function for events to exclude those with registered participants
+ if (!empty(self::$preDeleteFunction[$entityType])) {
+ $itemsToDelete = call_user_func_array(self::$preDeleteFunction[$entityType], [$params['entity_id']]);
}
- //Ready to execute delete on entities if it has delete function set
- if (!empty(CRM_Core_BAO_RecurringEntity::$_recurringEntityHelper[$params['entity_table']]['delete_func']) &&
- !empty(CRM_Core_BAO_RecurringEntity::$_recurringEntityHelper[$params['entity_table']]['helper_class'])
- ) {
- //Check if pre delete function has some ids to be deleted
- if (!empty(CRM_Core_BAO_RecurringEntity::$_entitiesToBeDeleted)) {
- foreach (CRM_Core_BAO_RecurringEntity::$_entitiesToBeDeleted as $eid) {
- $result = civicrm_api3(
- ucfirst(strtolower($apiType)),
- CRM_Core_BAO_RecurringEntity::$_recurringEntityHelper[$params['entity_table']]['delete_func'],
- [
- 'sequential' => 1,
- 'id' => $eid,
- ]
- );
- if ($result['error']) {
- CRM_Core_Error::statusBounce(ts('Error creating recurring list'));
- }
- }
- }
- else {
- $getRelatedEntities = CRM_Core_BAO_RecurringEntity::getEntitiesFor($params['entity_id'], $params['entity_table'], FALSE);
- foreach ($getRelatedEntities as $key => $value) {
- $result = civicrm_api3(
- ucfirst(strtolower($apiType)),
- CRM_Core_BAO_RecurringEntity::$_recurringEntityHelper[$params['entity_table']]['delete_func'],
- [
- 'sequential' => 1,
- 'id' => $value['id'],
- ]
- );
- if ($result['error']) {
- CRM_Core_Error::statusBounce(ts('Error creating recurring list'));
- }
- }
- }
+ else {
+ $getRelatedEntities = CRM_Core_BAO_RecurringEntity::getEntitiesFor($params['entity_id'], $params['entity_table'], FALSE);
+ $itemsToDelete = array_column($getRelatedEntities, 'id');
+ }
+ if ($itemsToDelete) {
+ civicrm_api4($entityType, 'delete', [
+ 'checkPermissions' => FALSE,
+ 'where' => [['id', 'IN', $itemsToDelete]],
+ ]);
}
// find all entities from the recurring set. At this point we 'll get entities which were not deleted
diff --git a/CRM/Core/Form/Renderer.php b/CRM/Core/Form/Renderer.php
index 92e23e7a505e..11f40d86ed84 100644
--- a/CRM/Core/Form/Renderer.php
+++ b/CRM/Core/Form/Renderer.php
@@ -217,6 +217,34 @@ public static function updateAttributes(&$element, $required, $error) {
$element->updateAttributes($attributes);
}
+ /**
+ * Process an template sourced in a string with Smarty
+ *
+ * This overrides the quick form function which has not been updated in a while.
+ *
+ * The function is called when render the code to mark a field as 'required'
+ *
+ * The notes on the quick form function seem to refer to older smarty - ie:
+ * Smarty has no core function to render a template given as a string.
+ * So we use the smarty eval plugin function to do this.
+ *
+ * @param string $tplSource The template source
+ */
+ public function _tplFetch($tplSource) {
+ // Smarty3 does not have this function defined so the parent fails.
+ // Adding this is preparatory to smarty 3....
+ if (!function_exists('smarty_function_eval') && !file_exists(SMARTY_DIR . '/plugins/function.eval.php')) {
+ $smarty = $this->_tpl;
+ $smarty->assign('var', $tplSource);
+ return $smarty->fetch("string:$tplSource");
+ }
+ // This part is what the parent does & is suitable to Smarty 2.
+ if (!function_exists('smarty_function_eval')) {
+ require SMARTY_DIR . '/plugins/function.eval.php';
+ }
+ return smarty_function_eval(['var' => $tplSource], $this->_tpl);
+ }
+
/**
* Convert IDs to values and format for display.
*
diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php
index c6bc824419f1..09ea4c76a247 100644
--- a/CRM/Core/ManagedEntities.php
+++ b/CRM/Core/ManagedEntities.php
@@ -1,6 +1,7 @@
value properties of CRM_Core_DAO_Managed used to match an existing record
+ * @param string $entityType
+ * @param $entityId
+ * @return bool
*/
- public function revert(array $params) {
+ public function revert(string $entityType, $entityId): bool {
$mgd = new \CRM_Core_DAO_Managed();
- $mgd->copyValues($params);
+ $mgd->entity_type = $entityType;
+ $mgd->entity_id = $entityId;
$mgd->find(TRUE);
$declarations = $this->getDeclarations([$mgd->module]);
$declarations = CRM_Utils_Array::findAll($declarations, [
@@ -130,12 +133,39 @@ public function revert(array $params) {
'entity' => $mgd->entity_type,
]);
if ($mgd->id && isset($declarations[0])) {
- $this->updateExistingEntity(['update' => 'always'] + $declarations[0] + $mgd->toArray());
+ $item = ['update' => 'always'] + $declarations[0] + $mgd->toArray();
+ $this->backfillDefaults($item);
+ $this->updateExistingEntity($item);
return TRUE;
}
return FALSE;
}
+ /**
+ * Backfill default values to restore record to a pristine state
+ *
+ * @param array $item Managed APIv4 record
+ */
+ private function backfillDefaults(array &$item): void {
+ if ($item['params']['version'] != 4) {
+ return;
+ }
+ // Fetch default values for fields that are writeable
+ $condition = [['type', '=', 'Field'], ['readonly', 'IS EMPTY'], ['default_value', '!=', 'now']];
+ // Exclude "weight" as that auto-adjusts
+ if (CoreUtil::isType($item['entity_type'], 'SortableEntity')) {
+ $weightCol = CoreUtil::getInfoItem($item['entity_type'], 'order_by');
+ $condition[] = ['name', '!=', $weightCol];
+ }
+ $getFields = civicrm_api4($item['entity_type'], 'getFields', [
+ 'checkPermissions' => FALSE,
+ 'action' => 'create',
+ 'where' => $condition,
+ ]);
+ $defaultValues = $getFields->indexBy('name')->column('default_value');
+ $item['params']['values'] += $defaultValues;
+ }
+
/**
* Take appropriate action on every managed entity.
*
@@ -170,12 +200,18 @@ private function filterPlanByAction(array $plan, string $action): array {
}
/**
- * Create a new entity.
+ * Create a new entity (if policy allows).
*
* @param array $item
* Entity specification (per hook_civicrm_managedEntities).
*/
protected function insertNewEntity(array $item) {
+ // If entity has previously been created, only re-insert if 'update' policy is 'always'
+ // NOTE: $item[id] is the id of the `civicrm_managed` row not the entity itself
+ // If that id exists, then we know the entity was inserted previously and subsequently deleted.
+ if (!empty($item['id']) && $item['update'] !== 'always') {
+ return;
+ }
$params = $item['params'];
// APIv4
if ($params['version'] == 4) {
@@ -203,11 +239,13 @@ protected function insertNewEntity(array $item) {
}
$dao = new CRM_Core_DAO_Managed();
+ // If re-inserting the entity, we'll update instead of create the managed record.
+ $dao->id = $item['id'] ?? NULL;
$dao->module = $item['module'];
$dao->name = $item['name'];
$dao->entity_type = $item['entity_type'];
$dao->entity_id = $id;
- $dao->cleanup = $item['cleanup'] ?? NULL;
+ $dao->cleanup = $item['cleanup'] ?? 'always';
$dao->save();
}
@@ -261,7 +299,13 @@ private function updateExistingEntity(array $item) {
}
elseif ($doUpdate && $item['params']['version'] == 4) {
$params = ['checkPermissions' => FALSE] + $item['params'];
- $params['values']['id'] = $item['entity_id'];
+ $idField = CoreUtil::getIdFieldName($item['entity_type']);
+ $params['values'][$idField] = $item['entity_id'];
+ // Exclude "weight" as that auto-adjusts
+ if (CoreUtil::isType($item['entity_type'], 'SortableEntity')) {
+ $weightCol = CoreUtil::getInfoItem($item['entity_type'], 'order_by');
+ unset($params['values'][$weightCol]);
+ }
// 'match' param doesn't apply to "update" action
unset($params['match']);
try {
@@ -332,7 +376,7 @@ protected function removeStaleEntity(array $item) {
case 'unused':
if (CRM_Core_BAO_Managed::isApi4ManagedType($item['entity_type'])) {
- $getRefCount = \Civi\Api4\Utils\CoreUtil::getRefCount($item['entity_type'], $item['entity_id']);
+ $getRefCount = CoreUtil::getRefCount($item['entity_type'], $item['entity_id']);
}
else {
$getRefCount = civicrm_api3($item['entity_type'], 'getrefcount', [
@@ -399,30 +443,6 @@ protected function createModuleIndex($modules) {
return $result;
}
- /**
- * @param array $moduleIndex
- * @param array $declarations
- *
- * @return array
- * indexed by module,name
- */
- protected function createDeclarationIndex($moduleIndex, $declarations) {
- $result = [];
- if (!isset($moduleIndex[TRUE])) {
- return $result;
- }
- foreach ($moduleIndex[TRUE] as $moduleName => $module) {
- if ($module->is_active) {
- // need an empty array() for all active modules, even if there are no current $declarations
- $result[$moduleName] = [];
- }
- }
- foreach ($declarations as $declaration) {
- $result[$declaration['module']][$declaration['name']] = $declaration;
- }
- return $result;
- }
-
/**
* @param array $declarations
*
@@ -555,29 +575,20 @@ protected function createPlan(array $declarations, $modules = NULL): array {
$plan = [];
foreach ($managedEntities as $managedEntity) {
$key = "{$managedEntity['module']}_{$managedEntity['name']}_{$managedEntity['entity_type']}";
- // Set to disable or delete if module is disabled or missing - it will be overwritten below module is active.
+ // Set to disable or delete if module is disabled or missing - it will be overwritten below if module is active.
$action = $this->isModuleDisabled($managedEntity['module']) ? 'disable' : 'delete';
$plan[$key] = array_merge($managedEntity, ['managed_action' => $action]);
}
foreach ($declarations as $declaration) {
$key = "{$declaration['module']}_{$declaration['name']}_{$declaration['entity']}";
- if (isset($plan[$key])) {
- $plan[$key]['params'] = $declaration['params'];
- $plan[$key]['managed_action'] = 'update';
- $plan[$key]['cleanup'] = $declaration['cleanup'] ?? NULL;
- $plan[$key]['update'] = $declaration['update'] ?? 'always';
- }
- else {
- $plan[$key] = [
- 'module' => $declaration['module'],
- 'name' => $declaration['name'],
- 'entity_type' => $declaration['entity'],
- 'managed_action' => 'create',
- 'params' => $declaration['params'],
- 'cleanup' => $declaration['cleanup'] ?? NULL,
- 'update' => $declaration['update'] ?? 'always',
- ];
- }
+ // Set action to update if already managed
+ $plan[$key]['managed_action'] = empty($plan[$key]['entity_id']) ? 'create' : 'update';
+ $plan[$key]['module'] = $declaration['module'];
+ $plan[$key]['name'] = $declaration['name'];
+ $plan[$key]['entity_type'] = $declaration['entity'];
+ $plan[$key]['params'] = $declaration['params'];
+ $plan[$key]['cleanup'] = $declaration['cleanup'] ?? NULL;
+ $plan[$key]['update'] = $declaration['update'] ?? 'always';
}
return $plan;
}
diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php
index 95662e6bd4b9..89f45a28da2a 100644
--- a/CRM/Core/OptionValue.php
+++ b/CRM/Core/OptionValue.php
@@ -181,7 +181,7 @@ public static function getRows($groupParams, $links, $orderBy = 'weight', $skipE
*
*/
public static function addOptionValue(&$params, $optionGroupName, $action, $optionValueID) {
- $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
+ $params['is_active'] = $params['is_active'] ?? FALSE;
// checking if the group name with the given id or name (in $groupParams) exists
$groupParams = ['name' => $optionGroupName, 'is_active' => 1];
$optionGroup = CRM_Core_BAO_OptionGroup::retrieve($groupParams, $defaults);
diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php
index 41a8a57c693a..bfe554070fc6 100644
--- a/CRM/Core/Page.php
+++ b/CRM/Core/Page.php
@@ -132,6 +132,8 @@ class CRM_Core_Page {
// in 'body.tpl
'suppressForm',
'beginHookFormElements',
+ // This is checked in validate.tpl
+ 'snippet_type',
];
/**
diff --git a/CRM/Core/Page/Redirect.php b/CRM/Core/Page/Redirect.php
index 4f0b83dde4b6..3977e5ad3389 100644
--- a/CRM/Core/Page/Redirect.php
+++ b/CRM/Core/Page/Redirect.php
@@ -55,7 +55,7 @@ public static function createUrl($requestPath, $requestArgs, $pageArgs, $absolut
$urlParts = parse_url($urlString);
$url = CRM_Utils_System::url(
$urlParts['path'],
- CRM_Utils_Array::value('query', $urlParts, NULL),
+ $urlParts['query'] ?? NULL,
$absolute,
CRM_Utils_Array::value('fragment', $urlParts, NULL)
);
diff --git a/CRM/Core/Payment.php b/CRM/Core/Payment.php
index 0453ac8ad712..9e0f2a33a87e 100644
--- a/CRM/Core/Payment.php
+++ b/CRM/Core/Payment.php
@@ -591,6 +591,24 @@ public function getText($context, $params) {
case 'contributionPageContinueText':
return ts('Click the Continue button to proceed with the payment.');
+ case 'contributionPageConfirmText':
+ if ($params['amount'] <= 0.0) {
+ return '';
+ }
+ if ((int) $this->_paymentProcessor['billing_mode'] !== 4) {
+ return ts('Your contribution will not be completed until you click the %1 button. Please click the button one time only.', [1 => ts('Make Contribution')]);
+ }
+ return '';
+
+ case 'contributionPageButtonText':
+ if ($params['amount'] <= 0.0 || (int) $this->_paymentProcessor['billing_mode'] === 4) {
+ return ts('Continue');
+ }
+ if ($params['is_payment_to_existing']) {
+ return ts('Make Payment');
+ }
+ return ts('Make Contribution');
+
case 'cancelRecurDetailText':
if ($params['mode'] === 'auto_renew') {
return ts('Click the button below if you want to cancel the auto-renewal option for your %1 membership. This will not cancel your membership. However you will need to arrange payment for renewal when your membership expires.',
diff --git a/CRM/Core/Payment/Manual.php b/CRM/Core/Payment/Manual.php
index 07a008c0ec37..26b348638b24 100644
--- a/CRM/Core/Payment/Manual.php
+++ b/CRM/Core/Payment/Manual.php
@@ -272,13 +272,16 @@ public function isSendReceiptForPending() {
*
* @return string
*/
- public function getText($context, $params) {
+ public function getText($context, $params): string {
switch ($context) {
case 'contributionPageContinueText':
- if ($params['amount'] <= 0) {
- return ts('To complete this transaction, click the Continue button below.');
- }
- return ts('To complete your contribution, click the Continue button below.');
+ return '';
+
+ case 'contributionPageButtonText':
+ return ts('Continue');
+
+ case 'contributionPageConfirmText':
+ return '';
default:
return parent::getText($context, $params);
diff --git a/CRM/Core/Payment/PayPalIPN.php b/CRM/Core/Payment/PayPalIPN.php
index 23be16e1afd0..232cad6e9f21 100644
--- a/CRM/Core/Payment/PayPalIPN.php
+++ b/CRM/Core/Payment/PayPalIPN.php
@@ -430,7 +430,7 @@ protected function getContribution(): CRM_Contribute_BAO_Contribution {
$this->contribution = new CRM_Contribute_BAO_Contribution();
$this->contribution->id = $this->getContributionID();
if (!$this->contribution->find(TRUE)) {
- throw new CRM_Core_Exception('Failure: Could not find contribution record for ' . (int) $contribution->id, NULL, ['context' => "Could not find contribution record: {$contribution->id} in IPN request: "]);
+ throw new CRM_Core_Exception('Failure: Could not find contribution record for ' . (int) $this->contribution->id, NULL, ['context' => "Could not find contribution record: {$this->contribution->id} in IPN request: "]);
}
if ((int) $this->contribution->contact_id !== $this->getContactID()) {
CRM_Core_Error::debug_log_message("Contact ID in IPN not found but contact_id found in contribution.");
diff --git a/CRM/Core/Payment/PayPalProIPN.php b/CRM/Core/Payment/PayPalProIPN.php
index 2106e136d425..61460ca9c33d 100644
--- a/CRM/Core/Payment/PayPalProIPN.php
+++ b/CRM/Core/Payment/PayPalProIPN.php
@@ -228,60 +228,29 @@ public function recur(array $input): void {
$first = !$this->isContributionCompleted();
$recur = $this->getContributionRecurObject();
if (!isset($input['txnType'])) {
- Civi::log()->debug('PayPalProIPN: Could not find txn_type in input request.');
+ Civi::log('paypal_pro')->debug('PayPalProIPN: Could not find txn_type in input request.');
echo 'Failure: Invalid parameters';
return;
}
- // make sure the invoice ids match
- // make sure the invoice is valid and matches what we have in
- // the contribution record
- if ($recur->invoice_id != $input['invoice']) {
- Civi::log()->debug('PayPalProIPN: Invoice values dont match between database and IPN request recur is ' . $recur->invoice_id . ' input is ' . $input['invoice']);
- echo 'Failure: Invoice values dont match between database and IPN request recur is ' . $recur->invoice_id . " input is " . $input['invoice'];
- return;
- }
-
$now = date('YmdHis');
- $sendNotification = FALSE;
- $subscriptionPaymentStatus = NULL;
- //List of Transaction Type
- /*
- recurring_payment_profile_created RP Profile Created
- recurring_payment RP Successful Payment
- recurring_payment_failed RP Failed Payment
- recurring_payment_profile_cancel RP Profile Cancelled
- recurring_payment_expired RP Profile Expired
- recurring_payment_skipped RP Profile Skipped
- recurring_payment_outstanding_payment RP Successful Outstanding Payment
- recurring_payment_outstanding_payment_failed RP Failed Outstanding Payment
- recurring_payment_suspended RP Profile Suspended
- recurring_payment_suspended_due_to_max_failed_payment RP Profile Suspended due to Max Failed Payment
- */
-
- //set transaction type
$txnType = $this->retrieve('txn_type', 'String');
- //Changes for paypal pro recurring payment
+
switch ($txnType) {
case 'recurring_payment_profile_created':
- if (in_array(CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', $recur->contribution_status_id), [
- 'Pending', 'In Progress',
- ], TRUE)
- && !empty($recur->processor_id)
+ if (CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', $recur->contribution_status_id) === 'In Progress'
) {
- echo 'already handled';
+ Civi::log('paypal_pro')->debug('already handled');
return;
}
- $recur->create_date = $now;
- $recur->contribution_status_id = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', 'Pending');
- $recur->processor_id = $this->retrieve('recurring_payment_id', 'String');
- $recur->trxn_id = $recur->processor_id;
- $subscriptionPaymentStatus = CRM_Core_Payment::RECURRING_PAYMENT_START;
- $sendNotification = TRUE;
- break;
+ $this->processProfileCreated();
+ return;
case 'recurring_payment':
+ $recur->processor_id = $this->retrieve('recurring_payment_id', 'String');
+ $recur->trxn_id = $recur->processor_id;
+ $recur->save();
if (!$first) {
if ($input['paymentStatus'] !== 'Completed') {
throw new CRM_Core_Exception('Ignore all IPN payments that are not completed');
@@ -306,29 +275,18 @@ public function recur(array $input): void {
}
$recur->contribution_status_id = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', 'Completed');
$recur->end_date = $now;
- $sendNotification = TRUE;
- $subscriptionPaymentStatus = CRM_Core_Payment::RECURRING_PAYMENT_END;
+ $recur->save();
+ //send recurring Notification email for user
+ CRM_Contribute_BAO_ContributionPage::recurringNotify(
+ $this->getContributionID(),
+ CRM_Core_Payment::RECURRING_PAYMENT_END,
+ $recur
+ );
}
-
+ $this->single($input);
break;
}
- $recur->save();
-
- if ($sendNotification) {
- //send recurring Notification email for user
- CRM_Contribute_BAO_ContributionPage::recurringNotify(
- $this->getContributionID(),
- $subscriptionPaymentStatus,
- $recur
- );
- }
-
- if ($txnType !== 'recurring_payment') {
- return;
- }
-
- $this->single($input);
}
/**
@@ -355,11 +313,11 @@ protected function single(array $input): void {
'cancel_date' => 'now',
'contribution_status_id:name' => 'Failed',
])->addWhere('id', '=', $this->getContributionID())->execute();
- Civi::log()->debug('Setting contribution status to Failed');
+ Civi::log('paypal_pro')->debug('Setting contribution status to Failed');
return;
}
if ($status === 'Pending') {
- Civi::log()->debug('Returning since contribution status is Pending');
+ Civi::log('paypal_pro')->debug('Returning since contribution status is Pending');
return;
}
if ($status === 'Refunded' || $status === 'Reversed') {
@@ -367,16 +325,16 @@ protected function single(array $input): void {
'cancel_date' => 'now',
'contribution_status_id:name' => 'Cancelled',
])->addWhere('id', '=', $this->getContributionID())->execute();
- Civi::log()->debug('Setting contribution status to Cancelled');
+ Civi::log('paypal_pro')->debug('Setting contribution status to Cancelled');
return;
}
if ($status !== 'Completed') {
- Civi::log()->debug('Returning since contribution status is not handled');
+ Civi::log('paypal_pro')->debug('Returning since contribution status is not handled');
return;
}
if ($this->isContributionCompleted()) {
- Civi::log()->debug('PayPalProIPN: Returning since contribution has already been handled.');
+ Civi::log('paypal_pro')->debug('PayPalProIPN: Returning since contribution has already been handled.');
echo 'Success: Contribution has already been handled
';
return;
}
@@ -396,7 +354,7 @@ public function getPayPalPaymentProcessorID() {
// entirely). The only thing the IPN class should really do is extract data from the request, validate it
// & call completetransaction or call fail? (which may not exist yet).
- Civi::log()->warning('Unreliable method used to get payment_processor_id for PayPal Pro IPN - this will cause problems if you have more than one instance');
+ Civi::log('paypal_pro')->warning('Unreliable method used to get payment_processor_id for PayPal Pro IPN - this will cause problems if you have more than one instance');
$paymentProcessorTypeID = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
'PayPal', 'id', 'name'
@@ -449,7 +407,7 @@ public function main(): void {
$this->single($input);
}
catch (Exception $e) {
- Civi::log()->debug($e->getMessage() . ' input {input}', ['input' => $input]);
+ Civi::log('paypal_pro')->debug($e->getMessage() . ' input {input}', ['input' => $input]);
echo 'Invalid or missing data';
}
}
@@ -561,6 +519,15 @@ protected function getContributionRecurObject(): CRM_Contribute_BAO_Contribution
if (!$contributionRecur->find(TRUE)) {
throw new CRM_Core_Exception('Failure: Could not find contribution recur record');
}
+
+ // make sure the invoice ids match
+ // make sure the invoice is valid and matches what we have in
+ // the contribution record
+ $invoice = (string) $this->getValue('i');
+ if ((string) $contributionRecur->invoice_id !== $invoice) {
+ Civi::log('paypal_pro')->debug('PayPalProIPN: Invoice values dont match between database and IPN request recur is ' . $contributionRecur->invoice_id . ' input is ' . $invoice);
+ throw new CRM_Core_Exception('Failure: Invoice values dont match between database and IPN request recur is ' . $contributionRecur->invoice_id . " input is " . $invoice);
+ }
return $this->contributionRecurObject = $contributionRecur;
}
return $this->contributionRecurObject;
@@ -607,4 +574,30 @@ private function isContributionCompleted(): bool {
return $status === 'Completed';
}
+ /**
+ * Update a recurring contribution to in progress based on an ipn profile_create notification.
+ *
+ * recurring_payment_profile_created is called when the
+ * subscription has been authorized and confirmed by the user,
+ * but before a payment has been taken.
+ * The recurring_payment_id is POSTed to the IPN
+ * and we store it in the recurring contribution's processor_id.
+ *
+ * @throws \CRM_Core_Exception
+ */
+ private function processProfileCreated(): void {
+ $recur = $this->getContributionRecurObject();
+ $recur->create_date = date('YmdHis');
+ $recur->contribution_status_id = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', 'Pending');
+ $recur->processor_id = $this->retrieve('recurring_payment_id', 'String');
+ $recur->trxn_id = $recur->processor_id;
+ $recur->save();
+ //send recurring Notification email for user
+ CRM_Contribute_BAO_ContributionPage::recurringNotify(
+ $this->getContributionID(),
+ CRM_Core_Payment::RECURRING_PAYMENT_START,
+ $recur
+ );
+ }
+
}
diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php
index 4a86234f1f83..73275f3eb51a 100644
--- a/CRM/Core/PseudoConstant.php
+++ b/CRM/Core/PseudoConstant.php
@@ -68,12 +68,6 @@ class CRM_Core_PseudoConstant {
*/
private static $country;
- /**
- * CountryIsoCode.
- * @var array
- */
- private static $countryIsoCode;
-
/**
* group
* @var array
@@ -99,43 +93,6 @@ class CRM_Core_PseudoConstant {
*/
private static $currencyCode;
- /**
- * Payment processor
- * @var array
- */
- private static $paymentProcessor;
-
- /**
- * Payment processor types
- * @var array
- */
- private static $paymentProcessorType;
-
- /**
- * World Region
- * @var array
- */
- private static $worldRegions;
-
- /**
- * activity status
- * @var array
- * @deprecated Please use the buildOptions() method in the appropriate BAO object.
- */
- private static $activityStatus;
-
- /**
- * Visibility
- * @var array
- */
- private static $visibility;
-
- /**
- * Greetings
- * @var array
- */
- private static $greeting;
-
/**
* Extensions of type module
* @var array
@@ -466,8 +423,7 @@ public static function populate(
}
/**
- * Flush given pseudoconstant so it can be reread from db.
- * nex time it's requested.
+ * Flush static array cache.
*
* @param bool|string $name pseudoconstant to be flushed
*/
@@ -496,12 +452,12 @@ public static function flush($name = 'cache') {
*/
public static function &activityType() {
$args = func_get_args();
- $all = CRM_Utils_Array::value(0, $args, TRUE);
- $includeCaseActivities = CRM_Utils_Array::value(1, $args, FALSE);
- $reset = CRM_Utils_Array::value(2, $args, FALSE);
- $returnColumn = CRM_Utils_Array::value(3, $args, 'label');
- $includeCampaignActivities = CRM_Utils_Array::value(4, $args, FALSE);
- $onlyComponentActivities = CRM_Utils_Array::value(5, $args, FALSE);
+ $all = $args[0] ?? TRUE;
+ $includeCaseActivities = $args[1] ?? FALSE;
+ $reset = $args[2] ?? FALSE;
+ $returnColumn = $args[3] ?? 'label';
+ $includeCampaignActivities = $args[4] ?? FALSE;
+ $onlyComponentActivities = $args[5] ?? FALSE;
$index = (int) $all . '_' . $returnColumn . '_' . (int) $includeCaseActivities;
$index .= '_' . (int) $includeCampaignActivities;
$index .= '_' . (int) $onlyComponentActivities;
@@ -668,6 +624,7 @@ public static function stateProvinceAbbreviation($id = FALSE, $limit = TRUE) {
/**
* Get all the State/Province abbreviations from the database for the specified country.
+ * @deprecated
*
* @param int $countryID
*
@@ -675,21 +632,24 @@ public static function stateProvinceAbbreviation($id = FALSE, $limit = TRUE) {
* array of all State/Province abbreviations for the given country.
*/
public static function stateProvinceAbbreviationForCountry($countryID) {
- if (!isset(\Civi::$statics[__CLASS__]['stateProvinceAbbreviationForCountry'][$countryID])) {
- \Civi::$statics[__CLASS__]['stateProvinceAbbreviationForCountry'][$countryID] = [];
- }
- self::populate(\Civi::$statics[__CLASS__]['stateProvinceAbbreviationForCountry'][$countryID], 'CRM_Core_DAO_StateProvince', TRUE, 'abbreviation', 'is_active', "country_id = " . (int) $countryID, 'abbreviation');
- return \Civi::$statics[__CLASS__]['stateProvinceAbbreviationForCountry'][$countryID];
+ CRM_Core_Error::deprecatedFunctionWarning('API');
+ $abbrs = [];
+ self::populate($abbrs, 'CRM_Core_DAO_StateProvince', TRUE, 'abbreviation', 'is_active', "country_id = " . (int) $countryID, 'abbreviation');
+ return $abbrs;
}
/**
* Get all the State/Province abbreviations from the database for the default country.
+ * @deprecated
*
* @return array
* array of all State/Province abbreviations for the given country.
*/
public static function stateProvinceAbbreviationForDefaultCountry() {
- return CRM_Core_PseudoConstant::stateProvinceAbbreviationForCountry(Civi::settings()->get('defaultContactCountry'));
+ $countryID = Civi::settings()->get('defaultContactCountry');
+ $abbrs = [];
+ self::populate($abbrs, 'CRM_Core_DAO_StateProvince', TRUE, 'abbreviation', 'is_active', "country_id = " . (int) $countryID, 'abbreviation');
+ return $abbrs;
}
/**
@@ -754,31 +714,18 @@ public static function country($id = FALSE, $applyLimit = TRUE) {
/**
* Get all the country ISO Code abbreviations from the database.
*
- * The static array countryIsoCode is returned, and if it's
- * called the first time, the Country DAO is used
- * to get all the countries' ISO codes.
- *
- * Note: any database errors will be trapped by the DAO.
- *
- *
* @param bool $id
*
* @return array
- * array reference of all country ISO codes.
*/
- public static function &countryIsoCode($id = FALSE) {
- if (!self::$countryIsoCode) {
- self::populate(self::$countryIsoCode, 'CRM_Core_DAO_Country', TRUE, 'iso_code');
- }
+ public static function countryIsoCode($id = FALSE) {
+ $values = [];
+ self::populate($values, 'CRM_Core_DAO_Country', TRUE, 'iso_code');
+
if ($id) {
- if (array_key_exists($id, self::$countryIsoCode)) {
- return self::$countryIsoCode[$id];
- }
- else {
- return CRM_Core_DAO::$_nullObject;
- }
+ return $values[$id] ?? NULL;
}
- return self::$countryIsoCode;
+ return $values;
}
/**
@@ -803,12 +750,9 @@ public static function &countryIsoCode($id = FALSE) {
*/
public static function allGroup($groupType = NULL, $excludeHidden = TRUE) {
$condition = CRM_Contact_BAO_Group::groupTypeCondition($groupType, $excludeHidden);
- $groupKey = ($groupType ?: 'null') . !empty($excludeHidden);
-
- if (!isset(Civi::$statics[__CLASS__]['groups']['allGroup'][$groupKey])) {
- self::populate(Civi::$statics[__CLASS__]['groups']['allGroup'][$groupKey], 'CRM_Contact_DAO_Group', FALSE, 'title', 'is_active', $condition);
- }
- return Civi::$statics[__CLASS__]['groups']['allGroup'][$groupKey];
+ $values = [];
+ self::populate($values, 'CRM_Contact_DAO_Group', FALSE, 'title', 'is_active', $condition);
+ return $values;
}
/**
@@ -955,9 +899,6 @@ public static function relationshipTypeOptions() {
/**
* Get all the ISO 4217 currency codes
*
- * so far, we use this for validation only, so there's no point of putting this into the database
- *
- *
* @return array
* array reference of all currency codes
*/
@@ -966,7 +907,6 @@ public static function ¤cyCode() {
$query = "SELECT name FROM civicrm_currency";
$dao = CRM_Core_DAO::executeQuery($query);
- $currencyCode = [];
while ($dao->fetch()) {
self::$currencyCode[] = $dao->name;
}
@@ -1025,8 +965,7 @@ public static function &county($id = FALSE) {
* array of all payment processors
*/
public static function paymentProcessor($all = FALSE, $test = FALSE, $additionalCond = NULL) {
- $condition = "is_test = ";
- $condition .= ($test) ? '1' : '0';
+ $condition = 'is_test = ' . ($test ? '1' : '0');
if ($additionalCond) {
$condition .= " AND ( $additionalCond ) ";
@@ -1035,13 +974,10 @@ public static function paymentProcessor($all = FALSE, $test = FALSE, $additional
// CRM-7178. Make sure we only include payment processors valid in this
// domain
$condition .= " AND domain_id = " . CRM_Core_Config::domainID();
+ $values = [];
+ self::populate($values, 'CRM_Financial_DAO_PaymentProcessor', $all, 'name', 'is_active', $condition, 'is_default desc, name');
- $cacheKey = $condition . '_' . (int) $all;
- if (!isset(self::$paymentProcessor[$cacheKey])) {
- self::populate(self::$paymentProcessor[$cacheKey], 'CRM_Financial_DAO_PaymentProcessor', $all, 'name', 'is_active', $condition, 'is_default desc, name');
- }
-
- return self::$paymentProcessor[$cacheKey];
+ return $values;
}
/**
@@ -1060,40 +996,32 @@ public static function paymentProcessor($all = FALSE, $test = FALSE, $additional
* array of all payment processor types
*/
public static function &paymentProcessorType($all = FALSE, $id = NULL, $return = 'title') {
- $cacheKey = $id . '_' . $return;
- if (empty(self::$paymentProcessorType[$cacheKey])) {
- self::populate(self::$paymentProcessorType[$cacheKey], 'CRM_Financial_DAO_PaymentProcessorType', $all, $return, 'is_active', NULL, "is_default, $return", 'id');
- }
- if ($id && !empty(self::$paymentProcessorType[$cacheKey][$id])) {
- return self::$paymentProcessorType[$cacheKey][$id];
- }
- return self::$paymentProcessorType[$cacheKey];
+ CRM_Core_Error::deprecatedFunctionWarning('API');
+ $values = [];
+ self::populate($values, 'CRM_Financial_DAO_PaymentProcessorType', $all, $return, 'is_active', NULL, "is_default, $return", 'id');
+ // This is incredibly stupid, but the whole function is deprecated anyway...
+ if ($id && !empty($values[$id])) {
+ return $values[$id];
+ }
+ return $values;
}
/**
* Get all the World Regions from Database.
*
- *
* @param bool $id
*
* @return array
* array reference of all World Regions
*/
- public static function &worldRegion($id = FALSE) {
- if (!self::$worldRegions) {
- self::populate(self::$worldRegions, 'CRM_Core_DAO_Worldregion', TRUE, 'name', NULL, NULL, 'id');
- }
+ public static function worldRegion($id = FALSE) {
+ $values = [];
+ self::populate($values, 'CRM_Core_DAO_Worldregion', TRUE, 'name', NULL, NULL, 'id');
if ($id) {
- if (array_key_exists($id, self::$worldRegions)) {
- return self::$worldRegions[$id];
- }
- else {
- return CRM_Core_DAO::$_nullObject;
- }
+ return $values[$id] ?? NULL;
}
-
- return self::$worldRegions;
+ return $values;
}
/**
@@ -1101,25 +1029,12 @@ public static function &worldRegion($id = FALSE) {
*
* Get all Activity Statuses.
*
- * The static array activityStatus is returned
- *
- *
* @param string $column
*
* @return array
- * array reference of all activity statuses
*/
public static function &activityStatus($column = 'label') {
- if (NULL === self::$activityStatus) {
- self::$activityStatus = [];
- }
- if (!array_key_exists($column, self::$activityStatus)) {
- self::$activityStatus[$column] = [];
-
- self::$activityStatus[$column] = CRM_Core_OptionGroup::values('activity_status', FALSE, FALSE, FALSE, NULL, $column);
- }
-
- return self::$activityStatus[$column];
+ return CRM_Core_OptionGroup::values('activity_status', FALSE, FALSE, FALSE, NULL, $column);
}
/**
@@ -1135,16 +1050,8 @@ public static function &activityStatus($column = 'label') {
* @return array
* array reference of all Visibility levels.
*/
- public static function &visibility($column = 'label') {
- if (!isset(self::$visibility)) {
- self::$visibility = [];
- }
-
- if (!isset(self::$visibility[$column])) {
- self::$visibility[$column] = CRM_Core_OptionGroup::values('visibility', FALSE, FALSE, FALSE, NULL, $column);
- }
-
- return self::$visibility[$column];
+ public static function visibility($column = 'label') {
+ return CRM_Core_OptionGroup::values('visibility', FALSE, FALSE, FALSE, NULL, $column);
}
/**
diff --git a/CRM/Core/QuickForm/Action/Upload.php b/CRM/Core/QuickForm/Action/Upload.php
index c86d0b2f1602..9f7089893d2f 100644
--- a/CRM/Core/QuickForm/Action/Upload.php
+++ b/CRM/Core/QuickForm/Action/Upload.php
@@ -77,7 +77,7 @@ public function upload(&$page, &$data, $pageName, $uploadName) {
// rename the uploaded file with a unique number at the end
$value = $element->getValue();
- $newName = CRM_Utils_File::makeFileName($value['name']);
+ $newName = CRM_Utils_File::makeFileName($value['name'], TRUE);
$status = $element->moveUploadedFile($this->_uploadDir, $newName);
if (!$status) {
CRM_Core_Error::statusBounce(ts('We could not move the uploaded file %1 to the upload directory %2. Please verify that the \'Temporary Files\' setting points to a valid path which is writable by your web server.', [
diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php
index b1818c689389..f1610b35f63c 100644
--- a/CRM/Core/Resources.php
+++ b/CRM/Core/Resources.php
@@ -429,7 +429,7 @@ public static function renderL10nJs(GenericHookEvent $e) {
$e->mimeType = 'application/javascript';
$params = $e->params;
$params += [
- 'contactSearch' => json_encode($params['includeEmailInName'] ? ts('Search by name/email or id...') : ts('Search by name or id...')),
+ 'contactSearch' => json_encode(!empty($params['includeEmailInName']) ? ts('Search by name/email or id...') : ts('Search by name or id...')),
'otherSearch' => json_encode(ts('Enter search term or id...')),
'entityRef' => self::getEntityRefMetadata(),
];
diff --git a/CRM/Core/SelectValues.php b/CRM/Core/SelectValues.php
index 0573b1a8a1f1..e550d54deceb 100644
--- a/CRM/Core/SelectValues.php
+++ b/CRM/Core/SelectValues.php
@@ -219,6 +219,11 @@ public static function customHtmlType() {
'name' => 'Link',
'label' => ts('Link'),
],
+ [
+ 'id' => 'Hidden',
+ 'name' => 'Hidden',
+ 'label' => ts('Hidden'),
+ ],
];
}
@@ -634,6 +639,7 @@ public static function contactTokens(): array {
* @return array
*/
public static function participantTokens(): array {
+ CRM_Core_Error::deprecatedFunctionWarning('user TokenProcessor');
$tokenProcessor = new TokenProcessor(Civi::dispatcher(), ['schema' => ['participantId']]);
$allTokens = $tokenProcessor->listTokens();
foreach (array_keys($allTokens) as $token) {
@@ -1079,16 +1085,19 @@ public static function getPermissionedRelationshipOptions() {
'id' => CRM_Contact_BAO_Relationship::NONE,
'name' => 'None',
'label' => ts('None'),
+ 'icon' => NULL,
],
[
'id' => CRM_Contact_BAO_Relationship::VIEW,
'name' => 'View only',
'label' => ts('View only'),
+ 'icon' => 'fa-eye',
],
[
'id' => CRM_Contact_BAO_Relationship::EDIT,
'name' => 'View and update',
'label' => ts('View and update'),
+ 'icon' => 'fa-pencil-square',
],
];
}
@@ -1127,6 +1136,7 @@ public static function quicksearchOptions() {
'address_primary.street_address' => ts('Street Address'),
'address_primary.city' => ts('City'),
'address_primary.postal_code' => ts('Postal Code'),
+ 'employer_id.sort_name' => ts('Current Employer'),
'job_title' => ts('Job Title'),
];
$custom = civicrm_api4('CustomField', 'get', [
diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php
index c2cc8d196aa6..b2d899a30532 100644
--- a/CRM/Core/Selector/Controller.php
+++ b/CRM/Core/Selector/Controller.php
@@ -325,7 +325,7 @@ public function run() {
}
else {
// output requires paging/sorting capability
- $rows = self::getRows($this);
+ $rows = $this->getRows($this);
CRM_Utils_Hook::searchColumns($contextName, $columnHeaders, $rows, $this);
$reorderedHeaders = [];
$noWeightHeaders = [];
diff --git a/CRM/Core/Smarty.php b/CRM/Core/Smarty.php
index b5c22c62df57..60f6cfcb0973 100644
--- a/CRM/Core/Smarty.php
+++ b/CRM/Core/Smarty.php
@@ -22,14 +22,10 @@
use Civi\Core\Event\SmartyErrorEvent;
-if (!class_exists('Smarty')) {
- require_once 'Smarty/Smarty.class.php';
-}
-
/**
*
*/
-class CRM_Core_Smarty extends Smarty {
+class CRM_Core_Smarty extends CRM_Core_SmartyCompatibility {
const
// use print.tpl and bypass the CMS. Civi prints a valid html file
PRINT_PAGE = 1,
@@ -132,6 +128,15 @@ private function initialize() {
$this->assign('config', $config);
$this->assign('session', $session);
+ $this->assign('debugging', [
+ 'smartyDebug' => CRM_Utils_Request::retrieveValue('smartyDebug', 'Integer'),
+ 'sessionReset' => CRM_Utils_Request::retrieveValue('sessionReset', 'Integer'),
+ 'sessionDebug' => CRM_Utils_Request::retrieveValue('sessionDebug', 'Integer'),
+ 'directoryCleanup' => CRM_Utils_Request::retrieveValue('directoryCleanup', 'Integer'),
+ 'cacheCleanup' => CRM_Utils_Request::retrieveValue('cacheCleanup', 'Integer'),
+ 'configReset' => CRM_Utils_Request::retrieveValue('configReset', 'Integer'),
+ ]);
+ $this->assign('snippet_type', CRM_Utils_Request::retrieveValue('snippet', 'String'));
$tsLocale = CRM_Core_I18n::getLocale();
$this->assign('tsLocale', $tsLocale);
@@ -141,7 +146,12 @@ private function initialize() {
$this->assign('langSwitch', CRM_Core_I18n::uiLanguages());
}
- if (CRM_Utils_Constant::value('CIVICRM_SMARTY_DEFAULT_ESCAPE')) {
+ if (CRM_Utils_Constant::value('CIVICRM_SMARTY_DEFAULT_ESCAPE')
+ && !CRM_Utils_Constant::value('CIVICRM_SMARTY3_AUTOLOAD_PATH')) {
+ // Currently DEFAULT escape does not work with Smarty3
+ // dunno why - thought it would be the default with Smarty3 - but
+ // getting onto Smarty 3 is higher priority.
+ // The include below loads the v2 version which is why id doesn't work.
// When default escape is enabled if the core escape is called before
// any custom escaping is done the modifier_escape function is not
// found, so require_once straight away. Note this was hit on the basic
@@ -183,35 +193,6 @@ public static function &singleton() {
return self::$_singleton;
}
- /**
- * Executes & returns or displays the template results
- *
- * @param string $resource_name
- * @param string $cache_id
- * @param string $compile_id
- * @param bool $display
- *
- * @return bool|mixed|string
- *
- * @noinspection PhpDocMissingThrowsInspection
- * @noinspection PhpUnhandledExceptionInspection
- */
- public function fetch($resource_name, $cache_id = NULL, $compile_id = NULL, $display = FALSE) {
- if (preg_match('/^(\s+)?string:/', $resource_name)) {
- $old_security = $this->security;
- $this->security = TRUE;
- }
- try {
- $output = parent::fetch($resource_name, $cache_id, $compile_id, $display);
- }
- finally {
- if (isset($old_security)) {
- $this->security = $old_security;
- }
- }
- return $output;
- }
-
/**
* Handle smarty error in one off string.
*
diff --git a/CRM/Core/Smarty/plugins/block.crmButton.php b/CRM/Core/Smarty/plugins/block.crmButton.php
index 64543d595768..fbd6606329e7 100644
--- a/CRM/Core/Smarty/plugins/block.crmButton.php
+++ b/CRM/Core/Smarty/plugins/block.crmButton.php
@@ -24,33 +24,37 @@
* Contents of block.
* @param CRM_Core_Smarty $smarty
* The Smarty object.
+ * @param bool $repeat
+ * Repeat is true for the opening tag, false for the closing tag
*
- * @return string
+ * @return string|null
* The generated html.
*/
-function smarty_block_crmButton($params, $text, &$smarty) {
- // Generate url (pass 'html' param as false to avoid double-encode by htmlAttributes)
- if (empty($params['href'])) {
- $params['href'] = CRM_Utils_System::crmURL($params + ['h' => FALSE]);
- }
- // Always add class 'button' - fixme probably should be crm-button
- $params['class'] = empty($params['class']) ? 'button' : 'button ' . $params['class'];
- // Any FA icon works
- if (array_key_exists('icon', $params) && !$params['icon']) {
- // icon=0 should produce a button with no icon
- $iconMarkup = '';
- }
- else {
- $icon = $params['icon'] ?? 'fa-pencil';
- // Assume for now that all icons are Font Awesome v4.x but handle if it's
- // specified
- if (strpos($icon, 'fa-') !== 0) {
- $icon = "fa-$icon";
+function smarty_block_crmButton($params, $text, &$smarty, &$repeat) {
+ if (!$repeat) {
+ // Generate url (pass 'html' param as false to avoid double-encode by htmlAttributes)
+ if (empty($params['href'])) {
+ $params['href'] = CRM_Utils_System::crmURL($params + ['h' => FALSE]);
+ }
+ // Always add class 'button' - fixme probably should be crm-button
+ $params['class'] = empty($params['class']) ? 'button' : 'button ' . $params['class'];
+ // Any FA icon works
+ if (array_key_exists('icon', $params) && !$params['icon']) {
+ // icon=0 should produce a button with no icon
+ $iconMarkup = '';
+ }
+ else {
+ $icon = $params['icon'] ?? 'fa-pencil';
+ // Assume for now that all icons are Font Awesome v4.x but handle if it's
+ // specified
+ if (strpos($icon, 'fa-') !== 0) {
+ $icon = "fa-$icon";
+ }
+ $iconMarkup = " ";
}
- $iconMarkup = " ";
+ // All other params are treated as html attributes
+ CRM_Utils_Array::remove($params, 'icon', 'p', 'q', 'a', 'f', 'h', 'fb', 'fe');
+ $attributes = CRM_Utils_String::htmlAttributes($params);
+ return "$iconMarkup$text";
}
- // All other params are treated as html attributes
- CRM_Utils_Array::remove($params, 'icon', 'p', 'q', 'a', 'f', 'h', 'fb', 'fe');
- $attributes = CRM_Utils_String::htmlAttributes($params);
- return "$iconMarkup$text";
}
diff --git a/CRM/Core/Smarty/plugins/block.crmUpgradeSnapshot.php b/CRM/Core/Smarty/plugins/block.crmUpgradeSnapshot.php
index 9e95233751c7..44571c14ed27 100644
--- a/CRM/Core/Smarty/plugins/block.crmUpgradeSnapshot.php
+++ b/CRM/Core/Smarty/plugins/block.crmUpgradeSnapshot.php
@@ -32,11 +32,13 @@
* @param string|null $text
* The SELECT query which supplies the interesting data to be stored in the snapshot.
* @param CRM_Core_Smarty $smarty
+ * @param bool $repeat
+ * Repeat is true for the opening tag, false for the closing tag
* @return string|null
* @throws \CRM_Core_Exception
*/
-function smarty_block_crmUpgradeSnapshot($params, $text, &$smarty) {
- if ($text === NULL) {
+function smarty_block_crmUpgradeSnapshot($params, $text, &$smarty, &$repeat) {
+ if ($repeat || $text === NULL) {
return NULL;
}
diff --git a/CRM/Core/Smarty/plugins/block.edit.php b/CRM/Core/Smarty/plugins/block.edit.php
index d42fe44e0392..cb3d15479d59 100644
--- a/CRM/Core/Smarty/plugins/block.edit.php
+++ b/CRM/Core/Smarty/plugins/block.edit.php
@@ -30,11 +30,15 @@
* {edit} block contents from the template.
* @param CRM_Core_Smarty $smarty
* The Smarty object.
+ * @param bool $repeat
+ * Repeat is true for the opening tag, false for the closing tag
*
- * @return string
+ * @return string|null
* the string, translated by gettext
*/
-function smarty_block_edit($params, $text, &$smarty) {
- $action = $smarty->_tpl_vars['action'];
- return ($action & 3) ? $text : NULL;
+function smarty_block_edit($params, $text, &$smarty, &$repeat) {
+ if (!$repeat) {
+ $action = $smarty->get_template_vars()['action'];
+ return ($action & 3) ? $text : NULL;
+ }
}
diff --git a/CRM/Core/Smarty/plugins/block.htxt.php b/CRM/Core/Smarty/plugins/block.htxt.php
index cfd03732c13c..cc58bda7731a 100644
--- a/CRM/Core/Smarty/plugins/block.htxt.php
+++ b/CRM/Core/Smarty/plugins/block.htxt.php
@@ -26,16 +26,16 @@
* {ts} block contents from the template.
* @param CRM_Core_Smarty $smarty
* The Smarty object.
+ * @param bool $repeat
+ * Repeat is true for the opening tag, false for the closing tag
*
- * @return string
+ * @return string|null
* the string, translated by gettext
*/
-function smarty_block_htxt($params, $text, &$smarty) {
- if ($params['id'] == $smarty->_tpl_vars['id']) {
+function smarty_block_htxt($params, $text, $smarty, &$repeat) {
+ if (!$repeat && $params['id'] == $smarty->getTemplateVars('id')) {
$smarty->assign('override_help_text', !empty($params['override']));
return $text;
}
- else {
- return NULL;
- }
+ return NULL;
}
diff --git a/CRM/Core/Smarty/plugins/block.icon.php b/CRM/Core/Smarty/plugins/block.icon.php
index 97dbb6d55d80..84865c63d4ec 100644
--- a/CRM/Core/Smarty/plugins/block.icon.php
+++ b/CRM/Core/Smarty/plugins/block.icon.php
@@ -30,14 +30,19 @@
*
* @param $smarty
*
- * @return string
+ * @param bool $repeat
+ * Repeat is true for the opening tag, false for the closing tag
+ *
+ * @return string|null
*/
-function smarty_block_icon($params, $text, &$smarty) {
- $condition = array_key_exists('condition', $params) ? $params['condition'] : 1;
- $icon = $params['icon'] ?? 'fa-check';
- $dontPass = [
- 'condition' => 1,
- 'icon' => 1,
- ];
- return CRM_Core_Page::crmIcon($icon, $text, $condition, array_diff_key($params, $dontPass));
+function smarty_block_icon($params, $text, &$smarty, &$repeat) {
+ if (!$repeat) {
+ $condition = array_key_exists('condition', $params) ? $params['condition'] : 1;
+ $icon = $params['icon'] ?? 'fa-check';
+ $dontPass = [
+ 'condition' => 1,
+ 'icon' => 1,
+ ];
+ return CRM_Core_Page::crmIcon($icon, $text, $condition, array_diff_key($params, $dontPass));
+ }
}
diff --git a/CRM/Core/Smarty/plugins/block.localize.php b/CRM/Core/Smarty/plugins/block.localize.php
index 47e64fe6be3d..6b7f357d85ee 100644
--- a/CRM/Core/Smarty/plugins/block.localize.php
+++ b/CRM/Core/Smarty/plugins/block.localize.php
@@ -33,18 +33,19 @@
* @return string
* multilingualized query
*/
-function smarty_block_localize($params, $text, &$smarty, &$repeat) {
+function smarty_block_localize($params, $text, $smarty, &$repeat) {
if ($repeat) {
// For opening tag text is always null
return '';
}
-
- if (!array_key_exists('multilingual', $smarty->_tpl_vars) || !$smarty->_tpl_vars['multilingual']) {
+ $multiLingual = method_exists($smarty, 'get_template_vars') ? $smarty->get_template_vars('multilingual') : $smarty->getTemplateVars('multilingual');
+ if (!$multiLingual) {
return $text;
}
$lines = [];
- foreach ($smarty->_tpl_vars['locales'] as $locale) {
+ $locales = (array) (method_exists($smarty, 'get_template_vars') ? $smarty->get_template_vars('locales') : $smarty->getTemplateVars('locales'));
+ foreach ($locales as $locale) {
$line = $text;
if (isset($params['field'])) {
$fields = explode(',', $params['field']);
diff --git a/CRM/Core/Smarty/plugins/block.serialize.php b/CRM/Core/Smarty/plugins/block.serialize.php
deleted file mode 100644
index e716631050bf..000000000000
--- a/CRM/Core/Smarty/plugins/block.serialize.php
+++ /dev/null
@@ -1,37 +0,0 @@
-
- * @copyright CiviCRM LLC https://civicrm.org/licensing
- */
-
-/**
- * Smarty block function providing serialization support
- *
- * See CRM_Core_I18n class documentation for details.
- *
- * @param array $params
- * Template call's parameters.
- * @param string $text
- * {serialize} block contents from the template.
- * @param CRM_Core_Smarty $smarty
- * The Smarty object.
- *
- * @return string
- * the string, translated by gettext
- */
-function smarty_block_serialize($params, $text, &$smarty) {
- return serialize($text);
-}
diff --git a/CRM/Core/Smarty/plugins/block.ts.php b/CRM/Core/Smarty/plugins/block.ts.php
index 785122d36e25..cb077675de66 100644
--- a/CRM/Core/Smarty/plugins/block.ts.php
+++ b/CRM/Core/Smarty/plugins/block.ts.php
@@ -29,13 +29,17 @@
* {ts} block contents from the template.
* @param CRM_Core_Smarty $smarty
* The Smarty object.
+ * @param bool $repeat
+ * Repeat is true for the opening tag, false for the closing tag
*
- * @return string
+ * @return string|null
* the string, translated by gettext
*/
-function smarty_block_ts($params, $text, &$smarty) {
- if (!isset($params['domain']) && $extensionKey = $smarty->get_template_vars('extensionKey')) {
- $params['domain'] = is_array($extensionKey) ? $extensionKey : [$extensionKey, NULL];
+function smarty_block_ts($params, $text, &$smarty, &$repeat) {
+ if (!$repeat) {
+ if (!isset($params['domain']) && $extensionKey = $smarty->get_template_vars('extensionKey')) {
+ $params['domain'] = is_array($extensionKey) ? $extensionKey : [$extensionKey, NULL];
+ }
+ return _ts($text, $params);
}
- return _ts($text, $params);
}
diff --git a/CRM/Core/Smarty/plugins/block.url.php b/CRM/Core/Smarty/plugins/block.url.php
index 71814af2a1b1..890d9d20b42e 100644
--- a/CRM/Core/Smarty/plugins/block.url.php
+++ b/CRM/Core/Smarty/plugins/block.url.php
@@ -34,10 +34,13 @@
* Contents of block.
* @param CRM_Core_Smarty $smarty
* The Smarty object.
+ * @param bool $repeat
+ * Repeat is true for the opening tag, false for the closing tag
+ *
* @return string
*/
-function smarty_block_url($params, $text, &$smarty) {
- if ($text === NULL) {
+function smarty_block_url($params, $text, &$smarty, &$repeat) {
+ if ($repeat || $text === NULL) {
return NULL;
}
diff --git a/CRM/Core/Smarty/plugins/function.help.php b/CRM/Core/Smarty/plugins/function.help.php
index 754d2ec401ed..a7010ef8edde 100644
--- a/CRM/Core/Smarty/plugins/function.help.php
+++ b/CRM/Core/Smarty/plugins/function.help.php
@@ -27,12 +27,12 @@
* the help html to be inserted
*/
function smarty_function_help($params, &$smarty) {
- if (!isset($params['id']) || !isset($smarty->_tpl_vars['config'])) {
+ if (!isset($params['id']) || !isset($smarty->get_template_vars()['config'])) {
return NULL;
}
- if (empty($params['file']) && isset($smarty->_tpl_vars['tplFile'])) {
- $params['file'] = $smarty->_tpl_vars['tplFile'];
+ if (empty($params['file']) && isset($smarty->get_template_vars()['tplFile'])) {
+ $params['file'] = $smarty->get_template_vars()['tplFile'];
}
elseif (empty($params['file'])) {
return NULL;
@@ -43,7 +43,6 @@ function smarty_function_help($params, &$smarty) {
if (empty($params['title'])) {
$vars = $smarty->get_template_vars();
- $smarty->assign('id', $params['id'] . '-title');
// The way this works is a bit bonkers. All the .hlp files are expecting an
// assign called $params (which is different from our php var here called
@@ -52,14 +51,16 @@ function smarty_function_help($params, &$smarty) {
// that we return at the bottom below). But right now when we fetch the
// file on the next line, there is no params. So it gives a notice. So
// let's assign something.
+ // We also need to assign the id for the title we are looking for, which
+ // will not be present in Smarty 3 otherwise.
// It's also awkward since the ONLY reason we're fetching the file
// now is to get the help section's title and we don't care about the rest
// of the file, but that is a bit of a separate issue.
- $temporary_vars = [];
+ $temporary_vars = ['id' => $params['id'] . '-title'];
if (!array_key_exists('params', $vars)) {
// In the unlikely event that params already exists, we don't want to
// overwrite it, so only do this if not already set.
- $temporary_vars = ['params' => []];
+ $temporary_vars += ['params' => []];
}
// Note fetchWith adds the temporary ones to the existing scope but then
// will reset, unsetting them if not already present before, which is what
diff --git a/CRM/Core/Smarty/plugins/modifier.smarty.php b/CRM/Core/Smarty/plugins/modifier.smarty.php
new file mode 100644
index 000000000000..000e87ecf3bb
--- /dev/null
+++ b/CRM/Core/Smarty/plugins/modifier.smarty.php
@@ -0,0 +1,45 @@
+assign_var` to
+ * `$smarty->assignVar()`
+ * 2) if someone adds the Smarty3 package onto their site and
+ * defines CIVICRM_SMARTY3_AUTOLOAD_PATH then Smarty3 will load from that
+ * location.
+ *
+ * Note that experimenting with `CIVICRM_SMARTY3_AUTOLOAD_PATH` will not
+ * go well if extensions are installed that have not run civix upgrade
+ * somewhat recently (ie have the old version of the hook_civicrm_config
+ * with reference to `$template =& CRM_Core_Smarty::singleton();`
+ */
+
+/**
+ * Fix for bug CRM-392. Not sure if this is the best fix or it will impact
+ * other similar PEAR packages. doubt it
+ */
+if (!class_exists('Smarty')) {
+ if (defined('CIVICRM_SMARTY3_AUTOLOAD_PATH')) {
+ // @todo - this is experimental but it allows someone to
+ // get Smarty3 to load instead of Smarty2 if set.
+ // It is likely the final Smarty3 solution will look
+ // different but this makes testing possible without re-inventing
+ // it each time we try...
+ require_once CIVICRM_SMARTY3_AUTOLOAD_PATH;
+ }
+ else {
+ require_once 'Smarty/Smarty.class.php';
+ }
+}
+
+/**
+ *
+ */
+class CRM_Core_SmartyCompatibility extends Smarty {
+
+ public function loadFilter($type, $name) {
+ if (method_exists(get_parent_class(), 'load_filter')) {
+ parent::load_filter($type, $name);
+ return;
+ }
+ parent::loadFilter($type, $name);
+ }
+
+ /**
+ * @deprecated
+ *
+ * @param string $type
+ * @param string $name
+ *
+ * @throws \SmartyException
+ */
+ public function load_filter($type, $name) {
+ if (method_exists(get_parent_class(), 'load_filter')) {
+ parent::load_filter($type, $name);
+ return;
+ }
+ parent::loadFilter($type, $name);
+ }
+
+ /**
+ * Registers modifier to be used in templates
+ *
+ * @deprecated
+ *
+ * @param string $modifier name of template modifier
+ * @param string $modifier_impl name of PHP function to register
+ */
+ public function register_modifier($modifier, $modifier_impl) {
+ if (method_exists(get_parent_class(), 'register_modifier')) {
+ parent::register_modifier($modifier, $modifier_impl);
+ return;
+ }
+ parent::registerPlugin('modifier', $modifier, $modifier_impl);
+ }
+
+ public function registerPlugin($type, $name, $callback, $cacheable = TRUE, $cache_attr = NULL) {
+ if (method_exists(get_parent_class(), 'registerPlugin')) {
+ parent::registerPlugin($type, $name, $callback, $cacheable = TRUE, $cache_attr = NULL);
+ return;
+ }
+ if ($type === 'modifier') {
+ parent::register_modifier($name, $callback);
+ }
+ }
+
+ /**
+ * Registers a resource to fetch a template
+ *
+ * @param string $type name of resource
+ * @param array $functions array of functions to handle resource
+ */
+ public function register_resource($type, $functions) {
+ if (method_exists(get_parent_class(), 'register_resource')) {
+ parent::register_resource($type, $functions);
+ return;
+ }
+ parent::registerResource($type, $functions);
+ }
+
+ /**
+ * Registers custom function to be used in templates
+ *
+ * @param string $function the name of the template function
+ * @param string $function_impl the name of the PHP function to register
+ * @param bool $cacheable
+ * @param null $cache_attrs
+ *
+ * @throws \SmartyException
+ */
+ public function register_function($function, $function_impl, $cacheable = TRUE, $cache_attrs = NULL) {
+ if (method_exists(get_parent_class(), 'register_function')) {
+ parent::register_function($function, $function_impl, $cacheable = TRUE, $cache_attrs = NULL);
+ return;
+ }
+ parent::registerPlugin('function', $function, $function, $cacheable, $cache_attrs);
+ }
+
+ /**
+ * Returns an array containing template variables
+ *
+ * @param string $name
+ *
+ * @return array
+ */
+ public function &get_template_vars($name = NULL) {
+ if (method_exists(get_parent_class(), 'get_template_vars')) {
+ return parent::get_template_vars($name);
+ }
+ $var = parent::getTemplateVars($name);
+ return $var;
+ }
+
+ /**
+ * Returns a single or all template variables
+ *
+ * @api Smarty::getTemplateVars()
+ * @link http://www.smarty.net/docs/en/api.get.template.vars.tpl
+ *
+ * @param string $varName variable name or NULL
+ * @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $_ptr optional pointer to data object
+ * @param bool $searchParents include parent templates?
+ *
+ * @return mixed variable value or or array of variables
+ */
+ public function getTemplateVars($varName = NULL, Smarty_Internal_Data $_ptr = NULL, $searchParents = TRUE) {
+ if (method_exists(get_parent_class(), 'getTemplateVars')) {
+ return parent::getTemplateVars($varName . $_ptr, $searchParents);
+ }
+ return parent::get_template_vars($varName);
+ }
+
+ /**
+ * Generally Civi mis-uses this for perceived php4 conformance, avoid.
+ *
+ * @deprecated
+ * @param string $tpl_var
+ * @param mixed $value
+ *
+ * @return mixed|null|void
+ */
+ public function assign_by_ref($tpl_var, &$value) {
+ if (method_exists(get_parent_class(), 'assign_by_ref')) {
+ parent::assign_by_ref($tpl_var, $value);
+ return;
+ }
+ return parent::assignByRef($tpl_var, $value);
+ }
+
+ /**
+ * Generally Civi mis-uses this for perceived php4 conformance, avoid.
+ *
+ * @deprecated
+ * @param string $tpl_var
+ *
+ * @return mixed|null|void
+ */
+ public function clear_assign($tpl_var) {
+ if (method_exists(get_parent_class(), 'clear_assign')) {
+ parent::clear_assign($tpl_var);
+ return;
+ }
+ return parent::clearAssign($tpl_var);
+ }
+
+ /**
+ * Checks whether requested template exists.
+ *
+ * @param string $tpl_file
+ *
+ * @return bool
+ * @throws \SmartyException
+ */
+ public function template_exists($tpl_file) {
+ if (method_exists(get_parent_class(), 'template_exists')) {
+ return parent::template_exists($tpl_file);
+ }
+ return parent::templateExists($tpl_file);
+ }
+
+ /**
+ * Check if a template resource exists
+ *
+ * @param string $resource_name template name
+ *
+ * @return bool status
+ * @throws \SmartyException
+ */
+ public function templateExists($resource_name) {
+ if (method_exists(get_parent_class(), 'templateExists')) {
+ return parent::templateExists($resource_name);
+ }
+ return parent::template_exists($resource_name);
+ }
+
+}
diff --git a/CRM/Core/xml/Menu/Contact.xml b/CRM/Core/xml/Menu/Contact.xml
index ed81f2bc8273..5de7c2814364 100644
--- a/CRM/Core/xml/Menu/Contact.xml
+++ b/CRM/Core/xml/Menu/Contact.xml
@@ -176,12 +176,6 @@
Smart Groups
CRM_Contact_Page_View_ContactSmartGroup
-