ActionScheduler::is_class_cli() - Code Metrics - Inspection of "Merge pull request #280 from AyeCode/manual-subscr..." - AyeCode/invoicing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 495efb...ace576 )

by Brian

created 2020-04-06 10:09 UTC

ActionScheduler::is_class_cli() A

↳ Parent: ActionScheduler

Complexity

Conditions	3
Paths	4

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

use Action_Scheduler\WP_CLI\Migration_Command;
use Action_Scheduler\Migration\Controller;

/**
 * Class ActionScheduler
 * @codeCoverageIgnore
 */
abstract class ActionScheduler {
	private static $plugin_file = '';
	/** @var ActionScheduler_ActionFactory */
	private static $factory = NULL;

	public static function factory() {
		if ( !isset(self::$factory) ) {
			self::$factory = new ActionScheduler_ActionFactory();
		}
		return self::$factory;
	}

	public static function store() {
		return ActionScheduler_Store::instance();
	}

	public static function lock() {
		return ActionScheduler_Lock::instance();
	}

	public static function logger() {
		return ActionScheduler_Logger::instance();
	}

	public static function runner() {
		return ActionScheduler_QueueRunner::instance();
	}

	public static function admin_view() {
		return ActionScheduler_AdminView::instance();
	}

	/**
	 * Get the absolute system path to the plugin directory, or a file therein
	 * @static
	 * @param string $path
	 * @return string
	 */
	public static function plugin_path( $path ) {
		$base = dirname(self::$plugin_file);
		if ( $path ) {
			return trailingslashit($base).$path;
		} else {
			return untrailingslashit($base);
		}
	}

	/**
	 * Get the absolute URL to the plugin directory, or a file therein
	 * @static
	 * @param string $path
	 * @return string
	 */
	public static function plugin_url( $path ) {
		return plugins_url($path, self::$plugin_file);
	}

	public static function autoload( $class ) {
		$d           = DIRECTORY_SEPARATOR;
		$classes_dir = self::plugin_path( 'classes' . $d );
		$separator   = strrpos( $class, '\\' );
		if ( false !== $separator ) {
			if ( 0 !== strpos( $class, 'Action_Scheduler' ) ) {
				return;
			}
			$class = substr( $class, $separator + 1 );
		}

		if ( 'Deprecated' === substr( $class, -10 ) ) {
			$dir = self::plugin_path( 'deprecated' . $d );
		} elseif ( self::is_class_abstract( $class ) ) {
			$dir = $classes_dir . 'abstracts' . $d;
		} elseif ( self::is_class_migration( $class ) ) {
			$dir = $classes_dir . 'migration' . $d;
		} elseif ( 'Schedule' === substr( $class, -8 ) ) {
			$dir = $classes_dir . 'schedules' . $d;
		} elseif ( 'Action' === substr( $class, -6 ) ) {
			$dir = $classes_dir . 'actions' . $d;
		} elseif ( 'Schema' === substr( $class, -6 ) ) {
			$dir = $classes_dir . 'schema' . $d;
		} elseif ( strpos( $class, 'ActionScheduler' ) === 0 ) {
			$segments = explode( '_', $class );
			$type = isset( $segments[ 1 ] ) ? $segments[ 1 ] : '';

			switch ( $type ) {
				case 'WPCLI':
					$dir = $classes_dir . 'WP_CLI' . $d;
					break;
				case 'DBLogger':
				case 'DBStore':
				case 'HybridStore':
				case 'wpPostStore':
				case 'wpCommentLogger':
					$dir = $classes_dir . 'data-stores' . $d;
					break;
				default:
					$dir = $classes_dir;
					break;
			}
		} elseif ( self::is_class_cli( $class ) ) {
			$dir = $classes_dir . 'WP_CLI' . $d;
		} elseif ( strpos( $class, 'CronExpression' ) === 0 ) {
			$dir = self::plugin_path( 'lib' . $d . 'cron-expression' . $d );
		} elseif ( strpos( $class, 'WP_Async_Request' ) === 0 ) {
			$dir = self::plugin_path( 'lib' . $d );
		} else {
			return;
		}

		if ( file_exists( "{$dir}{$class}.php" ) ) {
			include( "{$dir}{$class}.php" );
			return;
		}
	}

