cast extended models when loading from database

composer.json

@@ -4,7 +4,8 @@
     "type": "library",
     "require": {
         "vlucas/phpdotenv": "^5.5",
-        "evenement/evenement": "^3.0"
+        "evenement/evenement": "^3.0",
+        "symfony/var-dumper": "^6.3"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.4",

composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "7b31fc4374d54dc20d8f35625a8f74a7",
+    "content-hash": "ef49a4d31601e74941ecce68ae0ff3ff",
     "packages": [
         {
             "name": "evenement/evenement",
@@ -190,6 +190,73 @@
             ],
             "time": "2023-02-25T19:38:58+00:00"
         },
+        {
+            "name": "symfony/deprecation-contracts",
+            "version": "v3.3.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/deprecation-contracts.git",
+                "reference": "7c3aff79d10325257a001fcf92d991f24fc967cf"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/7c3aff79d10325257a001fcf92d991f24fc967cf",
+                "reference": "7c3aff79d10325257a001fcf92d991f24fc967cf",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=8.1"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-main": "3.4-dev"
+                },
+                "thanks": {
+                    "name": "symfony/contracts",
+                    "url": "https://github.com/symfony/contracts"
+                }
+            },
+            "autoload": {
+                "files": [
+                    "function.php"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Nicolas Grekas",
+                    "email": "p@tchwork.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "A generic function and convention to trigger deprecation notices",
+            "homepage": "https://symfony.com",
+            "support": {
+                "source": "https://github.com/symfony/deprecation-contracts/tree/v3.3.0"
+            },
+            "funding": [
+                {
+                    "url": "https://symfony.com/sponsor",
+                    "type": "custom"
+                },
+                {
+                    "url": "https://github.com/fabpot",
+                    "type": "github"
+                },
+                {
+                    "url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
+                    "type": "tidelift"
+                }
+            ],
+            "time": "2023-05-23T14:45:45+00:00"
+        },
         {
             "name": "symfony/polyfill-ctype",
             "version": "v1.28.0",
@@ -438,6 +505,90 @@
             ],
             "time": "2023-01-26T09:26:14+00:00"
         },
+        {
+            "name": "symfony/var-dumper",
+            "version": "v6.3.6",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/var-dumper.git",
+                "reference": "999ede244507c32b8e43aebaa10e9fce20de7c97"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/var-dumper/zipball/999ede244507c32b8e43aebaa10e9fce20de7c97",
+                "reference": "999ede244507c32b8e43aebaa10e9fce20de7c97",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=8.1",
+                "symfony/deprecation-contracts": "^2.5|^3",
+                "symfony/polyfill-mbstring": "~1.0"
+            },
+            "conflict": {
+                "symfony/console": "<5.4"
+            },
+            "require-dev": {
+                "ext-iconv": "*",
+                "symfony/console": "^5.4|^6.0",
+                "symfony/http-kernel": "^5.4|^6.0",
+                "symfony/process": "^5.4|^6.0",
+                "symfony/uid": "^5.4|^6.0",
+                "twig/twig": "^2.13|^3.0.4"
+            },
+            "bin": [
+                "Resources/bin/var-dump-server"
+            ],
+            "type": "library",
+            "autoload": {
+                "files": [
+                    "Resources/functions/dump.php"
+                ],
+                "psr-4": {
+                    "Symfony\\Component\\VarDumper\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Nicolas Grekas",
+                    "email": "p@tchwork.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Provides mechanisms for walking through any arbitrary PHP variable",
+            "homepage": "https://symfony.com",
+            "keywords": [
+                "debug",
+                "dump"
+            ],
+            "support": {
+                "source": "https://github.com/symfony/var-dumper/tree/v6.3.6"
+            },
+            "funding": [
+                {
+                    "url": "https://symfony.com/sponsor",
+                    "type": "custom"
+                },
+                {
+                    "url": "https://github.com/fabpot",
+                    "type": "github"
+                },
+                {
+                    "url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
+                    "type": "tidelift"
+                }
+            ],
+            "time": "2023-10-12T18:45:56+00:00"
+        },
         {
             "name": "vlucas/phpdotenv",
             "version": "v5.5.0",
@@ -3653,73 +3804,6 @@
             ],
             "time": "2023-08-16T10:10:12+00:00"
         },
