1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
|
<?php
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
namespace TodoList\Dao;
use \DateTime;
use \Exception;
use \PDO;
use \PDOStatement;
use \TodoList\Config\Config;
use \TodoList\Exception\NotFoundException;
use \TodoList\Mapping\TodoMapper;
use \TodoList\Model\Todo;
/**
* DAO for {@link \TodoList\Model\Todo}.
* <p>
* It is also a service, ideally, this class should be divided into DAO and Service.
*/
final class TodoDao {
/** @var PDO */
private $db = null;
public function __destruct() {
// close db connection
$this->db = null;
}
/**
* Find all {@link Todo}s by search criteria.
* @return array array of {@link Todo}s
*/
public function find(TodoSearchCriteria $search = null) {
$result = [];
foreach ($this->query($this->getFindSql($search)) as $row) {
$todo = new Todo();
TodoMapper::map($todo, $row);
$result[$todo->getId()] = $todo;
}
return $result;
}
/**
* Find {@link Todo} by identifier.
* @return Todo Todo or <i>null</i> if not found
*/
public function findById($id) {
$row = $this->query('SELECT * FROM todo WHERE deleted = 0 and id = ' . (int) $id)->fetch();
if (!$row) {
return null;
}
$todo = new Todo();
TodoMapper::map($todo, $row);
return $todo;
}
/**
* Save {@link Todo}.
* @param Todo $todo {@link Todo} to be saved
* @return Todo saved {@link Todo} instance
*/
public function save(Todo $todo) {
if ($todo->getId() === null) {
return $this->insert($todo);
}
return $this->update($todo);
}
/**
* Delete {@link Todo} by identifier.
* @param int $id {@link Todo} identifier
* @return bool <i>true</i> on success, <i>false</i> otherwise
*/
public function delete($id) {
$sql = '
UPDATE todo SET
last_modified_on = :last_modified_on,
deleted = :deleted
WHERE
id = :id';
$statement = $this->getDb()->prepare($sql);
$this->executeStatement($statement, [
':last_modified_on' => self::formatDateTime(new DateTime()),
':deleted' => true,
':id' => $id,
]);
return $statement->rowCount() == 1;
}
/**
* @return PDO
*/
private function getDb() {
if ($this->db !== null) {
return $this->db;
}
$config = Config::getConfig('db');
try {
$this->db = new PDO($config['dsn'], $config['username'], $config['password']);
} catch (Exception $ex) {
throw new Exception('DB connection error: ' . $ex->getMessage());
}
return $this->db;
}
private function getFindSql(TodoSearchCriteria $search = null) {
$sql = 'SELECT * FROM todo WHERE deleted = 0 ';
$orderBy = ' priority, due_on';
if ($search !== null) {
if ($search->getStatus() !== null) {
$sql .= 'AND status = ' . $this->getDb()->quote($search->getStatus());
switch ($search->getStatus()) {
case Todo::STATUS_PENDING:
$orderBy = 'due_on, priority';
break;
case Todo::STATUS_DONE:
case Todo::STATUS_VOIDED:
$orderBy = 'due_on DESC, priority';
break;
default:
throw new Exception('No order for status: ' . $search->getStatus());
}
}
}
$sql .= ' ORDER BY ' . $orderBy;
return $sql;
}
/**
* @return Todo
* @throws Exception
*/
private function insert(Todo $todo) {
$now = new DateTime();
$todo->setId(null);
$todo->setCreatedOn($now);
$todo->setLastModifiedOn($now);
$todo->setStatus(Todo::STATUS_PENDING);
$sql = '
INSERT INTO todo (id, priority, created_on, last_modified_on, due_on, title, description, comment, status, deleted)
VALUES (:id, :priority, :created_on, :last_modified_on, :due_on, :title, :description, :comment, :status, :deleted)';
return $this->execute($sql, $todo);
}
/**
* @return Todo
* @throws Exception
*/
private function update(Todo $todo) {
$todo->setLastModifiedOn(new DateTime());
$sql = '
UPDATE todo SET
priority = :priority,
last_modified_on = :last_modified_on,
due_on = :due_on,
title = :title,
description = :description,
comment = :comment,
status = :status,
deleted = :deleted
WHERE
id = :id';
return $this->execute($sql, $todo);
}
/**
* @return Todo
* @throws Exception
*/
private function execute($sql, Todo $todo) {
$statement = $this->getDb()->prepare($sql);
$this->executeStatement($statement, $this->getParams($todo));
if (!$todo->getId()) {
return $this->findById($this->getDb()->lastInsertId());
}
if (!$statement->rowCount()) {
throw new NotFoundException('TODO with ID "' . $todo->getId() . '" does not exist.');
}
return $todo;
}
private function getParams(Todo $todo) {
$params = [
':id' => $todo->getId(),
':priority' => $todo->getPriority(),
':created_on' => self::formatDateTime($todo->getCreatedOn()),
':last_modified_on' => self::formatDateTime($todo->getLastModifiedOn()),
':due_on' => self::formatDateTime($todo->getDueOn()),
':title' => $todo->getTitle(),
':description' => $todo->getDescription(),
':comment' => $todo->getComment(),
':status' => $todo->getStatus(),
':deleted' => self::formatBoolean($todo->getDeleted()),
];
if ($todo->getId()) {
// unset created date, this one is never updated
unset($params[':created_on']);
}
return $params;
}
private function executeStatement(PDOStatement $statement, array $params) {
// XXX
//echo str_replace(array_keys($params), $params, $statement->queryString) . PHP_EOL;
if ($statement->execute($params) === false) {
self::throwDbError($this->getDb()->errorInfo());
}
}
/**
* @return PDOStatement
*/
private function query($sql) {
$statement = $this->getDb()->query($sql, PDO::FETCH_ASSOC);
if ($statement === false) {
self::throwDbError($this->getDb()->errorInfo());
}
return $statement;
}
private static function throwDbError(array $errorInfo) {
// TODO log error, send email, etc.
throw new Exception('DB error [' . $errorInfo[0] . ', ' . $errorInfo[1] . ']: ' . $errorInfo[2]);
}
private static function formatDateTime(DateTime $date) {
return $date->format('Y-m-d H:i:s');
}
private static function formatBoolean($bool) {
return $bool ? 1 : 0;
}
}
|