Adds constants to LWT and its API that declare their version.

See issue #163 for details.
HugoFara · Dec 29, 2023 · 897235b · 897235b
1 parent b56b7c2
commit 897235b
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 9 deletions.
diff --git a/api.php b/api.php
@@ -14,6 +14,16 @@
 require_once __DIR__ . '/inc/ajax_edit_impr_text.php';
 
 
+/**
+ * @var string Version of this current LWT API.
+ */
+define('LWT_API_VERSION', "0.1.1");
+
+/**
+ * @var string Date of the last released change of the LWT API. 
+ */
+define('LWT_API_RELEASE_DATE', "2023-12-29");
+
 /**
  * Send JSON response and exit.
  * 
@@ -126,8 +136,8 @@ function endpoint_exits($method, $requestUri)
 function rest_api_version($get_req): array
 {
     return array(
-        "version"      => "0.1.1",
-        "release_date" => "2023-12-29"
+        "version"      => LWT_API_VERSION,
+        "release_date" => LWT_API_RELEASE_DATE
     );
 }
 

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -10,6 +10,9 @@ ones are marked like "v1.0.0-fork".
 ### Added
 
 * `unloadformcheck.js` no declares a new object `lwt_form_check` that contains all the functions needed.
+* New globals ([#163](https://github.com/HugoFara/lwt/issues/163)):
+  * On `inc/kernel_utility.php`: `LWT_APP_VERSION` and `LWT_RELEASE_DATE`.
+  * On `api.php`: `LWT_API_VERSION` and `LWT_API_RELEASE_DATE`.
 
 ### Fixed
 

diff --git a/docs/info.html b/docs/info.html
@@ -234,7 +234,7 @@ <h2 name="current" id="current">
 			</h2>
 
 			<p>
-				The current version is 2.9.1-fork (December 29 2023).
+				The current version is 2.9.1-fork (December 29, 2023).
 				<br>
 				<a href="#CHANGELOG">View the Changelog.</a>
 			</p>
@@ -2187,6 +2187,12 @@ <h4>Added</h4>
 <ul>
 <li>
 <code>unloadformcheck.js</code> no declares a new object <code>lwt_form_check</code> that contains all the functions needed.</li>
+<li>New globals (<a href="https://github.com/HugoFara/lwt/issues/163">#163</a>):
+<ul>
+<li>On <code>inc/kernel_utility.php</code>: <code>LWT_APP_VERSION</code> and <code>LWT_RELEASE_DATE</code>.</li>
+<li>On <code>api.php</code>: <code>LWT_API_VERSION</code> and <code>LWT_API_RELEASE_DATE</code>.</li>
+</ul>
+</li>
 </ul>
 <h4>Fixed</h4>
 <ul>

diff --git a/inc/kernel_utility.php b/inc/kernel_utility.php
@@ -14,6 +14,15 @@
 
  require __DIR__ . '/settings.php';
 
+/**
+ * @var string Version of this current LWT application.
+ */
+ define('LWT_APP_VERSION', '2.9.1-fork');
+
+ /**
+  * @var string Date of the last published release of LWT 
+  */
+ define('LWT_RELEASE_DATE', "2023-12-29");
 
 /**
  * Return LWT version for humans
@@ -30,9 +39,8 @@
 function get_version(): string 
 {
     global $debug;
-    $release_number = '2.9.1-fork';
-    $release_date = 'December 29 2023';
-    $version = "$release_number ($release_date)"; 
+    $formattedDate = date("F d Y", strtotime(LWT_RELEASE_DATE));
+    $version = LWT_APP_VERSION . " ($formattedDate)"; 
     if ($debug) {
         $version .= ' <span class="red">DEBUG</span>';
     }
@@ -548,11 +556,10 @@ function annotation_to_json($ann): string|false
  */
 function getreq($s) 
 {
-    if (isset($_REQUEST[$s]) ) {
+    if (isset($_REQUEST[$s])) {
         return trim($_REQUEST[$s]);
-    } else {
-        return ''; 
     }
+    return '';
 }
 
 /**