WordPoints_Importer::__construct() - Code Metrics - WordPoints/importer - Measure and Improve Code Quality continuously with Scrutinizer

WordPoints_Importer::__construct() A
last analyzed 2017-10-04 20:46 UTC

↳ Parent: WordPoints_Importer

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

/**
 * Base class for the importers.
 *
 * @package WordPoints_Importer
 * @since 1.0.0
 */

/**
 * Represents an importer.
 *
 * @since 1.0.0
 */
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&hellip;', '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&hellip;', '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 &#8220;%s&#8221;&hellip;', '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


1		<?php
2
3		/**
4		* Base class for the importers.
5		*
6		* @package WordPoints_Importer
7		* @since 1.0.0
8		*/
9
10		/**
11		* Represents an importer.
12		*
13		* @since 1.0.0
14		*/
15		abstract class WordPoints_Importer {
16
17		/**
18		* The name of the importer.
19		*
20		* @since 1.0.0
21		*
22		* @type string $name
23		*/
24		protected $name;
25
26		/**
27		* The components supported by this importer.
28		*
29		* The keys are the component slugs, the values arrays of options for importing
30		* to that component.
31		*
32		* @since 1.0.0
33		*
34		* @type array[] $components
35		*/
36		protected $components = array();
37
38		/**
39		* The feedback provider object.
40		*
41		* This is only set by self::do_import().
42		*
43		* @since 1.0.0
44		*
45		* @type WordPoints_Importer_Feedback $feedback
46		*/
47		protected $feedback;
48
49		/**
50		* Check if this importer is available.
51		*
52		* @since 1.0.0
53		*
54		* @return true\|WP_Error A WP_Error if the importer is not available.
55		*/
56		abstract public function is_available();
57
58		/**
59		* Construct the importer.
60		*
61		* @since 1.0.0
62		*
63		* @param string $name The name of the importer.
64		*/
65		public function __construct( $name ) {
66
67		$this->name = $name;
68		}
69
70		/**
71		* Check if this importer supports a specific component.
72		*
73		* @since 1.0.0
74		*
75		* @param string $component The slug of a component.
76		*
77		* @return bool True if the component is supported, otherwise false.
78		*/
79		public function supports_component( $component ) {
80
81		return isset( $this->components[ $component ] );
82		}
83
84		/**
85		* Get the import options for a component.
86		*
87		* @since 1.0.0
88		*
89		* @param string $component The slug of a component.
90		*
91		* @return array[] The options for this component.
92		*/
93		public function get_options_for_component( $component ) {
94
95		if ( ! $this->supports_component( $component ) ) {
96		return array();
97		}
98
99		return $this->components[ $component ];
100		}
101
102		/**
103		* Run the import.
104		*
105		* @since 1.0.0
106		*
107		* @param array $args The settings for the import.
108		* @param WordPoints_Importer_Feedback $feedback The feedback object.
109		*/
110		public function do_import( array $args, $feedback = null ) {
111
112		if ( ! ( $feedback instanceof WordPoints_Importer_Feedback ) ) {
113		$feedback = new WordPoints_Importer_Feedback();
114		}
115
116		$this->feedback = $feedback;
117
118		// translators: Plugin name.
119		$this->feedback->info( sprintf( __( 'Importing from %s…', 'wordpoints-importer' ), $this->name ) );
120
121		$this->no_interruptions();
122
123		foreach ( $args as $component => $options ) {
124		$this->do_import_for_component( $component, $options );
125		}
126
127		$this->feedback->info( __( 'Import complete.', 'wordpoints-importer' ) );
128		}
129
130		/**
131		* Prevent any interruptions from occurring during the import.
132		*
133		* @since 1.2.1
134		*/
135		protected function no_interruptions() {
136
137		wordpoints_prevent_interruptions();
138		}
139
140		/**
141		* Validate the import settings for a component.
142		*
143		* @since 1.0.0
144		*
145		* @param string $component The slug of the component.
146		* @param array $settings The settings supplied for this component.
147		*
148		* @return bool Whether the settings are valid.
149		*/
150		protected function validate_import_settings( $component, $settings ) {
151
152		/**
153		* Filter whether the settings are valid before importing.
154		*
155		* @since 1.0.0
156		*
157		* @param bool $valid Whether the settings are valid.
158		* @param array $settings The settings for this component.
159		* @param WordPoints_Importer_Feedback $feedback The feedback object.
160		*/
161		return apply_filters( "wordpoints_import_settings_valid-{$component}", true, $settings, $this->feedback );
162		}
163
164		/**
165		* Run the import for a component.
166		*
167		* @since 1.0.0
168		*
169		* @param string $component The component to run the import for.
170		* @param array $options The selected options of what to import.
171		*/
172		protected function do_import_for_component( $component, $options ) {
173
174		$component_data = WordPoints_Components::instance()->get_component(
175		$component
176		);
177
178	View Code Duplication	if ( false === $component_data ) {
179		// translators: Component name.
180		$this->feedback->warning( sprintf( __( 'Skipping %s component—not installed.', 'wordpoints-importer' ), esc_html( $component ) ) );
181		return;
182		}
183
184	View Code Duplication	if ( true !== $this->supports_component( $component ) ) {
185		// translators: Component name.
186		$this->feedback->warning( sprintf( __( 'Skipping the %s component—not supported.', 'wordpoints-importer' ), $component_data['name'] ) );
187		return;
188		}
189
190		$settings = array();
191
192		if ( isset( $options['_data'] ) ) {
193		$settings = $options['_data'];
194		unset( $options['_data'] );
195		}
196
197		if ( empty( $options ) \|\| ! $this->validate_import_settings( $component, $settings ) ) {
198		return;
199		}
200
201		// translators: Component name.
202		$this->feedback->info( sprintf( __( 'Importing data to the %s component…', 'wordpoints-importer' ), $component_data['name'] ) );
203
204		foreach ( $options as $option => $unused ) {
205		$this->do_import_for_option( $option, $component, $settings );
206		}
207		}
208
209		/**
210		* Run the import for an option.
211		*
212		* The import is split up into different options which the user can select (these
213		* are displayed to the user as checkboxes in the form). This handles the import
214		* for each of the individual things the user has selected to import. These are
215		* all optional, so each is just termed an import "option" here.
216		*
217		* @since 1.0.0
218		*
219		* @param string $option An import option that has been selected.
220		* @param string $component The component this option is for.
221		* @param array $settings Other settings for this component.
222		*/
223		protected function do_import_for_option( $option, $component, $settings ) {
224
225		if ( ! isset( $this->components[ $component ][ $option ] ) ) {
226		// translators: Option name.
227		$this->feedback->warning( sprintf( __( 'Skipping unrecognized import option “%s”…', 'wordpoints-importer' ), $option ) );
228		return;
229		}
230
231		$option_data = $this->components[ $component ][ $option ];
232
233		// Check if we can actually run this option.
234		if ( isset( $option_data['can_import'] ) ) {
235
236		$cant_import = call_user_func( $option_data['can_import'], $settings );
237
238		if ( is_wp_error( $cant_import ) ) {
239		// translators: 1. Option name; 2. Reason the import was skipped.
240		$this->feedback->warning( sprintf( __( 'Skipping importing %1$s. Reason: %2$s', 'wordpoints-importer' ), $option_data['label'], $cant_import->get_error_message() ) );
241		return;
242		}
243		}
244
245		// OK, we can run the import method for this option.
246		call_user_func( $option_data['function'], $settings );
247		}
248		}
249
250		// EOF
251

WordPoints / importer

WordPoints_Importer::__construct() A last analyzed 2017-10-04 20:46 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WordPoints_Importer::__construct() A
last analyzed 2017-10-04 20:46 UTC