TShellDbCronAction::addTask() - Code Metrics - Inspection of "#783 Shell modernization for Composer, Cron Shell..." - pradosoft/prado - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5fd064...896ccb )

by Fabio

created 2021-07-18 08:07 UTC

TShellDbCronAction::addTask() B

↳ Parent: TShellDbCronAction

Complexity

Conditions	11
Paths	19

Size

Total Lines	62
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	11
eloc	46
c	1
b	0
f	0
nc	19
nop	2
dl	0
loc	62
rs	7.3166

How to fix Long Method Complexity

<?php

/**
 * TShellDbCronAction class file.
 *
 * @author Brad Anderson <[email protected]>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */
 
namespace Prado\Util\Cron;

use Prado\Exceptions\TInvalidDataValueException;
use Prado\Exceptions\TApplicationException;
use Prado\Prado;
use Prado\Shell\TShellAppAction;
filter:
    dependency_paths: ["lib/*"]
use Prado\Shell\TShellWriter;

/**
 * TShellDbCronAction class.
 *
 * TShellDbCronAction extends {@link TShellCronAction} to implement
 * additional commands {@link addTask add}, {@link updateTask update},
 * and {@link removeTask}.
 *
 * @author Brad Anderson <[email protected]>
 * @package Prado\Util\Cron
 * @since 4.2.0
 */
class TShellDbCronAction extends TShellCronAction
{
	protected $methods = ['run', 'tasks', 'index', 'add', 'update', 'remove'];
	protected $parameters = [null, null, null, ['task-name', 'task-id', 'schedule'], ['task-name'], ['task-name']];
	protected $optional = [null, null, null, ['parameters...'], ['parameters...'], []];
	protected $description = ['Manages DbCron time-based services',
		'Runs the DbCron Pending Tasks.',
		'Displays the Cron tasks configured in the application and database.',
		'Displays the registered Cron tasks information.',
		'Adds a Cron task to the database.',
		'Updates a Cron task in the database.',
		'Removes a Cron task from the database.'
	];
	
	/**
	 * Overrides parent getModuleClass to return the TDbCronModule class.
	 * @return string the DbCron Class to find
	 */
	public function getModuleClass()
	{
		return 'Prado\\Util\\Cron\\TDbCronModule';
	}
	
	/**
	 * adds a task to the database with its name, task id, schedule, and other properties.
	 * @param array $args command arguments
	 */
	public function actionAdd($args)
	{
		$module = $this->getCronModule();
		$taskName = $args[1] ?? null;
		$id = $args[2] ?? null;
		$schedule = $args[3] ?? null;
		
		if (!$taskName) {
			$this->_outWriter->writeError("Cannot add a task without a name");
			return true;
		}
		if (!$id) {
			$this->_outWriter->writeError("Cannot add a task without a task id");
			return true;
		}
		if (!$schedule) {
			$this->_outWriter->writeError("Cannot add a task without a schedule");
			return true;
		}
		
		$exists = $module->taskExists($taskName);
  $exists = $module->taskExists($taskName);
		if ($exists) {
			$this->_outWriter->writeError("'{$taskName}' already exists in the database");
			return true;
		}
		$infos = $module->getTaskInfos();
  $infos = $module->getTaskInfos();
		$info = null;
		foreach ($infos as $i) {
			if ($i->getName() == $id) {
				$info = $i;
				break;
			}
		}
		if (!$info) {
			$this->_outWriter->writeError("Task ID '{$id}' could not be found");
			return true;
		}
		$s = new TTimeScheduler();
		try {
			$s->setSchedule($schedule);
		} catch (TInvalidDataValueException $e) {
			$this->_outWriter->writeError("Schedule '{$schedule}' is not a valid schedule");
			return true;
		}
		
		$task = $module->instanceTask($info->getTask());
  $task = $module->instanceTask($info->getTask());
		$task->setName($taskName);
		$task->setSchedule($schedule);
		for ($i = 4; $i < count($args); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
			$parts = explode('=', $args[$i]);
			$parts[0] = trim($parts[0]);
			$property = strtolower($parts[0]);
			if ($task->canSetProperty($property)) {
				$property = 'set' . $property;
				$task->$property(trim($parts[1]));
			} else {
				$this->_outWriter->writeError("Task Property '{$parts[0]}' is not found");
				return true;
			}
		}
		$module->addTask($task);
           addTask($task);
		
		$this->_outWriter->writeLine("Task '{$taskName}' was added to the database\n", [TShellWriter::GREEN, TShellWriter::BOLD]);
		return true;
	}
	
	/**
	 * updates a task in the database by its name for its schedule, username, moduleid, and other properties.
	 * @param array $args command arguments
	 */
	public function actionUpdate($args)
	{
		$module = $this->getCronModule();
		if (!($taskName = ($args[1] ?? null))) {
			$this->_outWriter->writeError("Cannot update a task without a name");
			return true;
		}
		
		$task = $module->getTask($taskName);
  $task = $module->getTask($taskName);
		if (!$task) {
			$this->_outWriter->writeError("Task '{$taskName}' is not found");
			return true;
		}
		if (count($args) < 3) {
			$this->_outWriter->writeError("No given properties to change");
			return true;
		}
		for ($i = 2; $i < count($args); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
			$parts = explode('=', $args[$i]);
			$parts[0] = trim($parts[0]);
			$property = strtolower($parts[0]);
			if ($task->canSetProperty($property)) {
				if ($property === 'schedule') {
					$s = new TTimeScheduler();
					try {
						$s->setSchedule($parts[1]);
					} catch (TInvalidDataValueException $e) {
						$this->_outWriter->writeError("Schedule '{$parts[1]}' is not a valid schedule");
						return true;
					}
				}
				$property = 'set' . $property;
				$task->$property(trim($parts[1]));
			} else {
				$this->_outWriter->writeError("Task Property '{$parts[0]}' is not found");
				return true;
			}
		}
		$module->updateTask($task);
           updateTask($task);
		$this->_outWriter->writeLine("Task '{$taskName}' was updated in the database\n", [TShellWriter::GREEN, TShellWriter::BOLD]);
		return true;
	}
	
	/**
	 * removes a task in the database by its name.
	 * @param array $args command arguments
	 */
	public function actionRemove($args)
	{
		$module = $this->getCronModule();
		if (!($taskName = $args[1] ?? null)) {
			$this->_outWriter->writeError("Cannot remove a task without a name");
			return true;
		}
		$exists = $module->taskExists($taskName);
		if (!$exists) {
			$this->_outWriter->writeError("'{$taskName}' does not exist in the database");
			return true;
		}
		$result = $module->removeTask($taskName);
  $result = $module->removeTask($taskName);
		
		if ($result) {
			$this->_outWriter->writeLine("'{$taskName}' was successfully removed.\n", [TShellWriter::GREEN, TShellWriter::BOLD]);
		} else {
			$this->_outWriter->writeError("'{$taskName}' could not be removed.\n");
		}
		return true;
	}
}


pradosoft / prado

Push — master ( 5fd064...896ccb )

TShellDbCronAction::addTask() B

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like