Make hook_civicrm_pre() and hook_civicrm_post() fire on CaseContacts

[aydun]

Overview

Make hook_civicrm_pre() and hook_civicrm_post() fire on CaseContacts

Before

Modifications to CaseContacts do not trigger hook_civicrm_pre() or hook_civicrm_post()

After

Modifications to CaseContacts do trigger hook_civicrm_pre() or hook_civicrm_post()

Technical Details

Based on CRM_Core_BAO_Dashboard::create() as advised on https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_post/

Documentation PR will follow once code merged.

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[demeritcowboy]

• General standards
  • [r-explain] PASS
  • [r-user] PASS
  • [r-doc] COMMENTS Since CaseContact isn't a first-class object and only exists because of the way the many-to-many relationship is modelled and exposed in civi, "create" and "edit" have a slightly different meaning here. They are more like "link" and "re-link". In other words, what you're hooking on is the event when a case object gets linked to a client contact object or vice-versa. No actual first-class object is being created/edited.
  • [r-run] PASS I tested this by making a little extension that logs the pre and post hook input and then created a case. It all looks right. I also tested via api explorer since I wasn't even sure how to test the "edit" otherwise. For example reassign case doesn't seem to use the object/hook, and even if it did that action actually creates a new case and a new linkage.
• Developer standards
  • [r-tech] PASS
  • [r-code] PASS
  • [r-maint] COMMENTS I'm not sure how you'd write a test for hooks.
  • [r-test] PASS

[MegaphoneJon]

@aydun @demeritcowboy I had to learn how to test hooks recently :) An example is in tests/phpunit/CRM/Contribute/Form/Task/PDFLetterCommonTest.php, testing that hook_civicrm_tokenValues works correctly on PDF letters.

You write a function using the hook, but you can name it whatever you want. Then you call $this->hookClass->setHook, specifying the function name.

[demeritcowboy]

@MegaphoneJon Ah cool. Do you want to post that as answer to this SE question? https://civicrm.stackexchange.com/questions/25795/how-to-write-php-unit-test-for-an-entity-using-hooks

[mattwire]

Tested by @demeritcowboy This is a standard hook with standard parameters added in a "standard" way so we can skip a unit test.

[mattwire]

@aydun Please follow up with docs PR and I'll merge