Skip to content

docs(ActionWebhook): Improve phpdoc for ExecuteResponseHandler #25

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.

Sign up for GitHub

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

Merged
jf-cbd merged 1 commit into from
May 19, 2025
Merged

docs(ActionWebhook): Improve phpdoc for ExecuteResponseHandler #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/Core/Notification/Action/_ActionWebhook.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@ abstract class _ActionWebhook extends ActionNotification
* Default WebResponse handler for a WebRequest made by an _ActionWebhook
*
* @param \Combodo\iTop\Core\WebResponse $oResponse
* @param array $aParams Parameters of the handler, must contain at least the triggering object and activated webhook action information:
* [
* 'oTriggeringObject' => ['class' => <CLASS>, 'id' => <ID>],
* 'oActionWebhook' => ['class' => <CLASS>, 'id' => <ID>],
* ]
* @param array{
* oActionWebhook: array{class: string, id: int},
* oTriggeringObject: \DBObject|array{class: string, id: int},
* } $aParams Parameters of the handler, must contain at least the triggering object and activated webhook action information
*
* @throws \ArchivedObjectException
* @throws \CoreException
Expand All @@ -42,6 +41,7 @@ public static function ExecuteResponseHandler(WebResponse $oResponse, array $aPa
]);
throw new Exception('Missing parameters in response handler. See error log for details.');
}
/** @var \DBObject $oTriggeringObject */
$oTriggeringObject = is_object($aParams['oTriggeringObject']) ?
$aParams['oTriggeringObject'] :
MetaModel::GetObject($aParams['oTriggeringObject']['class'], $aParams['oTriggeringObject']['id'], true, true);
Expand Down