├── .gitignore ├── README.md ├── bin ├── OBJ_mysql.php └── OBJ_mysql_result.php ├── composer.json ├── example.php └── gpl-3.0.txt /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_store 2 | test/ 3 | docs/ 4 | phpdox.xml.dist 5 | phpdox.xml 6 | 7 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | OBJ-MySQL 2 | ========= 3 | [![Latest Stable Version](https://poser.pugx.org/entomb/obj_mysql/v/stable.png)](https://packagist.org/packages/entomb/obj_mysql) 4 | [![Total Downloads](https://poser.pugx.org/entomb/obj_mysql/downloads.png)](https://packagist.org/packages/entomb/obj_mysql) 5 | [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/entomb/obj-mysql/trend.png)](https://bitdeli.com/free "Bitdeli Badge") 6 | 7 | 8 | OBJ MySQL is a simple MySQL Abstraction Layer for PHP>5.2 that provides a simple and _secure_ interaction with your database using mysqli_* functions at its core. 9 | 10 | OBJ-MySQL is perfect for small scale applications such as cron jobs, facebook canvas campaigns or micro frameworks or sites. 11 | 12 | _This project is under construction, any feedback would be appreciated_ 13 | 14 | Author: [Jonathan Tavares](https://github.com/entomb) 15 | 16 | **checkout the [changelog](https://github.com/entomb/OBJ-MySQL/wiki/changelog) for info on the latest changes** 17 | 18 | 19 | 20 | ##Get OBJ_MySQL 21 | You can download it from here, or require it using [composer](https://packagist.org/packages/entomb/obj_mysql). 22 | ```json 23 | { 24 | "require": { 25 | "entomb/obj_mysql": "dev-master" 26 | } 27 | } 28 | ``` 29 | 30 | Or you can require it by cloning this repo 31 | 32 | ```bash 33 | $ git clone https://github.com/entomb/OBJ-MySQL.git 34 | ``` 35 | 36 | If you are already using GIT on you project you can add it as a submodule 37 | 38 | ```bash 39 | $ git submodule add https://github.com/entomb/OBJ-MySQL.git libs/db 40 | ``` 41 | 42 | 43 | ##Starting the driver 44 | To start the db driver you must include the main class file and pass the '$config' array described bellow. 45 | you can have multiple instances of the Class each one with its own $config (one for Reads and one for Writes for example). 46 | 47 | ```php 48 | //include de main OBJ_mysql class file 49 | include("bin/OBJ_mysql.php"); 50 | 51 | //configuration array 52 | $config = array(); 53 | $config["hostname"] = "YOUR_HOST"; 54 | $config["database"] = "YOUR_DATABASE_NAME"; 55 | $config["username"] = "USER_NAME"; 56 | $config["password"] = "PASSWORD"; 57 | 58 | //other configurations 59 | $config["port"] = "PORT"; //defaults to 3306 60 | $config["charset"] = "CHARSET"; //defaults to UTF-8 61 | $config["exit_on_error"] = "TRUE|FALSE"; //defaults to true 62 | $config["allow_logging"] = "TRUE|FALSE"; //defaults to true 63 | 64 | //class instantiation 65 | $db = new OBJ_mysql($config); 66 | 67 | ``` 68 | 69 | 70 | 71 | ##Using OBJ_MySQL 72 | 73 | there are numerous ways of using this library, here are some examples of the most common methods 74 | 75 | ###Selecting and retrieving data from a table 76 | 77 | ```php 78 | $Result = $db->query("SELECT * FROM users"); 79 | $Users = $Result->fetchALL(); 80 | ``` 81 | 82 | ###Inserting data on a table 83 | 84 | To manipulate tables you have the most important methods wrapped, 85 | they all work the same way: parsing arrays of key/value pairs and forming a safe query 86 | 87 | the methods are: 88 | ```php 89 | $db->insert( String $Table, Array $Data); //generates an INSERT query 90 | $db->replace(String $Table, Array $Data); //generates an INSERT OR UPDATE query 91 | $db->update( String $Table, Array $Data, Array $Where); //generates an UPDATE query 92 | $db->delete( String $Table, Array $Where); //generates a DELETE query 93 | ``` 94 | 95 | All methods will return the resulting `mysqli_insert_id()` or true/false depending on context. 96 | The correct approach if to always check if they executed as success is always returned 97 | 98 | ```php 99 | $ok = $db->delete('users', array( 'user_id' => 9 ) ); 100 | if($ok){ 101 | echo "user deleted!"; 102 | }else{ 103 | echo "can't delete user!"; 104 | } 105 | ``` 106 | 107 | **note**: All parameter values are sanitized before execution, you don't have to escape values beforehand. 108 | 109 | ```php 110 | $new_user_id = $db->insert('users', array( 111 | 'name' => "jothn", 112 | 'email' => "johnsmith@email.com", 113 | 'group' => 1, 114 | 'active' => true, 115 | ) 116 | ); 117 | if($new_user_id){ 118 | echo "new user inserted with the id $new_user_id"; 119 | } 120 | ``` 121 | 122 | 123 | ###binding parameters on queries 124 | 125 | Binding parameters is a good way of preventing mysql injections as the parameters are sanitized before execution. 126 | 127 | ```php 128 | $Result = $db->query("SELECT * FROM users WHERE id_user = ? AND active = ? LIMIT 1",array(11,1)); 129 | if($Result){ 130 | $User = $Result->fetchArray(); 131 | print_r($User); 132 | }else{ 133 | echo "user not found"; 134 | } 135 | ``` 136 | 137 | ###Using the OBJ_mysql_result Class 138 | 139 | After executing a `SELECT` query you receive a `OBJ_mysql_result` object that will help you manipulate the resultant data. 140 | There are different ways of accessing this data, check the examples bellow: 141 | 142 | ####Fetching all data 143 | ```php 144 | $Result = $db->query("SELECT * FROM users"); 145 | $AllUsers = $Result->fetchAll(); 146 | ``` 147 | Fetching all data works as `Object` or `Array` the `fetchAll()` method will return the default based on the `$_default_result_type` config. 148 | Other methods are: 149 | 150 | ```php 151 | $Row = $Result->fetch(); // Fetch a single result row as defined by the config (Array or Object) 152 | $Row = $Result->fetchArray(); // Fetch a single result row as Array 153 | $Row = $Result->fetchObject(); // Fetch a single result row as Object 154 | 155 | $Data = $Result->fetchAll(); // Fetch all result data as defined by the config (Array or Object) 156 | $Data = $Result->fetchAllArray(); // Fetch all result data as Array 157 | $Data = $Result->fetchAllObject(); // Fetch all result data as Object 158 | 159 | $Data = $Result->fetchColumn(String $Column); // Fetch a single column in a 1 dimension Array 160 | $Data = $Result->fetchArrayPair(String $key, String $Value); // Fetch data as a key/value pair Array. 161 | 162 | ``` 163 | ####Aliases 164 | ```php 165 | $db->get() // Alias for $db->fetch(); 166 | $db->getAll() // Alias for $db->fetchAll(); 167 | $db->getObject() // Alias for $db->fetchAllObject(); 168 | $db->getArray() // Alias for $db->fetchAllArray(); 169 | $db->getColumn($key) // Alias for $db->fetchColumn($key); 170 | ``` 171 | 172 | ####Iterations 173 | To iterate a resultset, you can use any fetch() method listed above 174 | 175 | ```php 176 | $Result = $db->query("SELECT * FROM users"); 177 | 178 | //using while 179 | while( $row = $Result->fetch() ){ 180 | echo $row->name; 181 | echo $row->email; 182 | } 183 | 184 | //using foreach 185 | foreach( $Result->fetchAll() as $row ){ 186 | echo $row->name; 187 | echo $row->email; 188 | } 189 | 190 | ``` 191 | 192 | ####Logging and Errors 193 | 194 | Showing the query log. the log comes with the SQL executed, the execution time and the result row count (if any) 195 | ```php 196 | 197 | print_r($db->log()); 198 | 199 | ``` 200 | 201 | To debug mysql errors: 202 | 203 | Use `$db->errors()` to fetch all errors (returns false if no errors) or `$db->lastError()` for information on the last error. 204 | 205 | ```php 206 | if( $db->errors() ){ 207 | echo $db->lastError(); 208 | } 209 | ``` 210 | 211 | 212 | 213 | 214 | -------------------------------------------------------------------------------- /bin/OBJ_mysql.php: -------------------------------------------------------------------------------- 1 | 8 | * @license GNU General Public License, version 3 9 | * @link https://github.com/entomb/OBJ-MySQL GitHub Source 10 | * @filesource 11 | * 12 | * 13 | */ 14 | 15 | //load the result class file 16 | include("OBJ_mysql_result.php"); 17 | 18 | /** 19 | * OBJ-mysql - Database Abstraction Class 20 | * 21 | * 22 | ** Config DATA: 23 | ** 24 | ** $config["hostname"] = "YOUR_HOST"; 25 | ** $config["database"] = "YOUR_DATABASE_NAME"; 26 | ** $config["username"] = "USER_NAME"; 27 | ** $config["password"] = "PASSWORD"; 28 | ** $config["port"] = "PORT"; 29 | ** $config["charset"] = "CHARSET"; 30 | ** $config["exit_on_error"] = TRUE; 31 | ** $config["echo_on_error"] = TRUE; 32 | ** $config["allow_logging"] = "TRUE|FALSE"; //defaults to true 33 | * 34 | * 35 | * @package Database 36 | * @subpackage MySQL 37 | * @author Jonathan Tavares 38 | * @license GNU General Public License, version 3 39 | * @link https://github.com/entomb/OBJ-MySQL GitHub Source 40 | * 41 | */ 42 | Class OBJ_mysql{ 43 | 44 | // Default configuration variables 45 | private $hostname = ""; 46 | private $username = ""; 47 | private $password = ""; 48 | private $database = ""; 49 | private $port = "3306"; 50 | private $charset = "utf8"; 51 | 52 | protected $link; 53 | protected $LOG; 54 | protected $connected = false; 55 | private $_errors = array(); 56 | private $allow_logging = true; 57 | 58 | var $query_count = 0; 59 | 60 | var $css_mysql_box_border = "3px solid orange"; 61 | var $css_mysql_box_bg = "#FFCC66"; 62 | var $exit_on_error = true; 63 | var $echo_on_error = true; 64 | 65 | /** 66 | * OBJ_mysql constructor 67 | * 68 | * This is the config array template: 69 | * 70 | ** $config["hostname"] = "YOUR_HOST"; 71 | ** $config["database"] = "YOUR_DATABASE_NAME"; 72 | ** $config["username"] = "USER_NAME"; 73 | ** $config["password"] = "PASSWORD"; 74 | * 75 | * non mandatory configurations 76 | * 77 | ** $config["port"] = "PORT"; //defaults to 3306 78 | ** $config["charset"] = "CHARSET"; //defaults to UTF8 79 | ** $config["exit_on_error"] = "TRUE|FALSE"; //defaults to true 80 | ** $config["echo_on_error"] = "TRUE|FALSE"; //defaults to true 81 | ** $config["allow_logging"] = "TRUE|FALSE"; //defaults to true 82 | * 83 | * 84 | * @param array $config config array 85 | * 86 | */ 87 | function OBJ_mysql($config=null){ 88 | $this->connected = false; 89 | $this->_loadConfig($config); 90 | if($this->connect()){ 91 | $this->set_charset($this->charset); 92 | } 93 | } 94 | 95 | /** 96 | * Establishes the connection 97 | * @return boolean connection status 98 | */ 99 | function connect(){ 100 | if($this->is_ready()) return true; 101 | 102 | $this->link = @mysqli_connect( 103 | $this->hostname, 104 | $this->username, 105 | $this->password, 106 | $this->database, 107 | $this->port 108 | ); 109 | 110 | if(!($this->link)){ 111 | $this->_displayError("Error:" . mysqli_connect_error()); 112 | }else{ 113 | $this->connected = true; 114 | } 115 | 116 | return $this->is_ready(); 117 | } 118 | 119 | /** 120 | * Sets the connection charset 121 | * @param string $charset default is UTF8 122 | */ 123 | function set_charset($charset){ 124 | $this->charset = $charset; 125 | mysqli_set_charset($this->link,$charset); 126 | } 127 | 128 | /** 129 | * Restarts a connection with diferent connection array if given 130 | * @param array $config configuration array 131 | * @return boolean connection status 132 | */ 133 | function reconnect($config=null){ 134 | $this->close(); 135 | $this->_loadConfig($config); 136 | $this->connect(); 137 | return $this->is_ready(); 138 | } 139 | 140 | /** 141 | * checks if the connection is ready 142 | * @return boolean connection status 143 | */ 144 | function is_ready(){ 145 | return ($this->connected) ? true : false; 146 | } 147 | 148 | /** 149 | * Logs a query execution 150 | * @param string $sql SQL query 151 | * @param int $duration execution time 152 | * @param int $results number of affected_rows 153 | * @return void 154 | */ 155 | private function _logQuery($sql,$duration,$results){ 156 | if(!$this->allow_logging){ 157 | return; 158 | } 159 | $this->LOG[] = array( 160 | 'time' => round($duration,5), 161 | 'results' => $results, 162 | 'SQL' => $sql, 163 | ); 164 | } 165 | 166 | /** 167 | * Mysql Query 168 | * @param string $sql the SQL to execute 169 | * @param array $params any array pair of parameters 170 | * @return Object OBJ_mysql_result() or false if the query failed 171 | * @see OBJ_mysql_result() 172 | */ 173 | function query($sql="",$params=false){ 174 | if(!$this->is_ready()) return false; 175 | 176 | if (strlen($sql)==0){ 177 | $this->_displayError("Can't execute an empty Query"); 178 | return; 179 | } 180 | 181 | if($params!==FALSE && is_array($params)){ 182 | $sql = $this->_parseQueryParams($sql,$params); 183 | } 184 | 185 | $this->query_count++; 186 | 187 | $query_start_time = microtime(true); 188 | $result = mysqli_query($this->link, $sql); 189 | $query_duration = microtime(true)-$query_start_time; 190 | 191 | $this->_logQuery($sql, $query_duration, (int)$this->affected_rows() ); 192 | 193 | if(is_object($result) && $result!==null){ 194 | //return query result object 195 | return new OBJ_mysql_result($sql,$result); 196 | }else{ 197 | 198 | if($result===true){ 199 | //this query was successfull 200 | if( preg_match('/^\s*"?(INSERT|UPDATE|DELETE|REPLACE)\s+/i', $sql) ){ 201 | //was it an INSERT? 202 | if($this->insert_id()>0){ 203 | return (int)$this->insert_id(); 204 | } 205 | //was it an UPDATE or DELERE? 206 | if($this->affected_rows()>0){ 207 | return (int)$this->affected_rows(); 208 | } 209 | return true; 210 | }else{ 211 | return true; 212 | } 213 | }else{ 214 | //this query returned an error, we must display it 215 | $this->_displayError( mysqli_error($this->link) ); 216 | } 217 | } 218 | } 219 | 220 | /** 221 | * Creates and executes an insert statement 222 | * @param string $table target table 223 | * @param array $data data to insert 224 | * @return mixed Affected rows or null if the query failed 225 | */ 226 | function insert($table="",$data=array()){ 227 | 228 | if(strlen($table)==0){ 229 | $this->_displayError("invalid table name"); 230 | return false; 231 | } 232 | if(count($data)==0){ 233 | $this->_displayError("empty data to INSERT"); 234 | return false; 235 | } 236 | 237 | //extracting column names 238 | $columns = array_keys($data); 239 | foreach($columns as $k => $_key){ 240 | $columns[$k] = "`".$_key."`"; 241 | } 242 | 243 | $columns = implode(",",$columns); 244 | //extracting values 245 | foreach($data as $k => $_value){ 246 | $data[$k] = $this->secure($_value); 247 | } 248 | $values = implode(",",$data); 249 | 250 | 251 | $sql = "INSERT INTO `".$table."` ($columns) VALUES ($values);"; 252 | 253 | return $this->query($sql); 254 | 255 | } 256 | 257 | /** 258 | * Creates and executes a replace statement 259 | * @param string $table target table 260 | * @param array $data data to insert 261 | * @return mixed Affected rows or null if the query failed 262 | */ 263 | function replace($table="",$data=array()){ 264 | 265 | if(strlen($table)==0){ 266 | $this->_displayError("invalid table name"); 267 | return false; 268 | } 269 | if(count($data)==0){ 270 | $this->_displayError("empty data to INSERT"); 271 | return false; 272 | } 273 | 274 | //extracting column names 275 | $columns = array_keys($data); 276 | foreach($columns as $k => $_key){ 277 | $columns[$k] = "`".$_key."`"; 278 | } 279 | 280 | $columns = implode(",",$columns); 281 | //extracting values 282 | foreach($data as $k => $_value){ 283 | $data[$k] = $this->secure($_value); 284 | } 285 | $values = implode(",",$data); 286 | 287 | 288 | $sql = "REPLACE INTO `".$table."` ($columns) VALUES ($values);"; 289 | 290 | return $this->query($sql); 291 | 292 | } 293 | 294 | /** 295 | * Creates and executes an update statement 296 | * @param string $table target table 297 | * @param array $data data to update 298 | * @param string|array $where where clause 299 | * @return mixed Affected rows or null if the query failed 300 | */ 301 | function update($table="",$data=array(),$where="1=1"){ 302 | 303 | if(strlen($table)==0){ 304 | $this->_displayError("invalid table name"); 305 | return false; 306 | } 307 | if(count($data)==0){ 308 | $this->_displayError("empty data to UPDATE"); 309 | return false; 310 | } 311 | 312 | $SET = $this->_parseArrayPair($data); 313 | 314 | if(is_string($where)){ 315 | $WHERE = ($where); 316 | }elseif(is_array($where)){ 317 | $WHERE = $this->_parseArrayPair($where,"AND"); 318 | } 319 | 320 | $sql = "UPDATE $table SET $SET WHERE ($WHERE);"; 321 | 322 | return $this->query($sql); 323 | 324 | } 325 | 326 | /** 327 | * Creates and executes a delete statement 328 | * @param string $table the target table 329 | * @param string|array $where the where clause 330 | * @return mixed Affected rows or null if the query failed 331 | */ 332 | function delete($table="",$where="1=1"){ 333 | 334 | if(strlen($table)==0){ 335 | $this->_displayError("invalid table name"); 336 | return false; 337 | } 338 | 339 | if(is_string($where)){ 340 | $WHERE = ($where); 341 | }elseif(is_array($where)){ 342 | $WHERE = $this->_parseArrayPair($where,"AND"); 343 | } 344 | 345 | $sql = "DELETE FROM $table WHERE ($WHERE);"; 346 | 347 | return $this->query($sql); 348 | 349 | } 350 | 351 | /** 352 | * Parses arrays with value pairs and generates SQL to use in queries 353 | * 354 | * @access private 355 | * @param array $ArrayPair The value pair to parse 356 | * @param string $glue the glue for the implode(), can be "," for SETs or "AND" for WHEREs 357 | * 358 | */ 359 | private function _parseArrayPair($ArrayPair,$glue=","){ 360 | $sql = ""; 361 | $pairs = array(); 362 | if(!empty($ArrayPair)){ 363 | foreach($ArrayPair as $_key => $_value){ 364 | $_connector = "="; 365 | if(strpos($_key," IS")!==false){ 366 | $_connector = " IS"; 367 | } 368 | if(strpos($_key," IN")!==false){ 369 | $_connector = " IN"; 370 | } 371 | if(strpos($_key," >")!==false && strpos($_key,"=")===false){ 372 | $_connector = " >"; 373 | } 374 | if(strpos($_key," <")!==false && strpos($_key,"=")===false){ 375 | $_connector = " <"; 376 | } 377 | if(strpos($_key," >=")!==false){ 378 | $_connector = " >="; 379 | } 380 | if(strpos($_key," <=")!==false){ 381 | $_connector = " <="; 382 | } 383 | if(strpos($_key," LIKE")!==false){ 384 | $_connector = " LIKE"; 385 | } 386 | 387 | $pairs[] = " `".str_replace($_connector,"",$_key)."` $_connector ".$this->secure($_value)." "; 388 | 389 | } 390 | $sql = implode($glue, $pairs); 391 | } 392 | 393 | return $sql; 394 | } 395 | 396 | /** 397 | * Parsing query parameters replacing any "?" with a given $param 398 | * 399 | * @access private 400 | * @param string $sql SQL query to parse 401 | * @param array $params Array with values to place on any "?" found 402 | * @return string Parsed SQL string 403 | * 404 | */ 405 | private function _parseQueryParams($sql,$params){ 406 | 407 | if (strpos($sql, "?") === FALSE){ //is there anything to parse? 408 | return $sql; 409 | } 410 | if ( !is_array($params) ){ //conver to array 411 | $params = array($params); 412 | } 413 | $parse_key = md5(uniqid(time(),true)); 414 | $parsed_sql = str_replace("?",$parse_key,$sql); 415 | $k = 0; 416 | while(strpos($parsed_sql, $parse_key)>0){ 417 | $value = $this->secure($params[$k]); 418 | $parsed_sql = preg_replace("/$parse_key/",$value,$parsed_sql,1); 419 | $k++; 420 | } 421 | return $parsed_sql; 422 | } 423 | 424 | /** 425 | * Generates secure values depending on the type of the input. 426 | * 427 | * This "smart" function will escape and secure your data depending on its type. 428 | * here are some things you need to know: 429 | * 430 | ** Will send NULL if $var is empty 431 | ** Will treat bools as 0 or 1 432 | ** Will escape any string value 433 | ** Will round(6) any float value. will also replace "," for "." 434 | ** WARNING: Will treat strings cast as an object as RAW MySQL 435 | ** to use this send anything like this (object)"NOW()" and it will bypass the escaping. 436 | ** make sure you only use this when you need to execute raw MySQL functions like NOW() or ENCODE() 437 | * 438 | * @param mixed $var the value to secure 439 | * @return string Secure value 440 | * 441 | */ 442 | function secure($var){ 443 | if(is_object($var) && isset($var->scalar) && count((array)$var)==1){ 444 | $var = (string)$var->scalar; 445 | }elseif(is_string($var)){ 446 | $var = trim($var); 447 | $var = "'".$this->escape($var)."'"; 448 | }elseif(is_int($var)){ 449 | $var = intval((int)$var); 450 | }elseif(is_float($var)){ 451 | $var = "'".round(floatval(str_replace(",",".",$var)),6)."'"; 452 | }elseif(is_bool($var)){ 453 | $var = (int)$var; 454 | }elseif(is_array($var)){ 455 | $var = NULL; 456 | } 457 | 458 | $var = iconv("UTF-8", "UTF-8", $var); 459 | return ($var != "") ? $var : "NULL"; 460 | } 461 | 462 | /** 463 | * escapes any given string 464 | * 465 | */ 466 | function escape($str){ 467 | $str = get_magic_quotes_gpc() ? stripslashes($str) : $str; 468 | $str = function_exists("mysqli_real_escape_string") ? mysqli_real_escape_string($this->link,$str) : mysqli_escape_string($str); 469 | return (string)$str; 470 | } 471 | 472 | /** 473 | * Closes the MySQLi Connection 474 | */ 475 | function close(){ 476 | $this->connected = false; 477 | if($this->link) mysqli_close($this->link); 478 | } 479 | 480 | /** 481 | * returns mysqli_insert_id() 482 | */ 483 | function insert_id(){ 484 | return mysqli_insert_id($this->link); 485 | } 486 | /** 487 | * returns mysqli_affected_rows() 488 | */ 489 | function affected_rows(){ 490 | return mysqli_affected_rows($this->link); 491 | } 492 | 493 | /** 494 | * Returns all erros occurrend during the execution 495 | * @return array MySQL Errors 496 | */ 497 | function errors(){ 498 | return count($this->_errors)>0 ? $this->_errors : false; 499 | } 500 | 501 | /** 502 | * Return last error occurred 503 | * @return string Mysql Error 504 | */ 505 | function lastError(){ 506 | return count($this->_errors)>0 ? end($this->_errors) : false; 507 | } 508 | 509 | /** 510 | * Returns the query log 511 | * @return array Log entries 512 | */ 513 | function log(){ 514 | return $this->LOG; 515 | } 516 | 517 | /** 518 | * __destruct magic method 519 | * 520 | * This will make sure that the connection is closed when the variable is unset() 521 | * 522 | */ 523 | function __destruct(){ 524 | $this->close(); 525 | return; 526 | } 527 | 528 | /** 529 | * Displays a given error mensage and exits(). 530 | */ 531 | private function _displayError($e){ 532 | 533 | $this->_errors[] = $e; 534 | 535 | if($this->echo_on_error){ 536 | $box_border = $this->css_mysql_box_border; 537 | $box_bg = $this->css_mysql_box_bg; 538 | echo "
"; 539 | echo "MYSQL Error: "; 540 | echo ""; 541 | echo $e; 542 | echo ""; 543 | echo "
"; 544 | } 545 | 546 | if($this->exit_on_error){ 547 | exit(); 548 | } 549 | 550 | } 551 | 552 | /** 553 | * Loads a configuration 554 | * 555 | */ 556 | private function _loadConfig($config){ 557 | if(isset($config['hostname']) && !empty($config['hostname'])){ 558 | $this->hostname = $config['hostname']; 559 | } 560 | if(isset($config['username']) && !empty($config['username'])){ 561 | $this->username = $config['username']; 562 | } 563 | if(isset($config['password']) && !empty($config['password'])){ 564 | $this->password = $config['password']; 565 | } 566 | if(isset($config['database']) && !empty($config['database'])){ 567 | $this->database = $config['database']; 568 | } 569 | if(isset($config['port']) && !empty($config['port'])){ 570 | $this->port = $config['port']; 571 | } 572 | if(isset($config['exit_on_error'])){ 573 | $this->exit_on_error = $config['exit_on_error']; 574 | } 575 | if(isset($config['echo_on_error'])){ 576 | $this->echo_on_error = $config['echo_on_error']; 577 | } 578 | if(isset($config['allow_logging'])){ 579 | $this->allow_logging = (bool)$config['allow_logging']; 580 | } 581 | if(isset($config['charset']) && !empty($config['charset'])){ 582 | $this->charset = $config['charset']; 583 | } 584 | } 585 | } 586 | -------------------------------------------------------------------------------- /bin/OBJ_mysql_result.php: -------------------------------------------------------------------------------- 1 | 8 | * @license GNU General Public License, version 3 9 | * @link https://github.com/entomb/OBJ-MySQL GitHub Source 10 | * @filesource 11 | * 12 | * 13 | */ 14 | 15 | /** 16 | * OBJ-mysql - Database Result Class 17 | * 18 | * @package Database 19 | * @subpackage MySQL 20 | * @author Jonathan Tavares 21 | * @license GNU General Public License, version 3 22 | * @link https://github.com/entomb/OBJ-MySQL GitHub Source 23 | * 24 | * 25 | */ 26 | 27 | Class OBJ_mysql_result{ 28 | 29 | /** 30 | * Default result type 31 | * 32 | * Defines the default result type for methods like fetch() and fetchAll(); 33 | * basicly, I want to know if you prefer mysqli_fetch_object or mysqli_fetch_assoc. 34 | * 35 | * @var string object|array|json 36 | * @access public 37 | */ 38 | var $_default_result_type = "object"; 39 | 40 | /** 41 | * the MySQLi result object is stored here. 42 | * @access private 43 | */ 44 | private $result; 45 | 46 | /** 47 | * the number of rows in the current result are loaded on the __construct 48 | * @access public 49 | */ 50 | var $num_rows; 51 | 52 | /** 53 | * OBJ_mysql_result Construnctor 54 | */ 55 | function OBJ_mysql_result($sql="", $result = null){ 56 | if($result===null){ 57 | return false; 58 | } 59 | 60 | $this->sql = $sql; 61 | $this->result = $result; 62 | $this->num_rows = $this->result->num_rows; 63 | } 64 | 65 | /** 66 | * Fetches next row depending on the value of $_default_result_type 67 | * 68 | * @see OBJ_mysql_result::$_default_result_type 69 | * @see OBJ_mysql_result::fetchObject() 70 | * @see OBJ_mysql_result::fetchArray() 71 | */ 72 | function fetch(){ 73 | if($this->_default_result_type=='object'){ 74 | return $this->fetchObject(); 75 | } 76 | if($this->_default_result_type=='array'){ 77 | return $this->fetchArray(); 78 | } 79 | } 80 | 81 | /** 82 | * Fetches next row as an object using mysqli_fetch_object 83 | */ 84 | function fetchObject(){ 85 | return ($row = mysqli_fetch_object($this->result)) ? $row : false; 86 | } 87 | 88 | /** 89 | * Fetches next row as an array using mysqli_fetch_assoc 90 | */ 91 | function fetchArray(){ 92 | return ($row = mysqli_fetch_assoc($this->result)) ? $row : false; 93 | } 94 | 95 | /** 96 | * Fetches all rows depending on the value of $_default_result_type 97 | */ 98 | function fetchAll(){ 99 | if($this->_default_result_type=='object'){ 100 | return $this->fetchAllObject(); 101 | } 102 | if($this->_default_result_type=='array'){ 103 | return $this->fetchAllArray(); 104 | } 105 | } 106 | 107 | /** 108 | * Fetches all rows as an array using mysqli_fetch_object 109 | */ 110 | function fetchAllObject(){ 111 | $Data = array(); 112 | 113 | if( !$this->is_empty() ){ 114 | $this->reset(); 115 | while($row = mysqli_fetch_object($this->result)){ 116 | $Data[] = $row; 117 | } 118 | } 119 | return $Data; 120 | } 121 | 122 | /** 123 | * Fetches all rows as an array using mysqli_fetch_assoc 124 | */ 125 | function fetchAllArray(){ 126 | $Data = array(); 127 | if( !$this->is_empty() ){ 128 | $this->reset(); 129 | while($row = mysqli_fetch_assoc($this->result)){ 130 | $Data[] = $row; 131 | } 132 | } 133 | return $Data; 134 | } 135 | 136 | /** 137 | * Fetch Column 138 | * 139 | * Fetches data from a single column in the result set. 140 | * Will only return NOT NULL values 141 | */ 142 | function fetchColumn($column=""){ 143 | $ColumnData = array(); 144 | $Data = $this->fetchAllArray(); 145 | foreach($Data as $_index => $_row){ 146 | if(isset($_row[$column])){ 147 | $ColumnData[] = $_row[$column]; 148 | } 149 | } 150 | return $ColumnData; 151 | } 152 | 153 | /** 154 | * Fetch Array Pair 155 | * 156 | * Fetches data from two columns and compiles them into an array pair 157 | * Will only return NOT NULL values 158 | * 159 | * @param string $key the column to use as a key 160 | * @param string $value the column to use as value 161 | * @example: 162 | * 163 | * $this->fetchArrayPair('id_user','username'); 164 | * 165 | * Array 166 | * ( 167 | * [1] => admin 168 | * [5] => testUser 169 | * [10] => johnsmith 170 | * [11] => smith79 171 | * [12] => xxuser_name 172 | * ) 173 | * 174 | */ 175 | function fetchArrayPair($key,$value){ 176 | $ArrayPair = array(); 177 | $Data = $this->fetchAllArray(); 178 | foreach($Data as $_index => $_row){ 179 | if(isset($_row[$key]) && isset($_row[$value]) ){ 180 | $_key = $_row[$key]; 181 | $_value = $_row[$value]; 182 | $ArrayPair[$_key] = $_value; 183 | } 184 | } 185 | return $ArrayPair; 186 | 187 | } 188 | 189 | 190 | /** 191 | * Checks if the result is empty 192 | */ 193 | function is_empty(){ 194 | return ($this->num_rows>0) ? false : true; 195 | } 196 | 197 | /** 198 | * Resets the pointer for data seeking 199 | */ 200 | function reset(){ 201 | if( !$this->is_empty() ){ 202 | mysqli_data_seek($this->result,0); 203 | } 204 | return $this; 205 | } 206 | 207 | /** 208 | * Fetches all of the rows in the a json format string 209 | */ 210 | function json(){ 211 | $Data = $this->fetchAllArray(); 212 | return json_encode($Data); 213 | } 214 | 215 | /** 216 | * Free's the data in the result 217 | */ 218 | function free(){ 219 | mysqli_free_result($this->result); 220 | } 221 | 222 | /** 223 | * __destruct magic method 224 | * 225 | * This will make sure that the result is set free when the variable is unset() 226 | * it also works when it falls under garbage colecting 227 | * 228 | */ 229 | function __destruct(){ 230 | $this->free(); 231 | return; 232 | } 233 | 234 | //aliases for people used to the "get" syntax 235 | 236 | /** 237 | * Alias for fetch() 238 | * @see OBJ_mysql_result::fetch() 239 | */ 240 | function get(){ 241 | return $this->fetch(); 242 | } 243 | 244 | /** 245 | * Alias for fetchAll() 246 | * @see OBJ_mysql_result::fetchAll() 247 | */ 248 | function getAll(){ 249 | return $this->fetchAll(); 250 | } 251 | 252 | /** 253 | * Alias for fetchAllObject() 254 | * @see OBJ_mysql_result::fetchAllObject() 255 | */ 256 | function getObject(){ 257 | return $this->fetchAllObject(); 258 | } 259 | 260 | /** 261 | * Alias for fetchAllArray() 262 | * @see OBJ_mysql_result::fetchAllArray() 263 | */ 264 | function getArray(){ 265 | return $this->fetchAllArray(); 266 | } 267 | 268 | /** 269 | * Alias for fetchColumn() 270 | * @see OBJ_mysql_result::fetchColumn() 271 | */ 272 | function getColumn($key){ 273 | return $this->fetchColumn($key); 274 | } 275 | } 276 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "entomb/obj_mysql", 3 | "type": "library", 4 | "version": "1", 5 | "description": "MySQL abstraction layer", 6 | "keywords": ["mysql","dba","mysql abstraction layer", "msqli"], 7 | "homepage": "https://github.com/entomb/OBJ-MySQL", 8 | "license": "GPL 3.0", 9 | "authors": [ 10 | { 11 | "name": "Jonathan Tavares", 12 | "email": "the.entomb@gmail.com", 13 | "homepage": "https://github.com/entomb", 14 | "role": "Developer" 15 | } 16 | ], 17 | "require": { 18 | "php": ">=5.2.0" 19 | }, 20 | "autoload": { 21 | "classmap": ["bin/"] 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /example.php: -------------------------------------------------------------------------------- 1 | 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | include("bin/OBJ_mysql.php"); 19 | 20 | //database configuration 21 | $config = array( 22 | 'hostname' => 'localhost', 23 | 'username' => 'root', 24 | 'password' => '', 25 | 'database' => 'test', 26 | ); 27 | 28 | //creating a new MySQL Connection 29 | $db = new OBJ_mysql($config); 30 | $query = $db->query("show tables"); 31 | var_dump($query); 32 | 33 | $query = $db->query("SELECT * FROM client LIMIT 10 "); 34 | $array = $query->fetchAll(); 35 | $array2 = $query->fetchColumn('telefone'); 36 | $array3 = $query->fetchArrayPair('id_client','usern'); 37 | 38 | var_dump($array); 39 | var_dump($array2); 40 | var_dump($array3); 41 | 42 | 43 | ?> 44 | -------------------------------------------------------------------------------- /gpl-3.0.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS --------------------------------------------------------------------------------