-        {
-            "name": "symfony/deprecation-contracts",
-            "version": "v3.3.0",
-            "source": {
-                "type": "git",
-                "url": "https://github.com/symfony/deprecation-contracts.git",
-                "reference": "7c3aff79d10325257a001fcf92d991f24fc967cf"
-            },
-            "dist": {
-                "type": "zip",
-                "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/7c3aff79d10325257a001fcf92d991f24fc967cf",
-                "reference": "7c3aff79d10325257a001fcf92d991f24fc967cf",
-                "shasum": ""
-            },
-            "require": {
-                "php": ">=8.1"
-            },
-            "type": "library",
-            "extra": {
-                "branch-alias": {
-                    "dev-main": "3.4-dev"
-                },
-                "thanks": {
-                    "name": "symfony/contracts",
-                    "url": "https://github.com/symfony/contracts"
-                }
-            },
-            "autoload": {
-                "files": [
-                    "function.php"
-                ]
-            },
-            "notification-url": "https://packagist.org/downloads/",
-            "license": [
-                "MIT"
-            ],
-            "authors": [
-                {
-                    "name": "Nicolas Grekas",
-                    "email": "p@tchwork.com"
-                },
-                {
-                    "name": "Symfony Community",
-                    "homepage": "https://symfony.com/contributors"
-                }
-            ],
-            "description": "A generic function and convention to trigger deprecation notices",
-            "homepage": "https://symfony.com",
-            "support": {
-                "source": "https://github.com/symfony/deprecation-contracts/tree/v3.3.0"
-            },
-            "funding": [
-                {
-                    "url": "https://symfony.com/sponsor",
-                    "type": "custom"
-                },
-                {
-                    "url": "https://github.com/fabpot",
-                    "type": "github"
-                },
-                {
-                    "url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
-                    "type": "tidelift"
-                }
-            ],
-            "time": "2023-05-23T14:45:45+00:00"
-        },
         {
             "name": "symfony/filesystem",
             "version": "v6.3.1",

src/Collection.php

@@ -5,9 +5,10 @@ namespace Kletellier\PdoWrapper;
 use ArrayIterator;
 use Countable;
 use IteratorAggregate;
+use JsonSerializable;
 use Traversable;
 
-class Collection implements IteratorAggregate, Countable
+class Collection implements IteratorAggregate, Countable, JsonSerializable
 {
     private array $elements;
 
@@ -57,8 +58,7 @@ class Collection implements IteratorAggregate, Countable
 
     public function map(callable $fn): Collection
     {
-        $tmp = array_map($fn, $this->elements);
-        return new Collection($tmp);
+        return new Collection(array_map($fn, $this->elements));
     }
 
     public function each(callable $fn): void
@@ -68,9 +68,24 @@ class Collection implements IteratorAggregate, Countable
 
     public function filter(callable $fn): Collection
     {
-        $tmp = array_filter($this->elements, $fn, ARRAY_FILTER_USE_BOTH);
-        $collect = new Collection($tmp);
-        return $collect;
+        return new Collection(array_filter($this->elements, $fn, ARRAY_FILTER_USE_BOTH));
+    }
+
+    public function pluck(string $key): Collection
+    {
+        return new Collection(array_map(function ($item) use ($key) {
+            if (is_object($item)) {
+                return isset($item->$key) ? $item->$key : null;
+            }
+            if (is_array($item)) {
+                return isset($item[$key]) ? $item[$key] : null;
+            }
+        }, $this->elements));
+    }
+
+    public function toArray(): array
+    {
+        return $this->elements;
     }
 
     public function empty(): bool
@@ -97,4 +112,9 @@ class Collection implements IteratorAggregate, Countable
     {
         return new ArrayIterator($this->elements);
     }
+
+    public function jsonSerialize(): mixed
+    {
+        return $this->elements;
+    }
 }

src/Connection.php

@@ -18,6 +18,7 @@ class Connection
     private string $database;
     private ?string $port;
     private ?string $host;
+    private ?string $charset;
     private string $error;
 
     private function __construct($name, $config)
@@ -40,10 +41,11 @@ class Connection
             $key = (strtolower(trim($this->name)));
             $this->type = isset($config[$key]["TYPE"]) ? $config[$key]["TYPE"] : null;
             $this->user = isset($config[$key]["USER"]) ? $config[$key]["USER"] : null;
-            $this->host = isset($config[$key]["HOST"]) ? $config[$config[$key]["HOST"]] : null;
+            $this->host = isset($config[$key]["HOST"]) ? $config[$key]["HOST"] : null;
             $this->password = isset($config[$key]["PASSWORD"]) ? $config[$key]["PASSWORD"] : null;
             $this->database = isset($config[$key]["DATABASE"]) ? $config[$key]["DATABASE"] : null;
             $this->port = isset($config[$key]["PORT"]) ? $config[$key]["PORT"] : null;
+            $this->charset = isset($config[$key]["CHARSET"]) ? $config[$key]["CHARSET"] : null;
         } catch (\Throwable $th) {
             $this->error = $th->getMessage();
         }
