[Noalyss-commit] [noalyss] 03/20: Documentation

[dwm]

sparkyx pushed a commit to branch master
in repository noalyss.

commit 7b13bbfe534334e4bb724ada9dcdda5eca92a6da
Author: sparkyx <danydb@noalyss.eu>
AuthorDate: Sun Nov 12 22:13:47 2023 +0100

    Documentation
---
 html/css/style-classic7.css         |  6 +++---
 html/js/acc_ledger.js               |  3 +++
 include/class/extension.class.php   |  1 +
 include/class/periode.class.php     | 10 +++++-----
 include/lib/database_core.class.php | 31 ++++++++++++++++++++-----------
 include/lib/html_input.class.php    | 27 ++++++++++++++-------------
 include/lib/inplace_edit.class.php  |  8 ++++++--
 7 files changed, 52 insertions(+), 34 deletions(-)

diff --git a/html/css/style-classic7.css b/html/css/style-classic7.css
index 92579a4a5..101a95a02 100644
--- a/html/css/style-classic7.css
+++ b/html/css/style-classic7.css
@@ -2388,11 +2388,12 @@ td.selectedmenu {
 }
 .v-large { display: none;}
 
+/*
+ * Comment in  follow-up
+ */
 .field_follow_up
 {
     margin-top:1px;
-    white-space: -moz-pre-wrap;
-    white-space: pre-wrap;
     border:1px solid blue;
 }
 
@@ -2433,7 +2434,6 @@ td.selectedmenu {
     text-decoration: none;
     color:blue;
     font-size:1.7em;
-    font-size: 1.7rem;
     padding: 0px;
     margin: 0px;
     background-color: inherit;
diff --git a/html/js/acc_ledger.js b/html/js/acc_ledger.js
index 7cb77c916..5ad1e921b 100644
--- a/html/js/acc_ledger.js
+++ b/html/js/acc_ledger.js
@@ -1246,6 +1246,7 @@ function op_save(obj)
                         onFailure: null,
                         onSuccess: function (req){
                             if (req.responseText !=='OK') {
+                                console.error("D2. op_save")
                                 smoke.alert(req.responseText);
                             }
                         }
@@ -1283,6 +1284,7 @@ function op_save(obj)
                                          $(divid).innerHTML.evalScripts();
                                         remove_waiting_box();
                                         }  catch (e) {
+                                            console.error("D1. op_save")
                                             alert_box("1038"+e.message)
                                         } 
                                     }
@@ -1294,6 +1296,7 @@ function op_save(obj)
         return false;
     } catch (e)
     {
+        console.error("F1. op_save")
         alert_box(e.message);
     }
 }
diff --git a/include/class/extension.class.php 
b/include/class/extension.class.php
index 988f6702d..bf60cbdad 100644
--- a/include/class/extension.class.php
+++ b/include/class/extension.class.php
@@ -148,6 +148,7 @@ class Extension extends Menu_Ref_sql
             throw new Exception(_('Profil inexistant'), 10);
         }
         // Menu exists
