Improve docs.

Author: dereuromark

docs/sections/custom_tasks.md

@@ -41,8 +41,8 @@ class YourNameForItTask extends Task {
      * @return void
      */
     public function run(array $data, int $jobId): void {
-        $this->loadModel('FooBars');
-        if (!$this->FooBars->doSth()) {
+        $fooBarsTable = $this->fetchTable('FooBars');
+        if (!$fooBarsTable->doSth()) {
             throw new RuntimeException('Couldnt do sth.');
         }
     }

docs/sections/misc.md

@@ -39,18 +39,19 @@ From CLI you run this to rerun all of a specific job type at once:
 ```
 bin/cake queue rerun FooBar
 ```
-You can add an additional reference to rerun a specific job.
+You can add a reference to rerun a specific job.
 
 ## Using custom finder
 You can use a convenience finder for tasks that are still queued, that means not yet finished.
 ```php
-$query = $this->QueuedJobs->find('queued')->...;
+$queuedJobsTable = $this->fetchTable('Queue.QueuedJobs');
+$query = $queuedJobsTable->find('queued')->...;
 ```
 This includes also failed ones if not filtered further using `where()` conditions.
 
 ## Notes
 
-`<TaskName>` is the complete class name without the Task suffix (eg. Example or PluginName.Example).
+`<TaskName>` is the complete class name without the Task suffix (e.g. Example or PluginName.Example).
 
 Custom tasks should be placed in `src/Queue/Task/`.
 Tasks should be named `SomethingTask` and implement the Queue "Task".

docs/sections/queueing_jobs.md

@@ -33,9 +33,9 @@ The `createJob()` function takes three arguments.
 For sending emails, for example:
 
 ```php
-// In your controller
-$this->loadModel('Queue.QueuedJobs');
-$this->QueuedJobs->createJob('Queue.Email', ['to' => '[email protected]', ...]);
+// In your controller or where TableAwareTrait is used
+$queuedJobsTable = $this->fetchTable('Queue.QueuedJobs');
+$queuedJobsTable->createJob('Queue.Email', ['to' => '[email protected]', ...]);
 
 // Somewhere in the model or lib
 TableRegistry::getTableLocator()->get('Queue.QueuedJobs')
@@ -61,7 +61,7 @@ find the usage more easily, you can also use `<TaskClassName>::class` for `creat
 ```php
 use Queue\Queue\Task\EmailTask;
 
-$this->QueuedJobs->createJob(EmailTask::class, ['to' => '[email protected]', ...]);
+$queuedJobsTable->createJob(EmailTask::class, ['to' => '[email protected]', ...]);
 ```
 This does, however, require adding use statements for each such line on top.
 
@@ -72,7 +72,7 @@ use Queue\Queue\Task\EmailTask;
 
 $taskName = EmailTask::taskName();
 
-$this->QueuedJobs->createJob($taskName, ['to' => '[email protected]', ...]);
+$queuedJobsTable->createJob($taskName, ['to' => '[email protected]', ...]);
 ```
 This can be useful when more dynamically adding certain jobs of different types.
 
@@ -98,14 +98,14 @@ In your logic you can check on this using `isQueued()` and a unique reference:
     public function triggerImport() {
         $this->request->allowMethod('post');
 
-        $this->loadModel('Queue.QueuedJobs');
-        if ($this->QueuedJobs->isQueued('my-import', 'Queue.Execute')) {
+        $queuedJobsTable = $this->fetchTable('Queue.QueuedJobs');
+        if ($queuedJobsTable->isQueued('my-import', 'Queue.Execute')) {
             $this->Flash->error('Job already running');
 
             return $this->redirect($this->referer(['action' => 'index']));
         }
 
-        $this->QueuedJobs->createJob(
+        $queuedJobsTable->createJob(
            'Queue.Execute',
             ['command' => 'bin/cake importer run'],
             ['reference' => 'my-import', 'priority' => 2]
@@ -131,15 +131,15 @@ The `createJob()` method returns the entity. So you can store the ID and at any
 
 ```php
 // Within your regular web application
-$job = $this->QueuedJobs->createJob(...);
+$job = $queuedJobsTable->createJob(...);
 $id = $job->id;
 // Store
 
 // Inside your Queue task, if you know the total records:
 $totalRecords = count($records);
 foreach ($records as $i => $record) {
     $this->processImageRendering($record);
-    $this->QueuedJobs->updateProgress($id, ($i + 1) / $totalRecords);
+    $queuedJobsTable->updateProgress($id, ($i + 1) / $totalRecords);
 }
 ```
 
@@ -151,35 +151,35 @@ class FooTask extends Task {
 
     public function run(array $data, int $jobId): void {
         // Initializing
-        $jobsTable = TableRegistry::getTableLocator()->get('Queue.QueuedJobs');
+        $queuedJobsTable = TableRegistry::getTableLocator()->get('Queue.QueuedJobs');
         $foo = new Foo();
 
         // Part one
-        $jobsTable->updateAll(
+        $queuedJobsTable->updateAll(
             ['status' => 'Doing the first thing'],
             ['id' => $jobId]
         );
         $foo->doFirstPartOfTask();
-        $jobsTable->updateProgress($jobId, 33);
+        $queuedJobsTable->updateProgress($jobId, 33);
 
         // Part two
-        $jobsTable->updateAll(
+        $queuedJobsTable->updateAll(
             ['status' => 'Doing the next thing'],
             ['id' => $jobId]
         );
         $foo->doNextPartOfTask();
-        $jobsTable->updateProgress($jobId, 66);
+        $queuedJobsTable->updateProgress($jobId, 66);
 
         // Part three
-        $jobsTable->updateAll(
+        $queuedJobsTable->updateAll(
             ['status' => 'Doing the last thing'],
             ['id' => $jobId]
         );
         $foo->doLastPartOfTask();
-        $jobsTable->updateProgress($jobId, 100);
+        $queuedJobsTable->updateProgress($jobId, 100);
 
         // Done
-        $jobsTable->updateAll(
+        $queuedJobsTable->updateAll(
             ['status' => 'Done doing things'],
             ['id' => $jobId]
         );
@@ -189,7 +189,7 @@ class FooTask extends Task {
 
 Get progress status in website and display:
 ```php
-$job = $this->QueuedJobs->get($id);
+$job = $queuedJobsTable->get($id);
 
 $progress = $job->progress; // A float from 0 to 1
 echo $this->Number->toPercentage($progress, 0, ['multiply' => true]) . '%'; // Outputs 87% for example