@@ -70,6 +72,7 @@ class Connection
             $this->password = isset($_ENV[$this->getKey("PASSWORD", $key)]) ? $_ENV[$this->getKey("PASSWORD", $key)] : null;
             $this->database = isset($_ENV[$this->getKey("DATABASE", $key)]) ? $_ENV[$this->getKey("DATABASE", $key)] : null;
             $this->port = isset($_ENV[$this->getKey("PORT", $key)]) ? $_ENV[$this->getKey("PORT", $key)] : null;
+            $this->charset = isset($_ENV[$this->getKey("CHARSET", $key)]) ? $_ENV[$this->getKey("CHARSET", $key)] : null;
         } catch (\Throwable $th) {
             $this->error = $th->getMessage();
         }
@@ -84,6 +87,7 @@ class Connection
     {
         $this->getConnString();
         $this->pdo = new PDO($this->connstring, $this->user, $this->password);
+        $this->pdo->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
         $this->pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
     }
 
@@ -116,10 +120,19 @@ class Connection
         return $stmt;
     }
 
+    private function getMySQLOptions()
+    {
+        $ret = "";
+        if ($this->charset) {
+            $ret .= ";charset=" . $this->charset;
+        }
+        return $ret;
+    }
+
     private function getConnString()
     {
         $this->connstring = match ($this->type) {
-            "mysql"  => "mysql:host=" . $this->host . ":" . $this->port . ";dbname=" . $this->database,
+            "mysql"  => "mysql:host=" . $this->host . ":" . $this->port . ";dbname=" . $this->database . $this->getMySQLOptions() ,
             "sqlite" => "sqlite:" . $this->database,
         };
     }
@@ -130,13 +143,13 @@ class Connection
         return $stmt->execute();
     }
 
-    public function getSelectQuery(Query $query): mixed
+    public function getSelectQuery(Query $query, $fetchmode = PDO::FETCH_ASSOC): mixed
     {
         $stmt = $this->pdo->prepare($query->getQuery());
         $stmt = $this->bindParams($stmt, $query->getData());
         EventDispatcher::emit("on.query", $query);
         $stmt->execute();
-        return $stmt->fetchAll(PDO::FETCH_ASSOC);
+        return $stmt->fetchAll($fetchmode);
     }
 
     public function updateQuery(Query $query): bool
@@ -160,6 +173,30 @@ class Connection
         }
     }
 
