insideout10 / wordlift-plugin

src/ext/action-scheduler/classes/ActionScheduler_WPCommentCleaner.php

Indentation +117 added lines, -117 removed lines

@@ -7,121 +7,121 @@
  */
 class ActionScheduler_WPCommentCleaner {
 
-	/**
-	 * Post migration hook used to cleanup the WP comment table.
-	 *
-	 * @var string
-	 */
-	protected static $cleanup_hook = 'action_scheduler/cleanup_wp_comment_logs';
-
-	/**
-	 * An instance of the ActionScheduler_wpCommentLogger class to interact with the comments table.
-	 *
-	 * This instance should only be used as an interface. It should not be initialized.
-	 *
-	 * @var ActionScheduler_wpCommentLogger
-	 */
-	protected static $wp_comment_logger = null;
-
-	/**
-	 * The key used to store the cached value of whether there are logs in the WP comment table.
-	 *
-	 * @var string
-	 */
-	protected static $has_logs_option_key = 'as_has_wp_comment_logs';
-
-	/**
-	 * Initialize the class and attach callbacks.
-	 */
-	public static function init() {
-		if ( empty( self::$wp_comment_logger ) ) {
-			self::$wp_comment_logger = new ActionScheduler_wpCommentLogger();
-		}
-
-		add_action( self::$cleanup_hook, array( __CLASS__, 'delete_all_action_comments' ) );
-
-		// While there are orphaned logs left in the comments table, we need to attach the callbacks which filter comment counts.
-		add_action( 'pre_get_comments', array( self::$wp_comment_logger, 'filter_comment_queries' ), 10, 1 );
-		add_action( 'wp_count_comments', array( self::$wp_comment_logger, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
-		add_action( 'comment_feed_where', array( self::$wp_comment_logger, 'filter_comment_feed' ), 10, 2 );
-
-		// Action Scheduler may be displayed as a Tools screen or WooCommerce > Status administration screen
-		add_action( 'load-tools_page_action-scheduler', array( __CLASS__, 'register_admin_notice' ) );
-		add_action( 'load-woocommerce_page_wc-status', array( __CLASS__, 'register_admin_notice' ) );
-	}
-
-	/**
-	 * Determines if there are log entries in the wp comments table.
-	 *
-	 * Uses the flag set on migration completion set by @see self::maybe_schedule_cleanup().
-	 *
-	 * @return boolean Whether there are scheduled action comments in the comments table.
-	 */
-	public static function has_logs() {
-		return 'yes' === get_option( self::$has_logs_option_key );
-	}
-
-	/**
-	 * Schedules the WP Post comment table cleanup to run in 6 months if it's not already scheduled.
-	 * Attached to the migration complete hook 'action_scheduler/migration_complete'.
-	 */
-	public static function maybe_schedule_cleanup() {
-		if ( (bool) get_comments(
-			array(
-				'type'   => ActionScheduler_wpCommentLogger::TYPE,
-				'number' => 1,
-				'fields' => 'ids',
-			)
-		) ) {
-			update_option( self::$has_logs_option_key, 'yes' );
-
-			if ( ! as_next_scheduled_action( self::$cleanup_hook ) ) {
-				as_schedule_single_action( gmdate( 'U' ) + ( 6 * MONTH_IN_SECONDS ), self::$cleanup_hook );
-			}
-		}
-	}
-
-	/**
-	 * Delete all action comments from the WP Comments table.
-	 */
-	public static function delete_all_action_comments() {
-		global $wpdb;
-		$wpdb->delete(
-			$wpdb->comments,
-			array(
-				'comment_type'  => ActionScheduler_wpCommentLogger::TYPE,
-				'comment_agent' => ActionScheduler_wpCommentLogger::AGENT,
-			)
-		);
-		delete_option( self::$has_logs_option_key );
-	}
-
-	/**
-	 * Registers admin notices about the orphaned action logs.
-	 */
-	public static function register_admin_notice() {
-		add_action( 'admin_notices', array( __CLASS__, 'print_admin_notice' ) );
-	}
-
-	/**
-	 * Prints details about the orphaned action logs and includes information on where to learn more.
-	 */
-	public static function print_admin_notice() {
-		$next_cleanup_message        = '';
-		$next_scheduled_cleanup_hook = as_next_scheduled_action( self::$cleanup_hook );
-
-		if ( $next_scheduled_cleanup_hook ) {
-			/* translators: %s: date interval */
-			$next_cleanup_message = sprintf( __( 'This data will be deleted in %s.', 'action-scheduler' ), human_time_diff( gmdate( 'U' ), $next_scheduled_cleanup_hook ) );
-		}
-
-		$notice = sprintf(
-			/* translators: 1: next cleanup message 2: github issue URL */
-			__( 'Action Scheduler has migrated data to custom tables; however, orphaned log entries exist in the WordPress Comments table. %1$s <a href="%2$s">Learn more &raquo;</a>', 'action-scheduler' ),
-			$next_cleanup_message,
-			'https://github.com/woocommerce/action-scheduler/issues/368'
-		);
-
-		echo '<div class="notice notice-warning"><p>' . wp_kses_post( $notice ) . '</p></div>';
-	}
+    /**
+     * Post migration hook used to cleanup the WP comment table.
+     *
+     * @var string
+     */
+    protected static $cleanup_hook = 'action_scheduler/cleanup_wp_comment_logs';
+
+    /**
+     * An instance of the ActionScheduler_wpCommentLogger class to interact with the comments table.
+     *
+     * This instance should only be used as an interface. It should not be initialized.
+     *
+     * @var ActionScheduler_wpCommentLogger
+     */
+    protected static $wp_comment_logger = null;
+
+    /**
+     * The key used to store the cached value of whether there are logs in the WP comment table.
+     *
+     * @var string
+     */
+    protected static $has_logs_option_key = 'as_has_wp_comment_logs';
+
+    /**
+     * Initialize the class and attach callbacks.
+     */
+    public static function init() {
+        if ( empty( self::$wp_comment_logger ) ) {
+            self::$wp_comment_logger = new ActionScheduler_wpCommentLogger();
+        }
+
+        add_action( self::$cleanup_hook, array( __CLASS__, 'delete_all_action_comments' ) );
+
+        // While there are orphaned logs left in the comments table, we need to attach the callbacks which filter comment counts.
+        add_action( 'pre_get_comments', array( self::$wp_comment_logger, 'filter_comment_queries' ), 10, 1 );
+        add_action( 'wp_count_comments', array( self::$wp_comment_logger, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
+        add_action( 'comment_feed_where', array( self::$wp_comment_logger, 'filter_comment_feed' ), 10, 2 );
+
+        // Action Scheduler may be displayed as a Tools screen or WooCommerce > Status administration screen
+        add_action( 'load-tools_page_action-scheduler', array( __CLASS__, 'register_admin_notice' ) );
+        add_action( 'load-woocommerce_page_wc-status', array( __CLASS__, 'register_admin_notice' ) );
+    }
+
+    /**
+     * Determines if there are log entries in the wp comments table.
+     *
+     * Uses the flag set on migration completion set by @see self::maybe_schedule_cleanup().
+     *
+     * @return boolean Whether there are scheduled action comments in the comments table.
+     */
+    public static function has_logs() {
+        return 'yes' === get_option( self::$has_logs_option_key );
+    }
+
+    /**
+     * Schedules the WP Post comment table cleanup to run in 6 months if it's not already scheduled.
+     * Attached to the migration complete hook 'action_scheduler/migration_complete'.
+     */
+    public static function maybe_schedule_cleanup() {
+        if ( (bool) get_comments(
+            array(
+                'type'   => ActionScheduler_wpCommentLogger::TYPE,
+                'number' => 1,
+                'fields' => 'ids',
+            )
+        ) ) {
+            update_option( self::$has_logs_option_key, 'yes' );
+
+            if ( ! as_next_scheduled_action( self::$cleanup_hook ) ) {
+                as_schedule_single_action( gmdate( 'U' ) + ( 6 * MONTH_IN_SECONDS ), self::$cleanup_hook );
+            }
+        }
+    }
+
+    /**
+     * Delete all action comments from the WP Comments table.
+     */
+    public static function delete_all_action_comments() {
+        global $wpdb;
+        $wpdb->delete(
+            $wpdb->comments,
+            array(
+                'comment_type'  => ActionScheduler_wpCommentLogger::TYPE,
+                'comment_agent' => ActionScheduler_wpCommentLogger::AGENT,
+            )
+        );
+        delete_option( self::$has_logs_option_key );
+    }
+
+    /**
+     * Registers admin notices about the orphaned action logs.
+     */
+    public static function register_admin_notice() {
+        add_action( 'admin_notices', array( __CLASS__, 'print_admin_notice' ) );
+    }
+
+    /**
+     * Prints details about the orphaned action logs and includes information on where to learn more.
+     */
+    public static function print_admin_notice() {
+        $next_cleanup_message        = '';
+        $next_scheduled_cleanup_hook = as_next_scheduled_action( self::$cleanup_hook );
+
+        if ( $next_scheduled_cleanup_hook ) {
+            /* translators: %s: date interval */
+            $next_cleanup_message = sprintf( __( 'This data will be deleted in %s.', 'action-scheduler' ), human_time_diff( gmdate( 'U' ), $next_scheduled_cleanup_hook ) );
+        }
+
+        $notice = sprintf(
+            /* translators: 1: next cleanup message 2: github issue URL */
+            __( 'Action Scheduler has migrated data to custom tables; however, orphaned log entries exist in the WordPress Comments table. %1$s <a href="%2$s">Learn more &raquo;</a>', 'action-scheduler' ),
+            $next_cleanup_message,
+            'https://github.com/woocommerce/action-scheduler/issues/368'
+        );
+
+        echo '<div class="notice notice-warning"><p>' . wp_kses_post( $notice ) . '</p></div>';
+    }
 }

Spacing +20 added lines, -20 removed lines

@@ -34,20 +34,20 @@ 
 	 * Initialize the class and attach callbacks.
 	 */
 	public static function init() {
-		if ( empty( self::$wp_comment_logger ) ) {
+		if (empty(self::$wp_comment_logger)) {
 			self::$wp_comment_logger = new ActionScheduler_wpCommentLogger();
 		}
 
-		add_action( self::$cleanup_hook, array( __CLASS__, 'delete_all_action_comments' ) );
+		add_action(self::$cleanup_hook, array(__CLASS__, 'delete_all_action_comments'));
 
 		// While there are orphaned logs left in the comments table, we need to attach the callbacks which filter comment counts.
-		add_action( 'pre_get_comments', array( self::$wp_comment_logger, 'filter_comment_queries' ), 10, 1 );
-		add_action( 'wp_count_comments', array( self::$wp_comment_logger, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
-		add_action( 'comment_feed_where', array( self::$wp_comment_logger, 'filter_comment_feed' ), 10, 2 );
+		add_action('pre_get_comments', array(self::$wp_comment_logger, 'filter_comment_queries'), 10, 1);
+		add_action('wp_count_comments', array(self::$wp_comment_logger, 'filter_comment_count'), 20, 2); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
+		add_action('comment_feed_where', array(self::$wp_comment_logger, 'filter_comment_feed'), 10, 2);
 
 		// Action Scheduler may be displayed as a Tools screen or WooCommerce > Status administration screen
-		add_action( 'load-tools_page_action-scheduler', array( __CLASS__, 'register_admin_notice' ) );
-		add_action( 'load-woocommerce_page_wc-status', array( __CLASS__, 'register_admin_notice' ) );
+		add_action('load-tools_page_action-scheduler', array(__CLASS__, 'register_admin_notice'));
+		add_action('load-woocommerce_page_wc-status', array(__CLASS__, 'register_admin_notice'));
 	}
 
 	/**
@@ -58,7 +58,7 @@ 
 	 * @return boolean Whether there are scheduled action comments in the comments table.
 	 */
 	public static function has_logs() {
-		return 'yes' === get_option( self::$has_logs_option_key );
+		return 'yes' === get_option(self::$has_logs_option_key);
 	}
 
 	/**
@@ -66,17 +66,17 @@ 
 	 * Attached to the migration complete hook 'action_scheduler/migration_complete'.
 	 */
 	public static function maybe_schedule_cleanup() {
-		if ( (bool) get_comments(
+		if ((bool) get_comments(
 			array(
 				'type'   => ActionScheduler_wpCommentLogger::TYPE,
 				'number' => 1,
 				'fields' => 'ids',
 			)
-		) ) {
-			update_option( self::$has_logs_option_key, 'yes' );
+		)) {
+			update_option(self::$has_logs_option_key, 'yes');
 
-			if ( ! as_next_scheduled_action( self::$cleanup_hook ) ) {
-				as_schedule_single_action( gmdate( 'U' ) + ( 6 * MONTH_IN_SECONDS ), self::$cleanup_hook );
+			if ( ! as_next_scheduled_action(self::$cleanup_hook)) {
+				as_schedule_single_action(gmdate('U') + (6 * MONTH_IN_SECONDS), self::$cleanup_hook);
 			}
 		}
 	}
@@ -93,14 +93,14 @@ 
 				'comment_agent' => ActionScheduler_wpCommentLogger::AGENT,
 			)
 		);
-		delete_option( self::$has_logs_option_key );
+		delete_option(self::$has_logs_option_key);
 	}
 
 	/**
 	 * Registers admin notices about the orphaned action logs.
 	 */
 	public static function register_admin_notice() {
-		add_action( 'admin_notices', array( __CLASS__, 'print_admin_notice' ) );
+		add_action('admin_notices', array(__CLASS__, 'print_admin_notice'));
 	}
 
 	/**
@@ -108,20 +108,20 @@ 
 	 */
 	public static function print_admin_notice() {
 		$next_cleanup_message        = '';
-		$next_scheduled_cleanup_hook = as_next_scheduled_action( self::$cleanup_hook );
+		$next_scheduled_cleanup_hook = as_next_scheduled_action(self::$cleanup_hook);
 
-		if ( $next_scheduled_cleanup_hook ) {
+		if ($next_scheduled_cleanup_hook) {
 			/* translators: %s: date interval */
-			$next_cleanup_message = sprintf( __( 'This data will be deleted in %s.', 'action-scheduler' ), human_time_diff( gmdate( 'U' ), $next_scheduled_cleanup_hook ) );
+			$next_cleanup_message = sprintf(__('This data will be deleted in %s.', 'action-scheduler'), human_time_diff(gmdate('U'), $next_scheduled_cleanup_hook));
 		}
 
 		$notice = sprintf(
 			/* translators: 1: next cleanup message 2: github issue URL */
-			__( 'Action Scheduler has migrated data to custom tables; however, orphaned log entries exist in the WordPress Comments table. %1$s <a href="%2$s">Learn more &raquo;</a>', 'action-scheduler' ),
+			__('Action Scheduler has migrated data to custom tables; however, orphaned log entries exist in the WordPress Comments table. %1$s <a href="%2$s">Learn more &raquo;</a>', 'action-scheduler'),
 			$next_cleanup_message,
 			'https://github.com/woocommerce/action-scheduler/issues/368'
 		);
 
-		echo '<div class="notice notice-warning"><p>' . wp_kses_post( $notice ) . '</p></div>';
+		echo '<div class="notice notice-warning"><p>'.wp_kses_post($notice).'</p></div>';
 	}
 }

src/ext/action-scheduler/classes/ActionScheduler_ActionFactory.php

Indentation +236 added lines, -236 removed lines

@@ -5,257 +5,257 @@
  */
 class ActionScheduler_ActionFactory {
 
-	/**
-	 * Return stored actions for given params.
-	 *
-	 * @param string                   $status The action's status in the data store.
-	 * @param string                   $hook The hook to trigger when this action runs.
-	 * @param array                    $args Args to pass to callbacks when the hook is triggered.
-	 * @param ActionScheduler_Schedule $schedule The action's schedule.
-	 * @param string                   $group A group to put the action in.
-	 *
-	 * @return ActionScheduler_Action An instance of the stored action.
-	 */
-	public function get_stored_action( $status, $hook, array $args = array(), ActionScheduler_Schedule $schedule = null, $group = '' ) {
+    /**
+     * Return stored actions for given params.
+     *
+     * @param string                   $status The action's status in the data store.
+     * @param string                   $hook The hook to trigger when this action runs.
+     * @param array                    $args Args to pass to callbacks when the hook is triggered.
+     * @param ActionScheduler_Schedule $schedule The action's schedule.
+     * @param string                   $group A group to put the action in.
+     *
+     * @return ActionScheduler_Action An instance of the stored action.
+     */
+    public function get_stored_action( $status, $hook, array $args = array(), ActionScheduler_Schedule $schedule = null, $group = '' ) {
 
-		switch ( $status ) {
-			case ActionScheduler_Store::STATUS_PENDING:
-				$action_class = 'ActionScheduler_Action';
-				break;
-			case ActionScheduler_Store::STATUS_CANCELED:
-				$action_class = 'ActionScheduler_CanceledAction';
-				if ( $schedule !== null && ! is_a( $schedule, 'ActionScheduler_CanceledSchedule' ) && ! is_a( $schedule, 'ActionScheduler_NullSchedule' ) ) {
-					$schedule = new ActionScheduler_CanceledSchedule( $schedule->get_date() );
-				}
-				break;
-			default:
-				$action_class = 'ActionScheduler_FinishedAction';
-				break;
-		}
+        switch ( $status ) {
+            case ActionScheduler_Store::STATUS_PENDING:
+                $action_class = 'ActionScheduler_Action';
+                break;
+            case ActionScheduler_Store::STATUS_CANCELED:
+                $action_class = 'ActionScheduler_CanceledAction';
+                if ( $schedule !== null && ! is_a( $schedule, 'ActionScheduler_CanceledSchedule' ) && ! is_a( $schedule, 'ActionScheduler_NullSchedule' ) ) {
+                    $schedule = new ActionScheduler_CanceledSchedule( $schedule->get_date() );
+                }
+                break;
+            default:
+                $action_class = 'ActionScheduler_FinishedAction';
+                break;
+        }
 
-		$action_class = apply_filters( 'action_scheduler_stored_action_class', $action_class, $status, $hook, $args, $schedule, $group );
+        $action_class = apply_filters( 'action_scheduler_stored_action_class', $action_class, $status, $hook, $args, $schedule, $group );
 
-		$action = new $action_class( $hook, $args, $schedule, $group );
+        $action = new $action_class( $hook, $args, $schedule, $group );
 
-		/**
-		 * Allow 3rd party code to change the instantiated action for a given hook, args, schedule and group.
-		 *
-		 * @param ActionScheduler_Action $action The instantiated action.
-		 * @param string $hook The instantiated action's hook.
-		 * @param array $args The instantiated action's args.
-		 * @param ActionScheduler_Schedule $schedule The instantiated action's schedule.
-		 * @param string $group The instantiated action's group.
-		 */
-		return apply_filters( 'action_scheduler_stored_action_instance', $action, $hook, $args, $schedule, $group );
-	}
+        /**
+         * Allow 3rd party code to change the instantiated action for a given hook, args, schedule and group.
+         *
+         * @param ActionScheduler_Action $action The instantiated action.
+         * @param string $hook The instantiated action's hook.
+         * @param array $args The instantiated action's args.
+         * @param ActionScheduler_Schedule $schedule The instantiated action's schedule.
+         * @param string $group The instantiated action's group.
+         */
+        return apply_filters( 'action_scheduler_stored_action_instance', $action, $hook, $args, $schedule, $group );
+    }
 
-	/**
-	 * Enqueue an action to run one time, as soon as possible (rather a specific scheduled time).
-	 *
-	 * This method creates a new action with the NULLSchedule. This schedule maps to a MySQL datetime string of
-	 * 0000-00-00 00:00:00. This is done to create a psuedo "async action" type that is fully backward compatible.
-	 * Existing queries to claim actions claim by date, meaning actions scheduled for 0000-00-00 00:00:00 will
-	 * always be claimed prior to actions scheduled for a specific date. This makes sure that any async action is
-	 * given priority in queue processing. This has the added advantage of making sure async actions can be
-	 * claimed by both the existing WP Cron and WP CLI runners, as well as a new async request runner.
-	 *
-	 * @param string $hook The hook to trigger when this action runs.
-	 * @param array  $args Args to pass when the hook is triggered.
-	 * @param string $group A group to put the action in.
-	 *
-	 * @return int The ID of the stored action.
-	 */
-	public function async( $hook, $args = array(), $group = '' ) {
-		return $this->async_unique( $hook, $args, $group, false );
-	}
+    /**
+     * Enqueue an action to run one time, as soon as possible (rather a specific scheduled time).
+     *
+     * This method creates a new action with the NULLSchedule. This schedule maps to a MySQL datetime string of
+     * 0000-00-00 00:00:00. This is done to create a psuedo "async action" type that is fully backward compatible.
+     * Existing queries to claim actions claim by date, meaning actions scheduled for 0000-00-00 00:00:00 will
+     * always be claimed prior to actions scheduled for a specific date. This makes sure that any async action is
+     * given priority in queue processing. This has the added advantage of making sure async actions can be
+     * claimed by both the existing WP Cron and WP CLI runners, as well as a new async request runner.
+     *
+     * @param string $hook The hook to trigger when this action runs.
+     * @param array  $args Args to pass when the hook is triggered.
+     * @param string $group A group to put the action in.
+     *
+     * @return int The ID of the stored action.
+     */
+    public function async( $hook, $args = array(), $group = '' ) {
+        return $this->async_unique( $hook, $args, $group, false );
+    }
 
-	/**
-	 * Same as async, but also supports $unique param.
-	 *
-	 * @param string $hook The hook to trigger when this action runs.
-	 * @param array  $args Args to pass when the hook is triggered.
-	 * @param string $group A group to put the action in.
-	 * @param bool   $unique Whether to ensure the action is unique.
-	 *
-	 * @return int The ID of the stored action.
-	 */
-	public function async_unique( $hook, $args = array(), $group = '', $unique = true ) {
-		$schedule = new ActionScheduler_NullSchedule();
-		$action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
-		return $unique ? $this->store_unique_action( $action, $unique ) : $this->store( $action );
-	}
+    /**
+     * Same as async, but also supports $unique param.
+     *
+     * @param string $hook The hook to trigger when this action runs.
+     * @param array  $args Args to pass when the hook is triggered.
+     * @param string $group A group to put the action in.
+     * @param bool   $unique Whether to ensure the action is unique.
+     *
+     * @return int The ID of the stored action.
+     */
+    public function async_unique( $hook, $args = array(), $group = '', $unique = true ) {
+        $schedule = new ActionScheduler_NullSchedule();
+        $action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
+        return $unique ? $this->store_unique_action( $action, $unique ) : $this->store( $action );
+    }
 
-	/**
-	 * Create single action.
-	 *
-	 * @param string $hook  The hook to trigger when this action runs.
-	 * @param array  $args  Args to pass when the hook is triggered.
-	 * @param int    $when  Unix timestamp when the action will run.
-	 * @param string $group A group to put the action in.
-	 *
-	 * @return int The ID of the stored action.
-	 */
-	public function single( $hook, $args = array(), $when = null, $group = '' ) {
-		return $this->single_unique( $hook, $args, $when, $group, false );
-	}
+    /**
+     * Create single action.
+     *
+     * @param string $hook  The hook to trigger when this action runs.
+     * @param array  $args  Args to pass when the hook is triggered.
+     * @param int    $when  Unix timestamp when the action will run.
+     * @param string $group A group to put the action in.
+     *
+     * @return int The ID of the stored action.
+     */
+    public function single( $hook, $args = array(), $when = null, $group = '' ) {
+        return $this->single_unique( $hook, $args, $when, $group, false );
+    }
 
-	/**
-	 * Create single action only if there is no pending or running action with same name and params.
-	 *
-	 * @param string $hook The hook to trigger when this action runs.
-	 * @param array  $args Args to pass when the hook is triggered.
-	 * @param int    $when Unix timestamp when the action will run.
-	 * @param string $group A group to put the action in.
-	 * @param bool   $unique Whether action scheduled should be unique.
-	 *
-	 * @return int The ID of the stored action.
-	 */
-	public function single_unique( $hook, $args = array(), $when = null, $group = '', $unique = true ) {
-		$date     = as_get_datetime_object( $when );
-		$schedule = new ActionScheduler_SimpleSchedule( $date );
-		$action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
-		return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
-	}
+    /**
+     * Create single action only if there is no pending or running action with same name and params.
+     *
+     * @param string $hook The hook to trigger when this action runs.
+     * @param array  $args Args to pass when the hook is triggered.
+     * @param int    $when Unix timestamp when the action will run.
+     * @param string $group A group to put the action in.
+     * @param bool   $unique Whether action scheduled should be unique.
+     *
+     * @return int The ID of the stored action.
+     */
+    public function single_unique( $hook, $args = array(), $when = null, $group = '', $unique = true ) {
+        $date     = as_get_datetime_object( $when );
+        $schedule = new ActionScheduler_SimpleSchedule( $date );
+        $action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
+        return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
+    }
 
-	/**
-	 * Create the first instance of an action recurring on a given interval.
-	 *
-	 * @param string $hook The hook to trigger when this action runs.
-	 * @param array  $args Args to pass when the hook is triggered.
-	 * @param int    $first Unix timestamp for the first run.
-	 * @param int    $interval Seconds between runs.
-	 * @param string $group A group to put the action in.
-	 *
-	 * @return int The ID of the stored action.
-	 */
-	public function recurring( $hook, $args = array(), $first = null, $interval = null, $group = '' ) {
-		return $this->recurring_unique( $hook, $args, $first, $interval, $group, false );
-	}
+    /**
+     * Create the first instance of an action recurring on a given interval.
+     *
+     * @param string $hook The hook to trigger when this action runs.
+     * @param array  $args Args to pass when the hook is triggered.
+     * @param int    $first Unix timestamp for the first run.
+     * @param int    $interval Seconds between runs.
+     * @param string $group A group to put the action in.
+     *
+     * @return int The ID of the stored action.
+     */
+    public function recurring( $hook, $args = array(), $first = null, $interval = null, $group = '' ) {
+        return $this->recurring_unique( $hook, $args, $first, $interval, $group, false );
+    }
 
-	/**
-	 * Create the first instance of an action recurring on a given interval only if there is no pending or running action with same name and params.
-	 *
-	 * @param string $hook The hook to trigger when this action runs.
-	 * @param array  $args Args to pass when the hook is triggered.
-	 * @param int    $first Unix timestamp for the first run.
-	 * @param int    $interval Seconds between runs.
-	 * @param string $group A group to put the action in.
-	 * @param bool   $unique Whether action scheduled should be unique.
-	 *
-	 * @return int The ID of the stored action.
-	 */
-	public function recurring_unique( $hook, $args = array(), $first = null, $interval = null, $group = '', $unique = true ) {
-		if ( empty( $interval ) ) {
-			return $this->single_unique( $hook, $unique, $args, $first, $group );
-		}
-		$date     = as_get_datetime_object( $first );
-		$schedule = new ActionScheduler_IntervalSchedule( $date, $interval );
-		$action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
-		return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
-	}
+    /**
+     * Create the first instance of an action recurring on a given interval only if there is no pending or running action with same name and params.
+     *
+     * @param string $hook The hook to trigger when this action runs.
+     * @param array  $args Args to pass when the hook is triggered.
+     * @param int    $first Unix timestamp for the first run.
+     * @param int    $interval Seconds between runs.
+     * @param string $group A group to put the action in.
+     * @param bool   $unique Whether action scheduled should be unique.
+     *
+     * @return int The ID of the stored action.
+     */
+    public function recurring_unique( $hook, $args = array(), $first = null, $interval = null, $group = '', $unique = true ) {
+        if ( empty( $interval ) ) {
+            return $this->single_unique( $hook, $unique, $args, $first, $group );
+        }
+        $date     = as_get_datetime_object( $first );
+        $schedule = new ActionScheduler_IntervalSchedule( $date, $interval );
+        $action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
+        return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
+    }
 
-	/**
-	 * Create the first instance of an action recurring on a Cron schedule.
-	 *
-	 * @param string $hook The hook to trigger when this action runs.
-	 * @param array  $args Args to pass when the hook is triggered.
-	 * @param int    $base_timestamp The first instance of the action will be scheduled
-	 *        to run at a time calculated after this timestamp matching the cron
-	 *        expression. This can be used to delay the first instance of the action.
-	 * @param int    $schedule A cron definition string.
-	 * @param string $group A group to put the action in.
-	 *
-	 * @return int The ID of the stored action.
-	 */
-	public function cron( $hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '' ) {
-		return $this->cron_unique( $hook, $args, $base_timestamp, $schedule, $group, false );
-	}
+    /**
+     * Create the first instance of an action recurring on a Cron schedule.
+     *
+     * @param string $hook The hook to trigger when this action runs.
+     * @param array  $args Args to pass when the hook is triggered.
+     * @param int    $base_timestamp The first instance of the action will be scheduled
+     *        to run at a time calculated after this timestamp matching the cron
+     *        expression. This can be used to delay the first instance of the action.
+     * @param int    $schedule A cron definition string.
+     * @param string $group A group to put the action in.
+     *
+     * @return int The ID of the stored action.
+     */
+    public function cron( $hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '' ) {
+        return $this->cron_unique( $hook, $args, $base_timestamp, $schedule, $group, false );
+    }
 
-	/**
-	 * Create the first instance of an action recurring on a Cron schedule only if there is no pending or running action with same name and params.
-	 *
-	 * @param string $hook The hook to trigger when this action runs.
-	 * @param array  $args Args to pass when the hook is triggered.
-	 * @param int    $base_timestamp The first instance of the action will be scheduled
-	 *        to run at a time calculated after this timestamp matching the cron
-	 *        expression. This can be used to delay the first instance of the action.
-	 * @param int    $schedule A cron definition string.
-	 * @param string $group A group to put the action in.
-	 * @param bool   $unique Whether action scheduled should be unique.
-	 *
-	 * @return int The ID of the stored action.
-	 **/
-	public function cron_unique( $hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '', $unique = true ) {
-		if ( empty( $schedule ) ) {
-			return $this->single_unique( $hook, $unique, $args, $base_timestamp, $group );
-		}
-		$date     = as_get_datetime_object( $base_timestamp );
-		$cron     = CronExpression::factory( $schedule );
-		$schedule = new ActionScheduler_CronSchedule( $date, $cron );
-		$action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
-		return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
-	}
+    /**
+     * Create the first instance of an action recurring on a Cron schedule only if there is no pending or running action with same name and params.
+     *
+     * @param string $hook The hook to trigger when this action runs.
+     * @param array  $args Args to pass when the hook is triggered.
+     * @param int    $base_timestamp The first instance of the action will be scheduled
+     *        to run at a time calculated after this timestamp matching the cron
+     *        expression. This can be used to delay the first instance of the action.
+     * @param int    $schedule A cron definition string.
+     * @param string $group A group to put the action in.
+     * @param bool   $unique Whether action scheduled should be unique.
+     *
+     * @return int The ID of the stored action.
+     **/
+    public function cron_unique( $hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '', $unique = true ) {
+        if ( empty( $schedule ) ) {
+            return $this->single_unique( $hook, $unique, $args, $base_timestamp, $group );
+        }
+        $date     = as_get_datetime_object( $base_timestamp );
+        $cron     = CronExpression::factory( $schedule );
+        $schedule = new ActionScheduler_CronSchedule( $date, $cron );
+        $action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
+        return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
+    }
 
-	/**
-	 * Create a successive instance of a recurring or cron action.
-	 *
-	 * Importantly, the action will be rescheduled to run based on the current date/time.
-	 * That means when the action is scheduled to run in the past, the next scheduled date
-	 * will be pushed forward. For example, if a recurring action set to run every hour
-	 * was scheduled to run 5 seconds ago, it will be next scheduled for 1 hour in the
-	 * future, which is 1 hour and 5 seconds from when it was last scheduled to run.
-	 *
-	 * Alternatively, if the action is scheduled to run in the future, and is run early,
-	 * likely via manual intervention, then its schedule will change based on the time now.
-	 * For example, if a recurring action set to run every day, and is run 12 hours early,
-	 * it will run again in 24 hours, not 36 hours.
-	 *
-	 * This slippage is less of an issue with Cron actions, as the specific run time can
-	 * be set for them to run, e.g. 1am each day. In those cases, and entire period would
-	 * need to be missed before there was any change is scheduled, e.g. in the case of an
-	 * action scheduled for 1am each day, the action would need to run an entire day late.
-	 *
-	 * @param ActionScheduler_Action $action The existing action.
-	 *
-	 * @return string The ID of the stored action
-	 * @throws InvalidArgumentException If $action is not a recurring action.
-	 */
-	public function repeat( $action ) {
-		$schedule = $action->get_schedule();
-		$next     = $schedule->get_next( as_get_datetime_object() );
+    /**
+     * Create a successive instance of a recurring or cron action.
+     *
+     * Importantly, the action will be rescheduled to run based on the current date/time.
+     * That means when the action is scheduled to run in the past, the next scheduled date
+     * will be pushed forward. For example, if a recurring action set to run every hour
+     * was scheduled to run 5 seconds ago, it will be next scheduled for 1 hour in the
+     * future, which is 1 hour and 5 seconds from when it was last scheduled to run.
+     *
+     * Alternatively, if the action is scheduled to run in the future, and is run early,
+     * likely via manual intervention, then its schedule will change based on the time now.
+     * For example, if a recurring action set to run every day, and is run 12 hours early,
+     * it will run again in 24 hours, not 36 hours.
+     *
+     * This slippage is less of an issue with Cron actions, as the specific run time can
+     * be set for them to run, e.g. 1am each day. In those cases, and entire period would
+     * need to be missed before there was any change is scheduled, e.g. in the case of an
+     * action scheduled for 1am each day, the action would need to run an entire day late.
+     *
+     * @param ActionScheduler_Action $action The existing action.
+     *
+     * @return string The ID of the stored action
+     * @throws InvalidArgumentException If $action is not a recurring action.
+     */
+    public function repeat( $action ) {
+        $schedule = $action->get_schedule();
+        $next     = $schedule->get_next( as_get_datetime_object() );
 
-		if ( $next === null || ! $schedule->is_recurring() ) {
-			throw new InvalidArgumentException( __( 'Invalid action - must be a recurring action.', 'action-scheduler' ) );
-		}
+        if ( $next === null || ! $schedule->is_recurring() ) {
+            throw new InvalidArgumentException( __( 'Invalid action - must be a recurring action.', 'action-scheduler' ) );
+        }
 
-		$schedule_class = get_class( $schedule );
-		$new_schedule   = new $schedule( $next, $schedule->get_recurrence(), $schedule->get_first_date() );
-		$new_action     = new ActionScheduler_Action( $action->get_hook(), $action->get_args(), $new_schedule, $action->get_group() );
-		return $this->store( $new_action );
-	}
+        $schedule_class = get_class( $schedule );
+        $new_schedule   = new $schedule( $next, $schedule->get_recurrence(), $schedule->get_first_date() );
+        $new_action     = new ActionScheduler_Action( $action->get_hook(), $action->get_args(), $new_schedule, $action->get_group() );
+        return $this->store( $new_action );
+    }
 
-	/**
-	 * Save action to database.
-	 *
-	 * @param ActionScheduler_Action $action Action object to save.
-	 *
-	 * @return int The ID of the stored action
-	 */
-	protected function store( ActionScheduler_Action $action ) {
-		$store = ActionScheduler_Store::instance();
-		return $store->save_action( $action );
-	}
+    /**
+     * Save action to database.
+     *
+     * @param ActionScheduler_Action $action Action object to save.
+     *
+     * @return int The ID of the stored action
+     */
+    protected function store( ActionScheduler_Action $action ) {
+        $store = ActionScheduler_Store::instance();
+        return $store->save_action( $action );
+    }
 
-	/**
-	 * Store action if it's unique.
-	 *
-	 * @param ActionScheduler_Action $action Action object to store.
-	 *
-	 * @return int ID of the created action. Will be 0 if action was not created.
-	 */
-	protected function store_unique_action( ActionScheduler_Action $action ) {
-		$store = ActionScheduler_Store::instance();
-		return method_exists( $store, 'save_unique_action' ) ?
-			$store->save_unique_action( $action ) : $store->save_action( $action );
-	}
+    /**
+     * Store action if it's unique.
+     *
+     * @param ActionScheduler_Action $action Action object to store.
+     *
+     * @return int ID of the created action. Will be 0 if action was not created.
+     */
+    protected function store_unique_action( ActionScheduler_Action $action ) {
+        $store = ActionScheduler_Store::instance();
+        return method_exists( $store, 'save_unique_action' ) ?
+            $store->save_unique_action( $action ) : $store->save_action( $action );
+    }
 }

Spacing +51 added lines, -51 removed lines

@@ -16,16 +16,16 @@ 
 	 *
 	 * @return ActionScheduler_Action An instance of the stored action.
 	 */
-	public function get_stored_action( $status, $hook, array $args = array(), ActionScheduler_Schedule $schedule = null, $group = '' ) {
+	public function get_stored_action($status, $hook, array $args = array(), ActionScheduler_Schedule $schedule = null, $group = '') {
 
-		switch ( $status ) {
+		switch ($status) {
 			case ActionScheduler_Store::STATUS_PENDING:
 				$action_class = 'ActionScheduler_Action';
 				break;
 			case ActionScheduler_Store::STATUS_CANCELED:
 				$action_class = 'ActionScheduler_CanceledAction';
-				if ( $schedule !== null && ! is_a( $schedule, 'ActionScheduler_CanceledSchedule' ) && ! is_a( $schedule, 'ActionScheduler_NullSchedule' ) ) {
-					$schedule = new ActionScheduler_CanceledSchedule( $schedule->get_date() );
+				if ($schedule !== null && ! is_a($schedule, 'ActionScheduler_CanceledSchedule') && ! is_a($schedule, 'ActionScheduler_NullSchedule')) {
+					$schedule = new ActionScheduler_CanceledSchedule($schedule->get_date());
 				}
 				break;
 			default:
@@ -33,9 +33,9 @@ 
 				break;
 		}
 
-		$action_class = apply_filters( 'action_scheduler_stored_action_class', $action_class, $status, $hook, $args, $schedule, $group );
+		$action_class = apply_filters('action_scheduler_stored_action_class', $action_class, $status, $hook, $args, $schedule, $group);
 
-		$action = new $action_class( $hook, $args, $schedule, $group );
+		$action = new $action_class($hook, $args, $schedule, $group);
 
 		/**
 		 * Allow 3rd party code to change the instantiated action for a given hook, args, schedule and group.
@@ -46,7 +46,7 @@ 
 		 * @param ActionScheduler_Schedule $schedule The instantiated action's schedule.
 		 * @param string $group The instantiated action's group.
 		 */
-		return apply_filters( 'action_scheduler_stored_action_instance', $action, $hook, $args, $schedule, $group );
+		return apply_filters('action_scheduler_stored_action_instance', $action, $hook, $args, $schedule, $group);
 	}
 
 	/**
@@ -65,8 +65,8 @@ 
 	 *
 	 * @return int The ID of the stored action.
 	 */
-	public function async( $hook, $args = array(), $group = '' ) {
-		return $this->async_unique( $hook, $args, $group, false );
+	public function async($hook, $args = array(), $group = '') {
+		return $this->async_unique($hook, $args, $group, false);
 	}
 
 	/**
@@ -79,10 +79,10 @@ 
 	 *
 	 * @return int The ID of the stored action.
 	 */
-	public function async_unique( $hook, $args = array(), $group = '', $unique = true ) {
+	public function async_unique($hook, $args = array(), $group = '', $unique = true) {
 		$schedule = new ActionScheduler_NullSchedule();
-		$action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
-		return $unique ? $this->store_unique_action( $action, $unique ) : $this->store( $action );
+		$action   = new ActionScheduler_Action($hook, $args, $schedule, $group);
+		return $unique ? $this->store_unique_action($action, $unique) : $this->store($action);
 	}
 
 	/**
@@ -95,8 +95,8 @@ 
 	 *
 	 * @return int The ID of the stored action.
 	 */
-	public function single( $hook, $args = array(), $when = null, $group = '' ) {
-		return $this->single_unique( $hook, $args, $when, $group, false );
+	public function single($hook, $args = array(), $when = null, $group = '') {
+		return $this->single_unique($hook, $args, $when, $group, false);
 	}
 
 	/**
@@ -110,11 +110,11 @@ 
 	 *
 	 * @return int The ID of the stored action.
 	 */
-	public function single_unique( $hook, $args = array(), $when = null, $group = '', $unique = true ) {
-		$date     = as_get_datetime_object( $when );
-		$schedule = new ActionScheduler_SimpleSchedule( $date );
-		$action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
-		return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
+	public function single_unique($hook, $args = array(), $when = null, $group = '', $unique = true) {
+		$date     = as_get_datetime_object($when);
+		$schedule = new ActionScheduler_SimpleSchedule($date);
+		$action   = new ActionScheduler_Action($hook, $args, $schedule, $group);
+		return $unique ? $this->store_unique_action($action) : $this->store($action);
 	}
 
 	/**
@@ -128,8 +128,8 @@ 
 	 *
 	 * @return int The ID of the stored action.
 	 */
-	public function recurring( $hook, $args = array(), $first = null, $interval = null, $group = '' ) {
-		return $this->recurring_unique( $hook, $args, $first, $interval, $group, false );
+	public function recurring($hook, $args = array(), $first = null, $interval = null, $group = '') {
+		return $this->recurring_unique($hook, $args, $first, $interval, $group, false);
 	}
 
 	/**
@@ -144,14 +144,14 @@ 
 	 *
 	 * @return int The ID of the stored action.
 	 */
-	public function recurring_unique( $hook, $args = array(), $first = null, $interval = null, $group = '', $unique = true ) {
-		if ( empty( $interval ) ) {
-			return $this->single_unique( $hook, $unique, $args, $first, $group );
+	public function recurring_unique($hook, $args = array(), $first = null, $interval = null, $group = '', $unique = true) {
+		if (empty($interval)) {
+			return $this->single_unique($hook, $unique, $args, $first, $group);
 		}
-		$date     = as_get_datetime_object( $first );
-		$schedule = new ActionScheduler_IntervalSchedule( $date, $interval );
-		$action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
-		return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
+		$date     = as_get_datetime_object($first);
+		$schedule = new ActionScheduler_IntervalSchedule($date, $interval);
+		$action   = new ActionScheduler_Action($hook, $args, $schedule, $group);
+		return $unique ? $this->store_unique_action($action) : $this->store($action);
 	}
 
 	/**
@@ -167,8 +167,8 @@ 
 	 *
 	 * @return int The ID of the stored action.
 	 */
-	public function cron( $hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '' ) {
-		return $this->cron_unique( $hook, $args, $base_timestamp, $schedule, $group, false );
+	public function cron($hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '') {
+		return $this->cron_unique($hook, $args, $base_timestamp, $schedule, $group, false);
 	}
 
 	/**
@@ -185,15 +185,15 @@ 
 	 *
 	 * @return int The ID of the stored action.
 	 **/
-	public function cron_unique( $hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '', $unique = true ) {
-		if ( empty( $schedule ) ) {
-			return $this->single_unique( $hook, $unique, $args, $base_timestamp, $group );
+	public function cron_unique($hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '', $unique = true) {
+		if (empty($schedule)) {
+			return $this->single_unique($hook, $unique, $args, $base_timestamp, $group);
 		}
-		$date     = as_get_datetime_object( $base_timestamp );
-		$cron     = CronExpression::factory( $schedule );
-		$schedule = new ActionScheduler_CronSchedule( $date, $cron );
-		$action   = new ActionScheduler_Action( $hook, $args, $schedule, $group );
-		return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
+		$date     = as_get_datetime_object($base_timestamp);
+		$cron     = CronExpression::factory($schedule);
+		$schedule = new ActionScheduler_CronSchedule($date, $cron);
+		$action   = new ActionScheduler_Action($hook, $args, $schedule, $group);
+		return $unique ? $this->store_unique_action($action) : $this->store($action);
 	}
 
 	/**
@@ -220,18 +220,18 @@ 
 	 * @return string The ID of the stored action
 	 * @throws InvalidArgumentException If $action is not a recurring action.
 	 */
-	public function repeat( $action ) {
+	public function repeat($action) {
 		$schedule = $action->get_schedule();
-		$next     = $schedule->get_next( as_get_datetime_object() );
+		$next     = $schedule->get_next(as_get_datetime_object());
 
-		if ( $next === null || ! $schedule->is_recurring() ) {
-			throw new InvalidArgumentException( __( 'Invalid action - must be a recurring action.', 'action-scheduler' ) );
+		if ($next === null || ! $schedule->is_recurring()) {
+			throw new InvalidArgumentException(__('Invalid action - must be a recurring action.', 'action-scheduler'));
 		}
 
-		$schedule_class = get_class( $schedule );
-		$new_schedule   = new $schedule( $next, $schedule->get_recurrence(), $schedule->get_first_date() );
-		$new_action     = new ActionScheduler_Action( $action->get_hook(), $action->get_args(), $new_schedule, $action->get_group() );
-		return $this->store( $new_action );
+		$schedule_class = get_class($schedule);
+		$new_schedule   = new $schedule($next, $schedule->get_recurrence(), $schedule->get_first_date());
+		$new_action     = new ActionScheduler_Action($action->get_hook(), $action->get_args(), $new_schedule, $action->get_group());
+		return $this->store($new_action);
 	}
 
 	/**
@@ -241,9 +241,9 @@ 
 	 *
 	 * @return int The ID of the stored action
 	 */
-	protected function store( ActionScheduler_Action $action ) {
+	protected function store(ActionScheduler_Action $action) {
 		$store = ActionScheduler_Store::instance();
-		return $store->save_action( $action );
+		return $store->save_action($action);
 	}
 
 	/**
@@ -253,9 +253,9 @@ 
 	 *
 	 * @return int ID of the created action. Will be 0 if action was not created.
 	 */
-	protected function store_unique_action( ActionScheduler_Action $action ) {
+	protected function store_unique_action(ActionScheduler_Action $action) {
 		$store = ActionScheduler_Store::instance();
-		return method_exists( $store, 'save_unique_action' ) ?
-			$store->save_unique_action( $action ) : $store->save_action( $action );
+		return method_exists($store, 'save_unique_action') ?
+			$store->save_unique_action($action) : $store->save_action($action);
 	}
 }

src/ext/action-scheduler/classes/abstracts/ActionScheduler.php

Indentation +295 added lines, -295 removed lines

@@ -9,299 +9,299 @@
  * @codeCoverageIgnore
  */
 abstract class ActionScheduler {
-	private static $plugin_file = '';
-	/** @var ActionScheduler_ActionFactory */
-	private static $factory = null;
-	/** @var bool */
-	private static $data_store_initialized = false;
-
-	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' );
-			if ( ! ActionScheduler_DataController::is_migration_complete() && Controller::instance()->allow_migration() ) {
-				$command = new Migration_Command();
-				$command->register();
-			}
-		}
-
-		self::$data_store_initialized = true;
-
-		/**
-		 * 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' );
-	}
-
-	/**
-	 * Check whether the AS data store has been initialized.
-	 *
-	 * @param string $function_name The name of the function being called. Optional. Default `null`.
-	 * @return bool
-	 */
-	public static function is_initialized( $function_name = null ) {
-		if ( ! self::$data_store_initialized && ! empty( $function_name ) ) {
-			$message = sprintf( __( '%s() was called before the Action Scheduler data store was initialized', 'action-scheduler' ), esc_attr( $function_name ) );
-			error_log( $message, E_WARNING );
-		}
-
-		return self::$data_store_initialized;
-	}
-
-	/**
-	 * 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 );
-	}
-
-	/**
-	 * Issue deprecated warning if an Action Scheduler function is called in the shutdown hook.
-	 *
-	 * @param string $function_name The name of the function being called.
-	 * @deprecated 3.1.6.
-	 */
-	public static function check_shutdown_hook( $function_name ) {
-		_deprecated_function( __FUNCTION__, '3.1.6' );
-	}
+    private static $plugin_file = '';
+    /** @var ActionScheduler_ActionFactory */
+    private static $factory = null;
+    /** @var bool */
+    private static $data_store_initialized = false;
+
+    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' );
+            if ( ! ActionScheduler_DataController::is_migration_complete() && Controller::instance()->allow_migration() ) {
+                $command = new Migration_Command();
+                $command->register();
+            }
+        }
+
+        self::$data_store_initialized = true;
+
+        /**
+         * 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' );
+    }
+
+    /**
+     * Check whether the AS data store has been initialized.
+     *
+     * @param string $function_name The name of the function being called. Optional. Default `null`.
+     * @return bool
+     */
+    public static function is_initialized( $function_name = null ) {
+        if ( ! self::$data_store_initialized && ! empty( $function_name ) ) {
+            $message = sprintf( __( '%s() was called before the Action Scheduler data store was initialized', 'action-scheduler' ), esc_attr( $function_name ) );
+            error_log( $message, E_WARNING );
+        }
+
+        return self::$data_store_initialized;
+    }
+
+    /**
+     * 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 );
+    }
+
+    /**
+     * Issue deprecated warning if an Action Scheduler function is called in the shutdown hook.
+     *
+     * @param string $function_name The name of the function being called.
+     * @deprecated 3.1.6.
+     */
+    public static function check_shutdown_hook( $function_name ) {
+        _deprecated_function( __FUNCTION__, '3.1.6' );
+    }
 }

Spacing +78 added lines, -78 removed lines

@@ -16,7 +16,7 @@ 
 	private static $data_store_initialized = false;
 
 	public static function factory() {
-		if ( ! isset( self::$factory ) ) {
+		if ( ! isset(self::$factory)) {
 			self::$factory = new ActionScheduler_ActionFactory();
 		}
 		return self::$factory;
@@ -49,12 +49,12 @@ 
 	 * @param string $path
 	 * @return string
 	 */
-	public static function plugin_path( $path ) {
-		$base = dirname( self::$plugin_file );
-		if ( $path ) {
-			return trailingslashit( $base ) . $path;
+	public static function plugin_path($path) {
+		$base = dirname(self::$plugin_file);
+		if ($path) {
+			return trailingslashit($base).$path;
 		} else {
-			return untrailingslashit( $base );
+			return untrailingslashit($base);
 		}
 	}
 
@@ -65,64 +65,64 @@ 
 	 * @param string $path
 	 * @return string
 	 */
-	public static function plugin_url( $path ) {
-		return plugins_url( $path, self::$plugin_file );
+	public static function plugin_url($path) {
+		return plugins_url($path, self::$plugin_file);
 	}
 
-	public static function autoload( $class ) {
+	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' ) ) {
+		$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 );
+			$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 ) {
+		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;
+					$dir = $classes_dir.'WP_CLI'.$d;
 					break;
 				case 'DBLogger':
 				case 'DBStore':
 				case 'HybridStore':
 				case 'wpPostStore':
 				case 'wpCommentLogger':
-					$dir = $classes_dir . 'data-stores' . $d;
+					$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 );
+		} 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";
+		if (file_exists($dir."{$class}.php")) {
+			include $dir."{$class}.php";
 			return;
 		}
 	}
@@ -133,16 +133,16 @@ 
 	 * @static
 	 * @param string $plugin_file
 	 */
-	public static function init( $plugin_file ) {
+	public static function init($plugin_file) {
 		self::$plugin_file = $plugin_file;
-		spl_autoload_register( array( __CLASS__, 'autoload' ) );
+		spl_autoload_register(array(__CLASS__, 'autoload'));
 
 		/**
 		 * Fires in the early stages of Action Scheduler init hook.
 		 */
-		do_action( 'action_scheduler_pre_init' );
+		do_action('action_scheduler_pre_init');
 
-		require_once self::plugin_path( 'functions.php' );
+		require_once self::plugin_path('functions.php');
 		ActionScheduler_DataController::init();
 
 		$store      = self::store();
@@ -151,11 +151,11 @@ 
 		$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 );
+		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();
@@ -163,13 +163,13 @@ 
 			$runner->init();
 		}
 
-		if ( apply_filters( 'action_scheduler_load_deprecated_functions', true ) ) {
-			require_once self::plugin_path( 'deprecated/functions.php' );
+		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' );
-			if ( ! ActionScheduler_DataController::is_migration_complete() && Controller::instance()->allow_migration() ) {
+		if (defined('WP_CLI') && WP_CLI) {
+			WP_CLI::add_command('action-scheduler', 'ActionScheduler_WPCLI_Scheduler_command');
+			if ( ! ActionScheduler_DataController::is_migration_complete() && Controller::instance()->allow_migration()) {
 				$command = new Migration_Command();
 				$command->register();
 			}
@@ -180,11 +180,11 @@ 
 		/**
 		 * Handle WP comment cleanup after migration.
 		 */
-		if ( is_a( $logger, 'ActionScheduler_DBLogger' ) && ActionScheduler_DataController::is_migration_complete() && ActionScheduler_WPCommentCleaner::has_logs() ) {
+		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' );
+		add_action('action_scheduler/migration_complete', 'ActionScheduler_WPCommentCleaner::maybe_schedule_cleanup');
 	}
 
 	/**
@@ -193,10 +193,10 @@ 
 	 * @param string $function_name The name of the function being called. Optional. Default `null`.
 	 * @return bool
 	 */
-	public static function is_initialized( $function_name = null ) {
-		if ( ! self::$data_store_initialized && ! empty( $function_name ) ) {
-			$message = sprintf( __( '%s() was called before the Action Scheduler data store was initialized', 'action-scheduler' ), esc_attr( $function_name ) );
-			error_log( $message, E_WARNING );
+	public static function is_initialized($function_name = null) {
+		if ( ! self::$data_store_initialized && ! empty($function_name)) {
+			$message = sprintf(__('%s() was called before the Action Scheduler data store was initialized', 'action-scheduler'), esc_attr($function_name));
+			error_log($message, E_WARNING);
 		}
 
 		return self::$data_store_initialized;
@@ -211,7 +211,7 @@ 
 	 *
 	 * @return bool
 	 */
-	protected static function is_class_abstract( $class ) {
+	protected static function is_class_abstract($class) {
 		static $abstracts = array(
 			'ActionScheduler'                            => true,
 			'ActionScheduler_Abstract_ListTable'         => true,
@@ -225,7 +225,7 @@ 
 			'ActionScheduler_TimezoneHelper'             => true,
 		);
 
-		return isset( $abstracts[ $class ] ) && $abstracts[ $class ];
+		return isset($abstracts[$class]) && $abstracts[$class];
 	}
 
 	/**
@@ -237,7 +237,7 @@ 
 	 *
 	 * @return bool
 	 */
-	protected static function is_class_migration( $class ) {
+	protected static function is_class_migration($class) {
 		static $migration_segments = array(
 			'ActionMigrator'  => true,
 			'BatchFetcher'    => true,
@@ -250,10 +250,10 @@ 
 			'Scheduler'       => true,
 		);
 
-		$segments = explode( '_', $class );
-		$segment  = isset( $segments[1] ) ? $segments[1] : $class;
+		$segments = explode('_', $class);
+		$segment  = isset($segments[1]) ? $segments[1] : $class;
 
-		return isset( $migration_segments[ $segment ] ) && $migration_segments[ $segment ];
+		return isset($migration_segments[$segment]) && $migration_segments[$segment];
 	}
 
 	/**
@@ -265,34 +265,34 @@ 
 	 *
 	 * @return bool
 	 */
-	protected static function is_class_cli( $class ) {
+	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;
+		$segments = explode('_', $class);
+		$segment  = isset($segments[1]) ? $segments[1] : $class;
 
-		return isset( $cli_segments[ $segment ] ) && $cli_segments[ $segment ];
+		return isset($cli_segments[$segment]) && $cli_segments[$segment];
 	}
 
 	final public function __clone() {
-		trigger_error( 'Singleton. No cloning allowed!', E_USER_ERROR );
+		trigger_error('Singleton. No cloning allowed!', E_USER_ERROR);
 	}
 
 	final public function __wakeup() {
-		trigger_error( 'Singleton. No serialization allowed!', E_USER_ERROR );
+		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 );
+	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);
 	}
 
 	/**
@@ -301,7 +301,7 @@ 
 	 * @param string $function_name The name of the function being called.
 	 * @deprecated 3.1.6.
 	 */
-	public static function check_shutdown_hook( $function_name ) {
-		_deprecated_function( __FUNCTION__, '3.1.6' );
+	public static function check_shutdown_hook($function_name) {
+		_deprecated_function(__FUNCTION__, '3.1.6');
 	}
 }

src/ext/action-scheduler/classes/abstracts/ActionScheduler_Abstract_QueueRunner.php

Indentation +290 added lines, -290 removed lines

@@ -5,294 +5,294 @@
  */
 abstract class ActionScheduler_Abstract_QueueRunner extends ActionScheduler_Abstract_QueueRunner_Deprecated {
 
-	/** @var ActionScheduler_QueueCleaner */
-	protected $cleaner;
-
-	/** @var ActionScheduler_FatalErrorMonitor */
-	protected $monitor;
-
-	/** @var ActionScheduler_Store */
-	protected $store;
-
-	/**
-	 * The created time.
-	 *
-	 * Represents when the queue runner was constructed and used when calculating how long a PHP request has been running.
-	 * For this reason it should be as close as possible to the PHP request start time.
-	 *
-	 * @var int
-	 */
-	private $created_time;
-
-	/**
-	 * ActionScheduler_Abstract_QueueRunner constructor.
-	 *
-	 * @param ActionScheduler_Store             $store
-	 * @param ActionScheduler_FatalErrorMonitor $monitor
-	 * @param ActionScheduler_QueueCleaner      $cleaner
-	 */
-	public function __construct( ActionScheduler_Store $store = null, ActionScheduler_FatalErrorMonitor $monitor = null, ActionScheduler_QueueCleaner $cleaner = null ) {
-
-		$this->created_time = microtime( true );
-
-		$this->store   = $store ? $store : ActionScheduler_Store::instance();
-		$this->monitor = $monitor ? $monitor : new ActionScheduler_FatalErrorMonitor( $this->store );
-		$this->cleaner = $cleaner ? $cleaner : new ActionScheduler_QueueCleaner( $this->store );
-	}
-
-	/**
-	 * Process an individual action.
-	 *
-	 * @param int    $action_id The action ID to process.
-	 * @param string $context Optional identifer for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron'
-	 *        Generally, this should be capitalised and not localised as it's a proper noun.
-	 */
-	public function process_action( $action_id, $context = '' ) {
-		try {
-			$valid_action = false;
-			do_action( 'action_scheduler_before_execute', $action_id, $context );
-
-			if ( ActionScheduler_Store::STATUS_PENDING !== $this->store->get_status( $action_id ) ) {
-				do_action( 'action_scheduler_execution_ignored', $action_id, $context );
-				return;
-			}
-
-			$valid_action = true;
-			do_action( 'action_scheduler_begin_execute', $action_id, $context );
-
-			$action = $this->store->fetch_action( $action_id );
-			$this->store->log_execution( $action_id );
-			$action->execute();
-			do_action( 'action_scheduler_after_execute', $action_id, $action, $context );
-			$this->store->mark_complete( $action_id );
-		} catch ( Exception $e ) {
-			if ( $valid_action ) {
-				$this->store->mark_failure( $action_id );
-				do_action( 'action_scheduler_failed_execution', $action_id, $e, $context );
-			} else {
-				do_action( 'action_scheduler_failed_validation', $action_id, $e, $context );
-			}
-		}
-
-		if ( isset( $action ) && is_a( $action, 'ActionScheduler_Action' ) && $action->get_schedule()->is_recurring() ) {
-			$this->schedule_next_instance( $action, $action_id );
-		}
-	}
-
-	/**
-	 * Schedule the next instance of the action if necessary.
-	 *
-	 * @param ActionScheduler_Action $action
-	 * @param int                    $action_id
-	 */
-	protected function schedule_next_instance( ActionScheduler_Action $action, $action_id ) {
-		// If a recurring action has been consistently failing, we may wish to stop rescheduling it.
-		if (
-			ActionScheduler_Store::STATUS_FAILED === $this->store->get_status( $action_id )
-			&& $this->recurring_action_is_consistently_failing( $action, $action_id )
-		) {
-			ActionScheduler_Logger::instance()->log(
-				$action_id,
-				__( 'This action appears to be consistently failing. A new instance will not be scheduled.', 'action-scheduler' )
-			);
-
-			return;
-		}
-
-		try {
-			ActionScheduler::factory()->repeat( $action );
-		} catch ( Exception $e ) {
-			do_action( 'action_scheduler_failed_to_schedule_next_instance', $action_id, $e, $action );
-		}
-	}
-
-	/**
-	 * Determine if the specified recurring action has been consistently failing.
-	 *
-	 * @param ActionScheduler_Action $action    The recurring action to be rescheduled.
-	 * @param int                    $action_id The ID of the recurring action.
-	 *
-	 * @return bool
-	 */
-	private function recurring_action_is_consistently_failing( ActionScheduler_Action $action, $action_id ) {
-		/**
-		 * Controls the failure threshold for recurring actions.
-		 *
-		 * Before rescheduling a recurring action, we look at its status. If it failed, we then check if all of the most
-		 * recent actions (upto the threshold set by this filter) sharing the same hook have also failed: if they have,
-		 * that is considered consistent failure and a new instance of the action will not be scheduled.
-		 *
-		 * @param int $failure_threshold Number of actions of the same hook to examine for failure. Defaults to 5.
-		 */
-		$consistent_failure_threshold = (int) apply_filters( 'action_scheduler_recurring_action_failure_threshold', 5 );
-
-		// This query should find the earliest *failing* action (for the hook we are interested in) within our threshold.
-		$query_args = array(
-			'hook'         => $action->get_hook(),
-			'status'       => ActionScheduler_Store::STATUS_FAILED,
-			'date'         => date_create( 'now', timezone_open( 'UTC' ) )->format( 'Y-m-d H:i:s' ),
-			'date_compare' => '<',
-			'per_page'     => 1,
-			'offset'       => $consistent_failure_threshold - 1,
-		);
-
-		$first_failing_action_id = $this->store->query_actions( $query_args );
-
-		// If we didn't retrieve an action ID, then there haven't been enough failures for us to worry about.
-		if ( empty( $first_failing_action_id ) ) {
-			return false;
-		}
-
-		// Now let's fetch the first action (having the same hook) of *any status*ithin the same window.
-		unset( $query_args['status'] );
-		$first_action_id_with_the_same_hook = $this->store->query_actions( $query_args );
-
-		// If the IDs match, then actions for this hook must be consistently failing.
-		return $first_action_id_with_the_same_hook === $first_failing_action_id;
-	}
-
-	/**
-	 * Run the queue cleaner.
-	 *
-	 * @author Jeremy Pry
-	 */
-	protected function run_cleanup() {
-		$this->cleaner->clean( 10 * $this->get_time_limit() );
-	}
-
-	/**
-	 * Get the number of concurrent batches a runner allows.
-	 *
-	 * @return int
-	 */
-	public function get_allowed_concurrent_batches() {
-		return apply_filters( 'action_scheduler_queue_runner_concurrent_batches', 1 );
-	}
-
-	/**
-	 * Check if the number of allowed concurrent batches is met or exceeded.
-	 *
-	 * @return bool
-	 */
-	public function has_maximum_concurrent_batches() {
-		return $this->store->get_claim_count() >= $this->get_allowed_concurrent_batches();
-	}
-
-	/**
-	 * Get the maximum number of seconds a batch can run for.
-	 *
-	 * @return int The number of seconds.
-	 */
-	protected function get_time_limit() {
-
-		$time_limit = 30;
-
-		// Apply deprecated filter from deprecated get_maximum_execution_time() method
-		if ( has_filter( 'action_scheduler_maximum_execution_time' ) ) {
-			_deprecated_function( 'action_scheduler_maximum_execution_time', '2.1.1', 'action_scheduler_queue_runner_time_limit' );
-			$time_limit = apply_filters( 'action_scheduler_maximum_execution_time', $time_limit );
-		}
-
-		return absint( apply_filters( 'action_scheduler_queue_runner_time_limit', $time_limit ) );
-	}
-
-	/**
-	 * Get the number of seconds the process has been running.
-	 *
-	 * @return int The number of seconds.
-	 */
-	protected function get_execution_time() {
-		$execution_time = microtime( true ) - $this->created_time;
-
-		// Get the CPU time if the hosting environment uses it rather than wall-clock time to calculate a process's execution time.
-		if ( function_exists( 'getrusage' ) && apply_filters( 'action_scheduler_use_cpu_execution_time', defined( 'PANTHEON_ENVIRONMENT' ) ) ) {
-			$resource_usages = getrusage();
-
-			if ( isset( $resource_usages['ru_stime.tv_usec'], $resource_usages['ru_stime.tv_usec'] ) ) {
-				$execution_time = $resource_usages['ru_stime.tv_sec'] + ( $resource_usages['ru_stime.tv_usec'] / 1000000 );
-			}
-		}
-
-		return $execution_time;
-	}
-
-	/**
-	 * Check if the host's max execution time is (likely) to be exceeded if processing more actions.
-	 *
-	 * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action
-	 * @return bool
-	 */
-	protected function time_likely_to_be_exceeded( $processed_actions ) {
-
-		$execution_time        = $this->get_execution_time();
-		$max_execution_time    = $this->get_time_limit();
-		$time_per_action       = $execution_time / $processed_actions;
-		$estimated_time        = $execution_time + ( $time_per_action * 3 );
-		$likely_to_be_exceeded = $estimated_time > $max_execution_time;
-
-		return apply_filters( 'action_scheduler_maximum_execution_time_likely_to_be_exceeded', $likely_to_be_exceeded, $this, $processed_actions, $execution_time, $max_execution_time );
-	}
-
-	/**
-	 * Get memory limit
-	 *
-	 * Based on WP_Background_Process::get_memory_limit()
-	 *
-	 * @return int
-	 */
-	protected function get_memory_limit() {
-		if ( function_exists( 'ini_get' ) ) {
-			$memory_limit = ini_get( 'memory_limit' );
-		} else {
-			$memory_limit = '128M'; // Sensible default, and minimum required by WooCommerce
-		}
-
-		if ( ! $memory_limit || -1 === $memory_limit || '-1' === $memory_limit ) {
-			// Unlimited, set to 32GB.
-			$memory_limit = '32G';
-		}
-
-		return ActionScheduler_Compatibility::convert_hr_to_bytes( $memory_limit );
-	}
-
-	/**
-	 * Memory exceeded
-	 *
-	 * Ensures the batch process never exceeds 90% of the maximum WordPress memory.
-	 *
-	 * Based on WP_Background_Process::memory_exceeded()
-	 *
-	 * @return bool
-	 */
-	protected function memory_exceeded() {
-
-		$memory_limit    = $this->get_memory_limit() * 0.90;
-		$current_memory  = memory_get_usage( true );
-		$memory_exceeded = $current_memory >= $memory_limit;
-
-		return apply_filters( 'action_scheduler_memory_exceeded', $memory_exceeded, $this );
-	}
-
-	/**
-	 * See if the batch limits have been exceeded, which is when memory usage is almost at
-	 * the maximum limit, or the time to process more actions will exceed the max time limit.
-	 *
-	 * Based on WC_Background_Process::batch_limits_exceeded()
-	 *
-	 * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action
-	 * @return bool
-	 */
-	protected function batch_limits_exceeded( $processed_actions ) {
-		return $this->memory_exceeded() || $this->time_likely_to_be_exceeded( $processed_actions );
-	}
-
-	/**
-	 * Process actions in the queue.
-	 *
-	 * @author Jeremy Pry
-	 * @param string $context Optional identifer for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron'
-	 *        Generally, this should be capitalised and not localised as it's a proper noun.
-	 * @return int The number of actions processed.
-	 */
-	abstract public function run( $context = '' );
+    /** @var ActionScheduler_QueueCleaner */
+    protected $cleaner;
+
+    /** @var ActionScheduler_FatalErrorMonitor */
+    protected $monitor;
+
+    /** @var ActionScheduler_Store */
+    protected $store;
+
+    /**
+     * The created time.
+     *
+     * Represents when the queue runner was constructed and used when calculating how long a PHP request has been running.
+     * For this reason it should be as close as possible to the PHP request start time.
+     *
+     * @var int
+     */
+    private $created_time;
+
+    /**
+     * ActionScheduler_Abstract_QueueRunner constructor.
+     *
+     * @param ActionScheduler_Store             $store
+     * @param ActionScheduler_FatalErrorMonitor $monitor
+     * @param ActionScheduler_QueueCleaner      $cleaner
+     */
+    public function __construct( ActionScheduler_Store $store = null, ActionScheduler_FatalErrorMonitor $monitor = null, ActionScheduler_QueueCleaner $cleaner = null ) {
+
+        $this->created_time = microtime( true );
+
+        $this->store   = $store ? $store : ActionScheduler_Store::instance();
+        $this->monitor = $monitor ? $monitor : new ActionScheduler_FatalErrorMonitor( $this->store );
+        $this->cleaner = $cleaner ? $cleaner : new ActionScheduler_QueueCleaner( $this->store );
+    }
+
+    /**
+     * Process an individual action.
+     *
+     * @param int    $action_id The action ID to process.
+     * @param string $context Optional identifer for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron'
+     *        Generally, this should be capitalised and not localised as it's a proper noun.
+     */
+    public function process_action( $action_id, $context = '' ) {
+        try {
+            $valid_action = false;
+            do_action( 'action_scheduler_before_execute', $action_id, $context );
+
+            if ( ActionScheduler_Store::STATUS_PENDING !== $this->store->get_status( $action_id ) ) {
+                do_action( 'action_scheduler_execution_ignored', $action_id, $context );
+                return;
+            }
+
+            $valid_action = true;
+            do_action( 'action_scheduler_begin_execute', $action_id, $context );
+
+            $action = $this->store->fetch_action( $action_id );
+            $this->store->log_execution( $action_id );
+            $action->execute();
+            do_action( 'action_scheduler_after_execute', $action_id, $action, $context );
+            $this->store->mark_complete( $action_id );
+        } catch ( Exception $e ) {
+            if ( $valid_action ) {
+                $this->store->mark_failure( $action_id );
+                do_action( 'action_scheduler_failed_execution', $action_id, $e, $context );
+            } else {
+                do_action( 'action_scheduler_failed_validation', $action_id, $e, $context );
+            }
+        }
+
+        if ( isset( $action ) && is_a( $action, 'ActionScheduler_Action' ) && $action->get_schedule()->is_recurring() ) {
+            $this->schedule_next_instance( $action, $action_id );
+        }
+    }
+
+    /**
+     * Schedule the next instance of the action if necessary.
+     *
+     * @param ActionScheduler_Action $action
+     * @param int                    $action_id
+     */
+    protected function schedule_next_instance( ActionScheduler_Action $action, $action_id ) {
+        // If a recurring action has been consistently failing, we may wish to stop rescheduling it.
+        if (
+            ActionScheduler_Store::STATUS_FAILED === $this->store->get_status( $action_id )
+            && $this->recurring_action_is_consistently_failing( $action, $action_id )
+        ) {
+            ActionScheduler_Logger::instance()->log(
+                $action_id,
+                __( 'This action appears to be consistently failing. A new instance will not be scheduled.', 'action-scheduler' )
+            );
+
+            return;
+        }
+
+        try {
+            ActionScheduler::factory()->repeat( $action );
+        } catch ( Exception $e ) {
+            do_action( 'action_scheduler_failed_to_schedule_next_instance', $action_id, $e, $action );
+        }
+    }
+
+    /**
+     * Determine if the specified recurring action has been consistently failing.
+     *
+     * @param ActionScheduler_Action $action    The recurring action to be rescheduled.
+     * @param int                    $action_id The ID of the recurring action.
+     *
+     * @return bool
+     */
+    private function recurring_action_is_consistently_failing( ActionScheduler_Action $action, $action_id ) {
+        /**
+         * Controls the failure threshold for recurring actions.
+         *
+         * Before rescheduling a recurring action, we look at its status. If it failed, we then check if all of the most
+         * recent actions (upto the threshold set by this filter) sharing the same hook have also failed: if they have,
+         * that is considered consistent failure and a new instance of the action will not be scheduled.
+         *
+         * @param int $failure_threshold Number of actions of the same hook to examine for failure. Defaults to 5.
+         */
+        $consistent_failure_threshold = (int) apply_filters( 'action_scheduler_recurring_action_failure_threshold', 5 );
+
+        // This query should find the earliest *failing* action (for the hook we are interested in) within our threshold.
+        $query_args = array(
+            'hook'         => $action->get_hook(),
+            'status'       => ActionScheduler_Store::STATUS_FAILED,
+            'date'         => date_create( 'now', timezone_open( 'UTC' ) )->format( 'Y-m-d H:i:s' ),
+            'date_compare' => '<',
+            'per_page'     => 1,
+            'offset'       => $consistent_failure_threshold - 1,
+        );
+
+        $first_failing_action_id = $this->store->query_actions( $query_args );
+
+        // If we didn't retrieve an action ID, then there haven't been enough failures for us to worry about.
+        if ( empty( $first_failing_action_id ) ) {
+            return false;
+        }
+
+        // Now let's fetch the first action (having the same hook) of *any status*ithin the same window.
+        unset( $query_args['status'] );
+        $first_action_id_with_the_same_hook = $this->store->query_actions( $query_args );
+
+        // If the IDs match, then actions for this hook must be consistently failing.
+        return $first_action_id_with_the_same_hook === $first_failing_action_id;
+    }
+
+    /**
+     * Run the queue cleaner.
+     *
+     * @author Jeremy Pry
+     */
+    protected function run_cleanup() {
+        $this->cleaner->clean( 10 * $this->get_time_limit() );
+    }
+
+    /**
+     * Get the number of concurrent batches a runner allows.
+     *
+     * @return int
+     */
+    public function get_allowed_concurrent_batches() {
+        return apply_filters( 'action_scheduler_queue_runner_concurrent_batches', 1 );
+    }
+
+    /**
+     * Check if the number of allowed concurrent batches is met or exceeded.
+     *
+     * @return bool
+     */
+    public function has_maximum_concurrent_batches() {
+        return $this->store->get_claim_count() >= $this->get_allowed_concurrent_batches();
+    }
+
+    /**
+     * Get the maximum number of seconds a batch can run for.
+     *
+     * @return int The number of seconds.
+     */
+    protected function get_time_limit() {
+
+        $time_limit = 30;
+
+        // Apply deprecated filter from deprecated get_maximum_execution_time() method
+        if ( has_filter( 'action_scheduler_maximum_execution_time' ) ) {
+            _deprecated_function( 'action_scheduler_maximum_execution_time', '2.1.1', 'action_scheduler_queue_runner_time_limit' );
+            $time_limit = apply_filters( 'action_scheduler_maximum_execution_time', $time_limit );
+        }
+
+        return absint( apply_filters( 'action_scheduler_queue_runner_time_limit', $time_limit ) );
+    }
+
+    /**
+     * Get the number of seconds the process has been running.
+     *
+     * @return int The number of seconds.
+     */
+    protected function get_execution_time() {
+        $execution_time = microtime( true ) - $this->created_time;
+
+        // Get the CPU time if the hosting environment uses it rather than wall-clock time to calculate a process's execution time.
+        if ( function_exists( 'getrusage' ) && apply_filters( 'action_scheduler_use_cpu_execution_time', defined( 'PANTHEON_ENVIRONMENT' ) ) ) {
+            $resource_usages = getrusage();
+
+            if ( isset( $resource_usages['ru_stime.tv_usec'], $resource_usages['ru_stime.tv_usec'] ) ) {
+                $execution_time = $resource_usages['ru_stime.tv_sec'] + ( $resource_usages['ru_stime.tv_usec'] / 1000000 );
+            }
+        }
+
+        return $execution_time;
+    }
+
+    /**
+     * Check if the host's max execution time is (likely) to be exceeded if processing more actions.
+     *
+     * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action
+     * @return bool
+     */
+    protected function time_likely_to_be_exceeded( $processed_actions ) {
+
+        $execution_time        = $this->get_execution_time();
+        $max_execution_time    = $this->get_time_limit();
+        $time_per_action       = $execution_time / $processed_actions;
+        $estimated_time        = $execution_time + ( $time_per_action * 3 );
+        $likely_to_be_exceeded = $estimated_time > $max_execution_time;
+
+        return apply_filters( 'action_scheduler_maximum_execution_time_likely_to_be_exceeded', $likely_to_be_exceeded, $this, $processed_actions, $execution_time, $max_execution_time );
+    }
+
+    /**
+     * Get memory limit
+     *
+     * Based on WP_Background_Process::get_memory_limit()
+     *
+     * @return int
+     */
+    protected function get_memory_limit() {
+        if ( function_exists( 'ini_get' ) ) {
+            $memory_limit = ini_get( 'memory_limit' );
+        } else {
+            $memory_limit = '128M'; // Sensible default, and minimum required by WooCommerce
+        }
+
+        if ( ! $memory_limit || -1 === $memory_limit || '-1' === $memory_limit ) {
+            // Unlimited, set to 32GB.
+            $memory_limit = '32G';
+        }
+
+        return ActionScheduler_Compatibility::convert_hr_to_bytes( $memory_limit );
+    }
+
+    /**
+     * Memory exceeded
+     *
+     * Ensures the batch process never exceeds 90% of the maximum WordPress memory.
+     *
+     * Based on WP_Background_Process::memory_exceeded()
+     *
+     * @return bool
+     */
+    protected function memory_exceeded() {
+
+        $memory_limit    = $this->get_memory_limit() * 0.90;
+        $current_memory  = memory_get_usage( true );
+        $memory_exceeded = $current_memory >= $memory_limit;
+
+        return apply_filters( 'action_scheduler_memory_exceeded', $memory_exceeded, $this );
+    }
+
+    /**
+     * See if the batch limits have been exceeded, which is when memory usage is almost at
+     * the maximum limit, or the time to process more actions will exceed the max time limit.
+     *
+     * Based on WC_Background_Process::batch_limits_exceeded()
+     *
+     * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action
+     * @return bool
+     */
+    protected function batch_limits_exceeded( $processed_actions ) {
+        return $this->memory_exceeded() || $this->time_likely_to_be_exceeded( $processed_actions );
+    }
+
+    /**
+     * Process actions in the queue.
+     *
+     * @author Jeremy Pry
+     * @param string $context Optional identifer for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron'
+     *        Generally, this should be capitalised and not localised as it's a proper noun.
+     * @return int The number of actions processed.
+     */
+    abstract public function run( $context = '' );
 }

Spacing +56 added lines, -56 removed lines

@@ -31,13 +31,13 @@ 
 	 * @param ActionScheduler_FatalErrorMonitor $monitor
 	 * @param ActionScheduler_QueueCleaner      $cleaner
 	 */
-	public function __construct( ActionScheduler_Store $store = null, ActionScheduler_FatalErrorMonitor $monitor = null, ActionScheduler_QueueCleaner $cleaner = null ) {
+	public function __construct(ActionScheduler_Store $store = null, ActionScheduler_FatalErrorMonitor $monitor = null, ActionScheduler_QueueCleaner $cleaner = null) {
 
-		$this->created_time = microtime( true );
+		$this->created_time = microtime(true);
 
 		$this->store   = $store ? $store : ActionScheduler_Store::instance();
-		$this->monitor = $monitor ? $monitor : new ActionScheduler_FatalErrorMonitor( $this->store );
-		$this->cleaner = $cleaner ? $cleaner : new ActionScheduler_QueueCleaner( $this->store );
+		$this->monitor = $monitor ? $monitor : new ActionScheduler_FatalErrorMonitor($this->store);
+		$this->cleaner = $cleaner ? $cleaner : new ActionScheduler_QueueCleaner($this->store);
 	}
 
 	/**
@@ -47,35 +47,35 @@ 
 	 * @param string $context Optional identifer for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron'
 	 *        Generally, this should be capitalised and not localised as it's a proper noun.
 	 */
-	public function process_action( $action_id, $context = '' ) {
+	public function process_action($action_id, $context = '') {
 		try {
 			$valid_action = false;
-			do_action( 'action_scheduler_before_execute', $action_id, $context );
+			do_action('action_scheduler_before_execute', $action_id, $context);
 
-			if ( ActionScheduler_Store::STATUS_PENDING !== $this->store->get_status( $action_id ) ) {
-				do_action( 'action_scheduler_execution_ignored', $action_id, $context );
+			if (ActionScheduler_Store::STATUS_PENDING !== $this->store->get_status($action_id)) {
+				do_action('action_scheduler_execution_ignored', $action_id, $context);
 				return;
 			}
 
 			$valid_action = true;
-			do_action( 'action_scheduler_begin_execute', $action_id, $context );
+			do_action('action_scheduler_begin_execute', $action_id, $context);
 
-			$action = $this->store->fetch_action( $action_id );
-			$this->store->log_execution( $action_id );
+			$action = $this->store->fetch_action($action_id);
+			$this->store->log_execution($action_id);
 			$action->execute();
-			do_action( 'action_scheduler_after_execute', $action_id, $action, $context );
-			$this->store->mark_complete( $action_id );
-		} catch ( Exception $e ) {
-			if ( $valid_action ) {
-				$this->store->mark_failure( $action_id );
-				do_action( 'action_scheduler_failed_execution', $action_id, $e, $context );
+			do_action('action_scheduler_after_execute', $action_id, $action, $context);
+			$this->store->mark_complete($action_id);
+		} catch (Exception $e) {
+			if ($valid_action) {
+				$this->store->mark_failure($action_id);
+				do_action('action_scheduler_failed_execution', $action_id, $e, $context);
 			} else {
-				do_action( 'action_scheduler_failed_validation', $action_id, $e, $context );
+				do_action('action_scheduler_failed_validation', $action_id, $e, $context);
 			}
 		}
 
-		if ( isset( $action ) && is_a( $action, 'ActionScheduler_Action' ) && $action->get_schedule()->is_recurring() ) {
-			$this->schedule_next_instance( $action, $action_id );
+		if (isset($action) && is_a($action, 'ActionScheduler_Action') && $action->get_schedule()->is_recurring()) {
+			$this->schedule_next_instance($action, $action_id);
 		}
 	}
 
@@ -85,24 +85,24 @@ 
 	 * @param ActionScheduler_Action $action
 	 * @param int                    $action_id
 	 */
-	protected function schedule_next_instance( ActionScheduler_Action $action, $action_id ) {
+	protected function schedule_next_instance(ActionScheduler_Action $action, $action_id) {
 		// If a recurring action has been consistently failing, we may wish to stop rescheduling it.
 		if (
-			ActionScheduler_Store::STATUS_FAILED === $this->store->get_status( $action_id )
-			&& $this->recurring_action_is_consistently_failing( $action, $action_id )
+			ActionScheduler_Store::STATUS_FAILED === $this->store->get_status($action_id)
+			&& $this->recurring_action_is_consistently_failing($action, $action_id)
 		) {
 			ActionScheduler_Logger::instance()->log(
 				$action_id,
-				__( 'This action appears to be consistently failing. A new instance will not be scheduled.', 'action-scheduler' )
+				__('This action appears to be consistently failing. A new instance will not be scheduled.', 'action-scheduler')
 			);
 
 			return;
 		}
 
 		try {
-			ActionScheduler::factory()->repeat( $action );
-		} catch ( Exception $e ) {
-			do_action( 'action_scheduler_failed_to_schedule_next_instance', $action_id, $e, $action );
+			ActionScheduler::factory()->repeat($action);
+		} catch (Exception $e) {
+			do_action('action_scheduler_failed_to_schedule_next_instance', $action_id, $e, $action);
 		}
 	}
 
@@ -114,7 +114,7 @@ 
 	 *
 	 * @return bool
 	 */
-	private function recurring_action_is_consistently_failing( ActionScheduler_Action $action, $action_id ) {
+	private function recurring_action_is_consistently_failing(ActionScheduler_Action $action, $action_id) {
 		/**
 		 * Controls the failure threshold for recurring actions.
 		 *
@@ -124,28 +124,28 @@ 
 		 *
 		 * @param int $failure_threshold Number of actions of the same hook to examine for failure. Defaults to 5.
 		 */
-		$consistent_failure_threshold = (int) apply_filters( 'action_scheduler_recurring_action_failure_threshold', 5 );
+		$consistent_failure_threshold = (int) apply_filters('action_scheduler_recurring_action_failure_threshold', 5);
 
 		// This query should find the earliest *failing* action (for the hook we are interested in) within our threshold.
 		$query_args = array(
 			'hook'         => $action->get_hook(),
 			'status'       => ActionScheduler_Store::STATUS_FAILED,
-			'date'         => date_create( 'now', timezone_open( 'UTC' ) )->format( 'Y-m-d H:i:s' ),
+			'date'         => date_create('now', timezone_open('UTC'))->format('Y-m-d H:i:s'),
 			'date_compare' => '<',
 			'per_page'     => 1,
 			'offset'       => $consistent_failure_threshold - 1,
 		);
 
-		$first_failing_action_id = $this->store->query_actions( $query_args );
+		$first_failing_action_id = $this->store->query_actions($query_args);
 
 		// If we didn't retrieve an action ID, then there haven't been enough failures for us to worry about.
-		if ( empty( $first_failing_action_id ) ) {
+		if (empty($first_failing_action_id)) {
 			return false;
 		}
 
 		// Now let's fetch the first action (having the same hook) of *any status*ithin the same window.
-		unset( $query_args['status'] );
-		$first_action_id_with_the_same_hook = $this->store->query_actions( $query_args );
+		unset($query_args['status']);
+		$first_action_id_with_the_same_hook = $this->store->query_actions($query_args);
 
 		// If the IDs match, then actions for this hook must be consistently failing.
 		return $first_action_id_with_the_same_hook === $first_failing_action_id;
@@ -157,7 +157,7 @@ 
 	 * @author Jeremy Pry
 	 */
 	protected function run_cleanup() {
-		$this->cleaner->clean( 10 * $this->get_time_limit() );
+		$this->cleaner->clean(10 * $this->get_time_limit());
 	}
 
 	/**
@@ -166,7 +166,7 @@ 
 	 * @return int
 	 */
 	public function get_allowed_concurrent_batches() {
-		return apply_filters( 'action_scheduler_queue_runner_concurrent_batches', 1 );
+		return apply_filters('action_scheduler_queue_runner_concurrent_batches', 1);
 	}
 
 	/**
@@ -188,12 +188,12 @@ 
 		$time_limit = 30;
 
 		// Apply deprecated filter from deprecated get_maximum_execution_time() method
-		if ( has_filter( 'action_scheduler_maximum_execution_time' ) ) {
-			_deprecated_function( 'action_scheduler_maximum_execution_time', '2.1.1', 'action_scheduler_queue_runner_time_limit' );
-			$time_limit = apply_filters( 'action_scheduler_maximum_execution_time', $time_limit );
+		if (has_filter('action_scheduler_maximum_execution_time')) {
+			_deprecated_function('action_scheduler_maximum_execution_time', '2.1.1', 'action_scheduler_queue_runner_time_limit');
+			$time_limit = apply_filters('action_scheduler_maximum_execution_time', $time_limit);
 		}
 
-		return absint( apply_filters( 'action_scheduler_queue_runner_time_limit', $time_limit ) );
+		return absint(apply_filters('action_scheduler_queue_runner_time_limit', $time_limit));
 	}
 
 	/**
@@ -202,14 +202,14 @@ 
 	 * @return int The number of seconds.
 	 */
 	protected function get_execution_time() {
-		$execution_time = microtime( true ) - $this->created_time;
+		$execution_time = microtime(true) - $this->created_time;
 
 		// Get the CPU time if the hosting environment uses it rather than wall-clock time to calculate a process's execution time.
-		if ( function_exists( 'getrusage' ) && apply_filters( 'action_scheduler_use_cpu_execution_time', defined( 'PANTHEON_ENVIRONMENT' ) ) ) {
+		if (function_exists('getrusage') && apply_filters('action_scheduler_use_cpu_execution_time', defined('PANTHEON_ENVIRONMENT'))) {
 			$resource_usages = getrusage();
 
-			if ( isset( $resource_usages['ru_stime.tv_usec'], $resource_usages['ru_stime.tv_usec'] ) ) {
-				$execution_time = $resource_usages['ru_stime.tv_sec'] + ( $resource_usages['ru_stime.tv_usec'] / 1000000 );
+			if (isset($resource_usages['ru_stime.tv_usec'], $resource_usages['ru_stime.tv_usec'])) {
+				$execution_time = $resource_usages['ru_stime.tv_sec'] + ($resource_usages['ru_stime.tv_usec'] / 1000000);
 			}
 		}
 
@@ -222,15 +222,15 @@ 
 	 * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action
 	 * @return bool
 	 */
-	protected function time_likely_to_be_exceeded( $processed_actions ) {
+	protected function time_likely_to_be_exceeded($processed_actions) {
 
 		$execution_time        = $this->get_execution_time();
 		$max_execution_time    = $this->get_time_limit();
 		$time_per_action       = $execution_time / $processed_actions;
-		$estimated_time        = $execution_time + ( $time_per_action * 3 );
+		$estimated_time        = $execution_time + ($time_per_action * 3);
 		$likely_to_be_exceeded = $estimated_time > $max_execution_time;
 
-		return apply_filters( 'action_scheduler_maximum_execution_time_likely_to_be_exceeded', $likely_to_be_exceeded, $this, $processed_actions, $execution_time, $max_execution_time );
+		return apply_filters('action_scheduler_maximum_execution_time_likely_to_be_exceeded', $likely_to_be_exceeded, $this, $processed_actions, $execution_time, $max_execution_time);
 	}
 
 	/**
@@ -241,18 +241,18 @@ 
 	 * @return int
 	 */
 	protected function get_memory_limit() {
-		if ( function_exists( 'ini_get' ) ) {
-			$memory_limit = ini_get( 'memory_limit' );
+		if (function_exists('ini_get')) {
+			$memory_limit = ini_get('memory_limit');
 		} else {
 			$memory_limit = '128M'; // Sensible default, and minimum required by WooCommerce
 		}
 
-		if ( ! $memory_limit || -1 === $memory_limit || '-1' === $memory_limit ) {
+		if ( ! $memory_limit || -1 === $memory_limit || '-1' === $memory_limit) {
 			// Unlimited, set to 32GB.
 			$memory_limit = '32G';
 		}
 
-		return ActionScheduler_Compatibility::convert_hr_to_bytes( $memory_limit );
+		return ActionScheduler_Compatibility::convert_hr_to_bytes($memory_limit);
 	}
 
 	/**
@@ -267,10 +267,10 @@ 
 	protected function memory_exceeded() {
 
 		$memory_limit    = $this->get_memory_limit() * 0.90;
-		$current_memory  = memory_get_usage( true );
+		$current_memory  = memory_get_usage(true);
 		$memory_exceeded = $current_memory >= $memory_limit;
 
-		return apply_filters( 'action_scheduler_memory_exceeded', $memory_exceeded, $this );
+		return apply_filters('action_scheduler_memory_exceeded', $memory_exceeded, $this);
 	}
 
 	/**
@@ -282,8 +282,8 @@ 
 	 * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action
 	 * @return bool
 	 */
-	protected function batch_limits_exceeded( $processed_actions ) {
-		return $this->memory_exceeded() || $this->time_likely_to_be_exceeded( $processed_actions );
+	protected function batch_limits_exceeded($processed_actions) {
+		return $this->memory_exceeded() || $this->time_likely_to_be_exceeded($processed_actions);
 	}
 
 	/**
@@ -294,5 +294,5 @@ 
 	 *        Generally, this should be capitalised and not localised as it's a proper noun.
 	 * @return int The number of actions processed.
 	 */
-	abstract public function run( $context = '' );
+	abstract public function run($context = '');
 }

src/ext/action-scheduler/classes/abstracts/ActionScheduler_Abstract_Schema.php

Indentation +157 added lines, -157 removed lines

@@ -11,161 +11,161 @@
  */
 abstract class ActionScheduler_Abstract_Schema {
 
-	/**
-	 * @var int Increment this value in derived class to trigger a schema update.
-	 */
-	protected $schema_version = 1;
-
-	/**
-	 * @var string Schema version stored in database.
-	 */
-	protected $db_version;
-
-	/**
-	 * @var array Names of tables that will be registered by this class.
-	 */
-	protected $tables = array();
-
-	/**
-	 * Can optionally be used by concrete classes to carry out additional initialization work
-	 * as needed.
-	 */
-	public function init() {}
-
-	/**
-	 * Register tables with WordPress, and create them if needed.
-	 *
-	 * @param bool $force_update Optional. Default false. Use true to always run the schema update.
-	 *
-	 * @return void
-	 */
-	public function register_tables( $force_update = false ) {
-		global $wpdb;
-
-		// make WP aware of our tables
-		foreach ( $this->tables as $table ) {
-			$wpdb->tables[] = $table;
-			$name           = $this->get_full_table_name( $table );
-			$wpdb->$table   = $name;
-		}
-
-		// create the tables
-		if ( $this->schema_update_required() || $force_update ) {
-			foreach ( $this->tables as $table ) {
-				/**
-				 * Allow custom processing before updating a table schema.
-				 *
-				 * @param string $table Name of table being updated.
-				 * @param string $db_version Existing version of the table being updated.
-				 */
-				do_action( 'action_scheduler_before_schema_update', $table, $this->db_version );
-				$this->update_table( $table );
-			}
-			$this->mark_schema_update_complete();
-		}
-	}
-
-	/**
-	 * @param string $table The name of the table
-	 *
-	 * @return string The CREATE TABLE statement, suitable for passing to dbDelta
-	 */
-	abstract protected function get_table_definition( $table );
-
-	/**
-	 * Determine if the database schema is out of date
-	 * by comparing the integer found in $this->schema_version
-	 * with the option set in the WordPress options table
-	 *
-	 * @return bool
-	 */
-	private function schema_update_required() {
-		$option_name      = 'schema-' . static::class;
-		$this->db_version = get_option( $option_name, 0 );
-
-		// Check for schema option stored by the Action Scheduler Custom Tables plugin in case site has migrated from that plugin with an older schema
-		if ( 0 === $this->db_version ) {
-
-			$plugin_option_name = 'schema-';
-
-			switch ( static::class ) {
-				case 'ActionScheduler_StoreSchema':
-					$plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Store_Table_Maker';
-					break;
-				case 'ActionScheduler_LoggerSchema':
-					$plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Logger_Table_Maker';
-					break;
-			}
-
-			$this->db_version = get_option( $plugin_option_name, 0 );
-
-			delete_option( $plugin_option_name );
-		}
-
-		return version_compare( $this->db_version, $this->schema_version, '<' );
-	}
-
-	/**
-	 * Update the option in WordPress to indicate that
-	 * our schema is now up to date
-	 *
-	 * @return void
-	 */
-	private function mark_schema_update_complete() {
-		$option_name = 'schema-' . static::class;
-
-		// work around race conditions and ensure that our option updates
-		$value_to_save = (string) $this->schema_version . '.0.' . time();
-
-		update_option( $option_name, $value_to_save );
-	}
-
-	/**
-	 * Update the schema for the given table
-	 *
-	 * @param string $table The name of the table to update
-	 *
-	 * @return void
-	 */
-	private function update_table( $table ) {
-		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
-		$definition = $this->get_table_definition( $table );
-		if ( $definition ) {
-			$updated = dbDelta( $definition );
-			foreach ( $updated as $updated_table => $update_description ) {
-				if ( strpos( $update_description, 'Created table' ) === 0 ) {
-					do_action( 'action_scheduler/created_table', $updated_table, $table );
-				}
-			}
-		}
-	}
-
-	/**
-	 * @param string $table
-	 *
-	 * @return string The full name of the table, including the
-	 *                table prefix for the current blog
-	 */
-	protected function get_full_table_name( $table ) {
-		return $GLOBALS['wpdb']->prefix . $table;
-	}
-
-	/**
-	 * Confirms that all of the tables registered by this schema class have been created.
-	 *
-	 * @return bool
-	 */
-	public function tables_exist() {
-		global $wpdb;
-
-		$existing_tables = $wpdb->get_col( 'SHOW TABLES' );
-		$expected_tables = array_map(
-			function ( $table_name ) use ( $wpdb ) {
-				return $wpdb->prefix . $table_name;
-			},
-			$this->tables
-		);
-
-		return count( array_intersect( $existing_tables, $expected_tables ) ) === count( $expected_tables );
-	}
+    /**
+     * @var int Increment this value in derived class to trigger a schema update.
+     */
+    protected $schema_version = 1;
+
+    /**
+     * @var string Schema version stored in database.
+     */
+    protected $db_version;
+
+    /**
+     * @var array Names of tables that will be registered by this class.
+     */
+    protected $tables = array();
+
+    /**
+     * Can optionally be used by concrete classes to carry out additional initialization work
+     * as needed.
+     */
+    public function init() {}
+
+    /**
+     * Register tables with WordPress, and create them if needed.
+     *
+     * @param bool $force_update Optional. Default false. Use true to always run the schema update.
+     *
+     * @return void
+     */
+    public function register_tables( $force_update = false ) {
+        global $wpdb;
+
+        // make WP aware of our tables
+        foreach ( $this->tables as $table ) {
+            $wpdb->tables[] = $table;
+            $name           = $this->get_full_table_name( $table );
+            $wpdb->$table   = $name;
+        }
+
+        // create the tables
+        if ( $this->schema_update_required() || $force_update ) {
+            foreach ( $this->tables as $table ) {
+                /**
+                 * Allow custom processing before updating a table schema.
+                 *
+                 * @param string $table Name of table being updated.
+                 * @param string $db_version Existing version of the table being updated.
+                 */
+                do_action( 'action_scheduler_before_schema_update', $table, $this->db_version );
+                $this->update_table( $table );
+            }
+            $this->mark_schema_update_complete();
+        }
+    }
+
+    /**
+     * @param string $table The name of the table
+     *
+     * @return string The CREATE TABLE statement, suitable for passing to dbDelta
+     */
+    abstract protected function get_table_definition( $table );
+
+    /**
+     * Determine if the database schema is out of date
+     * by comparing the integer found in $this->schema_version
+     * with the option set in the WordPress options table
+     *
+     * @return bool
+     */
+    private function schema_update_required() {
+        $option_name      = 'schema-' . static::class;
+        $this->db_version = get_option( $option_name, 0 );
+
+        // Check for schema option stored by the Action Scheduler Custom Tables plugin in case site has migrated from that plugin with an older schema
+        if ( 0 === $this->db_version ) {
+
+            $plugin_option_name = 'schema-';
+
+            switch ( static::class ) {
+                case 'ActionScheduler_StoreSchema':
+                    $plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Store_Table_Maker';
+                    break;
+                case 'ActionScheduler_LoggerSchema':
+                    $plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Logger_Table_Maker';
+                    break;
+            }
+
+            $this->db_version = get_option( $plugin_option_name, 0 );
+
+            delete_option( $plugin_option_name );
+        }
+
+        return version_compare( $this->db_version, $this->schema_version, '<' );
+    }
+
+    /**
+     * Update the option in WordPress to indicate that
+     * our schema is now up to date
+     *
+     * @return void
+     */
+    private function mark_schema_update_complete() {
+        $option_name = 'schema-' . static::class;
+
+        // work around race conditions and ensure that our option updates
+        $value_to_save = (string) $this->schema_version . '.0.' . time();
+
+        update_option( $option_name, $value_to_save );
+    }
+
+    /**
+     * Update the schema for the given table
+     *
+     * @param string $table The name of the table to update
+     *
+     * @return void
+     */
+    private function update_table( $table ) {
+        require_once ABSPATH . 'wp-admin/includes/upgrade.php';
+        $definition = $this->get_table_definition( $table );
+        if ( $definition ) {
+            $updated = dbDelta( $definition );
+            foreach ( $updated as $updated_table => $update_description ) {
+                if ( strpos( $update_description, 'Created table' ) === 0 ) {
+                    do_action( 'action_scheduler/created_table', $updated_table, $table );
+                }
+            }
+        }
+    }
+
+    /**
+     * @param string $table
+     *
+     * @return string The full name of the table, including the
+     *                table prefix for the current blog
+     */
+    protected function get_full_table_name( $table ) {
+        return $GLOBALS['wpdb']->prefix . $table;
+    }
+
+    /**
+     * Confirms that all of the tables registered by this schema class have been created.
+     *
+     * @return bool
+     */
+    public function tables_exist() {
+        global $wpdb;
+
+        $existing_tables = $wpdb->get_col( 'SHOW TABLES' );
+        $expected_tables = array_map(
+            function ( $table_name ) use ( $wpdb ) {
+                return $wpdb->prefix . $table_name;
+            },
+            $this->tables
+        );
+
+        return count( array_intersect( $existing_tables, $expected_tables ) ) === count( $expected_tables );
+    }
 }

Spacing +32 added lines, -32 removed lines

@@ -39,27 +39,27 @@ 
 	 *
 	 * @return void
 	 */
-	public function register_tables( $force_update = false ) {
+	public function register_tables($force_update = false) {
 		global $wpdb;
 
 		// make WP aware of our tables
-		foreach ( $this->tables as $table ) {
+		foreach ($this->tables as $table) {
 			$wpdb->tables[] = $table;
-			$name           = $this->get_full_table_name( $table );
+			$name           = $this->get_full_table_name($table);
 			$wpdb->$table   = $name;
 		}
 
 		// create the tables
-		if ( $this->schema_update_required() || $force_update ) {
-			foreach ( $this->tables as $table ) {
+		if ($this->schema_update_required() || $force_update) {
+			foreach ($this->tables as $table) {
 				/**
 				 * Allow custom processing before updating a table schema.
 				 *
 				 * @param string $table Name of table being updated.
 				 * @param string $db_version Existing version of the table being updated.
 				 */
-				do_action( 'action_scheduler_before_schema_update', $table, $this->db_version );
-				$this->update_table( $table );
+				do_action('action_scheduler_before_schema_update', $table, $this->db_version);
+				$this->update_table($table);
 			}
 			$this->mark_schema_update_complete();
 		}
@@ -70,7 +70,7 @@ 
 	 *
 	 * @return string The CREATE TABLE statement, suitable for passing to dbDelta
 	 */
-	abstract protected function get_table_definition( $table );
+	abstract protected function get_table_definition($table);
 
 	/**
 	 * Determine if the database schema is out of date
@@ -80,15 +80,15 @@ 
 	 * @return bool
 	 */
 	private function schema_update_required() {
-		$option_name      = 'schema-' . static::class;
-		$this->db_version = get_option( $option_name, 0 );
+		$option_name      = 'schema-'.static::class;
+		$this->db_version = get_option($option_name, 0);
 
 		// Check for schema option stored by the Action Scheduler Custom Tables plugin in case site has migrated from that plugin with an older schema
-		if ( 0 === $this->db_version ) {
+		if (0 === $this->db_version) {
 
 			$plugin_option_name = 'schema-';
 
-			switch ( static::class ) {
+			switch (static::class) {
 				case 'ActionScheduler_StoreSchema':
 					$plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Store_Table_Maker';
 					break;
@@ -97,12 +97,12 @@ 
 					break;
 			}
 
-			$this->db_version = get_option( $plugin_option_name, 0 );
+			$this->db_version = get_option($plugin_option_name, 0);
 
-			delete_option( $plugin_option_name );
+			delete_option($plugin_option_name);
 		}
 
-		return version_compare( $this->db_version, $this->schema_version, '<' );
+		return version_compare($this->db_version, $this->schema_version, '<');
 	}
 
 	/**
@@ -112,12 +112,12 @@ 
 	 * @return void
 	 */
 	private function mark_schema_update_complete() {
-		$option_name = 'schema-' . static::class;
+		$option_name = 'schema-'.static::class;
 
 		// work around race conditions and ensure that our option updates
-		$value_to_save = (string) $this->schema_version . '.0.' . time();
+		$value_to_save = (string) $this->schema_version.'.0.'.time();
 
-		update_option( $option_name, $value_to_save );
+		update_option($option_name, $value_to_save);
 	}
 
 	/**
@@ -127,14 +127,14 @@ 
 	 *
 	 * @return void
 	 */
-	private function update_table( $table ) {
-		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
-		$definition = $this->get_table_definition( $table );
-		if ( $definition ) {
-			$updated = dbDelta( $definition );
-			foreach ( $updated as $updated_table => $update_description ) {
-				if ( strpos( $update_description, 'Created table' ) === 0 ) {
-					do_action( 'action_scheduler/created_table', $updated_table, $table );
+	private function update_table($table) {
+		require_once ABSPATH.'wp-admin/includes/upgrade.php';
+		$definition = $this->get_table_definition($table);
+		if ($definition) {
+			$updated = dbDelta($definition);
+			foreach ($updated as $updated_table => $update_description) {
+				if (strpos($update_description, 'Created table') === 0) {
+					do_action('action_scheduler/created_table', $updated_table, $table);
 				}
 			}
 		}
@@ -146,8 +146,8 @@ 
 	 * @return string The full name of the table, including the
 	 *                table prefix for the current blog
 	 */
-	protected function get_full_table_name( $table ) {
-		return $GLOBALS['wpdb']->prefix . $table;
+	protected function get_full_table_name($table) {
+		return $GLOBALS['wpdb']->prefix.$table;
 	}
 
 	/**
@@ -158,14 +158,14 @@ 
 	public function tables_exist() {
 		global $wpdb;
 
-		$existing_tables = $wpdb->get_col( 'SHOW TABLES' );
+		$existing_tables = $wpdb->get_col('SHOW TABLES');
 		$expected_tables = array_map(
-			function ( $table_name ) use ( $wpdb ) {
-				return $wpdb->prefix . $table_name;
+			function($table_name) use ($wpdb) {
+				return $wpdb->prefix.$table_name;
 			},
 			$this->tables
 		);
 
-		return count( array_intersect( $existing_tables, $expected_tables ) ) === count( $expected_tables );
+		return count(array_intersect($existing_tables, $expected_tables)) === count($expected_tables);
 	}
 }

src/ext/action-scheduler/classes/abstracts/ActionScheduler_TimezoneHelper.php

Indentation +145 added lines, -145 removed lines

@@ -4,149 +4,149 @@
  * Class ActionScheduler_TimezoneHelper
  */
 abstract class ActionScheduler_TimezoneHelper {
-	private static $local_timezone = null;
-
-	/**
-	 * Set a DateTime's timezone to the WordPress site's timezone, or a UTC offset
-	 * if no timezone string is available.
-	 *
-	 * @since  2.1.0
-	 *
-	 * @param DateTime $date
-	 * @return ActionScheduler_DateTime
-	 */
-	public static function set_local_timezone( DateTime $date ) {
-
-		// Accept a DateTime for easier backward compatibility, even though we require methods on ActionScheduler_DateTime
-		if ( ! is_a( $date, 'ActionScheduler_DateTime' ) ) {
-			$date = as_get_datetime_object( $date->format( 'U' ) );
-		}
-
-		if ( get_option( 'timezone_string' ) ) {
-			$date->setTimezone( new DateTimeZone( self::get_local_timezone_string() ) );
-		} else {
-			$date->setUtcOffset( self::get_local_timezone_offset() );
-		}
-
-		return $date;
-	}
-
-	/**
-	 * Helper to retrieve the timezone string for a site until a WP core method exists
-	 * (see https://core.trac.wordpress.org/ticket/24730).
-	 *
-	 * Adapted from wc_timezone_string() and https://secure.php.net/manual/en/function.timezone-name-from-abbr.php#89155.
-	 *
-	 * If no timezone string is set, and its not possible to match the UTC offset set for the site to a timezone
-	 * string, then an empty string will be returned, and the UTC offset should be used to set a DateTime's
-	 * timezone.
-	 *
-	 * @since 2.1.0
-	 * @return string PHP timezone string for the site or empty if no timezone string is available.
-	 */
-	protected static function get_local_timezone_string( $reset = false ) {
-		// If site timezone string exists, return it.
-		$timezone = get_option( 'timezone_string' );
-		if ( $timezone ) {
-			return $timezone;
-		}
-
-		// Get UTC offset, if it isn't set then return UTC.
-		$utc_offset = intval( get_option( 'gmt_offset', 0 ) );
-		if ( 0 === $utc_offset ) {
-			return 'UTC';
-		}
-
-		// Adjust UTC offset from hours to seconds.
-		$utc_offset *= 3600;
-
-		// Attempt to guess the timezone string from the UTC offset.
-		$timezone = timezone_name_from_abbr( '', $utc_offset );
-		if ( $timezone ) {
-			return $timezone;
-		}
-
-		// Last try, guess timezone string manually.
-		foreach ( timezone_abbreviations_list() as $abbr ) {
-			foreach ( $abbr as $city ) {
-				if ( (bool) date( 'I' ) === (bool) $city['dst'] && $city['timezone_id'] && intval( $city['offset'] ) === $utc_offset ) {
-					return $city['timezone_id'];
-				}
-			}
-		}
-
-		// No timezone string
-		return '';
-	}
-
-	/**
-	 * Get timezone offset in seconds.
-	 *
-	 * @since  2.1.0
-	 * @return float
-	 */
-	protected static function get_local_timezone_offset() {
-		$timezone = get_option( 'timezone_string' );
-
-		if ( $timezone ) {
-			$timezone_object = new DateTimeZone( $timezone );
-			return $timezone_object->getOffset( new DateTime( 'now' ) );
-		} else {
-			return floatval( get_option( 'gmt_offset', 0 ) ) * HOUR_IN_SECONDS;
-		}
-	}
-
-	/**
-	 * @deprecated 2.1.0
-	 */
-	public static function get_local_timezone( $reset = false ) {
-		_deprecated_function( __FUNCTION__, '2.1.0', 'ActionScheduler_TimezoneHelper::set_local_timezone()' );
-		if ( $reset ) {
-			self::$local_timezone = null;
-		}
-		if ( ! isset( self::$local_timezone ) ) {
-			$tzstring = get_option( 'timezone_string' );
-
-			if ( empty( $tzstring ) ) {
-				$gmt_offset = get_option( 'gmt_offset' );
-				if ( $gmt_offset == 0 ) {
-					$tzstring = 'UTC';
-				} else {
-					$gmt_offset *= HOUR_IN_SECONDS;
-					$tzstring    = timezone_name_from_abbr( '', $gmt_offset, 1 );
-
-					// If there's no timezone string, try again with no DST.
-					if ( false === $tzstring ) {
-						$tzstring = timezone_name_from_abbr( '', $gmt_offset, 0 );
-					}
-
-					// Try mapping to the first abbreviation we can find.
-					if ( false === $tzstring ) {
-						$is_dst = date( 'I' );
-						foreach ( timezone_abbreviations_list() as $abbr ) {
-							foreach ( $abbr as $city ) {
-								if ( $city['dst'] == $is_dst && $city['offset'] == $gmt_offset ) {
-									// If there's no valid timezone ID, keep looking.
-									if ( null === $city['timezone_id'] ) {
-										continue;
-									}
-
-									$tzstring = $city['timezone_id'];
-									break 2;
-								}
-							}
-						}
-					}
-
-					// If we still have no valid string, then fall back to UTC.
-					if ( false === $tzstring ) {
-						$tzstring = 'UTC';
-					}
-				}
-			}
-
-			self::$local_timezone = new DateTimeZone( $tzstring );
-		}
-		return self::$local_timezone;
-	}
+    private static $local_timezone = null;
+
+    /**
+     * Set a DateTime's timezone to the WordPress site's timezone, or a UTC offset
+     * if no timezone string is available.
+     *
+     * @since  2.1.0
+     *
+     * @param DateTime $date
+     * @return ActionScheduler_DateTime
+     */
+    public static function set_local_timezone( DateTime $date ) {
+
+        // Accept a DateTime for easier backward compatibility, even though we require methods on ActionScheduler_DateTime
+        if ( ! is_a( $date, 'ActionScheduler_DateTime' ) ) {
+            $date = as_get_datetime_object( $date->format( 'U' ) );
+        }
+
+        if ( get_option( 'timezone_string' ) ) {
+            $date->setTimezone( new DateTimeZone( self::get_local_timezone_string() ) );
+        } else {
+            $date->setUtcOffset( self::get_local_timezone_offset() );
+        }
+
+        return $date;
+    }
+
+    /**
+     * Helper to retrieve the timezone string for a site until a WP core method exists
+     * (see https://core.trac.wordpress.org/ticket/24730).
+     *
+     * Adapted from wc_timezone_string() and https://secure.php.net/manual/en/function.timezone-name-from-abbr.php#89155.
+     *
+     * If no timezone string is set, and its not possible to match the UTC offset set for the site to a timezone
+     * string, then an empty string will be returned, and the UTC offset should be used to set a DateTime's
+     * timezone.
+     *
+     * @since 2.1.0
+     * @return string PHP timezone string for the site or empty if no timezone string is available.
+     */
+    protected static function get_local_timezone_string( $reset = false ) {
+        // If site timezone string exists, return it.
+        $timezone = get_option( 'timezone_string' );
+        if ( $timezone ) {
+            return $timezone;
+        }
+
+        // Get UTC offset, if it isn't set then return UTC.
+        $utc_offset = intval( get_option( 'gmt_offset', 0 ) );
+        if ( 0 === $utc_offset ) {
+            return 'UTC';
+        }
+
+        // Adjust UTC offset from hours to seconds.
+        $utc_offset *= 3600;
+
+        // Attempt to guess the timezone string from the UTC offset.
+        $timezone = timezone_name_from_abbr( '', $utc_offset );
+        if ( $timezone ) {
+            return $timezone;
+        }
+
+        // Last try, guess timezone string manually.
+        foreach ( timezone_abbreviations_list() as $abbr ) {
+            foreach ( $abbr as $city ) {
+                if ( (bool) date( 'I' ) === (bool) $city['dst'] && $city['timezone_id'] && intval( $city['offset'] ) === $utc_offset ) {
+                    return $city['timezone_id'];
+                }
+            }
+        }
+
+        // No timezone string
+        return '';
+    }
+
+    /**
+     * Get timezone offset in seconds.
+     *
+     * @since  2.1.0
+     * @return float
+     */
+    protected static function get_local_timezone_offset() {
+        $timezone = get_option( 'timezone_string' );
+
+        if ( $timezone ) {
+            $timezone_object = new DateTimeZone( $timezone );
+            return $timezone_object->getOffset( new DateTime( 'now' ) );
+        } else {
+            return floatval( get_option( 'gmt_offset', 0 ) ) * HOUR_IN_SECONDS;
+        }
+    }
+
+    /**
+     * @deprecated 2.1.0
+     */
+    public static function get_local_timezone( $reset = false ) {
+        _deprecated_function( __FUNCTION__, '2.1.0', 'ActionScheduler_TimezoneHelper::set_local_timezone()' );
+        if ( $reset ) {
+            self::$local_timezone = null;
+        }
+        if ( ! isset( self::$local_timezone ) ) {
+            $tzstring = get_option( 'timezone_string' );
+
+            if ( empty( $tzstring ) ) {
+                $gmt_offset = get_option( 'gmt_offset' );
+                if ( $gmt_offset == 0 ) {
+                    $tzstring = 'UTC';
+                } else {
+                    $gmt_offset *= HOUR_IN_SECONDS;
+                    $tzstring    = timezone_name_from_abbr( '', $gmt_offset, 1 );
+
+                    // If there's no timezone string, try again with no DST.
+                    if ( false === $tzstring ) {
+                        $tzstring = timezone_name_from_abbr( '', $gmt_offset, 0 );
+                    }
+
+                    // Try mapping to the first abbreviation we can find.
+                    if ( false === $tzstring ) {
+                        $is_dst = date( 'I' );
+                        foreach ( timezone_abbreviations_list() as $abbr ) {
+                            foreach ( $abbr as $city ) {
+                                if ( $city['dst'] == $is_dst && $city['offset'] == $gmt_offset ) {
+                                    // If there's no valid timezone ID, keep looking.
+                                    if ( null === $city['timezone_id'] ) {
+                                        continue;
+                                    }
+
+                                    $tzstring = $city['timezone_id'];
+                                    break 2;
+                                }
+                            }
+                        }
+                    }
+
+                    // If we still have no valid string, then fall back to UTC.
+                    if ( false === $tzstring ) {
+                        $tzstring = 'UTC';
+                    }
+                }
+            }
+
+            self::$local_timezone = new DateTimeZone( $tzstring );
+        }
+        return self::$local_timezone;
+    }
 }

Spacing +40 added lines, -40 removed lines

@@ -15,17 +15,17 @@ 
 	 * @param DateTime $date
 	 * @return ActionScheduler_DateTime
 	 */
-	public static function set_local_timezone( DateTime $date ) {
+	public static function set_local_timezone(DateTime $date) {
 
 		// Accept a DateTime for easier backward compatibility, even though we require methods on ActionScheduler_DateTime
-		if ( ! is_a( $date, 'ActionScheduler_DateTime' ) ) {
-			$date = as_get_datetime_object( $date->format( 'U' ) );
+		if ( ! is_a($date, 'ActionScheduler_DateTime')) {
+			$date = as_get_datetime_object($date->format('U'));
 		}
 
-		if ( get_option( 'timezone_string' ) ) {
-			$date->setTimezone( new DateTimeZone( self::get_local_timezone_string() ) );
+		if (get_option('timezone_string')) {
+			$date->setTimezone(new DateTimeZone(self::get_local_timezone_string()));
 		} else {
-			$date->setUtcOffset( self::get_local_timezone_offset() );
+			$date->setUtcOffset(self::get_local_timezone_offset());
 		}
 
 		return $date;
@@ -44,16 +44,16 @@ 
 	 * @since 2.1.0
 	 * @return string PHP timezone string for the site or empty if no timezone string is available.
 	 */
-	protected static function get_local_timezone_string( $reset = false ) {
+	protected static function get_local_timezone_string($reset = false) {
 		// If site timezone string exists, return it.
-		$timezone = get_option( 'timezone_string' );
-		if ( $timezone ) {
+		$timezone = get_option('timezone_string');
+		if ($timezone) {
 			return $timezone;
 		}
 
 		// Get UTC offset, if it isn't set then return UTC.
-		$utc_offset = intval( get_option( 'gmt_offset', 0 ) );
-		if ( 0 === $utc_offset ) {
+		$utc_offset = intval(get_option('gmt_offset', 0));
+		if (0 === $utc_offset) {
 			return 'UTC';
 		}
 
@@ -61,15 +61,15 @@ 
 		$utc_offset *= 3600;
 
 		// Attempt to guess the timezone string from the UTC offset.
-		$timezone = timezone_name_from_abbr( '', $utc_offset );
-		if ( $timezone ) {
+		$timezone = timezone_name_from_abbr('', $utc_offset);
+		if ($timezone) {
 			return $timezone;
 		}
 
 		// Last try, guess timezone string manually.
-		foreach ( timezone_abbreviations_list() as $abbr ) {
-			foreach ( $abbr as $city ) {
-				if ( (bool) date( 'I' ) === (bool) $city['dst'] && $city['timezone_id'] && intval( $city['offset'] ) === $utc_offset ) {
+		foreach (timezone_abbreviations_list() as $abbr) {
+			foreach ($abbr as $city) {
+				if ((bool) date('I') === (bool) $city['dst'] && $city['timezone_id'] && intval($city['offset']) === $utc_offset) {
 					return $city['timezone_id'];
 				}
 			}
@@ -86,48 +86,48 @@ 
 	 * @return float
 	 */
 	protected static function get_local_timezone_offset() {
-		$timezone = get_option( 'timezone_string' );
+		$timezone = get_option('timezone_string');
 
-		if ( $timezone ) {
-			$timezone_object = new DateTimeZone( $timezone );
-			return $timezone_object->getOffset( new DateTime( 'now' ) );
+		if ($timezone) {
+			$timezone_object = new DateTimeZone($timezone);
+			return $timezone_object->getOffset(new DateTime('now'));
 		} else {
-			return floatval( get_option( 'gmt_offset', 0 ) ) * HOUR_IN_SECONDS;
+			return floatval(get_option('gmt_offset', 0)) * HOUR_IN_SECONDS;
 		}
 	}
 
 	/**
 	 * @deprecated 2.1.0
 	 */
-	public static function get_local_timezone( $reset = false ) {
-		_deprecated_function( __FUNCTION__, '2.1.0', 'ActionScheduler_TimezoneHelper::set_local_timezone()' );
-		if ( $reset ) {
+	public static function get_local_timezone($reset = false) {
+		_deprecated_function(__FUNCTION__, '2.1.0', 'ActionScheduler_TimezoneHelper::set_local_timezone()');
+		if ($reset) {
 			self::$local_timezone = null;
 		}
-		if ( ! isset( self::$local_timezone ) ) {
-			$tzstring = get_option( 'timezone_string' );
+		if ( ! isset(self::$local_timezone)) {
+			$tzstring = get_option('timezone_string');
 
-			if ( empty( $tzstring ) ) {
-				$gmt_offset = get_option( 'gmt_offset' );
-				if ( $gmt_offset == 0 ) {
+			if (empty($tzstring)) {
+				$gmt_offset = get_option('gmt_offset');
+				if ($gmt_offset == 0) {
 					$tzstring = 'UTC';
 				} else {
 					$gmt_offset *= HOUR_IN_SECONDS;
-					$tzstring    = timezone_name_from_abbr( '', $gmt_offset, 1 );
+					$tzstring    = timezone_name_from_abbr('', $gmt_offset, 1);
 
 					// If there's no timezone string, try again with no DST.
-					if ( false === $tzstring ) {
-						$tzstring = timezone_name_from_abbr( '', $gmt_offset, 0 );
+					if (false === $tzstring) {
+						$tzstring = timezone_name_from_abbr('', $gmt_offset, 0);
 					}
 
 					// Try mapping to the first abbreviation we can find.
-					if ( false === $tzstring ) {
-						$is_dst = date( 'I' );
-						foreach ( timezone_abbreviations_list() as $abbr ) {
-							foreach ( $abbr as $city ) {
-								if ( $city['dst'] == $is_dst && $city['offset'] == $gmt_offset ) {
+					if (false === $tzstring) {
+						$is_dst = date('I');
+						foreach (timezone_abbreviations_list() as $abbr) {
+							foreach ($abbr as $city) {
+								if ($city['dst'] == $is_dst && $city['offset'] == $gmt_offset) {
 									// If there's no valid timezone ID, keep looking.
-									if ( null === $city['timezone_id'] ) {
+									if (null === $city['timezone_id']) {
 										continue;
 									}
 
@@ -139,13 +139,13 @@ 
 					}
 
 					// If we still have no valid string, then fall back to UTC.
-					if ( false === $tzstring ) {
+					if (false === $tzstring) {
 						$tzstring = 'UTC';
 					}
 				}
 			}
 
-			self::$local_timezone = new DateTimeZone( $tzstring );
+			self::$local_timezone = new DateTimeZone($tzstring);
 		}
 		return self::$local_timezone;
 	}

src/ext/action-scheduler/classes/abstracts/ActionScheduler_Abstract_RecurringSchedule.php

Indentation +90 added lines, -90 removed lines

@@ -5,102 +5,102 @@
  */
 abstract class ActionScheduler_Abstract_RecurringSchedule extends ActionScheduler_Abstract_Schedule {
 
-	/**
-	 * The date & time the first instance of this schedule was setup to run (which may not be this instance).
-	 *
-	 * Schedule objects are attached to an action object. Each schedule stores the run date for that
-	 * object as the start date - @see $this->start - and logic to calculate the next run date after
-	 * that - @see $this->calculate_next(). The $first_date property also keeps a record of when the very
-	 * first instance of this chain of schedules ran.
-	 *
-	 * @var DateTime
-	 */
-	private $first_date = null;
+    /**
+     * The date & time the first instance of this schedule was setup to run (which may not be this instance).
+     *
+     * Schedule objects are attached to an action object. Each schedule stores the run date for that
+     * object as the start date - @see $this->start - and logic to calculate the next run date after
+     * that - @see $this->calculate_next(). The $first_date property also keeps a record of when the very
+     * first instance of this chain of schedules ran.
+     *
+     * @var DateTime
+     */
+    private $first_date = null;
 
-	/**
-	 * Timestamp equivalent of @see $this->first_date
-	 *
-	 * @var int
-	 */
-	protected $first_timestamp = null;
+    /**
+     * Timestamp equivalent of @see $this->first_date
+     *
+     * @var int
+     */
+    protected $first_timestamp = null;
 
-	/**
-	 * The recurrance between each time an action is run using this schedule.
-	 * Used to calculate the start date & time. Can be a number of seconds, in the
-	 * case of ActionScheduler_IntervalSchedule, or a cron expression, as in the
-	 * case of ActionScheduler_CronSchedule. Or something else.
-	 *
-	 * @var mixed
-	 */
-	protected $recurrence;
+    /**
+     * The recurrance between each time an action is run using this schedule.
+     * Used to calculate the start date & time. Can be a number of seconds, in the
+     * case of ActionScheduler_IntervalSchedule, or a cron expression, as in the
+     * case of ActionScheduler_CronSchedule. Or something else.
+     *
+     * @var mixed
+     */
+    protected $recurrence;
 
-	/**
-	 * @param DateTime      $date The date & time to run the action.
-	 * @param mixed         $recurrence The data used to determine the schedule's recurrance.
-	 * @param DateTime|null $first (Optional) The date & time the first instance of this interval schedule ran. Default null, meaning this is the first instance.
-	 */
-	public function __construct( DateTime $date, $recurrence, DateTime $first = null ) {
-		parent::__construct( $date );
-		$this->first_date = empty( $first ) ? $date : $first;
-		$this->recurrence = $recurrence;
-	}
+    /**
+     * @param DateTime      $date The date & time to run the action.
+     * @param mixed         $recurrence The data used to determine the schedule's recurrance.
+     * @param DateTime|null $first (Optional) The date & time the first instance of this interval schedule ran. Default null, meaning this is the first instance.
+     */
+    public function __construct( DateTime $date, $recurrence, DateTime $first = null ) {
+        parent::__construct( $date );
+        $this->first_date = empty( $first ) ? $date : $first;
+        $this->recurrence = $recurrence;
+    }
 
-	/**
-	 * @return bool
-	 */
-	public function is_recurring() {
-		return true;
-	}
+    /**
+     * @return bool
+     */
+    public function is_recurring() {
+        return true;
+    }
 
-	/**
-	 * Get the date & time of the first schedule in this recurring series.
-	 *
-	 * @return DateTime|null
-	 */
-	public function get_first_date() {
-		return clone $this->first_date;
-	}
+    /**
+     * Get the date & time of the first schedule in this recurring series.
+     *
+     * @return DateTime|null
+     */
+    public function get_first_date() {
+        return clone $this->first_date;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function get_recurrence() {
-		return $this->recurrence;
-	}
+    /**
+     * @return string
+     */
+    public function get_recurrence() {
+        return $this->recurrence;
+    }
 
-	/**
-	 * For PHP 5.2 compat, since DateTime objects can't be serialized
-	 *
-	 * @return array
-	 */
-	public function __sleep() {
-		$sleep_params          = parent::__sleep();
-		$this->first_timestamp = $this->first_date->getTimestamp();
-		return array_merge(
-			$sleep_params,
-			array(
-				'first_timestamp',
-				'recurrence',
-			)
-		);
-	}
+    /**
+     * For PHP 5.2 compat, since DateTime objects can't be serialized
+     *
+     * @return array
+     */
+    public function __sleep() {
+        $sleep_params          = parent::__sleep();
+        $this->first_timestamp = $this->first_date->getTimestamp();
+        return array_merge(
+            $sleep_params,
+            array(
+                'first_timestamp',
+                'recurrence',
+            )
+        );
+    }
 
-	/**
-	 * Unserialize recurring schedules serialized/stored prior to AS 3.0.0
-	 *
-	 * Prior to Action Scheduler 3.0.0, schedules used different property names to refer
-	 * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp
-	 * was the same as ActionScheduler_SimpleSchedule::timestamp. This was addressed in
-	 * Action Scheduler 3.0.0, where properties and property names were aligned for better
-	 * inheritance. To maintain backward compatibility with scheduled serialized and stored
-	 * prior to 3.0, we need to correctly map the old property names.
-	 */
-	public function __wakeup() {
-		parent::__wakeup();
-		if ( $this->first_timestamp > 0 ) {
-			$this->first_date = as_get_datetime_object( $this->first_timestamp );
-		} else {
-			$this->first_date = $this->get_date();
-		}
-	}
+    /**
+     * Unserialize recurring schedules serialized/stored prior to AS 3.0.0
+     *
+     * Prior to Action Scheduler 3.0.0, schedules used different property names to refer
+     * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp
+     * was the same as ActionScheduler_SimpleSchedule::timestamp. This was addressed in
+     * Action Scheduler 3.0.0, where properties and property names were aligned for better
+     * inheritance. To maintain backward compatibility with scheduled serialized and stored
+     * prior to 3.0, we need to correctly map the old property names.
+     */
+    public function __wakeup() {
+        parent::__wakeup();
+        if ( $this->first_timestamp > 0 ) {
+            $this->first_date = as_get_datetime_object( $this->first_timestamp );
+        } else {
+            $this->first_date = $this->get_date();
+        }
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -39,9 +39,9 @@ 
 	 * @param mixed         $recurrence The data used to determine the schedule's recurrance.
 	 * @param DateTime|null $first (Optional) The date & time the first instance of this interval schedule ran. Default null, meaning this is the first instance.
 	 */
-	public function __construct( DateTime $date, $recurrence, DateTime $first = null ) {
-		parent::__construct( $date );
-		$this->first_date = empty( $first ) ? $date : $first;
+	public function __construct(DateTime $date, $recurrence, DateTime $first = null) {
+		parent::__construct($date);
+		$this->first_date = empty($first) ? $date : $first;
 		$this->recurrence = $recurrence;
 	}
 
@@ -97,8 +97,8 @@ 
 	 */
 	public function __wakeup() {
 		parent::__wakeup();
-		if ( $this->first_timestamp > 0 ) {
-			$this->first_date = as_get_datetime_object( $this->first_timestamp );
+		if ($this->first_timestamp > 0) {
+			$this->first_date = as_get_datetime_object($this->first_timestamp);
 		} else {
 			$this->first_date = $this->get_date();
 		}

src/ext/action-scheduler/classes/abstracts/ActionScheduler_Lock.php

Indentation +52 added lines, -52 removed lines

@@ -7,56 +7,56 @@
  */
 abstract class ActionScheduler_Lock {
 
-	/** @var ActionScheduler_Lock */
-	private static $locker = null;
-
-	/** @var int */
-	protected static $lock_duration = MINUTE_IN_SECONDS;
-
-	/**
-	 * Check if a lock is set for a given lock type.
-	 *
-	 * @param string $lock_type A string to identify different lock types.
-	 * @return bool
-	 */
-	public function is_locked( $lock_type ) {
-		return ( $this->get_expiration( $lock_type ) >= time() );
-	}
-
-	/**
-	 * Set a lock.
-	 *
-	 * @param string $lock_type A string to identify different lock types.
-	 * @return bool
-	 */
-	abstract public function set( $lock_type );
-
-	/**
-	 * If a lock is set, return the timestamp it was set to expiry.
-	 *
-	 * @param string $lock_type A string to identify different lock types.
-	 * @return bool|int False if no lock is set, otherwise the timestamp for when the lock is set to expire.
-	 */
-	abstract public function get_expiration( $lock_type );
-
-	/**
-	 * Get the amount of time to set for a given lock. 60 seconds by default.
-	 *
-	 * @param string $lock_type A string to identify different lock types.
-	 * @return int
-	 */
-	protected function get_duration( $lock_type ) {
-		return apply_filters( 'action_scheduler_lock_duration', self::$lock_duration, $lock_type );
-	}
-
-	/**
-	 * @return ActionScheduler_Lock
-	 */
-	public static function instance() {
-		if ( empty( self::$locker ) ) {
-			$class        = apply_filters( 'action_scheduler_lock_class', 'ActionScheduler_OptionLock' );
-			self::$locker = new $class();
-		}
-		return self::$locker;
-	}
+    /** @var ActionScheduler_Lock */
+    private static $locker = null;
+
+    /** @var int */
+    protected static $lock_duration = MINUTE_IN_SECONDS;
+
+    /**
+     * Check if a lock is set for a given lock type.
+     *
+     * @param string $lock_type A string to identify different lock types.
+     * @return bool
+     */
+    public function is_locked( $lock_type ) {
+        return ( $this->get_expiration( $lock_type ) >= time() );
+    }
+
+    /**
+     * Set a lock.
+     *
+     * @param string $lock_type A string to identify different lock types.
+     * @return bool
+     */
+    abstract public function set( $lock_type );
+
+    /**
+     * If a lock is set, return the timestamp it was set to expiry.
+     *
+     * @param string $lock_type A string to identify different lock types.
+     * @return bool|int False if no lock is set, otherwise the timestamp for when the lock is set to expire.
+     */
+    abstract public function get_expiration( $lock_type );
+
+    /**
+     * Get the amount of time to set for a given lock. 60 seconds by default.
+     *
+     * @param string $lock_type A string to identify different lock types.
+     * @return int
+     */
+    protected function get_duration( $lock_type ) {
+        return apply_filters( 'action_scheduler_lock_duration', self::$lock_duration, $lock_type );
+    }
+
+    /**
+     * @return ActionScheduler_Lock
+     */
+    public static function instance() {
+        if ( empty( self::$locker ) ) {
+            $class        = apply_filters( 'action_scheduler_lock_class', 'ActionScheduler_OptionLock' );
+            self::$locker = new $class();
+        }
+        return self::$locker;
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -19,8 +19,8 @@ 
 	 * @param string $lock_type A string to identify different lock types.
 	 * @return bool
 	 */
-	public function is_locked( $lock_type ) {
-		return ( $this->get_expiration( $lock_type ) >= time() );
+	public function is_locked($lock_type) {
+		return ($this->get_expiration($lock_type) >= time());
 	}
 
 	/**
@@ -29,7 +29,7 @@ 
 	 * @param string $lock_type A string to identify different lock types.
 	 * @return bool
 	 */
-	abstract public function set( $lock_type );
+	abstract public function set($lock_type);
 
 	/**
 	 * If a lock is set, return the timestamp it was set to expiry.
@@ -37,7 +37,7 @@ 
 	 * @param string $lock_type A string to identify different lock types.
 	 * @return bool|int False if no lock is set, otherwise the timestamp for when the lock is set to expire.
 	 */
-	abstract public function get_expiration( $lock_type );
+	abstract public function get_expiration($lock_type);
 
 	/**
 	 * Get the amount of time to set for a given lock. 60 seconds by default.
@@ -45,16 +45,16 @@ 
 	 * @param string $lock_type A string to identify different lock types.
 	 * @return int
 	 */
-	protected function get_duration( $lock_type ) {
-		return apply_filters( 'action_scheduler_lock_duration', self::$lock_duration, $lock_type );
+	protected function get_duration($lock_type) {
+		return apply_filters('action_scheduler_lock_duration', self::$lock_duration, $lock_type);
 	}
 
 	/**
 	 * @return ActionScheduler_Lock
 	 */
 	public static function instance() {
-		if ( empty( self::$locker ) ) {
-			$class        = apply_filters( 'action_scheduler_lock_class', 'ActionScheduler_OptionLock' );
+		if (empty(self::$locker)) {
+			$class        = apply_filters('action_scheduler_lock_class', 'ActionScheduler_OptionLock');
 			self::$locker = new $class();
 		}
 		return self::$locker;

src/ext/action-scheduler/classes/abstracts/ActionScheduler_Logger.php

Indentation +167 added lines, -167 removed lines

@@ -6,171 +6,171 @@
  * @codeCoverageIgnore
  */
 abstract class ActionScheduler_Logger {
-	private static $logger = null;
-
-	/**
-	 * @return ActionScheduler_Logger
-	 */
-	public static function instance() {
-		if ( empty( self::$logger ) ) {
-			$class        = apply_filters( 'action_scheduler_logger_class', 'ActionScheduler_wpCommentLogger' );
-			self::$logger = new $class();
-		}
-		return self::$logger;
-	}
-
-	/**
-	 * @param string   $action_id
-	 * @param string   $message
-	 * @param DateTime $date
-	 *
-	 * @return string The log entry ID
-	 */
-	abstract public function log( $action_id, $message, DateTime $date = null );
-
-	/**
-	 * @param string $entry_id
-	 *
-	 * @return ActionScheduler_LogEntry
-	 */
-	abstract public function get_entry( $entry_id );
-
-	/**
-	 * @param string $action_id
-	 *
-	 * @return ActionScheduler_LogEntry[]
-	 */
-	abstract public function get_logs( $action_id );
-
-	/**
-	 * @codeCoverageIgnore
-	 */
-	public function init() {
-		$this->hook_stored_action();
-		add_action( 'action_scheduler_canceled_action', array( $this, 'log_canceled_action' ), 10, 1 );
-		add_action( 'action_scheduler_begin_execute', array( $this, 'log_started_action' ), 10, 2 );
-		add_action( 'action_scheduler_after_execute', array( $this, 'log_completed_action' ), 10, 3 );
-		add_action( 'action_scheduler_failed_execution', array( $this, 'log_failed_action' ), 10, 3 );
-		add_action( 'action_scheduler_failed_action', array( $this, 'log_timed_out_action' ), 10, 2 );
-		add_action( 'action_scheduler_unexpected_shutdown', array( $this, 'log_unexpected_shutdown' ), 10, 2 );
-		add_action( 'action_scheduler_reset_action', array( $this, 'log_reset_action' ), 10, 1 );
-		add_action( 'action_scheduler_execution_ignored', array( $this, 'log_ignored_action' ), 10, 2 );
-		add_action( 'action_scheduler_failed_fetch_action', array( $this, 'log_failed_fetch_action' ), 10, 2 );
-		add_action( 'action_scheduler_failed_to_schedule_next_instance', array( $this, 'log_failed_schedule_next_instance' ), 10, 2 );
-		add_action( 'action_scheduler_bulk_cancel_actions', array( $this, 'bulk_log_cancel_actions' ), 10, 1 );
-	}
-
-	public function hook_stored_action() {
-		add_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
-	}
-
-	public function unhook_stored_action() {
-		remove_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
-	}
-
-	public function log_stored_action( $action_id ) {
-		$this->log( $action_id, __( 'action created', 'action-scheduler' ) );
-	}
-
-	public function log_canceled_action( $action_id ) {
-		$this->log( $action_id, __( 'action canceled', 'action-scheduler' ) );
-	}
-
-	public function log_started_action( $action_id, $context = '' ) {
-		if ( ! empty( $context ) ) {
-			/* translators: %s: context */
-			$message = sprintf( __( 'action started via %s', 'action-scheduler' ), $context );
-		} else {
-			$message = __( 'action started', 'action-scheduler' );
-		}
-		$this->log( $action_id, $message );
-	}
-
-	public function log_completed_action( $action_id, $action = null, $context = '' ) {
-		if ( ! empty( $context ) ) {
-			/* translators: %s: context */
-			$message = sprintf( __( 'action complete via %s', 'action-scheduler' ), $context );
-		} else {
-			$message = __( 'action complete', 'action-scheduler' );
-		}
-		$this->log( $action_id, $message );
-	}
-
-	public function log_failed_action( $action_id, Exception $exception, $context = '' ) {
-		if ( ! empty( $context ) ) {
-			/* translators: 1: context 2: exception message */
-			$message = sprintf( __( 'action failed via %1$s: %2$s', 'action-scheduler' ), $context, $exception->getMessage() );
-		} else {
-			/* translators: %s: exception message */
-			$message = sprintf( __( 'action failed: %s', 'action-scheduler' ), $exception->getMessage() );
-		}
-		$this->log( $action_id, $message );
-	}
-
-	public function log_timed_out_action( $action_id, $timeout ) {
-		/* translators: %s: amount of time */
-		$this->log( $action_id, sprintf( __( 'action marked as failed after %s seconds. Unknown error occurred. Check server, PHP and database error logs to diagnose cause.', 'action-scheduler' ), $timeout ) );
-	}
-
-	public function log_unexpected_shutdown( $action_id, $error ) {
-		if ( ! empty( $error ) ) {
-			/* translators: 1: error message 2: filename 3: line */
-			$this->log( $action_id, sprintf( __( 'unexpected shutdown: PHP Fatal error %1$s in %2$s on line %3$s', 'action-scheduler' ), $error['message'], $error['file'], $error['line'] ) );
-		}
-	}
-
-	public function log_reset_action( $action_id ) {
-		$this->log( $action_id, __( 'action reset', 'action-scheduler' ) );
-	}
-
-	public function log_ignored_action( $action_id, $context = '' ) {
-		if ( ! empty( $context ) ) {
-			/* translators: %s: context */
-			$message = sprintf( __( 'action ignored via %s', 'action-scheduler' ), $context );
-		} else {
-			$message = __( 'action ignored', 'action-scheduler' );
-		}
-		$this->log( $action_id, $message );
-	}
-
-	/**
-	 * @param string         $action_id
-	 * @param Exception|NULL $exception The exception which occured when fetching the action. NULL by default for backward compatibility.
-	 *
-	 * @return ActionScheduler_LogEntry[]
-	 */
-	public function log_failed_fetch_action( $action_id, Exception $exception = null ) {
-
-		if ( $exception !== null ) {
-			/* translators: %s: exception message */
-			$log_message = sprintf( __( 'There was a failure fetching this action: %s', 'action-scheduler' ), $exception->getMessage() );
-		} else {
-			$log_message = __( 'There was a failure fetching this action', 'action-scheduler' );
-		}
-
-		$this->log( $action_id, $log_message );
-	}
-
-	public function log_failed_schedule_next_instance( $action_id, Exception $exception ) {
-		/* translators: %s: exception message */
-		$this->log( $action_id, sprintf( __( 'There was a failure scheduling the next instance of this action: %s', 'action-scheduler' ), $exception->getMessage() ) );
-	}
-
-	/**
-	 * Bulk add cancel action log entries.
-	 *
-	 * Implemented here for backward compatibility. Should be implemented in parent loggers
-	 * for more performant bulk logging.
-	 *
-	 * @param array $action_ids List of action ID.
-	 */
-	public function bulk_log_cancel_actions( $action_ids ) {
-		if ( empty( $action_ids ) ) {
-			return;
-		}
-
-		foreach ( $action_ids as $action_id ) {
-			$this->log_canceled_action( $action_id );
-		}
-	}
+    private static $logger = null;
+
+    /**
+     * @return ActionScheduler_Logger
+     */
+    public static function instance() {
+        if ( empty( self::$logger ) ) {
+            $class        = apply_filters( 'action_scheduler_logger_class', 'ActionScheduler_wpCommentLogger' );
+            self::$logger = new $class();
+        }
+        return self::$logger;
+    }
+
+    /**
+     * @param string   $action_id
+     * @param string   $message
+     * @param DateTime $date
+     *
+     * @return string The log entry ID
+     */
+    abstract public function log( $action_id, $message, DateTime $date = null );
+
+    /**
+     * @param string $entry_id
+     *
+     * @return ActionScheduler_LogEntry
+     */
+    abstract public function get_entry( $entry_id );
+
+    /**
+     * @param string $action_id
+     *
+     * @return ActionScheduler_LogEntry[]
+     */
+    abstract public function get_logs( $action_id );
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function init() {
+        $this->hook_stored_action();
+        add_action( 'action_scheduler_canceled_action', array( $this, 'log_canceled_action' ), 10, 1 );
+        add_action( 'action_scheduler_begin_execute', array( $this, 'log_started_action' ), 10, 2 );
+        add_action( 'action_scheduler_after_execute', array( $this, 'log_completed_action' ), 10, 3 );
+        add_action( 'action_scheduler_failed_execution', array( $this, 'log_failed_action' ), 10, 3 );
+        add_action( 'action_scheduler_failed_action', array( $this, 'log_timed_out_action' ), 10, 2 );
+        add_action( 'action_scheduler_unexpected_shutdown', array( $this, 'log_unexpected_shutdown' ), 10, 2 );
+        add_action( 'action_scheduler_reset_action', array( $this, 'log_reset_action' ), 10, 1 );
+        add_action( 'action_scheduler_execution_ignored', array( $this, 'log_ignored_action' ), 10, 2 );
+        add_action( 'action_scheduler_failed_fetch_action', array( $this, 'log_failed_fetch_action' ), 10, 2 );
+        add_action( 'action_scheduler_failed_to_schedule_next_instance', array( $this, 'log_failed_schedule_next_instance' ), 10, 2 );
+        add_action( 'action_scheduler_bulk_cancel_actions', array( $this, 'bulk_log_cancel_actions' ), 10, 1 );
+    }
+
+    public function hook_stored_action() {
+        add_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
+    }
+
+    public function unhook_stored_action() {
+        remove_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
+    }
+
+    public function log_stored_action( $action_id ) {
+        $this->log( $action_id, __( 'action created', 'action-scheduler' ) );
+    }
+
+    public function log_canceled_action( $action_id ) {
+        $this->log( $action_id, __( 'action canceled', 'action-scheduler' ) );
+    }
+
+    public function log_started_action( $action_id, $context = '' ) {
+        if ( ! empty( $context ) ) {
+            /* translators: %s: context */
+            $message = sprintf( __( 'action started via %s', 'action-scheduler' ), $context );
+        } else {
+            $message = __( 'action started', 'action-scheduler' );
+        }
+        $this->log( $action_id, $message );
+    }
+
+    public function log_completed_action( $action_id, $action = null, $context = '' ) {
+        if ( ! empty( $context ) ) {
+            /* translators: %s: context */
+            $message = sprintf( __( 'action complete via %s', 'action-scheduler' ), $context );
+        } else {
+            $message = __( 'action complete', 'action-scheduler' );
+        }
+        $this->log( $action_id, $message );
+    }
+
+    public function log_failed_action( $action_id, Exception $exception, $context = '' ) {
+        if ( ! empty( $context ) ) {
+            /* translators: 1: context 2: exception message */
+            $message = sprintf( __( 'action failed via %1$s: %2$s', 'action-scheduler' ), $context, $exception->getMessage() );
+        } else {
+            /* translators: %s: exception message */
+            $message = sprintf( __( 'action failed: %s', 'action-scheduler' ), $exception->getMessage() );
+        }
+        $this->log( $action_id, $message );
+    }
+
+    public function log_timed_out_action( $action_id, $timeout ) {
+        /* translators: %s: amount of time */
+        $this->log( $action_id, sprintf( __( 'action marked as failed after %s seconds. Unknown error occurred. Check server, PHP and database error logs to diagnose cause.', 'action-scheduler' ), $timeout ) );
+    }
+
+    public function log_unexpected_shutdown( $action_id, $error ) {
+        if ( ! empty( $error ) ) {
+            /* translators: 1: error message 2: filename 3: line */
+            $this->log( $action_id, sprintf( __( 'unexpected shutdown: PHP Fatal error %1$s in %2$s on line %3$s', 'action-scheduler' ), $error['message'], $error['file'], $error['line'] ) );
+        }
+    }
+
+    public function log_reset_action( $action_id ) {
+        $this->log( $action_id, __( 'action reset', 'action-scheduler' ) );
+    }
+
+    public function log_ignored_action( $action_id, $context = '' ) {
+        if ( ! empty( $context ) ) {
+            /* translators: %s: context */
+            $message = sprintf( __( 'action ignored via %s', 'action-scheduler' ), $context );
+        } else {
+            $message = __( 'action ignored', 'action-scheduler' );
+        }
+        $this->log( $action_id, $message );
+    }
+
+    /**
+     * @param string         $action_id
+     * @param Exception|NULL $exception The exception which occured when fetching the action. NULL by default for backward compatibility.
+     *
+     * @return ActionScheduler_LogEntry[]
+     */
+    public function log_failed_fetch_action( $action_id, Exception $exception = null ) {
+
+        if ( $exception !== null ) {
+            /* translators: %s: exception message */
+            $log_message = sprintf( __( 'There was a failure fetching this action: %s', 'action-scheduler' ), $exception->getMessage() );
+        } else {
+            $log_message = __( 'There was a failure fetching this action', 'action-scheduler' );
+        }
+
+        $this->log( $action_id, $log_message );
+    }
+
+    public function log_failed_schedule_next_instance( $action_id, Exception $exception ) {
+        /* translators: %s: exception message */
+        $this->log( $action_id, sprintf( __( 'There was a failure scheduling the next instance of this action: %s', 'action-scheduler' ), $exception->getMessage() ) );
+    }
+
+    /**
+     * Bulk add cancel action log entries.
+     *
+     * Implemented here for backward compatibility. Should be implemented in parent loggers
+     * for more performant bulk logging.
+     *
+     * @param array $action_ids List of action ID.
+     */
+    public function bulk_log_cancel_actions( $action_ids ) {
+        if ( empty( $action_ids ) ) {
+            return;
+        }
+
+        foreach ( $action_ids as $action_id ) {
+            $this->log_canceled_action( $action_id );
+        }
+    }
 }

Spacing +60 added lines, -60 removed lines

@@ -12,8 +12,8 @@ 
 	 * @return ActionScheduler_Logger
 	 */
 	public static function instance() {
-		if ( empty( self::$logger ) ) {
-			$class        = apply_filters( 'action_scheduler_logger_class', 'ActionScheduler_wpCommentLogger' );
+		if (empty(self::$logger)) {
+			$class        = apply_filters('action_scheduler_logger_class', 'ActionScheduler_wpCommentLogger');
 			self::$logger = new $class();
 		}
 		return self::$logger;
@@ -26,111 +26,111 @@ 
 	 *
 	 * @return string The log entry ID
 	 */
-	abstract public function log( $action_id, $message, DateTime $date = null );
+	abstract public function log($action_id, $message, DateTime $date = null);
 
 	/**
 	 * @param string $entry_id
 	 *
 	 * @return ActionScheduler_LogEntry
 	 */
-	abstract public function get_entry( $entry_id );
+	abstract public function get_entry($entry_id);
 
 	/**
 	 * @param string $action_id
 	 *
 	 * @return ActionScheduler_LogEntry[]
 	 */
-	abstract public function get_logs( $action_id );
+	abstract public function get_logs($action_id);
 
 	/**
 	 * @codeCoverageIgnore
 	 */
 	public function init() {
 		$this->hook_stored_action();
-		add_action( 'action_scheduler_canceled_action', array( $this, 'log_canceled_action' ), 10, 1 );
-		add_action( 'action_scheduler_begin_execute', array( $this, 'log_started_action' ), 10, 2 );
-		add_action( 'action_scheduler_after_execute', array( $this, 'log_completed_action' ), 10, 3 );
-		add_action( 'action_scheduler_failed_execution', array( $this, 'log_failed_action' ), 10, 3 );
-		add_action( 'action_scheduler_failed_action', array( $this, 'log_timed_out_action' ), 10, 2 );
-		add_action( 'action_scheduler_unexpected_shutdown', array( $this, 'log_unexpected_shutdown' ), 10, 2 );
-		add_action( 'action_scheduler_reset_action', array( $this, 'log_reset_action' ), 10, 1 );
-		add_action( 'action_scheduler_execution_ignored', array( $this, 'log_ignored_action' ), 10, 2 );
-		add_action( 'action_scheduler_failed_fetch_action', array( $this, 'log_failed_fetch_action' ), 10, 2 );
-		add_action( 'action_scheduler_failed_to_schedule_next_instance', array( $this, 'log_failed_schedule_next_instance' ), 10, 2 );
-		add_action( 'action_scheduler_bulk_cancel_actions', array( $this, 'bulk_log_cancel_actions' ), 10, 1 );
+		add_action('action_scheduler_canceled_action', array($this, 'log_canceled_action'), 10, 1);
+		add_action('action_scheduler_begin_execute', array($this, 'log_started_action'), 10, 2);
+		add_action('action_scheduler_after_execute', array($this, 'log_completed_action'), 10, 3);
+		add_action('action_scheduler_failed_execution', array($this, 'log_failed_action'), 10, 3);
+		add_action('action_scheduler_failed_action', array($this, 'log_timed_out_action'), 10, 2);
+		add_action('action_scheduler_unexpected_shutdown', array($this, 'log_unexpected_shutdown'), 10, 2);
+		add_action('action_scheduler_reset_action', array($this, 'log_reset_action'), 10, 1);
+		add_action('action_scheduler_execution_ignored', array($this, 'log_ignored_action'), 10, 2);
+		add_action('action_scheduler_failed_fetch_action', array($this, 'log_failed_fetch_action'), 10, 2);
+		add_action('action_scheduler_failed_to_schedule_next_instance', array($this, 'log_failed_schedule_next_instance'), 10, 2);
+		add_action('action_scheduler_bulk_cancel_actions', array($this, 'bulk_log_cancel_actions'), 10, 1);
 	}
 
 	public function hook_stored_action() {
-		add_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
+		add_action('action_scheduler_stored_action', array($this, 'log_stored_action'));
 	}
 
 	public function unhook_stored_action() {
-		remove_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
+		remove_action('action_scheduler_stored_action', array($this, 'log_stored_action'));
 	}
 
-	public function log_stored_action( $action_id ) {
-		$this->log( $action_id, __( 'action created', 'action-scheduler' ) );
+	public function log_stored_action($action_id) {
+		$this->log($action_id, __('action created', 'action-scheduler'));
 	}
 
-	public function log_canceled_action( $action_id ) {
-		$this->log( $action_id, __( 'action canceled', 'action-scheduler' ) );
+	public function log_canceled_action($action_id) {
+		$this->log($action_id, __('action canceled', 'action-scheduler'));
 	}
 
-	public function log_started_action( $action_id, $context = '' ) {
-		if ( ! empty( $context ) ) {
+	public function log_started_action($action_id, $context = '') {
+		if ( ! empty($context)) {
 			/* translators: %s: context */
-			$message = sprintf( __( 'action started via %s', 'action-scheduler' ), $context );
+			$message = sprintf(__('action started via %s', 'action-scheduler'), $context);
 		} else {
-			$message = __( 'action started', 'action-scheduler' );
+			$message = __('action started', 'action-scheduler');
 		}
-		$this->log( $action_id, $message );
+		$this->log($action_id, $message);
 	}
 
-	public function log_completed_action( $action_id, $action = null, $context = '' ) {
-		if ( ! empty( $context ) ) {
+	public function log_completed_action($action_id, $action = null, $context = '') {
+		if ( ! empty($context)) {
 			/* translators: %s: context */
-			$message = sprintf( __( 'action complete via %s', 'action-scheduler' ), $context );
+			$message = sprintf(__('action complete via %s', 'action-scheduler'), $context);
 		} else {
-			$message = __( 'action complete', 'action-scheduler' );
+			$message = __('action complete', 'action-scheduler');
 		}
-		$this->log( $action_id, $message );
+		$this->log($action_id, $message);
 	}
 
-	public function log_failed_action( $action_id, Exception $exception, $context = '' ) {
-		if ( ! empty( $context ) ) {
+	public function log_failed_action($action_id, Exception $exception, $context = '') {
+		if ( ! empty($context)) {
 			/* translators: 1: context 2: exception message */
-			$message = sprintf( __( 'action failed via %1$s: %2$s', 'action-scheduler' ), $context, $exception->getMessage() );
+			$message = sprintf(__('action failed via %1$s: %2$s', 'action-scheduler'), $context, $exception->getMessage());
 		} else {
 			/* translators: %s: exception message */
-			$message = sprintf( __( 'action failed: %s', 'action-scheduler' ), $exception->getMessage() );
+			$message = sprintf(__('action failed: %s', 'action-scheduler'), $exception->getMessage());
 		}
-		$this->log( $action_id, $message );
+		$this->log($action_id, $message);
 	}
 
-	public function log_timed_out_action( $action_id, $timeout ) {
+	public function log_timed_out_action($action_id, $timeout) {
 		/* translators: %s: amount of time */
-		$this->log( $action_id, sprintf( __( 'action marked as failed after %s seconds. Unknown error occurred. Check server, PHP and database error logs to diagnose cause.', 'action-scheduler' ), $timeout ) );
+		$this->log($action_id, sprintf(__('action marked as failed after %s seconds. Unknown error occurred. Check server, PHP and database error logs to diagnose cause.', 'action-scheduler'), $timeout));
 	}
 
-	public function log_unexpected_shutdown( $action_id, $error ) {
-		if ( ! empty( $error ) ) {
+	public function log_unexpected_shutdown($action_id, $error) {
+		if ( ! empty($error)) {
 			/* translators: 1: error message 2: filename 3: line */
-			$this->log( $action_id, sprintf( __( 'unexpected shutdown: PHP Fatal error %1$s in %2$s on line %3$s', 'action-scheduler' ), $error['message'], $error['file'], $error['line'] ) );
+			$this->log($action_id, sprintf(__('unexpected shutdown: PHP Fatal error %1$s in %2$s on line %3$s', 'action-scheduler'), $error['message'], $error['file'], $error['line']));
 		}
 	}
 
-	public function log_reset_action( $action_id ) {
-		$this->log( $action_id, __( 'action reset', 'action-scheduler' ) );
+	public function log_reset_action($action_id) {
+		$this->log($action_id, __('action reset', 'action-scheduler'));
 	}
 
-	public function log_ignored_action( $action_id, $context = '' ) {
-		if ( ! empty( $context ) ) {
+	public function log_ignored_action($action_id, $context = '') {
+		if ( ! empty($context)) {
 			/* translators: %s: context */
-			$message = sprintf( __( 'action ignored via %s', 'action-scheduler' ), $context );
+			$message = sprintf(__('action ignored via %s', 'action-scheduler'), $context);
 		} else {
-			$message = __( 'action ignored', 'action-scheduler' );
+			$message = __('action ignored', 'action-scheduler');
 		}
-		$this->log( $action_id, $message );
+		$this->log($action_id, $message);
 	}
 
 	/**
@@ -139,21 +139,21 @@ 
 	 *
 	 * @return ActionScheduler_LogEntry[]
 	 */
-	public function log_failed_fetch_action( $action_id, Exception $exception = null ) {
+	public function log_failed_fetch_action($action_id, Exception $exception = null) {
 
-		if ( $exception !== null ) {
+		if ($exception !== null) {
 			/* translators: %s: exception message */
-			$log_message = sprintf( __( 'There was a failure fetching this action: %s', 'action-scheduler' ), $exception->getMessage() );
+			$log_message = sprintf(__('There was a failure fetching this action: %s', 'action-scheduler'), $exception->getMessage());
 		} else {
-			$log_message = __( 'There was a failure fetching this action', 'action-scheduler' );
+			$log_message = __('There was a failure fetching this action', 'action-scheduler');
 		}
 
-		$this->log( $action_id, $log_message );
+		$this->log($action_id, $log_message);
 	}
 
-	public function log_failed_schedule_next_instance( $action_id, Exception $exception ) {
+	public function log_failed_schedule_next_instance($action_id, Exception $exception) {
 		/* translators: %s: exception message */
-		$this->log( $action_id, sprintf( __( 'There was a failure scheduling the next instance of this action: %s', 'action-scheduler' ), $exception->getMessage() ) );
+		$this->log($action_id, sprintf(__('There was a failure scheduling the next instance of this action: %s', 'action-scheduler'), $exception->getMessage()));
 	}
 
 	/**
@@ -164,13 +164,13 @@ 
 	 *
 	 * @param array $action_ids List of action ID.
 	 */
-	public function bulk_log_cancel_actions( $action_ids ) {
-		if ( empty( $action_ids ) ) {
+	public function bulk_log_cancel_actions($action_ids) {
+		if (empty($action_ids)) {
 			return;
 		}
 
-		foreach ( $action_ids as $action_id ) {
-			$this->log_canceled_action( $action_id );
+		foreach ($action_ids as $action_id) {
+			$this->log_canceled_action($action_id);
 		}
 	}
 }