From a3dc1f0f55003ca2fb325ed2e3f974094f6cad2e Mon Sep 17 00:00:00 2001
From: George Halkiadakis <gchalkiadakis@sklavenitis.co.gr>
Date: Thu, 25 May 2023 09:30:37 +0300
Subject: break form scripts in parts; first pdf example

---
 core/classes/Benchmark.php | 15 ++++++++++-----
 core/classes/Cart.php      |  4 +++-
 core/classes/Registry.php  | 17 ++++++++++-------
 core/classes/Route.php     |  8 ++++----
 4 files changed, 27 insertions(+), 17 deletions(-)

(limited to 'core')

diff --git a/core/classes/Benchmark.php b/core/classes/Benchmark.php
index 8aa040d..a8b4145 100644
--- a/core/classes/Benchmark.php
+++ b/core/classes/Benchmark.php
@@ -52,7 +52,8 @@ class Benchmark {
     /** add_timespot
      * ---
      * add new timespot
-     * @param $key : label of timespot
+     * 
+     * @param string $key : label of timespot
      */
     public static function add_spot(string $key)
     {
@@ -62,7 +63,10 @@ class Benchmark {
 
 
     /** exist
+     * ---
      * checks if a benchmark spot  with label $key exists 
+     * 
+     * @param string $key : label of timespot
      */
     public static function exist(string $key) : bool
     {
@@ -71,7 +75,8 @@ class Benchmark {
 
 
     /** desableReport
-     * (Self-explanatory)
+     * ---
+     * desables report exporting
      */
     public static function disableReport()
     {
@@ -84,7 +89,7 @@ class Benchmark {
      * renders performance report
      * as html comment at the end of webpage in various modes
      * 
-     * @param $mode (int): report format id
+     * @param int $mode: report format id
      * ... default: BENCH_REPORT_COMMENT (5) = report as html comment;
      * ... for more report-formats check the BENCH_REPORT_* defines
      */
@@ -198,9 +203,9 @@ class Benchmark {
 
             $output .= $suffix;
 
-        }
-        return $output;
+        } else { return; }
 
+        return $output;
     }
 
 }
diff --git a/core/classes/Cart.php b/core/classes/Cart.php
index 4e6f585..f90eab6 100644
--- a/core/classes/Cart.php
+++ b/core/classes/Cart.php
@@ -1,5 +1,7 @@
 <?php
-
+/** TODO:
+ * not implemented yet
+ */
 class Cart
 {
 
diff --git a/core/classes/Registry.php b/core/classes/Registry.php
index 119e2b9..02a1ec5 100644
--- a/core/classes/Registry.php
+++ b/core/classes/Registry.php
@@ -24,7 +24,7 @@ class Registry
      * -------------------------------------------------------------------------
      */
 
-    /** @var $records (array)
+    /** @var array $records
      * keeps all ready-to-use records
      * --- --- -- - - -
      * 
@@ -37,7 +37,7 @@ class Registry
      */
     private static $records = Array();
 
-    /** @var $wish (array)
+    /** @var array $wish
      * keeps all records that will be carried-out later (if ever) 
      * --- -- -- - - -
      * 
@@ -54,8 +54,8 @@ class Registry
      * --- -- -- - - -
      * store $data to the registry undel the label $key
      * 
-     * @param $key (string)
-     * @param $data *
+     * @param string $key
+     * @param mixed $data
      */
     static function set($key, $data)
     {
@@ -80,8 +80,8 @@ class Registry
      * get data from registry,
      * stored under the label $key
      * 
-     * @param $key (string): the label
-     * @return data (mixed)
+     * @param string $key : the label
+     * @return mixed data
      */
     static function get($key)
     {
@@ -107,7 +107,7 @@ class Registry
      * that a 'vow' will not use system resources to prepare
      * the data/object/handler/etc until/if-ever is called.
      * 
-     * @param $label (string): label / refference key
+     * @param string $label : label / refference key
      * @param function : 
      */
     static function vow($label, $function)
@@ -120,6 +120,9 @@ class Registry
      * ---
      * this is the method that carries out
      * the promissed function (with arguments)
+     * 
+     * @param string $label
+     * @param array $args
      */
     static function use($label, $args=[])
     {
diff --git a/core/classes/Route.php b/core/classes/Route.php
index 072723c..ab0a0a7 100644
--- a/core/classes/Route.php
+++ b/core/classes/Route.php
@@ -20,9 +20,9 @@ class Route {
 
     /** add (route)
      * ---
-     * @param $expression : (string) static or regex matcher
-     * @param $function : callback function to be executed if expression is matched
-     * @param $method : get / post / any
+     * @param string $expression : static or regex matcher
+     * @param callback $function : function to be executed if expression is matched
+     * @param string $method : get / post / any
      */
     public static function add( $expression, $function, $method = 'get' )
     {
@@ -36,7 +36,7 @@ class Route {
 
     /** notFound($function)
      * ---
-     * @param $function : call back function to be executed
+     * @param callback $function : callback function to be executed
      */
     public static function notFound($function)
     {
-- 
cgit v1.2.3