+    public function beginTransaction(): bool
+    {
+        if ($this->pdo) {
+            return $this->pdo->beginTransaction();
+        }
+        return false;
+    }
+
+    public function commit(): bool
+    {
+        if ($this->pdo) {
+            return $this->pdo->commit();
+        }
+        return false;
+    }
+
+    public function rollback(): bool
+    {
+        if ($this->pdo) {
+            return $this->pdo->rollBack();
+        }
+        return false;
+    }
+
     public static function init($config, array $connections = ["default"])
     {
         self::fillInstances($config, $connections);
@@ -175,10 +212,9 @@ class Connection
         }
     }
 
-    public static function getInstance($connection="")
-    {       
-        if($connection=="" && count(self::$instances)>0)
+    public static function getInstance($connection = "")
     {
+        if ($connection == "" && count(self::$instances) > 0) {
             $connection = array_keys(self::$instances)[0];
         }
         if (isset(self::$instances[$connection])) {
@@ -194,4 +230,14 @@ class Connection
     {
         return $this->error;
     }
+
+    public function getPdo()
+    {
+        return $this->pdo;
+    }
+
+    public function getDriverType()
+    {
+        return $this->type;
+    }
 }

src/Model.php

@@ -2,23 +2,39 @@
 
 namespace Kletellier\PdoWrapper;
 
-class Model
+use JsonSerializable;
+
+class Model implements JsonSerializable
 {
     protected mixed $values;
     protected array $updated;
-    protected string $table;
+    protected string $table = "";
     protected string $connection = "";
     protected string $pk;
     private bool $new;
+    private bool $ro;
 
-    public function __construct()
+    public function __construct($ro = false)
     {
         $this->new = true;
         $this->values = array();
         $this->updated = array();
         $this->pk = "id";
+        $this->ro = $ro;
+        $this->initTable();
+    }
+
+    private function initTable(): void
+    {
+        if (!$this->ro) {
+            if ($this->table == "") {
                 $this->table =  $this->getDefaultTableName();
             }
+        } else {
+            $this->table = "ReadOnlyModel";
+            $this->pk = "__idpk";
+        }
+    }
 
     public function getTable(): string
     {
@@ -31,6 +47,11 @@ class Model
         return $this;
     }
 
+    public function getValues(): array
+    {
+        return $this->values;
+    }
+
     public function getPk(): string
     {
         return $this->pk;
@@ -61,10 +82,22 @@ class Model
         return $this;
     }
 
+    public function find(mixed $key): mixed
+    {
+        $qb = $this->newQueryBuilder(get_class($this));
+        $find = $qb->find($key);
+        if ($find !== null) {
+            $this->fillData($find->getValues());
+            return $this;
+        }
+        return null;
+    }
+
     public function save(): bool
     {
         $ret = false;
-        $qb = $this->newQueryBuilder();
+        if (!$this->ro) {
+            $qb = $this->newQueryBuilder("");
             if ($this->new) {
                 $query = $qb->getPreparedQuery($this->values);
                 $id = Connection::getInstance($this->connection)->insertQuery($query);
@@ -89,12 +122,13 @@ class Model
                     }
                 }
             }
+        }
         return $ret;
     }
 
-    public function newQueryBuilder(): QueryBuilder
+    public function newQueryBuilder($className): QueryBuilder
     {
-        return new QueryBuilder($this->table, $this->pk, $this->connection);
+        return new QueryBuilder($this->table, $this->pk, $this->connection, $className);
     }
 
     public function __set($name, $value): void
@@ -105,6 +139,27 @@ class Model
         }
     }
 
