COMCL-167: Accept multiple types argument #838
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lisandro-compucorp
previously approved these changes
Jan 12, 2022
$apiRequest parameter can be passed as array or Civi\Api4\Generic\AbstractAction according to https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_apiWrappers/ therefore the function must be able to handle multiple types argument.
erawat
force-pushed
the
COMCL-167-searchkit-error
branch
2 times, most recently
from
ef10045 to
6d189aa
Compare
|
@lisandro-compucorp I have rebased this branch with the master branch after the linter action was fixed and merged from this PR #839 I have also added a new commit that fixed the linter, can you re-review this PR again? |
Fix - The array content should be split up over multiple lines
erawat
force-pushed
the
COMCL-167-searchkit-error
branch
from
6d189aa to
4c3a4d8
Compare
lisandro-compucorp
approved these changes
Jan 14, 2022
This was referenced Jan 25, 2022
Closed
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR fixes the issue when the site throws an error when accessing SearchKit menu.
Before
After
Technical Details
When using SearchKit function, the APIWrapper hook get called and API v4 object is passed to $apiRequest, and CiviCase implements apiWrappers hook, and the implementation only accept a parameter as an array, hence, PHP throws the error.
According to https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_apiWrappers/ $apiRequest parameter can be passed as array or Civi\Api4\Generic\AbstractAction therefore the function must be able to handle multiple types argument.
Note on the CiviCase's API Wrapper hook, the implementation mainly handle an array and this should not be any issue as the Civi\Api4\Generic\AbstractAction class has implemented ArrayAccess interface that allow to access object's properties as an array.
See https://github.com/civicrm/civicrm-core/blob/5.39/Civi/Api4/Generic/AbstractAction.php#L43
Comment
Note that there is an issue when installing NODE JS, so the linter is not running probably which should be dealt with separately as it is not relevant to this PR.