Translator: better error messages

src/Dibi/Translator.php

@@ -27,8 +27,8 @@ final class Translator
 	/** @var array */
 	private $args;
 
-	/** @var bool */
+	/** @var string[] */
-	private $hasError;
+	private $errors;
 
 	/** @var bool */
 	private $comment;
@@ -76,7 +76,7 @@ final class Translator
 
 		$this->limit = NULL;
 		$this->offset = NULL;
-		$this->hasError = FALSE;
+		$this->errors = [];
 		$commandIns = NULL;
 		$lastArr = NULL;
 		// shortcuts
@@ -164,8 +164,8 @@ final class Translator
 
 		$sql = implode(' ', $sql);
 
-		if ($this->hasError) {
+		if ($this->errors) {
-			throw new Exception('SQL translate error', 0, $sql);
+			throw new Exception('SQL translate error: ' . trim(reset($this->errors), '*'), 0, $sql);
 		}
 
 		// apply limit
@@ -281,15 +281,13 @@ final class Translator
 						if (is_array($v)) {
 							if (isset($proto)) {
 								if ($proto !== array_keys($v)) {
-									$this->hasError = TRUE;
+									return $this->errors[] = '**Multi-insert array "' . $k . '" is different**';
-									return '**Multi-insert array "' . $k . '" is different.**';
 								}
 							} else {
 								$proto = array_keys($v);
 							}
 						} else {
-							$this->hasError = TRUE;
+							return $this->errors[] = '**Unexpected type ' . (is_object($v) ? get_class($v) : gettype($v)) . '**';
-							return '**Unexpected type ' . gettype($v) . '**';
 						}
 
 						$pair = explode('%', $k, 2); // split into identifier & modifier
@@ -333,8 +331,8 @@ final class Translator
 		// with modifier procession
 		if ($modifier) {
 			if ($value !== NULL && !is_scalar($value) && !$value instanceof \DateTime && !$value instanceof \DateTimeInterface) {  // array is already processed
-				$this->hasError = TRUE;
+				$type = is_object($value) ? get_class($value) : gettype($value);
-				return '**Unexpected type ' . gettype($value) . '**';
+				return $this->errors[] = "**Invalid combination of type $type and modifier %$modifier**";
 			}
 
 			switch ($modifier) {
@@ -430,12 +428,11 @@ final class Translator
 				case 'a':
 				case 'l':
 				case 'v':
-					$this->hasError = TRUE;
+					$type = gettype($value);
-					return '**Unexpected type ' . gettype($value) . '**';
+					return $this->errors[] = "**Invalid combination of type $type and modifier %$modifier**";
 
 				default:
-					$this->hasError = TRUE;
+					return $this->errors[] = "**Unknown or unexpected modifier %$modifier**";
-					return "**Unknown or invalid modifier %$modifier**";
 			}
 		}
 
@@ -463,8 +460,8 @@ final class Translator
 			return (string) $value;
 
 		} else {
-			$this->hasError = TRUE;
+			$type = is_object($value) ? get_class($value) : gettype($value);
-			return '**Unexpected ' . gettype($value) . '**';
+			return $this->errors[] = "**Unexpected $type**";
 		}
 	}
 
@@ -493,8 +490,7 @@ final class Translator
 			$cursor = & $this->cursor;
 
 			if ($cursor >= count($this->args)) {
-				$this->hasError = TRUE;
+				return $this->errors[] = '**Extra placeholder**';
-				return '**Extra placeholder**';
 			}
 
 			$cursor++;
@@ -506,8 +502,7 @@ final class Translator
 			$cursor = & $this->cursor;
 
 			if ($cursor >= count($this->args) && $mod !== 'else' && $mod !== 'end') {
-				$this->hasError = TRUE;
+				return $this->errors[] = "**Extra modifier %$mod**";
-				return "**Extra modifier %$mod**";
 			}
 
 			if ($mod === 'if') {
@@ -589,8 +584,7 @@ final class Translator
 			return $this->driver->escapeText(str_replace('""', '"', $matches[6]));
 
 		} elseif ($matches[7]) { // string quote
-			$this->hasError = TRUE;
+			return $this->errors[] = '**Alone quote**';
-			return '**Alone quote**';
 		}
 
 		if ($matches[8]) { // SQL identifier substitution

tests/dibi/Translator.phpt

@@ -77,8 +77,8 @@ Assert::same(
 // invalid input
 $e = Assert::exception(function () use ($conn) {
 	$conn->translate('SELECT %s', (object) [123], ', %m', 123);
-}, 'Dibi\Exception', 'SQL translate error');
+}, 'Dibi\Exception', 'SQL translate error: Invalid combination of type stdClass and modifier %s');
-Assert::same('SELECT **Unexpected type object** , **Unknown or invalid modifier %m**', $e->getSql());
+Assert::same('SELECT **Invalid combination of type stdClass and modifier %s** , **Unknown or unexpected modifier %m**', $e->getSql());
 
 Assert::same(
 	reformat('SELECT * FROM [table] WHERE id=10 AND name=\'ahoj\''),
@@ -228,7 +228,7 @@ if ($config['system'] === 'postgre') {
 
 $e = Assert::exception(function () use ($conn) {
 	$conn->translate("SELECT '");
-}, 'Dibi\Exception', 'SQL translate error');
+}, 'Dibi\Exception', 'SQL translate error: Alone quote');
 Assert::same('SELECT **Alone quote**', $e->getSql());
 
 Assert::match(
@@ -478,8 +478,8 @@ $e = Assert::exception(function () use ($conn) {
 		'num%i' => ['1', ''],
 	];
 	$conn->translate('INSERT INTO test %m', $array6);
-}, 'Dibi\Exception', 'SQL translate error');
+}, 'Dibi\Exception', 'SQL translate error: Multi-insert array "num%i" is different');
-Assert::same('INSERT INTO test **Multi-insert array "num%i" is different.**', $e->getSql());
+Assert::same('INSERT INTO test **Multi-insert array "num%i" is different**', $e->getSql());
 
 $array6 = [
 	'id' => [1, 2, 3, 4],