[GT-187] Add comment to give insight on variables.

GOCDB · Aug 31, 2023 · 2fce820 · 2fce820
1 parent 294ebd1
commit 2fce820
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/htdocs/web_portal/controllers/downtime/downtime_utils.php b/htdocs/web_portal/controllers/downtime/downtime_utils.php
@@ -44,6 +44,12 @@ function endpointToServiceMapping($impactedIDs)
      * sort between endpoints and services using the prepended letter.
      */
     foreach ($impactedIDs as $id) {
+        /**
+         * `$siteNumber` => It's about Site ID
+         * `$parentService` => It's about service ID endpoint belongs too
+         * `idType` => It's about to differentiate
+         *             the endpoint vs service selection.
+         */
         list($siteNumber, $parentService, $idType) = explode(':', $id);
 
         $type = strpos($idType, 's') !== false ? 'services' : 'endpoints';