WordPoints / importer

src/admin/screens/importing.php

Indentation +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
  */
 
 if ( true !== current_user_can( 'manage_options' ) ) {
-	wp_die();
+    wp_die();
 }
 
 check_admin_referer( 'wordpoints_import' );

tests/phpunit/includes/activate-cubepoints-components.php

Indentation +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
  */
 
 foreach ( $data as $module_slug ) {
-	cp_module_activation_set( $module_slug, 'active' );
+    cp_module_activation_set( $module_slug, 'active' );
 }
 
 // EOF

tests/codeception/_support/AcceptanceTester.php

Indentation +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
  * @since 1.0.0
  */
 class AcceptanceTester extends \WordPoints\Tests\Codeception\AcceptanceTester {
-	// Add any methods here that you want.
+    // Add any methods here that you want.
 }
 
 // EOF

src/importer.php

Indentation +8 added lines, -8 removed lines

@@ -27,7 +27,7 @@ 
  */
 
 wordpoints_register_extension(
-	'
+    '
 		Extension Name: Importer
 		Author:         J.D. Grimes
 		Author URI:     https://codesymphony.co/
@@ -41,7 +41,7 @@ 
 		ID:             430
 		Namespace:      Importer
 	'
-	, __FILE__
+    , __FILE__
 );
 
 WordPoints_Class_Autoloader::register_dir( dirname( __FILE__ ) . '/includes' );
@@ -55,12 +55,12 @@ 
 
 if ( is_admin() ) {
 
-	/**
-	 * The extension's admin-side code.
-	 *
-	 * @since 1.0.0
-	 */
-	require_once dirname( __FILE__ ) . '/admin/admin.php';
+    /**
+     * The extension's admin-side code.
+     *
+     * @since 1.0.0
+     */
+    require_once dirname( __FILE__ ) . '/admin/admin.php';
 }
 
 // EOF

src/admin/admin.php

Indentation +107 added lines, -107 removed lines

@@ -14,23 +14,23 @@ 
  */
 function wordpoints_importer_admin_menu() {
 
-	add_submenu_page(
-		wordpoints_get_main_admin_menu()
-		,__( 'WordPoints — Import', 'wordpoints-importer' )
-		,__( 'Import', 'wordpoints-importer' )
-		,'manage_options'
-		,'wordpoints_import'
-		,'wordpoints_import_admin_screen'
-	);
-
-	add_submenu_page(
-		'_wordpoints_import' // Fake.
-		,__( 'WordPoints — Importing', 'wordpoints-importer' )
-		,__( 'Importing', 'wordpoints-importer' )
-		,'manage_options'
-		,'wordpoints_importing'
-		,'wordpoints_importing_admin_screen'
-	);
+    add_submenu_page(
+        wordpoints_get_main_admin_menu()
+        ,__( 'WordPoints — Import', 'wordpoints-importer' )
+        ,__( 'Import', 'wordpoints-importer' )
+        ,'manage_options'
+        ,'wordpoints_import'
+        ,'wordpoints_import_admin_screen'
+    );
+
+    add_submenu_page(
+        '_wordpoints_import' // Fake.
+        ,__( 'WordPoints — Importing', 'wordpoints-importer' )
+        ,__( 'Importing', 'wordpoints-importer' )
+        ,'manage_options'
+        ,'wordpoints_importing'
+        ,'wordpoints_importing_admin_screen'
+    );
 }
 add_action( 'admin_menu', 'wordpoints_importer_admin_menu' );
 add_action( 'network_admin_menu', 'wordpoints_importer_admin_menu' );
@@ -42,12 +42,12 @@ 
  */
 function wordpoints_import_admin_screen() {
 
-	/**
-	 * The importer admin screen.
-	 *
-	 * @since 1.0.0
-	 */
-	require dirname( __FILE__ ) . '/screens/import.php';
+    /**
+     * The importer admin screen.
+     *
+     * @since 1.0.0
+     */
+    require dirname( __FILE__ ) . '/screens/import.php';
 }
 
 /**
@@ -57,12 +57,12 @@ 
  */
 function wordpoints_importing_admin_screen() {
 
-	/**
-	 * The importer admin screen.
-	 *
-	 * @since 1.0.0
-	 */
-	require dirname( __FILE__ ) . '/screens/importing.php';
+    /**
+     * The importer admin screen.
+     *
+     * @since 1.0.0
+     */
+    require dirname( __FILE__ ) . '/screens/importing.php';
 }
 
 /**
@@ -72,17 +72,17 @@ 
  */
 function wordpoints_importer_register_admin_scripts() {
 
-	$assets_url = wordpoints_extensions_url(
-		'admin/assets'
-		, dirname( dirname( __FILE__ ) ) . '/importer.php'
-	);
+    $assets_url = wordpoints_extensions_url(
+        'admin/assets'
+        , dirname( dirname( __FILE__ ) ) . '/importer.php'
+    );
 
-	$suffix = SCRIPT_DEBUG ? '' : '.min';
+    $suffix = SCRIPT_DEBUG ? '' : '.min';
 
-	wp_register_style(
-		'wordpoints-importer-feedback'
-		, "{$assets_url}/css/feedback{$suffix}.css"
-	);
+    wp_register_style(
+        'wordpoints-importer-feedback'
+        , "{$assets_url}/css/feedback{$suffix}.css"
+    );
 }
 add_action( 'init', 'wordpoints_importer_register_admin_scripts' );
 
