From 822c4c7e6ca9a7d3b296aa3bee1eb46af6885481 Mon Sep 17 00:00:00 2001 From: Yonas Habteab Date: Wed, 26 Jul 2023 15:46:07 +0200 Subject: [PATCH] Extend `sendExtraUpdates()` doc blocks --- src/Compat/CompatController.php | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/Compat/CompatController.php b/src/Compat/CompatController.php index 8514457a..72f33481 100644 --- a/src/Compat/CompatController.php +++ b/src/Compat/CompatController.php @@ -388,8 +388,11 @@ public function sendMultipartUpdate(BaseHtmlElement ...$additionalControls) * Instruct the client to side-load additional updates * * If an item in the given array is indexed by an integer, its value will be used by the client to refresh - * the parent of the element identified by it. If indexed by a string, the client will use this index to - * identify a container (by id) and will use the value (a URL) to load content into it. + * the parent of the element identified by it. The value is expected to be a valid CSS selector such + * as `.foo`, `#foo`. If indexed by a string, the client will use this index to identify a container (by id) and + * will use the value (a URL) to load content into it. Since Icinga Web >= 2.12, the indices can be specified with + * or without the `#` indicator. If you require compatibility with older Icinga Web versions, you have to specify + * the indices (container ids) without the `#` char. * * @param array $updates *