minor bc, docs/doc-block updates, added function

- renamed cleanInput to clean_string
- renamed createCertificate to create_certificate
- added global get_results to return result sets in different formats

Author: TheTechsTech

README.md

@@ -247,7 +247,9 @@ foreach ($result as $row) {
 $db->query_prepared('INSERT INTO profile( name, email, phone) VALUES( ?, ?, ? );', [$user, $address, $number]);
 
 $db->query_prepared('SELECT name, email FROM profile WHERE phone = ? OR id != ?', [$number, 5]);
-$result = $db->queryResult(); // the last query that has results are stored in `last_result` protected property
+$result = $db->queryResult(); // the last query that has results are stored in `lastResult` protected property
+// Or for results in other formats use the global function, will use global database instance if no `$db` supplied
+$result = get_results(/* OBJECT|ARRAY_A|ARRAY_N|JSON */, $db); // Defaults to `OBJECT`
 
 foreach ($result as $row) {
     echo $row->name.' '.$row->email;
@@ -271,11 +273,11 @@ use function ezsql\functions\{
     setInstance,
     getInstance,
     clearInstance,
-///
     getVendor,
+///
     to_string,
-    cleanInput,
-    createCertificate,
+    clean_string,
+    create_certificate,
 ///
     column,
     primary,
@@ -323,6 +325,7 @@ use function ezsql\functions\{
     replacing,
     selecting,
     inserting,
+    get_results,
     table_setup,
     set_table,
     set_prefix

lib/ezFunctions.php

@@ -153,24 +153,27 @@ function to_string($arrays, $separation = ',')
     }
 
     /**
-     * Creates an database column,
-     * - column, datatype, value/options with the given arguments.
+     * Creates an database column as:
+     * - `column`, data`type`, ...value/options `arguments`.
      *
-     * // datatype are global CONSTANTS and can be written out like:
+     * // datatype are global `CONSTANTS` and can be written out like:
      *      - VARCHAR, 32, notNULL, PRIMARY, SEQUENCE|AUTO, ....
      * // SEQUENCE|AUTO constants will replaced with the proper auto sequence for the SQL driver
      *
-     * @param string $column|CONSTRAINT, - column name/CONSTRAINT usage for PRIMARY|FOREIGN KEY
-     * @param string $type|$constraintName, - data type for column/primary|foreign constraint name
-     * @param mixed $size|...$primaryForeignKeys,
-     * @param mixed $value, - column should be NULL or NOT NULL. If omitted, assumes NULL
-     * @param mixed $default - Optional. It is the value to assign to the column
+     * @param string $column | `CONSTRAINT`, - column name/CONSTRAINT usage for PRIMARY|FOREIGN KEY
+     * @param string $type | constraintName, - data type for column/primary|foreign constraint name
+     * @param mixed ...$arguments any remainder assignments `ordered` like:
+     *  - @param mixed $size, or/and
+     *  - @param mixed $value, - or/and column should be `NULLS`|`notNULL`. If omitted, assumes `NULLS`
+     *  - @param mixed $default, - or/and Optional. It is the value to assign to the column
+     *  - @param mixed $autoNumber, or/and `AUTO` for vendor's auto numbering
+     *  - @param mixed $primaryForeignKeys | or/and `PRIMARY`|`FOREIGN`
      *
      * @return string|bool - SQL schema string, or false for error
      */
-    function column(string $column = null, string $type = null, ...$args)
+    function column(string $column = null, string $type = null, ...$arguments)
     {
-        return ezSchema::column($column, $type, ...$args);
+        return ezSchema::column($column, $type, ...$arguments);
     }
 
     function primary(string $primaryName, ...$primaryKeys)
@@ -536,6 +539,42 @@ function getInstance()
         return ($ezInstance instanceof ezQueryInterface) ? $ezInstance : null;
     }
 
+    /**
+     * Get multiple row result set from the database (previously cached results).
+     * Returns a multi dimensional array.
+     *
+     * Each element of the array contains one row of results and can be
+     * specified to be either an `object`, `json`, `associative array` or `numerical
+     * array`.
+     * - If no results are found then the function returns `false`,
+     * enabling you to use the function within logic statements such as if.
+     *
+     * **OBJECT** - `Returning results as an object` is the quickest way to get and
+     * display results. It is also useful that you are able to put
+     * `$object->var` syntax directly inside print statements without
+     * having to worry about causing php parsing errors.
+     *
+     * **ARRAY_A** - `Returning results as an associative array` is useful if you would
+     * like dynamic access to column names.
+     *
+     * **ARRAY_N** - `Returning results as a numerical array` is useful if you are using
+     * completely dynamic queries with varying column names but still need
+     * a way to get a handle on the results.
+     *
+     * **JSON** - `Returning results as JSON encoded` is useful for any interactive dynamic queries.
+     *
+     * @param constant $output Either: `OBJECT`|`ARRAY_A`|`ARRAY_N`|`JSON`
+     * @param object|null $instance `ez_pdo`|`ez_pgsql`|`ez_sqlsrv`|`ez_sqlite3`|`ez_mysqli`
+     * @return bool|object|array - results as objects (default)
+     */
+    function get_results($output = \OBJECT, $instance = null)
+    {
+        $ezQuery = empty($instance) || !is_object($instance) ? getInstance() : $instance;
+        return ($ezQuery instanceof ezsqlModelInterface)
+            ? $ezQuery->get_results(null, $output, false)
+            : false;
+    }
+
     /**
      * Clear/unset the global database class instance.
      */
@@ -548,12 +587,12 @@ function clearInstance()
     }
 
     /**
-     * Clean input of XSS, html, javascript, etc...
+     * Clean input string of XSS, html, javascript, etc...
      * @param string $string
      *
      * @return string cleaned string
      */
-    function cleanInput($string)
+    function clean_string(string $string)
     {
         return ezQuery::clean($string);
     }

lib/ezsqlModelInterface.php

@@ -314,22 +314,24 @@ public function get_col(string $query = null, int $x = 0, bool $use_prepare = fa
 	 * - if setup/active, `prepareActive()` has been called, use
 	 * prepare statements in SQL transactions.
 	 *
-	 * `Returning results as an object` is the quickest way to get and
+	 * **OBJECT** - `Returning results as an object` is the quickest way to get and
 	 * display results. It is also useful that you are able to put
 	 * `$object->var` syntax directly inside print statements without
 	 * having to worry about causing php parsing errors.
 	 *
-	 * `Returning results as an associative array` is useful if you would
+	 * **ARRAY_A** - `Returning results as an associative array` is useful if you would
 	 * like dynamic access to column names.
 	 *
-	 * `Returning results as a numerical array` is useful if you are using
+	 * **ARRAY_N** - `Returning results as a numerical array` is useful if you are using
 	 * completely dynamic queries with varying column names but still need
 	 * a way to get a handle on the results.
 	 *
+	 * **JSON** - `Returning results as JSON encoded` is useful for any interactive dynamic queries.
+
 	 * @param string $query
-	 * @param OBJECT|ARRAY_A|ARRAY_N|JSON $output
+	 * @param constant $output Either: `OBJECT`|`ARRAY_A`|`ARRAY_N`|`JSON`
 	 * @param bool $use_prepare - has prepare statements been activated
-	 * @return bool|mixed - results as objects (default)
+	 * @return bool|object|array - results as objects (default)
 	 */
 	public function get_results(string $query = null, $output = \OBJECT, bool $use_prepare = false);
 
@@ -339,7 +341,7 @@ public function get_results(string $query = null, $output = \OBJECT, bool $use_p
 	 * Returns meta information about one or all columns such as column name or type.
 	 * - If no information type is supplied then the default information type of name is used.
 	 * - If no column offset is supplied then a one dimensional array is returned with the
-	 * information type for ‘all columns’.
+	 * information type for all columns.
 	 * - For access to the full meta information for all columns you can use the cached
 	 * variable `$db->colInfo`, access by calling `$db->getCol_Info()`
 	 *

tests/ezQueryTest.php

@@ -10,7 +10,7 @@
     neq,
     like,
     in,
-    cleanInput
+    clean_string
 };
 
 class ezQueryTest extends EZTestCase
@@ -27,9 +27,9 @@ protected function tearDown(): void
         $this->object = null;
     }
 
-    public function testCleanInput()
+    public function testClean_string()
     {
-        $this->assertEquals("' help", cleanInput("<?php echo 'foo' >' help</php?>"));
+        $this->assertEquals("' help", clean_string("<?php echo 'foo' >' help</php?>"));
     }
 
     public function testHaving()

tests/mysqli/ezResultsetTest.php

@@ -8,6 +8,7 @@
 use function ezsql\functions\{
     mysqlInstance,
     column,
+    get_results,
     selecting,
     inserting,
     set_table,
@@ -53,7 +54,7 @@ protected function setUp(): void
         inserting(['id' => 5, 'test_key' => 'test 5']);
         selecting();
 
-        $this->object = new ezResultset($this->database->get_results());
+        $this->object = new ezResultset(get_results());
     } // setUp
 
     /**