Prado\Util\Cron\TDbCronCleanLogTask

Complexity

Total Complexity

10

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	execute()	0	16	8
A	setTimePeriod()	0	3	1
A	getTimePeriod()	0	3	1

<?php

/**
 * TDbCronCleanLogTask 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\Shell\TShellWriter;
use Prado\TPropertyValue;
use Prado\Exceptions\TInvalidDataValueException;
use Prado\Util\Cron\TCronModule;

/**
 * TDbCronCleanLogTask class.
 *
 * TDbCronCleanLogTask Cleans the cron log of old entries older than the
 * age of {@link getTimePeriod} seconds.
 *
 * @author Brad Anderson <belisoful@icloud.com>
 * @package Prado\Util\Cron
 * @since 4.2.0
 */
class TDbCronCleanLogTask extends TCronTask
{
	/**
	 * @var int the time period in seconds of valid log items, default 28 days.
	 */
	private $_timeperiod = 2419200; //86400 seconds/day * 28 days
	
	/**
	 * This clears the log of the TDBCronModule specified by the ModuleId,
	 * or if none specified, then the cron executing this task.
	 * @param Prado\Util\Cron\TDbCronModule $cron

The type Prado\Util\Cron\Prado\Util\Cron\TDbCronModule was not found. Did you mean Prado\Util\Cron\TDbCronModule? If so, make sure to prefix the type with \.

	 */
	public function execute($cron)
	{
		if ($mid = $this->getModuleId()) {
			$cron = $this->getApplication()->getModule($mid);
			if ($cron === null) {
				throw new TInvalidDataValueException('dbcronclean_moduleid_is_null', $mid);
			}
		}
		if (is_object($cron) && $cron->isa('Prado\\Util\\Cron\\TDbCronModule')) {

The method isa() does not exist on Prado\IModule. It seems like you code against a sub-type of said class. However, the method does not exist in Prado\Util\IDbModule or Prado\Util\IPluginModule. Are you sure you never get one of those?

			$count = $cron->clearCronLog($this->getTimePeriod());

The method clearCronLog() does not exist on Prado\IModule. It seems like you code against a sub-type of said class. However, the method does not exist in Prado\Util\IDbModule or Prado\Util\IPluginModule. Are you sure you never get one of those?

			
			if ($cron->asa(TCronModule::SHELL_LOG_BEHAVIOR)) {

The method asa() does not exist on Prado\IModule. It seems like you code against a sub-type of said class. However, the method does not exist in Prado\Util\IDbModule or Prado\Util\IPluginModule. Are you sure you never get one of those?

				$cron->getOutputWriter()->writeLine("Cleared {$count} Cron Task Logs", TShellWriter::GREEN);

The method getOutputWriter() does not exist on Prado\IModule. It seems like you code against a sub-type of said class. However, the method does not exist in Prado\Util\IDbModule or Prado\Util\IPluginModule. Are you sure you never get one of those?

			}
		} elseif (is_object($cron) && $cron->asa(TCronModule::SHELL_LOG_BEHAVIOR)) {
			$cron->getOutputWriter()->writeLine("No DB Cron Module to clean", TShellWriter::RED);
		}
	}
	
	/**
	 * @return int number of seconds, before which cron logs are to be deleted
	 */
	public function getTimePeriod()
	{
		return $this->_timeperiod;
	}
	
	/**
	 *
	 * @param int $timeperiod number of seconds, before which cron logs are to be deleted
	 */
	public function setTimePeriod($timeperiod)
	{
		$this->_timeperiod = TPropertyValue::ensureInteger($timeperiod);
	}
}