symbiote / silverstripe-queuedjobs

src/DataObjects/QueuedJobDescriptor.php

Doc Comments +1 added lines, -1 removed lines

@@ -263,7 +263,7 @@
     }
 
     /**
-     * @return FieldList
+     * @return \SilverStripe\Forms\FieldList
      */
     public function getCMSFields()
     {

src/Forms/GridFieldQueuedJobExecute.php

Doc Comments +3 added lines, -3 removed lines

@@ -104,7 +104,7 @@ 
      * Which columns are handled by this component
      *
      * @param GridField $gridField
-     * @return array
+     * @return string[]
      */
     public function getColumnsHandled($gridField)
     {
@@ -115,7 +115,7 @@ 
      * Which GridField actions are this component handling
      *
      * @param GridField $gridField
-     * @return array
+     * @return string[]
      */
     public function getActions($gridField)
     {
@@ -126,7 +126,7 @@ 
      * @param GridField $gridField
      * @param DataObject $record
      * @param string $columnName
-     * @return string|void - the HTML for the column
+     * @return null|\SilverStripe\ORM\FieldType\DBHTMLText - the HTML for the column
      */
     public function getColumnContent($gridField, $record, $columnName)
     {

src/Jobs/CleanupJob.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
 
     /**
      * Required because we aren't extending object
-     * @return Config_ForClass
+     * @return \SilverStripe\Core\Config\Config_ForClass
      */
     public function config()
     {

tests/CleanupJobTest.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace Symbiote\QueuedJobs\Tests;
 
-use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Core\Config\Config;
 use SilverStripe\ORM\FieldType\DBDatetime;
 use Symbiote\QueuedJobs\Jobs\CleanupJob;

tests/QueuedJobsTest.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace Symbiote\QueuedJobs\Tests;
 
-use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Core\Config\Config;
 use SilverStripe\ORM\DataList;
 use SilverStripe\ORM\DataObject;

tests/QueuedJobsAdminTest.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace Symbiote\QueuedJobs\Tests;
 
-use SilverStripe\Core\Config\Config;
 use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Dev\FunctionalTest;
 use SilverStripe\Forms\FieldList;

src/Jobs/RunBuildTaskJob.php

Doc Comments +1 added lines, -1 removed lines

@@ -20,7 +20,7 @@
 class RunBuildTaskJob extends AbstractQueuedJob
 {
     /**
-     * @param DataObject $node
+     * @param string $queryString
      */
     public function __construct($taskClass = null, $queryString = null)
     {

src/Services/QueuedJobService.php

Doc Comments +7 added lines, -3 removed lines

@@ -150,7 +150,7 @@ 
      *
      * @param QueuedJob $job
      *          The job to start.
-     * @param $startAfter
+     * @param string $startAfter
      *          The date (in Y-m-d H:i:s format) to start execution after
      * @param int $userId
      *          The ID of a user to execute the job as. Defaults to the current user
@@ -206,7 +206,7 @@ 
     /**
      * Start a job (or however the queue handler determines it should be started)
      *
-     * @param JobDescriptor $jobDescriptor
+     * @param QueuedJobDescriptor $jobDescriptor
      * @param date $startAfter
      */
     public function startJob($jobDescriptor, $startAfter = null)
@@ -381,6 +381,7 @@ 
 
     /**
      * Checks through ll the scheduled jobs that are expected to exist
+     * @param string $queue
      */
     public function checkDefaultJobs($queue = null)
     {
@@ -461,7 +462,7 @@ 
      *
      * @param QueuedJobDescriptor $stalledJob
      *
-     * @return bool True if the job was successfully restarted
+     * @return boolean|null True if the job was successfully restarted
      */
     protected function restartStalledJob($stalledJob)
     {
@@ -1012,6 +1013,9 @@ 
         }
     }
 
+    /**
+     * @param double $size
+     */
     protected function humanReadable($size)
     {
         $filesizename = [" Bytes", " KB", " MB", " GB", " TB", " PB", " EB", " ZB", " YB"];

tests/QueuedJobsTest/TestQJService.php

Doc Comments +3 added lines

@@ -18,6 +18,9 @@
         'queueHandler' => '%$QueueHandler'
     ];
 
+    /**
+     * @param \SilverStripe\ORM\DataObject|null $descriptor
+     */
     public function testInit($descriptor)
     {
         return $this->initialiseJob($descriptor);