@@ -93,41 +93,41 @@ 
  */
 function wordpoints_importer_do_import() {
 
-	if ( ! defined( 'IFRAME_REQUEST' ) ) {
-		define( 'IFRAME_REQUEST', true );
-	}
+    if ( ! defined( 'IFRAME_REQUEST' ) ) {
+        define( 'IFRAME_REQUEST', true );
+    }
 
-	if ( ! current_user_can( 'manage_options' ) ) {
-		wp_die( esc_html__( 'Sorry, you are not allowed to import to WordPoints.', 'wordpoints-importer' ) );
-	}
+    if ( ! current_user_can( 'manage_options' ) ) {
+        wp_die( esc_html__( 'Sorry, you are not allowed to import to WordPoints.', 'wordpoints-importer' ) );
+    }
 
-	check_admin_referer( 'wordpoints_import' );
+    check_admin_referer( 'wordpoints_import' );
 
-	if ( ! isset( $_GET['importer'] ) ) {
-		wp_die( esc_html__( 'No importer selected.', 'wordpoints-importer' ) );
-	}
+    if ( ! isset( $_GET['importer'] ) ) {
+        wp_die( esc_html__( 'No importer selected.', 'wordpoints-importer' ) );
+    }
 
-	$importer = WordPoints_Importers::get_importer(
-		sanitize_key( $_GET['importer'] )
-	);
+    $importer = WordPoints_Importers::get_importer(
+        sanitize_key( $_GET['importer'] )
+    );
 
-	if ( ! ( $importer instanceof WordPoints_Importer ) ) {
-		wp_die( esc_html__( 'Importer not installed.', 'wordpoints-importer' ) );
-	}
+    if ( ! ( $importer instanceof WordPoints_Importer ) ) {
+        wp_die( esc_html__( 'Importer not installed.', 'wordpoints-importer' ) );
+    }
 
-	wp_enqueue_style( 'wordpoints-importer-feedback' );
+    wp_enqueue_style( 'wordpoints-importer-feedback' );
 
-	$args = array();
+    $args = array();
 
-	if ( isset( $_GET['wordpoints_import'] ) && is_array( $_GET['wordpoints_import'] ) ) {
-		$args = wp_unslash( $_GET['wordpoints_import'] ); // WPCS: sanitization OK.
-	}
+    if ( isset( $_GET['wordpoints_import'] ) && is_array( $_GET['wordpoints_import'] ) ) {
+        $args = wp_unslash( $_GET['wordpoints_import'] ); // WPCS: sanitization OK.
+    }
 
-	iframe_header();
+    iframe_header();
 
-	$importer->do_import( $args );
+    $importer->do_import( $args );
 
-	iframe_footer();
+    iframe_footer();
 }
 add_action( 'update-custom_wordpoints_import', 'wordpoints_importer_do_import' );
 
