remember task run time

Author: toplan

README.md

@@ -45,7 +45,7 @@ $result = Balancer::run('task1');
 ```
 # Todo
 
-- [ ] remember every tasks` start time and end time.
-- [ ] remember every drivers` start time and end time.
-- [ ] driver`s create arguments in task class (smart parse arguments)
+- [x] remember every tasks` start time and end time.
+- [x] remember every drivers` start time and end time.
+- [ ] smart parse driver`s create arguments in task class
 - [ ] define task`s lifecycle

src/TaskBalancer/Driver.php

@@ -95,7 +95,7 @@ public static function create(Task $task, $name, $weight = 1, $isBackUp = false,
      * before run hook
      * @return bool
      */
-    public function beforeRun()
+    private function beforeRun()
     {
         $this->time['started_at'] = microtime();
         return true;
@@ -124,7 +124,7 @@ public function run()
      *
      * @return mixed
      */
-    public function afterRun($result)
+    private function afterRun($result)
     {
         $this->time['finished_at'] = microtime();
         return $result;

src/TaskBalancer/Task.php

@@ -52,6 +52,15 @@ class Task {
      */
     protected $work = null;
 
+    /**
+     * task run time
+     * @var array
+     */
+    protected $time = [
+        'started_at' => 0,
+        'finished_at' => 0
+    ];
+
     /**
      * drivers` results
      * @var array
@@ -92,22 +101,61 @@ public function runWork()
         }
     }
 
+    /**
+     * run task
+     * @param string $driverName
+     *
+     * @return bool
+     * @throws \Exception
+     */
     public function run($driverName = '')
     {
         if ($this->isRunning()) {
             //stop run because current task is running
             return false;
         }
-        $this->status = static::RUNNING;
+        if (!$this->beforeRun()) {
+            return false;
+        }
         if (!$driverName) {
             $driverName = $this->getDriverNameByWeight();
         }
         $this->resortBackupDrivers($driverName);
         $success = $this->runDriver($driverName);
+        return $this->afterRun($success);
+    }
+
+    /**
+     * before run task
+     * @return bool
+     */
+    private function beforeRun()
+    {
+        $this->time['started_at'] = microtime();
+        $this->status = static::RUNNING;
+        return true;
+    }
+
+    /**
+     * after run task
+     * @param $result
+     *
+     * @return mixed
+     */
+    private function afterRun($result)
+    {
         $this->status = static::FINISHED;
-        return $success;
+        $this->time['finished_at'] = microtime();
+        return $result;
     }
 
+    /**
+     * run driver by name
+     * @param $name
+     *
+     * @return bool
+     * @throws \Exception
+     */
     public function runDriver($name)
     {
         $driver = $this->getDriver($name);
@@ -133,6 +181,11 @@ public function runDriver($name)
         return $success;
     }
 
+    /**
+     * get a backup driver and run it
+     * @return bool
+     * @throws \Exception
+     */
     public function runBackupDriver()
     {
         $name = $this->getNextBackupDriverName();
@@ -142,6 +195,10 @@ public function runBackupDriver()
         return true;
     }
 
+    /**
+     * generator a back up driver`s name
+     * @return null
+     */
     public function getNextBackupDriverName()
     {
         $drivers = $this->backupDrivers;
@@ -162,6 +219,11 @@ public function getNextBackupDriverName()
         return null;
     }
 
+    /**
+     * get a driver`s name by drivers` weight
+     * @return mixed
+     * @throws \Exception
+     */
     public function getDriverNameByWeight()
     {
         $count = $base = 0;
@@ -190,11 +252,24 @@ public function getDriverNameByWeight()
         throw new \Exception('get driver name by weight failed, something wrong');
     }
 
+    /**
+     * get a driver name
+     * @return mixed
+     */
     public function driverNameRand()
     {
         return array_rand(array_keys($this->drivers));
     }
 
+    /**
+     * create a new driver instance for current task
+     * @param               $name
+     * @param int           $weight
+     * @param bool|false    $isBackup
+     * @param \Closure|null $work
+     *
+     * @return mixed
+     */
     public function driver($name, $weight = 1, $isBackup = false, \Closure $work = null)
     {
         $driver = $this->getDriver($name);
@@ -205,9 +280,15 @@ public function driver($name, $weight = 1, $isBackup = false, \Closure $work = n
                 $this->backupDrivers[] = $name;
             }
         }
-        return $this->drivers[$name];
+        return $driver;
     }
 
+    /**
+     * current task has driver?
+     * @param $name
+     *
+     * @return bool
+     */
     public function hasDriver($name)
     {
         if (!$this->drivers) {
@@ -216,6 +297,12 @@ public function hasDriver($name)
         return isset($this->drivers[$name]);
     }
 
+    /**
+     * get a driver from current task drives pool
+     * @param $name
+     *
+     * @return null
+     */
     public function getDriver($name)
     {
         if ($this->hasDriver($name)) {
@@ -224,6 +311,10 @@ public function getDriver($name)
         return null;
     }
 
+    /**
+     * init back up drivers
+     * @param $name
+     */
     public function resortBackupDrivers($name)
     {
         if (count($this->backupDrivers) < 2) {
@@ -237,17 +328,29 @@ public function resortBackupDrivers($name)
         }
     }
 
+    /**
+     * task is running ?
+     * @return bool
+     */
     public function isRunning()
     {
         return $this->status == static::RUNNING;
     }
 
+    /**
+     * reset status
+     * @return $this
+     */
     public function reset()
     {
         $this->status = '';
         return $this;
     }
 
+    /**
+     * add a driver to backup drivers
+     * @param $driverName
+     */
     public function addToBackupDrivers($driverName)
     {
         if ($driverName instanceof Driver) {
@@ -258,6 +361,10 @@ public function addToBackupDrivers($driverName)
         }
     }
 
+    /**
+     * remove character driver from backup drivers
+     * @param $driverName
+     */
     public function removeFromBackupDrivers($driverName)
     {
         if ($driverName instanceof Driver) {

test/index.php

@@ -39,4 +39,6 @@
 $result = Balancer::run('test1');
 
 print_r('<br>resuts data:<br>');
-var_dump($result);
+var_dump($result);
+print_r('<hr>task data:<br>');
+var_dump($t);