+        \Noalyss\Dbg::echo_var(1,__FILE__.__LINE__. "p_module to find 
$p_module");
         $module=new Menu_Ref($cn, $p_module);
         if ($module->me_code==null)
         {
diff --git a/include/class/periode.class.php b/include/class/periode.class.php
index 2cbafa44b..f2981638b 100644
--- a/include/class/periode.class.php
+++ b/include/class/periode.class.php
@@ -54,11 +54,11 @@ class Periode
     {
       $r=<<<EOF
 Object Periode [
-    \$jrn_def_id=>$jrn_def_id,
-     \$p_id=>$p_id,
-     \$status => $status,
-     \$p_start => $p_start,
-     \$p_end => $p_end,
+    \$jrn_def_id=>$this->jrn_def_id,
+     \$p_id=>$this->p_id,
+     \$status => $this->status,
+     \$p_start => $this->p_start,
+     \$p_end => $this->p_end,
 ] 
 EOF;
       return $r;
diff --git a/include/lib/database_core.class.php 
b/include/lib/database_core.class.php
index 36eb417d5..56831a3c6 100644
--- a/include/lib/database_core.class.php
+++ b/include/lib/database_core.class.php
@@ -169,7 +169,7 @@ class DatabaseCore
         return $this;
     }
 
-        /**
+    /**
      * \brief send a sql string to the database
      * \param $p_string     sql string
      * \param $p_array array for the SQL string (see pg_query_params)
@@ -480,7 +480,7 @@ class DatabaseCore
     }
 
     /**
-     * Returns only one row from a query
+     * @brief  Returns only one row from a query
      * @param string $p_sql
      * @param array $p_array
      * @return array , idx = column of the table or null if nothing is found
@@ -735,7 +735,8 @@ class DatabaseCore
         return false;
     }
 
-    /**\brief wrapper for the function pg_num_rows
+    /**
+     * \brief wrapper for the function pg_num_rows
      * \param $ret is the result of a exec_sql
      * \return number of line affected
      */
@@ -745,7 +746,8 @@ class DatabaseCore
         return pg_num_rows($ret);
     }
 
-    /**\brief wrapper for the function pg_fetch_array
+    /**
+     * \brief wrapper for the function pg_fetch_array
      * \param $ret is the result of a pg_exec
      * \param $p_indice is the index
      * \param $p_indice is the index
@@ -757,7 +759,8 @@ class DatabaseCore
         return pg_fetch_array($ret, $p_indice,$p_mode);
     }
 
-    /**\brief wrapper for the function pg_fetch_all
+    /**
+     * \brief wrapper for the function pg_fetch_all
      * \param $ret is the result of pg_exec (exec_sql)
      * \return double array (row x col ) or false
      */
@@ -767,7 +770,8 @@ class DatabaseCore
         return pg_fetch_all($ret);
     }
 
-    /**\brief wrapper for the function pg_fetch_all
+    /**
+     * \brief wrapper for the function pg_fetch_all
      * \param $ret is the result of pg_exec (exec_sql)
      * \param $p_row is the indice of the row
      * \param $p_col is the indice of the col
@@ -790,7 +794,8 @@ class DatabaseCore
         return pg_fetch_row($ret, $p_row);
     }
 
-    /**\brief wrapper for the function pg_lo_unlink
+    /**
+     * \brief wrapper for the function pg_lo_unlink
      * \param $p_oid is the of oid
      * \return return the result of the operation
      */
@@ -838,7 +843,8 @@ class DatabaseCore
         return pg_lo_export($this->db, $p_oid, $tmp_file);
     }
 
-    /**\brief wrapper for the function pg_lo_export
+    /**
+     * \brief wrapper for the function pg_lo_export
      * \param $p_filename is the filename
      * \param $tmp  is the file
      * \return result of the operation
@@ -849,7 +855,8 @@ class DatabaseCore
         return pg_lo_import($this->db, $p_filename);
     }
 
-    /**\brief wrapper for the function pg_escape_string
+    /**
+     * \brief wrapper for the function pg_escape_string
      * \param $p_string is the string to escape
      * \return escaped string
      */
@@ -861,7 +868,8 @@ class DatabaseCore
         return pg_escape_string($cn->db,$p_string);
     }
 
-    /**\brief wrapper for the function pg_close
+    /**
+     * \brief wrapper for the function pg_close
      */
 
     function close()
@@ -870,7 +878,8 @@ class DatabaseCore
         $this->is_open = FALSE;
     }
 
-    /**\brief
+    /**
+     * \brief
      * \param
      * \return
      * \note
diff --git a/include/lib/html_input.class.php b/include/lib/html_input.class.php
index 9ea2e3b1d..bef615f6a 100755
--- a/include/lib/html_input.class.php
+++ b/include/lib/html_input.class.php
@@ -102,7 +102,8 @@ var $css_size;
         $this->readOnly=$p_read;
     }
 
-    /*!\brief set the extra javascript property for the INPUT field
+    /*!
+     * \brief set the extra javascript property for the INPUT field
      * \param $p_name name of the parameter
      * \param $p_value default value of this parameter
      */
@@ -440,7 +441,7 @@ var $css_size;
     }
 
     /**
-     * close button for the HTML popup
+     * @brief close button for the HTML popup
      * @see add_div modify_operation
      * @param $div_name is the name of the div to remove
      */
