add phpdoc

src/Collection.php

@@ -12,33 +12,64 @@ class Collection implements IteratorAggregate, Countable, JsonSerializable
 {
     private array $elements;
 
+    /**
+     * Constructor
+     *
+     * @param array $elements
+     */
     public function __construct(array $elements = [])
     {
         $this->elements = $elements;
     }
 
+    /**
+     * Return first element of the collection
+     *
+     * @return mixed
+     */
     public function first(): mixed
     {
         return reset($this->elements);
     }
 
+    /**
+     * Return last element of the collection
+     *
+     * @return mixed
+     */
     public function last(): mixed
     {
         return end($this->elements);
     }
 
+    /**
+     * Return collection length
+     *
+     * @return integer
+     */
     public function count(): int
     {
         return count($this->elements);
     }
 
+    /**
+     * Clear all elements in collection
+     *
+     * @return boolean
+     */
     public function clear(): bool
     {
         $this->elements = [];
         return count($this->elements) == 0;
     }
 
-    public function index($index): mixed
+    /**
+     * Return element in nth position in the collection
+     *
+     * @param int $index
+     * @return mixed
+     */
+    public function index(int $index): mixed
     {
         if (isset($this->elements[$index])) {
             return $this->elements[$index];
@@ -46,31 +77,67 @@ class Collection implements IteratorAggregate, Countable, JsonSerializable
         return null;
     }
 
+    /**
+     * Return random element of the collection
+     *
+     * @return mixed
+     */
     public function random(): mixed
     {
         return array_rand($this->elements);
     }
 
+    /**
+     * Reduce function on the collection
+     *
+     * @param callable $fn
+     * @param mixed $initial
+     * @return mixed
+     */
     public function reduce(callable $fn, mixed $initial): mixed
     {
         return array_reduce($this->elements, $fn, $initial);
     }
 
+    /**
+     * Map function on the collection
+     *
+     * @param callable $fn
+     * @return Collection
+     */
     public function map(callable $fn): Collection
     {
         return new Collection(array_map($fn, $this->elements));
     }
 
+    /**
+     * Apply callable function on each element of the function
+     *
+     * @param callable $fn
+     * @return void
+     */
     public function each(callable $fn): void
     {
         array_walk($this->elements, $fn);
     }
 
+    /**
+     * Apply function to filter collection
+     *
+     * @param callable $fn
+     * @return Collection
+     */
     public function filter(callable $fn): Collection
     {
         return new Collection(array_filter($this->elements, $fn, ARRAY_FILTER_USE_BOTH));
     }
 
+    /**
+     * Return collection of the key related items in current collection
+     *
+     * @param string $key
+     * @return Collection
+     */
     public function pluck(string $key): Collection
     {
         return new Collection(array_map(function ($item) use ($key) {
@@ -83,36 +150,72 @@ class Collection implements IteratorAggregate, Countable, JsonSerializable
         }, $this->elements));
     }
 
+    /**
+     * Return actual collection items in an array
+     *
+     * @return array
+     */
     public function toArray(): array
     {
         return $this->elements;
     }
 
+    /**
+     * Return if the collection are empty
+     *
+     * @return boolean
+     */
     public function empty(): bool
     {
         return empty($this->elements);
     }
 
+    /**
+     * Add an element to the collection
+     *
+     * @param mixed $element
+     * @return void
+     */
     public function add(mixed $element): void
     {
         $this->elements[] = $element;
     }
 
+    /**
+     * Return all values of the collection
+     *
+     * @return array
+     */
     public function values(): array
     {
         return array_values($this->elements);
     }
 
+    /**
+     * Return all items of the collection
+     *
+     * @return array
+     */
     public function items(): array
     {
         return $this->elements;
     }
 
+    /**
+     * Iterator
+     *
+     * @return Traversable
+     */
     public function getIterator(): Traversable
     {
         return new ArrayIterator($this->elements);
     }
 
+    /**
+     * Return json serialization of the collection
+     *
+     * @return mixed
+     */
     public function jsonSerialize(): mixed
     {
         return $this->elements;

src/Connection.php

@@ -137,12 +137,25 @@ class Connection
         };
     }
 
+    /**
+     * Execute raw query on the current pdo connection
+     *
+     * @param string $rawquery
+     * @return boolean
+     */
     public function executeRawQuery(string $rawquery): bool
     {
         $stmt = $this->pdo->prepare($rawquery);
         return $stmt->execute();
     }
 
+    /**
+     * Run prepared query in the current pdo connection
+     *
+     * @param Query $query
+     * @param $fetchmode
+     * @return mixed
+     */
     public function getSelectQuery(Query $query, $fetchmode = PDO::FETCH_ASSOC): mixed
     {
         $stmt = $this->pdo->prepare($query->getQuery());
@@ -152,6 +165,12 @@ class Connection
         return $stmt->fetchAll($fetchmode);
     }
 
+    /**
+     * Run prepared update query on the current pdo connection
+     *
+     * @param Query $query
+     * @return boolean
+     */
     public function updateQuery(Query $query): bool
     {
         $stmt = $this->pdo->prepare($query->getQuery());
@@ -160,6 +179,12 @@ class Connection
         return $stmt->execute();
     }
 
+    /**
+     * Run prepared insert query on the current pdo connection
+     *
+     * @param Query $query
+     * @return mixed
+     */
     public function insertQuery(Query $query): mixed
     {
         $stmt = $this->pdo->prepare($query->getQuery());
@@ -173,6 +198,11 @@ class Connection
         }
     }
 