@@ -138,9 +138,9 @@ 
  */
 function wordpoints_importer_admin_screen_points_type_select() {
 
-	$args = array( 'name' => 'wordpoints_import[points][_data][points_type]' );
+    $args = array( 'name' => 'wordpoints_import[points][_data][points_type]' );
 
-	?>
+    ?>
 
 	<p>
 		<label for="wordpoints_import[points][_data][points_type]">
@@ -152,8 +152,8 @@ 
 	<?php
 }
 add_action(
-	'wordpoints_importer_before_component_options-points'
-	, 'wordpoints_importer_admin_screen_points_type_select'
+    'wordpoints_importer_before_component_options-points'
+    , 'wordpoints_importer_admin_screen_points_type_select'
 );
 
 /**
@@ -169,24 +169,24 @@ 
  */
 function wordpoints_importer_validate_points_type_setting( $valid, $settings, $feedback ) {
 
-	if ( $valid ) {
+    if ( $valid ) {
 
-		if ( ! isset( $settings['points_type'] ) ) {
-			$feedback->warning( __( 'Skipping Points component—no points type specified.', 'wordpoints-importer' ) );
-			$valid = false;
-		} elseif ( ! wordpoints_is_points_type( $settings['points_type'] ) ) {
-			$feedback->warning( __( 'Skipping Points component—invalid points type selected.', 'wordpoints-importer' ) );
-			$valid = false;
-		}
-	}
+        if ( ! isset( $settings['points_type'] ) ) {
+            $feedback->warning( __( 'Skipping Points component—no points type specified.', 'wordpoints-importer' ) );
+            $valid = false;
+        } elseif ( ! wordpoints_is_points_type( $settings['points_type'] ) ) {
+            $feedback->warning( __( 'Skipping Points component—invalid points type selected.', 'wordpoints-importer' ) );
+            $valid = false;
+        }
+    }
 
-	return $valid;
+    return $valid;
 }
 add_action(
-	'wordpoints_import_settings_valid-points'
-	, 'wordpoints_importer_validate_points_type_setting'
-	, 10
-	, 3
+    'wordpoints_import_settings_valid-points'
+    , 'wordpoints_importer_validate_points_type_setting'
+    , 10
+    , 3
 );
 
 /**
@@ -196,20 +196,20 @@ 
  */
 function wordpoints_importer_admin_screen_rank_group_select() {
 
-	$rank_groups = WordPoints_Rank_Groups::get();
+    $rank_groups = WordPoints_Rank_Groups::get();
 
-	// See https://github.com/WordPoints/wordpoints/issues/310.
-	$options = array();
-	foreach ( $rank_groups as $rank_group ) {
-		$options[ $rank_group->slug ] = $rank_group->name;
-	}
+    // See https://github.com/WordPoints/wordpoints/issues/310.
+    $options = array();
+    foreach ( $rank_groups as $rank_group ) {
+        $options[ $rank_group->slug ] = $rank_group->name;
+    }
 
-	$dropdown = new WordPoints_Dropdown_Builder(
-		$options
-		, array( 'name' => 'wordpoints_import[ranks][_data][rank_group]' )
-	);
+    $dropdown = new WordPoints_Dropdown_Builder(
+        $options
+        , array( 'name' => 'wordpoints_import[ranks][_data][rank_group]' )
+    );
 
-	?>
+    ?>
 
 	<p>
 		<label for="wordpoints_import[ranks][_data][rank_group]">
@@ -221,8 +221,8 @@ 
 <?php
 }
 add_action(
-	'wordpoints_importer_before_component_options-ranks'
-	, 'wordpoints_importer_admin_screen_rank_group_select'
+    'wordpoints_importer_before_component_options-ranks'
+    , 'wordpoints_importer_admin_screen_rank_group_select'
 );
 
 /**
@@ -238,24 +238,24 @@ 
  */
 function wordpoints_importer_validate_rank_group_setting( $valid, $settings, $feedback ) {
 
-	if ( $valid ) {
+    if ( $valid ) {
 
-		if ( ! isset( $settings['rank_group'] ) ) {
-			$feedback->warning( __( 'Skipping Ranks component—no rank group specified.', 'wordpoints-importer' ) );
-			$valid = false;
-		} elseif ( ! WordPoints_Rank_Groups::is_group_registered( $settings['rank_group'] ) ) {
-			$feedback->warning( __( 'Skipping Ranks component—invalid rank group selected.', 'wordpoints-importer' ) );
-			$valid = false;
-		}
-	}
+        if ( ! isset( $settings['rank_group'] ) ) {
+            $feedback->warning( __( 'Skipping Ranks component—no rank group specified.', 'wordpoints-importer' ) );
+            $valid = false;
+        } elseif ( ! WordPoints_Rank_Groups::is_group_registered( $settings['rank_group'] ) ) {
+            $feedback->warning( __( 'Skipping Ranks component—invalid rank group selected.', 'wordpoints-importer' ) );
+            $valid = false;
+        }
+    }
 
-	return $valid;
+    return $valid;
 }
 add_action(
-	'wordpoints_import_settings_valid-ranks'
-	, 'wordpoints_importer_validate_rank_group_setting'
-	, 10
-	, 3
+    'wordpoints_import_settings_valid-ranks'
+    , 'wordpoints_importer_validate_rank_group_setting'
+    , 10
+    , 3
 );
 
 // EOF

src/admin/screens/import.php

Indentation +47 added lines, -47 removed lines

@@ -8,7 +8,7 @@ 
  */
 
 if ( true !== current_user_can( 'manage_options' ) ) {
-	wp_die();
+    wp_die();
 }
 
 $tabs = array( 'unavailable' => __( 'Unavailable', 'wordpoints-importer' ) );
