Completed
Push — master ( 7fd5f6...af8ac7 )
by James Ekow Abaka
01:40
created

DriverAdapter::getQueryEngine()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 7
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 7
rs 9.4285
c 0
b 0
f 0
ccs 5
cts 5
cp 1
cc 2
eloc 5
nc 2
nop 0
crap 2
1
<?php
2
3
namespace ntentan\nibii;
4
5
/**
6
 * A DriverAdaptr is a generic database adapter.
7
 * This adapter implements a lot of its operations through the atiaa library.
8
 * Driver specific implementation of this class only handle the conversion of
9
 * data types from the native datatypes of the database to the generic types
10
 * used in the nibii library.
11
 */
12
abstract class DriverAdapter {
13
14
    protected $data;
15
    private $insertQuery;
16
    private $updateQuery;
17
    private $modelInstance;
18
    protected $queryEngine;
19
    private $driver;
20
    
21 1
    public function setContext(ORMContext $context) {
22 1
        $this->driver = $context->getDbContext()->getDriver();
23 1
    }
24
25
    public function setData($data) {
26
        $this->data = $data;
27
    }
28
29
    /**
30
     * Convert datatypes from the database system's native type to a generic type
31
     * supported by nibii.
32
     *
33
     * @param string $nativeType The native datatype
34
     * @return string The generic datatype for use in nibii.
35
     */
36
    abstract public function mapDataTypes($nativeType);
37
38
    /**
39
     * 
40
     * 
41
     * @param QueryParameters $parameters
42
     * @return type
43
     */
44 1
    public function select($parameters) {
45 1
        $result = $this->driver->query(
46 1
            $this->getQueryEngine()->getSelectQuery($parameters), 
47 1
            $parameters->getBoundData()
0 ignored issues
show
Documentation introduced by
$parameters->getBoundData() is of type array|boolean, but the function expects a false|array<integer,*>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
48
        );
49
50 1
        if ($parameters->getFirstOnly() && isset($result[0])) {
51
            $result = $result[0];
52
        }
53
54 1
        return $result;
55
    }
56
57
    /**
58
     * @param QueryParameters $parameters
59
     */
60
    public function count($parameters) {
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
61
        $result = $this->driver->query(
62
            $this->getQueryEngine()->getCountQuery($parameters), $parameters->getBoundData()
0 ignored issues
show
Documentation introduced by
$parameters->getBoundData() is of type array|boolean, but the function expects a false|array<integer,*>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
63
        );
64
        return $result[0]['count'];
65
    }
66
67
    private function initInsert() {
68
        $this->insertQuery = $this->getQueryEngine()
69
            ->getInsertQuery($this->modelInstance);
70
    }
71
72
    private function initUpdate() {
73
        $this->updateQuery = $this->getQueryEngine()->getUpdateQuery($this->modelInstance);
74
    }
75
76
    public function insert($record) {
77
        if ($this->insertQuery === null) {
78
            $this->initInsert();
79
        }
80
        return $this->driver->query($this->insertQuery, $record);
81
    }
82
83
    public function update($record) {
84
        if ($this->updateQuery === null) {
85
            $this->initUpdate();
86
        }
87
        return $this->driver->query($this->updateQuery, $record);
88
    }
89
90
    /**
91
     * @param QueryParameters $parameters
92
     */
93
    public function bulkUpdate($data, $parameters) {
94
        return $this->driver->query(
95
            $this->getQueryEngine()->getBulkUpdateQuery($data, $parameters), array_merge($data, $parameters->getBoundData())
96
        );
97
    }
98
99
    /**
100
     * @param QueryParameters $parameters
101
     */
102
    public function delete($parameters) {
103
        return $this->driver->query(
104
            $this->getQueryEngine()->getDeleteQuery($parameters), $parameters->getBoundData()
0 ignored issues
show
Documentation introduced by
$parameters->getBoundData() is of type array|boolean, but the function expects a false|array<integer,*>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
105
        );
106
    }
107
108
    public function describe($model, $relationships) {
0 ignored issues
show
Unused Code introduced by
The parameter $model is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
109
        return new ModelDescription(
110
            $this->driver->describeTable($table)[$table], $relationships, function($type) {
0 ignored issues
show
Bug introduced by
The variable $table does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
Unused Code introduced by
The call to ModelDescription::__construct() has too many arguments starting with function ($type) { r...>mapDataTypes($type); }.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
111
                return $this->mapDataTypes($type);
112
            }
113
        );
114
    }
115
116
    /**
117
     *
118
     * @return \ntentan\nibii\QueryEngine
119
     */
120 1
    private function getQueryEngine() {
121 1
        if ($this->queryEngine === null) {
122 1
            $this->queryEngine = new QueryEngine();
123 1
            $this->queryEngine->setDriver($this->driver);
124
        }
125 1
        return $this->queryEngine;
126
    }
127
128
    /**
129
     * @param RecordWrapper $model
130
     */
131 1
    public function setModel($model) {
132 1
        $this->modelInstance = $model;
133 1
    }
134
    
135
    public function getDriver() {
136
        return $this->driver;
137
    }
138
139
}
140