silverstripe-australia / silverstripe-queuedjobs

code/forms/GridFieldQueuedJobExecute.php

Doc Comments +5 added lines, -2 removed lines

@@ -33,6 +33,9 @@ 
 	 */
 	protected $viewCheck;
 
+	/**
+	 * @param Closure $check
+	 */
 	public function __construct($action = 'execute', $check = null) {
 		$this->action = $action;
 		if (!$check) {
@@ -85,7 +88,7 @@ 
 	 * Which columns are handled by this component
 	 *
 	 * @param type $gridField
-	 * @return type
+	 * @return string[]
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -95,7 +98,7 @@ 
 	 * Which GridField actions are this component handling
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('execute', 'pause', 'resume');

code/services/DefaultQueueHandler.php

Doc Comments +3 added lines

@@ -11,6 +11,9 @@
 		$job->activateOnQueue();
 	}
 
+	/**
+	 * @param Date $date
+	 */
 	public function scheduleJob(QueuedJobDescriptor $job, $date) {
 		// noop
 	}

code/tasks/engines/BaseRunner.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
 	/**
 	 * Logs the status of the queued job descriptor.
 	 *
-	 * @param bool|null|QueuedJobDescriptor $descriptor
+	 * @param DataObject|null $descriptor
 	 * @param string $queue
 	 */
 	protected function logDescriptorStatus($descriptor, $queue) {

code/tasks/engines/DoormanRunner.php

Doc Comments +2 added lines, -2 removed lines

@@ -22,7 +22,7 @@ 
 	}
 
 	/**
-	 * @return array List of rules
+	 * @return string List of rules
 	 */
 	public function getDefaultRules() {
 		return $this->defaultRules;
@@ -66,7 +66,7 @@ 
 
 	/**
 	 * @param string $queue
-	 * @return null|QueuedJobDescriptor
+	 * @return DataObject|null
 	 */
 	protected function getNextJobDescriptorWithoutMutex($queue) {
 		$list = QueuedJobDescriptor::get()

Unused Use Statements -2 removed lines

@@ -1,7 +1,5 @@
 <?php
 
-use AsyncPHP\Doorman\Rule;
-
 /**
  * Runs all jobs through the doorman engine
  */

code/services/QueuedJobService.php

Doc Comments +7 added lines, -3 removed lines

@@ -162,7 +162,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) {
@@ -178,7 +178,7 @@ 
 	 * Copies data from a job into a descriptor for persisting
 	 *
 	 * @param QueuedJob $job
-	 * @param JobDescriptor $jobDescriptor
+	 * @param DataObject $jobDescriptor
 	 */
 	protected function copyJobToDescriptor($job, $jobDescriptor) {
 		$data = $job->getJobData();
@@ -322,6 +322,7 @@ 
 
 	/**
 	 * Checks through all the scheduled jobs that are expected to exist
+	 * @param string $queue
 	 */
 	public function checkdefaultJobs($queue = null) {
 		$queue = $queue ?: QueuedJob::QUEUED;
@@ -375,7 +376,7 @@ 
 	 * Attempt to restart a stalled job
 	 *
 	 * @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) {
 		if ($stalledJob->ResumeCounts < Config::inst()->get(__CLASS__, 'stall_threshold')) {
@@ -791,6 +792,9 @@ 
 		}
 	}
 
+	/**
+	 * @param double $size
+	 */
 	protected function humanReadable($size) {
 		$filesizename = array(" Bytes", " KB", " MB", " GB", " TB", " PB", " EB", " ZB", " YB");
 		return $size ? round($size/pow(1024, ($i = floor(log($size, 1024)))), 2) . $filesizename[$i] : '0 Bytes';