update cron behavior, model and error handler

Author: Chepurnoy

actions/CronLogAction.php

@@ -1,14 +1,7 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: semenov
- * Date: 04.07.14
- * Time: 20:31
- */
 
 namespace yii2mod\cron\actions;
 
-
 use yii\base\Action;
 use yii\data\ActiveDataProvider;
 use yii2mod\cron\models\CronScheduleModel;
@@ -25,7 +18,7 @@ class CronLogAction extends Action
     public $view = '@vendor/yii2mod/yii2-cron-log/views/index';
 
     /**
-     *
+     * Run action
      */
     public function run()
     {

behaviors/CronLoggerBehavior.php

@@ -1,42 +1,35 @@
 <?php
+
 namespace yii2mod\cron\behaviors;
 
 use Yii;
 use yii\base\Behavior;
 use yii\console\Controller;
 use yii2mod\cron\models\CronScheduleModel;
+use yii2mod\cron\models\enumerables\CronScheduleStatus;
 
 /**
  * CronLoggerBehavior allows logging of the console command running schedule.
  * This behavior adjusts the application event handles to intercept any errors and exception and log
  * them properly.
  *
  * You may adjust log result using the exit code, which is returned by command action.
- * In order to mark success, command action should return '0'.
  * In order to signal an error, command action should return string error message.
  *
- * Usage:
- * <code>
- * class MyCommand extends CConsoleCommand
+ * ~~~
+ * class JobCommand extends Controller
  * {
  *     public function behaviors()
  *     {
- *         return array(
- *             'mutexBehavior' => array(
+ *         return [
+ *             'cronLogger' => [
  *                 'class' => 'CronLoggerBehavior',
- *                 'actions' => array('index'),
- *             ),
- *         );
+ *                 'actions' => ['index'], // OR ['*'] - attach to all actions
+ *             ],
+ *         ];
  *     }
  * }
- * </code>
- *
- * @author  Roman Protsenko <protsenko@zfort.com>
- * @author  Klimov Paul <klimov@zfort.com>
- * @author  Dmitry Semenov <disemx@gmail.com>
- * @version $Id$
- * @package default
- * @since   1.0
+ * ~~~
  */
 class CronLoggerBehavior extends Behavior
 {
@@ -48,15 +41,17 @@ class CronLoggerBehavior extends Behavior
     /**
      * @var array list of action names, which should be logged.
      */
-    public $actions = array();
+    public $actions = [];
 
     /**
      * @var string error message
      */
     public $message = '';
 
     /**
-     * @inheritdoc
+     * Declares event handlers for the [[owner]]'s events.
+     *
+     * @return array events (array keys) and the corresponding event handler methods (array values).
      */
     public function events()
     {
@@ -67,12 +62,12 @@ public function events()
     }
 
     /**
-     * @inheritdoc
+     * Before action
+     * @param $event \yii\base\ActionEvent
      */
     public function beforeAction($event)
     {
-        if (isset($this->actions) && is_array($this->actions) && in_array(strtolower($event->action->id), $this->actions)) {
-            /* @var CConsoleCommand $sender */
+        if (in_array($event->action->id, $this->actions) || in_array('*', $this->actions)) {
             $sender = $event->sender;
             $command = $sender->id . '/' . $sender->action->id;
             $this->schedule = new CronScheduleModel();
@@ -82,16 +77,16 @@ public function beforeAction($event)
     }
 
     /**
-     * @inheritdoc
+     * After action
+     * @param $event \yii\base\ActionEvent
      */
     public function afterAction($event)
     {
         if ($this->schedule) {
-            $exitCode = (int)$event->result;
-            if ($exitCode == 0) {
-                $exitCode = 'success';
+            if ($event->result === false) {
+                $exitCode = CronScheduleStatus::ERROR;
             } else {
-                $exitCode = 'error';
+                $exitCode = CronScheduleStatus::SUCCESS;
             }
             $this->schedule->endCronSchedule($exitCode);
             $this->schedule = null;

components/ErrorHandler.php

@@ -1,8 +1,11 @@
 <?php
+
 namespace yii2mod\cron\components;
 
 use Yii;
 use yii\web\HttpException;
+use yii2mod\cron\models\CronScheduleModel;
+use yii2mod\cron\models\enumerables\CronScheduleStatus;
 
 /**
  * Class ErrorHandler
@@ -11,7 +14,7 @@
 class ErrorHandler extends \yii\console\ErrorHandler
 {
     /**
-     * @var Schedule model
+     * @var CronScheduleModel model
      */
     public $schedule;
 
@@ -20,7 +23,7 @@ class ErrorHandler extends \yii\console\ErrorHandler
      *
      * @param \Exception $exception the exception to be logged
      */
-    protected function logException($exception)
+    public function logException($exception)
     {
         $category = get_class($exception);
         if ($exception instanceof HttpException) {
@@ -29,10 +32,10 @@ protected function logException($exception)
             $category .= ':' . $exception->getSeverity();
         }
         if ($this->schedule) {
-            $this->schedule->endCronSchedule('error', (string)$exception);
+            $this->schedule->endCronSchedule(CronScheduleStatus::ERROR, (string)$exception);
             $this->schedule = null;
         }
         \Yii::error((string)$exception, $category);
     }
 
-} 
+} 

composer.json

@@ -5,14 +5,21 @@
     "keywords": ["yii2", "extension"],
     "license": "Apache-2.0",
     "authors": [
-        {
-            "name": "Dmitry Semenov",
-            "email": "disemx@gmail.com"
-        }
+      {
+        "name": "Dmitry Semenov",
+        "email": "disemx@gmail.com"
+      },
+      {
+        "name": "Igor Chepurnoy",
+        "email": "igorzfort@gmail.com"
+      }
     ],
+    "require": {
+      "yii2mod/yii2-enum": "dev-master"
+    },
     "autoload": {
-        "psr-4": {
-            "yii2mod\\cron\\": ""
-        }
+      "psr-4": {
+        "yii2mod\\cron\\": ""
+      }
     }
 }

models/CronScheduleModel.php

@@ -1,9 +1,11 @@
 <?php
+
 namespace yii2mod\cron\models;
 
 use Yii;
 use yii\db\ActiveRecord;
 use yii\db\Expression;
+use yii2mod\cron\models\enumerables\CronScheduleStatus;
 
 /**
  * This is the model class for table "CronSchedule".
@@ -19,29 +21,33 @@
  */
 class CronScheduleModel extends ActiveRecord
 {
+
     /**
-     * @inheritdoc
+     * Declares the name of the database table associated with this AR class.
+     * @return string the table name
      */
     public static function tableName()
     {
-        return 'CronSchedule';
+        return '{{%CronSchedule}}';
     }
 
     /**
-     * @inheritdoc
+     * Returns the validation rules for attributes.
+     * @return array validation rules
      */
     public function rules()
     {
         return [
             [['messages'], 'string'],
             [['dateCreated', 'dateScheduled', 'dateExecuted', 'dateFinished'], 'safe'],
             [['jobCode'], 'string', 'max' => 255],
-            [['status'], 'string', 'max' => 255]
+            ['status', 'integer'],
         ];
     }
 
     /**
-     * @inheritdoc
+     * Returns the attribute labels.
+     * @return array attribute labels (name => label)
      */
     public function attributeLabels()
     {
@@ -59,38 +65,30 @@ public function attributeLabels()
 
 
     /**
-     *
-     * @author   Roman Protsenko <protsenko@zfort.com>
+     * Start cron schedule
      *
      * @param string $jobCode
-     * @param string $status
-     * @param null   $messages
-     *
-     * @internal param string $message
-     * @return boolean
+     * @param int $status
+     * @param null $messages
+     * @return bool
      */
-    public function startCronSchedule($jobCode, $status = null, $messages = null)
+    public function startCronSchedule($jobCode, $status = CronScheduleStatus::RUN, $messages = null)
     {
-        if ($status === null) {
-            $status = 'running';
-        }
         $this->jobCode = $jobCode;
         $this->status = $status;
         $this->messages = $messages;
-
         $this->dateScheduled = new Expression('NOW()');
         $this->dateExecuted = new Expression('NOW()');
+
         return $this->save();
     }
 
     /**
-     *
-     * @author   Roman Protsenko <protsenko@zfort.com>
+     * End cron schedule
      *
      * @param string $status
-     * @param null   $messages
+     * @param null $messages
      *
-     * @internal param string $message
      * @return boolean
      */
     public function endCronSchedule($status, $messages = null)

models/enumerables/CronScheduleStatus.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace yii2mod\cron\models\enumerables;
+
+use yii2mod\enum\helpers\BaseEnum;
+
+/**
+ * Class CronScheduleStatus
+ * @package yii2mod\cron\models\enumerables
+ */
+class CronScheduleStatus extends BaseEnum
+{
+    const SUCCESS = 0;
+    const ERROR = 1;
+    const RUN = 2;
+
+    public static $list = [
+        self::ERROR => 'Error',
+        self::RUN => 'Run',
+        self::SUCCESS => 'Complete',
+    ];
+}