Merge branch 'master' into v5

Author: TheTechsTech

README.md

@@ -9,6 +9,7 @@
 [![Total Downloads](https://poser.pugx.org/ezsql/ezsql/downloads)](https://packagist.org/packages/ezsql/ezsql)
 
 ***A class to make it very easy to deal with database connections.***
+*An universal interchangeable **CRUD** system.*
 
 This is [__Version 5__](https://github.com/ezSQL/ezsql/tree/v5) which will break users of **version 4**.
 
@@ -34,6 +35,9 @@ Mainly by:
     - The table *name* with *prefix*, can be preset/stored with methods `tableSetup(name, prefix), or setTable(name), setPrefix(append)`, if called without presetting, `false` is returned.
     - This **feature** will be added to **all** database *CRUD* access methods , each method name will have an `ing` ending added.
 - Removed global functions where `table` name passed in, use functions using preset table names ending with `ing`.
+- renamed cleanInput to clean_string
+- renamed createCertificate to create_certificate
+- added global get_results to return result sets in different formats
 
 [__Version 4__](https://github.com/ezSQL/ezsql/tree/v4) has many modern programming practices in which will break users of version 3.
 
@@ -83,7 +87,7 @@ ___General Methods___
         string $path = '.'._DS
     );
     secureReset();
-    createCertificate(string $privatekeyFile = certificate.key,
+    create_certificate(string $privatekeyFile = certificate.key,
         string $certificateFile = certificate.crt,
         string $signingFile = certificate.csr,
         string $ssl_path = null, array $details = [commonName => localhost]
@@ -96,6 +100,7 @@ ___Shortcut Table Methods___
     primary(string $primaryName, ...$primaryKeys);
     index(string $indexName, ...$indexKeys);
     drop(string $table);
+
 Example
 
 ```php
@@ -147,6 +152,9 @@ prepareOff(); // When off shortcut SQL Methods calls will use vendors escape rou
 * `delete(string $table = null, ...$whereConditions);`
 * `replace(string $table = null, $keyAndValue);`
 * `insert(string $table = null, $keyAndValue);`
+* `create(string $table = null, ...$schemas);`
+* `drop(string $table = null);`
+* `alter(string $table = null, ...$alteringSchema);`
 * `insert_select(string $toTable = null, $toColumns = '*', $fromTable = null, $fromColumns = '*', ...$conditions);`
 
 ```php
@@ -239,6 +247,9 @@ $result = $db->select('profile', 'name, email',
 foreach ($result as $row) {
     echo $row->name.' '.$row->email;
 }
+
+// To get results in `JSON` format
+$json = get_results(JSON, $db);
 ```
 
 #### Example for using prepare statements directly, no shortcut SQL methods used
@@ -247,7 +258,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 +284,11 @@ use function ezsql\functions\{
     setInstance,
     getInstance,
     clearInstance,
+    get_vendor,
 ///
-    getVendor,
     to_string,
-    cleanInput,
-    createCertificate,
+    clean_string,
+    create_certificate,
 ///
     column,
     primary,
@@ -284,6 +297,7 @@ use function ezsql\functions\{
     index,
     addColumn,
     dropColumn,
+    changingColumn,
 ///
     eq,
     neq,
@@ -301,9 +315,6 @@ use function ezsql\functions\{
     between,
     notBetween,
 ///
-    select_into,
-    insert_select,
-    create_select,
     where,
     grouping,
     groupBy,
@@ -323,9 +334,14 @@ use function ezsql\functions\{
     replacing,
     selecting,
     inserting,
+    altering,
+    get_results,
     table_setup,
     set_table,
-    set_prefix
+    set_prefix,
+    select_into,
+    insert_select,
+    create_select,
 };
 ```
 

composer.json

@@ -1,7 +1,9 @@
 {
     "name": "ezsql/ezsql",
-    "description": "Advance database access library. Make interacting with a database ridiculously easy.",
+    "description": "Advance database access library. Make interacting with a database ridiculously easy. An universal interchangeable CRUD system.",
     "keywords": [
+        "crud",
+        "dba",
         "mysql",
         "mysqli",
         "postgresql",
@@ -13,8 +15,7 @@
         "sqlite3",
         "database",
         "abstraction",
-        "sql",
-        "dba"
+        "sql"
     ],
     "license": [
         "LGPL-3.0-or-later",

lib/Config.php

@@ -31,43 +31,6 @@ public function __construct(string $driver = '', array $arguments = null)
         }
     }
 
-    /**
-     * Setup Connections for each SQL database class
-     * @param string $driver - The vendor's SQL database driver name
-     * @param string|array $arguments In the following:
-     *
-     * - user|args[0][1] // The database user name
-     * - password|args[1][2] // The database users password
-     * - database|args[1][2] // The name of the database
-     * - host|args[3] // The host name or IP address of the database server,
-     *      Default is localhost
-     * - port|args[4] // The  database TCP/IP port,
-     *      Default is: 5432 - PostgreSQL, 3306 - MySQL
-     *
-     *  for: mysqli
-     * - (username, password, database, host, port, charset)
-     * - charset|args[5] // The database charset,
-     *      Default is empty string
-     *
-     *  for: postgresql
-     * - (username, password, database, host, port)
-     *
-     *  for: sqlserver
-     * - (username, password, database, host, convertMysqlToMssqlQuery)
-     * - convertMysqlToMssqlQuery[4] // convert Queries in MySql syntax to MS-SQL syntax
-     *      Default is false
-     *
-     *  for: pdo
-     * - (dsn, username, password, options, isFile?)
-     * - dsn |args[0] // The PDO DSN connection parameter string
-     * - options|args[3] // Array for setting connection options as MySQL
-     * - isFile|args[4] // File based databases like SQLite don't need
-     *      user and password, they work with path in the dsn parameter
-     *      Default is false
-     *
-     *  for: sqlite3
-     * - (filePath, database) - filePath|args[0] // The path to open an SQLite database
-     */
     public static function initialize(string $driver = '',  array $arguments = null)
     {
         return new self($driver, $arguments);

lib/ConfigAbstract.php

@@ -24,35 +24,66 @@
 namespace ezsql;
 
 /**
- * @method set/get{property} - a property that needs to be accessed
  *
  * @method void setDriver($args);
+ * Database Sql driver name
  * @method void setDsn($args);
+ * The PDO connection parameter string, database server in the DSN parameters
  * @method void setUser($args);
+ * Database user name
  * @method void setPassword($args);
+ * Database password for the given user
  * @method void setName($args);
+ * Database name
  * @method void setHost($args);
+ * Host name or IP address
  * @method void setPort($args);
+ * TCP/IP port of PostgreSQL/MySQL
  * @method void setCharset($args);
+ * Database charset
  * @method void setOptions($args);
+ * The PDO array for connection options, MySQL connection charset, for example
  * @method void setIsFile($args);
+ * Check PDO for whether it is a file based database connection, for example to a SQLite
+ * database file, or not
  * @method void setToMssql($args);
+ * If we want to convert Queries in MySql syntax to MS-SQL syntax.
+ * Yes, there are some differences in query syntax.
  * @method void setToMysql($args);
+ * If we want to convert Queries in MySql syntax to MS-SQL syntax.
+ * Yes, there are some differences in query syntax.
  * @method void setPath($args);
+ * The path to open an SQLite database
  *
  * @method string getDriver();
+ * Database Sql driver name
  * @method string getDsn();
+ * The PDO connection parameter string, database server in the DSN parameters
  * @method string getUser();
+ * Database user name
  * @method string getPassword()
+ * Database password for the given user
  * @method string getName();
+ * Database name
  * @method string getHost();
+ * Host name or IP address
  * @method string getPort();
+ * TCP/IP port of PostgreSQL/MySQL
  * @method string getCharset();
+ * Database charset
  * @method string getOptions();
+ * The PDO array for connection options, MySQL connection charset, for example
  * @method string getToMysql();
+ * If we want to convert Queries in MySql syntax to MS-SQL syntax.
+ * Yes, there are some differences in query syntax.
  * @method bool getIsFile();
+ * Check PDO for whether it is a file based database connection, for example to a SQLite
+ * database file, or not
  * @method bool getToMssql();
+ * If we want to convert Queries in MySql syntax to MS-SQL syntax.
+ * Yes, there are some differences in query syntax.
  * @method string getPath();
+ * The path to open an SQLite database
  */
 abstract class ConfigAbstract
 {

lib/ConfigInterface.php

@@ -4,40 +4,100 @@
 
 /**
  * @method void setDriver($args);
+ * Database Sql driver name
  * @method void setDsn($args);
+ * The PDO connection parameter string, database server in the DSN parameters
  * @method void setUser($args);
+ * Database user name
  * @method void setPassword($args);
+ * Database password for the given user
  * @method void setName($args);
+ * Database name
  * @method void setHost($args);
+ * Host name or IP address
  * @method void setPort($args);
+ * TCP/IP port of PostgreSQL/MySQL
  * @method void setCharset($args);
+ * Database charset
  * @method void setOptions($args);
+ * The PDO array for connection options, MySQL connection charset, for example
  * @method void setIsFile($args);
+ * Check PDO for whether it is a file based database connection, for example to a SQLite
+ * database file, or not
  * @method void setToMssql($args);
+ * If we want to convert Queries in MySql syntax to MS-SQL syntax.
+ * Yes, there are some differences in query syntax.
  * @method void setToMysql($args);
+ * If we want to convert Queries in MySql syntax to MS-SQL syntax.
+ * Yes, there are some differences in query syntax.
  * @method void setPath($args);
+ * The path to open an SQLite database
  *
  * @method string getDriver();
+ * Database Sql driver name
  * @method string getDsn();
+ * The PDO connection parameter string, database server in the DSN parameters
  * @method string getUser();
+ * Database user name
  * @method string getPassword()
+ * Database password for the given user
  * @method string getName();
+ * Database name
  * @method string getHost();
+ * Host name or IP address
  * @method string getPort();
+ * TCP/IP port of PostgreSQL/MySQL
  * @method string getCharset();
+ * Database charset
  * @method string getOptions();
+ * The PDO array for connection options, MySQL connection charset, for example
  * @method bool getIsFile();
- * @method bool getToMysql();
+ * Check PDO for whether it is a file based database connection, for example to a SQLite
+ * database file, or not
  * @method bool getToMssql();
+ * If we want to convert Queries in MySql syntax to MS-SQL syntax.
+ * Yes, there are some differences in query syntax.
+ * @method bool getToMysql();
+ * If we want to convert Queries in MySql syntax to MS-SQL syntax.
+ * Yes, there are some differences in query syntax.
  * @method string getPath();
+ * The path to open an SQLite database
  */
 interface ConfigInterface
 {
     /**
      * Setup Connections for each SQL database class
      *
-     * @param string $driver
-     * @param string|array $arguments
+     * @param string $driver - The vendor's SQL database driver name
+     * @param array $arguments SQL connection parameters, in the following:
+     *```js
+     * [
+     *  user,  // The database user name.
+     *  password, // The database users password.
+     *  database, // The name of the database.
+     *  host,   // The host name or IP address of the database server. Default is localhost
+     *  port    // The  database TCP/IP port. Default is: 5432 - PostgreSQL, 3306 - MySQL
+     * ]
+     *```
+     *  for: **mysqli** - (`username`, `password`, `database`, `host`, `port`, `charset`)
+     * - `charset` // The database charset,
+     *      Default is empty string
+     *
+     *  for: **postgresql** - (`username`, `password`, `database`, `host`, `port`)
+     *
+     *  for: **sqlserver** - (`username`, `password`, `database`, `host`, `convertMysqlToMssqlQuery`)
+     * - `convertMysqlToMssqlQuery` // convert Queries in MySql syntax to MS-SQL syntax
+     *      Default is false
+     *
+     *  for: **pdo** - (`dsn`, `username`, `password`, `options`, `isFile`?)
+     * - `dsn`  // The PDO DSN connection parameter string
+     * - `options` // Array for setting connection options as MySQL
+     * - `isFile` // File based databases like SQLite don't need
+     *      user and password, they work with path in the dsn parameter
+     *      Default is false
+     *
+     *  for: **sqlite3** - (`filePath`, `database`)
+     * - `filePath` // The path to open an SQLite database
      */
     public static function initialize(string $driver = '', array $arguments = null);
 }

lib/Constants.php

@@ -5,10 +5,12 @@
     /**
      * ezsqlModel Constants
      */
-    \defined('EZSQL_VERSION') or \define('EZSQL_VERSION', '5.0.0');
+    \defined('EZSQL_VERSION') or \define('EZSQL_VERSION', '5.1.0');
     \defined('OBJECT') or \define('OBJECT', 'OBJECT');
     \defined('ARRAY_A') or \define('ARRAY_A', 'ARRAY_A');
     \defined('ARRAY_N') or \define('ARRAY_N', 'ARRAY_N');
+    // Use to set get_result output as json
+    \define('JSON', 'json');
 
     // Error messages
     \define('MISSING_CONFIGURATION', '<b>Fatal Error:</b> Missing configuration details to connect to database');
@@ -17,8 +19,6 @@
 
     // ezQuery prepare placeholder/positional tag
     \define('_TAG', '__ez__');
-    // Use to set get_result output as json
-    \define('_JSON', 'json');
 
     /**
      * Operator boolean expressions.
@@ -174,7 +174,7 @@
     \define('DROP', 'DROP COLUMN');
     \define('CHANGE', 'CHANGE COLUMN');
     \define('ALTER', 'ALTER COLUMN');
-    \define('MODIFY', 'MODIFY');
+    \define('MODIFY', 'MODIFY COLUMN');
     \define('RENAME', 'RENAME TO');
     \define('CHANGER', '__modifyingColumns__');