SQLite3Connector::connect() - Code Metrics - Inspection of "API Apply SilverStripe\SQLite namespace to module" - silverstripe-labs/silverstripe-sqlite3 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#23)

by Damian

created 2016-06-29 01:56 UTC

SQLite3Connector::connect() A

↳ Parent: SQLite3Connector

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	2
eloc	7
nc	2
nop	2

<?php

namespace SilverStripe\SQLite;

use SilverStripe\ORM\Connect\DBConnector;
use SQLite3;

/**
 * SQLite connector class
 *
 * @package SQLite3
 */
class SQLite3Connector extends DBConnector
{

    /**
     * The name of the database.
     *
     * @var string
     */
    protected $databaseName;

    /**
     * Connection to the DBMS.
     *
     * @var SQLite3
     */
    protected $dbConn;

    public function connect($parameters, $selectDB = false)
    {
        $file = $parameters['filepath'];
        $this->dbConn = empty($parameters['key'])
                ? new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE)
                : new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, $parameters['key']);
        $this->dbConn->busyTimeout(60000);
        $this->databaseName = $parameters['database'];
    }

    public function affectedRows()
    {
        return $this->dbConn->changes();
    }

    public function getGeneratedID($table)
    {
        return $this->dbConn->lastInsertRowID();
    }

    public function getLastError()
    {
        $message = $this->dbConn->lastErrorMsg();
        return $message === 'not an error' ? null : $message;
    }

    public function getSelectedDatabase()
    {
        return $this->databaseName;
    }

    public function getVersion()
    {
        $version = SQLite3::version();
        return trim($version['versionString']);
    }

    public function isActive()
    {
        return $this->databaseName && $this->dbConn;
    }

    /**
     * Prepares the list of parameters in preparation for passing to mysqli_stmt_bind_param
     *
     * @param array $parameters List of parameters
     * @return array List of parameters types and values
     */
    public function parsePreparedParameters($parameters)
    {
        $values = array();
        foreach ($parameters as $value) {
            $phpType = gettype($value);
            $sqlType = null;

            // Allow overriding of parameter type using an associative array
            if ($phpType === 'array') {
                $phpType = $value['type'];
                $value = $value['value'];
            }

            // Convert php variable type to one that makes mysqli_stmt_bind_param happy
            // @see http://www.php.net/manual/en/mysqli-stmt.bind-param.php
            switch ($phpType) {
                case 'boolean':
                case 'integer':
                    $sqlType = SQLITE3_INTEGER;
                    break;
                case 'float': // Not actually returnable from gettype
                case 'double':
                    $sqlType = SQLITE3_FLOAT;
                    break;
                case 'object': // Allowed if the object or resource has a __toString method
                case 'resource':
                case 'string':
                    $sqlType = SQLITE3_TEXT;
                    break;
                case 'NULL':
                    $sqlType = SQLITE3_NULL;
                    break;
                case 'blob':
                    $sqlType = SQLITE3_BLOB;
                    break;
                case 'array':
                case 'unknown type':
                default:
                    user_error("Cannot bind parameter \"$value\" as it is an unsupported type ($phpType)", E_USER_ERROR);
                    break;
            }
            $values[] = array(
                'type' => $sqlType,
                'value' => $value
            );
        }
        return $values;
    }

    public function preparedQuery($sql, $parameters, $errorLevel = E_USER_ERROR)
    {
        // Type check, identify, and prepare parameters for passing to the statement bind function
        $parsedParameters = $this->parsePreparedParameters($parameters);

        // Prepare statement
        $statement = @$this->dbConn->prepare($sql);
        if ($statement) {
            // Bind and run to statement
            for ($i = 0; $i < count($parsedParameters); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $value = $parsedParameters[$i]['value'];
                $type = $parsedParameters[$i]['type'];
                $statement->bindValue($i+1, $value, $type);
            }

            // Return successful result
            $handle = $statement->execute();
            if ($handle) {
                return new SQLite3Query($this, $handle);
            }
        }

        // Handle error
        $values = $this->parameterValues($parameters);
        $this->databaseError($this->getLastError(), $errorLevel, $sql, $values);
        return null;
    }

    public function query($sql, $errorLevel = E_USER_ERROR)
    {
        // Return successful result
        $handle = @$this->dbConn->query($sql);
        if ($handle) {
            return new SQLite3Query($this, $handle);
        }

        // Handle error
        $this->databaseError($this->getLastError(), $errorLevel, $sql);
        return null;
    }

    public function quoteString($value)
    {
        return "'".$this->escapeString($value)."'";
    }

    public function escapeString($value)
    {
        return $this->dbConn->escapeString($value);
    }

    public function selectDatabase($name)
    {
        if ($name !== $this->databaseName) {
            user_error("SQLite3Connector can't change databases. Please create a new database connection", E_USER_ERROR);
        }
        return true;
    }

    public function unloadDatabase()
    {
        $this->dbConn->close();
        $this->databaseName = null;
    }
}