@@ -16,19 +16,19 @@ 
 
 foreach ( WordPoints_Importers::get() as $slug => $args ) {
 
-	$importer = WordPoints_Importers::get_importer( $slug );
+    $importer = WordPoints_Importers::get_importer( $slug );
 
-	$is_available = $importer->is_available();
+    $is_available = $importer->is_available();
 
-	if ( is_wp_error( $is_available ) ) {
-		$unavailable[ $args['name'] ] = $is_available;
-	} else {
-		$tabs[ $slug ] = $args['name'];
-	}
+    if ( is_wp_error( $is_available ) ) {
+        $unavailable[ $args['name'] ] = $is_available;
+    } else {
+        $tabs[ $slug ] = $args['name'];
+    }
 }
 
 if ( empty( $unavailable ) ) {
-	unset( $tabs['unavailable'] );
+    unset( $tabs['unavailable'] );
 }
 
 $current_tab = wordpoints_admin_get_current_tab( $tabs );
@@ -51,14 +51,14 @@ 
 				<li>
 					<?php
 
-					printf(
-						/* translators: 1 is an importer name, 2 is the reason that it is unavailable. */
-						esc_html__( '%1$s — %2$s', 'wordpoints-importer' )
-						, '<strong>' . esc_html( $name ) . '</strong>'
-						, esc_html( $error->get_error_message() )
-					);
+                    printf(
+                        /* translators: 1 is an importer name, 2 is the reason that it is unavailable. */
+                        esc_html__( '%1$s — %2$s', 'wordpoints-importer' )
+                        , '<strong>' . esc_html( $name ) . '</strong>'
+                        , esc_html( $error->get_error_message() )
+                    );
 
-					?>
+                    ?>
 				</li>
 			<?php endforeach; ?>
 		</ul>
@@ -74,39 +74,39 @@ 
 
 				<?php
 
-				if ( ! $importer->supports_component( $slug ) ) {
-					continue;
-				}
+                if ( ! $importer->supports_component( $slug ) ) {
+                    continue;
+                }
 
-				$supported = true;
+                $supported = true;
 
-				?>
+                ?>
 
 				<h3><?php echo esc_html( $component['name'] ); ?></h3>
 
 				<?php
 
-				/**
-				 * Before the import option fields for a component.
-				 *
-				 * @since 1.0.0
-				 */
-				do_action( "wordpoints_importer_before_component_options-{$slug}" );
+                /**
+                 * Before the import option fields for a component.
+                 *
+                 * @since 1.0.0
+                 */
+                do_action( "wordpoints_importer_before_component_options-{$slug}" );
 
-				?>
+                ?>
 
 				<?php foreach ( $importer->get_options_for_component( $slug ) as $name => $option ) : ?>
 
 					<?php
 
-					$can_import = true;
+                    $can_import = true;
 
-					// Check if this option is available.
-					if ( isset( $option['can_import'] ) ) {
-						$can_import = call_user_func( $option['can_import'], array() );
-					}
+                    // Check if this option is available.
+                    if ( isset( $option['can_import'] ) ) {
+                        $can_import = call_user_func( $option['can_import'], array() );
+                    }
 
-					?>
+                    ?>
 
 					<label for="wordpoints_import[<?php echo esc_attr( $slug ); ?>][<?php echo esc_attr( $name ); ?>]">
 						<input type="checkbox" value="1" id="wordpoints_import[<?php echo esc_attr( $slug ); ?>][<?php echo esc_attr( $name ); ?>]" name="wordpoints_import[<?php echo esc_attr( $slug ); ?>][<?php echo esc_attr( $name ); ?>]" <?php disabled( is_wp_error( $can_import ), true ); ?> />
@@ -116,10 +116,10 @@ 
 							<em>
 								<?php
 
-								// translators: Error message explaining the reason why the importer is disabled.
-								printf( esc_html__( 'Disabled (%s)', 'wordpoints-importer' ), esc_html( $can_import->get_error_message() ) );
+                                // translators: Error message explaining the reason why the importer is disabled.
+                                printf( esc_html__( 'Disabled (%s)', 'wordpoints-importer' ), esc_html( $can_import->get_error_message() ) );
 
-								?>
+                                ?>
 							</em>
 						<?php endif; ?>
 					</label>
@@ -140,20 +140,20 @@ 
 
 			<?php
 
