2.25

Author: jorgecc-business-account

README.md

@@ -655,6 +655,8 @@ Commonly, the log format could be of the type info or error.   Flag could show a
 Dual license (LGPL 3.0 and Commercial). See LICENSE file.
 
 ## Version
+* 2.25 2024-07-19
+  * added function setTime() 
 * 2.24 2024-07-18
   * updated to PHP 7.4 
   * update comments

composer.json

@@ -24,7 +24,7 @@
         "eftec/minilang": "^2.28",
         "ext-ctype": "*",
         "ext-json": "*",
-        "eftec/documentstoreone": "^1.26"
+        "eftec/documentstoreone": "^1.27"
     },
     "require-dev": {
       "phpunit/phpunit": "^9.0"

example/exampletimeline.php

@@ -0,0 +1,31 @@
+<?php
+
+use eftec\statemachineone\StateMachineOne;
+
+include '../vendor/autoload.php';
+
+$smachine=new StateMachineOne(null);
+$smachine->setDefaultInitState(1);
+$smachine->setDocDB('exampledb','col1','folder');
+$smachine->getDocOne()->autoSerialize(true,'json_array');
+$smachine->setTime(1000);
+//$smachine->setTime(6000);
+
+
+$smachine->setStates([1=>'init',2=>'mid',3=>'end']);
+$smachine->fieldDefault=['v1'=>0];
+$smachine->addTransition(1,2,'where _time>=1010','change');
+$smachine->addTransition(2,3,'where _time>=1020','change');
+
+$job=$smachine->createJob(['v1'=>1]);
+
+for($i=1000;$i<=1020;$i++) {
+    $smachine->setTime($i);
+    $smachine->checkAllJobs();
+
+    $lastJob = $smachine->getLastJob();
+    echo "State:$lastJob->state time:$i<br>";
+}
+
+
+//$smachine->saveDBAllJob();

lib/Flags.php

@@ -17,7 +17,7 @@
  *
  * @package  eftec\statemachineone
  * @author   Jorge Patricio Castro Castillo <jcastro arroba eftec dot cl>
- * @version  2.23.3 2023-06-29
+ * @version  2.25 2024-07-19
  * @link     https://github.com/EFTEC/StateMachineOne
  */
 class Flags implements StateSerializable

lib/Job.php

@@ -7,7 +7,7 @@
  * Class Job
  * @package  eftec\statemachineone
  * @author   Jorge Patricio Castro Castillo <jcastro arroba eftec dot cl>
- * @version  1.7 2019-06-16
+ * @version  2.25 2024-07-19
  * @link     https://github.com/EFTEC/StateMachineOne
  */
 class Job

lib/StateMachineOne.php

@@ -24,20 +24,19 @@
  *
  * @package  eftec\statemachineone
  * @author   Jorge Patricio Castro Castillo <jcastro arroba eftec dot cl>
- * @version  2.24 2024-07-18
+ * @version  2.25 2024-07-19
  * @license  LGPL-3.0 (you could use in a comercial-close-source product but any change to this library must be shared)
  * @link     https://github.com/EFTEC/StateMachineOne
  */
 class StateMachineOne
 {
-    public const VERSION = '2.24';
+    public const VERSION = '2.25';
     /** @var int NODB constants indicate that NO DB would be used */
     public const NODB = 0;
     /** @var int PDODB constants indicate that PdoOne database would be used */
     public const PDODB = 1;
     /** @var int PDODB constants indicate that DocumentStoreOne database would be used */
     public const DOCDB = 2;
-
     /**
      * @var array Possible states. It must be an associative array.<br>
      * <p>$statemachine->states=['State1'=>'name of the state','State2'=>'another name'];</p>
@@ -54,7 +53,7 @@ class StateMachineOne
     /** @var string The name of the table to store the jobs */
     public string $tableJobs = 'stm_jobs';
     /** @var string The name of the table to store the logs per job. If it's empty then it is not used */
-    public string $tableJobLogs = '';
+    public string $tableJobLogs = 'stm_logs';
     /** @var array The list of database columns used by the job */
     public array $columnJobs = ['idjob', 'idparentjob', 'idactive', 'idstate', 'dateinit', 'datelastchange'
         , 'dateexpired', 'dateend'];
@@ -83,7 +82,7 @@ class StateMachineOne
     /** @var MiniLang */
     public $miniLang;
     /** @var null|object It is the service class (optional) */
-    public ?object $serviceObject=null;
+    public ?object $serviceObject = null;
     /** @var string =['after','before','instead'][$i] */
     public string $pauseTriggerWhen; // none
     /** @var callable|null It is used to replace the current method used to store the logs */
@@ -111,7 +110,7 @@ class StateMachineOne
     private string $dbSchema = '';
     // callbacks
     /** @var PdoOne|null */
-    private ?PdoOne $pdoOne=null;
+    private ?PdoOne $pdoOne = null;
     /** @var DocumentStoreOne */
     private DocumentStoreOne $docOne;
     /** @var callable it's called when we change state (by default it returns true) */
@@ -131,6 +130,10 @@ class StateMachineOne
     /** @var callable This function increased in 1 the next id of the job. It is only called if we are not using a database */
     private $getNumberTrigger;
     public string $zeroDate = '1970-01-01 00:00:01';
+    /**
+     * @var callable|null
+     */
+    private $timeFunction;
 
     /**
      * Constructor of the class. By default, the construct set default triggers.
@@ -921,9 +924,13 @@ public function addLog(Job $job, string $type, string $subtype, string $descript
     }
 
     /**
-     * It returns the current timestamp. If exists a universal timer function (a global function called universaltime),
-     * then it is uses.  Why? It is because sometimes we want the same time across different services.
-     *
+     * It returns the current timestamp using the microtime function. It is used internally.<br>
+     * If exists a universal timer function (a global function called universaltime),then it is uses.<br>
+     * If setTime() is set, then it uses the value set there.<br>
+     * **Example**
+     * ```
+     * $time=$this->getTime();
+     * ```
      * @param bool $microtime if true then it returns the microtime as float
      *
      * @return int|float
@@ -933,9 +940,40 @@ public function getTime(bool $microtime = false)
         if (function_exists('universaltime')) {
             return universaltime($microtime);
         }
+        if ($this->timeFunction !== null) {
+            $fn = $this->timeFunction;
+            return $fn($microtime);
+        }
         return $microtime ? microtime(true) : time();
     }
 
+    /**
+     * It sets the way to determine the current time (timestamp). If it is not set, then it uses microtime()<br>
+     * **Example**<br>
+     * ```
+     * $this->setTime(10); // GMT: Thursday, 1 January 1970 0:00:10
+     * $this->setTime(new DateTime("2024-01-01 11:12:14"));
+     * $this->setTime(function($microtime=false) { return microtime($microtime); });
+     * ```
+     * @param callable|DateTime|numeric|null $newTime if callable, then it uses a funcion to determine the current time
+     *                                            if DateTime, then it is converted to timestamp
+     *                                            If int, then it is used as the current timestamp
+     * @return void
+     */
+    public function setTime($newTime): void
+    {
+        if (is_callable($newTime)) {
+            $this->timeFunction = $newTime;
+        } else {
+            if($newTime instanceof DateTime) {
+                $newTime = $newTime->getTimestamp();
+            }
+            $this->timeFunction = static function($arg = null) use ($newTime) {
+                return $newTime;
+            };
+        }
+    }
+
     /**
      * @param mixed $time timestamp with microseconds. If "now", then it returns the current time.
      *
@@ -1412,9 +1450,9 @@ public function callEvent($name, ?Job $job = null): void
             return;
         }
         $this->events[$name]->setDict($jobExec->fields);
-        $this->events[$name]->setDictEntry('_idjob', $job->idJob);
+        $this->events[$name]->setDictEntry('_idjob', $job !== null ? $job->idJob : null);
         $this->events[$name]->setDictEntry('_time', $this->getTime());
-        $this->events[$name]->setDictEntry('_state0', $job->state);
+        $this->events[$name]->setDictEntry('_state0', $job !== null ? $job->state : null);
         $this->events[$name]->evalSet();
         $this->checkJob($jobExec);
         if ($this->dbActive != self::NODB) {

lib/Transition.php

@@ -10,7 +10,7 @@
  * Class Transition
  * @package  eftec\statemachineone
  * @author   Jorge Patricio Castro Castillo <jcastro arroba eftec dot cl>
- * @version  2.24 2024-07-18
+ * @version  2.25 2024-07-19
  * @link     https://github.com/EFTEC/StateMachineOne
  */
 class Transition
@@ -153,9 +153,11 @@ public function doTransition(StateMachineOne $smo, Job $job, bool $forced = fals
                     $smo->changeState($job, $this->state1);
                     $this->caller->miniLang->evalSet($numTransaction);
                     //if ($smo->isDbActive()) $smo->saveDBJob($job);
+
                     $smo->addLog($job, 'INFO', 'TRANSITION', 'state,,changed,,'
                         . $smo->getStates()[$this->state0] . ",,$this->state0,,"
                         . $smo->getStates()[$this->state1] . ",,$this->state1,,$numTransaction,,$this->result");
+
                     return true;
                 }
                 break;