Completed
Push — master ( eaf5ea...97c539 )
by Michael
05:35
created

PDOAwareTrait   A

Complexity

Total Complexity 3

Size/Duplication

Total Lines 29
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 0

Importance

Changes 0
Metric Value
wmc 3
lcom 1
cbo 0
dl 0
loc 29
rs 10
c 0
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
A setPdo() 0 5 1
A getPdo() 0 8 2
1
<?php
2
declare(strict_types = 1);
3
/**
4
 * Contains trait PDOAwareTrait.
5
 *
6
 * PHP version 7.0+
7
 *
8
 * LICENSE:
9
 * This file is part of Yet Another Php Eve Api Library also know as Yapeal
10
 * which can be used to access the Eve Online API data and place it into a
11
 * database.
12
 * Copyright (C) 2016 Michael Cummings
13
 *
14
 * This program is free software: you can redistribute it and/or modify it
15
 * under the terms of the GNU Lesser General Public License as published by the
16
 * Free Software Foundation, either version 3 of the License, or (at your
17
 * option) any later version.
18
 *
19
 * This program is distributed in the hope that it will be useful, but WITHOUT
20
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
22
 * for more details.
23
 *
24
 * You should have received a copy of the GNU Lesser General Public License
25
 * along with this program. If not, see
26
 * <http://spdx.org/licenses/LGPL-3.0.html>.
27
 *
28
 * You should be able to find a copy of this license in the COPYING-LESSER.md
29
 * file. A copy of the GNU GPL should also be available in the COPYING.md file.
30
 *
31
 * @author    Michael Cummings <[email protected]>
32
 * @copyright 2016 Michael Cummings
33
 * @license   LGPL-3.0+
34
 */
35
namespace Yapeal\Sql;
36
37
/**
38
 * Trait PDOAwareTrait.
39
 */
40
trait PDOAwareTrait
41
{
42
    /**
43
     * @param \PDO $value
0 ignored issues
show
Documentation introduced by
Should the type for parameter $value not be null|\PDO?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
44
     *
45
     * @return static Fluent interface.
46
     */
47
    public function setPdo(\PDO $value = null)
48
    {
49
        $this->pdo = $value;
50
        return $this;
51
    }
52
    /**
53
     * @return \PDO
54
     * @throws \LogicException
55
     */
56
    protected function getPdo(): \PDO
57
    {
58
        if (null === $this->pdo) {
59
            $mess = 'Tried to use pdo before it was set';
60
            throw new \LogicException($mess, 1);
61
        }
62
        return $this->pdo;
63
    }
64
    /**
65
     * @var \PDO $pdo
66
     */
67
    private $pdo;
68
}
69