docs: add comments to Config\Filters

codeigniter4 · Nov 5, 2023 · 19271ee · 19271ee
1 parent 1f5472a
commit 19271ee
Showing 1 changed file with 11 additions and 6 deletions.
diff --git a/app/Config/Filters.php b/app/Config/Filters.php
@@ -38,17 +38,22 @@ class Filters extends BaseConfig
      * The filters listed here are special. They are applied before and after
      * other kinds of filters, and always applied even if a route does not exist.
      *
-     * @var array<string, array<int, string>>
+     * Filters set by default provide framework functionality. If removed,
+     * those functions will no longer work.
+     *
+     * @see https://codeigniter.com/user_guide/incoming/filters.html#provided-filters
+     *
+     * @var array<string, list<string>>
      */
     public array $required = [
         'before' => [
-            'forcehttps',
-            'pagecache',
+            'forcehttps', // Force Global Secure Requests
+            'pagecache',  // Web Page Caching
         ],
         'after' => [
-            'pagecache',
-            'performance',
-            'toolbar',
+            'pagecache',   // Web Page Caching
+            'performance', // Performance Metrics
+            'toolbar',     // Debug Toolbar
         ],
     ];