CRM-20459: Actively deprecate CRM_Core_OptionGroup::getValue[Sub PR 1] #12049

monishdeb · 2018-04-29T06:14:52Z

Overview

This function is deprecated and needs to be replaced by respective function in CRM_Core_Pseudoconstant. This PR is all about this replacement.

This is a sub PR of #12041

CRM-20459: Actively deprecate CRM_Core_OptionGroup::getValue

monishdeb · 2018-04-29T07:14:02Z

CRM/Badge/BAO/Layout.php

@@ -92,7 +92,7 @@ public static function create(&$params) {
    $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
    $params['is_reserved'] = CRM_Utils_Array::value('is_reserved', $params, FALSE);

-    $params['label_type_id'] = CRM_Core_OptionGroup::getValue('label_type', 'Event Badge', 'name');
+    $params['label_type_id'] = CRM_Core_PseudoConstant::getKey('CRM_Core_DAO_PrintLabel', 'label_type_id', 'Event Badge');


Cannot be changed to CRM_Core_DAO_PrintLabel as the class don't exist

OK - I have tested this line through the civicrm/admin/badgelayout?action=add&reset=1 screen

eileenmcnaughton · 2018-04-29T08:16:43Z

CRM/Badge/BAO/Layout.php

@@ -162,7 +162,8 @@ public static function buildLayout(&$params) {
    $layoutParams = array('id' => $params['badge_id']);
    CRM_Badge_BAO_Layout::retrieve($layoutParams, $layoutInfo);

-    $formatProperties = CRM_Core_OptionGroup::getValue('name_badge', $layoutInfo['label_format_name'], 'name');
+    $formatProperties = CRM_Core_PseudoConstant::getKey('CRM_Core_DAO_PrintLabel', 'name_badge', $layoutInfo['label_format_name']);
+


I tested this & it actually needs to be

$formatProperties = CRM_Core_PseudoConstant::getKey('CRM_Core_DAO_PrintLabel', 'label_format_name', $layoutInfo['label_format_name']);

@eileenmcnaughton oops my bad .. just updated

eileenmcnaughton · 2018-04-29T08:18:50Z

CRM/Campaign/BAO/Petition.php

@@ -94,7 +94,7 @@ public static function getPetitionSummary($params = array(), $onlyCount = FALSE)

    //we only have activity type as a
    //difference between survey and petition.
-    $petitionTypeID = CRM_Core_OptionGroup::getValue('activity_type', 'petition', 'name');
+    $petitionTypeID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Petition');


Ok this activity type pattern is really common & familiar so I have just checked that the the value is the value in the relevant 'name' field & it is

eileenmcnaughton · 2018-04-29T08:19:09Z

CRM/Campaign/BAO/Petition.php

@@ -160,7 +160,7 @@ public static function getPetitionSummary($params = array(), $onlyCount = FALSE)
  public static function getPetitionCount() {
    $whereClause = 'WHERE ( 1 )';
    $queryParams = array();
-    $petitionTypeID = CRM_Core_OptionGroup::getValue('activity_type', 'petition', 'name');
+    $petitionTypeID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Petition');


this one looks the same as above & fine

eileenmcnaughton · 2018-04-29T08:19:14Z

CRM/Campaign/BAO/Survey.php

@@ -167,7 +167,7 @@ public static function getSurveySummary($params = array(), $onlyCount = FALSE) {

    //we only have activity type as a
    //difference between survey and petition.
-    $petitionTypeID = CRM_Core_OptionGroup::getValue('activity_type', 'petition', 'name');
+    $petitionTypeID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Petition');


eileenmcnaughton · 2018-04-29T08:20:31Z

CRM/Campaign/Form/Survey/Results.php

@@ -434,7 +434,7 @@ public function postProcess() {
        'street_unit',
        'survey_response',
      );
-      if (CRM_Core_OptionGroup::getValue('activity_type', 'WalkList') ==
+      if (CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'WalkList') ==


ok - although it would make more sense to be if (CRM_Core_PseudoConstant::getName.... ==== )
However, as is I think I can approve without replicating as this pattern on this field is well known

eileenmcnaughton · 2018-04-29T08:20:46Z

CRM/Campaign/Form/Survey/Results.php

@@ -456,14 +456,14 @@ public function postProcess() {
          ),
        );
      }
-      elseif (CRM_Core_OptionGroup::getValue('activity_type', 'PhoneBank') ==
+      elseif (CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'PhoneBank') ==


eileenmcnaughton · 2018-04-29T08:21:06Z

CRM/Campaign/Form/Survey/Results.php

        $this->_values['activity_type_id']
      ) {
        array_push($displayFields, 'phone');
      }
-      elseif ((CRM_Core_OptionGroup::getValue('activity_type', 'Survey') ==
+      elseif ((CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Survey') ==


eileenmcnaughton · 2018-04-29T08:21:12Z

CRM/Campaign/Form/Survey/Results.php

          $this->_values['activity_type_id']) ||
-        (CRM_Core_OptionGroup::getValue('activity_type', 'Canvass') ==
+        (CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Canvass') ==
          $this->_values['activity_type_id'])


eileenmcnaughton · 2018-04-29T08:24:18Z

I've checked the first handful & marked those I've checked. I was find to do ones that fitted an existing pattern (CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', ) without testing all of them but I need to figure out somewhere to test the others I think

eileenmcnaughton · 2018-04-29T08:25:49Z

CRM/Badge/BAO/Layout.php

@@ -162,7 +162,8 @@ public static function buildLayout(&$params) {
    $layoutParams = array('id' => $params['badge_id']);
    CRM_Badge_BAO_Layout::retrieve($layoutParams, $layoutInfo);

-    $formatProperties = CRM_Core_OptionGroup::getValue('name_badge', $layoutInfo['label_format_name'], 'name');
+    $formatProperties = CRM_Core_PseudoConstant::getKey('CRM_Core_DAO_PrintLabel', 'label_format_name', $layoutInfo['label_format_name']);


I tested this via the 'Save and Preview' on the badge layout page

eileenmcnaughton · 2018-04-29T08:29:39Z

@monishdeb what say I figure out how to confirm the priority_id ones & you drop the others out of this PR to get it mergeable. TBH the pcp ones I doubt I am going to want to try to replicate.

eileenmcnaughton · 2018-04-30T07:22:07Z

CRM/Case/BAO/Case.php

@@ -1127,10 +1127,10 @@ public static function getCaseActivity($caseID, &$params, $contactID, $context =
      }

      if (!empty($dao->priority)) {
-        if ($dao->priority == CRM_Core_OptionGroup::getValue('priority', 'Urgent', 'name')) {
+        if ($dao->priority == CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Urgent')) {


OK - tested - need to view case tab & have some set priorities - & row colour results

eileenmcnaughton · 2018-04-30T07:22:19Z

CRM/Case/BAO/Case.php

          $caseActivity['DT_RowClass'] .= " priority-urgent ";
        }
-        elseif ($dao->priority == CRM_Core_OptionGroup::getValue('priority', 'Low', 'name')) {
+        elseif ($dao->priority == CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Low')) {


eileenmcnaughton · 2018-04-30T07:23:21Z

CRM/Case/Form/Activity/ChangeCaseStartDate.php

@@ -155,7 +155,7 @@ public static function endPostProcess(&$form, &$params, $activity) {

    $params['status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
    $activity->status_id = $params['status_id'];
-    $params['priority_id'] = CRM_Core_OptionGroup::getValue('priority', 'Normal', 'name');
+    $params['priority_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Normal');


OK - Checked against checked pattern & checked option value

eileenmcnaughton · 2018-04-30T07:23:34Z

CRM/Case/Form/Activity/ChangeCaseStatus.php

@@ -205,7 +205,7 @@ public static function endPostProcess(&$form, &$params, $activity) {
    }
    $params['status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
    $activity->status_id = $params['status_id'];
-    $params['priority_id'] = CRM_Core_OptionGroup::getValue('priority', 'Normal', 'name');
+    $params['priority_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Normal');


OK - Checked against checked pattern & checked option value

eileenmcnaughton · 2018-04-30T07:23:48Z

CRM/Case/Form/Activity/ChangeCaseType.php

@@ -160,7 +160,7 @@ public static function endPostProcess(&$form, &$params, $activity) {

    $params['status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
    $activity->status_id = $params['status_id'];
-    $params['priority_id'] = CRM_Core_OptionGroup::getValue('priority', 'Normal', 'name');
+    $params['priority_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Normal');


OK - Checked against checked pattern & checked option value

eileenmcnaughton · 2018-04-30T07:24:56Z

CRM/Contribute/BAO/ContributionSoft.php

@@ -85,7 +85,7 @@ public static function processSoftContribution($params, $contribution) {
      $softParams['pcp_display_in_roll'] = CRM_Utils_Array::value('pcp_display_in_roll', $pcp);
      $softParams['pcp_roll_nickname'] = CRM_Utils_Array::value('pcp_roll_nickname', $pcp);
      $softParams['pcp_personal_note'] = CRM_Utils_Array::value('pcp_personal_note', $pcp);
-      $softParams['soft_credit_type_id'] = CRM_Core_OptionGroup::getValue('soft_credit_type', 'pcp', 'name');
+      $softParams['soft_credit_type_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', 'pcp');


OK - checked this in the course of doing a reviewer's commit on #12044

eileenmcnaughton · 2018-04-30T07:26:01Z

CRM/Contribute/BAO/ContributionSoft.php

@@ -149,7 +149,7 @@ public static function formatSoftCreditParams(&$params, &$form) {
      $honorId = NULL;

      // @todo fix use of deprecated function.
-      $contributionSoftParams['soft_credit_type_id'] = CRM_Core_OptionGroup::getValue('soft_credit_type', 'pcp', 'name');
+      $contributionSoftParams['soft_credit_type_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', 'pcp');


OK - based on this being identical to checked change above

eileenmcnaughton · 2018-04-30T07:27:46Z

@monishdeb I've checked & approved all of these except the very last one (CRM/Contribute/Form/Contribution/Confirm.php) - if you can drop that out we can merge the rest

monishdeb · 2018-04-30T08:31:06Z

Thanks @eileenmcnaughton I have moved the changes of Confirm.php to #12050

eileenmcnaughton · 2018-04-30T08:48:18Z

OK - this is good - there is a version of the Confirm changes in the PR fixing the pcp note field which is up for review so let's close that one for now - it's a lot of work to test so better to have it tested by someone who uses pcps!

civicrm-builder added the master label Apr 29, 2018

monishdeb mentioned this pull request Apr 29, 2018

CRM-20459: Actively deprecate CRM_Core_OptionGroup::getValue #12041

Closed

monishdeb force-pushed the CRM-20459-1 branch from 53c0769 to 2c8b98f Compare April 29, 2018 07:12

monishdeb commented Apr 29, 2018

View reviewed changes

eileenmcnaughton reviewed Apr 29, 2018

View reviewed changes

monishdeb force-pushed the CRM-20459-1 branch from 2c8b98f to 7d29e55 Compare April 29, 2018 08:23

eileenmcnaughton reviewed Apr 29, 2018

View reviewed changes

eileenmcnaughton reviewed Apr 30, 2018

View reviewed changes

CRM-20459: Actively dt eprecate CRM_Core_OptionGroup::getValue

0571e73

monishdeb force-pushed the CRM-20459-1 branch from 7d29e55 to 0571e73 Compare April 30, 2018 08:28

eileenmcnaughton added the merge on pass label Apr 30, 2018

eileenmcnaughton merged commit cf57b96 into civicrm:master Apr 30, 2018

monishdeb deleted the CRM-20459-1 branch April 30, 2018 12:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CRM-20459: Actively deprecate CRM_Core_OptionGroup::getValue[Sub PR 1] #12049

CRM-20459: Actively deprecate CRM_Core_OptionGroup::getValue[Sub PR 1] #12049

monishdeb commented Apr 29, 2018 •

edited by civicrm-builder

Loading

monishdeb Apr 29, 2018

eileenmcnaughton Apr 29, 2018

eileenmcnaughton Apr 29, 2018

monishdeb Apr 29, 2018

eileenmcnaughton Apr 29, 2018

eileenmcnaughton Apr 29, 2018

eileenmcnaughton Apr 29, 2018

eileenmcnaughton Apr 29, 2018

eileenmcnaughton Apr 29, 2018

eileenmcnaughton Apr 29, 2018

eileenmcnaughton Apr 29, 2018

eileenmcnaughton commented Apr 29, 2018

eileenmcnaughton Apr 29, 2018

eileenmcnaughton commented Apr 29, 2018

eileenmcnaughton Apr 30, 2018

eileenmcnaughton Apr 30, 2018

eileenmcnaughton Apr 30, 2018

eileenmcnaughton Apr 30, 2018

eileenmcnaughton Apr 30, 2018

eileenmcnaughton Apr 30, 2018

eileenmcnaughton Apr 30, 2018

eileenmcnaughton commented Apr 30, 2018

monishdeb commented Apr 30, 2018

eileenmcnaughton commented Apr 30, 2018

CRM-20459: Actively deprecate CRM_Core_OptionGroup::getValue[Sub PR 1] #12049

CRM-20459: Actively deprecate CRM_Core_OptionGroup::getValue[Sub PR 1] #12049

Conversation

monishdeb commented Apr 29, 2018 • edited by civicrm-builder Loading

Overview

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eileenmcnaughton commented Apr 29, 2018

Choose a reason for hiding this comment

eileenmcnaughton commented Apr 29, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eileenmcnaughton commented Apr 30, 2018

monishdeb commented Apr 30, 2018

eileenmcnaughton commented Apr 30, 2018

monishdeb commented Apr 29, 2018 •

edited by civicrm-builder

Loading