Version 5.0.0 beta 1

applications/cms/extensions/core/Queue/RebuildReciprocalMaps.php

@@ -12,40 +12,51 @@
 namespace IPS\cms\extensions\core\Queue;
 
 /* To prevent PHP errors (extending class does not exist) revealing path */
-if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
+
+use Exception;
+use IPS\cms\Databases;
+use IPS\cms\Fields;
+use IPS\Db;
+use IPS\Extensions\QueueAbstract;
+use IPS\Member;
+use OutOfRangeException;
+use function defined;
+use const IPS\REBUILD_QUICK;
+
+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: Rebuild database reciprocal maps
  */
-class _RebuildReciprocalMaps
+class RebuildReciprocalMaps extends QueueAbstract
 {
 	/**
 	 * @brief Number of content items to rebuild per cycle
 	 */
-	public $rebuild	= \IPS\REBUILD_QUICK;
+	public int $rebuild	= REBUILD_QUICK;
 	
 	/**
 	 * Parse data before queuing
 	 *
 	 * @param	array	$data
-	 * @return	array
+	 * @return	array|null
 	 */
-	public function preQueueData( $data )
+	public function preQueueData( array $data ): ?array
 	{
 		$databaseId = $data['database'];
 		$fieldId    = $data['field'];
 
 		try
 		{
-			$data['count'] = (int) \IPS\Db::i()->select( 'COUNT(*)', 'cms_custom_database_' . $databaseId, array( 'field_' . $fieldId . ' != \'\' or field_' . $fieldId . ' IS NOT NULL' ) )->first();
+			$data['count'] = (int) Db::i()->select( 'COUNT(*)', 'cms_custom_database_' . $databaseId, array( 'field_' . $fieldId . ' != \'\' or field_' . $fieldId . ' IS NOT NULL' ) )->first();
 		}
-		catch( \Exception $ex )
+		catch( Exception $ex )
 		{
-			throw new \OutOfRangeException;
+			throw new OutOfRangeException;
 		}
 		
 		if( $data['count'] == 0 )
@@ -57,26 +68,27 @@ class _RebuildReciprocalMaps
 
 		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 or NULL if complete
 	 */
-	public function run( &$data, $offset )
+	public function run( mixed &$data, int $offset ): int
 	{
 		$databaseId	= $data['database'];
 		$fieldId	= $data['field'];
 		$last		= NULL;
 		
-		if ( \IPS\Db::i()->checkForTable( 'cms_custom_database_' . $databaseId ) )
+		if ( Db::i()->checkForTable( 'cms_custom_database_' . $databaseId ) )
 		{
+			/* @var Fields $fieldsClass */
 			$fieldsClass = 'IPS\cms\Fields' . $databaseId;
 			$field = $fieldsClass::load( $fieldId );
 		
-			foreach ( \IPS\Db::i()->select( '*', 'cms_custom_database_' . $databaseId, array( 'primary_id_field > ? AND (field_' . $fieldId . ' != \'\' or field_' . $fieldId . ' IS NOT NULL)', $offset ), 'primary_id_field asc', array( 0, $this->rebuild ) ) as $row )
+			foreach ( Db::i()->select( '*', 'cms_custom_database_' . $databaseId, array( 'primary_id_field > ? AND (field_' . $fieldId . ' != \'\' or field_' . $fieldId . ' IS NOT NULL)', $offset ), 'primary_id_field asc', array( 0, $this->rebuild ) ) as $row )
 			{
 				$extra = $field->extra;
 				if ( $row[ 'field_' . $fieldId ] and ! empty( $extra['database'] ) )
@@ -85,7 +97,7 @@ class _RebuildReciprocalMaps
 					{
 						if ( $foreignId )
 						{
-							\IPS\Db::i()->insert( 'cms_database_fields_reciprocal_map', array(
+							Db::i()->insert( 'cms_database_fields_reciprocal_map', array(
 								'map_origin_database_id'	=> $databaseId,
 								'map_foreign_database_id'   => $extra['database'],
 								'map_origin_item_id'		=> $row['primary_id_field'],
@@ -115,11 +127,11 @@ class _RebuildReciprocalMaps
 	 * @param	mixed					$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 )
+	public function getProgress( mixed $data, int $offset ): array
 	{
 		$databaseId = $data['database'];
-		return array( 'text' => \IPS\Member::loggedIn()->language()->addToStack('rebuilding_cms_database_reciprocal_map', FALSE, array( 'sprintf' => array( \IPS\cms\Databases::load( $databaseId )->_title, $data['field'] ) ) ), 'complete' => $data['count'] ? ( round( 100 / $data['count'] * $data['completed'], 2 ) ) : 100 );
+		return array( 'text' => Member::loggedIn()->language()->addToStack('rebuilding_cms_database_reciprocal_map', FALSE, array( 'sprintf' => array( Databases::load( $databaseId )->_title, $data['field'] ) ) ), 'complete' => $data['count'] ? ( round( 100 / $data['count'] * $data['completed'], 2 ) ) : 100 );
 	}	
 }