-			if ( ! isset( $supported ) ) {
+            if ( ! isset( $supported ) ) {
 
-				esc_html_e(
-					'This importer does not support any of the installed components.'
-					, 'wordpoints-importer'
-				);
+                esc_html_e(
+                    'This importer does not support any of the installed components.'
+                    , 'wordpoints-importer'
+                );
 
-			} else {
+            } else {
 
-				wp_nonce_field( 'wordpoints_import' );
-				submit_button( __( 'Import', 'wordpoints-importer' ) );
-			}
+                wp_nonce_field( 'wordpoints_import' );
+                submit_button( __( 'Import', 'wordpoints-importer' ) );
+            }
 
-			?>
+            ?>
 		</form>
 	<?php endif; ?>
 </div>

src/includes/class-importer.php

Indentation +231 added lines, -231 removed lines

@@ -14,237 +14,237 @@
  */
 abstract class WordPoints_Importer {
 
-	/**
-	 * The name of the importer.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @type string $name
-	 */
-	protected $name;
-
-	/**
-	 * The components supported by this importer.
-	 *
-	 * The keys are the component slugs, the values arrays of options for importing
-	 * to that component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @type array[] $components
-	 */
-	protected $components = array();
-
-	/**
-	 * The feedback provider object.
-	 *
-	 * This is only set by self::do_import().
-	 *
-	 * @since 1.0.0
-	 *
-	 * @type WordPoints_Importer_Feedback $feedback
-	 */
-	protected $feedback;
-
-	/**
-	 * Check if this importer is available.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @return true|WP_Error A WP_Error if the importer is not available.
-	 */
-	abstract public function is_available();
-
-	/**
-	 * Construct the importer.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $name The name of the importer.
-	 */
-	public function __construct( $name ) {
-
-		$this->name = $name;
-	}
-
-	/**
-	 * Check if this importer supports a specific component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $component The slug of a component.
-	 *
-	 * @return bool True if the component is supported, otherwise false.
-	 */
-	public function supports_component( $component ) {
-
-		return isset( $this->components[ $component ] );
-	}
-
-	/**
-	 * Get the import options for a component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $component The slug of a component.
-	 *
-	 * @return array[] The options for this component.
-	 */
-	public function get_options_for_component( $component ) {
-
-		if ( ! $this->supports_component( $component ) ) {
-			return array();
-		}
-
-		return $this->components[ $component ];
-	}
-
-	/**
-	 * Run the import.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array                        $args     The settings for the import.
-	 * @param WordPoints_Importer_Feedback $feedback The feedback object.
-	 */
-	public function do_import( array $args, $feedback = null ) {
-
-		if ( ! ( $feedback instanceof WordPoints_Importer_Feedback ) ) {
-			$feedback = new WordPoints_Importer_Feedback();
-		}
-
-		$this->feedback = $feedback;
-
-		// translators: Plugin name.
-		$this->feedback->info( sprintf( __( 'Importing from %s…', 'wordpoints-importer' ), $this->name ) );
-
-		$this->no_interruptions();
-
-		foreach ( $args as $component => $options ) {
-			$this->do_import_for_component( $component, $options );
-		}
-
-		$this->feedback->info( __( 'Import complete.', 'wordpoints-importer' ) );
-	}
-
-	/**
-	 * Prevent any interruptions from occurring during the import.
-	 *
-	 * @since 1.2.1
-	 */
-	protected function no_interruptions() {
-
-		wordpoints_prevent_interruptions();
-	}
-
-	/**
-	 * Validate the import settings for a component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $component The slug of the component.
-	 * @param array  $settings  The settings supplied for this component.
-	 *
-	 * @return bool Whether the settings are valid.
-	 */
-	protected function validate_import_settings( $component, $settings ) {
-
-		/**
-		 * Filter whether the settings are valid before importing.
-		 *
-		 * @since 1.0.0
-		 *
-		 * @param bool  $valid    Whether the settings are valid.
-		 * @param array $settings The settings for this component.
-		 * @param WordPoints_Importer_Feedback $feedback The feedback object.
-		 */
-		return apply_filters( "wordpoints_import_settings_valid-{$component}", true, $settings, $this->feedback );
-	}
-
-	/**
-	 * Run the import for a component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $component The component to run the import for.
-	 * @param array  $options   The selected options of what to import.
-	 */
-	protected function do_import_for_component( $component, $options ) {
-
-		$component_data = WordPoints_Components::instance()->get_component(
-			$component
-		);
-
-		if ( false === $component_data ) {
-			// translators: Component name.
-			$this->feedback->warning( sprintf( __( 'Skipping %s component—not installed.', 'wordpoints-importer' ), esc_html( $component ) ) );
-			return;
-		}
-
-		if ( true !== $this->supports_component( $component ) ) {
-			// translators: Component name.
-			$this->feedback->warning( sprintf( __( 'Skipping the %s component—not supported.', 'wordpoints-importer' ), $component_data['name'] ) );
-			return;
-		}
-
-		$settings = array();
-
-		if ( isset( $options['_data'] ) ) {
-			$settings = $options['_data'];
-			unset( $options['_data'] );
-		}
-
-		if ( empty( $options ) || ! $this->validate_import_settings( $component, $settings ) ) {
-			return;
-		}
-
-		// translators: Component name.
-		$this->feedback->info( sprintf( __( 'Importing data to the %s component…', 'wordpoints-importer' ), $component_data['name'] ) );
-
-		foreach ( $options as $option => $unused ) {
-			$this->do_import_for_option( $option, $component, $settings );
-		}
-	}
-
-	/**
-	 * Run the import for an option.
-	 *
-	 * The import is split up into different options which the user can select (these
-	 * are displayed to the user as checkboxes in the form). This handles the import
-	 * for each of the individual things the user has selected to import. These are
-	 * all optional, so each is just termed an import "option" here.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $option    An import option that has been selected.
-	 * @param string $component The component this option is for.
-	 * @param array  $settings  Other settings for this component.
-	 */
-	protected function do_import_for_option( $option, $component, $settings ) {
-
-		if ( ! isset( $this->components[ $component ][ $option ] ) ) {
-			// translators: Option name.
-			$this->feedback->warning( sprintf( __( 'Skipping unrecognized import option “%s”…', 'wordpoints-importer' ), $option ) );
-			return;
-		}
-
-		$option_data = $this->components[ $component ][ $option ];
-
-		// Check if we can actually run this option.
-		if ( isset( $option_data['can_import'] ) ) {
-
-			$cant_import = call_user_func( $option_data['can_import'], $settings );
-
-			if ( is_wp_error( $cant_import ) ) {
-				// translators: 1. Option name; 2. Reason the import was skipped.
-				$this->feedback->warning( sprintf( __( 'Skipping importing %1$s. Reason: %2$s', 'wordpoints-importer' ), $option_data['label'], $cant_import->get_error_message() ) );
-				return;
-			}
-		}
-
-		// OK, we can run the import method for this option.
-		call_user_func( $option_data['function'], $settings );
-	}
+    /**
+     * The name of the importer.
+     *
+     * @since 1.0.0
+     *
+     * @type string $name
+     */
+    protected $name;
+
+    /**
+     * The components supported by this importer.
+     *
+     * The keys are the component slugs, the values arrays of options for importing
+     * to that component.
+     *
+     * @since 1.0.0
+     *
+     * @type array[] $components
+     */
+    protected $components = array();
+
+    /**
+     * The feedback provider object.
+     *
+     * This is only set by self::do_import().
+     *
+     * @since 1.0.0
+     *
+     * @type WordPoints_Importer_Feedback $feedback
+     */
+    protected $feedback;
+
+    /**
+     * Check if this importer is available.
+     *
+     * @since 1.0.0
+     *
+     * @return true|WP_Error A WP_Error if the importer is not available.
+     */
+    abstract public function is_available();
+
+    /**
+     * Construct the importer.
+     *
+     * @since 1.0.0
+     *
+     * @param string $name The name of the importer.
+     */
+    public function __construct( $name ) {
+
+        $this->name = $name;
+    }
+
+    /**
+     * Check if this importer supports a specific component.
+     *
+     * @since 1.0.0
+     *
+     * @param string $component The slug of a component.
+     *
+     * @return bool True if the component is supported, otherwise false.
+     */
+    public function supports_component( $component ) {
+
+        return isset( $this->components[ $component ] );
+    }
+
+    /**
+     * Get the import options for a component.
+     *
+     * @since 1.0.0
+     *
+     * @param string $component The slug of a component.
+     *
+     * @return array[] The options for this component.
+     */
+    public function get_options_for_component( $component ) {
+
+        if ( ! $this->supports_component( $component ) ) {
+            return array();
+        }
+
+        return $this->components[ $component ];
+    }
+
+    /**
+     * Run the import.
+     *
+     * @since 1.0.0
+     *
+     * @param array                        $args     The settings for the import.
+     * @param WordPoints_Importer_Feedback $feedback The feedback object.
+     */
+    public function do_import( array $args, $feedback = null ) {
+
+        if ( ! ( $feedback instanceof WordPoints_Importer_Feedback ) ) {
+            $feedback = new WordPoints_Importer_Feedback();
+        }
+
+        $this->feedback = $feedback;
+
+        // translators: Plugin name.
+        $this->feedback->info( sprintf( __( 'Importing from %s…', 'wordpoints-importer' ), $this->name ) );
+
+        $this->no_interruptions();
+
+        foreach ( $args as $component => $options ) {
+            $this->do_import_for_component( $component, $options );
+        }
+
+        $this->feedback->info( __( 'Import complete.', 'wordpoints-importer' ) );
+    }
+
+    /**
+     * Prevent any interruptions from occurring during the import.
+     *
+     * @since 1.2.1
+     */
+    protected function no_interruptions() {
+
+        wordpoints_prevent_interruptions();
+    }
+
+    /**
+     * Validate the import settings for a component.
+     *
+     * @since 1.0.0
+     *
+     * @param string $component The slug of the component.
+     * @param array  $settings  The settings supplied for this component.
+     *
+     * @return bool Whether the settings are valid.
+     */
+    protected function validate_import_settings( $component, $settings ) {
+
+        /**
+         * Filter whether the settings are valid before importing.
+         *
+         * @since 1.0.0
+         *
+         * @param bool  $valid    Whether the settings are valid.
+         * @param array $settings The settings for this component.
+         * @param WordPoints_Importer_Feedback $feedback The feedback object.
+         */
+        return apply_filters( "wordpoints_import_settings_valid-{$component}", true, $settings, $this->feedback );
+    }
+
+    /**
+     * Run the import for a component.
+     *
+     * @since 1.0.0
+     *
+     * @param string $component The component to run the import for.
+     * @param array  $options   The selected options of what to import.
+     */
+    protected function do_import_for_component( $component, $options ) {
+
+        $component_data = WordPoints_Components::instance()->get_component(
+            $component
+        );
+
+        if ( false === $component_data ) {
+            // translators: Component name.
+            $this->feedback->warning( sprintf( __( 'Skipping %s component—not installed.', 'wordpoints-importer' ), esc_html( $component ) ) );
+            return;
+        }
+
+        if ( true !== $this->supports_component( $component ) ) {
+            // translators: Component name.
+            $this->feedback->warning( sprintf( __( 'Skipping the %s component—not supported.', 'wordpoints-importer' ), $component_data['name'] ) );
+            return;
+        }
+
+        $settings = array();
+
+        if ( isset( $options['_data'] ) ) {
+            $settings = $options['_data'];
+            unset( $options['_data'] );
+        }
+
+        if ( empty( $options ) || ! $this->validate_import_settings( $component, $settings ) ) {
+            return;
+        }
+
+        // translators: Component name.
+        $this->feedback->info( sprintf( __( 'Importing data to the %s component…', 'wordpoints-importer' ), $component_data['name'] ) );
+
+        foreach ( $options as $option => $unused ) {
+            $this->do_import_for_option( $option, $component, $settings );
+        }
+    }
+
+    /**
+     * Run the import for an option.
+     *
+     * The import is split up into different options which the user can select (these
+     * are displayed to the user as checkboxes in the form). This handles the import
+     * for each of the individual things the user has selected to import. These are
+     * all optional, so each is just termed an import "option" here.
+     *
+     * @since 1.0.0
+     *
+     * @param string $option    An import option that has been selected.
+     * @param string $component The component this option is for.
+     * @param array  $settings  Other settings for this component.
+     */
+    protected function do_import_for_option( $option, $component, $settings ) {
+
+        if ( ! isset( $this->components[ $component ][ $option ] ) ) {
+            // translators: Option name.
+            $this->feedback->warning( sprintf( __( 'Skipping unrecognized import option “%s”…', 'wordpoints-importer' ), $option ) );
+            return;
+        }
+
+        $option_data = $this->components[ $component ][ $option ];
+
+        // Check if we can actually run this option.
+        if ( isset( $option_data['can_import'] ) ) {
+
+            $cant_import = call_user_func( $option_data['can_import'], $settings );
+
+            if ( is_wp_error( $cant_import ) ) {
+                // translators: 1. Option name; 2. Reason the import was skipped.
+                $this->feedback->warning( sprintf( __( 'Skipping importing %1$s. Reason: %2$s', 'wordpoints-importer' ), $option_data['label'], $cant_import->get_error_message() ) );
+                return;
+            }
+        }
+
+        // OK, we can run the import method for this option.
+        call_user_func( $option_data['function'], $settings );
+    }
 }
 
 // EOF

