release

francescobianco · francescobianco · commit 1a88fca7f3c0 · 2022-02-22T10:45:16.000+01:00
diff --git a/README.md b/README.md
@@ -31,7 +31,13 @@ $hdb = Hamper::getInstance();
 
 ## Documentation
 
-TEST
+The documentation lists all the functions you can use to make the code simple and easy to read. 
+The access you have on the data inside the database is based on extraction methods that return `array` 
+and that you can easily manipulate with `foreach`. 
+Use the functions well because they allow you to take a single record or a list of records or all the values of a column. 
+Before starting to use it, read the list of functions carefully, and you will automatically use the best one based on the context. 
+For each function you are also presented, the "😿 Legacy", the version of the old style Vtiger code you can replace with Hamper functions, 
+comparing them, and you will realize how Hamper improves your work.
 
 ### All Functions
 
@@ -82,7 +88,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -114,7 +120,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -146,7 +152,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -172,7 +178,7 @@ This method is useful to handle this situations
 $crmId = $hdb->fetchValue("SELECT crmid FROM vtiger_crmentity WHERE setype=? AND deleted=0", [$module]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -210,7 +216,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -242,7 +248,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -274,7 +280,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -306,7 +312,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -338,7 +344,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -370,7 +376,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -392,7 +398,7 @@ query($sql, $params = [], $options = [])
 
 This method is useful to handle this situations
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
diff --git a/contrib/update-readme.php b/contrib/update-readme.php
@@ -39,7 +39,7 @@
             foreach ($docBlock->getTagsByName('example') as $tag) {
                 $documentation .= "```php\n" . $tag->getDescription() . "\n```\n\n";
             }
-            $documentation .= "#### Legacy\n\nThis method replace this kind of legacy code\n\n";
+            $documentation .= "#### 😿 Legacy\n\nThis method replace this kind of legacy code\n\n";
             foreach ($docBlock->getTagsByName('legacy') as $tag) {
                 $documentation .= "```php\n" . $tag->getDescription() . "\n```\n\n";
             }
diff --git a/docs/README.md b/docs/README.md
@@ -31,7 +31,13 @@ $hdb = Hamper::getInstance();
 
 ## Documentation
 
-TEST
+The documentation lists all the functions you can use to make the code simple and easy to read. 
+The access you have on the data inside the database is based on extraction methods that return `array` 
+and that you can easily manipulate with `foreach`. 
+Use the functions well because they allow you to take a single record or a list of records or all the values of a column. 
+Before starting to use it, read the list of functions carefully, and you will automatically use the best one based on the context. 
+For each function you are also presented, the "😿 Legacy", the version of the old style Vtiger code you can replace with Hamper functions, 
+comparing them, and you will realize how Hamper improves your work.
 
 ### All Functions
 
@@ -82,7 +88,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -114,7 +120,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -146,7 +152,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -172,7 +178,7 @@ This method is useful to handle this situations
 $crmId = $hdb->fetchValue("SELECT crmid FROM vtiger_crmentity WHERE setype=? AND deleted=0", [$module]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -210,7 +216,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -242,7 +248,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -274,7 +280,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -306,7 +312,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -338,7 +344,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -370,7 +376,7 @@ $hdb->query("SET NAMES utf8");
 $hdb->query("UPDATE vtiger_users SET language = ? WHERE user_name = ?", ["en_us", "admin"]);
 ```
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 
@@ -392,7 +398,7 @@ query($sql, $params = [], $options = [])
 
 This method is useful to handle this situations
 
-#### Legacy
+#### 😿 Legacy
 
 This method replace this kind of legacy code
 

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@`
`39`	`39`	`foreach ($docBlock->getTagsByName('example') as $tag) {`
`40`	`40`	$documentation .= "```php\n" . $tag->getDescription() . "\n```\n\n";
`41`	`41`	`}`
`42`		`- $documentation .= "#### Legacy\n\nThis method replace this kind of legacy code\n\n";`
	`42`	`+ $documentation .= "#### 😿 Legacy\n\nThis method replace this kind of legacy code\n\n";`
`43`	`43`	`foreach ($docBlock->getTagsByName('legacy') as $tag) {`
`44`	`44`	$documentation .= "```php\n" . $tag->getDescription() . "\n```\n\n";
`45`	`45`	`}`