+    public function __isset($name): bool
+    {
+        if (method_exists($this, $name)) {
+            return true;
+        } else {
+            return isset($this->values[$name]);
+        }
+    }
+
+    public static function getClassName()
+    {
+        return static::class;
+    }
+
+    public static function q(): QueryBuilder
+    {
+        $cls = self::getClassName();
+        $ist = new static();
+        return $ist->newQueryBuilder($cls);
+    }
+
     public function __get($name): mixed
     {
         if (isset($this->values[$name])) {
@@ -122,4 +177,9 @@ class Model
 
         return $table;
     }
+
+    public function jsonSerialize(): mixed
+    {
+        return $this->values;
+    }
 }

src/QueryBuilder.php

@@ -6,9 +6,11 @@ class QueryBuilder
 {
     protected array $columns;
     protected array $wheres;
+    protected array $orwheres;
     protected array $orders;
     protected array $groupby;
     protected string $table;
+    protected string $classname;
     protected string $connection;
     protected string $pk;
     protected ?int $take;
@@ -16,8 +18,12 @@ class QueryBuilder
     protected string $raw_query;
     protected bool $distinct;
 
-    public function __construct($table, $pk = "id", $connection = "")
+    public const MODE_AND = 0;
+    public const MODE_OR = 1;
+
+    public function __construct($table, $pk = "id", $connection = "", $classname = "")
     {
+        $this->classname = $classname;
         $this->table = $table;
         $this->pk = $pk;
         $this->connection = $connection;
@@ -28,6 +34,7 @@ class QueryBuilder
     {
         $this->columns = [];
         $this->wheres = [];
+        $this->orwheres = [];
         $this->orders = [];
         $this->groupby = [];
         $this->offset = null;
@@ -128,12 +135,28 @@ class QueryBuilder
         return $this;
     }
 
+    public function orWhere($condition, $operator, $value = null)
+    {
+        if ($value === null) {
+            $this->orwheres[] = new Expression($condition, "=", $operator);
+        } else {
+            $this->orwheres[] = new Expression($condition, $operator, $value);
+        }
+        return $this;
+    }
+
     public function whereRaw(string $raw)
     {
         $this->wheres[] = $raw;
         return $this;
     }
 
+    public function orWhereRaw(string $raw)
+    {
+        $this->orwheres[] = $raw;
+        return $this;
+    }
+
     public function find($id): mixed
     {
         $this->reset();
@@ -187,7 +210,12 @@ class QueryBuilder
     {
         $ret = array();
         foreach ($data as $row) {
+            if ($this->classname != "") {
+                $model = new $this->classname();
+            } else {
                 $model = new Model();
+            }
+
             $ret[] = $model->setPk($this->pk)->setTable($this->table)->fillData($row);
         }
         return new Collection($ret);
@@ -213,10 +241,16 @@ class QueryBuilder
         $query = "SELECT " . $distinct . " " . $columns . " FROM " . $this->table ;
 
         $where = $this->getWhere();
+        $Orwhere = $this->getWhere(QueryBuilder::MODE_OR);
+
         $this->fillData($ret);
 
+        if ($where != "" && $Orwhere != "") {
+            $Orwhere = " OR " . $Orwhere;
+        }
+
         if ($where != "") {
-            $query .= " WHERE " . $where;
+            $query .= " WHERE " . $where . $Orwhere;
         }
 
         $query .= $this->getClause("GROUP By", $this->groupby);
@@ -229,7 +263,7 @@ class QueryBuilder
 
     private function fillData(Query &$query): void
     {
-        foreach ($this->wheres as $expression) {
+        foreach (array_merge($this->wheres, $this->orwheres) as $expression) {
             if ($expression instanceof Expression) {
                 if ($expression->hasData()) {
                     $query->addData($expression->getValue());
@@ -238,10 +272,18 @@ class QueryBuilder
         }
     }
 
-    private function getWhere(): string
+    private function getWhere(int $mode = QueryBuilder::MODE_AND): string
     {
         $where = "";
-        foreach ($this->wheres as $expression) {
+        $collection = match ($mode) {
+            QueryBuilder::MODE_AND => $this->wheres,
+            QueryBuilder::MODE_OR => $this->orwheres,
+        };
+        $keyword = match ($mode) {
+            QueryBuilder::MODE_AND => " AND ",
+            QueryBuilder::MODE_OR => " OR ",
+        };
+        foreach ($collection as $expression) {
             $sw = "";
             if ($expression instanceof Expression) {
                 $sw = $expression->raw();
@@ -252,7 +294,7 @@ class QueryBuilder
                 }
             }
             if ($where != "" && $sw != "") {
-                $where .= " AND ";
+                $where .= " $keyword ";
             }
             $where .= $sw;
         }

tests/CollectionTest.php

@@ -50,5 +50,29 @@ test("collection", function () {
         return $item + $carry;
     },$init);
     expect($reduce)->toBe(55);
+
+    $array = $coll->toArray();
+    expect($array)->toBeArray();
+    expect(count($array))->toBe(11);
+
+    $obj = new \stdClass();
+    $obj->key = "test";
+    $obj->val = 1;
+
+    $obj2 = new \stdClass();
+    $obj2->key = "test2";
+    $obj2->val = 2;
+
+    $collo = new Collection([$obj,$obj2]);
+    expect($collo)->toBeInstanceOf(Collection::class);
+    expect(count($collo))->toBe(2);
+
+    $json = json_encode($collo);
+    expect($json)->toBeJson();
+    
+    $pluck = $collo->pluck("key");
+    expect($pluck)->toBeInstanceOf(Collection::class);
+    expect(count($pluck))->toBe(2);
+    expect($pluck->first())->toBe("test");
 });
  

tests/DbTest.php

@@ -35,6 +35,32 @@ test("insert row",function () {
     expect($ret2)->toBe(true);
 });
 
+test("model find", function() {
+    $row = new Model();
+    $row->setTable("test");
+
+    $res = $row->find(1);
+    expect($res->id)->toBe(1);
+    expect($row->col1)->toBe("test");
+
+    $res = $row->find(15);
+    expect($res)->toBe(null); 
+
+    $row->col1 = "test2";
+    $res = $row->save();
+    expect($res)->toBe(true);
+
+    $row->col1 = "test";
+    $res = $row->save();
+    expect($res)->toBe(true);
+
+    $json = json_encode($row);
+    expect($json)->toBeJson();
+
+    $obj = json_decode($json);
+    expect($obj->col1)->toBe("test");
+});
+
 test("querybuilder", function() {
     $qb = new QueryBuilder("test");
     $row = $qb->find(1);
@@ -72,6 +98,26 @@ test("querybuilder", function() {
     $qb->reset();
     $rows = $qb->whereNotNull("col1")->get();
     expect(count($rows))->toBe(2);    
+
+    $qb->reset();
+    $rows = $qb->where("id",1)->orWhere("id",2)->get();
+    expect(count($rows))->toBe(2);   
+});
+
+test("extending model",function()
+{
+    $class = "Test";
+    $code = "class $class extends \Kletellier\PdoWrapper\Model {}";
+    eval($code);
+
+    $qbs = Test::q(); 
+    expect($qbs)->toBeInstanceOf(QueryBuilder::class);
+
+    $row = $qbs->find(1);
+    expect($row->id)->toBe(1);
+    expect($row->col1)->toBe("test");
+
+    expect($row)->toBeInstanceOf(Test::class);
 });
 
 test("order by", function(){
@@ -99,7 +145,18 @@ test("group by", function(){
     expect($rows->first()->Nb)->toBe(1);
 });
 
+test("isset",function()
+{
+    $q = new QueryBuilder("test");
+    $row = $q->where("id",1)->get()->first();
  
+    expect($row->id)->toBe(1);
+    expect($row->col1)->toBe("test");
+
+    expect(isset($row->col1))->toBe(true);
+    expect(isset($row->col2))->toBe(false);
+    expect(isset($row->find))->toBe(true);
+});
 
 test("update row", function() {
     $qb = new QueryBuilder("test","id");