src/includes/class-feedback.php

Indentation +66 added lines, -66 removed lines

@@ -16,84 +16,84 @@
  */
 class WordPoints_Importer_Feedback {
 
-	/**
-	 * Send an info message.
-	 *
-	 * Use this to give the user any info that wouldn't be handles by the other
-	 * methods.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $message The info message.
-	 */
-	public function info( $message ) {
-		$this->_send( $message, 'info' );
-	}
+    /**
+     * Send an info message.
+     *
+     * Use this to give the user any info that wouldn't be handles by the other
+     * methods.
+     *
+     * @since 1.0.0
+     *
+     * @param string $message The info message.
+     */
+    public function info( $message ) {
+        $this->_send( $message, 'info' );
+    }
 
-	/**
-	 * Send a success message.
-	 *
-	 * Use this when you want to let the user know that something was a success.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $message The success message.
-	 */
-	public function success( $message ) {
-		$this->_send( $message, 'success' );
-	}
+    /**
+     * Send a success message.
+     *
+     * Use this when you want to let the user know that something was a success.
+     *
+     * @since 1.0.0
+     *
+     * @param string $message The success message.
+     */
+    public function success( $message ) {
+        $this->_send( $message, 'success' );
+    }
 
-	/**
-	 * Send an error message.
-	 *
-	 * Use this when you want to let the user know that there was an error.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $message The error message.
-	 */
-	public function error( $message ) {
-		$this->_send( $message, 'error' );
-	}
+    /**
+     * Send an error message.
+     *
+     * Use this when you want to let the user know that there was an error.
+     *
+     * @since 1.0.0
+     *
+     * @param string $message The error message.
+     */
+    public function error( $message ) {
+        $this->_send( $message, 'error' );
+    }
 
-	/**
-	 * Send a warning message.
-	 *
-	 * Use this to warn the user about something. A warning doesn't necessarily imply
-	 * an error, but that something unexpected has occured that the user might need
-	 * to know.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $message The warning message.
-	 */
-	public function warning( $message ) {
-		$this->_send( $message, 'warning' );
-	}
+    /**
+     * Send a warning message.
+     *
+     * Use this to warn the user about something. A warning doesn't necessarily imply
+     * an error, but that something unexpected has occured that the user might need
+     * to know.
+     *
+     * @since 1.0.0
+     *
+     * @param string $message The warning message.
+     */
+    public function warning( $message ) {
+        $this->_send( $message, 'warning' );
+    }
 
-	//
-	// Protected Methods.
-	//
+    //
+    // Protected Methods.
+    //
 
-	/**
-	 * Send a message to the user.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $message The feedback message.
-	 * @param string $type    The type of message: 'info' (defuault), 'sucess',
-	 *                        'error', 'warning'.
-	 */
-	protected function _send( $message, $type = 'info' ) { // @codingStandardsIgnoreLine
+    /**
+     * Send a message to the user.
+     *
+     * @since 1.0.0
+     *
+     * @param string $message The feedback message.
+     * @param string $type    The type of message: 'info' (defuault), 'sucess',
+     *                        'error', 'warning'.
+     */
+    protected function _send( $message, $type = 'info' ) { // @codingStandardsIgnoreLine
 
-		?>
+        ?>
 
 		<p class="wordpoints-feedback wordpoints-feedback-<?php echo esc_attr( $type ); ?>">
 			<?php echo wp_kses( $message, 'wordpoints_importer_feedback' ); ?>
 		</p>
 
 		<?php
-	}
+    }
 }
 
 // EOF

