You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
123 lines
3.9 KiB
123 lines
3.9 KiB
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Progress handler that updates a database table with the progress.
|
|
*
|
|
* @package core
|
|
* @copyright 2018 Matt Porritt <mattp@catalyst-au.net>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core\progress;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Progress handler that updates a database table with the progress.
|
|
*
|
|
* @package core
|
|
* @copyright 2018 Matt Porritt <mattp@catalyst-au.net>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class db_updater extends base {
|
|
|
|
/**
|
|
* The primary key of the database record to update.
|
|
*
|
|
* @var integer
|
|
*/
|
|
protected $recordid = 0;
|
|
|
|
/**
|
|
* The database table to insert the progress updates into.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $table = '';
|
|
|
|
/**
|
|
* The table field to update with the progress.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $field = '';
|
|
|
|
/**
|
|
* The maximum frequency in seconds to update the database (default 5 seconds).
|
|
* Lower values will increase database calls.
|
|
*
|
|
* @var integer
|
|
*/
|
|
protected $interval = 5;
|
|
|
|
|
|
/**
|
|
* The timestamp of when the next progress update to the database will be.
|
|
*
|
|
* @var integer
|
|
*/
|
|
protected $nextupdate = 0;
|
|
|
|
/**
|
|
* Constructs the progress reporter.
|
|
*
|
|
* @param int $recordid The primary key of the database record to update.
|
|
* @param string $table The databse table to insert the progress updates into.
|
|
* @param string $field The table field to update with the progress.
|
|
* @param int $interval The maximum frequency in seconds to update the database (default 5 seconds).
|
|
*/
|
|
public function __construct($recordid, $table, $field, $interval=5) {
|
|
$this->recordid = $recordid;
|
|
$this->table = $table;
|
|
$this->field = $field;
|
|
$this->interval = $interval;
|
|
}
|
|
|
|
/**
|
|
* Updates the progress in the database.
|
|
* Database update frequency is set by $interval.
|
|
*
|
|
* @see \core\progress\base::update_progress()
|
|
*/
|
|
public function update_progress() {
|
|
global $DB;
|
|
$now = $this->get_time();
|
|
$lastprogress = $this->lastprogresstime != 0 ? $this->lastprogresstime : $now;
|
|
|
|
$progressrecord = new \stdClass();
|
|
$progressrecord->id = $this->recordid;
|
|
$progressrecord->{$this->field} = '';
|
|
|
|
// Update database with progress.
|
|
if ($now > $this->nextupdate) { // Limit database updates based on time.
|
|
list ($min, $max) = $this->get_progress_proportion_range();
|
|
|
|
$progressrecord->{$this->field} = $min;
|
|
$DB->update_record($this->table, $progressrecord);
|
|
$this->nextupdate = $lastprogress + $this->interval;
|
|
}
|
|
|
|
// Set progress to 1 (100%) when there are no more progress updates.
|
|
// Their is no guarantee that the final update from the get progress method
|
|
// will be 1 even for a successful process. So we explicitly set the final DB
|
|
// value to 1 when we are no longer in progress.
|
|
if (!$this->is_in_progress_section()) {
|
|
$progressrecord->{$this->field} = 1;
|
|
$DB->update_record($this->table, $progressrecord);
|
|
}
|
|
}
|
|
}
|
|
|