Rename timeline items hook (#18758)

* rename timeline items hook * readd old constant * restore old name * Add deprecation --------- Co-authored-by: Cédric Anne <[email protected]>
glpi-project · Jan 27, 2025 · cde67f0 · cde67f0
1 parent 962ae5d
commit cde67f0
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -227,6 +227,7 @@ The present file will list all changes made to the project; according to the
 - `Search::getOptions()` no longer returns a reference.
 - The `$target` parameter has been removed from the `AuthLDAP::showLdapGroups()` method.
 - The `$target` parameter has been removed from the `Rule::showRulePreviewCriteriasForm()`, `Rule::showRulePreviewResultsForm()`, `RuleCollection::showRulesEnginePreviewCriteriasForm()`, and `RuleCollection::showRulesEnginePreviewResultsForm()` methods signature.
+- `Hooks::SHOW_IN_TIMELINE`/`show_in_timeline` plugin hook has been renamed to `Hooks::TIMELINE_ITEMS`/`timeline_items`.
 
 #### Deprecated
 - Usage of the `/marketplace` path for plugins URLs. All plugins URLs should now start with `/plugins`.

diff --git a/src/CommonITILObject.php b/src/CommonITILObject.php
@@ -7888,7 +7888,8 @@ class_exists($validation_class) && $params['with_validations']
             ];
         }
 
-        Plugin::doHook(Hooks::SHOW_IN_TIMELINE, ['item' => $this, 'timeline' => &$timeline]);
+        Plugin::doHook(Hooks::SHOW_IN_TIMELINE, ['item' => $this, 'timeline' => &$timeline]); // @phpstan-ignore classConstant.deprecated
+        Plugin::doHook(Hooks::TIMELINE_ITEMS, ['item' => $this, 'timeline' => &$timeline]);
 
         //sort timeline items by date. If items have the same date, sort by id
         $reverse = $params['sort_by_date_desc'];

diff --git a/src/Glpi/Plugin/Hooks.php b/src/Glpi/Plugin/Hooks.php
@@ -125,7 +125,11 @@ class Hooks
     const PRE_ITEM_LIST           = 'pre_item_list';
     const TIMELINE_ACTIONS        = 'timeline_actions';  // (keys: item, rand)
     const TIMELINE_ANSWER_ACTIONS = 'timeline_answer_actions';  // (keys: item)
-    const SHOW_IN_TIMELINE        = 'show_in_timeline';  // (keys: item)
+    /**
+     * @deprecated 11.0.0 Use `TIMELINE_ITEMS` instead.
+     */
+    const SHOW_IN_TIMELINE        = 'show_in_timeline';
+    const TIMELINE_ITEMS          = 'timeline_items';  // (keys: item)
     const SET_ITEM_IMPACT_ICON    = 'set_item_impact_icon'; // (keys: itemtype, items_id)
 
    // Security hooks (data to encypt)

diff --git a/src/Plugin.php b/src/Plugin.php
@@ -1537,6 +1537,10 @@ public static function doHook($name, $param = null)
                         continue;
                     }
 
+                    if ($name === Hooks::SHOW_IN_TIMELINE) { // @phpstan-ignore classConstant.deprecated
+                        Toolbox::deprecated('`show_in_timeline` hook is deprecated, use `timeline_items` instead.');
+                    }
+
                     if (isset($tab[$itemtype])) {
                         \Glpi\Debug\Profiler::getInstance()->start("{$plugin_key}:{$name}", \Glpi\Debug\Profiler::CATEGORY_PLUGINS);
                         self::includeHook($plugin_key);