init

Author: leongrdic

composer.json

@@ -0,0 +1,13 @@
+{
+  "name": "leven-framework/dba-common",
+  "type": "library",
+  "suggest": {
+    "leven-framework/dba-mock": "Mock a database using e.g. a local file",
+    "leven-framework/dba-mysql": "PDO MySQL adapter"
+  },
+  "autoload": {
+    "psr-4": {
+      "Leven\\DBA\\Common\\": "src/"
+    }
+  }
+}

src/DatabaseAdapterInterface.php

@@ -0,0 +1,62 @@
+<?php namespace Leven\DBA\Common;
+
+use Leven\DBA\Common\Exception\{ArgumentValidationException, Driver\DriverException, EmptyResultException};
+
+interface DatabaseAdapterInterface {
+
+    public function escapeValue(string $string);
+    public function escapeName(string $string);
+
+    /**
+     * @throws DriverException
+     */
+    public function schema(string $table): array;
+
+    /**
+     * @throws DriverException
+     */
+    public function count(string $table): int;
+
+    /**
+    * @throws ArgumentValidationException
+    * @throws DriverException
+    * @throws EmptyResultException
+    */
+    public function get(string $table, array|string $columns, array $conditions, array $options): DatabaseAdapterResponse;
+
+    /**
+    * @throws ArgumentValidationException
+    * @throws DriverException
+    */
+    public function insert(string $table, array $data): DatabaseAdapterResponse;
+
+    /**
+    * @throws ArgumentValidationException
+    * @throws DriverException
+    */
+    public function update(string $table, array $data, array $conditions, array $options): DatabaseAdapterResponse;
+
+    /**
+    * @throws ArgumentValidationException
+    * @throws DriverException
+    */
+    public function delete(string $table, array $conditions, array $options): DatabaseAdapterResponse;
+
+
+
+    /**
+    * @throws DriverException
+    */
+    public function txnBegin();
+
+    /**
+    * @throws DriverException
+    */
+    public function txnCommit();
+
+    /**
+    * @throws DriverException
+    */
+    public function txnRollback();
+
+}

src/DatabaseAdapterResponse.php

@@ -0,0 +1,20 @@
+<?php namespace Leven\DBA\Common;
+
+use ArrayIterator, ArrayObject, IteratorAggregate;
+
+class DatabaseAdapterResponse implements IteratorAggregate {
+
+    public function __construct(
+        public string|null $query = null,
+        public int $count = 0,
+        public array $rows = [],
+        public array|null $row = null,
+        public int|string|null $lastID = null
+    ) { }
+
+    public function getIterator(): ArrayIterator
+    {
+        $o = new ArrayObject($this->rows);
+        return $o->getIterator();
+    }
+}

src/Exception/ArgumentValidationException.php

@@ -0,0 +1,3 @@
+<?php namespace Leven\DBA\Common\Exception;
+
+final class ArgumentValidationException extends DatabaseAdapterException {}

src/Exception/DatabaseAdapterException.php

@@ -0,0 +1,3 @@
+<?php namespace Leven\DBA\Common\Exception;
+
+abstract class DatabaseAdapterException extends \Exception {}

src/Exception/Driver/DriverException.php

@@ -0,0 +1,5 @@
+<?php namespace Leven\DBA\Common\Exception\Driver;
+
+use Leven\DBA\Common\Exception\DatabaseAdapterException;
+
+class DriverException extends DatabaseAdapterException {}

src/Exception/Driver/NotImplementedException.php

@@ -0,0 +1,3 @@
+<?php namespace Leven\DBA\Common\Exception\Driver;
+
+final class NotImplementedException extends DriverException {}

src/Exception/Driver/TxnNotActiveException.php

@@ -0,0 +1,3 @@
+<?php namespace Leven\DBA\Common\Exception\Driver;
+
+final class TxnNotActiveException extends DriverException {}

src/Exception/EmptyResultException.php

@@ -0,0 +1,3 @@
+<?php namespace Leven\DBA\Common\Exception;
+
+final class EmptyResultException extends DatabaseAdapterException {}