From 10aae0a9f29043c33bb4a03d53746883dea3e505 Mon Sep 17 00:00:00 2001
From: Brian Rogers <captbrogers@gmail.com>
Date: Thu, 15 Sep 2022 10:45:04 -0600
Subject: [PATCH] adding some comment headers to constants and global functions

---
 src/helpers/constants/cache_ttl.php         | 10 ++++++++++
 src/helpers/constants/http_status_codes.php | 10 ++++++++++
 src/helpers/global_functions.php            | 10 ++++++++++
 3 files changed, 30 insertions(+)

diff --git a/src/helpers/constants/cache_ttl.php b/src/helpers/constants/cache_ttl.php
index 638d0ba..2e954f1 100644
--- a/src/helpers/constants/cache_ttl.php
+++ b/src/helpers/constants/cache_ttl.php
@@ -1,5 +1,15 @@
 <?php
 
+/*
+|--------------------------------------------------------------------------
+| Cache TTL (Time-To-Live)
+|--------------------------------------------------------------------------
+|
+| Here is a collection of intervals in seconds that are commong to use
+| when caching, but written as a more human-friendly phrase.
+|
+*/
+
 define('CACHE_TTL_FIVE_MINUTES', 300);
 define('CACHE_TTL_FIFTEEN_MINUTES', 900);
 
diff --git a/src/helpers/constants/http_status_codes.php b/src/helpers/constants/http_status_codes.php
index 29eb11d..6b2e637 100644
--- a/src/helpers/constants/http_status_codes.php
+++ b/src/helpers/constants/http_status_codes.php
@@ -1,5 +1,15 @@
 <?php
 
+/*
+|--------------------------------------------------------------------------
+| HTTP Status Codes
+|--------------------------------------------------------------------------
+|
+| Here is a collection of HTTP status codes and a corresponding string
+| that is human-friendly and easy to remember.
+|
+*/
+
 $httpCodes = [
     // 100's (informational / "hold on")
     100 => 'HTTP_CONTINUE',
diff --git a/src/helpers/global_functions.php b/src/helpers/global_functions.php
index 4b795a6..6b927aa 100644
--- a/src/helpers/global_functions.php
+++ b/src/helpers/global_functions.php
@@ -1,5 +1,15 @@
 <?php
 
+/*
+|--------------------------------------------------------------------------
+| Global Functions
+|--------------------------------------------------------------------------
+|
+| This is a home for functions that don't belong to any one class and
+| that should be available anywhere in the application.
+|
+*/
+
 if (! function_exists('snake2Title')) {
     /**
      * Convert a snake case string to a title with spaces