Controller::schedule_migration() - Code Metrics - Inspection of "Test gateway now supports subscriptions" - AyeCode/invoicing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#280)

by Brian

created 2020-04-03 10:41 UTC

Controller::schedule_migration() A

↳ Parent: Controller

Complexity

Conditions	3
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Action_Scheduler\Migration;

use Action_Scheduler\WP_CLI\Migration_Command;
use Action_Scheduler\WP_CLI\ProgressBar;

/**
 * Class Controller
 *
 * The main plugin/initialization class for migration to custom tables.
 *
 * @package Action_Scheduler\Migration
 *
 * @since 3.0.0
 *
 * @codeCoverageIgnore
 */
class Controller {
	private static $instance;

	/** @var Action_Scheduler\Migration\Scheduler */

	private $migration_scheduler;

	/** @var string */
	private $store_classname;

	/** @var string */
	private $logger_classname;

	/** @var bool */
	private $migrate_custom_store;

	/**
	 * Controller constructor.
	 *
	 * @param Scheduler $migration_scheduler Migration scheduler object.
	 */
	protected function __construct( Scheduler $migration_scheduler ) {
		$this->migration_scheduler = $migration_scheduler;

		$this->store_classname     = '';
	}

	/**
	 * Set the action store class name.
	 *
	 * @param string $class Classname of the store class.
	 *
	 * @return string
	 */
	public function get_store_class( $class ) {
		if ( \ActionScheduler_DataController::is_migration_complete() ) {
			return \ActionScheduler_DataController::DATASTORE_CLASS;
		} elseif ( \ActionScheduler_Store::DEFAULT_CLASS !== $class ) {
			$this->store_classname = $class;
			return $class;
		} else {
			return 'ActionScheduler_HybridStore';
		}
	}

	/**
	 * Set the action logger class name.
	 *
	 * @param string $class Classname of the logger class.
	 *
	 * @return string
	 */
	public function get_logger_class( $class ) {
		\ActionScheduler_Store::instance();

		if ( $this->has_custom_datastore() ) {
			$this->logger_classname = $class;
			return $class;
		} else {
			return \ActionScheduler_DataController::LOGGER_CLASS;
		}
	}

	/**
	 * Get flag indicating whether a custom datastore is in use.
	 *
	 * @return bool
	 */
	public function has_custom_datastore() {
		return (bool) $this->store_classname;
	}

	/**
	 * Set up the background migration process
	 *
	 * @return void
	 */
	public function schedule_migration() {
		if ( \ActionScheduler_DataController::is_migration_complete() || $this->migration_scheduler->is_migration_scheduled() ) {
			return;
		}

		$this->migration_scheduler->schedule_migration();
	}

	/**
	 * Get the default migration config object
	 *
	 * @return ActionScheduler\Migration\Config
filter:
    dependency_paths: ["lib/*"]
	 */
	public function get_migration_config_object() {
		static $config = null;

		if ( ! $config ) {
			$source_store  = $this->store_classname ? new $this->store_classname() : new \ActionScheduler_wpPostStore();
			$source_logger = $this->logger_classname ? new $this->logger_classname() : new \ActionScheduler_wpCommentLogger();

			$config = new Config();
			$config->set_source_store( $source_store );
			$config->set_source_logger( $source_logger );
			$config->set_destination_store( new \ActionScheduler_DBStoreMigrator() );
			$config->set_destination_logger( new \ActionScheduler_DBLogger() );

			if ( defined( 'WP_CLI' ) && WP_CLI ) {

				$config->set_progress_bar( new ProgressBar( '', 0 ) );
			}
		}

		return apply_filters( 'action_scheduler/migration_config', $config );
	}

	/**
	 * Hook dashboard migration notice.
	 */
	public function hook_admin_notices() {
		if ( ! $this->allow_migration() || \ActionScheduler_DataController::is_migration_complete() ) {
			return;
		}
		add_action( 'admin_notices', array( $this, 'display_migration_notice' ), 10, 0 );
	}

	/**
	 * Show a dashboard notice that migration is in progress.
	 */
	public function display_migration_notice() {
		printf( '<div class="notice notice-warning"><p>%s</p></div>', __( 'Action Scheduler migration in progress. The list of scheduled actions may be incomplete.', 'action-scheduler' ) );
	}

