Jetpack_Unified_Importer_Module::import_ui() - Code Metrics - Inspection of "rename the class too" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/custom-import-experience ( 1565d5...46abbe )

unknown

created 2019-03-04 20:51 UTC

Jetpack_Unified_Importer_Module::import_ui() A

↳ Parent: Jetpack_Unified_Importer_Module

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	33
rs	9.392
c	0
b	0
f	0

<?php

class Jetpack_Unified_Importer_Module {
	static function is_import_screen() {
		global $pagenow;

		// $pagenow is probably enough for us
		// We may want additional "screen" info at some point, so putting here for ref
		// $screen = get_current_screen();
		// error_log( print_r( $screen, 1 ) );

		switch ( $pagenow ) {
			case 'import.php':
				return true;
			case 'admin.php':
				return isset( $_REQUEST['import'] ) && $_REQUEST['import'];
		}
	}

	static function import_ui() {
		if ( ! self::is_import_screen() ) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
			// Do nothing except on the import screen
			return;
		}

		/**
		 * Pre-hide the core UI so it doesn't jump around
		 *
		 * @TODO If you can find a better way to reference this markup, that'd be awesome.
		 * This is fragile in that a core change to this markup would break our app.
		 * See:
		 *   * https://github.com/WordPress/WordPress/blob/71cf332e6569f0ac2f263ce9b2168644942f5534/wp-admin/admin-header.php#L251
		 *   * https://github.com/WordPress/WordPress/blob/71cf332e6569f0ac2f263ce9b2168644942f5534/wp-admin/import.php#L56-L60
		 *
		 * The scripts can use the `parentElement` of `table.importers` which is probably less fragile.
		 * (wouldn't a parent pseudoselector be nice! ;) )
		 */
?><style>#wpbody-content .wrap { display: none; }</style><?php

		wp_enqueue_script( 'jetpack_import_ui', plugin_dir_url( __FILE__ ) . '/index.js', array( 'jquery' /* @TODO react n stuff */ ), JETPACK__VERSION, true );

		// @TODO is `admin_notices` our best hook for our entry element?
		add_action( 'admin_notices', __CLASS__ . '::import_ui_entry_element' );
		add_action( 'admin_footer', __CLASS__ . '::import_ui_ensure_core_ui_is_hidden_by_default' );

		/**
		 * @TODO override help text? https://github.com/WordPress/WordPress/blob/e0e99fe82e652a9d16b603ec17b777395fb9783e/wp-admin/import.php#L20-L33
		 * 	See:
		 * 		https://user-images.githubusercontent.com/1587282/53657998-a8811880-3c25-11e9-9a75-5e8f67b0d67d.png
		 * 	...for default look  & feel
		 */
	}

	static function import_ui_entry_element() {
?>
<div class="jetpack-unified-importer">
	<h1>Oh hi, hullo, Unified Importer!!!!</h1>
	<p>So, this element (<code>.jetpack-unified-importer</code>) is our entry point for our script.</p>
	<hr />
	<p>
		We can clone and mutate the core list (<code>table.importers</code>)<br />
		...then append it to the bottom of our UI as desired
	</p>
	<hr />
	<p>And we can have a button which toggles visibility of this & the "regular" UI</p>
	<p>e.g.&nbsp;&nbsp;<button class="jetpack-unified-importer__exit">Exit</button></p>
	<div style="width: 400px">
		<marquee>For now, please enjoy this super-1337 throwback jQuery mockup ;P</marquee>
	</div>
</div>
<?php
	}

	static function import_ui_ensure_core_ui_is_hidden_by_default() {
?>
<script>
try {
	document.querySelector( 'table.importers' ).parentElement.style.display = 'none';
} catch ( e ) {
	console.error( 'Jetpack Importer UI: Unable to locate importers table' );
}
</script>
<?php
	}
}

/**
 * This action fires in wp-admin when query argument `action=jetpack_import_ui`
 * @see https://developer.wordpress.org/reference/hooks/admin_action__requestaction/
 */
add_action( 'admin_action_jetpack_import_ui', array( 'Jetpack_Unified_Importer_Module', 'import_ui' ) );


