update docs, and wording, code clean up

TheTechsTech · TheTechsTech · commit 30dde6b97f9f · 2019-04-16T22:16:55.000-04:00
diff --git a/README.md b/README.md
@@ -46,10 +46,10 @@ ___General Methods___
     to_string($arrays, $separation = ',');
     clean($string);
     create_cache(string $path = null);
-    secureSetup($key = 'certificate.key',
-        $cert = 'certificate.crt',
-        $ca = 'cacert.pem',
-        $path = '.'._DS
+    secureSetup(string $key = 'certificate.key',
+        string $cert = 'certificate.crt',
+        string $ca = 'cacert.pem',
+        string $path = '.'._DS
     );
     secureReset();
     createCertificate(string $privatekeyFile = certificate.key,
@@ -62,7 +62,7 @@ ___Shortcut Table Methods___
 
     create(string $table = null, ...$schemas);// $schemas requires... column()
     column(string $column = null, string $type = null, ...$args);
-    primary(string $constraintName, ...$primaryKeys);
+    primary(string $primaryName, ...$primaryKeys);
     index(string $indexName, ...$indexKeys);
     drop(string $table);
 Example
@@ -108,15 +108,38 @@ prepareOff(); // When off shortcut SQL Methods calls will use vendors escape rou
 * `unionAll(string $table = null, $columnFields = '*', ...$conditions);`
 * `orderBy($orderBy, $order);`
 * `limit($numberOf, $offset = null)`
-* `where( ...$whereKeyArray);`
+* `where( ...$whereConditions);`
 * `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);`
+* `create_select(string $newTable, $fromColumns, $oldTable = null, ...$conditions);`
+* `select_into(string $newTable, $fromColumns, $oldTable = null, ...$conditions);`
+* `update(string $table = null, $keyAndValue, ...$whereConditions);`
+* `delete(string $table = null, ...$whereConditions);`
 * `replace(string $table = null, $keyAndValue);`
 * `insert(string $table = null, $keyAndValue);`
-* `insert_select(string $toTable = null, $toColumns = '*', $fromTable = null, $fromColumns = '*', ...$fromWhere);`
+* `insert_select(string $toTable = null, $toColumns = '*', $fromTable = null, $fromColumns = '*', ...$conditions);`
+
+```php
+// The variadic ...$whereConditions, and ..$conditions parameters,
+//  represent the following global functions.
+// They are comparison expressions returning an array with the given arguments,
+//  the last arguments of _AND, _OR, _NOT, _andNOT will combine expressions
+eq('key/Field/Column', $value, _AND), // combine next expression
+neq('key/Field/Column', $value, _OR), // will combine next expression again
+ne('key/Field/Column', $value)
+lt('key/Field/Column', $value)
+lte('key/Field/Column', $value)
+gt('key/Field/Column', $value)
+gte('key/Field/Column', $value)
+isNull('key/Field/Column')
+isNotNull('key/Field/Column')
+like('key/Field/Column', '_%')
+notLike('key/Field/Column', '_%')
+in('key/Field/Column', $value)
+notIn('key/Field/Column', $value)
+between('key/Field/Column', $value, $value2)
+notBetween('key/Field/Column', $value, $value2)
+// The above should be used within the where( ...$whereConditions) clause
+```
 
 ```php
 // Supply the the whole query string, and placing '?' within
@@ -140,17 +163,8 @@ $values['phone'] = $number;
 $db->insert('profile', $values);
 $db->insert('profile', ['name' => 'john john', 'email' => 'john@email', 'phone' => 123456]);
 
-// returns result set given the table name, column fields, and ...conditionals
-$result = $db->selecting('profile', 'phone',
-    // ...conditionals are comparison operators($column, $value, _COMBINE_EXPRESSION_CONSTANTS)
-    // these operators are functions returning arrays:
-    //      eq(), neq(), ne(), lt(), lte(),
-    //      gt(), gte(), isNull(), isNotNull(),
-    //      like(), notLike(), in(), notIn(), between(), notBetween(),
-    // _COMBINE_EXPRESSION_CONSTANTS:
-    //      _AND, _OR, _NOT, _andNOT
-    eq('email', $email, _AND), neq('id', 1)
-);
+// returns result set given the table name, column fields, and ...conditions
+$result = $db->selecting('profile', 'phone', eq('email', $email, _AND), neq('id', 1));
 
 foreach ($result as $row) {
     echo $row->phone;
diff --git a/lib/ezFunctions.php b/lib/ezFunctions.php
@@ -60,22 +60,22 @@ function column(string $column = null, string $type = null, ...$args)
         return ezSchema::column($column, $type, ...$args);
     }
 
-    function primary(string $constraintName, ...$primaryKeys)
+    function primary(string $primaryName, ...$primaryKeys)
     {
         array_unshift($primaryKeys, \PRIMARY);
-        return \column(\CONSTRAINT, $constraintName, ...$primaryKeys);
+        return \column(\CONSTRAINT, $primaryName, ...$primaryKeys);
     }
 
-    function foreign(string $constraintName, ...$foreignKeys)
+    function foreign(string $foreignName, ...$foreignKeys)
     {
         array_unshift($foreignKeys, \FOREIGN);
-        return \column(\CONSTRAINT, $constraintName, ...$foreignKeys);
+        return \column(\CONSTRAINT, $foreignName, ...$foreignKeys);
     }
 
-    function unique(string $constraintName, ...$uniqueKeys)
+    function unique(string $uniqueName, ...$uniqueKeys)
     {
         array_unshift($uniqueKeys, \UNIQUE);
-        return \column(\CONSTRAINT, $constraintName, ...$uniqueKeys);
+        return \column(\CONSTRAINT, $uniqueName, ...$uniqueKeys);
     }
 
     function index(string $indexName, ...$indexKeys)
diff --git a/lib/ezQuery.php b/lib/ezQuery.php
@@ -292,102 +292,99 @@ public function limit($numberOf, $offset = null)
         return 'LIMIT '.$rows.$value;
     }
 
-    public function where( ...$whereKeyArray) 
+    public function where( ...$whereConditions) 
     {
-        if (empty($whereKeyArray))
+        if (empty($whereConditions))
 			return false;
 
         $whereOrHaving = ($this->isWhere) ? 'WHERE' : 'HAVING';
         $this->isWhere = true;
 
-        $whereKey = [];
+        $whereClause = [];
         $operator = [];
         $extra = [];
         $combiner = [];
         $combineWith = '';
-		if (\is_string($whereKeyArray[0])) {
-            if ((\strpos($whereKeyArray[0], 'WHERE') !== false) 
-                || (\strpos($whereKeyArray[0], 'HAVING') !== false)
+        
+		$storeWhereConditions = $whereConditions;
+		if (\is_string($whereConditions[0])) {
+            if ((\strpos($whereConditions[0], 'WHERE') !== false) 
+                || (\strpos($whereConditions[0], 'HAVING') !== false)
             )
-                return $whereKeyArray[0];
+                return $whereConditions[0];
 
-			foreach ($whereKeyArray as $makeArray)
-				$whereKeys[] = \explode('  ', $makeArray);	
-		} else 
-			$whereKeys = $whereKeyArray;	
+            $storeWhereConditions = [];
+			foreach ($whereConditions as $makeWhereArray)
+				$storeWhereConditions[] = \explode('  ', $makeWhereArray);	
+		}
         
-		foreach ($whereKeys as $values) {
-			$operator[] = (isset($values[1])) ? $values[1]: '';
-			if (!empty($values[1])){
-				if (\strtoupper($values[1]) == 'IN') {
-					$whereKey[ $values[0] ] = \array_slice((array) $values, 2);
-					$combiner[] = (isset($values[3])) ? $values[3]: \_AND;
-					$extra[] = (isset($values[4])) ? $values[4]: null;				
-				} else {
-					$whereKey[ (isset($values[0])) ? $values[0] : '1' ] = (isset($values[2])) ? $values[2] : '' ;
-					$combiner[] = (isset($values[3])) ? $values[3]: \_AND;
-					$extra[] = (isset($values[4])) ? $values[4]: null;
-				}				
-			} else {
+		foreach ($storeWhereConditions as $checkFields) {
+            $operator[] = (isset($checkFields[1])) ? $checkFields[1]: '';            
+            if (empty($checkFields[1]))
                 return $this->clearPrepare();
-            }                
+            
+            if (\strtoupper($checkFields[1]) == 'IN') {
+				$whereClause[ $checkFields[0] ] = \array_slice((array) $checkFields, 2);
+				$combiner[] = (isset($checkFields[3])) ? $checkFields[3]: \_AND;
+				$extra[] = (isset($checkFields[4])) ? $checkFields[4]: null;				
+			} else {
+				$whereClause[ (isset($checkFields[0])) ? $checkFields[0] : '1' ] = (isset($checkFields[2])) ? $checkFields[2] : '' ;
+				$combiner[] = (isset($checkFields[3])) ? $checkFields[3]: \_AND;
+				$extra[] = (isset($checkFields[4])) ? $checkFields[4]: null;
+			}           
 		}
         
         $where = '1';    
-        if (! isset($whereKey['1'])) {
+        if (! isset($whereClause['1'])) {
             $where = '';
             $i = 0;
-            foreach($whereKey as $key => $val) {
+            foreach($whereClause as $key => $val) {
                 $isCondition = \strtoupper($operator[$i]);
 				$combine = $combiner[$i];
+                $combineWith = \_AND;
 				if ( \in_array(\strtoupper($combine), \_COMBINERS) || isset($extra[$i])) 
 					$combineWith = (isset($extra[$i])) ? $combine : \strtoupper($combine);
-				else 
-                    $combineWith = \_AND;
 
-                if (! \in_array( $isCondition, \_BOOLEAN_OPERATORS)) {
+                if (! \in_array( $isCondition, \_BOOLEAN_OPERATORS))
                     return $this->clearPrepare();
-                } else {
-                    if (($isCondition == \_BETWEEN) || ($isCondition == \_notBETWEEN)) {
-						$value = $this->escape($combineWith);
-						if (\in_array(\strtoupper($extra[$i]), \_COMBINERS)) 
-							$myCombineWith = \strtoupper($extra[$i]);
-						else 
-                            $myCombineWith = \_AND;
 
-						if ($this->isPrepareOn()) {
-							$where .= "$key ".$isCondition.' '.\_TAG." AND ".\_TAG." $myCombineWith ";
-							$this->addPrepare($val);
-							$this->addPrepare($combineWith);
-						} else 
-                            $where .= "$key ".$isCondition." '".$this->escape($val)."' AND '".$value."' $myCombineWith ";
+                if (($isCondition == \_BETWEEN) || ($isCondition == \_notBETWEEN)) {
+				    $value = $this->escape($combineWith);
+                    $myCombineWith = \_AND;
+					if (\in_array(\strtoupper($extra[$i]), \_COMBINERS)) 
+						$myCombineWith = \strtoupper($extra[$i]);
+
+					if ($this->isPrepareOn()) {
+						$where .= "$key ".$isCondition.' '.\_TAG." AND ".\_TAG." $myCombineWith ";
+						$this->addPrepare($val);
+						$this->addPrepare($combineWith);
+					} else 
+                        $where .= "$key ".$isCondition." '".$this->escape($val)."' AND '".$value."' $myCombineWith ";
                             
-						$combineWith = $myCombineWith;
-					} elseif ($isCondition == \_IN) {
-						$value = '';
-						foreach ($val as $inValues) {
-							if ($this->isPrepareOn()) {
-								$value .= \_TAG.', ';
-								$this->addPrepare($inValues);
-							} else 
-								$value .= "'".$this->escape($inValues)."', ";
-                        }                        
-						$where .= "$key ".$isCondition." ( ".\rtrim($value, ', ')." ) $combineWith ";
-					} elseif (((\strtolower($val) == 'null') || ($isCondition == 'IS') || ($isCondition == 'IS NOT'))) {
-                        $isCondition = (($isCondition == 'IS') || ($isCondition == 'IS NOT')) ? $isCondition : 'IS';
-                        $where .= "$key ".$isCondition." NULL $combineWith ";
-                    } elseif ((($isCondition == \_LIKE) || ($isCondition == \_notLIKE)) && ! \preg_match('/[_%?]/', $val)) {
-                        return $this->clearPrepare();
-                    } else {
+					$combineWith = $myCombineWith;
+				} elseif ($isCondition == \_IN) {
+					$value = '';
+					foreach ($val as $inValues) {
 						if ($this->isPrepareOn()) {
-							$where .= "$key ".$isCondition.' '.\_TAG." $combineWith ";
-							$this->addPrepare($val);
+							$value .= \_TAG.', ';
+							$this->addPrepare($inValues);
 						} else 
-							$where .= "$key ".$isCondition." '".$this->escape($val)."' $combineWith ";
-                    }
-                    
-                    $i++;
-                }
+							$value .= "'".$this->escape($inValues)."', ";
+                    }                        
+					$where .= "$key ".$isCondition." ( ".\rtrim($value, ', ')." ) $combineWith ";
+				} elseif (((\strtolower($val) == 'null') || ($isCondition == 'IS') || ($isCondition == 'IS NOT'))) {
+                     $isCondition = (($isCondition == 'IS') || ($isCondition == 'IS NOT')) ? $isCondition : 'IS';
+                    $where .= "$key ".$isCondition." NULL $combineWith ";
+                } elseif ((($isCondition == \_LIKE) || ($isCondition == \_notLIKE)) && ! \preg_match('/[_%?]/', $val)) {
+                    return $this->clearPrepare();
+                } else {
+					if ($this->isPrepareOn()) {
+						$where .= "$key ".$isCondition.' '.\_TAG." $combineWith ";
+						$this->addPrepare($val);
+					} else 
+						$where .= "$key ".$isCondition." '".$this->escape($val)."' $combineWith ";
+                }                    
+                $i++;
             }
             $where = \rtrim($where, " $combineWith ");
         }
@@ -507,15 +504,15 @@ public function unionAll(string $table = null, $columnFields = '*', ...$conditio
         return 'UNION ALL '.$this->select_sql($table, $columnFields, ...$conditions);             
     }
 
-    public function create_select(string $newTable, $fromColumns, $oldTable = null, ...$fromWhere) 
+    public function create_select(string $newTable, $fromColumns, $oldTable = null, ...$conditions) 
     {
 		if (isset($oldTable))
 			$this->fromTable = $oldTable;
 		else {
             return $this->clearPrepare();            
         }
 			
-        $newTableFromTable = $this->select_sql($newTable, $fromColumns, ...$fromWhere);			
+        $newTableFromTable = $this->select_sql($newTable, $fromColumns, ...$conditions);			
         if (is_string($newTableFromTable))
             return (($this->isPrepareOn()) && !empty($this->prepareValues())) 
                 ? $this->query($newTableFromTable, true) 
@@ -524,15 +521,15 @@ public function create_select(string $newTable, $fromColumns, $oldTable = null,
         return $this->clearPrepare();   
     }
     
-    public function select_into(string $newTable, $fromColumns, $oldTable = null, ...$fromWhere) 
+    public function select_into(string $newTable, $fromColumns, $oldTable = null, ...$conditions) 
     {
 		$this->isInto = true;        
 		if (isset($oldTable))
 			$this->fromTable = $oldTable;
 		else
 			return $this->clearPrepare();
 			
-        $newTableFromTable = $this->select_sql($newTable, $fromColumns, ...$fromWhere);
+        $newTableFromTable = $this->select_sql($newTable, $fromColumns, ...$conditions);
         if (is_string($newTableFromTable))
             return (($this->isPrepareOn()) && !empty($this->prepareValues())) 
                 ? $this->query($newTableFromTable, true) 
@@ -541,7 +538,7 @@ public function select_into(string $newTable, $fromColumns, $oldTable = null, ..
         return $this->clearPrepare();     
     }
 
-    public function update(string $table = null, $keyAndValue, ...$whereKeys) 
+    public function update(string $table = null, $keyAndValue, ...$whereConditions) 
     {        
         if ( ! is_array( $keyAndValue ) || empty($table) ) {
 			return $this->clearPrepare();
@@ -563,7 +560,7 @@ public function update(string $table = null, $keyAndValue, ...$whereKeys)
 			}
         }
         
-        $where = $this->where(...$whereKeys);
+        $where = $this->where(...$whereConditions);
         if (\is_string($where)) {   
             $sql = \rtrim($sql, ', ') . $where;
             return (($this->isPrepareOn()) && !empty($this->prepareValues())) 
@@ -574,15 +571,15 @@ public function update(string $table = null, $keyAndValue, ...$whereKeys)
         return $this->clearPrepare();
     }   
          
-    public function delete(string $table = null, ...$whereKeys) 
+    public function delete(string $table = null, ...$whereConditions) 
     {   
         if ( empty($table) ) {
 			return $this->clearPrepare();         			
 		}  
 		
         $sql = "DELETE FROM $table";
         
-        $where = $this->where(...$whereKeys);
+        $where = $this->where(...$whereConditions);
         if (\is_string($where)) {   
             $sql .= $where;						
             return (($this->isPrepareOn()) && !empty($this->prepareValues())) 
@@ -664,10 +661,10 @@ public function insert(string $table = null, $keyAndValue)
         return $this->_query_insert_replace($table, $keyAndValue, 'INSERT');
     }
 
-    public function insert_select(string $toTable = null, $toColumns = '*', $fromTable = null, $fromColumns = '*', ...$fromWhere) 
+    public function insert_select(string $toTable = null, $toColumns = '*', $fromTable = null, $fromColumns = '*', ...$conditions) 
     {
         $putToTable = $this->_query_insert_replace($toTable, $toColumns, 'INSERT', false);
-        $getFromTable = $this->select_sql($fromTable, $fromColumns, ...$fromWhere);
+        $getFromTable = $this->select_sql($fromTable, $fromColumns, ...$conditions);
 
         if (\is_string($putToTable) && \is_string($getFromTable))
             return (($this->isPrepareOn()) && !empty($this->prepareValues())) 
diff --git a/lib/ezQueryInterface.php b/lib/ezQueryInterface.php

Original file line number	Diff line number	Diff line change
`@@ -60,22 +60,22 @@ function column(string $column = null, string $type = null, ...$args)`
`60`	`60`	`return ezSchema::column($column, $type, ...$args);`
`61`	`61`	`}`
`62`	`62`
`63`		`- function primary(string $constraintName, ...$primaryKeys)`
	`63`	`+ function primary(string $primaryName, ...$primaryKeys)`
`64`	`64`	`{`
`65`	`65`	`array_unshift($primaryKeys, \PRIMARY);`
`66`		`- return \column(\CONSTRAINT, $constraintName, ...$primaryKeys);`
	`66`	`+ return \column(\CONSTRAINT, $primaryName, ...$primaryKeys);`
`67`	`67`	`}`
`68`	`68`
`69`		`- function foreign(string $constraintName, ...$foreignKeys)`
	`69`	`+ function foreign(string $foreignName, ...$foreignKeys)`
`70`	`70`	`{`
`71`	`71`	`array_unshift($foreignKeys, \FOREIGN);`
`72`		`- return \column(\CONSTRAINT, $constraintName, ...$foreignKeys);`
	`72`	`+ return \column(\CONSTRAINT, $foreignName, ...$foreignKeys);`
`73`	`73`	`}`
`74`	`74`
`75`		`- function unique(string $constraintName, ...$uniqueKeys)`
	`75`	`+ function unique(string $uniqueName, ...$uniqueKeys)`
`76`	`76`	`{`
`77`	`77`	`array_unshift($uniqueKeys, \UNIQUE);`
`78`		`- return \column(\CONSTRAINT, $constraintName, ...$uniqueKeys);`
	`78`	`+ return \column(\CONSTRAINT, $uniqueName, ...$uniqueKeys);`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`function index(string $indexName, ...$indexKeys)`