@@ -470,7 +471,7 @@ var $css_size;
     }
 
     /**
-     * Return a html string with an anchor which close the inside popup. 
(top-right corner)
+     * @brief Return a html string with an anchor which close the inside 
popup. (top-right corner)
      * @param name of the DIV to close
      * @deprecated 
      * @see Icon_Action::close
@@ -481,7 +482,7 @@ var $css_size;
     }
 
     /**
-     * Anchor Html with javascript
+     * @brief Anchor Html with javascript
      * @param $action action action to perform (message) without onclick
      * @param $javascript javascript to execute
      * @param $id is the DOM element id 
@@ -501,7 +502,7 @@ var $css_size;
     }
 
     /**
-     * button Html with javascript
+     * @brief button Html with javascript
      * @param $action action action to perform (message) without onclick
      * @param $javascript javascript to execute
      * @param $id is the DOM element id 
@@ -521,7 +522,7 @@ var $css_size;
     }
 
     /**
-     * Image to click , 
+     * @brief Image to click ,
      * @param string $p_image filename of the image under image/
      * @param string $p_js javascript when the image is clicked
      * @param string $p_message Message 
@@ -534,7 +535,7 @@ var $css_size;
     }
 
     /**
-     * button Html image
+     * @brief button Html image
      * @param $javascript javascript to execute
      * @param $id id of the button
      * @param  $class class of the button
@@ -553,7 +554,7 @@ var $css_size;
     }
 
     /**
-     * Return a html string with an anchor to hide a div, put it in the right 
corner
+     * @brief  Return a html string with an anchor to hide a div, put it in 
the right corner
      * @param $action action action to perform (message)
      * @param $javascript javascript
      * @note not protected against html
@@ -577,7 +578,7 @@ var $css_size;
     }
 
     /**
-     * show the detail of a card
+     * @brief  show the detail of a card
      */
     static function card_detail($p_qcode, $pname='', $p_style="",
             $p_nohistory=false)
@@ -591,7 +592,7 @@ var $css_size;
     }
 
     /**
-     * transform request data  to hidden
+     * @brief transform request data  to hidden
      * @param $array is an of indices
      * @param $request name of the superglobal $_POST $_GET $_REQUEST(default)
      * @return html string with the hidden data
@@ -625,7 +626,7 @@ var $css_size;
         return $r;
     }
     /**
-     * Transform a double array as a HTML string with hidden html value
+     * @brief  Transform a double array as a HTML string with hidden html value
      * array has the formarray ["name"]="x",array['value']="y") the key name 
will be the hidden input name;
      * @param double $array 
      */
@@ -652,7 +653,7 @@ var $css_size;
     }
 
     /**
-     * transform $_GET   data  to hidden
+     * @brief  transform $_GET   data  to hidden
      * @param $array is an of indices
      * @see HtmlInput::request_to_hidden
      * @return html string with the hidden data
@@ -1167,7 +1168,7 @@ var $css_size;
     }
 
     /**
-     * Insert attribute inside a INPUT TYPE, these attribute can be retrieved
+     * @brief Insert attribute inside a INPUT TYPE, these attribute can be 
retrieved
      * in javascript with element.getAttribute or changed with 
element.setAttribute
      * example insert my_attribute into a checkbox <input type="checkbox" 
"my_attribute"="XX"> 
      * @return string to insert into the HTML node
diff --git a/include/lib/inplace_edit.class.php 
b/include/lib/inplace_edit.class.php
index 6e631320e..dd22acafd 100644
--- a/include/lib/inplace_edit.class.php
+++ b/include/lib/inplace_edit.class.php
@@ -30,7 +30,11 @@
  * You need an ajax to response and modify the data. Some parameters will be 
sent
  * by default when you click on the element
  *  - input : htmlInput object serialized
- *  - action : ok or cancel , nothing if you just want to display the input
+ *  - ieaction : ok or cancel , nothing if you just want to display the input
+ *
+ * Very important it is the DOM ID of the HtmlInput element, it must unique. 
For the date
+ * set a uniq dom id, otherwise it fails
+ * $id_limit_date->id=uniqid("date");
  * 
  * @example inplace_edit.test.php
  */
@@ -111,7 +115,7 @@ EOF;
     function value()
     {
         $v=$this->input->get_value();
-        $v=html_entity_decode($v);
+        $v=html_entity_decode($v??"");
          if ( $this->input instanceof ITextarea) {
            
             echo '<pre class="field_follow_up">';