1			<?php
2
3			namespace SilverStripe\SQLite;
4
5			use SilverStripe\ORM\Connect\DBConnector;
6			use SQLite3;
7
8			/**
9			* SQLite connector class
10			*
11			* @package SQLite3
12			*/
13			class SQLite3Connector extends DBConnector
14			{
15
16			/**
17			* The name of the database.
18			*
19			* @var string
20			*/
21			protected $databaseName;
22
23			/**
24			* Connection to the DBMS.
25			*
26			* @var SQLite3
27			*/
28			protected $dbConn;
29
30			public function connect($parameters, $selectDB = false)
31			{
32			$file = $parameters['filepath'];
33			$this->dbConn = empty($parameters['key'])
34			? new SQLite3($file, SQLITE3_OPEN_READWRITE \| SQLITE3_OPEN_CREATE)
35			: new SQLite3($file, SQLITE3_OPEN_READWRITE \| SQLITE3_OPEN_CREATE, $parameters['key']);
36			$this->dbConn->busyTimeout(60000);
37			$this->databaseName = $parameters['database'];
38			}
39
40			public function affectedRows()
41			{
42			return $this->dbConn->changes();
43			}
44
45			public function getGeneratedID($table)
46			{
47			return $this->dbConn->lastInsertRowID();
48			}
49
50			public function getLastError()
51			{
52			$message = $this->dbConn->lastErrorMsg();
53			return $message === 'not an error' ? null : $message;
54			}
55
56			public function getSelectedDatabase()
57			{
58			return $this->databaseName;
59			}
60
61			public function getVersion()
62			{
63			$version = SQLite3::version();
64			return trim($version['versionString']);
65			}
66
67			public function isActive()
68			{
69			return $this->databaseName && $this->dbConn;
70			}
71
72			/**
73			* Prepares the list of parameters in preparation for passing to mysqli_stmt_bind_param
74			*
75			* @param array $parameters List of parameters
76			* @return array List of parameters types and values
77			*/
78			public function parsePreparedParameters($parameters)
79			{
80			$values = array();
81			foreach ($parameters as $value) {
82			$phpType = gettype($value);
83			$sqlType = null;
84
85			// Allow overriding of parameter type using an associative array
86			if ($phpType === 'array') {
87			$phpType = $value['type'];
88			$value = $value['value'];
89			}
90
91			// Convert php variable type to one that makes mysqli_stmt_bind_param happy
92			// @see http://www.php.net/manual/en/mysqli-stmt.bind-param.php
93			switch ($phpType) {
94			case 'boolean':
95			case 'integer':
96			$sqlType = SQLITE3_INTEGER;
97			break;
98			case 'float': // Not actually returnable from gettype
99			case 'double':
100			$sqlType = SQLITE3_FLOAT;
101			break;
102			case 'object': // Allowed if the object or resource has a __toString method
103			case 'resource':
104			case 'string':
105			$sqlType = SQLITE3_TEXT;
106			break;
107			case 'NULL':
108			$sqlType = SQLITE3_NULL;
109			break;
110			case 'blob':
111			$sqlType = SQLITE3_BLOB;
112			break;
113			case 'array':
114			case 'unknown type':
115			default:
116			user_error("Cannot bind parameter \"$value\" as it is an unsupported type ($phpType)", E_USER_ERROR);
117			break;
118			}
119			$values[] = array(
120			'type' => $sqlType,
121			'value' => $value
122			);
123			}
124			return $values;
125			}
126
127			public function preparedQuery($sql, $parameters, $errorLevel = E_USER_ERROR)
128			{
129			// Type check, identify, and prepare parameters for passing to the statement bind function
130			$parsedParameters = $this->parsePreparedParameters($parameters);
131
132			// Prepare statement
133			$statement = @$this->dbConn->prepare($sql);
134			if ($statement) {
135			// Bind and run to statement
136			for ($i = 0; $i < count($parsedParameters); $i++) {
			0 ignored issues – show Performance Best Practice introduced 2016-03-23 12:58 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
137			$value = $parsedParameters[$i]['value'];
138			$type = $parsedParameters[$i]['type'];
139			$statement->bindValue($i+1, $value, $type);
140			}
141
142			// Return successful result
143			$handle = $statement->execute();
144			if ($handle) {
145			return new SQLite3Query($this, $handle);
146			}
147			}
148
149			// Handle error
150			$values = $this->parameterValues($parameters);
151			$this->databaseError($this->getLastError(), $errorLevel, $sql, $values);
152			return null;
153			}
154
155			public function query($sql, $errorLevel = E_USER_ERROR)
156			{
157			// Return successful result
158			$handle = @$this->dbConn->query($sql);
159			if ($handle) {
160			return new SQLite3Query($this, $handle);
161			}
162
163			// Handle error
164			$this->databaseError($this->getLastError(), $errorLevel, $sql);
165			return null;
166			}
167
168			public function quoteString($value)
169			{
170			return "'".$this->escapeString($value)."'";
171			}
172
173			public function escapeString($value)
174			{
175			return $this->dbConn->escapeString($value);
176			}
177
178			public function selectDatabase($name)
179			{
180			if ($name !== $this->databaseName) {
181			user_error("SQLite3Connector can't change databases. Please create a new database connection", E_USER_ERROR);
182			}
183			return true;
184			}
185
186			public function unloadDatabase()
187			{
188			$this->dbConn->close();
189			$this->databaseName = null;
190			}
191			}
192

silverstripe-labs / silverstripe-sqlite3

Pull Request — master (#23)

SQLite3Connector::connect() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like