	/**
	 * Initialize the plugin
	 *
	 * @static
	 * @param string $plugin_file
	 */
	public static function init( $plugin_file ) {
		self::$plugin_file = $plugin_file;
		spl_autoload_register( array( __CLASS__, 'autoload' ) );

		/**
		 * Fires in the early stages of Action Scheduler init hook.
		 */
		do_action( 'action_scheduler_pre_init' );

		require_once( self::plugin_path( 'functions.php' ) );
		ActionScheduler_DataController::init();

		$store      = self::store();
		$logger     = self::logger();
		$runner     = self::runner();
		$admin_view = self::admin_view();

		// Ensure initialization on plugin activation.
		if ( ! did_action( 'init' ) ) {
			add_action( 'init', array( $admin_view, 'init' ), 0, 0 ); // run before $store::init()
			add_action( 'init', array( $store, 'init' ), 1, 0 );
			add_action( 'init', array( $logger, 'init' ), 1, 0 );
			add_action( 'init', array( $runner, 'init' ), 1, 0 );
		} else {
			$admin_view->init();
			$store->init();
			$logger->init();
			$runner->init();
		}

		if ( apply_filters( 'action_scheduler_load_deprecated_functions', true ) ) {
			require_once( self::plugin_path( 'deprecated/functions.php' ) );
		}

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

			WP_CLI::add_command( 'action-scheduler', 'ActionScheduler_WPCLI_Scheduler_command' );
filter:
    dependency_paths: ["lib/*"]
			if ( ! ActionScheduler_DataController::is_migration_complete() && Controller::instance()->allow_migration() ) {
				$command = new Migration_Command();
				$command->register();
			}
		}

		/**
		 * Handle WP comment cleanup after migration.
		 */
		if ( is_a( $logger, 'ActionScheduler_DBLogger' ) && ActionScheduler_DataController::is_migration_complete() && ActionScheduler_WPCommentCleaner::has_logs() ) {
			ActionScheduler_WPCommentCleaner::init();
		}

		add_action( 'action_scheduler/migration_complete', 'ActionScheduler_WPCommentCleaner::maybe_schedule_cleanup' );
	}

	/**
	 * Determine if the class is one of our abstract classes.
	 *
	 * @since 3.0.0
	 *
	 * @param string $class The class name.
	 *
	 * @return bool
	 */
	protected static function is_class_abstract( $class ) {
		static $abstracts = array(
			'ActionScheduler'                            => true,
			'ActionScheduler_Abstract_ListTable'         => true,
			'ActionScheduler_Abstract_QueueRunner'       => true,
			'ActionScheduler_Abstract_Schedule'          => true,
			'ActionScheduler_Abstract_RecurringSchedule' => true,
			'ActionScheduler_Lock'                       => true,
			'ActionScheduler_Logger'                     => true,
			'ActionScheduler_Abstract_Schema'            => true,
			'ActionScheduler_Store'                      => true,
			'ActionScheduler_TimezoneHelper'             => true,
		);

		return isset( $abstracts[ $class ] ) && $abstracts[ $class ];
	}

	/**
	 * Determine if the class is one of our migration classes.
	 *
	 * @since 3.0.0
	 *
	 * @param string $class The class name.
	 *
	 * @return bool
	 */
	protected static function is_class_migration( $class ) {
		static $migration_segments = array(
			'ActionMigrator'  => true,
			'BatchFetcher'    => true,
			'DBStoreMigrator' => true,
			'DryRun'          => true,
			'LogMigrator'     => true,
			'Config'          => true,
			'Controller'      => true,
			'Runner'          => true,
			'Scheduler'       => true,
		);

		$segments = explode( '_', $class );
		$segment = isset( $segments[ 1 ] ) ? $segments[ 1 ] : $class;

		return isset( $migration_segments[ $segment ] ) && $migration_segments[ $segment ];
	}

	/**
	 * Determine if the class is one of our WP CLI classes.
	 *
	 * @since 3.0.0
	 *
	 * @param string $class The class name.
	 *
	 * @return bool
	 */
	protected static function is_class_cli( $class ) {
		static $cli_segments = array(
			'QueueRunner' => true,
			'Command'     => true,
			'ProgressBar' => true,
		);

		$segments = explode( '_', $class );
		$segment = isset( $segments[ 1 ] ) ? $segments[ 1 ] : $class;

		return isset( $cli_segments[ $segment ] ) && $cli_segments[ $segment ];
	}

	final public function __clone() {
		trigger_error("Singleton. No cloning allowed!", E_USER_ERROR);
	}

	final public function __wakeup() {
		trigger_error("Singleton. No serialization allowed!", E_USER_ERROR);
	}

	final private function __construct() {}

	/** Deprecated **/

	public static function get_datetime_object( $when = null, $timezone = 'UTC' ) {
		_deprecated_function( __METHOD__, '2.0', 'wcs_add_months()' );
		return as_get_datetime_object( $when, $timezone );
	}
}


