Skip to content

Commit da6764d

Browse files
UnlinkUnlink
committed
ResultSet: configurable row normalization
1 parent d8aab0a commit da6764d

File tree

7 files changed

+183
-48
lines changed

7 files changed

+183
-48
lines changed

‎src/Database/Connection.php‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ class Connection
4040
/** @var PDO */
4141
private $pdo;
4242

43+
/** @var IRowNormalizer */
44+
private $rowNormalizer;
45+
4346

4447
public function __construct($dsn, $user = NULL, $password = NULL, array $options = NULL)
4548
{
@@ -69,6 +72,9 @@ public function connect()
6972
throw ConnectionException::from($e);
7073
}
7174

75+
$rowNormalizer = empty($this->options['rowNormalizer']) ? 'Nette\Database\RowNormalizer' : $this->options['rowNormalizer'];
76+
$this->rowNormalizer = new $rowNormalizer;
77+
7278
$class = empty($this->options['driverClass'])
7379
? 'Nette\Database\Drivers\\' . ucfirst(str_replace('sql', 'Sql', $this->pdo->getAttribute(PDO::ATTR_DRIVER_NAME))) . 'Driver'
7480
: $this->options['driverClass'];
@@ -175,7 +181,7 @@ public function query($sql, ...$params)
175181
{
176182
list($sql, $params) = $this->preprocess($sql, ...$params);
177183
try {
178-
$result = new ResultSet($this, $sql, $params);
184+
$result = new ResultSet($this, $sql, $params, $this->rowNormalizer);
179185
} catch (PDOException $e) {
180186
$this->onQuery($this, $e);
181187
throw $e;

‎src/Database/IRowNormalizer.php‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
/**
4+
* This file is part of the Nette Framework (https://nette.org)
5+
* Copyright (c) 2004 David Grudl (https://davidgrudl.com)
6+
*/
7+
8+
namespace Nette\Database;
9+
10+
11+
/**
12+
* Row normalizer interface.
13+
*/
14+
interface IRowNormalizer
15+
{
16+
/**
17+
* Normalizes result row.
18+
* @param array
19+
* @param ResultSet
20+
* @return array
21+
*/
22+
function normalizeRow($row, ResultSet $resultSet);
23+
}

‎src/Database/ResultSet.php‎

Lines changed: 45 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ class ResultSet implements \Iterator, IRowContainer
2727
/** @var \PDOStatement|NULL */
2828
private $pdoStatement;
2929

30+
/** @var IRowNormalizer */
31+
private $rowNormalizer;
32+
3033
/** @var IRow */
3134
private $result;
3235

@@ -48,14 +51,18 @@ class ResultSet implements \Iterator, IRowContainer
4851
/** @var array */
4952
private $types;
5053

54+
/** @var callable|NULL */
55+
private $rowFactory;
56+
5157

52-
public function __construct(Connection $connection, $queryString, array $params)
58+
public function __construct(Connection $connection, $queryString, array $params, IRowNormalizer $normalizer)
5359
{
5460
$time = microtime(TRUE);
5561
$this->connection = $connection;
5662
$this->supplementalDriver = $connection->getSupplementalDriver();
5763
$this->queryString = $queryString;
5864
$this->params = $params;
65+
$this->rowNormalizer = $normalizer;
5966

6067
try {
6168
if (substr($queryString, 0, 2) === '::') {
@@ -116,6 +123,16 @@ public function getParameters()
116123
return $this->params;
117124
}
118125

126+
/**
127+
* @return array
128+
*/
129+
public function getColumnTypes()
130+
{
131+
if ($this->types === NULL) {
132+
$this->types = (array) $this->supplementalDriver->getColumnTypes($this->pdoStatement);
133+
}
134+
return $this->types;
135+
}
119136

120137
/**
121138
* @return int
@@ -145,47 +162,24 @@ public function getTime()
145162

146163

147164
/**
148-
* Normalizes result row.
149-
* @param array
150-
* @return array
165+
* @param IRowNormalizer|NULL
166+
* @return static
151167
*/
152-
public function normalizeRow($row)
168+
public function setRowNormalizer($normalizer)
153169
{
154-
if ($this->types === NULL) {
155-
$this->types = (array) $this->supplementalDriver->getColumnTypes($this->pdoStatement);
156-
}
157-
158-
foreach ($this->types as $key => $type) {
159-
$value = $row[$key];
160-
if ($value === NULL || $value === FALSE || $type === IStructure::FIELD_TEXT) {
161-
162-
} elseif ($type === IStructure::FIELD_INTEGER) {
163-
$row[$key] = is_float($tmp = $value * 1) ? $value : $tmp;
164-
165-
} elseif ($type === IStructure::FIELD_FLOAT) {
166-
if (($pos = strpos($value, '.')) !== FALSE) {
167-
$value = rtrim(rtrim($pos === 0 ? "0$value" : $value, '0'), '.');
168-
}
169-
$float = (float) $value;
170-
$row[$key] = (string) $float === $value ? $float : $value;
171-
172-
} elseif ($type === IStructure::FIELD_BOOL) {
173-
$row[$key] = ((bool) $value) && $value !== 'f' && $value !== 'F';
174-
175-
} elseif ($type === IStructure::FIELD_DATETIME || $type === IStructure::FIELD_DATE || $type === IStructure::FIELD_TIME) {
176-
$row[$key] = new Nette\Utils\DateTime($value);
177-
178-
} elseif ($type === IStructure::FIELD_TIME_INTERVAL) {
179-
preg_match('#^(-?)(\d+)\D(\d+)\D(\d+)\z#', $value, $m);
180-
$row[$key] = new \DateInterval("PT$m[2]H$m[3]M$m[4]S");
181-
$row[$key]->invert = (int) (bool) $m[1];
170+
$this->rowNormalizer = $normalizer;
171+
return $this;
172+
}
182173

183-
} elseif ($type === IStructure::FIELD_UNIX_TIMESTAMP) {
184-
$row[$key] = Nette\Utils\DateTime::from($value);
185-
}
186-
}
187174

188-
return $this->supplementalDriver->normalizeRow($row);
175+
/**
176+
* Set a factory to create fetched object instances. These should implements the IRow interface.
177+
* @return self
178+
*/
179+
public function setRowFactory(callable $callback)
180+
{
181+
$this->rowFactory = $callback;
182+
return $this;
189183
}
190184

191185

@@ -255,10 +249,19 @@ public function fetch()
255249
return FALSE;
256250
}
257251

258-
$row = new Row;
259-
foreach ($this->normalizeRow($data) as $key => $value) {
260-
if ($key !== '') {
261-
$row->$key = $value;
252+
if ($this->rowNormalizer !== NULL) {
253+
$data = $this->rowNormalizer->normalizeRow($data, $this);
254+
}
255+
256+
if ($this->rowFactory) {
257+
$row = call_user_func($this->rowFactory, $data);
258+
}
259+
else {
260+
$row = new Row;
261+
foreach ($data as $key => $value) {
262+
if ($key !== '') {
263+
$row->$key = $value;
264+
}
262265
}
263266
}
264267

‎src/Database/RowNormalizer.php‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<?php
2+
3+
/**
4+
* This file is part of the Nette Framework (https://nette.org)
5+
* Copyright (c) 2004 David Grudl (https://davidgrudl.com)
6+
*/
7+
8+
namespace Nette\Database;
9+
10+
use Nette;
11+
12+
13+
/**
14+
* Default implementation for row normalization.
15+
*/
16+
class RowNormalizer implements IRowNormalizer
17+
{
18+
use Nette\SmartObject;
19+
20+
/** @var ISupplementalDriver */
21+
private $supplementalDriver;
22+
23+
24+
/**
25+
* @inheritdoc
26+
*/
27+
public function normalizeRow($row, ResultSet $resultSet)
28+
{
29+
foreach ($resultSet->getColumnTypes() as $key => $type) {
30+
$value = $row[$key];
31+
if ($value === NULL || $value === FALSE || $type === IStructure::FIELD_TEXT) {
32+
33+
} elseif ($type === IStructure::FIELD_INTEGER) {
34+
$row[$key] = is_float($tmp = $value * 1) ? $value : $tmp;
35+
36+
} elseif ($type === IStructure::FIELD_FLOAT) {
37+
if (($pos = strpos($value, '.')) !== FALSE) {
38+
$value = rtrim(rtrim($pos === 0 ? "0$value" : $value, '0'), '.');
39+
}
40+
$float = (float) $value;
41+
$row[$key] = (string) $float === $value ? $float : $value;
42+
43+
} elseif ($type === IStructure::FIELD_BOOL) {
44+
$row[$key] = ((bool) $value) && $value !== 'f' && $value !== 'F';
45+
46+
} elseif ($type === IStructure::FIELD_DATETIME || $type === IStructure::FIELD_DATE || $type === IStructure::FIELD_TIME) {
47+
$row[$key] = new Nette\Utils\DateTime($value);
48+
49+
} elseif ($type === IStructure::FIELD_TIME_INTERVAL) {
50+
preg_match('#^(-?)(\d+)\D(\d+)\D(\d+)\z#', $value, $m);
51+
$row[$key] = new \DateInterval("PT$m[2]H$m[3]M$m[4]S");
52+
$row[$key]->invert = (int) (bool) $m[1];
53+
54+
} elseif ($type === IStructure::FIELD_UNIX_TIMESTAMP) {
55+
$row[$key] = Nette\Utils\DateTime::from($value);
56+
}
57+
}
58+
59+
if ($this->supplementalDriver === NULL) {
60+
$this->supplementalDriver = $resultSet->getConnection()->getSupplementalDriver();
61+
}
62+
63+
return $this->supplementalDriver->normalizeRow($row);
64+
}
65+
}

‎src/Database/Table/Selection.php‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -575,11 +575,9 @@ protected function execute()
575575
throw $exception;
576576
}
577577
}
578-
579578
$this->rows = [];
580579
$usedPrimary = TRUE;
581-
foreach ($result->getPdoStatement() as $key => $row) {
582-
$row = $this->createRow($result->normalizeRow($row));
580+
foreach ($result as $key => $row) {
583581
$primary = $row->getSignature(FALSE);
584582
$usedPrimary = $usedPrimary && (string) $primary !== '';
585583
$this->rows[$usedPrimary ? $primary : $key] = $row;
@@ -614,7 +612,11 @@ protected function createGroupedSelectionInstance($table, $column)
614612

615613
protected function query($query)
616614
{
617-
return $this->context->queryArgs($query, $this->sqlBuilder->getParameters());
615+
$result = $this->context->queryArgs($query, $this->sqlBuilder->getParameters());
616+
$result->setRowFactory(function($row) {
617+
return $this->createRow($row);
618+
});
619+
return $result;
618620
}
619621

620622

‎tests/Database/ResultSet.customNormalization.phpt‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php
2+
3+
/**
4+
* @dataProvider? databases.ini
5+
*/
6+
7+
use Tester\Assert;
8+
9+
require __DIR__ . '/connect.inc.php'; // create $connection
10+
11+
Nette\Database\Helpers::loadFromFile($connection, __DIR__ . "/files/{$driverName}-nette_test1.sql");
12+
13+
class CustomRowNormalizer implements \Nette\Database\IRowNormalizer
14+
{
15+
function normalizeRow($row, \Nette\Database\ResultSet $resultSet)
16+
{
17+
foreach ($row as $key => $value) {
18+
unset($row[$key]);
19+
$row['_'.$key.'_'] = (string) $value;
20+
}
21+
return $row;
22+
}
23+
}
24+
25+
test(function() use ($context) {
26+
$res = $context->query('SELECT * FROM author');
27+
$res->setRowNormalizer(new CustomRowNormalizer());
28+
Assert::equal([
29+
'_id_' => '11',
30+
'_name_' => 'Jakub Vrana',
31+
'_web_' => 'http://www.vrana.cz/',
32+
'_born_' => ''
33+
], (array)$res->fetch());
34+
});

‎tests/Database/Table/Table.join.phpt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,5 +90,7 @@ test(function () use ($connection, $structure) {
9090
);
9191

9292
$books = $context->table('book')->select('book.*, author.name, translator.name');
93-
iterator_to_array($books);
93+
Assert::error(function() use($books) {
94+
iterator_to_array($books);
95+
}, E_USER_NOTICE, 'Found duplicate columns in database result set.');
9496
});

0 commit comments

Comments
 (0)