Add $id to arguments of run method in example tasks

QueueShell::runworker() passes the id of the QueuedTask when it calls the run method on the task. The QueueLongExampleTask included the argument but the rest were missing.
dereuromark · Mar 4, 2015 · bc2d78e · bc2d78e
1 parent 5907258
commit bc2d78e
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 6 deletions.
diff --git a/Console/Command/Task/QueueEmailTask.php b/Console/Command/Task/QueueEmailTask.php
@@ -56,9 +56,10 @@ public function add() {
  * QueueEmailTask::run()
  *
  * @param mixed $data Job data
+ * @param int $id The id of the QueuedTask
  * @return bool Success
  */
-	public function run($data) {
+	public function run($data, $id = null) {
 		if (!isset($data['settings'])) {
 			$this->err('Queue Email task called without settings data.');
 			return false;

diff --git a/Console/Command/Task/QueueExampleTask.php b/Console/Command/Task/QueueExampleTask.php
@@ -89,9 +89,10 @@ public function add() {
  * The return parameter will determine, if the task will be marked completed, or be requeued.
  *
  * @param array $data The array passed to QueuedTask->createJob()
+ * @param int $id The id of the QueuedTask
  * @return bool Success
  */
-	public function run($data) {
+	public function run($data, $id = null) {
 		$this->hr();
 		$this->out('CakePHP Queue Example task.');
 		$this->hr();

diff --git a/Console/Command/Task/QueueExecuteTask.php b/Console/Command/Task/QueueExecuteTask.php
@@ -89,9 +89,10 @@ public function add() {
  * The return parameter will determine, if the task will be marked completed, or be requeued.
  *
  * @param array $data The array passed to QueuedTask->createJob()
+ * @param int $id The id of the QueuedTask
  * @return bool Success
  */
-	public function run($data) {
+	public function run($data, $id = null) {
 		$command = escapeshellcmd($data['command']);
 		if (!empty($data['params'])) {
 			$command .= ' ' . implode(' ', $data['params']);

diff --git a/Console/Command/Task/QueueLongExampleTask.php b/Console/Command/Task/QueueLongExampleTask.php
@@ -85,7 +85,7 @@ public function add() {
  * The return parameter will determine, if the task will be marked completed, or be requeued.
  *
  * @param array $data The array passed to QueuedTask->createJob()
- * @param int $id The id
+ * @param int $id The id of the QueuedTask
  * @return bool Success
  * @throws RuntimeException when seconds are 0;
  */

diff --git a/Console/Command/Task/QueueRetryExampleTask.php b/Console/Command/Task/QueueRetryExampleTask.php
@@ -105,9 +105,10 @@ public function add() {
  * The return parameter will determine, if the task will be marked completed, or be requeued.
  *
  * @param array $data The array passed to QueuedTask->createJob()
+ * @param int $id The id of the QueuedTask
  * @return bool Success
  */
-	public function run($data) {
+	public function run($data, $id = null) {
 		$count = (int)file_get_contents($this->file);
 
 		$this->hr();

diff --git a/Console/Command/Task/QueueSuperExampleTask.php b/Console/Command/Task/QueueSuperExampleTask.php
@@ -88,9 +88,10 @@ public function add() {
  * The return parameter will determine, if the task will be marked completed, or be requeued.
  *
  * @param array $data The array passed to QueuedTask->createJob()
+ * @param int $id The id of the QueuedTask
  * @return bool Success
  */
-	public function run($data) {
+	public function run($data, $id = null) {
 		$this->hr();
 		$this->out('CakePHP Queue SuperExample task.');
 		$this->hr();