From 8f7273e3d061ac4da59a0038b8eb250c9a83852b Mon Sep 17 00:00:00 2001 From: kprkpr Date: Wed, 20 Sep 2017 14:35:54 +0200 Subject: [PATCH] Initial commit --- LICENSE | 201 +++++++++++++++++++++++++++++++++++++++ README.md | 62 ++++++++++++ src/dbwrapper.php | 235 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 498 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 src/dbwrapper.php diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9b5a79a --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2017 Code Solutions Project + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f8ffd6 --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# DBWrapper - Version 1.4 + +This script is a simple wrapper for SQLite3, MySQL and PgSQL, for make possible to use different BD systems without changing the functions. + +## Avalible functions: +* To connect +```php +//$server is location in SQLite3 +resource dbw_connect (string $tdb,string $server[,string $database, string $user,string $password]); +``` +* To close +```php + //Closes connection +bool dbw_close (resource $conn); +``` +* Queries +```php +//Does a query +mixed dbw_query (resource $conn, string $query); +//This does a multiquery without returning nothing. Its used for load from a file/script +bool dbw_multi_query(resource $conn, string $multiquery); +//Fetch a row. ($typearray optional, see below) +array dbw_fetch_array (resource $conn,resource $result[, string $typearray]); +//This do a query and fetch array, all in one function($typearray optional, see below) +array dbw_query_fetch_array (resource $conn,string $query[, string $typearray]); +``` +* Using result of a query +```php +//Wrappers of dbw_fetch_array with row or assoc arguments +array dbw_fetch_row(resource $conn,resource $result); +array dbw_fetch_assoc(resource $conn,resource $result); +//Goto X result of a query. If row is not specified, will be first row, 0 +bool array dbw_query_goto(resource $conn,resource $result[,int $row]) ; +//Return number of results of a query +int dbw_num_rows(resource $conn, resource $result); +``` +* Without a query +```php +// Escapes conflictive chars for inserting into database +string dbw_escape_string(resource $conn,string $string); +//Returns last insert ID +int dbw_last_id(resource $conn); +//Alias of dbw_last_id +int dbw_insert_id(resource $conn); +``` +* Important details + + ``` + $tdb (Type of database) can be: + -mysql/mysqli -> MySQL or MariaDB + -sqlite/sqlite3 -> Sqlite3 + -PostgreSQL/PgSQL/pg -> PostgreSQL + + $conn is the connection stablished in dbw_connect (ie. $conn = dbw_connect('sqlite','file.sqlite')) + + $typearray is the form of array is returned, and not writed is default: + -ASSOC -> Associative indexes + -NUM -> Numeric indexes + -BOTH -> (Default) Both types of indexes + ``` + + diff --git a/src/dbwrapper.php b/src/dbwrapper.php new file mode 100644 index 0000000..f91ff98 --- /dev/null +++ b/src/dbwrapper.php @@ -0,0 +1,235 @@ + some values are optional, + except $tdb and $server. $server is location in SQLite3 + dbw_close ($conn) -> Closes connection + + dbw_query ($conn,$query) -> Does a query + dbw_multi_query($conn,$multiquery) -> This does a multiquery without returning nothing. + Its used for load from a file/script + dbw_query_fetch_array ($conn,$query[,$typearray]) -> This do a query and fetch array, all in one function + ($typearray optional, see below) + + --After here, this functions works with result of a query-- + + dbw_fetch_array ($conn,$result[,$typearray]) -> Fetch a row. ($typearray optional, see below) + dbw_escape_string($conn,$string) -> Escapes conflictive chars for inserting into database + + dbw_fetch_row and dbw_fetch_assoc ($conn,$result) -> Wrappers of dbw_fetch_array with row or assoc arguments + dbw_query_goto($conn,$result[,$row]) -> Goto X result of a query. If row is not specified, will be first row, 0 + dbw_num_rows($conn,$result) -> Return number of results of a query + + --This doesnt need a query-- + dbw_last_id($conn) -> Returns last insert ID + dbw_insert_id($conn) -> Alias of dbw_last_id + + + $tdb (Type of database) can be: + -mysql/mysqli -> MySQL or MariaDB + -sqlite/sqlite3 -> Sqlite3 + -PostgreSQL/PgSQL/pg -> PostgreSQL + + $conn is the connection stablished in dbw_connect (ie. $conn = dbw_connect('sqlite','file.sqlite')) + $typearray is the form of array is returned, and not writed is default: + -ASSOC -> Associative indexes + -NUM -> Numeric indexes + -BOTH -> (Default) Both types of indexes +*/ + + +/** Connect with database */ +function dbw_connect($tdb,$server,$database=NULL,$user = NULL,$password=NULL){ + switch ($tdb){ + case "mysql": + case "mysqli": + $return[0] = mysqli_connect($server,$user,$password,$database) or die("Error de conexion"); + $return[1] = "mysqli"; //Return standard mysqli for other funcs. + break; + case "sqlite": + case "sqlite3": + $return[0] = new SQLite3($server); + if (!$return[0]) die ("Error de conexion"); + $return[1] = "sqlite"; //Return standard SQLite3 for other funcs. + break; + case "PostgreSQL": + case "pg": + case "PgSQL": + $return[0] = pg_connect("host=$server dbname=$database user=$user password=$password") or die ('Error de conexion: ' . pg_last_error()); + $return[1] = "PgSQL"; //Return standard PgSQL for other funcs. + break; + default: + return false; + break; + } + return $return; +} + +/** Escapes conflictive chars for inserting into database */ +function dbw_escape_string($conn,$string){ + switch ($conn[1]){ + case "mysqli": + return mysqli_escape_string($conn[0],$string); + case "sqlite": + return SQLite3::escapeString($string); + case "PgSQL": + return pg_escape_string($string); + } +} + + +/** Make query */ +function dbw_query($conn,$query){ + switch ($conn[1]){ + case "mysqli": + return mysqli_query($conn[0],$query); + break; + case "sqlite": + return $conn[0]->query($query); + break; + case "PgSQL": + return pg_query($query); //Last error (pg_last_error()) not implemented + break; + default: + return false; + break; + } +} + +/** Fetch array from query */ +function dbw_fetch_array($conn,$result,$typearray = NULL){ + if ($result == false || $result == NULL){return false;} + switch ($conn[1]){ + case "mysqli": + if ($typearray == NULL || $typearray == "BOTH"){return mysqli_fetch_array($result);} + if ($typearray == "ASSOC"){return mysqli_fetch_array($result,MYSQLI_ASSOC);} + if ($typearray == "NUM"){return mysqli_fetch_array($result,MYSQLI_NUM);} + break; + case "sqlite": + if ($typearray == NULL || $typearray == "BOTH"){return $result->fetchArray();} + if ($typearray == "ASSOC"){return $result->fetchArray(SQLITE3_ASSOC);} + if ($typearray == "NUM"){return $result->fetchArray(SQLITE3_NUM);} + break; + case "PgSQL": + if ($typearray == NULL || $typearray == "BOTH"){return pg_fetch_array($result);} + if ($typearray == "ASSOC"){return pg_fetch_array($result,NULL,PGSQL_ASSOC);} + if ($typearray == "NUM"){return pg_fetch_array($result,NULL,PGSQL_NUM);} + break; + default: + return false; + break; + } +} + +/** Make query and fetch array */ +function dbw_query_fetch_array($conn,$query){ + switch ($conn[1]){ + case "mysqli": + $query = mysqli_query($conn[0],$query); + if ($query == false || $query == NULL){return false;} + return mysqli_fetch_array($query); + break; + case "sqlite": + $query = $conn[0]->query($query); + if ($query == false || $query == NULL){return false;} + return $query->fetchArray(); + break; + case "PgSQL": + $query = pg_query($query); + if ($query == false || $query == NULL){return false;} + return pg_fetch_array($query); //Last error (pg_last_error()) not implemented + break; + } +} + +/** Goes a query to $row. $row starts in 0 as first row as if not specified */ +function dbw_query_goto($conn,$result,$row = 0){ + switch ($conn[1]){ + case "mysqli": + mysqli_data_seek($result,$row); + break; + case "sqlite": + $result->reset(); + $count = 0; + while ($count != $row){ + $result->fetchArray(); + } + break; + case "PgSQL": + pg_result_seek($result, $row); + break; + } +} + +/** Does multiple querys in one command */ +function dbw_multi_query($conn,$query){ + switch ($conn[1]){ + case "mysqli": + mysqli_multi_query($conn[0],$query); + break; + case "sqlite": + $conn[0]->exec($query); + break; + case "PgSQL": + die ("No soportado aun"); // TODO + break; + } +} + +/** Returns the lastest Insert ID */ +function dbw_last_id($conn){ + switch ($conn[1]){ + case "mysqli": + return mysqli_insert_id($conn[0]); + break; + case "sqlite": + return $conn[0]->lastInsertRowID(); + break; + case "PgSQL": + return pg_fetch_array(pg_query("SELECT lastval();"))[0]; + break; + } +} + + +/** Returns number of results */ +function dbw_num_rows($conn,$result){ + switch ($conn[1]){ + case "mysqli": + return mysqli_num_rows($result); + break; + case "sqlite": + die ("No soportado aun"); // TODO + break; + case "PgSQL": + die ("No soportado aun"); // TODO + break; + } +} + + +/** Close connection */ +function dbw_close($conn){ + switch ($conn[1]){ + case "mysqli": + mysqli_close($conn[0]); + break; + case "sqlite": + $conn[0]->close(); + break; + case "PgSQL": + pg_close($conn[0]); + break; + } +} + +/** Some internal wrappers for functions that are equal to other with arguments */ + +function dbw_fetch_assoc($conn,$result){return dbw_fetch_array($conn,$result,"ASSOC");} +function dbw_fetch_row($conn,$result){return dbw_fetch_array($conn,$result,"NUM");} +function dbw_insert_id($conn){return dbw_last_id($conn);} + +?> \ No newline at end of file