1			<?php
2
3			use Action_Scheduler\WP_CLI\Migration_Command;
4			use Action_Scheduler\Migration\Controller;
5
6			/**
7			* Class ActionScheduler
8			* @codeCoverageIgnore
9			*/
10			abstract class ActionScheduler {
11			private static $plugin_file = '';
12			/** @var ActionScheduler_ActionFactory */
13			private static $factory = NULL;
14
15			public static function factory() {
16			if ( !isset(self::$factory) ) {
17			self::$factory = new ActionScheduler_ActionFactory();
18			}
19			return self::$factory;
20			}
21
22			public static function store() {
23			return ActionScheduler_Store::instance();
24			}
25
26			public static function lock() {
27			return ActionScheduler_Lock::instance();
28			}
29
30			public static function logger() {
31			return ActionScheduler_Logger::instance();
32			}
33
34			public static function runner() {
35			return ActionScheduler_QueueRunner::instance();
36			}
37
38			public static function admin_view() {
39			return ActionScheduler_AdminView::instance();
40			}
41
42			/**
43			* Get the absolute system path to the plugin directory, or a file therein
44			* @static
45			* @param string $path
46			* @return string
47			*/
48			public static function plugin_path( $path ) {
49			$base = dirname(self::$plugin_file);
50			if ( $path ) {
51			return trailingslashit($base).$path;
52			} else {
53			return untrailingslashit($base);
54			}
55			}
56
57			/**
58			* Get the absolute URL to the plugin directory, or a file therein
59			* @static
60			* @param string $path
61			* @return string
62			*/
63			public static function plugin_url( $path ) {
64			return plugins_url($path, self::$plugin_file);
65			}
66
67			public static function autoload( $class ) {
68			$d = DIRECTORY_SEPARATOR;
69			$classes_dir = self::plugin_path( 'classes' . $d );
70			$separator = strrpos( $class, '\\' );
71			if ( false !== $separator ) {
72			if ( 0 !== strpos( $class, 'Action_Scheduler' ) ) {
73			return;
74			}
75			$class = substr( $class, $separator + 1 );
76			}
77
78			if ( 'Deprecated' === substr( $class, -10 ) ) {
79			$dir = self::plugin_path( 'deprecated' . $d );
80			} elseif ( self::is_class_abstract( $class ) ) {
81			$dir = $classes_dir . 'abstracts' . $d;
82			} elseif ( self::is_class_migration( $class ) ) {
83			$dir = $classes_dir . 'migration' . $d;
84			} elseif ( 'Schedule' === substr( $class, -8 ) ) {
85			$dir = $classes_dir . 'schedules' . $d;
86			} elseif ( 'Action' === substr( $class, -6 ) ) {
87			$dir = $classes_dir . 'actions' . $d;
88			} elseif ( 'Schema' === substr( $class, -6 ) ) {
89			$dir = $classes_dir . 'schema' . $d;
90			} elseif ( strpos( $class, 'ActionScheduler' ) === 0 ) {
91			$segments = explode( '_', $class );
92			$type = isset( $segments[ 1 ] ) ? $segments[ 1 ] : '';
93
94			switch ( $type ) {
95			case 'WPCLI':
96			$dir = $classes_dir . 'WP_CLI' . $d;
97			break;
98			case 'DBLogger':
99			case 'DBStore':
100			case 'HybridStore':
101			case 'wpPostStore':
102			case 'wpCommentLogger':
103			$dir = $classes_dir . 'data-stores' . $d;
104			break;
105			default:
106			$dir = $classes_dir;
107			break;
108			}
109			} elseif ( self::is_class_cli( $class ) ) {
110			$dir = $classes_dir . 'WP_CLI' . $d;
111			} elseif ( strpos( $class, 'CronExpression' ) === 0 ) {
112			$dir = self::plugin_path( 'lib' . $d . 'cron-expression' . $d );
113			} elseif ( strpos( $class, 'WP_Async_Request' ) === 0 ) {
114			$dir = self::plugin_path( 'lib' . $d );
115			} else {
116			return;
117			}
118
119			if ( file_exists( "{$dir}{$class}.php" ) ) {
120			include( "{$dir}{$class}.php" );
121			return;
122			}
123			}
124
125			/**
126			* Initialize the plugin
127			*
128			* @static
129			* @param string $plugin_file
130			*/
131			public static function init( $plugin_file ) {
132			self::$plugin_file = $plugin_file;
133			spl_autoload_register( array( __CLASS__, 'autoload' ) );
134
135			/**
136			* Fires in the early stages of Action Scheduler init hook.
137			*/
138			do_action( 'action_scheduler_pre_init' );
139
140			require_once( self::plugin_path( 'functions.php' ) );
141			ActionScheduler_DataController::init();
142
143			$store = self::store();
144			$logger = self::logger();
145			$runner = self::runner();
146			$admin_view = self::admin_view();
147
148			// Ensure initialization on plugin activation.
149			if ( ! did_action( 'init' ) ) {
150			add_action( 'init', array( $admin_view, 'init' ), 0, 0 ); // run before $store::init()
151			add_action( 'init', array( $store, 'init' ), 1, 0 );
152			add_action( 'init', array( $logger, 'init' ), 1, 0 );
153			add_action( 'init', array( $runner, 'init' ), 1, 0 );
154			} else {
155			$admin_view->init();
156			$store->init();
157			$logger->init();
158			$runner->init();
159			}
160
161			if ( apply_filters( 'action_scheduler_load_deprecated_functions', true ) ) {
162			require_once( self::plugin_path( 'deprecated/functions.php' ) );
163			}
164
165			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 `WP_CLI` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
166			WP_CLI::add_command( 'action-scheduler', 'ActionScheduler_WPCLI_Scheduler_command' );
			0 ignored issues – show Bug introduced 2020-04-03 10:46 UTC by Report Bug Copy Issue Report The type `WP_CLI` 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...
167			if ( ! ActionScheduler_DataController::is_migration_complete() && Controller::instance()->allow_migration() ) {
168			$command = new Migration_Command();
169			$command->register();
170			}
171			}
172
173			/**
174			* Handle WP comment cleanup after migration.
175			*/
176			if ( is_a( $logger, 'ActionScheduler_DBLogger' ) && ActionScheduler_DataController::is_migration_complete() && ActionScheduler_WPCommentCleaner::has_logs() ) {
177			ActionScheduler_WPCommentCleaner::init();
178			}
179
180			add_action( 'action_scheduler/migration_complete', 'ActionScheduler_WPCommentCleaner::maybe_schedule_cleanup' );
181			}
182
183			/**
184			* Determine if the class is one of our abstract classes.
185			*
186			* @since 3.0.0
187			*
188			* @param string $class The class name.
189			*
190			* @return bool
191			*/
192			protected static function is_class_abstract( $class ) {
193			static $abstracts = array(
194			'ActionScheduler' => true,
195			'ActionScheduler_Abstract_ListTable' => true,
196			'ActionScheduler_Abstract_QueueRunner' => true,
197			'ActionScheduler_Abstract_Schedule' => true,
198			'ActionScheduler_Abstract_RecurringSchedule' => true,
199			'ActionScheduler_Lock' => true,
200			'ActionScheduler_Logger' => true,
201			'ActionScheduler_Abstract_Schema' => true,
202			'ActionScheduler_Store' => true,
203			'ActionScheduler_TimezoneHelper' => true,
204			);
205
206			return isset( $abstracts[ $class ] ) && $abstracts[ $class ];
207			}
208
209			/**
210			* Determine if the class is one of our migration classes.
211			*
212			* @since 3.0.0
213			*
214			* @param string $class The class name.
215			*
216			* @return bool
217			*/
218			protected static function is_class_migration( $class ) {
219			static $migration_segments = array(
220			'ActionMigrator' => true,
221			'BatchFetcher' => true,
222			'DBStoreMigrator' => true,
223			'DryRun' => true,
224			'LogMigrator' => true,
225			'Config' => true,
226			'Controller' => true,
227			'Runner' => true,
228			'Scheduler' => true,
229			);
230
231			$segments = explode( '_', $class );
232			$segment = isset( $segments[ 1 ] ) ? $segments[ 1 ] : $class;
233
234			return isset( $migration_segments[ $segment ] ) && $migration_segments[ $segment ];
235			}
236
237			/**
238			* Determine if the class is one of our WP CLI classes.
239			*
240			* @since 3.0.0
241			*
242			* @param string $class The class name.
243			*
244			* @return bool
245			*/
246			protected static function is_class_cli( $class ) {
247			static $cli_segments = array(
248			'QueueRunner' => true,
249			'Command' => true,
250			'ProgressBar' => true,
251			);
252
253			$segments = explode( '_', $class );
254			$segment = isset( $segments[ 1 ] ) ? $segments[ 1 ] : $class;
255
256			return isset( $cli_segments[ $segment ] ) && $cli_segments[ $segment ];
257			}
258
259			final public function __clone() {
260			trigger_error("Singleton. No cloning allowed!", E_USER_ERROR);
261			}
262
263			final public function __wakeup() {
264			trigger_error("Singleton. No serialization allowed!", E_USER_ERROR);
265			}
266
267			final private function __construct() {}
268
269			/ Deprecated /
270
271			public static function get_datetime_object( $when = null, $timezone = 'UTC' ) {
272			_deprecated_function( __METHOD__, '2.0', 'wcs_add_months()' );
273			return as_get_datetime_object( $when, $timezone );
274			}
275			}
276

AyeCode / invoicing

Push — master ( 495efb...ace576 )

ActionScheduler::is_class_cli() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like