+    /**
+     * Begin transaction on the current pdo connection
+     *
+     * @return boolean
+     */
     public function beginTransaction(): bool
     {
         if ($this->pdo) {
@@ -181,6 +211,11 @@ class Connection
         return false;
     }
 
+    /**
+     * Commit transaction on the current pdo connection
+     *
+     * @return boolean
+     */
     public function commit(): bool
     {
         if ($this->pdo) {
@@ -189,6 +224,11 @@ class Connection
         return false;
     }
 
+    /**
+     * Rollback transaction on the current pdo connection
+     *
+     * @return boolean
+     */
     public function rollback(): bool
     {
         if ($this->pdo) {
@@ -197,6 +237,13 @@ class Connection
         return false;
     }
 
+    /**
+     * Init the connections
+     *
+     * @param [type] $config
+     * @param array $connections
+     * @return void
+     */
     public static function init($config, array $connections = ["default"])
     {
         self::fillInstances($config, $connections);
@@ -226,17 +273,32 @@ class Connection
         throw new \Exception("Unknown connection");
     }
 
-    public function getError()
+    /**
+     * Return last error
+     *
+     * @return string
+     */
+    public function getError(): string
     {
         return $this->error;
     }
 
-    public function getPdo()
+    /**
+     * Return current PDO object
+     *
+     * @return PDO
+     */
+    public function getPdo(): PDO
     {
         return $this->pdo;
     }
 
-    public function getDriverType()
+    /**
+     * Return current database driver type currently used
+     *
+     * @return string
+     */
+    public function getDriverType(): string
     {
         return $this->type;
     }

src/Expression.php

@@ -4,9 +4,9 @@ namespace Kletellier\PdoWrapper;
 
 class Expression
 {
-    private $condition;
-    private $operator;
-    private $value;
+    private string $condition;
+    private string $operator;
+    private mixed $value;
 
     public function __construct($condition, $operator, $value)
     {
@@ -15,6 +15,11 @@ class Expression
         $this->value = $value;
     }
 
+    /**
+     * Return raw value of the expression
+     *
+     * @return string
+     */
     public function raw(): string
     {
         $operator = trim(strtolower($this->operator));
@@ -34,40 +39,78 @@ class Expression
         return "(" . $this->condition . " "  . $this->operator . " ? )";
     }
 
+    /**
+     * Return if the condition need to evaluate data
+     *
+     * @return boolean
+     */
     public function hasData()
     {
         $operator = trim(strtolower($this->operator));
         return (in_array($operator, ["isnull","notnull"])) ? false : true;
     }
 
-    public function getCondition()
+    /**
+     * Return actual condition
+     *
+     * @return string
+     */
+    public function getCondition(): string
     {
         return $this->condition;
     }
 
-    public function setCondition($condition)
+    /**
+     * Set condition
+     *
+     * @param string $condition
+     * @return self
+     */
+    public function setCondition(string $condition): self
     {
         $this->condition = $condition;
         return $this;
     }
 
-    public function getOperator()
+    /**
+     * Get actual operator
+     *
+     * @return string
+     */
+    public function getOperator(): string
     {
         return $this->operator;
     }
 
-    public function setOperator($operator)
+    /**
+     * Set operator
+     *
+     * @param string $operator
+     * @return self
+     */
+    public function setOperator(string $operator): self
     {
         $this->operator = $operator;
         return $this;
     }
 
-    public function getValue()
+    /**
+     * Get the value of the expression
+     *
+     * @return mixed
+     */
+    public function getValue(): mixed
     {
         return $this->value;
     }
 
-    public function setValue($value)
+    /**
+     * Set the value of the expression
+     *
+     * @param mixed $value
+     * @return void
+     */
+    public function setValue(mixed $value)
     {
         $this->value = $value;
         return $this;

src/Model.php

@@ -12,61 +12,117 @@ class Model implements JsonSerializable
     protected string $connection = "";
     protected string $pk;
     private bool $new;
+    private bool $ro;
 
-    public function __construct()
+    /**
+     * Constructor
+     *
+     * @param boolean $ro readonly model
+     */
+    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->table == "") {
-            $this->table =  $this->getDefaultTableName();
+        if (!$this->ro) {
+            if ($this->table == "") {
+                $this->table =  $this->getDefaultTableName();
+            }
+        } else {
+            $this->table = "ReadOnlyModel";
+            $this->pk = "__idpk";
         }
     }
 
+    /**
+     * Return table
+     *
+     * @return string
+     */
     public function getTable(): string
     {
         return $this->table;
     }
 
+    /**
+     * Define table
+     *
+     * @param string $table
+     * @return self
+     */
     public function setTable(string $table): self
     {
         $this->table = $table;
         return $this;
     }
 
+    /**
+     * Return current key value attributes
+     *
+     * @return array
+     */
     public function getValues(): array
     {
         return $this->values;
     }
 
+    /**
+     * Return current primary key
+     *
+     * @return string
+     */
     public function getPk(): string
     {
         return $this->pk;
     }
 
+    /**
+     * Set primary key
+     *
+     * @param string $pk
+     * @return self
+     */
     public function setPk(string $pk): self
     {
         $this->pk = $pk;
         return $this;
     }
 
-    public function getConnection()
+    /**
+     * Return actual connection
+     *
+     * @return string
+     */
+    public function getConnection(): string
     {
         return $this->connection;
     }
 
-    public function setConnection($connection)
+    /**
+     * Set connection
+     *
+     * @param string $connection
+     * @return void
+     */
+    public function setConnection(string $connection)
     {
         $this->connection = $connection;
         return $this;
     }
 
+    /**
+     * Fill values from key value array
+     *
+     * @param mixed $data
+     * @return self
+     */
     public function fillData(mixed $data): self
     {
         $this->values = $data;
@@ -75,9 +131,15 @@ class Model implements JsonSerializable
         return $this;
     }
 
+    /**
+     * Find specific element in the table on the primary key
+     *
+     * @param mixed $key
+     * @return mixed
+     */
     public function find(mixed $key): mixed
     {
-        $qb = $this->newQueryBuilder();
+        $qb = $this->newQueryBuilder(get_class($this));
         $find = $qb->find($key);
         if ($find !== null) {
             $this->fillData($find->getValues());
@@ -86,30 +148,37 @@ class Model implements JsonSerializable
         return null;
     }
 
+    /**
+     * Save current model
+     *
+     * @return boolean
+     */
     public function save(): bool
     {
         $ret = false;
-        $qb = $this->newQueryBuilder();
-        if ($this->new) {
-            $query = $qb->getPreparedQuery($this->values);
-            $id = Connection::getInstance($this->connection)->insertQuery($query);
-            if ($id !== false) {
-                $this->values[$this->pk] = $id;
-                $this->new = false;
-                $ret = true;
-            }
-        } else {
-            if (isset($this->values[$this->pk])) {
-                if (count($this->updated) > 0) {
-                    $data = [];
-                    $data[$this->pk] = $this->values[$this->pk];
-                    foreach ($this->updated as $updatecol) {
-                        $data[$updatecol] = $this->values[$updatecol];
-                    }
-                    $query = $qb->getPreparedQuery($data, false);
-                    $ret = Connection::getInstance($this->connection)->updateQuery($query);
-                    if ($ret) {
-                        $this->updated = [];
+        if (!$this->ro) {
+            $qb = $this->newQueryBuilder("");
+            if ($this->new) {
+                $query = $qb->getPreparedQuery($this->values);
+                $id = Connection::getInstance($this->connection)->insertQuery($query);
+                if ($id !== false) {
+                    $this->values[$this->pk] = $id;
+                    $this->new = false;
+                    $ret = true;
+                }
+            } else {
+                if (isset($this->values[$this->pk])) {
+                    if (count($this->updated) > 0) {
+                        $data = [];
+                        $data[$this->pk] = $this->values[$this->pk];
+                        foreach ($this->updated as $updatecol) {
+                            $data[$updatecol] = $this->values[$updatecol];
+                        }
+                        $query = $qb->getPreparedQuery($data, false);
+                        $ret = Connection::getInstance($this->connection)->updateQuery($query);
+                        if ($ret) {
+                            $this->updated = [];
+                        }
                     }
                 }
             }
@@ -117,9 +186,15 @@ class Model implements JsonSerializable
         return $ret;
     }
 
-    public function newQueryBuilder(): QueryBuilder
+    /**
+     * Return new QueryBuilder on the model
+     *
+     * @param string $className
+     * @return QueryBuilder
+     */
+    public function newQueryBuilder(string $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
@@ -139,10 +214,21 @@ class Model implements JsonSerializable
         }
     }
 
+    public static function getClassName()
+    {
+        return static::class;
+    }
+
+    /**
+     * Static method to return new QueryBuilder
+     *
+     * @return QueryBuilder
+     */
     public static function q(): QueryBuilder
     {
+        $cls = self::getClassName();
         $ist = new static();
-        return $ist->newQueryBuilder();
+        return $ist->newQueryBuilder($cls);
     }
 
     public function __get($name): mixed
@@ -163,6 +249,11 @@ class Model implements JsonSerializable
         return $table;
     }
 
+    /**
+     * Serialize the model in Json
+     *
+     * @return mixed
+     */
     public function jsonSerialize(): mixed
     {
         return $this->values;

src/Query.php

@@ -13,7 +13,13 @@ class Query
         $this->data = [];
     }
 
-    public function addData($value)
+    /**
+     * Add data to the query
+     *
+     * @param array|mixed $value
+     * @return void
+     */
+    public function addData(mixed $value)
     {
         if (is_array($value)) {
             $this->data = array_merge($this->data, $value);
@@ -22,22 +28,44 @@ class Query
         }
     }
 
+    /**
+     * Return statement
+     *
+     * @return string
+     */
     public function getQuery(): string
     {
         return $this->query;
     }
 
+    /**
+     * Set Statement
+     *
+     * @param string $query
+     * @return void
+     */
     public function setQuery(string $query)
     {
         $this->query = $query;
         return $this;
     }
 
+    /**
+     * Return current data of the query
+     *
+     * @return array
+     */
     public function getData(): array
     {
         return $this->data;
     }
 
+    /**
+     * Set data of the query
+     *
+     * @param array $data
+     * @return void
+     */
     public function setData(array $data)
     {
         $this->data = $data;

src/QueryBuilder.php

@@ -10,6 +10,7 @@ class QueryBuilder
     protected array $orders;
     protected array $groupby;
     protected string $table;
+    protected string $classname;
     protected string $connection;
     protected string $pk;
     protected ?int $take;
@@ -20,8 +21,9 @@ class QueryBuilder
     public const MODE_AND = 0;
     public const MODE_OR = 1;
 
-    public function __construct($table, $pk = "id", $connection = "")
+    public function __construct($table, $pk = "id", $connection = "", $classname = "")
     {
+        $this->classname = $classname;
         $this->table = $table;
         $this->pk = $pk;
         $this->connection = $connection;
@@ -208,7 +210,12 @@ class QueryBuilder
     {
         $ret = array();
         foreach ($data as $row) {
-            $model = new Model();
+            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);
@@ -238,8 +245,7 @@ class QueryBuilder
 
         $this->fillData($ret);
 
-        if($where!="" && $Orwhere!="")
-        {
+        if ($where != "" && $Orwhere != "") {
             $Orwhere = " OR " . $Orwhere;
         }
 
@@ -257,7 +263,7 @@ class QueryBuilder
 
     private function fillData(Query &$query): void
     {
-        foreach (array_merge($this->wheres,$this->orwheres) as $expression) {
+        foreach (array_merge($this->wheres, $this->orwheres) as $expression) {
             if ($expression instanceof Expression) {
                 if ($expression->hasData()) {
                     $query->addData($expression->getValue());

tests/DbTest.php

@@ -116,6 +116,8 @@ test("extending model",function()
     $row = $qbs->find(1);
     expect($row->id)->toBe(1);
     expect($row->col1)->toBe("test");
+
+    expect($row)->toBeInstanceOf(Test::class);
 });
 
 test("order by", function(){