src/includes/functions.php

Indentation +10 added lines, -10 removed lines

@@ -15,12 +15,12 @@ 
  */
 function wordpoints_importer_load_textdomain() {
 
-	_deprecated_function( __FUNCTION__, '1.3.0' );
+    _deprecated_function( __FUNCTION__, '1.3.0' );
 
-	wordpoints_load_module_textdomain(
-		'wordpoints-importer'
-		, wordpoints_module_basename( dirname( dirname( __FILE__ ) ) ) . '/languages'
-	);
+    wordpoints_load_module_textdomain(
+        'wordpoints-importer'
+        , wordpoints_module_basename( dirname( dirname( __FILE__ ) ) ) . '/languages'
+    );
 }
 
 /**
@@ -30,12 +30,12 @@ 
  */
 function wordpoints_importer_register_importers() {
 
-	$args = array(
-		'class' => 'WordPoints_CubePoints_Importer',
-		'name'  => __( 'CubePoints', 'wordpoints-importer' ),
-	);
+    $args = array(
+        'class' => 'WordPoints_CubePoints_Importer',
+        'name'  => __( 'CubePoints', 'wordpoints-importer' ),
+    );
 
-	WordPoints_Importers::register( 'cubepoints', $args );
+    WordPoints_Importers::register( 'cubepoints', $args );
 }
 add_action( 'wordpoints_register_importers', 'wordpoints_importer_register_importers' );