Add IdeHelper support for createJob().

Author: dereuromark

config/bootstrap.php

@@ -1,9 +1,13 @@
 <?php
 use Cake\Core\Configure;
+use Queue\Generator\Task\QueuedJobTask;
 
-// Optionally load additional queue config defaults
-// from local app config
-
+// Optionally load additional queue config defaults from local app config
 if (file_exists(ROOT . DS . 'config' . DS . 'app_queue.php')) {
 	Configure::load('app_queue');
 }
+
+// For IdeHelper plugin if in use - make sure to run `bin/cake phpstorm generate` then
+$generatorTasks = (array)Configure::read('IdeHelper.generatorTasks');
+$generatorTasks[] = QueuedJobTask::class;
+Configure::write('IdeHelper.generatorTasks', $generatorTasks);

docs/README.md

@@ -318,6 +318,27 @@ Then you can kill them gracefully with `-15` (or forcefully with `-9`, not recom
 Locally, if you want to kill them all, usually `killapp -15 php` does the trick.
 Do not run this with production ones, though.
 
+## IDE support
+With [IdeHelper](https://github.com/dereuromark/cakephp-ide-helper/) plugin you can get typehinting and autocomplete for your createJob() calls.
+Especially if you use PHPStorm, this will make it possible to get support here.
+
+Include that plugin, set up your generator config and run e.g. `bin/cake phpstorm generate`.
+
+If you use `Plugin::load('Queue', ['bootstrap' => true, ...])`, the necessary config is already auto-included (recommended).
+Otherwise you can manually include the Queue plugin generator tasks in your `config/app.php` on project level:
+```php
+use Queue\Generator\Task\QueuedJobTask;
+
+return [
+	...
+	'IdeHelper' => [
+		'generatorTasks' => [
+			QueuedJobTask::class
+		],
+	],
+];
+```
+
 ## Contributing
 I am looking forward to your contributions.
 

src/Generator/Task/QueuedJobTask.php

@@ -0,0 +1,59 @@
+<?php
+namespace Queue\Generator\Task;
+
+use Cake\Core\App;
+use IdeHelper\Generator\Task\TaskInterface;
+use Queue\Queue\TaskFinder;
+
+class QueuedJobTask implements TaskInterface {
+
+	/**
+	 * @var array
+	 */
+	protected $aliases = [
+		'\Queue\Model\Table\QueuedJobsTable::createJob(0)',
+	];
+
+	/**
+	 * @return array
+	 */
+	public function collect() {
+		$map = [];
+
+		$models = $this->collectQueuedJobTasks();
+		foreach ($models as $model => $className) {
+			$map[$model] = '\\' . $className . '::class';
+		}
+
+		$result = [];
+		foreach ($this->aliases as $alias) {
+			$result[$alias] = $map;
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @return string[]
+	 */
+	protected function collectQueuedJobTasks() {
+		$result = [];
+
+		$taskFinder = new TaskFinder();
+		$tasks = $taskFinder->allAppAndPluginTasks();
+
+		foreach ($tasks as $task) {
+			$className = App::className($task, 'Shell/Task', 'Task');
+
+			if (substr($task, 0, 6) === 'Queue.') {
+				$task = 'Queue.' . substr($task, 11);
+			} else {
+				$task = substr($task, 5);
+			}
+			$result[$task] = $className;
+		}
+
+		return $result;
+	}
+
+}