Version 5.0.0 beta 1

applications/core/data/defaults/extensions/Queue.txt

@@ -11,25 +11,30 @@
 
 namespace IPS\{app}\extensions\core\Queue;
 
+use IPS\Extensions\QueueAbstract;
+use IPS\Task\Queue\OutOfRangeException as QueueOutOfRangeException;
+use OutOfRangeException;
+use function defined;
+
 /* To prevent PHP errors (extending class does not exist) revealing path */
-if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
+if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
 {
-	header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
+	header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
 	exit;
 }
 
 /**
  * Background Task
  */
-class _{class}
+class {class} extends QueueAbstract
 {
 	/**
 	 * Parse data before queuing
 	 *
 	 * @param	array	$data
-	 * @return	array
+	 * @return	array|null
 	 */
-	public function preQueueData( $data ): ?array
+	public function preQueueData( array $data ): ?array
 	{
 		return $data;
 	}
@@ -37,25 +42,25 @@ class _{class}
 	/**
 	 * Run Background Task
 	 *
-	 * @param	mixed						$data	Data as it was passed to \IPS\Task::queue()
+	 * @param	array						$data	Data as it was passed to \IPS\Task::queue()
 	 * @param	int							$offset	Offset
 	 * @return	int							New offset
-	 * @throws	\IPS\Task\Queue\OutOfRangeException	Indicates offset doesn't exist and thus task is complete
+	 * @throws	QueueOutOfRangeException	        Indicates offset doesn't exist and thus task is complete
 	 */
-	public function run( $data, $offset )
+	public function run( array &$data, int $offset ): int
 	{
-		
+		return $offset;
 	}
 	
 	/**
 	 * Get Progress
 	 *
-	 * @param	mixed					$data	Data as it was passed to \IPS\Task::queue()
+	 * @param	array					$data	Data as it was passed to \IPS\Task::queue()
 	 * @param	int						$offset	Offset
 	 * @return	array( 'text' => 'Doing something...', 'complete' => 50 )	Text explaining task and percentage complete
-	 * @throws	\OutOfRangeException	Indicates offset doesn't exist and thus task is complete
+	 * @throws	OutOfRangeException	Indicates offset doesn't exist and thus task is complete
 	 */
-	public function getProgress( $data, $offset ): array
+	public function getProgress( array $data, int $offset ): array
 	{
 		return array( 'text' => 'Doing something...', 'complete' => 50 );
 	}
@@ -67,7 +72,7 @@ class _{class}
 	 * @param	bool	$processed	Was anything processed or not? If preQueueData returns NULL, this will be FALSE.
 	 * @return	void
 	 */
-	public function postComplete( $data, $processed = TRUE )
+	public function postComplete( array $data, bool $processed = TRUE ) : void
 	{
 
 	}