	/**
	 * Add store classes. Hook migration.
	 */
	private function hook() {
		add_filter( 'action_scheduler_store_class', array( $this, 'get_store_class' ), 100, 1 );
		add_filter( 'action_scheduler_logger_class', array( $this, 'get_logger_class' ), 100, 1 );
		add_action( 'init', array( $this, 'maybe_hook_migration' ) );
		add_action( 'shutdown', array( $this, 'schedule_migration' ), 0, 0 );

		// Action Scheduler may be displayed as a Tools screen or WooCommerce > Status administration screen
		add_action( 'load-tools_page_action-scheduler', array( $this, 'hook_admin_notices' ), 10, 0 );
		add_action( 'load-woocommerce_page_wc-status', array( $this, 'hook_admin_notices' ), 10, 0 );
	}

	/**
	 * Possibly hook the migration scheduler action.
	 *
	 * @author Jeremy Pry
	 */
	public function maybe_hook_migration() {
		if ( ! $this->allow_migration() || \ActionScheduler_DataController::is_migration_complete() ) {
			return;
		}

		$this->migration_scheduler->hook();
	}

	/**
	 * Allow datastores to enable migration to AS tables.
	 */
	public function allow_migration() {
		if ( ! \ActionScheduler_DataController::dependencies_met() ) {
			return false;
		}

		if ( null === $this->migrate_custom_store ) {
			$this->migrate_custom_store = apply_filters( 'action_scheduler_migrate_data_store', false );
		}

		return ( ! $this->has_custom_datastore() ) || $this->migrate_custom_store;
	}

	/**
	 * Proceed with the migration if the dependencies have been met.
	 */
	public static function init() {
		if ( \ActionScheduler_DataController::dependencies_met() ) {
			self::instance()->hook();
		}
	}

	/**
	 * Singleton factory.
	 */
	public static function instance() {
		if ( ! isset( self::$instance ) ) {
			self::$instance = new static( new Scheduler() );
		}

		return self::$instance;
	}
}


