seeddms-code/inc/inc.Tasks.php
2020-05-27 15:12:03 +02:00

41 lines
1.1 KiB
PHP

<?php
/**
* Class containing methods for running a scheduled task
*
* @author Uwe Steinmann <uwe@steinmann.cx>
* @package SeedDMS
* @subpackage trash
*/
class SeedDMS_ExpiredDocumentsTask extends SeedDMS_SchedulerTaskBase { /* {{{ */
/**
* Run the task
*
* @param $task task to be executed
* @param $dms dms
* @return boolean true if task was executed succesfully, otherwise false
*/
public function execute($task, $dms, $user, $settings) {
$taskparams = $task->getParameter();
$dms->getDocumentsExpired(intval($taskparams['days']));
return true;
}
public function getDescription() {
return 'Check for expired documents and set the document status';
}
public function getAdditionalParams() {
return array(
array(
'name'=>'days',
'type'=>'integer',
'description'=> 'Number of days to check for. Negative values will look into the past. 0 will just check for documents expiring the current day. Keep in mind that the document is still valid on the expiration date.',
)
);
}
} /* }}} */
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['expireddocs'] = new SeedDMS_ExpiredDocumentsTask;