Merge branch 'master' of https://git.mcnd.ca/mcndave/ulmus

- WIP on virtual fields
- Some minor bugfixes

src/Annotation/Property/Field.php

@@ -7,17 +7,15 @@ class Field implements \Ulmus\Annotation\Annotation {
     public string $type;
 
     public string $name;
-
+    
-    # public string $column;
-
     public int $length;
 
     public int $precision;
 
     public array $attributes = [];
 
-    public bool $nullable;
+    public bool $nullable = false;
-
+        
     public function __construct(? string $type = null, ? int $length = null)
     {
         if ( $type !== null ) {

src/Annotation/Property/Virtual.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Ulmus\Annotation\Property;
+
+class Virtual extends Field {
+    public Closure $closure;
+}

src/Common/EntityResolver.php

@@ -6,6 +6,7 @@ use Ulmus\Ulmus,
     Ulmus\Annotation\Annotation,
     Ulmus\Annotation\Classes\Table,
     Ulmus\Annotation\Property\Field,
+    Ulmus\Annotation\Property\Virtual,
     Ulmus\Annotation\Property\Relation;
 
 class EntityResolver {
@@ -51,13 +52,17 @@ class EntityResolver {
         return null;
     }
 
-    public function fieldList($fieldKey = self::KEY_ENTITY_NAME) : array
+    public function fieldList($fieldKey = self::KEY_ENTITY_NAME, bool $skipVirtual = false) : array
     {
         $fieldList = [];
         
         foreach($this->properties as $item) {
             foreach($item['tags'] ?? [] as $tag) {
                 if ( $tag['object'] instanceof Field ) {
+                    if ( $skipVirtual && ($tag['object'] instanceof Virtual )) {
+                        break;
+                    }
+                    
                     switch($fieldKey) {
                         case static::KEY_ENTITY_NAME:
                             $key = $item['name'];

src/Common/PdoObject.php

@@ -6,10 +6,13 @@ use PDO,
     PDOStatement;
 
 class PdoObject extends PDO {
+    
+    public static ? string $dump = null;
 
     public function select(string $sql, array $parameters = []): PDOStatement 
     {
-        //dump($sql, $parameters);
+        static::$dump && call_user_func_array(static::$dump, [ $sql, $parameters ]);
+
         try {
             if (false !== ( $statement = $this->prepare($sql) )) {
                 $statement = $this->execute($statement, $parameters, false);
@@ -25,6 +28,8 @@ class PdoObject extends PDO {
 
     public function runQuery(string $sql, array $parameters = []): ? PDOStatement 
     {
+        static::$dump && call_user_func_array(static::$dump, [ $sql, $parameters ]);
+        
         try {
             if (false !== ( $statement = $this->prepare($sql) )) {
                 return $this->execute($statement, $parameters, true);
@@ -63,7 +68,9 @@ class PdoObject extends PDO {
             throw $e;
         }
         catch (\Throwable $e) {
-            debogueur($statement, $parameters, $commit);
+            if ( function_exists("debogueur") ) {
+                debogueur($statement, $parameters, $commit);
+            }
             
             throw $e;
         }

src/EntityCollection.php

@@ -8,7 +8,7 @@ class EntityCollection extends \ArrayObject {
     
     public ? string $entityClass = null;
     
-    public function filters(Callable $callback) : Generator
+    public function filters(Callable $callback, bool $yieldValueOnly = false) : Generator
     {
         $idx = 0;
         
@@ -16,31 +16,41 @@ class EntityCollection extends \ArrayObject {
             if ( $callback($item, $key, $idx) ) {
                 $idx++;
                 
-                yield $key => $item;
+                if ( $yieldValueOnly ) {
+                    yield $item;
+                }
+                else {
+                    yield $key => $item;
+                }
             }
         }
     }
         
-    public function filtersCollection(Callable $callback) : self
+    public function filtersCollection(Callable $callback, bool $yieldValueOnly = false, bool $replaceCollection = false) : self
     {
         $collection = new static();
         
-        foreach($this->filters($callback) as $item) {
+        foreach($this->filters($callback, $yieldValueOnly) as $item) {
             $collection->append($item);
         }
         
-        return $collection;
+        if ($replaceCollection) {
+            $this->exchangeArray(array_values($collection->getArrayCopy()));
+            
+            return $this;
+        }
+        else {
+            return $collection;
+        }
     }
         
-    public function iterate(Callable $callback) : array
+    public function iterate(Callable $callback) : self
     {
-        $results = [];
-        
         foreach($this as $item) {
-            $results[] = $callback($item);
+            $callback($item);
         }
         
-        return $results;
+        return $this;
     }
     
     public function removeOne($value, string $field, bool $strict = true) : ? object
@@ -68,6 +78,13 @@ class EntityCollection extends \ArrayObject {
         return $removed;
     }
     
+    public function search($value, string $field, bool $strict = true) : Generator 
+    {
+        foreach($this->filters(fn($v) => $strict ? $v->$field === $value : $v->$field == $value) as $key => $item) {
+            yield $key => $item;
+        }
+    }
+    
     public function searchOne($value, string $field, bool $strict = true) : ? object 
     {
         # Returning first value only
@@ -78,24 +95,83 @@ class EntityCollection extends \ArrayObject {
         return null;
     }
     
-    public function search($value, string $field, bool $strict = true) : Generator 
+    public function searchAll($value, string $field, bool $strict = true) : self
     {
-        foreach($this->filters(fn($v) => $strict ? $v->$field === $value : $v->$field == $value) as $key => $item) {
+        $obj = new static();
-            yield $key => $item;
+        
+        foreach($this->search($value, $field, $strict) as $item) {
+            $obj->append($item);
         }
+        
+        return $obj;
     }
     
-    public function column($field) : array
+    public function column($field, bool $unique = false) : array
     {
         $list = [];
         
         foreach($this as $item) {
-            $list[] = $item->$field;
+            if ( is_callable($field) ) {
+                $value = call_user_func_array($field, [ $item ]);
+            }
+            else {
+                $value = $item->$field;
+            }
+            
+            if ($unique && in_array($value, $list)) {
+                break;
+            }
+            
+            $list[] = $value;
         }
         
         return $list;
     }
     
+    public function unique(/*stringable|callable */ $field, bool $strict = false) : self
+    {
+        $list = [];
+        $obj = new static();
+        
+        foreach($this as $item) {
+            if ( $field === null) {
+                $value = $this;
+            }
+            if ( is_callable($field) ) {
+                $value = call_user_func_array($field, [ $item ]);
+            }
+            else {
+                $value = $item->$field;
+            }
+            
+            if ( ! in_array($value, $list, $strict) ) {
+                $list[] = $value;
+                
+                $obj->append($item);
+            }   
+        }
+        
+        return $obj;
+    }
+    
+    public function first() : ? object
+    {
+        foreach($this as $item) {
+            return $item;
+        }
+        
+        return null;
+    }
+
+    public function last() : ? object
+    {
+        foreach($this as $item) {
+            $return = $item;
+        }
+        
+        return $return ?? null;
+    }
+    
     public function buildArray(string $keyColumn, /* string|callable|null */ $value = null) : array
     {
         $list = [];
@@ -143,7 +219,7 @@ class EntityCollection extends \ArrayObject {
         return $list;
     }
         
-    public function fromArray(array $datasets, ? string $entityClass = null) : self 
+    public function fromArray(array $datasets, ? string /*stringable*/ $entityClass = null) : self 
     {
         if ( ! ($this->entityClass || $entityClass) ) {
             throw new \Exception("An entity class name must be provided to be instanciated and populated before insertion into this collection.");
@@ -168,4 +244,31 @@ class EntityCollection extends \ArrayObject {
         
         return $this;
     }
+    
+    public function replaceWith( /*array|EntityCollection*/ $datasets ) : self
+    {
+        if ( is_object($datasets) ) {
+            $datasets = $datasets->getArrayCopy();
+        }
+        
+        $this->exchangeArray( $datasets );
+        
+        return $this;
+    }
+    
+    public function randomize() : self
+    {
+        $arr = $this->getArrayCopy();
+        shuffle($arr);
+        $this->exchangeArray($arr);
+        
+        return $this;
+    }
+    
+    public function sort(callable $callback, $function = "uasort") : self
+    {
+        call_user_func_array([ $this, $function ], [ $callback ]);
+
+        return $this;
+    }
 }

src/EntityTrait.php

@@ -8,7 +8,7 @@ use Ulmus\Repository,
     Ulmus\Common\EntityField;
 
 use Ulmus\Annotation\Classes\{ Method, Table, Collation, };
-use Ulmus\Annotation\Property\{ Field, Relation, OrderBy, Where, Join };
+use Ulmus\Annotation\Property\{ Field, Relation, OrderBy, Where, Join, Virtual };
 use Ulmus\Annotation\Property\Field\{ Id, ForeignKey, CreatedAt, UpdatedAt, };
 
 trait EntityTrait {
@@ -70,7 +70,7 @@ trait EntityTrait {
                     $repository = $baseEntity->repository();
 
                     foreach($where as $condition) {
-                        $repository->where($condition->field, $condition->value, $condition->operator);
+                        $repository->where($condition->field, is_callable($condition->value) ? $f = call_user_func_array($condition->value, [ $this ]) : $condition->value, $condition->operator);
                     }
 
                     foreach($order as $item) {
@@ -81,10 +81,11 @@ trait EntityTrait {
                 }
 
                 switch( $relationType ) {
-                    case 'onetoone':                    
+                    case 'onetoone':       
-                        $repository->where( is_object($relation->foreignKey) ? $relation->foreignKey : $baseEntity->field($relation->foreignKey), $this->$field );
+                        if ($relation->foreignKey) {             
-                        $repository->limit(1);
+                            $repository->where( is_object($relation->foreignKey) ? $relation->foreignKey : $baseEntity->field($relation->foreignKey), is_callable($field) ? $field($this) : $this->$field );
-
+                        }
+                        
                         $this->eventExecute(Event\EntityRelationLoadInterface::class, $name, $repository);
                         
                         $result = call_user_func([$repository, $relation->function]);
@@ -96,7 +97,9 @@ trait EntityTrait {
                         return $this->$name = $result[0];
 
                     case 'onetomany':
-                        $repository->where( is_object($relation->foreignKey) ? $relation->foreignKey : $baseEntity->field($relation->foreignKey), $this->$field );
+                        if ($relation->foreignKey) {
+                            $repository->where( is_object($relation->foreignKey) ? $relation->foreignKey : $baseEntity->field($relation->foreignKey), is_callable($field) ? $field($this) : $this->$field );
+                        }
                         $this->eventExecute(Event\EntityRelationLoadInterface::class, $name, $repository);
 
                         return $this->$name = call_user_func([$repository, $relation->function]);
@@ -183,12 +186,12 @@ trait EntityTrait {
     /**
      * @Ignore
      */
-    public function entityFillFromDataset(iterable $dataset) : self
+    public function entityFillFromDataset(iterable $dataset, bool $isLoadedDataset = false) : self
     {
         $loaded = $this->isLoaded();
         
         $entityResolver = $this->resolveEntity();
-        
+
         foreach($dataset as $key => $value) {
             $field = $entityResolver->field(strtolower($key), EntityResolver::KEY_COLUMN_NAME, false) ?? null;
             
@@ -232,7 +235,7 @@ trait EntityTrait {
             }
             
             # Keeping original data to diff on UPDATE query
-            if ( ! $loaded ) {
+            if ( ! $loaded || $isLoadedDataset ) {
                 #if ( $field !== null ) {
                 #    $annotation = $entityResolver->searchFieldAnnotation($field['name'], new Field() );
                 #    $this->entityLoadedDataset[$annotation ? $annotation->name : $field['name']] = $dataset;       # <--------- THIS TO FIX !!!!!!
@@ -280,7 +283,7 @@ trait EntityTrait {
         
         $entityResolver = $this->resolveEntity();
         
-        foreach($entityResolver->fieldList() as $key => $field) {
+        foreach($entityResolver->fieldList(Common\EntityResolver::KEY_ENTITY_NAME, true) as $key => $field) {
             $annotation = $entityResolver->searchFieldAnnotation($key, new Field() );
 
             if ( isset($this->$key) ) { 
@@ -304,7 +307,6 @@ trait EntityTrait {
             }
         }
         
-        # @TODO Must fix recursive bug !
         if ($includeRelations) {
             foreach($entityResolver->properties as $name => $field){
                 $relation = $entityResolver->searchFieldAnnotation($name, new Relation() );
@@ -315,13 +317,13 @@ trait EntityTrait {
                             $list = [];
                             
                             foreach($value as $entity) {
-                                $list[] = $entity->entityGetDataset(true);
+                                $list[] = $entity->entityGetDataset(false);
                             }
                             
                             $dataset[$name] = $list;
                         }
                         elseif ( is_object($value) ) {
-                            $dataset[$name] = $value->entityGetDataset(true);
+                            $dataset[$name] = $value->entityGetDataset(false);
                         }
                     }
                 }

src/Query/Where.php

@@ -36,7 +36,7 @@ class Where extends Fragment {
         $this->condition = $condition;
         $this->parent = $queryBuilder->where ?? null;
     }
-
+    
     public function add($field, $value, string $operator, string $condition, bool $not = false) : self
     {
         $this->conditionList[] = [

src/QueryBuilder.php

@@ -29,6 +29,23 @@ class QueryBuilder
 
     protected array $queryStack = [];
 
+    public function __clone() 
+    {
+        if ($this->where ?? false) {
+            #$this->where = clone $this->where;
+            #$this->where->queryBuilder = $this;
+        }
+        
+        if ($this->having ?? false) {
+            #$this->having = clone $this->having;
+            #$this->having->queryBuiler = $this;
+        }
+        
+        if ($this->parent ?? false) {
+            #$this->parent = clone $this->parent;
+        }
+    }
+    
     public function select($field) : self
     {
         if ( null !== ( $select = $this->getFragment(Query\Select::class) ) ) {

src/Repository.php

@@ -29,6 +29,11 @@ class Repository
         $this->adapter = $adapter ?? $this->entityResolver->databaseAdapter();
         $this->queryBuilder = new QueryBuilder();
     }
+    
+    public function __clone() 
+    {
+        #$this->queryBuilder = clone $this->queryBuilder;
+    }
 
     public function loadOne() : ? object
     {
@@ -138,10 +143,10 @@ class Repository
                ( null !== $primaryKeyDefinition )) {
 
                 $pkField = key($primaryKeyDefinition);
-                $entity->$pkField = $statement->lastInsertId;
+                $dataset[$pkField] = $statement->lastInsertId;
             }
-
+            
-            return true;
+            $entity->entityFillFromDataset($dataset, true);
         }
         else {
             if ( $primaryKeyDefinition === null ) {
@@ -155,6 +160,8 @@ class Repository
 
                 $update = $this->updateSqlQuery($diff)->runQuery();
 
+                $entity->entityFillFromDataset($dataset);
+       
                 return $update ? (bool) $update->rowCount() : false;
             }
         }
@@ -205,7 +212,7 @@ class Repository
         }
     }
 
-    public function select($fields) : self
+    public function select(/*array|Stringable*/ $fields) : self
     {
         $this->queryBuilder->select($fields);
 
@@ -318,6 +325,14 @@ class Repository
         return $this;
     }
 
+    # @UNTESTED
+    public function randomizeOrder() : self
+    {
+        $this->queryBuilder->orderBy(Common\Sql::function('RAND', Sql::identifier('CURDATE()+0')));
+        
+        return $this;
+    }
+    
     public function orders(array $orderList) : self
     {
         foreach($orderList as $field => $direction) {
@@ -363,6 +378,7 @@ class Repository
 
         return $this->where($primaryKeyField[$pkField]->name ?? $pkField, $value);
     }
+ 
 
     public function withJoin(/*string|array*/ $fields) : self
     {
@@ -373,9 +389,10 @@ class Repository
         foreach((array) $fields as $item) {
             if ( null !== $join = $this->entityResolver->searchFieldAnnotation($item, new Annotation\Property\Join) ) {
                 $alias = $join->alias ?? $item;
+
                 $entity = $join->entity ?? $this->entityResolver->properties[$item]['type'];
 
-                foreach($entity::resolveEntity()->fieldList(Common\EntityResolver::KEY_COLUMN_NAME) as $key => $field) {
+                foreach($entity::resolveEntity()->fieldList(Common\EntityResolver::KEY_COLUMN_NAME, true) as $key => $field) {
                     $this->select("$alias.$key as {$alias}\${$field['name']}");
                 }
 
@@ -392,6 +409,7 @@ class Repository
         return $this;
     }
 
+
     public function filterServerRequest(SearchRequest\SearchRequestInterface $searchRequest) : self
     {
         $searchRequest->count = $searchRequest->filter( clone $this )
@@ -443,7 +461,14 @@ class Repository
 
         return Ulmus::runQuery($this->queryBuilder, $this->adapter);
     }
-
+    
+    public function resetQuery() : self
+    {
+        $this->queryBuilder->reset();
+        
+        return $this;
+    }
+    
     protected function insertSqlQuery(array $dataset) : self
     {
         if ( null === $this->queryBuilder->getFragment(Query\Insert::class) ) {
@@ -525,10 +550,10 @@ class Repository
 
         return $result;
     }
-
+    
-    public function instanciateEntityCollection() : EntityCollection
+    public function instanciateEntityCollection(...$arguments) : EntityCollection
     {
-        return $this->entityClass::entityCollection();
+        return $this->entityClass::entityCollection(...$arguments);
     }
 
     public function instanciateEntity() : object