1			<?php
2
3			class Jetpack_Unified_Importer_Module {
4			static function is_import_screen() {
5			global $pagenow;
6
7			// $pagenow is probably enough for us
8			// We may want additional "screen" info at some point, so putting here for ref
9			// $screen = get_current_screen();
10			// error_log( print_r( $screen, 1 ) );
11
12			switch ( $pagenow ) {
13			case 'import.php':
14			return true;
15			case 'admin.php':
16			return isset( $_REQUEST['import'] ) && $_REQUEST['import'];
17			}
18			}
19
20			static function import_ui() {
21			if ( ! self::is_import_screen() ) {
			0 ignored issues – show Bug Best Practice introduced 2019-03-02 02:23 UTC by Report Bug Copy Issue Report The expression `self::is_import_screen()` of type `boolean\|null` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
22			// Do nothing except on the import screen
23			return;
24			}
25
26			/**
27			* Pre-hide the core UI so it doesn't jump around
28			*
29			* @TODO If you can find a better way to reference this markup, that'd be awesome.
30			* This is fragile in that a core change to this markup would break our app.
31			* See:
32			* * https://github.com/WordPress/WordPress/blob/71cf332e6569f0ac2f263ce9b2168644942f5534/wp-admin/admin-header.php#L251
33			* * https://github.com/WordPress/WordPress/blob/71cf332e6569f0ac2f263ce9b2168644942f5534/wp-admin/import.php#L56-L60
34			*
35			* The scripts can use the `parentElement` of `table.importers` which is probably less fragile.
36			* (wouldn't a parent pseudoselector be nice! ;) )
37			*/
38			?><style>#wpbody-content .wrap { display: none; }</style><?php
39
40			wp_enqueue_script( 'jetpack_import_ui', plugin_dir_url( __FILE__ ) . '/index.js', array( 'jquery' /* @TODO react n stuff */ ), JETPACK__VERSION, true );
41
42			// @TODO is `admin_notices` our best hook for our entry element?
43			add_action( 'admin_notices', __CLASS__ . '::import_ui_entry_element' );
44			add_action( 'admin_footer', __CLASS__ . '::import_ui_ensure_core_ui_is_hidden_by_default' );
45
46			/**
47			* @TODO override help text? https://github.com/WordPress/WordPress/blob/e0e99fe82e652a9d16b603ec17b777395fb9783e/wp-admin/import.php#L20-L33
48			* See:
49			* https://user-images.githubusercontent.com/1587282/53657998-a8811880-3c25-11e9-9a75-5e8f67b0d67d.png
50			* ...for default look & feel
51			*/
52			}
53
54			static function import_ui_entry_element() {
55			?>
56			<div class="jetpack-unified-importer">
57			<h1>Oh hi, hullo, Unified Importer!!!!</h1>
58			<p>So, this element (<code>.jetpack-unified-importer</code>) is our entry point for our script.</p>
59			<hr />
60			<p>
61			We can clone and mutate the core list (<code>table.importers</code>)<br />
62			...then append it to the bottom of our UI as desired
63			</p>
64			<hr />
65			<p>And we can have a button which toggles visibility of this & the "regular" UI</p>
66			<p>e.g.  <button class="jetpack-unified-importer__exit">Exit</button></p>
67			<div style="width: 400px">
68			<marquee>For now, please enjoy this super-1337 throwback jQuery mockup ;P</marquee>
69			</div>
70			</div>
71			<?php
72			}
73
74			static function import_ui_ensure_core_ui_is_hidden_by_default() {
75			?>
76			<script>
77			try {
78			document.querySelector( 'table.importers' ).parentElement.style.display = 'none';
79			} catch ( e ) {
80			console.error( 'Jetpack Importer UI: Unable to locate importers table' );
81			}
82			</script>
83			<?php
84			}
85			}
86
87			/**
88			* This action fires in wp-admin when query argument `action=jetpack_import_ui`
89			* @see https://developer.wordpress.org/reference/hooks/admin_action__requestaction/
90			*/
91			add_action( 'admin_action_jetpack_import_ui', array( 'Jetpack_Unified_Importer_Module', 'import_ui' ) );
92

Automattic / jetpack

Push — add/custom-import-experience ( 1565d5...46abbe )

Jetpack_Unified_Importer_Module::import_ui() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like