thamtech / yii2-scheduler

src/models/base/SchedulerTask.php

<?php
/**
 * @copyright Copyright(c) 2016 Webtools Ltd
 * @copyright Copyright(c) 2018 Thamtech, LLC
 * @link https://github.com/thamtech/yii2-scheduler
 * @license https://opensource.org/licenses/MIT
**/

namespace thamtech\scheduler\models\base;

use Yii;
use yii\data\ActiveDataProvider;

/**
 * This is the base-model class for table "scheduler_task".
 *
 * @property integer $id
 * @property string $name
 * @property string $display_name
 * @property string $schedule
 * @property string $description
 * @property integer $status_id
 * @property string $started_at
 * @property string $last_run
 * @property string $next_run
 * @property integer $active
 *
 * @property \thamtech\scheduler\models\SchedulerLog[] $schedulerLogs
 */
class SchedulerTask extends \yii\db\ActiveRecord
{
    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return 'scheduler_task';
    }

    /**
     *
     */
    public static function label($n = 1)
    {
        return Yii::t('app', '{n, plural, =1{Scheduler Task} other{Scheduler Tasks}}', ['n' => $n]);
    }

    /**
     *
     */
    public function __toString()
    {
        return (string) $this->id;
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['name', 'display_name', 'schedule', 'description', 'status_id'], 'required'],
            [['description', 'display_name'], 'string'],
            [['status_id'], 'integer'],
            [['started_at', 'last_run', 'next_run'], 'safe'],
            [['name', 'schedule'], 'string', 'max' => 255],
            [['name'], 'unique']
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'id' => Yii::t('app', 'ID'),
            'name' => Yii::t('app', 'Name'),
            'display_name' => Yii::t('app', 'Display Name'),
            'schedule' => Yii::t('app', 'Schedule'),
            'description' => Yii::t('app', 'Description'),
            'status_id' => Yii::t('app', 'Status ID'),
            'started_at' => Yii::t('app', 'Started At'),
            'last_run' => Yii::t('app', 'Last Run'),
            'next_run' => Yii::t('app', 'Next Run'),
        ];
    }

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getSchedulerLogs()
    {
        return $this->hasMany(\thamtech\scheduler\models\SchedulerLog::className(), ['scheduled_task_id' => 'id']);

The function yii\base\BaseObject::className() has been deprecated: since 2.0.14. On PHP >=5.5, use `::class` instead.

    }

    /**
     * Creates data provider instance with search query applied
     *
     * @param array $params
     *
     * @return ActiveDataProvider
     */
    public function search($params = null)
    {
        $formName = $this->formName();
        $params = !$params ? Yii::$app->request->get($formName, array()) : $params;
        $query = self::find();

        $dataProvider = new ActiveDataProvider([
            'query' => $query,
            'sort' => ['defaultOrder'=>['id'=>SORT_DESC]],
        ]);

        $this->load($params, $formName);

        $query->andFilterWhere([
            'id' => $this->id,
            'status_id' => $this->status_id,
        ]);

        $query
            ->andFilterWhere(['like', 'name', $this->name])
            ->andFilterWhere(['like', 'display_name', $this->display_name])
            ->andFilterWhere(['like', 'schedule', $this->schedule])
            ->andFilterWhere(['like', 'description', $this->description])
            ->andFilterWhere(['like', 'started_at', $this->started_at])
            ->andFilterWhere(['like', 'last_run', $this->last_run])
            ->andFilterWhere(['like', 'next_run', $this->next_run]);

        return $dataProvider;
    }
}