Просмотр исходного кода

add doc entry for starting work event

David Moreau 10 лет назад
Родитель
Сommit
fce20ccd68
1 измененных файлов с 17 добавлено и 1 удалено
  1. 17 1
      Resources/docs/kernel_events.rst

+ 17 - 1
Resources/docs/kernel_events.rst

@@ -129,6 +129,22 @@ The second method will return `$context` that you could add in the `addTask()` m
             tags:
               - { name: kernel.event_listener, event: gearman.client.callback.workload, method: onWorkload }
 
+Starting Work Event
+~~~~~~~~~~~~~~~~~~
+
+This event receives as parameter an instanceof `Mmoreram\GearmanBundle\Event\GearmanWorkStartingEvent` with one method:
+`$event->getJobs()` returns the configuration of the jobs.
+
+This event is dispatched before a job starts.
+
+.. code-block:: yml
+
+    services:
+        my_event_listener:
+            class: AcmeBundle\EventListener\MyEventListener
+            tags:
+              - { name: kernel.event_listener, event: gearman.work.starting, method: onWorkStarting }
+
 Execute Work Event
 ~~~~~~~~~~~~~~~~~~
 
@@ -145,4 +161,4 @@ This event is dispatched after a job has been completed.  After this event is co
         my_event_listener:
             class: AcmeBundle\EventListener\MyEventListener
             tags:
-              - { name: kernel.event_listener, event: gearman.work.executed, method: onWorkExecuted }
+              - { name: kernel.event_listener, event: gearman.work.executed, method: onWorkExecuted }