Merge branch 'ready' into newmaster

Author: TheTechsTech

.vscode/settings.json

@@ -19,6 +19,7 @@
         "VARBIT",
         "VARCHAR",
         "autoload",
+        "cacert",
         "codecov",
         "ezmysqli",
         "ezpdo",
@@ -30,7 +31,9 @@
         "isfile",
         "mysqli",
         "pgsql",
+        "phpunit",
         "postgresql",
+        "privatekey",
         "repo",
         "sqlserver",
         "sqlsrv",

README.md

@@ -5,15 +5,15 @@
 [![codecov](https://codecov.io/gh/ezSQL/ezSQL/branch/v4/graph/badge.svg)](https://codecov.io/gh/ezSQL/ezSQL)
 [![Maintainability](https://api.codeclimate.com/v1/badges/0071eb99ab4f5ac5b1f2/maintainability)](https://codeclimate.com/github/ezSQL/ezSQL/maintainability)
 
-***Class to make it very easy to deal with database connections.***
+***A class to make it very easy to deal with database connections.***
 
 This is [__version 4__](https://github.com/ezSQL/ezSQL/tree/v4) that has many modern programming practices in which will break users of version 3.
 
 [__Version 3__](https://github.com/ezSQL/ezSQL/tree/v3) broke version 2.1.7 in one major way, it required *PHP 5.6*. Which drop mysql extension support, other than that, nothing as far using the library was changed, only additional features.
 
-This library has an `Database` class, a combination of the [Factory](https://en.wikipedia.org/wiki/Factory_method_pattern) pattern with an [Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection) container hosting. The library is following many OOP principles, one in which, properties public access has been removed.
+This library has an `Database` class, an combination of the [Factory](https://en.wikipedia.org/wiki/Factory_method_pattern) pattern with an [Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection) container hosting. This library now is following many OOP principles, one in which, the methods properties public access has been removed. This library also following PSR-2, PSR-4, and PSR-11 conventions.
 
- - More Todo...
+* More Todo...
 
 For an full overview see [documentation Wiki](https://github.com/ezSQL/ezSQL/WIKI.md), which is not completely finish.
 
@@ -26,18 +26,84 @@ For an full overview see [documentation Wiki](https://github.com/ezSQL/ezSQL/WIK
 ```php
 require 'vendor/autoload.php';
 
-// '****' is one of **mysqli**, **pgsql**, **sqlsrv**, **sqlite3**, or **Pdo**.
+// **** is one of mysqli, pgsql, sqlsrv, sqlite3, or Pdo.
 use ezsql\Database;
 
-$db = Database::initialize('****', [$dsn_path_user, $password, $database, $or, $other_settings], $optional_instance_tag);
+$db = Database::initialize('****', [$dsn_path_user, $password, $database, $other_settings], $optional_tag);
 
 // Is same as:
 use ezsql\Config;
 use ezsql\Database\ez_****;
 
-$setting = new Config('****', [$dsn_path_user, $password, $database, $or, $other_settings]);
+$setting = new Config('****', [$dsn_path_user, $password, $database, $other_settings]);
 
 $db = new ez_****($settings);
 ```
 
+This library will assume the developer is using some sort of IDE with intellisense enabled. The comments/doc-block area will hold any missing documentations. For additional examples see __phpunit__ tests, The tests are fully functional integration tests, meaning the are live database tests, no mocks.
+
+##### General Methods
+---
+    to_string($arrays, $separation = ',');
+    clean($string);
+    create_cache(string $path = null);
+    securePDO($vendor = null,
+        $key = 'certificate.key',
+        $cert = 'certificate.crt',
+        $ca = 'cacert.pem',
+        $path = '.'._DS
+    );
+    createCertificate(string $privatekeyFile = certificate.key,
+        string $certificateFile = certificate.crt,
+        string $signingFile = certificate.csr,
+        string $ssl_path = null, array $details = [commonName => localhost]
+    );
+
+___Shortcut Table Methods___
+
+    create(string $table = null, ...$schemas);// $schemas requires... column()
+    column(string $column = null, string $type = null, ...$args);
+    drop(string $table);
+---
+
+    innerJoin(string $leftTable = null, string $rightTable = null,
+        string $leftColumn = null, string $rightColumn = null, $condition = EQ);
+
+    leftJoin(string $leftTable = null, string $rightTable = null,
+        string $leftColumn = null, string $rightColumn = null, $condition = EQ);
+
+    rightJoin(string $leftTable = null, string $rightTable = null,
+        string $leftColumn = null, string $rightColumn = null, $condition = EQ);
+
+    fullJoin(string $leftTable = null, string $rightTable = null,
+        string $leftColumn = null, string $rightColumn = null, $condition = EQ);
+---
+
+```php
+prepareOn(); // When activated will use prepare statements for all shortcut SQL Methods calls.
+prepareOff(); // When off shortcut SQL Methods calls will use vendors escape routine instead. This is the default behavior.
+```
+
+### Shortcut SQL Methods
+
+* `having(...$having);`
+* `groupBy($groupBy);`
+* `union(string $table = null, $columnFields = '*', ...$conditions);`
+* `unionAll(string $table = null, $columnFields = '*', ...$conditions);`
+* `orderBy($orderBy, $order);`
+* `limit($numberOf, $offset = null)`
+* `where( ...$whereKeyArray);`
+* `selecting(string $table = null, $columnFields = '*', ...$conditions);`
+* `create_select(string $newTable, $fromColumns, $oldTable = null, ...$fromWhere);`
+* `select_into(string $newTable, $fromColumns, $oldTable = null, ...$fromWhere);`
+* `update(string $table = null, $keyAndValue, ...$whereKeys);`
+* `delete(string $table = null, ...$whereKeys);`
+* `replace(string $table = null, $keyAndValue);`
+* `insert(string $table = null, $keyAndValue);`
+* `insert_select(string $toTable = null, $toColumns = '*', $fromTable = null, $fromColumns = '*', ...$fromWhere);`
+
+---
+
+    query_prepared(string $query_string, array $param_array);
+
 **For** **[Authors/Contributors](https://github.com/ezsql/ezsql/CONTRIBUTORS.md)**

WIKI.md

@@ -161,32 +161,38 @@ This version further break things introduced in version 3 that broke version 2.1
 ____Installation and Usage____
 ---
 
-Note: __****__ is one of '**mysqli**, **pgsql**, **sqlsrv**, **sqlite3**, or **Pdo**'.
 
 Either: ***for version 3.x***
 
-    composer require ezsql/ezsql=^3.1.0
-    require 'vendor/autoload.php';
-    ---------
-    // Manually download https://github.com/ezSQL/ezSQL/archive/v3.zip and extract.
-    require 'ez_sql_loader.php';
-    ---------
+    composer require ezsql/ezsql=^3.1.2
 
-    $db = new ezSQL_****(user, password, database, or, other settings);
+```php
+require 'vendor/autoload.php';
+```
+```php
+// Manually download https://github.com/ezSQL/ezSQL/archive/v3.zip and extract.
+require 'ez_sql_loader.php';
+```
+```php
+$db = new ezSQL_****(user, password, database, or, other settings);
+```
 
 Or: ***for version 4.x***
 
     // composer is required for version 4
     composer require ezsql/ezsql
-    require 'vendor/autoload.php';
-    ---------
 
-    $db = Database::initialize('****', [user, password, database, or, other settings], **optional storage tag);
+```php
+require 'vendor/autoload.php';
+
+$db = Database::initialize('****', [user, password, database, other settings], **optional tag);
 
-    Is same as:
+// Is same as:
+$setting = new Config('****', [user, password, database, other settings]);
+$db = new ez_****($settings);
+```
 
-    $setting = new Config('****', [user, password, database, or, other settings]);
-    $db = new ez_****($settings);
+>Note: __****__ is one of **mysqli**, **pgsql**, **sqlsrv**, **sqlite3**, or **Pdo**.
 
 **ezsql** functions
 ---

appveyor.yml

@@ -7,8 +7,6 @@ clone_folder: c:\projects\php-project-workspace
 environment:
   matrix:
   - php_ver_target: 7.1
-  - dependencies: current
-    php_ver_target: 7.2
   MYSQL_DATABASE: ez_test
   MYSQL_HOST: localhost
   MYSQL_USER: root
@@ -40,40 +38,25 @@ init:
 install:
     - IF EXIST c:\tools\php (SET PHP=0)
     - ps: >-
-        If ($env:php_ver_target -eq "5.6") {
-          appveyor-retry cinst --params '""/InstallDir:C:\tools\php""' --ignore-checksums -y --forcex86 php --version ((choco search php --exact --all-versions -r | select-string -pattern $env:php_ver_target | sort { [version]($_ -split '\|' | select -last 1) } -Descending | Select-Object -first 1) -replace '[php|]','')
-        } Else {
           appveyor-retry cinst --params '""/InstallDir:C:\tools\php""' --ignore-checksums -y php --version ((choco search php --exact --all-versions -r | select-string -pattern $env:php_ver_target | sort { [version]($_ -split '\|' | select -last 1) } -Descending | Select-Object -first 1) -replace '[php|]','')
-        }
     - appveyor-retry cinst -y sqlite
     - cd c:\tools\php
     # Get the MSSQL DLL's
     - ps: >-
         If ($env:PHP -eq "1") {
-          If ($env:php_ver_target -eq "5.6") {
-            $source = "https://cdn.joomla.org/ci/php-sqlsrv.zip"
-            $destination = "c:\tools\php\php-sqlsrv.zip"
-            Invoke-WebRequest $source -OutFile $destination
-            #appveyor-retry appveyor DownloadFile https://cdn.joomla.org/ci/php-sqlsrv.zip
-            7z x php-sqlsrv.zip > $null
-            copy SQLSRV\php_sqlsrv_56_nts.dll ext\php_sqlsrv_nts.dll
-            copy SQLSRV\php_pdo_sqlsrv_56_nts.dll ext\php_pdo_sqlsrv_nts.dll
-            Remove-Item c:\tools\php\* -include .zip
-            } Else {
             $DLLVersion = "4.3.0"
             cd c:\tools\php\ext
             $source = "http://windows.php.net/downloads/pecl/releases/sqlsrv/$($DLLVersion)/php_sqlsrv-$($DLLVersion)-$($env:php_ver_target)-nts-vc14-x64.zip"
             $destination = "c:\tools\php\ext\php_sqlsrv-$($DLLVersion)-$($env:php_ver_target)-nts-vc14-x64.zip"
             Invoke-WebRequest $source -OutFile $destination
-            #appveyor-retry appveyor DownloadFile http://windows.php.net/downloads/pecl/releases/sqlsrv/$($DLLVersion)/php_sqlsrv-$($DLLVersion)-$($env:php_ver_target)-nts-vc14-x64.zip
             7z x -y php_sqlsrv-$($DLLVersion)-$($env:php_ver_target)-nts-vc14-x64.zip > $null
             $source = "http://windows.php.net/downloads/pecl/releases/pdo_sqlsrv/$($DLLVersion)/php_pdo_sqlsrv-$($DLLVersion)-$($env:php_ver_target)-nts-vc14-x64.zip"
             $destination = "c:\tools\php\ext\php_pdo_sqlsrv-$($DLLVersion)-$($env:php_ver_target)-nts-vc14-x64.zip"
             Invoke-WebRequest $source -OutFile $destination
-            #appveyor-retry appveyor DownloadFile http://windows.php.net/downloads/pecl/releases/pdo_sqlsrv/$($DLLVersion)/php_pdo_sqlsrv-$($DLLVersion)-$($env:php_ver_target)-nts-vc14-x64.zip
             7z x -y php_pdo_sqlsrv-$($DLLVersion)-$($env:php_ver_target)-nts-vc14-x64.zip > $null
             Remove-Item c:\tools\php\ext* -include .zip
-            cd c:\tools\php}}
+            cd c:\tools\php
+        }
     - IF %PHP%==1 copy php.ini-production php.ini /Y
     - IF %PHP%==1 echo date.timezone="UTC" >> php.ini
     - IF %PHP%==1 echo extension_dir=ext >> php.ini
@@ -96,9 +79,9 @@ install:
     - IF %PHP%==1 echo extension=php_pdo_sqlite.dll >> php.ini
     - IF %PHP%==1 echo extension=php_mysqli.dll >> php.ini
     - IF %PHP%==1 echo extension=php_pdo_mysql.dll >> php.ini
-    - IF %PHP%==1 appveyor-retry appveyor DownloadFile https://xdebug.org/files/php_xdebug-2.5.5-7.0-vc14-nts-x86_64.dll -FileName c:\tools\php\ext\php_xdebug-2.5.5-7.0-vc14-nts-x86_64.dll
+    - IF %PHP%==1 appveyor-retry appveyor DownloadFile https://xdebug.org/files/php_xdebug-2.6.0-7.1-vc14-nts-x86_64.dll -FileName c:\tools\php\ext\php_xdebug-2.6.0-7.1-vc14-nts-x86_64.dll
     - IF %PHP%==1 echo [xdebug] >> php.ini
-    - IF %PHP%==1 echo zend_extension=php_xdebug-2.5.5-7.0-vc14-nts-x86_64.dll >> php.ini
+    - IF %PHP%==1 echo zend_extension=php_xdebug-2.6.0-7.1-vc14-nts-x86_64.dll >> php.ini
     - IF %PHP%==1 echo zend.assertions=1 >> php.ini
     - IF %PHP%==1 echo assert.exception=On >> php.ini
     - IF %PHP%==1 echo xdebug.remote_enable=1 >> php.ini

lib/DatabaseInterface.php

@@ -54,7 +54,15 @@ public function escape(string $str);
     public function sysDate();
 
 	/**
-     * Creates a prepared query, binds the given parameters and returns the result of the executed
+     * Creates a prepared query, binds the given parameters and returns the result of the executed.
+     * 
+     * Supplying the the whole query string, and placing '?' within, 
+     * then the same number of arguments in an array.
+     * 
+     * Example:
+     *  `query_prepared('INSERT INTO unit_test(id, test_key) VALUES(1, ?)', ['test 1']);`
+     * 
+     * - It will determine arguments type, execute, and return results.
      * 
      * @param string $query
      * @param array $param
@@ -89,4 +97,9 @@ public function disconnect();
      * Get connection handle
      */
     public function handle();
+
+    /**
+     * Reset connection handle
+     */
+    public function reset();
 }

lib/ezFunctions.php

@@ -313,7 +313,7 @@ function setInstance($ezSQL = '') {
     function getInstance() {
         global $ezInstance;
 
-        return $ezInstance;
+        return ($ezInstance instanceOf DatabaseInterface) ? $ezInstance : null;
     }
 
     function clearInstance() {

lib/ezQuery.php

@@ -391,7 +391,7 @@ public function where( ...$whereKeyArray)
 		return ($where != '1') ? " $whereOrHaving ".$where.' ' : ' ' ;
     }        
 
-    public function selecting($table ='', $columnFields = '*', ...$conditions) 
+    public function selecting(string $table = null, $columnFields = '*', ...$conditions) 
     {    
 		$getFromTable = $this->fromTable;
 		$getSelect_result = $this->select_result;       
@@ -490,17 +490,17 @@ private function select_sql($table = '', $columnFields = '*', ...$conditions)
         return $this->selecting($table, $columnFields, ...$conditions);	            
     }
 
-    public function union($table = '', $columnFields = '*', ...$conditions)
+    public function union(string $table = null, $columnFields = '*', ...$conditions)
     {
         return 'UNION '.$this->select_sql($table, $columnFields, ...$conditions);           
     }
 
-    public function unionAll($table = '', $columnFields = '*', ...$conditions)
+    public function unionAll(string $table = null, $columnFields = '*', ...$conditions)
     {
         return 'UNION ALL '.$this->select_sql($table, $columnFields, ...$conditions);             
     }
 
-    public function create_select($newTable, $fromColumns, $oldTable = null, ...$fromWhere) 
+    public function create_select(string $newTable, $fromColumns, $oldTable = null, ...$fromWhere) 
     {
 		if (isset($oldTable))
 			$this->fromTable = $oldTable;
@@ -517,7 +517,7 @@ public function create_select($newTable, $fromColumns, $oldTable = null, ...$fro
         return $this->clearPrepare();   
     }
 
-    public function select_into($newTable, $fromColumns, $oldTable = null, ...$fromWhere) 
+    public function select_into(string $newTable, $fromColumns, $oldTable = null, ...$fromWhere) 
     {
 		$this->isInto = true;        
 		if (isset($oldTable))
@@ -534,7 +534,7 @@ public function select_into($newTable, $fromColumns, $oldTable = null, ...$fromW
         return $this->clearPrepare();     
     }
 
-    public function update($table = '', $keyAndValue, ...$whereKeys) 
+    public function update(string $table = null, $keyAndValue, ...$whereKeys) 
     {        
         if ( ! is_array( $keyAndValue ) || empty($table) ) {
 			return $this->clearPrepare();
@@ -567,7 +567,7 @@ public function update($table = '', $keyAndValue, ...$whereKeys)
         return $this->clearPrepare();
     }   
 
-    public function delete($table = '', ...$whereKeys) 
+    public function delete(string $table = null, ...$whereKeys) 
     {   
         if ( empty($table) ) {
 			return $this->clearPrepare();         			
@@ -647,17 +647,17 @@ private function _query_insert_replace($table = '', $keyAndValue, $type = '', $e
         }
 	}
 
-    public function replace($table = '', $keyAndValue) 
+    public function replace(string $table = null, $keyAndValue) 
     {
         return $this->_query_insert_replace($table, $keyAndValue, 'REPLACE');
     }
 
-    public function insert($table = '', $keyAndValue) 
+    public function insert(string $table = null, $keyAndValue) 
     {
         return $this->_query_insert_replace($table, $keyAndValue, 'INSERT');
     }
 
-    public function insert_select($toTable = '', $toColumns = '*', $fromTable = null, $fromColumns = '*', ...$fromWhere) 
+    public function insert_select(string $toTable = null, $toColumns = '*', $fromTable = null, $fromColumns = '*', ...$fromWhere) 
     {
         $putToTable = $this->_query_insert_replace($toTable, $toColumns, 'INSERT', false);
         $getFromTable = $this->select_sql($fromTable, $fromColumns, ...$fromWhere);