chillerlan\Database\Drivers\SQLite\SQLite3Driver

Complexity

Total Complexity

16

Size/Duplication

Total Lines	175
Duplicated Lines	15.43 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	connect()	0	19	3
A	disconnect()	0	3	1
A	getClientInfo()	0	3	1
A	getServerInfo()	0	3	1
B	escape()	27	27	6
A	raw()	0	4	1
A	prepared()	0	4	1
A	multi()	0	4	1
A	multi_callback()	0	4	1

<?php
/**
 * Class SQLite3Driver
 *
 * @filesource   SQLite3Driver.php
 * @created      21.02.2016
 * @package      chillerlan\Database\Drivers\SQLite
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2016 Smiley
 * @license      MIT
 */

namespace chillerlan\Database\Drivers\SQLite;

use chillerlan\Database\DBException;
use chillerlan\Database\Drivers\DBDriverAbstract;
use Exception;
use SQLite3;

/**
 *
 */
class SQLite3Driver extends DBDriverAbstract{

	/**
	 * Holds the database resource object
	 *
	 * @var SQLite3
	 */
	protected $db;

	/**
	 * Establishes a database connection and returns the connection object
	 *
	 * @return \SQLite3 the database resource object
	 * @throws \chillerlan\Database\DBException
	 */
	public function connect():SQLite3{

		if($this->db instanceof SQLite3){
			return $this->db;
		}

		try{
			$this->db = new SQLite3(
				$this->options->database,
				$this->options->sqlite_flags,
				$this->options->sqlite_encryption_key
			);
		}
		catch(Exception $Exception){
			throw new DBException($Exception->getMessage());
		}

		return $this->db;
	}

	/**
	 * Closes a database connection
	 *
	 * @return bool
	 */
	public function disconnect():bool{
		return $this->db->close();
	}

	/**
	 * Returns info about the used php client
	 *
	 * @return string php's database client string
	 */
	public function getClientInfo():string{
		return 'SQLite '.SQLite3::version()['versionString'];
	}

	/**
	 * Returns info about the database server
	 *
	 * @return string database's serverinfo string
	 */
	public function getServerInfo():string{
		return 'N/A (SQLite '.SQLite3::version()['versionString'].')';
	}

	/**
	 * Sanitizer.
	 *
	 * Recursively escapes string values, optional htmlspecialchars()
	 *
	 * @param array|string $data         array or string to escape
	 * @param bool         $specialchars [optional] if true, it performs a htmlspecialchars() on each value given
	 *
	 * @return array|string array or string. escaped. obviously.
	 */
	public function escape($data, bool $specialchars = false){

This method seems to be duplicated in your project.

		if(is_array($data)){

			foreach($data as $key => $value){
				$data[$key] = $this->escape($value, $specialchars);
			}

		}
		else if(is_object($data)){

			foreach($data as $key => $value){
				$data->{$key} = $this->escape($value, $specialchars);
			}

		}
		else{

			if($specialchars){
				$data = htmlspecialchars($data, ENT_HTML5, 'UTF-8', false);
			}

			$data = SQLite3::escapeString($data);
		}

		return $data;
	}

	/**
	 * Basic SQL query for non prepared statements
	 *
	 * There is no escaping in here, so make sure, your SQL is clean/escaped.
	 * Also, your SQL should NEVER contain user input, use prepared statements in this case.
	 *
	 * If the query was successful it returns either an array of results or true
	 * if it was a void query. On errors, a false will be returned, obviously.
	 *
	 * @param string $sql         The SQL statement
	 * @param string $index       [optional] an index column to assingn as the result's keys

Should the type for parameter $index not be null|string?

	 * @param bool   $assoc       [optional] If true, the fields are named with the respective column names, otherwise numbered
	 * @param bool   $fetch_array [optional] fetch the vaues as array instead of object
	 *
	 * @return array|bool array with results, true on void query success, otherwise false.
	 * @throws \mysqli_sql_exception
	 */
	public function raw(string $sql, string $index = null, bool $assoc = true, bool $fetch_array = false){
		// TODO: Implement raw() method.
		return false;
	}

	/**
	 * Prepared statements wrapper
	 *
	 * Does everything for you: prepares the statement and fetches the results as an object or array
	 * just pass a query along with values and you're done. Not meant for multi-inserts.
	 *
	 * @param string $sql         The SQL statement to prepare
	 * @param array  $values      [optional] the value for each "?" in the statement - in the respective order, of course
	 * @param string $index       [optional] an index column to assingn as the result's keys

Should the type for parameter $index not be null|string?

	 * @param bool   $assoc       [optional] If true, the fields are named with the respective column names, otherwise numbered
	 * @param bool   $fetch_array [optional] fetch the vaues as array instead of object
	 *
	 * @return array|bool Array with results, true on void query success, otherwise false
	 */
	public function prepared(string $sql, array $values = [], string $index = null, bool $assoc = true, bool $fetch_array = false){
		// TODO: Implement prepared() method.
		return false;
	}

	/**
	 * Prepared multi line insert
	 *
	 * Prepared statement multi insert/update
	 *
	 * @param string $sql    The SQL statement to prepare
	 * @param array  $values a multidimensional array with the values, each row represents one line to insert.
	 *
	 * @return bool true query success, otherwise false
	 */
	public function multi(string $sql, array $values){
		// TODO: Implement multi() method.
		return false;
	}

	/**
	 * Prepared multi line insert/update with callback
	 *
	 * @todo: multi treading
	 * @see https://gist.github.com/krakjoe/6437782
	 * @see https://gist.github.com/krakjoe/9384409
	 *
	 * @param string         $sql      The SQL statement to prepare
	 * @param array          $data     an array with the (raw) data to insert, each row represents one line to insert.
	 * @param callable|array $callback a callback that processes the values for each row.
	 *
	 * @return bool true query success, otherwise false
	 * @throws \chillerlan\Database\DBException
	 */
	public function multi_callback(string $sql, array $data, $callback){
		// TODO: Implement multi_callback() method.
		return false;
	}
}