1			<?php
2
3			namespace Action_Scheduler\Migration;
4
5			use Action_Scheduler\WP_CLI\Migration_Command;
6			use Action_Scheduler\WP_CLI\ProgressBar;
7
8			/**
9			* Class Controller
10			*
11			* The main plugin/initialization class for migration to custom tables.
12			*
13			* @package Action_Scheduler\Migration
14			*
15			* @since 3.0.0
16			*
17			* @codeCoverageIgnore
18			*/
19			class Controller {
20			private static $instance;
21
22			/** @var Action_Scheduler\Migration\Scheduler */
			0 ignored issues – show Bug introduced 2020-04-03 10:46 UTC by Report Bug Copy Issue Report The type `Action_Scheduler\Migrati...ler\Migration\Scheduler` was not found. Did you mean `Action_Scheduler\Migration\Scheduler`? If so, make sure to prefix the type with `\`. Loading history...
23			private $migration_scheduler;
24
25			/** @var string */
26			private $store_classname;
27
28			/** @var string */
29			private $logger_classname;
30
31			/** @var bool */
32			private $migrate_custom_store;
33
34			/**
35			* Controller constructor.
36			*
37			* @param Scheduler $migration_scheduler Migration scheduler object.
38			*/
39			protected function __construct( Scheduler $migration_scheduler ) {
40			$this->migration_scheduler = $migration_scheduler;
			0 ignored issues – show Documentation Bug introduced 2020-04-03 10:46 UTC by Report Bug Copy Issue Report It seems like `$migration_scheduler` of type `Action_Scheduler\Migration\Scheduler` is incompatible with the declared type `Action_Scheduler\Migrati...ler\Migration\Scheduler` of property `$migration_scheduler`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
41			$this->store_classname = '';
42			}
43
44			/**
45			* Set the action store class name.
46			*
47			* @param string $class Classname of the store class.
48			*
49			* @return string
50			*/
51			public function get_store_class( $class ) {
52			if ( \ActionScheduler_DataController::is_migration_complete() ) {
53			return \ActionScheduler_DataController::DATASTORE_CLASS;
54			} elseif ( \ActionScheduler_Store::DEFAULT_CLASS !== $class ) {
55			$this->store_classname = $class;
56			return $class;
57			} else {
58			return 'ActionScheduler_HybridStore';
59			}
60			}
61
62			/**
63			* Set the action logger class name.
64			*
65			* @param string $class Classname of the logger class.
66			*
67			* @return string
68			*/
69			public function get_logger_class( $class ) {
70			\ActionScheduler_Store::instance();
71
72			if ( $this->has_custom_datastore() ) {
73			$this->logger_classname = $class;
74			return $class;
75			} else {
76			return \ActionScheduler_DataController::LOGGER_CLASS;
77			}
78			}
79
80			/**
81			* Get flag indicating whether a custom datastore is in use.
82			*
83			* @return bool
84			*/
85			public function has_custom_datastore() {
86			return (bool) $this->store_classname;
87			}
88
89			/**
90			* Set up the background migration process
91			*
92			* @return void
93			*/
94			public function schedule_migration() {
95			if ( \ActionScheduler_DataController::is_migration_complete() \|\| $this->migration_scheduler->is_migration_scheduled() ) {
96			return;
97			}
98
99			$this->migration_scheduler->schedule_migration();
100			}
101
102			/**
103			* Get the default migration config object
104			*
105			* @return ActionScheduler\Migration\Config
			0 ignored issues – show Bug introduced 2020-04-03 10:46 UTC by Report Bug Copy Issue Report The type `Action_Scheduler\Migrati...eduler\Migration\Config` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
106			*/
107			public function get_migration_config_object() {
108			static $config = null;
109
110			if ( ! $config ) {
111			$source_store = $this->store_classname ? new $this->store_classname() : new \ActionScheduler_wpPostStore();
112			$source_logger = $this->logger_classname ? new $this->logger_classname() : new \ActionScheduler_wpCommentLogger();
113
114			$config = new Config();
115			$config->set_source_store( $source_store );
116			$config->set_source_logger( $source_logger );
117			$config->set_destination_store( new \ActionScheduler_DBStoreMigrator() );
118			$config->set_destination_logger( new \ActionScheduler_DBLogger() );
119
120			if ( defined( 'WP_CLI' ) && WP_CLI ) {
			0 ignored issues – show Bug introduced 2020-04-03 10:46 UTC by Report Bug Copy Issue Report The constant `Action_Scheduler\Migration\WP_CLI` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
121			$config->set_progress_bar( new ProgressBar( '', 0 ) );
122			}
123			}
124
125			return apply_filters( 'action_scheduler/migration_config', $config );
126			}
127
128			/**
129			* Hook dashboard migration notice.
130			*/
131			public function hook_admin_notices() {
132			if ( ! $this->allow_migration() \|\| \ActionScheduler_DataController::is_migration_complete() ) {
133			return;
134			}
135			add_action( 'admin_notices', array( $this, 'display_migration_notice' ), 10, 0 );
136			}
137
138			/**
139			* Show a dashboard notice that migration is in progress.
140			*/
141			public function display_migration_notice() {
142			printf( '<div class="notice notice-warning"><p>%s</p></div>', __( 'Action Scheduler migration in progress. The list of scheduled actions may be incomplete.', 'action-scheduler' ) );
143			}
144
145			/**
146			* Add store classes. Hook migration.
147			*/
148			private function hook() {
149			add_filter( 'action_scheduler_store_class', array( $this, 'get_store_class' ), 100, 1 );
150			add_filter( 'action_scheduler_logger_class', array( $this, 'get_logger_class' ), 100, 1 );
151			add_action( 'init', array( $this, 'maybe_hook_migration' ) );
152			add_action( 'shutdown', array( $this, 'schedule_migration' ), 0, 0 );
153
154			// Action Scheduler may be displayed as a Tools screen or WooCommerce > Status administration screen
155			add_action( 'load-tools_page_action-scheduler', array( $this, 'hook_admin_notices' ), 10, 0 );
156			add_action( 'load-woocommerce_page_wc-status', array( $this, 'hook_admin_notices' ), 10, 0 );
157			}
158
159			/**
160			* Possibly hook the migration scheduler action.
161			*
162			* @author Jeremy Pry
163			*/
164			public function maybe_hook_migration() {
165			if ( ! $this->allow_migration() \|\| \ActionScheduler_DataController::is_migration_complete() ) {
166			return;
167			}
168
169			$this->migration_scheduler->hook();
170			}
171
172			/**
173			* Allow datastores to enable migration to AS tables.
174			*/
175			public function allow_migration() {
176			if ( ! \ActionScheduler_DataController::dependencies_met() ) {
177			return false;
178			}
179
180			if ( null === $this->migrate_custom_store ) {
181			$this->migrate_custom_store = apply_filters( 'action_scheduler_migrate_data_store', false );
182			}
183
184			return ( ! $this->has_custom_datastore() ) \|\| $this->migrate_custom_store;
185			}
186
187			/**
188			* Proceed with the migration if the dependencies have been met.
189			*/
190			public static function init() {
191			if ( \ActionScheduler_DataController::dependencies_met() ) {
192			self::instance()->hook();
193			}
194			}
195
196			/**
197			* Singleton factory.
198			*/
199			public static function instance() {
200			if ( ! isset( self::$instance ) ) {
201			self::$instance = new static( new Scheduler() );
202			}
203
204			return self::$instance;
205			}
206			}
207

AyeCode / invoicing

Pull Request — master (#280)

Controller::schedule_migration() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like