Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Case Activity: use select2 for Medium field #27879

Merged
merged 1 commit into from
Oct 22, 2023

Conversation

mlutfy
Copy link
Member

@mlutfy mlutfy commented Oct 22, 2023

Overview

Uses select2 for the "Medium" field on Case Activities. This makes it more consistent with other select fields.

Before

image

After

image

Comments

I did a bit of cleanup because it seemed weird.

@civibot
Copy link

civibot bot commented Oct 22, 2023

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers...

➡️ Online demo of this PR 🔗

@civibot civibot bot added the master label Oct 22, 2023
@@ -203,6 +203,10 @@ public function setDefaultValues() {
}
$this->assign('targetContactValues', empty($targetContactValues) ? FALSE : $targetContactValues);

if ($this->_activityId) {
$this->_encounterMedium = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $this->_activityId, 'medium_id');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an undeclared property of the class so will cause warnings in php8. Why are we even setting it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm yep - previously the variable was being set from buildQuickForm() and only used once in setDefaultValues(), so I moved it to setDefaultValues.

I updated my PR to simplify the code further. All these shenanigans around encounterMediums were odd, there is nothing special about this field.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shenanigans

Good word for it!

Comment on lines 206 to 208
if ($this->_activityId) {
$this->_defaults['medium_id'] = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $this->_activityId, 'medium_id');
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't even know why this shenanigan still exists. Why wouldn't this value be set along with all the others by the call to parent::setDefaultValues() above?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no medium on regular activities.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The field exists though so shouldn't it be populated?

<field>
<name>medium_id</name>
<uniqueName>activity_medium_id</uniqueName>
<title>Activity Medium</title>
<type>int unsigned</type>
<default>NULL</default>
<comment>Activity Medium, Implicit FK to civicrm_option_value where option_group = encounter_medium.</comment>
<pseudoconstant>
<optionGroupName>encounter_medium</optionGroupName>
</pseudoconstant>
<html>
<type>Select</type>
</html>
<add>2.2</add>
</field>

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just saying that's why it's not unexpected to see encounter_medium code here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested on a site and it does seem to work without those lines of code ($this->_defaults['medium_id'] = ..)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the code and it certainly looks like the lines aren't needed. The setDefaultValues function does a pretty standard DAO->find(TRUE) and CRM_Core_DAO::storeValues() which is basically like SELECT *.

So it should work without it, and it does work without it. Let's remove it :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I had a side-quest (joys of numeric custom fields), and now updated this PR to remove it.

@demeritcowboy
Copy link
Contributor

jenkins retest this please

@demeritcowboy demeritcowboy merged commit 5843344 into civicrm:master Oct 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants