|
1
|
|
|
<?php |
|
2
|
|
|
/* |
|
3
|
|
|
* The MIT License |
|
4
|
|
|
* |
|
5
|
|
|
* Copyright 2017 David Schoenbauer <[email protected]>. |
|
6
|
|
|
* |
|
7
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy |
|
8
|
|
|
* of this software and associated documentation files (the "Software"), to deal |
|
9
|
|
|
* in the Software without restriction, including without limitation the rights |
|
10
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|
11
|
|
|
* copies of the Software, and to permit persons to whom the Software is |
|
12
|
|
|
* furnished to do so, subject to the following conditions: |
|
13
|
|
|
* |
|
14
|
|
|
* The above copyright notice and this permission notice shall be included in |
|
15
|
|
|
* all copies or substantial portions of the Software. |
|
16
|
|
|
* |
|
17
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
18
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
19
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
20
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
21
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
22
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
|
23
|
|
|
* THE SOFTWARE. |
|
24
|
|
|
*/ |
|
25
|
|
|
namespace DSchoenbauer\Sql\Command; |
|
26
|
|
|
|
|
27
|
|
|
use DSchoenbauer\Sql\Exception\ExecutionErrorException; |
|
28
|
|
|
use DSchoenbauer\Sql\Exception\NoRecordsAffectedDeleteException; |
|
29
|
|
|
use DSchoenbauer\Sql\Exception\NoRecordsAffectedException; |
|
30
|
|
|
use DSchoenbauer\Sql\Where\WhereStatementInterface; |
|
31
|
|
|
use PDO; |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* removes records from a PDO connected resource |
|
35
|
|
|
* |
|
36
|
|
|
* @author David Schoenbauer <[email protected]> |
|
37
|
|
|
*/ |
|
38
|
|
|
class Delete extends AbstractCommand |
|
39
|
|
|
{ |
|
40
|
|
|
|
|
41
|
|
|
private $table; |
|
42
|
|
|
|
|
43
|
|
|
use WhereTrait; |
|
44
|
|
|
|
|
45
|
|
|
/** |
|
46
|
|
|
* @param string $table table with which you wish to remove records from |
|
47
|
|
|
* @param null|WhereStatementInterface $where an object that is designed to |
|
48
|
|
|
* return a where statement to limit the data that is affected by the delete |
|
49
|
|
|
* @since v1.0.0 |
|
50
|
|
|
*/ |
|
51
|
11 |
|
public function __construct($table, WhereStatementInterface $where = null) |
|
52
|
|
|
{ |
|
53
|
11 |
|
$this->setTable($table)->setWhere($where); |
|
54
|
11 |
|
} |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
57
|
|
|
* takes the SQL and the data provided and executes the query with the data |
|
58
|
|
|
* @param PDO $pdo a connection object that defines where the connection is to be executed |
|
59
|
|
|
* @return bool TRUE on success or FALSE on failure. |
|
60
|
|
|
* @throws ExecutionErrorException thrown when any exception or SQL failure occurs |
|
61
|
|
|
* @since v1.0.0 |
|
62
|
|
|
*/ |
|
63
|
4 |
View Code Duplication |
public function execute(PDO $pdo) |
|
|
|
|
|
|
64
|
|
|
{ |
|
65
|
|
|
try { |
|
66
|
4 |
|
$stmt = $pdo->prepare($this->getSql()); |
|
67
|
4 |
|
if (count($this->getData()) > 0) { |
|
68
|
1 |
|
$result = $stmt->execute($this->getData()); |
|
69
|
|
|
} else { |
|
70
|
3 |
|
$result = $stmt->execute(); |
|
71
|
|
|
} |
|
72
|
3 |
|
$this->checkAffected($stmt, new NoRecordsAffectedDeleteException()); |
|
73
|
2 |
|
return $result; |
|
74
|
2 |
|
} catch (NoRecordsAffectedException $exc) { |
|
75
|
1 |
|
throw $exc; |
|
76
|
1 |
|
} catch (\Exception $exc) { |
|
77
|
1 |
|
throw new ExecutionErrorException($exc->getMessage()); |
|
78
|
|
|
} |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
|
|
/** |
|
82
|
|
|
* retrieves the data that is uses to fulfill the requirements of a prepared |
|
83
|
|
|
* statement |
|
84
|
|
|
* @return array a single level associative array containing keys that |
|
85
|
|
|
* represent the fields and values that represent items to fulfill the |
|
86
|
|
|
* requirements of a prepared statement |
|
87
|
|
|
* @since v1.0.0 |
|
88
|
|
|
*/ |
|
89
|
6 |
|
public function getData() |
|
90
|
|
|
{ |
|
91
|
6 |
|
return $this->getWhereData(); |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* Generates a SQL statement ready to be prepared for execution with the intent of removing data |
|
96
|
|
|
* @return string a string that represents a delete statement ready to be prepared by PDO |
|
97
|
|
|
* @since v1.0.0 |
|
98
|
|
|
*/ |
|
99
|
6 |
|
public function getSql() |
|
100
|
|
|
{ |
|
101
|
6 |
|
$sqlTemplate = 'DELETE FROM %1$s %2$s'; |
|
102
|
6 |
|
return trim(sprintf($sqlTemplate, $this->getTable(), $this->getWhereStatement())); |
|
103
|
|
|
} |
|
104
|
|
|
|
|
105
|
|
|
/** |
|
106
|
|
|
* retrieves the table with which you wish to remove from |
|
107
|
|
|
* @return string table with which you wish to remove from |
|
108
|
|
|
* @since v1.0.0 |
|
109
|
|
|
*/ |
|
110
|
8 |
|
public function getTable() |
|
111
|
|
|
{ |
|
112
|
8 |
|
return $this->table; |
|
113
|
|
|
} |
|
114
|
|
|
|
|
115
|
|
|
/** |
|
116
|
|
|
* defines a table with which you wish to remove from |
|
117
|
|
|
* @param string $table table with which you wish to remove from |
|
118
|
|
|
* @return Delete for method chaining |
|
119
|
|
|
* @since v1.0.0 |
|
120
|
|
|
*/ |
|
121
|
11 |
|
public function setTable($table) |
|
122
|
|
|
{ |
|
123
|
11 |
|
$this->table = $table; |
|
124
|
11 |
|
return $this; |
|
125
|
|
|
} |
|
126
|
|
|
} |
|
127
|
|
|
|
dschoenbauer /
sql
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.