Version 4.1.19

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

@@ -2,9 +2,9 @@
 /**
  * @brief		Background Task
  * @author		<a href='http://www.invisionpower.com'>Invision Power Services, Inc.</a>
- * @copyright	(c) 2001 - SVN_YYYY Invision Power Services, Inc.
+ * @copyright	(c) 2001 - 2016 Invision Power Services, Inc.
  * @license		http://www.invisionpower.com/legal/standards/
- * @package		IPS Social Suite
+ * @package		IPS Community Suite
 {subpackage}
  * @since		{date}
  * @version		SVN_VERSION_NUMBER
@@ -24,13 +24,24 @@ if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
  */
 class _{class}
 {
+	/**
+	 * Parse data before queuing
+	 *
+	 * @param	array	$data
+	 * @return	array
+	 */
+	public function preQueueData( $data )
+	{
+		return $data;
+	}
+
 	/**
 	 * Run Background Task
 	 *
-	 * @param	mixed					$data	Data as it was passed to \IPS\Task::queue()
-	 * @param	int						$offset	Offset
-	 * @return	int|null				New offset or NULL if complete
-	 * @throws	\OutOfRangeException	Indicates offset doesn't exist and thus task is complete
+	 * @param	mixed						$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
 	 */
 	public function run( $data, $offset )
 	{
@@ -42,11 +53,22 @@ class _{class}
 	 *
 	 * @param	mixed					$data	Data as it was passed to \IPS\Task::queue()
 	 * @param	int						$offset	Offset
-	 * @return	array( 'text' => 'Doing something...', 'complete' => 50 )	Text explaning task and percentage complete
+	 * @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
 	 */
 	public function getProgress( $data, $offset )
 	{
 		return array( 'text' => 'Doing something...', 'complete' => 50 );
-	}	
+	}
+
+	/**
+	 * Perform post-completion processing
+	 *
+	 * @param	array	$data
+	 * @return	void
+	 */
+	public function postComplete( $data )
+	{
+
+	}
 }