├── MIT-LICENSE.txt ├── README.md ├── GPL-LICENSE.txt └── Db.php /MIT-LICENSE.txt: -------------------------------------------------------------------------------- 1 | Copyright (c) 2011 Adrien Gibrat, https://github.com/adriengibrat/ 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining 4 | a copy of this software and associated documentation files (the 5 | "Software"), to deal in the Software without restriction, including 6 | without limitation the rights to use, copy, modify, merge, publish, 7 | distribute, sublicense, and/or sell copies of the Software, and to 8 | permit persons to whom the Software is furnished to do so, subject to 9 | the following conditions: 10 | 11 | The above copyright notice and this permission notice shall be 12 | included in all copies or substantial portions of the Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## How to use it 2 | 3 | Get new instance like this 4 | ```php 5 | raw( 'SELECT * FROM Table' ); // Execute raw SQL query (don't forget to secure your SQL) 28 | 29 | $db->query( 'SELECT * FROM Table WHERE id = :id', array( 'id' => 1 ) ); // Prepare and execute SQL 30 | 31 | $db->select( 'Table' ); // Select everything (*) from Table 32 | $db->select( 'Table', 'id' ); // Select id column 33 | $db->select( 'Table', array( 'id', 'field' ) ); // Select id & field columns 34 | $db->select( 'Table', '*', array( // Select everything where field1 = $value1 AND field2 = $value2 35 | 'field1' => $value1, 36 | 'field2' => $value2 37 | ) ); 38 | $db->select( 'Table', '*', array( // Complex select where N.B: you can't mix ? and named placeholder 39 | 'field1 >= ? AND field1 <= ? ' => array(42, 100), 40 | 'field2 LIKE ?' => '%test%', 41 | 'field3 = :value OR CHAR_LENGTH(field3) < :length' => array( 42 | 'value' => $value, 43 | 'length' => 10 44 | ) 45 | ) ); 46 | 47 | ``` 48 | ### CRUD methods 49 | ```php 50 | create( 'Table', array( 'field' => 'data' ) ); // Insert into Table 52 | 53 | $db->read( 'Table', 1 ); // Select from Table where primary key = 1 54 | $db->read( 'Table', 'data', 'field' ); // Select from Table where field = 'data' 55 | 56 | $db->update( 'Table', 'field', 'test', 1 ) // Update field to 'test' in Table where primary key = 1 57 | $data = array( 'field' => 'test' ); // Passing data as array shift next arguments 58 | $db->update( 'Table', $data, 1 ) // Equivalent to previous line 59 | $db->update( 'Table', $data, 'test', 'data' ) // Update field(s) containing 'data' to 'test' 60 | 61 | $db->delete( 'Table', 1 ) // Delete Table row where primary key = 1 62 | $db->delete( 'Table', 'test', 'field' ) // Delete Table row where field = 'test' 63 | ``` 64 | ### Fetch methods 65 | ```php 66 | read( 'Table', 1 )->fetch(); // fetch returns objects (stdClass by default) 68 | $db->read( 'Table', 1 )->fetch( 'Class' ); // But you can specify a class 69 | $select = $db->select( 'Table' ); 70 | while ( $row = $select->fetch() ) // It's a row fetching method 71 | echo $row->field; 72 | 73 | $select = $db->select( 'Table' ); 74 | while ( $row = $select->fetch( false ) ) // returns associative array 75 | echo $row[ 'field' ]; 76 | 77 | $db->select( 'Table' )->all(); // all returns all rows (as ArrayObject) 78 | $db->select( 'Table' )->all( 'Class' ); // You also can specify row class 79 | 80 | $db->select( 'Table', 'id' )->column( 'id' ); // column returns only values (as an array) 81 | ``` 82 | ### Various methods 83 | ```php 84 | key( 'Table' ); // Get Table primary key (id) 86 | $db->quote( $value ); // Get quote protected value 87 | $db->create( 'Table', array( 'field' => 'data' ) ); // Add a row, then 88 | $db->id(); // Get last inserted id 89 | ``` 90 | ### Config tricks 91 | Db::config method is a getter and a setter 92 | ```php 93 | setter 95 | Db::config( array( // One array argument -> setter 96 | 'user' => 'databaseUser' 97 | , 'password' => 'databaseUserPassword' 98 | ) ); 99 | 100 | Db::config( 'host' ); // One argument -> getter 101 | ``` 102 | You can store what you want in config (only driver, host, database, user, password & fetch are reserved) 103 | ```php 104 | $login 108 | , 'password' => md5( Db::config( 'salt' ) . $password ) // Hash password 109 | ); 110 | $userId = $db->create( 'User', $user )->id(); // Save new user 111 | ``` 112 | By default fetch method return stdClass, but you can customize globaly 113 | ```php 114 | read( 'Table', 1 )->fetch(); // Methods fetch and all now return Class object(s) 117 | $db->select( 'Table' )->all(); 118 | $db->read( 'Table', 1 )->fetch( 'OtherClass' ); // You still can override it 119 | ``` 120 | Read, update and delete methods automatically guess which primary key to use, 121 | but you can set/override it manually 122 | ```php 123 | read( 'Table', 'test' ); // Now, this select from Table where field = 'test' 126 | ``` 127 | -------------------------------------------------------------------------------- /GPL-LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | -------------------------------------------------------------------------------- /Db.php: -------------------------------------------------------------------------------- 1 | 'mysql' 14 | , 'host' => 'localhost' 15 | , 'port' => 3307 16 | , 'fetch' => 'stdClass' 17 | ); 18 | /** 19 | * Get and set default Db configurations 20 | * @uses static::config 21 | * @param string|array $key [Optional] Name of configuration or hash array of configurations names / values 22 | * @param mixed $value [Optional] Value of the configuration 23 | * @return mixed Configuration value(s), get all configurations when called without arguments 24 | */ 25 | static public function config ( $key = null, $value = null ) { 26 | if ( ! isset( $key ) ) 27 | return static::$config; 28 | if ( isset( $value ) ) 29 | return static::$config[ (string) $key ] = $value; 30 | if ( is_array( $key ) ) 31 | return array_map( 'static::config', array_keys( (array) $key ), array_values( (array) $key ) ); 32 | if ( isset( static::$config[ $key ] ) ) 33 | return static::$config[ $key ]; 34 | } 35 | /* Static instances */ 36 | /** 37 | * Multiton instances 38 | * @var array 39 | */ 40 | protected static $instance = array(); 41 | protected static $arguments = array( 'driver', 'host', 'database', 'user', 'password' ); 42 | /** 43 | * Get singleton instance 44 | * @uses static::config 45 | * @uses static::__construct 46 | * @param string $driver [Optional] Database driver 47 | * @param string $host [Optional] Database host 48 | * @param string $database [Optional] Database name 49 | * @param string $user [Optional] User name 50 | * @param string $pass [Optional] User password 51 | * @return Db Singleton instance 52 | */ 53 | static public function __callStatic ( $name, $config ) { 54 | if ( isset( static::$instance[ $name ] ) ) 55 | return static::$instance[ $name ]; 56 | $config = array_merge( 57 | static::config(), 58 | array_filter( array_combine( static::$arguments, $config + array_fill( 0, count( static::$arguments ), null ) ) ) 59 | ); 60 | return static::$instance[ $name ] = new static( $config[ 'driver' ], $config[ 'host' ], $config[ 'database' ], $config[ 'user' ], $config[ 'password' ] ); 61 | } 62 | /* Constructor */ 63 | /** 64 | * Database connection 65 | * @var PDO 66 | */ 67 | protected $db; 68 | /** 69 | * Latest query statement 70 | * @var PDOStatement 71 | */ 72 | protected $result; 73 | /** 74 | * Database information 75 | * @var stdClass 76 | */ 77 | protected $info; 78 | /** 79 | * Statements cache 80 | * @var array 81 | */ 82 | protected $statement = array(); 83 | /** 84 | * Tables shema information cache 85 | * @var array 86 | */ 87 | protected $table = array(); 88 | /** 89 | * Primary keys information cache 90 | * @var array 91 | */ 92 | protected $key = array(); 93 | /** 94 | * Constructor 95 | * @uses PDO 96 | * @throw PDOException 97 | * @param string $driver Database driver 98 | * @param string $host Database host 99 | * @param string $database Database name 100 | * @param string $user User name 101 | * @param string $pass [Optional] User password 102 | * @see http://php.net/manual/fr/pdo.construct.php 103 | * @todo Support port/socket within DSN? 104 | */ 105 | public function __construct ( $driver, $host, $database, $user, $password = null ) { 106 | set_exception_handler( array( __CLASS__, 'safe_exception' ) ); 107 | $this->db = new pdo( $driver . ':host=' . $host . ';dbname=' . $database, $user, $password, array( 108 | PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION 109 | ) ); 110 | restore_exception_handler(); 111 | $this->db->exec('SET NAMES "UTF8"'); 112 | $this->info = (object) array_combine( static::$arguments, func_get_args() ); 113 | unset($this->info->password); 114 | } 115 | /** 116 | * Avoid exposing exception informations 117 | * @param Exception $exception [Optional] User password 118 | */ 119 | public static function safe_exception ( Exception $exception ) { 120 | die( 'Uncaught exception: ' . $exception->getMessage() ); 121 | } 122 | /* SQL query */ 123 | /** 124 | * Get latest SQL query 125 | * @return string Latest SQL query 126 | */ 127 | public function __toString () { 128 | return $this->result ? 129 | $this->result->queryString : 130 | null; 131 | } 132 | /* Query methods */ 133 | /** 134 | * Execute raw SQL query 135 | * @uses PDO::query 136 | * @throw PDOException 137 | * @param string $sql Plain SQL query 138 | * @return Db Self instance 139 | * @todo ? detect USE query to update dbname ? 140 | */ 141 | public function raw ( $sql ) { 142 | $this->result = $this->db->query( $sql ); 143 | return $this; 144 | } 145 | /** 146 | * Execute SQL query with paramaters 147 | * @uses PDO::prepare 148 | * @uses self::_uncomment 149 | * @uses PDOStatement::execute 150 | * @throw PDOException 151 | * @param string $sql SQL query with placeholder 152 | * @param array $params SQL parameters to escape (quote) 153 | * @return Db Self instance 154 | */ 155 | public function query ( $sql, array $params ) { 156 | $this->result = isset( $this->statement[ $sql ] ) ? 157 | $this->statement[ $sql ] : 158 | $this->statement[ $sql ] = $this->db->prepare( self::_uncomment( $sql ) ); 159 | $this->result->execute( $params ); 160 | return $this; 161 | } 162 | /** 163 | * Execute SQL select query 164 | * @uses PDO::query 165 | * @throw PDOException 166 | * @param string $table 167 | * @param string|array $fields [Optional] 168 | * @param string|array $where [Optional] 169 | * @param string $order [Optional] 170 | * @param string|int $limit [Optional] 171 | * @return Db Self instance 172 | * @todo Need complete review 173 | */ 174 | public function select ( $table, $fields = '*', $where = null, $order = null, $limit = null ) { 175 | $sql = 'SELECT ' . self::_fields( $fields ) . ' FROM ' . $this->_table( $table ); 176 | if ( $where && $where = $this->_conditions( $where ) ) 177 | $sql .= ' WHERE ' . $where->sql; 178 | if ( $order ) 179 | $sql .= ' ORDER BY ' . ( is_array( $order ) ? implode( ', ', $order ) : $order ); 180 | if ( $limit ) 181 | $sql .= ' LIMIT ' . $limit; 182 | return $where ? 183 | $this->query( $sql, $where->params ) : 184 | $this->raw( $sql ); 185 | } 186 | /* Query formating helpers */ 187 | /** 188 | * Check if data is a plain key (without SQL logic) 189 | * @param mixed $data Data to check 190 | * @return bool 191 | */ 192 | static protected function _is_plain ( $data ) { 193 | if ( ! is_scalar( $data ) ) 194 | return false; 195 | return is_string( $data ) ? ! preg_match( '/\W/i', $data ) : true; 196 | } 197 | /** 198 | * Check if array is a simple indexed list 199 | * @param array $array Array to check 200 | * @return bool 201 | */ 202 | static protected function _is_list ( array $array ) { 203 | foreach ( array_keys( $array ) as $key ) 204 | if ( ! is_int( $key ) ) 205 | return false; 206 | return true; 207 | } 208 | /** 209 | * Remove all (inline & multiline bloc) comments from SQL query 210 | * @param string $sql SQL query string 211 | * @return string SQL query string without comments 212 | */ 213 | static protected function _uncomment ( $sql ) { 214 | /* '@ 215 | (([\'"`]).*?[^\\\]\2) # $1 : Skip single & double quoted expressions 216 | |( # $3 : Match comments 217 | (?:\#|--).*?$ # - Single line comments 218 | | # - Multi line (nested) comments 219 | /\* # . comment open marker 220 | (?: [^/*] # . non comment-marker characters 221 | |/(?!\*) # . ! not a comment open 222 | |\*(?!/) # . ! not a comment close 223 | |(?R) # . recursive case 224 | )* # . repeat eventually 225 | \*\/ # . comment close marker 226 | )\s* # Trim after comments 227 | |(?<=;)\s+ # Trim after semi-colon 228 | @msx' */ 229 | return trim( preg_replace( '@(([\'"`]).*?[^\\\]\2)|((?:\#|--).*?$|/\*(?:[^/*]|/(?!\*)|\*(?!/)|(?R))*\*\/)\s*|(?<=;)\s+@ms', '$1', $sql ) ); 230 | } 231 | /** 232 | * Format query parameters 233 | * @uses self::_escape 234 | * @param string|array $data Data to format 235 | * @param string $operator [Optional] 236 | * @param string $glue [Optional] 237 | * @return string SQL params query chunk 238 | * @todo Handle integer keys like in self::_conditions 239 | */ 240 | static protected function _params ( $data, $operator = '=', $glue = ', ' ) { 241 | $params = is_string( $data) ? array( $data ) : array_keys( (array) $data ); 242 | foreach ( $params as &$param ) 243 | $param = implode( ' ', array( self::_escape( $param ), $operator, ':' . $param ) ); 244 | return implode( $glue, $params ); 245 | } 246 | /** 247 | * Format query fields 248 | * @uses self::_is_plain 249 | * @param string $field Field String 250 | * @return string SQL field query chunk 251 | */ 252 | static protected function _escape ( $field ) { 253 | return self::_is_plain( $field ) ? 254 | '`' . $field . '`' : 255 | $field; 256 | } 257 | static protected function _extract ( $table, $type = 'table' ) { 258 | static $infos = array( 259 | 'database' => '@(?:(`?)(?P\w+)\g{-2})\.(`?)(?P\w+)\g{-2}(?:\.(`?)(?P\w+)\g{-2})?@' 260 | , 'table' => '@(?:(`?)(?P\w+)\g{-2}\.)?(?:(`?)(?P
\w+)\g{-2})(?:\.(`?)(?P\w+)\g{-2})?@' 261 | , 'field' => '@(?:(`?)(?P\w+)\g{-2}\.)?(?:(`?)(?P
\w+)\g{-2}\.)?(`?)(?P\w+)\g{-2}@' 262 | ); 263 | if ( ! isset( $infos[ $type ] ) || ! preg_match( $infos[ $type ], $table, $match ) ) 264 | return; 265 | $match = array_filter( array_intersect_key( $match, $infos ) ); 266 | return $match[ $type ]; 267 | } 268 | static protected function _alias ( array $alias ) { 269 | foreach ( $alias as $k => $v ) 270 | $_alias[] = self::_escape( $v ) . ( is_string( $k ) ? ' AS '. self::_escape( $k ) : '' ); 271 | return $_alias; 272 | } 273 | static protected function _fields ( $fields ) { 274 | if ( empty( $fields ) ) 275 | return '*'; 276 | if ( is_string( $fields ) ) 277 | return $fields; 278 | return implode( ', ', self::_alias ( $fields ) ); 279 | } 280 | //@todo 281 | static protected function _conditions ( array $conditions ) { 282 | $sql = array(); 283 | $params = array(); 284 | $i = 0; 285 | foreach ( $conditions as $condition => $param ) { 286 | if ( is_string( $condition ) ) { 287 | for ( $keys = array(), $n = 0; false !== ( $n = strpos( $condition, '?', $n ) ); $n ++ ) 288 | $condition = substr_replace( $condition, ':' . ( $keys[] = '_' . ++ $i ), $n, 1 ); 289 | if ( ! empty( $keys ) ) 290 | $param = array_combine( $keys, (array) $param ); 291 | if ( self::_is_plain( $condition ) ) { 292 | $param = array( $condition => (string) $param ); 293 | $condition = self::_params( $condition ); 294 | } 295 | $params += (array) $param; 296 | } else 297 | $condition = $param; 298 | $sql[] = $condition; 299 | } 300 | return (object) array( 301 | 'sql' => '( ' . implode( ' ) AND ( ', $sql ) . ' )', 302 | 'params' => $params 303 | ); 304 | } 305 | protected function _table ( $table, $escape = true ) { 306 | return $escape ? 307 | self::_escape( $this->_database( $table ) ) . '.' . self::_escape( self::_extract( $table, 'table' ) ) : 308 | $this->_database( $table ) . '.' . self::_extract( $table, 'table' ); 309 | } 310 | protected function _database ( $table = null ) { 311 | return self::_extract( $table, 'database' ) ?: 312 | $this->info->database; 313 | } 314 | /* Data column helpers */ 315 | static protected function _column ( array $data, $field ) { 316 | $column = array(); 317 | foreach ( $data as $key => $row ) 318 | if ( is_object( $row ) && isset( $row->{$field} ) ) 319 | $column[ $key ] = $row->{$field}; 320 | else if ( is_array( $row ) && isset( $row[ $field ] ) ) 321 | $column[ $key ] = $row[ $field ]; 322 | else 323 | $column[ $key ] = null; 324 | return $column; 325 | } 326 | static protected function _index ( array $data, $field ) { 327 | return array_combine( 328 | self::_column( $data, $field ), 329 | $data 330 | ); 331 | } 332 | /* CRUD methods */ 333 | public function create ( $table, array $data ) { 334 | $keys = array_keys( $data ); 335 | $sql = 'INSERT INTO ' . $this->_table( $table ) . ' (' . implode( ', ', $keys ) . ') VALUES (:' . implode( ', :', $keys ) . ')'; 336 | return $this->query( $sql, $data ); 337 | } 338 | //public function read ( $table, $where ) 339 | public function read ( $table, $id, $key = null ) { 340 | $key = $key ?: current( $this->key( $table ) ); 341 | $sql = 'SELECT * FROM ' . $this->_table( $table ) . ' WHERE ' . self::_params( $key ); 342 | return $this->query( $sql, array( ':' . $key => $id ) ); 343 | } 344 | //public function update ( $table, $data, $where ) 345 | public function update ( $table, $data, $value = null, $id = null, $key = null ) { 346 | if ( is_array( $data ) ) { 347 | $key = $id; 348 | $id = $value; 349 | } else 350 | $data = array( $data => $value ); 351 | $key = $key ?: current( $this->key( $table ) ); 352 | if ( is_null( $id ) && isset( $data[ $key ] ) && ! ( $id = $data[ $key ] ) ) 353 | throw new Exception( 'No `' . $key . '` key value to update `' . $table . '` table, please specify a key value' ); 354 | $sql = 'UPDATE ' . $this->_table( $table ) . ' SET ' . self::_params( $data ) . ' WHERE ' . self::_params( $key ); 355 | return $this->query( $sql, array_merge( $data, array( ':' . $key => $id ) ) ); 356 | } 357 | //public function delete ( $table, $where ) 358 | public function delete ( $table, $id, $key = null ) { 359 | $key = $key ?: current( $this->key( $table ) ); 360 | $sql = 'DELETE FROM ' . $this->_table( $table ) . ' WHERE ' . self::_params( $key ); 361 | return $this->query( $sql, array( ':' . $key => $id ) ); 362 | } 363 | /* Fetch methods */ 364 | public function fetch ( $class = null ) { 365 | if ( ! $this->result ) 366 | throw new Exception( 'Can\'t fetch result if no query!' ); 367 | return $class === false ? 368 | $this->result->fetch( PDO::FETCH_ASSOC ) : 369 | $this->result->fetchObject( $class ?: self::config( 'fetch' ) ); 370 | } 371 | public function all ( $class = null ) { 372 | if ( ! $this->result ) 373 | throw new Exception( 'Can\'t fetch results if no query!' ); 374 | return $class === false ? 375 | $this->result->fetchAll( PDO::FETCH_ASSOC ) : 376 | $this->result->fetchAll( PDO::FETCH_CLASS, $class ?: self::config( 'fetch' ) ); 377 | } 378 | public function column ( $field, $index = null ) { 379 | $data = $this->all( false ); 380 | $values = self::_column( $data, $field ); 381 | return is_string( $index ) ? 382 | array_combine( self::_column( $data, $index ), $values ) : 383 | $values; 384 | } 385 | /* Table infos */ 386 | public function key ( $table ) { 387 | $table = $this->_table( $table, false ); 388 | if ( self::config( $table . ':PK' ) ) 389 | return self::config( $table . ':PK' ); 390 | else if ( isset( $this->key[ $table ] ) ) 391 | return $this->key[ $table ]; 392 | $keys = array_keys( self::_column( $this->fields( $table ), 'key' ), 'PRI' ); 393 | if ( empty( $keys ) ) 394 | throw new Exception( 'No primary key on ' . $this->_table( $table ) . ' table, please set a primary key' ); 395 | return $this->key[ $table ] = $keys; 396 | } 397 | public function fields ( $table ) { 398 | $table = $this->_table( $table, false ); 399 | if ( isset( $this->table[ $table ] ) ) 400 | return $this->table[ $table ]; 401 | $sql = 'SELECT 402 | `COLUMN_NAME` AS `name`, 403 | `COLUMN_DEFAULT` AS `default`, 404 | NULLIF( `IS_NULLABLE`, "NO" ) AS `null`, 405 | `DATA_TYPE` AS `type`, 406 | COALESCE( `CHARACTER_MAXIMUM_LENGTH`, `NUMERIC_PRECISION` ) AS `length`, 407 | `CHARACTER_SET_NAME` AS `encoding`, 408 | `COLUMN_KEY` AS `key`, 409 | `EXTRA` AS `auto`, 410 | `COLUMN_COMMENT` AS `comment` 411 | FROM `INFORMATION_SCHEMA`.`COLUMNS` 412 | WHERE 413 | `TABLE_SCHEMA` = ' . $this->quote( self::_database( $table ) ) . ' AND 414 | `TABLE_NAME` = ' . $this->quote( self::_extract( $table ) ) . ' 415 | ORDER BY `ORDINAL_POSITION` ASC'; 416 | $fields = $this->db->query( $sql ); 417 | if ( ! $fields->rowCount() ) 418 | throw new Exception( 'No ' . $this->_table( $table ) . ' table, please specify a valid table' ); 419 | return $this->table[ $table ] = self::_index( $fields->fetchAll( PDO::FETCH_CLASS ), 'name' ); 420 | } 421 | /* Quote Helper */ 422 | public function quote ( $value ) { 423 | return is_null( $value ) ? 424 | 'NULL' : 425 | $this->db->quote( $value ); 426 | } 427 | public function database ( $table = null ) { 428 | return $this->_table( $table, true ) ?: 429 | $this->info->database; 430 | } 431 | /* Statement infos */ 432 | public function id () { 433 | // !! see http://php.net/manual/fr/pdo.lastinsertid.php 434 | return $this->db->lastInsertId(); 435 | } 436 | public function count () { 437 | return $this->result ? 438 | $this->result->rowCount() : 439 | null; 440 | } 441 | 442 | } 443 | --------------------------------------------------------------------------------