Oefenweb / cakephp-queue

src/Queue/Config.php

Indentation +56 added lines, -56 removed lines

@@ -6,66 +6,66 @@
 class Config
 {
 
-    /**
-     *
-     * @return int
-     */
-    public static function defaultWorkerTimeout()
-    {
-        return Configure::read('Queue.defaultWorkerTimeout', 600); // 10min
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function defaultWorkerTimeout()
+	{
+		return Configure::read('Queue.defaultWorkerTimeout', 600); // 10min
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function workerMaxRuntime()
-    {
-        return Configure::read('Queue.workerMaxRuntime', 120);
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function workerMaxRuntime()
+	{
+		return Configure::read('Queue.workerMaxRuntime', 120);
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function cleanupTimeout()
-    {
-        return Configure::read('Queue.cleanupTimeout', 2592000); // 30 days
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function cleanupTimeout()
+	{
+		return Configure::read('Queue.cleanupTimeout', 2592000); // 30 days
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function sleepTime()
-    {
-        return Configure::read('Queue.sleepTime', 10);
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function sleepTime()
+	{
+		return Configure::read('Queue.sleepTime', 10);
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function gcprob()
-    {
-        return Configure::read('Queue.gcprob', 10);
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function gcprob()
+	{
+		return Configure::read('Queue.gcprob', 10);
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function defaultWorkerRetries()
-    {
-        return Configure::read('Queue.defaultWorkerRetries', 1);
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function defaultWorkerRetries()
+	{
+		return Configure::read('Queue.defaultWorkerRetries', 1);
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function maxWorkers()
-    {
-        return Configure::read('Queue.maxWorkers', 1);
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function maxWorkers()
+	{
+		return Configure::read('Queue.maxWorkers', 1);
+	}
 }

src/Shell/Task/AddInterface.php

Indentation +8 added lines, -8 removed lines

@@ -10,12 +10,12 @@
 interface AddInterface
 {
 
-    /**
-     * Allows adding a task to the queue.
-     *
-     * Will create one example task in the queue, which later will be executed using run().
-     *
-     * @return void
-     */
-    public function add(): void;
+	/**
+	 * Allows adding a task to the queue.
+	 *
+	 * Will create one example task in the queue, which later will be executed using run().
+	 *
+	 * @return void
+	 */
+	public function add(): void;
 }

src/Model/Entity/QueuedTask.php

Indentation +17 added lines, -17 removed lines

@@ -20,21 +20,21 @@
 class QueuedTask extends Entity
 {
 
-    /**
-     *
-     * {@inheritdoc}
-     *
-     * @var array
-     */
-    protected $_accessible = [
-        'task' => true,
-        'data' => true,
-        'not_before' => true,
-        'fetched' => true,
-        'completed' => true,
-        'failed_count' => true,
-        'failure_message' => true,
-        'worker_key' => true,
-        'created' => true
-    ];
+	/**
+	 *
+	 * {@inheritdoc}
+	 *
+	 * @var array
+	 */
+	protected $_accessible = [
+		'task' => true,
+		'data' => true,
+		'not_before' => true,
+		'fetched' => true,
+		'completed' => true,
+		'failed_count' => true,
+		'failure_message' => true,
+		'worker_key' => true,
+		'created' => true
+	];
 }

tests/Fixture/QueuedTasksFixture.php

Indentation +42 added lines, -42 removed lines

@@ -8,47 +8,47 @@
  */
 class QueuedTasksFixture extends TestFixture
 {
-    /**
-     * Fields
-     *
-     * @var array
-     */
-    // @codingStandardsIgnoreStart
-    public $fields = [
-        'id' => ['type' => 'integer', 'length' => 10, 'unsigned' => true, 'null' => false, 'default' => null, 'comment' => '', 'autoIncrement' => true, 'precision' => null],
-        'task' => ['type' => 'string', 'length' => 255, 'null' => false, 'default' => null, 'collate' => 'utf8_general_ci', 'comment' => '', 'precision' => null, 'fixed' => null],
-        'data' => ['type' => 'text', 'length' => 16777215, 'null' => true, 'default' => null, 'collate' => 'utf8_general_ci', 'comment' => '', 'precision' => null],
-        'not_before' => ['type' => 'timestamp', 'length' => null, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
-        'fetched' => ['type' => 'timestamp', 'length' => null, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
-        'completed' => ['type' => 'timestamp', 'length' => null, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
-        'failed_count' => ['type' => 'integer', 'length' => 10, 'unsigned' => true, 'null' => false, 'default' => '0', 'comment' => '', 'precision' => null, 'autoIncrement' => null],
-        'failure_message' => ['type' => 'text', 'length' => null, 'null' => true, 'default' => null, 'collate' => 'utf8_general_ci', 'comment' => '', 'precision' => null],
-        'worker_key' => ['type' => 'string', 'fixed' => true, 'length' => 40, 'null' => true, 'default' => null, 'collate' => 'utf8_general_ci', 'comment' => '', 'precision' => null],
-        'created' => ['type' => 'timestamp', 'length' => null, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
-        '_indexes' => [
-            'completed' => ['type' => 'index', 'columns' => ['completed'], 'length' => []],
-            'worker_key' => ['type' => 'index', 'columns' => ['worker_key'], 'length' => []],
-            'task' => ['type' => 'index', 'columns' => ['task'], 'length' => []],
-        ],
-        '_constraints' => [
-            'primary' => ['type' => 'primary', 'columns' => ['id'], 'length' => []],
-        ],
-        '_options' => [
-            'engine' => 'InnoDB',
-            'collation' => 'utf8_general_ci'
-        ],
-    ];
-    // @codingStandardsIgnoreEnd
+	/**
+	 * Fields
+	 *
+	 * @var array
+	 */
+	// @codingStandardsIgnoreStart
+	public $fields = [
+		'id' => ['type' => 'integer', 'length' => 10, 'unsigned' => true, 'null' => false, 'default' => null, 'comment' => '', 'autoIncrement' => true, 'precision' => null],
+		'task' => ['type' => 'string', 'length' => 255, 'null' => false, 'default' => null, 'collate' => 'utf8_general_ci', 'comment' => '', 'precision' => null, 'fixed' => null],
+		'data' => ['type' => 'text', 'length' => 16777215, 'null' => true, 'default' => null, 'collate' => 'utf8_general_ci', 'comment' => '', 'precision' => null],
+		'not_before' => ['type' => 'timestamp', 'length' => null, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
+		'fetched' => ['type' => 'timestamp', 'length' => null, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
+		'completed' => ['type' => 'timestamp', 'length' => null, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
+		'failed_count' => ['type' => 'integer', 'length' => 10, 'unsigned' => true, 'null' => false, 'default' => '0', 'comment' => '', 'precision' => null, 'autoIncrement' => null],
+		'failure_message' => ['type' => 'text', 'length' => null, 'null' => true, 'default' => null, 'collate' => 'utf8_general_ci', 'comment' => '', 'precision' => null],
+		'worker_key' => ['type' => 'string', 'fixed' => true, 'length' => 40, 'null' => true, 'default' => null, 'collate' => 'utf8_general_ci', 'comment' => '', 'precision' => null],
+		'created' => ['type' => 'timestamp', 'length' => null, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
+		'_indexes' => [
+			'completed' => ['type' => 'index', 'columns' => ['completed'], 'length' => []],
+			'worker_key' => ['type' => 'index', 'columns' => ['worker_key'], 'length' => []],
+			'task' => ['type' => 'index', 'columns' => ['task'], 'length' => []],
+		],
+		'_constraints' => [
+			'primary' => ['type' => 'primary', 'columns' => ['id'], 'length' => []],
+		],
+		'_options' => [
+			'engine' => 'InnoDB',
+			'collation' => 'utf8_general_ci'
+		],
+	];
+	// @codingStandardsIgnoreEnd
     
-    /**
-     * Init method
-     *
-     * @return void
-     */
-    public function init()
-    {
-        $this->records = [
-        ];
-        parent::init();
-    }
+	/**
+	 * Init method
+	 *
+	 * @return void
+	 */
+	public function init()
+	{
+		$this->records = [
+		];
+		parent::init();
+	}
 }

tests/config/app_queue.php

Indentation +10 added lines, -10 removed lines

@@ -1,18 +1,18 @@
 <?php
 
 return [
-    'Queue' => [
-        // time (in seconds) after which a job is requeued if the worker doesn't report back
-        'defaultWorkerTimeout' => 1800,
+	'Queue' => [
+		// time (in seconds) after which a job is requeued if the worker doesn't report back
+		'defaultWorkerTimeout' => 1800,
 
-        // seconds of running time after which the worker will terminate (0 = unlimited)
-        'workerMaxRuntime' => 120,
+		// seconds of running time after which the worker will terminate (0 = unlimited)
+		'workerMaxRuntime' => 120,
 
-        // minimum time (in seconds) which a task remains in the database before being cleaned up.
-        'cleanupTimeout' => 2592000, // 30 days
+		// minimum time (in seconds) which a task remains in the database before being cleaned up.
+		'cleanupTimeout' => 2592000, // 30 days
 
-        /* Optional */
+		/* Optional */
 
-        'isSearchEnabled' => true,
-    ],
+		'isSearchEnabled' => true,
+	],
 ];

src/Queue/TaskFinder.php

Indentation +68 added lines, -68 removed lines

@@ -8,80 +8,80 @@
 class TaskFinder
 {
 
-    /**
-     *
-     * @var array|null
-     */
-    protected $tasks;
+	/**
+	 *
+	 * @var array|null
+	 */
+	protected $tasks;
 
-    /**
-     * Returns all possible Queue tasks.
-     *
-     * Makes sure that app tasks are prioritized over plugin ones.
-     *
-     * @return array
-     */
-    public function allAppAndPluginTasks()
-    {
-        if ($this->tasks !== null) {
-            return $this->tasks;
-        }
+	/**
+	 * Returns all possible Queue tasks.
+	 *
+	 * Makes sure that app tasks are prioritized over plugin ones.
+	 *
+	 * @return array
+	 */
+	public function allAppAndPluginTasks()
+	{
+		if ($this->tasks !== null) {
+			return $this->tasks;
+		}
 
-        $paths = App::path('Shell/Task');
-        $this->tasks = [];
+		$paths = App::path('Shell/Task');
+		$this->tasks = [];
 
-        foreach ($paths as $path) {
-            $Folder = new Folder($path);
-            $this->tasks = $this->getAppPaths($Folder);
-        }
-        $plugins = Plugin::loaded();
-        foreach ($plugins as $plugin) {
-            $pluginPaths = App::path('Shell/Task', $plugin);
-            foreach ($pluginPaths as $pluginPath) {
-                $Folder = new Folder($pluginPath);
-                $pluginTasks = $this->getPluginPaths($Folder, $plugin);
-                $this->tasks = array_merge($this->tasks, $pluginTasks);
-            }
-        }
+		foreach ($paths as $path) {
+			$Folder = new Folder($path);
+			$this->tasks = $this->getAppPaths($Folder);
+		}
+		$plugins = Plugin::loaded();
+		foreach ($plugins as $plugin) {
+			$pluginPaths = App::path('Shell/Task', $plugin);
+			foreach ($pluginPaths as $pluginPath) {
+				$Folder = new Folder($pluginPath);
+				$pluginTasks = $this->getPluginPaths($Folder, $plugin);
+				$this->tasks = array_merge($this->tasks, $pluginTasks);
+			}
+		}
 
-        return $this->tasks;
-    }
+		return $this->tasks;
+	}
 
-    /**
-     *
-     * @param \Cake\Filesystem\Folder $Folder The directory
-     *
-     * @return array
-     */
-    protected function getAppPaths(Folder $Folder)
-    {
-        $res = array_merge($this->tasks, $Folder->find('Queue.+\.php'));
-        foreach ($res as &$r) {
-            $r = basename($r, 'Task.php');
-        }
+	/**
+	 *
+	 * @param \Cake\Filesystem\Folder $Folder The directory
+	 *
+	 * @return array
+	 */
+	protected function getAppPaths(Folder $Folder)
+	{
+		$res = array_merge($this->tasks, $Folder->find('Queue.+\.php'));
+		foreach ($res as &$r) {
+			$r = basename($r, 'Task.php');
+		}
 
-        return $res;
-    }
+		return $res;
+	}
 
-    /**
-     *
-     * @param \Cake\Filesystem\Folder $Folder The directory
-     * @param string $plugin The plugin name
-     *
-     * @return array
-     */
-    protected function getPluginPaths(Folder $Folder, $plugin)
-    {
-        $res = $Folder->find('Queue.+Task\.php');
-        foreach ($res as $key => $r) {
-            $name = basename($r, 'Task.php');
-            if (in_array($name, $this->tasks)) {
-                unset($res[$key]);
-                continue;
-            }
-            $res[$key] = $plugin . '.' . $name;
-        }
+	/**
+	 *
+	 * @param \Cake\Filesystem\Folder $Folder The directory
+	 * @param string $plugin The plugin name
+	 *
+	 * @return array
+	 */
+	protected function getPluginPaths(Folder $Folder, $plugin)
+	{
+		$res = $Folder->find('Queue.+Task\.php');
+		foreach ($res as $key => $r) {
+			$name = basename($r, 'Task.php');
+			if (in_array($name, $this->tasks)) {
+				unset($res[$key]);
+				continue;
+			}
+			$res[$key] = $plugin . '.' . $name;
+		}
 
-        return $res;
-    }
+		return $res;
+	}
 }

src/Shell/QueueShell.php

Indentation +555 added lines, -555 removed lines

@@ -30,570 +30,570 @@
 class QueueShell extends Shell
 {
 
-    /**
-     *
-     * @var string
-     */
-    public $modelClass = 'Queue.QueuedTasks';
-
-    /**
-     *
-     * @var array|null
-     */
-    protected $_taskConf;
-
-    /**
-     *
-     * @var int
-     */
-    protected $_time = 0;
-
-    /**
-     *
-     * @var bool
-     */
-    protected $_exit = false;
-
-    /**
-     * Overwrite shell initialize to dynamically load all Queue Related Tasks.
-     *
-     * @return void
-     */
-    public function initialize()
-    {
-        $taskFinder = new TaskFinder();
-        $this->tasks = $taskFinder->allAppAndPluginTasks();
-
-        parent::initialize();
-    }
-
-    /**
-     *
-     * @return void
-     */
-    public function startup()
-    {
-        if ($this->param('quiet')) {
-            $this->interactive = false;
-        }
-
-        parent::startup();
-    }
-
-    /**
-     *
-     * @return string
-     */
-    public function _getDescription()
-    {
-        $tasks = [];
-        foreach ($this->taskNames as $loadedTask) {
-            $tasks[] = "\t" . '* ' . $this->_taskName($loadedTask);
-        }
-        $tasks = implode(PHP_EOL, $tasks);
-
-        $text = <<<TEXT
+	/**
+	 *
+	 * @var string
+	 */
+	public $modelClass = 'Queue.QueuedTasks';
+
+	/**
+	 *
+	 * @var array|null
+	 */
+	protected $_taskConf;
+
+	/**
+	 *
+	 * @var int
+	 */
+	protected $_time = 0;
+
+	/**
+	 *
+	 * @var bool
+	 */
+	protected $_exit = false;
+
+	/**
+	 * Overwrite shell initialize to dynamically load all Queue Related Tasks.
+	 *
+	 * @return void
+	 */
+	public function initialize()
+	{
+		$taskFinder = new TaskFinder();
+		$this->tasks = $taskFinder->allAppAndPluginTasks();
+
+		parent::initialize();
+	}
+
+	/**
+	 *
+	 * @return void
+	 */
+	public function startup()
+	{
+		if ($this->param('quiet')) {
+			$this->interactive = false;
+		}
+
+		parent::startup();
+	}
+
+	/**
+	 *
+	 * @return string
+	 */
+	public function _getDescription()
+	{
+		$tasks = [];
+		foreach ($this->taskNames as $loadedTask) {
+			$tasks[] = "\t" . '* ' . $this->_taskName($loadedTask);
+		}
+		$tasks = implode(PHP_EOL, $tasks);
+
+		$text = <<<TEXT
 Simple and minimalistic job queue (or deferred-task) system.
 
 Available Tasks:
 $tasks
 TEXT;
-        return $text;
-    }
-
-    /**
-     * Look for a Queue Task of hte passed name and try to call add() on it.
-     * A QueueTask may provide an add function to enable the user to create new jobs via commandline.
-     *
-     * @return void
-     */
-    public function add()
-    {
-        if (count($this->args) < 1) {
-            $this->out('Please call like this:');
-            $this->out('       bin/cake queue add <taskname>');
-            $this->_displayAvailableTasks();
-
-            return;
-        }
-
-        $name = Inflector::camelize($this->args[0]);
-        if (in_array('Queue' . $name, $this->taskNames, true)) {
-            /** @var \Queue\Shell\Task\QueueTask|\Queue\Shell\Task\AddInterface $task */
-            $task = $this->{'Queue' . $name};
-            if (!($task instanceof AddInterface)) {
-                $this->abort('This task does not support adding via CLI call');
-            }
-            $task->add();
-        } else {
-            $this->out('Error: Task not found: ' . $name);
-            $this->_displayAvailableTasks();
-        }
-    }
-
-    /**
-     * Output the task without Queue or Task
-     * example: QueueImageTask becomes Image on display
-     *
-     * @param string $task Task name
-     * @return string Cleaned task name
-     */
-    protected function _taskName($task)
-    {
-        if (strpos($task, 'Queue') === 0) {
-            return substr($task, 5);
-        }
-        return $task;
-    }
-
-    /**
-     * Run a QueueWorker loop.
-     * Runs a Queue Worker process which will try to find unassigned jobs in the queue
-     * which it may run and try to fetch and execute them.
-     *
-     * @return int|null
-     */
-    public function runworker()
-    {
-        try {
-            $pid = $this->_initPid();
-        } catch (PersistenceFailedException $exception) {
-            $this->err($exception->getMessage());
-            $limit = (int)Configure::read('Queue.maxWorkers');
-            if ($limit) {
-                $this->out('Cannot start worker: Too many workers already/still running on this server (' . $limit . '/' . $limit . ')');
-            }
-            return static::CODE_ERROR;
-        }
-
-        // Enable Garbage Collector (PHP >= 5.3)
-        if (function_exists('gc_enable')) {
-            gc_enable();
-        }
-        if (function_exists('pcntl_signal')) {
-            pcntl_signal(SIGTERM, [
-                &$this,
-                '_exit'
-            ]);
-            pcntl_signal(SIGINT, [
-                &$this,
-                '_exit'
-            ]);
-            pcntl_signal(SIGTSTP, [
-                &$this,
-                '_exit'
-            ]);
-            pcntl_signal(SIGQUIT, [
-                &$this,
-                '_exit'
-            ]);
-        }
-        $this->_exit = false;
-
-        $startTime = time();
-        $types = $this->_stringToArray($this->param('type'));
-
-        while (!$this->_exit) {
-            $this->out(__d('queue', 'Looking for a job.'), 1, Shell::VERBOSE);
-
-            $QueuedTask = $this->QueuedTasks->requestJob($this->_getTaskConf(), $types);
-
-            if ($QueuedTask) {
-                $this->runJob($QueuedTask, $pid);
-            } elseif (Configure::read('Queue.exitWhenNothingToDo')) {
-                $this->out('nothing to do, exiting.');
-                $this->_exit = true;
-            } else {
-                $this->out('nothing to do, sleeping.');
-                sleep(Config::sleepTime());
-            }
-
-            // check if we are over the maximum runtime and end processing if so.
-            if (Configure::readOrFail('Queue.workerMaxRuntime') && (time() - $startTime) >= Configure::readOrFail('Queue.workerMaxRuntime')) {
-                $this->_exit = true;
-                $this->out('queue', 'Reached runtime of ' . (time() - $startTime) . ' Seconds (Max ' . Configure::readOrFail('Queue.workerMaxRuntime') . '), terminating.');
-            }
-            if ($this->_exit || mt_rand(0, 100) > (100 - (int)Config::gcprob())) {
-                $this->out(__d('queue', 'Performing old job cleanup.'));
-                $this->QueuedTasks->cleanOldJobs();
-            }
-            $this->hr();
-        }
-
-        $this->_deletePid($pid);
-
-        if ($this->param('verbose')) {
-            $this->_log('endworker', $pid);
-        }
-    }
-
-    /**
-     *
-     * @param \Queue\Model\Entity\QueuedTask $QueuedTask
-     * @param string $pid
-     * @return void
-     */
-    protected function runJob(QueuedTask $QueuedTask, $pid)
-    {
-        $this->out('Running Job of type "' . $QueuedTask->task . '"');
-        $this->_log('job ' . $QueuedTask->task . ', id ' . $QueuedTask->id, $pid, false);
-        $taskName = 'Queue' . $QueuedTask->task;
-
-        try {
-            $this->_time = time();
-
-            $data = unserialize($QueuedTask->data);
-            /** @var \Queue\Shell\Task\QueueTask $task */
-            $task = $this->{$taskName};
-            if (!$task instanceof QueueTaskInterface) {
-                throw new RuntimeException('Task must implement ' . QueueTaskInterface::class);
-            }
-
-            $return = $task->run((array)$data, $QueuedTask->id);
-            if ($return !== null) {
-                trigger_error('run() should be void and throw exception in error case now.', E_USER_DEPRECATED);
-            }
-            $failureMessage = $taskName . ' failed';
-        } catch (Throwable $e) {
-            $return = false;
-
-            $failureMessage = get_class($e) . ': ' . $e->getMessage();
-            if (!($e instanceof QueueException)) {
-                $failureMessage .= "\n" . $e->getTraceAsString();
-            }
-
-            $this->_logError($taskName . ' (job ' . $QueuedTask->id . ')' . "\n" . $failureMessage, $pid);
-        } catch (Exception $e) {
-            $return = false;
-
-            $failureMessage = get_class($e) . ': ' . $e->getMessage();
-            $this->_logError($taskName . "\n" . $failureMessage, $pid);
-        }
-
-        if ($return === false) {
-            $this->QueuedTasks->markJobFailed($QueuedTask, $failureMessage);
-            $failedStatus = $this->QueuedTasks->getFailedStatus($QueuedTask, $this->_getTaskConf());
-            $this->_log('job ' . $QueuedTask->task . ', id ' . $QueuedTask->id . ' failed and ' . $failedStatus, $pid);
-            $this->out('Job did not finish, ' . $failedStatus . ' after try ' . $QueuedTask->failed . '.');
-            return;
-        }
-
-        $this->QueuedTasks->markJobDone($QueuedTask);
-        $this->out('Job Finished.');
-    }
-
-    /**
-     * Manually trigger a Finished job cleanup.
-     *
-     * @return void
-     */
-    public function clean()
-    {
-        if (!Configure::read('Queue.cleanupTimeout')) {
-            $this->abort('You disabled cleanuptimout in config. Aborting.');
-        }
-
-        $this->out('Deleting old jobs, that have finished before ' . date('Y-m-d H:i:s', time() - (int)Configure::read('Queue.cleanupTimeout')));
-        $this->QueuedTasks->cleanOldJobs();
-    }
-
-    /**
-     * Display current settings
-     *
-     * @return void
-     */
-    public function settings()
-    {
-        $this->out('Current Settings:');
-        $conf = (array)Configure::read('Queue');
-        foreach ($conf as $key => $val) {
-            if ($val === false) {
-                $val = 'no';
-            }
-            if ($val === true) {
-                $val = 'yes';
-            }
-            $this->out('* ' . $key . ': ' . print_r($val, true));
-        }
-
-        $this->out();
-    }
-
-    /**
-     * Display some statistics about Finished Jobs.
-     *
-     * @return void
-     */
-    public function stats()
-    {
-        $this->out('Jobs currently in the queue:');
-
-        $types = $this->QueuedTasks->getTypes()->toArray();
-        foreach ($types as $type) {
-            $this->out('      ' . str_pad($type, 20, ' ', STR_PAD_RIGHT) . ': ' . $this->QueuedTasks->getLength($type));
-        }
-        $this->hr();
-        $this->out('Total unfinished jobs: ' . $this->QueuedTasks->getLength());
-        $this->hr();
-        $this->out('Finished job statistics:');
-        $data = $this->QueuedTasks->getStats();
-        foreach ($data as $item) {
-            $this->out(' ' . $item['task'] . ': ');
-            $this->out('   Finished Jobs in Database: ' . $item['num']);
-            $this->out('   Average Job existence    : ' . str_pad(Number::precision($item['alltime']), 8, ' ', STR_PAD_LEFT) . 's');
-            $this->out('   Average Execution delay  : ' . str_pad(Number::precision($item['fetchdelay']), 8, ' ', STR_PAD_LEFT) . 's');
-            $this->out('   Average Execution time   : ' . str_pad(Number::precision($item['runtime']), 8, ' ', STR_PAD_LEFT) . 's');
-        }
-    }
-
-    /**
-     * Get option parser method to parse commandline options
-     *
-     * @return \Cake\Console\ConsoleOptionParser
-     */
-    public function getOptionParser()
-    {
-        $subcommandParser = [
-            'options' => [ /*
+		return $text;
+	}
+
+	/**
+	 * Look for a Queue Task of hte passed name and try to call add() on it.
+	 * A QueueTask may provide an add function to enable the user to create new jobs via commandline.
+	 *
+	 * @return void
+	 */
+	public function add()
+	{
+		if (count($this->args) < 1) {
+			$this->out('Please call like this:');
+			$this->out('       bin/cake queue add <taskname>');
+			$this->_displayAvailableTasks();
+
+			return;
+		}
+
+		$name = Inflector::camelize($this->args[0]);
+		if (in_array('Queue' . $name, $this->taskNames, true)) {
+			/** @var \Queue\Shell\Task\QueueTask|\Queue\Shell\Task\AddInterface $task */
+			$task = $this->{'Queue' . $name};
+			if (!($task instanceof AddInterface)) {
+				$this->abort('This task does not support adding via CLI call');
+			}
+			$task->add();
+		} else {
+			$this->out('Error: Task not found: ' . $name);
+			$this->_displayAvailableTasks();
+		}
+	}
+
+	/**
+	 * Output the task without Queue or Task
+	 * example: QueueImageTask becomes Image on display
+	 *
+	 * @param string $task Task name
+	 * @return string Cleaned task name
+	 */
+	protected function _taskName($task)
+	{
+		if (strpos($task, 'Queue') === 0) {
+			return substr($task, 5);
+		}
+		return $task;
+	}
+
+	/**
+	 * Run a QueueWorker loop.
+	 * Runs a Queue Worker process which will try to find unassigned jobs in the queue
+	 * which it may run and try to fetch and execute them.
+	 *
+	 * @return int|null
+	 */
+	public function runworker()
+	{
+		try {
+			$pid = $this->_initPid();
+		} catch (PersistenceFailedException $exception) {
+			$this->err($exception->getMessage());
+			$limit = (int)Configure::read('Queue.maxWorkers');
+			if ($limit) {
+				$this->out('Cannot start worker: Too many workers already/still running on this server (' . $limit . '/' . $limit . ')');
+			}
+			return static::CODE_ERROR;
+		}
+
+		// Enable Garbage Collector (PHP >= 5.3)
+		if (function_exists('gc_enable')) {
+			gc_enable();
+		}
+		if (function_exists('pcntl_signal')) {
+			pcntl_signal(SIGTERM, [
+				&$this,
+				'_exit'
+			]);
+			pcntl_signal(SIGINT, [
+				&$this,
+				'_exit'
+			]);
+			pcntl_signal(SIGTSTP, [
+				&$this,
+				'_exit'
+			]);
+			pcntl_signal(SIGQUIT, [
+				&$this,
+				'_exit'
+			]);
+		}
+		$this->_exit = false;
+
+		$startTime = time();
+		$types = $this->_stringToArray($this->param('type'));
+
+		while (!$this->_exit) {
+			$this->out(__d('queue', 'Looking for a job.'), 1, Shell::VERBOSE);
+
+			$QueuedTask = $this->QueuedTasks->requestJob($this->_getTaskConf(), $types);
+
+			if ($QueuedTask) {
+				$this->runJob($QueuedTask, $pid);
+			} elseif (Configure::read('Queue.exitWhenNothingToDo')) {
+				$this->out('nothing to do, exiting.');
+				$this->_exit = true;
+			} else {
+				$this->out('nothing to do, sleeping.');
+				sleep(Config::sleepTime());
+			}
+
+			// check if we are over the maximum runtime and end processing if so.
+			if (Configure::readOrFail('Queue.workerMaxRuntime') && (time() - $startTime) >= Configure::readOrFail('Queue.workerMaxRuntime')) {
+				$this->_exit = true;
+				$this->out('queue', 'Reached runtime of ' . (time() - $startTime) . ' Seconds (Max ' . Configure::readOrFail('Queue.workerMaxRuntime') . '), terminating.');
+			}
+			if ($this->_exit || mt_rand(0, 100) > (100 - (int)Config::gcprob())) {
+				$this->out(__d('queue', 'Performing old job cleanup.'));
+				$this->QueuedTasks->cleanOldJobs();
+			}
+			$this->hr();
+		}
+
+		$this->_deletePid($pid);
+
+		if ($this->param('verbose')) {
+			$this->_log('endworker', $pid);
+		}
+	}
+
+	/**
+	 *
+	 * @param \Queue\Model\Entity\QueuedTask $QueuedTask
+	 * @param string $pid
+	 * @return void
+	 */
+	protected function runJob(QueuedTask $QueuedTask, $pid)
+	{
+		$this->out('Running Job of type "' . $QueuedTask->task . '"');
+		$this->_log('job ' . $QueuedTask->task . ', id ' . $QueuedTask->id, $pid, false);
+		$taskName = 'Queue' . $QueuedTask->task;
+
+		try {
+			$this->_time = time();
+
+			$data = unserialize($QueuedTask->data);
+			/** @var \Queue\Shell\Task\QueueTask $task */
+			$task = $this->{$taskName};
+			if (!$task instanceof QueueTaskInterface) {
+				throw new RuntimeException('Task must implement ' . QueueTaskInterface::class);
+			}
+
+			$return = $task->run((array)$data, $QueuedTask->id);
+			if ($return !== null) {
+				trigger_error('run() should be void and throw exception in error case now.', E_USER_DEPRECATED);
+			}
+			$failureMessage = $taskName . ' failed';
+		} catch (Throwable $e) {
+			$return = false;
+
+			$failureMessage = get_class($e) . ': ' . $e->getMessage();
+			if (!($e instanceof QueueException)) {
+				$failureMessage .= "\n" . $e->getTraceAsString();
+			}
+
+			$this->_logError($taskName . ' (job ' . $QueuedTask->id . ')' . "\n" . $failureMessage, $pid);
+		} catch (Exception $e) {
+			$return = false;
+
+			$failureMessage = get_class($e) . ': ' . $e->getMessage();
+			$this->_logError($taskName . "\n" . $failureMessage, $pid);
+		}
+
+		if ($return === false) {
+			$this->QueuedTasks->markJobFailed($QueuedTask, $failureMessage);
+			$failedStatus = $this->QueuedTasks->getFailedStatus($QueuedTask, $this->_getTaskConf());
+			$this->_log('job ' . $QueuedTask->task . ', id ' . $QueuedTask->id . ' failed and ' . $failedStatus, $pid);
+			$this->out('Job did not finish, ' . $failedStatus . ' after try ' . $QueuedTask->failed . '.');
+			return;
+		}
+
+		$this->QueuedTasks->markJobDone($QueuedTask);
+		$this->out('Job Finished.');
+	}
+
+	/**
+	 * Manually trigger a Finished job cleanup.
+	 *
+	 * @return void
+	 */
+	public function clean()
+	{
+		if (!Configure::read('Queue.cleanupTimeout')) {
+			$this->abort('You disabled cleanuptimout in config. Aborting.');
+		}
+
+		$this->out('Deleting old jobs, that have finished before ' . date('Y-m-d H:i:s', time() - (int)Configure::read('Queue.cleanupTimeout')));
+		$this->QueuedTasks->cleanOldJobs();
+	}
+
+	/**
+	 * Display current settings
+	 *
+	 * @return void
+	 */
+	public function settings()
+	{
+		$this->out('Current Settings:');
+		$conf = (array)Configure::read('Queue');
+		foreach ($conf as $key => $val) {
+			if ($val === false) {
+				$val = 'no';
+			}
+			if ($val === true) {
+				$val = 'yes';
+			}
+			$this->out('* ' . $key . ': ' . print_r($val, true));
+		}
+
+		$this->out();
+	}
+
+	/**
+	 * Display some statistics about Finished Jobs.
+	 *
+	 * @return void
+	 */
+	public function stats()
+	{
+		$this->out('Jobs currently in the queue:');
+
+		$types = $this->QueuedTasks->getTypes()->toArray();
+		foreach ($types as $type) {
+			$this->out('      ' . str_pad($type, 20, ' ', STR_PAD_RIGHT) . ': ' . $this->QueuedTasks->getLength($type));
+		}
+		$this->hr();
+		$this->out('Total unfinished jobs: ' . $this->QueuedTasks->getLength());
+		$this->hr();
+		$this->out('Finished job statistics:');
+		$data = $this->QueuedTasks->getStats();
+		foreach ($data as $item) {
+			$this->out(' ' . $item['task'] . ': ');
+			$this->out('   Finished Jobs in Database: ' . $item['num']);
+			$this->out('   Average Job existence    : ' . str_pad(Number::precision($item['alltime']), 8, ' ', STR_PAD_LEFT) . 's');
+			$this->out('   Average Execution delay  : ' . str_pad(Number::precision($item['fetchdelay']), 8, ' ', STR_PAD_LEFT) . 's');
+			$this->out('   Average Execution time   : ' . str_pad(Number::precision($item['runtime']), 8, ' ', STR_PAD_LEFT) . 's');
+		}
+	}
+
+	/**
+	 * Get option parser method to parse commandline options
+	 *
+	 * @return \Cake\Console\ConsoleOptionParser
+	 */
+	public function getOptionParser()
+	{
+		$subcommandParser = [
+			'options' => [ /*
                              * 'dry-run'=> array(
                              * 'short' => 'd',
                              * 'help' => 'Dry run the update, no jobs will actually be added.',
                              * 'boolean' => true
                              * ),
                              */
-            ]
-        ];
-        $subcommandParserFull = $subcommandParser;
-        $subcommandParserFull['options']['type'] = [
-            'short' => 't',
-            'help' => 'Type (comma separated list possible)',
-            'default' => null
-        ];
-
-        return parent::getOptionParser()->setDescription($this->_getDescription())
-            ->addSubcommand('clean', [
-            'help' => 'Remove old jobs (cleanup)',
-            'parser' => $subcommandParser
-        ])
-            ->addSubcommand('add', [
-            'help' => 'Add Job',
-            'parser' => $subcommandParser
-        ])
-            ->addSubcommand('stats', [
-            'help' => 'Stats',
-            'parser' => $subcommandParserFull
-        ])
-            ->addSubcommand('settings', [
-            'help' => 'Settings',
-            'parser' => $subcommandParserFull
-        ])
-            ->addSubcommand('runworker', [
-            'help' => 'Run Worker',
-            'parser' => $subcommandParserFull
-        ]);
-    }
-
-    /**
-     * Timestamped log.
-     *
-     * @param string $message Log type
-     * @param string|null $pid PID of the process
-     * @param bool $addDetails
-     * @return void
-     */
-    protected function _log($message, $pid = null, $addDetails = true)
-    {
-        if (!Configure::read('Queue.log')) {
-            return;
-        }
-
-        if ($addDetails) {
-            $timeNeeded = $this->_timeNeeded();
-            $memoryUsage = $this->_memoryUsage();
-            $message .= ' [' . $timeNeeded . ', ' . $memoryUsage . ']';
-        }
-
-        if ($pid) {
-            $message .= ' (pid ' . $pid . ')';
-        }
-        Log::write('info', $message, [
-            'scope' => 'queue'
-        ]);
-    }
-
-    /**
-     *
-     * @param string $message
-     * @param string|null $pid PID of the process
-     * @return void
-     */
-    protected function _logError($message, $pid = null)
-    {
-        $timeNeeded = $this->_timeNeeded();
-        $memoryUsage = $this->_memoryUsage();
-        $message .= ' [' . $timeNeeded . ', ' . $memoryUsage . ']';
-
-        if ($pid) {
-            $message .= ' (pid ' . $pid . ')';
-        }
-
-        Log::write('error', $message);
-    }
-
-    /**
-     * Returns a List of available QueueTasks and their individual configurations.
-     *
-     * @return array
-     */
-    protected function _getTaskConf()
-    {
-        if (!is_array($this->_taskConf)) {
-            $this->_taskConf = [];
-            foreach ($this->tasks as $task) {
-                list ($pluginName, $taskName) = pluginSplit($task);
-
-                $this->_taskConf[$taskName]['name'] = substr($taskName, 5);
-                $this->_taskConf[$taskName]['plugin'] = $pluginName;
-                if (property_exists($this->{$taskName}, 'timeout')) {
-                    $this->_taskConf[$taskName]['timeout'] = $this->{$taskName}->timeout;
-                } else {
-                    $this->_taskConf[$taskName]['timeout'] = Config::defaultWorkerTimeout();
-                }
-                if (property_exists($this->{$taskName}, 'retries')) {
-                    $this->_taskConf[$taskName]['retries'] = $this->{$taskName}->retries;
-                } else {
-                    $this->_taskConf[$taskName]['retries'] = Config::defaultWorkerRetries();
-                }
-                if (property_exists($this->{$taskName}, 'cleanupTimeout')) {
-                    $this->_taskConf[$taskName]['cleanupTimeout'] = $this->{$taskName}->cleanupTimeout;
-                } else {
-                    $this->_taskConf[$taskName]['cleanupTimeout'] = Config::cleanupTimeout();
-                }
-            }
-        }
-        return $this->_taskConf;
-    }
-
-    /**
-     * Signal handling to queue worker for clean shutdown
-     *
-     * @param int $signal
-     * @return void
-     */
-    protected function _exit($signal)
-    {
-        $this->out(__d('queue', 'Caught %d signal, exiting.', $signal));
-        $this->_exit = true;
-    }
-
-    /**
-     *
-     * @return void
-     */
-    protected function _displayAvailableTasks()
-    {
-        $this->out('Available Tasks:');
-        foreach ($this->taskNames as $loadedTask) {
-            $this->out("\t" . '* ' . $this->_taskName($loadedTask));
-        }
-    }
-
-    /**
-     *
-     * @return string
-     */
-    protected function _initPid()
-    {
-        $this->_pid = $this->_retrievePid();
-        return $this->_pid;
-    }
-
-    /**
-     *
-     * @return string
-     */
-    protected function _retrievePid()
-    {
-        if (function_exists('posix_getpid')) {
-            $pid = (string)posix_getpid();
-        } else {
-            $pid = $this->QueuedTasks->key();
-        }
-        return $pid;
-    }
-
-    /**
-     *
-     * @return string Memory usage in MB.
-     */
-    protected function _memoryUsage()
-    {
-        $limit = ini_get('memory_limit');
-
-        $used = number_format(memory_get_peak_usage(true) / (1024 * 1024), 0) . 'MB';
-        if ($limit !== '-1') {
-            $used .= '/' . $limit;
-        }
-
-        return $used;
-    }
-
-    /**
-     *
-     * @param string|null $pid
-     *
-     * @return void
-     */
-    protected function _deletePid($pid)
-    {
-        if (!$pid) {
-            $pid = $this->_pid;
-        }
-        if (!$pid) {
-            return;
-        }
-    }
-
-    /**
-     *
-     * @return string
-     */
-    protected function _timeNeeded()
-    {
-        $diff = $this->_time() - $this->_time($this->_time);
-        $seconds = max($diff, 1);
-
-        return $seconds . 's';
-    }
-
-    /**
-     *
-     * @param int|null $providedTime
-     *
-     * @return int
-     */
-    protected function _time($providedTime = null)
-    {
-        if ($providedTime) {
-            return $providedTime;
-        }
-
-        return time();
-    }
-
-    /**
-     *
-     * @param string|null $param
-     * @return array
-     */
-    protected function _stringToArray($param)
-    {
-        if (!$param) {
-            return [];
-        }
-
-        $array = Text::tokenize($param);
-
-        return array_filter($array);
-    }
+			]
+		];
+		$subcommandParserFull = $subcommandParser;
+		$subcommandParserFull['options']['type'] = [
+			'short' => 't',
+			'help' => 'Type (comma separated list possible)',
+			'default' => null
+		];
+
+		return parent::getOptionParser()->setDescription($this->_getDescription())
+			->addSubcommand('clean', [
+			'help' => 'Remove old jobs (cleanup)',
+			'parser' => $subcommandParser
+		])
+			->addSubcommand('add', [
+			'help' => 'Add Job',
+			'parser' => $subcommandParser
+		])
+			->addSubcommand('stats', [
+			'help' => 'Stats',
+			'parser' => $subcommandParserFull
+		])
+			->addSubcommand('settings', [
+			'help' => 'Settings',
+			'parser' => $subcommandParserFull
+		])
+			->addSubcommand('runworker', [
+			'help' => 'Run Worker',
+			'parser' => $subcommandParserFull
+		]);
+	}
+
+	/**
+	 * Timestamped log.
+	 *
+	 * @param string $message Log type
+	 * @param string|null $pid PID of the process
+	 * @param bool $addDetails
+	 * @return void
+	 */
+	protected function _log($message, $pid = null, $addDetails = true)
+	{
+		if (!Configure::read('Queue.log')) {
+			return;
+		}
+
+		if ($addDetails) {
+			$timeNeeded = $this->_timeNeeded();
+			$memoryUsage = $this->_memoryUsage();
+			$message .= ' [' . $timeNeeded . ', ' . $memoryUsage . ']';
+		}
+
+		if ($pid) {
+			$message .= ' (pid ' . $pid . ')';
+		}
+		Log::write('info', $message, [
+			'scope' => 'queue'
+		]);
+	}
+
+	/**
+	 *
+	 * @param string $message
+	 * @param string|null $pid PID of the process
+	 * @return void
+	 */
+	protected function _logError($message, $pid = null)
+	{
+		$timeNeeded = $this->_timeNeeded();
+		$memoryUsage = $this->_memoryUsage();
+		$message .= ' [' . $timeNeeded . ', ' . $memoryUsage . ']';
+
+		if ($pid) {
+			$message .= ' (pid ' . $pid . ')';
+		}
+
+		Log::write('error', $message);
+	}
+
+	/**
+	 * Returns a List of available QueueTasks and their individual configurations.
+	 *
+	 * @return array
+	 */
+	protected function _getTaskConf()
+	{
+		if (!is_array($this->_taskConf)) {
+			$this->_taskConf = [];
+			foreach ($this->tasks as $task) {
+				list ($pluginName, $taskName) = pluginSplit($task);
+
+				$this->_taskConf[$taskName]['name'] = substr($taskName, 5);
+				$this->_taskConf[$taskName]['plugin'] = $pluginName;
+				if (property_exists($this->{$taskName}, 'timeout')) {
+					$this->_taskConf[$taskName]['timeout'] = $this->{$taskName}->timeout;
+				} else {
+					$this->_taskConf[$taskName]['timeout'] = Config::defaultWorkerTimeout();
+				}
+				if (property_exists($this->{$taskName}, 'retries')) {
+					$this->_taskConf[$taskName]['retries'] = $this->{$taskName}->retries;
+				} else {
+					$this->_taskConf[$taskName]['retries'] = Config::defaultWorkerRetries();
+				}
+				if (property_exists($this->{$taskName}, 'cleanupTimeout')) {
+					$this->_taskConf[$taskName]['cleanupTimeout'] = $this->{$taskName}->cleanupTimeout;
+				} else {
+					$this->_taskConf[$taskName]['cleanupTimeout'] = Config::cleanupTimeout();
+				}
+			}
+		}
+		return $this->_taskConf;
+	}
+
+	/**
+	 * Signal handling to queue worker for clean shutdown
+	 *
+	 * @param int $signal
+	 * @return void
+	 */
+	protected function _exit($signal)
+	{
+		$this->out(__d('queue', 'Caught %d signal, exiting.', $signal));
+		$this->_exit = true;
+	}
+
+	/**
+	 *
+	 * @return void
+	 */
+	protected function _displayAvailableTasks()
+	{
+		$this->out('Available Tasks:');
+		foreach ($this->taskNames as $loadedTask) {
+			$this->out("\t" . '* ' . $this->_taskName($loadedTask));
+		}
+	}
+
+	/**
+	 *
+	 * @return string
+	 */
+	protected function _initPid()
+	{
+		$this->_pid = $this->_retrievePid();
+		return $this->_pid;
+	}
+
+	/**
+	 *
+	 * @return string
+	 */
+	protected function _retrievePid()
+	{
+		if (function_exists('posix_getpid')) {
+			$pid = (string)posix_getpid();
+		} else {
+			$pid = $this->QueuedTasks->key();
+		}
+		return $pid;
+	}
+
+	/**
+	 *
+	 * @return string Memory usage in MB.
+	 */
+	protected function _memoryUsage()
+	{
+		$limit = ini_get('memory_limit');
+
+		$used = number_format(memory_get_peak_usage(true) / (1024 * 1024), 0) . 'MB';
+		if ($limit !== '-1') {
+			$used .= '/' . $limit;
+		}
+
+		return $used;
+	}
+
+	/**
+	 *
+	 * @param string|null $pid
+	 *
+	 * @return void
+	 */
+	protected function _deletePid($pid)
+	{
+		if (!$pid) {
+			$pid = $this->_pid;
+		}
+		if (!$pid) {
+			return;
+		}
+	}
+
+	/**
+	 *
+	 * @return string
+	 */
+	protected function _timeNeeded()
+	{
+		$diff = $this->_time() - $this->_time($this->_time);
+		$seconds = max($diff, 1);
+
+		return $seconds . 's';
+	}
+
+	/**
+	 *
+	 * @param int|null $providedTime
+	 *
+	 * @return int
+	 */
+	protected function _time($providedTime = null)
+	{
+		if ($providedTime) {
+			return $providedTime;
+		}
+
+		return time();
+	}
+
+	/**
+	 *
+	 * @param string|null $param
+	 * @return array
+	 */
+	protected function _stringToArray($param)
+	{
+		if (!$param) {
+			return [];
+		}
+
+		$array = Text::tokenize($param);
+
+		return array_filter($array);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -17,7 +17,7 @@ 
 use Queue\Shell\Task\QueueTaskInterface;
 use RuntimeException;
 use Throwable;
-declare(ticks = 1);
+declare(ticks=1);
 
 /**
  * Main shell to init and run queue workers.
@@ -354,7 +354,7 @@ 
     public function getOptionParser()
     {
         $subcommandParser = [
-            'options' => [ /*
+            'options' => [/*
                              * 'dry-run'=> array(
                              * 'short' => 'd',
                              * 'help' => 'Dry run the update, no jobs will actually be added.',

src/Shell/Task/QueueTask.php

Indentation +45 added lines, -45 removed lines

@@ -18,57 +18,57 @@
 abstract class QueueTask extends Shell implements QueueTaskInterface
 {
 
-    /**
-     *
-     * @var string
-     */
-    public $queueModelClass = 'Queue.QueuedTasks';
+	/**
+	 *
+	 * @var string
+	 */
+	public $queueModelClass = 'Queue.QueuedTasks';
 
-    /**
-     *
-     * @var \Queue\Model\Table\QueuedTasksTable
-     */
-    public $QueuedTasks;
+	/**
+	 *
+	 * @var \Queue\Model\Table\QueuedTasksTable
+	 */
+	public $QueuedTasks;
 
-    /**
-     * Timeout for run, after which the Task is reassigned to a new worker.
-     *
-     * @var int
-     */
-    public $timeout = 120;
+	/**
+	 * Timeout for run, after which the Task is reassigned to a new worker.
+	 *
+	 * @var int
+	 */
+	public $timeout = 120;
 
-    /**
-     * Number of times a failed instance of this task should be restarted before giving up.
-     *
-     * @var int
-     */
-    public $retries = 1;
+	/**
+	 * Number of times a failed instance of this task should be restarted before giving up.
+	 *
+	 * @var int
+	 */
+	public $retries = 1;
 
-    /**
-     *
-     * @param \Cake\Console\ConsoleIo|null $io IO
-     */
-    public function __construct(ConsoleIo $io = null)
-    {
-        parent::__construct($io);
+	/**
+	 *
+	 * @param \Cake\Console\ConsoleIo|null $io IO
+	 */
+	public function __construct(ConsoleIo $io = null)
+	{
+		parent::__construct($io);
 
-        $this->loadModel($this->queueModelClass);
-    }
+		$this->loadModel($this->queueModelClass);
+	}
 
-    /**
-     *
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    protected function queueTaskName()
-    {
-        $class = get_class($this);
+	/**
+	 *
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	protected function queueTaskName()
+	{
+		$class = get_class($this);
 
-        preg_match('#\\\\Queue(.+)Task$#', $class, $matches);
-        if (!$matches) {
-            throw new InvalidArgumentException('Invalid class name: ' . $class);
-        }
+		preg_match('#\\\\Queue(.+)Task$#', $class, $matches);
+		if (!$matches) {
+			throw new InvalidArgumentException('Invalid class name: ' . $class);
+		}
 
-        return $matches[1];
-    }
+		return $matches[1];
+	}
 }

src/Shell/Task/QueueExampleTask.php

Indentation +72 added lines, -72 removed lines

@@ -7,82 +7,82 @@
 class QueueExampleTask extends QueueTask implements AddInterface
 {
 
-    /**
-     * Timeout for run, after which the task is reassigned to a new worker.
-     *
-     * @var int
-     */
-    public $timeout = 10;
+	/**
+	 * Timeout for run, after which the task is reassigned to a new worker.
+	 *
+	 * @var int
+	 */
+	public $timeout = 10;
 
-    /**
-     * Timeout for cleanup, after which completed jobs are deleted (in seconds).
-     *
-     * @var int
-     */
-    public $cleanupTimeout = 600;
+	/**
+	 * Timeout for cleanup, after which completed jobs are deleted (in seconds).
+	 *
+	 * @var int
+	 */
+	public $cleanupTimeout = 600;
 
-    /**
-     * Number of times a failed instance of this task should be restarted before giving up.
-     *
-     * @var int
-     */
-    public $retries = 0;
+	/**
+	 * Number of times a failed instance of this task should be restarted before giving up.
+	 *
+	 * @var int
+	 */
+	public $retries = 0;
 
-    /**
-     * Stores any failure messages triggered during run().
-     *
-     * @var string
-     */
-    public $failureMessage = '';
+	/**
+	 * Stores any failure messages triggered during run().
+	 *
+	 * @var string
+	 */
+	public $failureMessage = '';
 
-    /**
-     * Example add functionality.
-     * Will create one example job in the queue, which later will be executed using run();
-     *
-     * To invoke from CLI execute:
-     * - bin/cake queue add Example
-     *
-     * @return void
-     */
-    public function add(): void
-    {
-        $this->out(__d('queue', 'CakePHP Queue Example task.'));
-        $this->hr();
-        $this->out(__d('queue', 'This is a very simple example of a queueTask.'));
-        $this->out(__d('queue', 'Now adding an example Task Job into the Queue.'));
-        $this->out(__d('queue', 'This task will only produce some console output on the worker that it runs on.'));
-        $this->out(' ');
-        $this->out(__d('queue', 'To run a Worker use:'));
-        $this->out(__d('queue', '	cake queue runworker'));
-        $this->out(' ');
-        $this->out(__d('queue', 'You can find the sourcecode of this task in: '));
-        $this->out(__FILE__);
-        $this->out(' ');
+	/**
+	 * Example add functionality.
+	 * Will create one example job in the queue, which later will be executed using run();
+	 *
+	 * To invoke from CLI execute:
+	 * - bin/cake queue add Example
+	 *
+	 * @return void
+	 */
+	public function add(): void
+	{
+		$this->out(__d('queue', 'CakePHP Queue Example task.'));
+		$this->hr();
+		$this->out(__d('queue', 'This is a very simple example of a queueTask.'));
+		$this->out(__d('queue', 'Now adding an example Task Job into the Queue.'));
+		$this->out(__d('queue', 'This task will only produce some console output on the worker that it runs on.'));
+		$this->out(' ');
+		$this->out(__d('queue', 'To run a Worker use:'));
+		$this->out(__d('queue', '	cake queue runworker'));
+		$this->out(' ');
+		$this->out(__d('queue', 'You can find the sourcecode of this task in: '));
+		$this->out(__FILE__);
+		$this->out(' ');
 
-        // Adding a task of type 'example' with no additionally passed data
-        if ($this->QueuedTasks->createJob('Example')) {
-            $this->out(__d('queue', 'OK, job created, now run the worker'));
-        } else {
-            $this->err(__d('queue', 'Could not create Job'));
-        }
-    }
+		// Adding a task of type 'example' with no additionally passed data
+		if ($this->QueuedTasks->createJob('Example')) {
+			$this->out(__d('queue', 'OK, job created, now run the worker'));
+		} else {
+			$this->err(__d('queue', 'Could not create Job'));
+		}
+	}
 
-    /**
-     * Example run function.
-     * This function is executed, when a worker is executing a task.
-     * The return parameter will determine, if the task will be marked completed, or be requeued.
-     *
-     * @param array $data The array passed to QueuedTasksTable::createJob()
-     * @param int $taskId The id of the QueuedTask entity
-     * @return void
-     */
-    public function run(array $data, $taskId): void
-    {
-        $this->hr();
-        $this->out(__d('queue', 'CakePHP Queue Example task.'));
-        $this->hr();
-        $this->out(__d('queue', ' ->Success, the Example Task was run.<-'));
-        $this->out(' ');
-        $this->out(' ');
-    }
+	/**
+	 * Example run function.
+	 * This function is executed, when a worker is executing a task.
+	 * The return parameter will determine, if the task will be marked completed, or be requeued.
+	 *
+	 * @param array $data The array passed to QueuedTasksTable::createJob()
+	 * @param int $taskId The id of the QueuedTask entity
+	 * @return void
+	 */
+	public function run(array $data, $taskId): void
+	{
+		$this->hr();
+		$this->out(__d('queue', 'CakePHP Queue Example task.'));
+		$this->hr();
+		$this->out(__d('queue', ' ->Success, the Example Task was run.<-'));
+		$this->out(' ');
+		$this->out(' ');
+	}
 }