Prado\Util\Cron\TShellCronAction::showTasks()

Complexity

Conditions	19
Paths	9226

Size

Total Lines	86
Code Lines	62

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	TShellCronAction::actionIndex()	0	23	3

<?php

/**
 * TShellCronAction class file.
 *
 * @author Brad Anderson <belisoful@icloud.com>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */
 
namespace Prado\Util\Cron;

use Prado\Prado;
use Prado\Shell\TShellAction;
use Prado\Shell\TShellWriter;
use Prado\Util\Cron\TCronModule;

/**
 * TShellCronAction class.
 *
 * Runs the TCronModule from the command line.   This will run all pending
 * tasks when the "cron" command is run.  Other sub-commands are "info" and
 * "tasks"; where "info" reports the possible cron tasks registered in the
 * application, and "tasks" reports the installed tasks being managed.
 *
 * @author Brad Anderson <belisoful@icloud.com>
 * @package Prado\Util\Cron
 * @since 4.2.0
 */
class TShellCronAction extends TShellAction
{
	protected $action = 'cron';
	protected $methods = ['run', 'tasks', 'index'];
	protected $parameters = [null, null, null];
	protected $optional = [null, null, null];
	protected $description = ['Manages Cron time-based services',
		'Runs the Cron Pending Tasks.',
		'Displays the Cron tasks configured in the application.',
		'Displays the registered Cron tasks information.'
	];
	
	/**
	 * @return string the Cron Class to find
	 */
	public function getModuleClass()
	{
		return 'Prado\\Util\\Cron\\TCronModule';
	}
	
	/**
	 * @retutrn null|Prado\Util\Cron\TCronModule returns the Cron Module of the applications
	 */
	public function getCronModule()
	{
		$app = Prado::getApplication();
		$moduleClass = $this->getModuleClass();
		$modules = $app->getModulesByType($moduleClass, false);
		$module = null;
		foreach ($modules as $id => $m) {
			if ($module = $app->getModule($id)) {
				break;
			}
		}
		if (!$module) {
			$this->_outWriter->writeError("A {$moduleClass} is not found");
			return null;
		}
		if (!$module->asa(TCronModule::SHELL_LOG_BEHAVIOR)) {
			$module->attachBehavior(TCronModule::SHELL_LOG_BEHAVIOR, new TShellCronLogBehavior($this->getWriter()));
		}
		return $module;
	}
	
	/**
	 * @param string[] $args the arguments to the command line action
	 */
	public function actionRun($args)

The parameter $args is not used and could be removed.

	{
		$module = $this->getCronModule();
		if (!$module) {
			return true;
		}
		$this->_outWriter->writeLine("\nLast Task time was " . date('Y-m-d H:i:s', $module->getLastCronTime()) . '');

The method getLastCronTime() does not exist on Prado\TModule. Since you implemented __call, consider adding a @method annotation.

		$module->processPendingTasks(true);

The method processPendingTasks() does not exist on Prado\TModule. Since you implemented __call, consider adding a @method annotation.

		return true;
	}
	
	/**
	 * Shows configured tasks and their run status.  For TDbCronModule, this also shows the
	 * database tasks as well.
	 * @param TCronModule $module the module servicing the action
	 * @param mixed $args
	 */
	public function actionTasks($args)

The parameter $args is not used and could be removed.

	{
		$module = $this->getCronModule();
		
		$this->_outWriter->writeLine("\nLast cron run was " . date('Y-m-d H:i:s', $module->getLastCronTime()) . "");
		$this->_outWriter->writeLine("The system time is " . date('Y-m-d H:i:s') . "\n");
		$tasks = $module->getTasks();

The method getTasks() does not exist on Prado\TModule. Since you implemented __call, consider adding a @method annotation.

		
		$this->_outWriter->writeLine("  Application Cron Tasks: ", [TShellWriter::BOLD]);
		if (!count($tasks)) {
			$this->_outWriter->writeLine("     **  There are no configured Cron Tasks.  **\n");
			return true;
		}
		$rows = [];
		foreach ($tasks as $task) {
			$f = 'H:i:s';
			if (time() - $task->getLastExecTime() > 86400) {
				$f = 'Y-m-d H:i:s';
			}
			$lastrun = date($f, $task->getLastExecTime());
			
			$f = 'H:i:s';
			$trigger = $task->getNextTriggerTime();
			if ($trigger - time() > 86400) {
				$f = 'Y-m-d H:i:s';
			}
			
			if (($user = $task->getUserName()) == null) {
				$user = $module->getDefaultUserName();

The method getDefaultUserName() does not exist on Prado\TModule. Since you implemented __call, consider adding a @method annotation.

			}
			$nextrun = date($f, $trigger) . ($task->getIsPending() ? '*' : '');
			if ($task->getIsPending()) {
				$nextrun = $this->_outWriter->format($nextrun, [TShellWriter::GREEN, TShellWriter::BOLD]);
			}
			
			$rows[] = [$task->getName(), $task->getSchedule(), $task->getTask(), $lastrun, $nextrun, '@' . $user, $task->getProcessCount()];
		}
		$this->_outWriter->write($this->_outWriter->tableWidget(['headers' => ['Name', 'Schedule', 'Task', 'Last Run', 'Next Run', 'User', 'Run #'],
			'rows' => $rows]));
		$this->_outWriter->writeLine("\nAny 'next run' with a * means it is Pending\n");
		
		return true;
	}
	
	/**
	 * shows the registered tasks from the application for possible configuration
	 * or addition to TDbCronModule.
	 * @param TCronModule $module the module servicing the action
	 * @param mixed $args
	 */
	public function actionIndex($args)

The parameter $args is not used and could be removed.

	{
		$module = $this->getCronModule();
		
		$infos = $module->getTaskInfos(true);

The method getTaskInfos() does not exist on Prado\TModule. Since you implemented __call, consider adding a @method annotation.

		$this->_outWriter->writeLine();
		$this->_outWriter->writeLine("  Registered Cron Task Information: ", [TShellWriter::BOLD]);
		if (!count($infos)) {
			$this->_outWriter->writeLine("		(** No registered application tasks **)");
			return true;
		}
		$rows = [];
		foreach ($infos as $taskinfo) {
			$rows[] = [
					$this->_outWriter->format($taskinfo->getName(), [TShellWriter::BLUE, TShellWriter::BOLD]),
					$taskinfo->getTask(), $taskinfo->getModuleId(), $taskinfo->getTitle()
				];
			$rows[] = ['span' => $this->_outWriter->format('      ' . $taskinfo->getDescription(), TShellWriter::DARK_GRAY)];
		}
		$this->_outWriter->write($this->_outWriter->tableWidget(['headers' => ['Task ID', 'Task', 'Module ID', 'Title'],
			'rows' => $rows]));
		$this->_outWriter->writeLine();
		return true;
	}
}