Removed job ID from execute method

Author: zhuravljov

README.md

@@ -33,36 +33,30 @@ to the require section of your `composer.json` file.
 Basic Usage
 -----------
 
-Job class example:
+Each task which is sent to queue should be defined as a separate class.
+For example, if you need to download and save a file the class may look like the following:
 
 ```php
 class DownloadJob extends Object implements \zhuravljov\yii\queue\Job
 {
     public $url;
     public $file;
 
-    /**
-     * @param Queue $queue which handled the job
-     * @param string|null $jobId job message ID
-     */
-    public function execute($queue, $jobId)
+    public function execute($queue)
     {
         file_put_contents($this->file, file_get_contents($this->url));
     }
 }
 ```
 
-Pushes job into queue:
+Here's how to send a task into queue:
 
 ```php
 Yii::$app->queue->push(new DownloadJob([
     'url' => 'http://example.com/image.jpg',
     'file' => '/tmp/image.jpg',
 ]));
 ```
-
-Method of handling a queue depend on selected driver.
-
 Pushes job into queue that run after 5 min:
 
 ```php
@@ -72,6 +66,24 @@ Yii::$app->queue->later(new DownloadJob([
 ]), 5 * 60);
 ```
 
-But only some drivers support delayed running.
+The exact way task is executed depends on the driver used. The most part of drivers can be run using
+console commands, which the component registers in your application. For more details see documentation
+of a driver.
+
+The component has ability to track status jobs which was pushed into queue.
+
+```php
+// Push a job into queue and get massage ID.
+$id = Yii::$app->queue->push(new SomeJob());
+
+// The job is waiting for execute. 
+Yii::$app->queue->isWaiting($id);
+
+// Worker gets the job from queue, end executing it.
+Yii::$app->queue->isReserved($id);
+
+// Worker has executed the job. 
+Yii::$app->queue->isDone($id);
+```
 
 For more details see [the guide](docs/guide/README.md).

UPGRADE.md

@@ -12,7 +12,7 @@ Upgrade from 0.x to 1.0
 
 * Some methods and constants was modified.
 
-  - Method `Job::run()` modified to `Job::execute($queue, $jobId)`.
+  - Method `Job::run()` modified to `Job::execute($queue)`.
   - Const `Queue::EVENT_BEFORE_WORK` renamed to `Queue::EVENT_BEFORE_EXEC`.
   - Const `Queue::EVENT_AFTER_WORK` renamed to `Queue::EVENT_AFTER_EXEC`.
   - Const `Queue::EVENT_AFTER_ERROR` renamed to `Queue::EVENT_AFTER_EXEC_ERROR`.

docs/guide-ru/driver-file.md

@@ -1,7 +1,7 @@
 Файловый драйвер
 ================
 
-DB дравер для хранения очереди заданий использует файлы.
+Файловый драйвер для хранения очереди заданий использует определенную директорию.
 
 Пример настройки:
 

docs/guide-ru/usage.md

@@ -37,11 +37,7 @@ class DownloadJob extends Object implements \zhuravljov\yii\queue\Job
     public $url;
     public $file;
 
-    /**
-     * @param Queue $queue очередь, которая обрабатывает задание
-     * @param string|null $jobId задания
-     */
-    public function execute($queue, $jobId)
+    public function execute($queue)
     {
         file_put_contents($this->file, file_get_contents($this->url));
     }
@@ -204,7 +200,7 @@ class SomeJob extends Object implements \zhuravljov\yii\queue\Job
     public $bookId;
     public $someUrl;
 
-    public function execute($queue, $jobId)
+    public function execute($queue)
     {
         $user = User::findOne($this->userId);
         $book = Book::findOne($this->bookId);

docs/guide/usage.md

@@ -37,11 +37,7 @@ class DownloadJob extends Object implements \zhuravljov\yii\queue\Job
     public $url;
     public $file;
 
-    /**
-     * @param Queue $queue which handled the job
-     * @param string|null $jobId job message ID
-     */
-    public function execute($queue, $jobId)
+    public function execute($queue)
     {
         file_put_contents($this->file, file_get_contents($this->url));
     }
@@ -79,7 +75,7 @@ of a driver.
 Job status
 ----------
 
-The component has ability to track status jobs which is pushed into queue.
+The component has ability to track status jobs which was pushed into queue.
 
 ```php
 // Push a job into queue and get massage ID.
@@ -200,7 +196,7 @@ class SomeJob extends Object implements \zhuravljov\yii\queue\Job
     public $bookId;
     public $someUrl;
 
-    public function execute($queue, $jobId)
+    public function execute($queue)
     {
         $user = User::findOne($this->userId);
         $book = Book::findOne($this->bookId);

src/Job.php

@@ -15,8 +15,7 @@
 interface Job
 {
     /**
-     * @param Queue $queue which was pushed the job
-     * @param string|null $jobId job message ID
+     * @param Queue $queue which pushed and is handling the job
      */
-    public function execute($queue, $jobId);
+    public function execute($queue);
 }

src/Queue.php

@@ -119,7 +119,7 @@ protected function handleMessage($id, $message)
         $error = null;
         $this->trigger(self::EVENT_BEFORE_EXEC, new JobEvent(['id' => $id, 'job' => $job]));
         try {
-            $job->execute($this, $id);
+            $job->execute($this);
         } catch (\Exception $error) {
             $this->trigger(self::EVENT_AFTER_EXEC_ERROR, new ErrorEvent(['id' => $id, 'job' => $job, 'error' => $error]));
         }

src/closure/Job.php

@@ -27,7 +27,7 @@ class Job extends Object implements BaseJob
      * Unserializes and executes a closure
      * @inheritdoc
      */
-    public function execute($queue, $jobId)
+    public function execute($queue)
     {
         $serializer = new Serializer();
         $closure = $serializer->unserialize($this->serialized);

src/gii/default/job.php

@@ -33,7 +33,7 @@ class <?= $jobClass ?> extends <?= $baseClass ?> <?= $implements ?>
     /**
      * @inheritdoc
      */
-    public function execute($queue, $jobId)
+    public function execute($queue)
     {
     }
 }

tests/app/TestJob.php

@@ -20,13 +20,13 @@ class TestJob extends Object implements Job
 {
     public $uid;
 
-    public function execute($queue, $jobId)
+    public function execute($queue)
     {
-        file_put_contents($this->getFileName($jobId), '');
+        file_put_contents($this->getFileName(), '');
     }
 
-    public function getFileName($jobId)
+    public function getFileName()
     {
-        return Yii::getAlias("@runtime/job-{$this->uid}-{$jobId}.lock");
+        return Yii::getAlias("@runtime/job-{$this->uid}.lock");
     }
 }