AyeCode / invoicing

includes/libraries/action-scheduler/deprecated/ActionScheduler_Abstract_QueueRunner_Deprecated.php

Indentation +16 added lines, -16 removed lines

@@ -5,23 +5,23 @@
  */
 abstract class ActionScheduler_Abstract_QueueRunner_Deprecated {
 
-	/**
-	 * Get the maximum number of seconds a batch can run for.
-	 *
-	 * @deprecated 2.1.1
-	 * @return int The number of seconds.
-	 */
-	protected function get_maximum_execution_time() {
-		_deprecated_function( __METHOD__, '2.1.1', 'ActionScheduler_Abstract_QueueRunner::get_time_limit()' );
+    /**
+     * Get the maximum number of seconds a batch can run for.
+     *
+     * @deprecated 2.1.1
+     * @return int The number of seconds.
+     */
+    protected function get_maximum_execution_time() {
+        _deprecated_function( __METHOD__, '2.1.1', 'ActionScheduler_Abstract_QueueRunner::get_time_limit()' );
 
-		$maximum_execution_time = 30;
+        $maximum_execution_time = 30;
 
-		// Apply deprecated filter
-		if ( has_filter( 'action_scheduler_maximum_execution_time' ) ) {
-			_deprecated_function( 'action_scheduler_maximum_execution_time', '2.1.1', 'action_scheduler_queue_runner_time_limit' );
-			$maximum_execution_time = apply_filters( 'action_scheduler_maximum_execution_time', $maximum_execution_time );
-		}
+        // Apply deprecated filter
+        if ( has_filter( 'action_scheduler_maximum_execution_time' ) ) {
+            _deprecated_function( 'action_scheduler_maximum_execution_time', '2.1.1', 'action_scheduler_queue_runner_time_limit' );
+            $maximum_execution_time = apply_filters( 'action_scheduler_maximum_execution_time', $maximum_execution_time );
+        }
 
-		return absint( $maximum_execution_time );
-	}
+        return absint( $maximum_execution_time );
+    }
 }

includes/libraries/action-scheduler/action-scheduler.php

Indentation +19 added lines, -19 removed lines

@@ -27,27 +27,27 @@
 
 if ( ! function_exists( 'action_scheduler_register_3_dot_1_dot_4' ) ) {
 
-	if ( ! class_exists( 'ActionScheduler_Versions' ) ) {
-		require_once( 'classes/ActionScheduler_Versions.php' );
-		add_action( 'plugins_loaded', array( 'ActionScheduler_Versions', 'initialize_latest_version' ), 1, 0 );
-	}
+    if ( ! class_exists( 'ActionScheduler_Versions' ) ) {
+        require_once( 'classes/ActionScheduler_Versions.php' );
+        add_action( 'plugins_loaded', array( 'ActionScheduler_Versions', 'initialize_latest_version' ), 1, 0 );
+    }
 
-	add_action( 'plugins_loaded', 'action_scheduler_register_3_dot_1_dot_4', 0, 0 );
+    add_action( 'plugins_loaded', 'action_scheduler_register_3_dot_1_dot_4', 0, 0 );
 
-	function action_scheduler_register_3_dot_1_dot_4() {
-		$versions = ActionScheduler_Versions::instance();
-		$versions->register( '3.1.4', 'action_scheduler_initialize_3_dot_1_dot_4' );
-	}
+    function action_scheduler_register_3_dot_1_dot_4() {
+        $versions = ActionScheduler_Versions::instance();
+        $versions->register( '3.1.4', 'action_scheduler_initialize_3_dot_1_dot_4' );
+    }
 
-	function action_scheduler_initialize_3_dot_1_dot_4() {
-		require_once( 'classes/abstracts/ActionScheduler.php' );
-		ActionScheduler::init( __FILE__ );
-	}
+    function action_scheduler_initialize_3_dot_1_dot_4() {
+        require_once( 'classes/abstracts/ActionScheduler.php' );
+        ActionScheduler::init( __FILE__ );
+    }
 
-	// Support usage in themes - load this version if no plugin has loaded a version yet.
-	if ( did_action( 'plugins_loaded' ) && ! class_exists( 'ActionScheduler' ) ) {
-		action_scheduler_initialize_3_dot_1_dot_4();
-		do_action( 'action_scheduler_pre_theme_init' );
-		ActionScheduler_Versions::initialize_latest_version();
-	}
+    // Support usage in themes - load this version if no plugin has loaded a version yet.
+    if ( did_action( 'plugins_loaded' ) && ! class_exists( 'ActionScheduler' ) ) {
+        action_scheduler_initialize_3_dot_1_dot_4();
+        do_action( 'action_scheduler_pre_theme_init' );
+        ActionScheduler_Versions::initialize_latest_version();
+    }
 }

includes/libraries/action-scheduler/classes/ActionScheduler_FatalErrorMonitor.php

Indentation +42 added lines, -42 removed lines

@@ -4,52 +4,52 @@
  * Class ActionScheduler_FatalErrorMonitor
  */
 class ActionScheduler_FatalErrorMonitor {
-	/** @var ActionScheduler_ActionClaim */
-	private $claim = NULL;
-	/** @var ActionScheduler_Store */
-	private $store = NULL;
-	private $action_id = 0;
+    /** @var ActionScheduler_ActionClaim */
+    private $claim = NULL;
+    /** @var ActionScheduler_Store */
+    private $store = NULL;
+    private $action_id = 0;
 
-	public function __construct( ActionScheduler_Store $store ) {
-		$this->store = $store;
-	}
+    public function __construct( ActionScheduler_Store $store ) {
+        $this->store = $store;
+    }
 
-	public function attach( ActionScheduler_ActionClaim $claim ) {
-		$this->claim = $claim;
-		add_action( 'shutdown', array( $this, 'handle_unexpected_shutdown' ) );
-		add_action( 'action_scheduler_before_execute', array( $this, 'track_current_action' ), 0, 1 );
-		add_action( 'action_scheduler_after_execute',  array( $this, 'untrack_action' ), 0, 0 );
-		add_action( 'action_scheduler_execution_ignored',  array( $this, 'untrack_action' ), 0, 0 );
-		add_action( 'action_scheduler_failed_execution',  array( $this, 'untrack_action' ), 0, 0 );
-	}
+    public function attach( ActionScheduler_ActionClaim $claim ) {
+        $this->claim = $claim;
+        add_action( 'shutdown', array( $this, 'handle_unexpected_shutdown' ) );
+        add_action( 'action_scheduler_before_execute', array( $this, 'track_current_action' ), 0, 1 );
+        add_action( 'action_scheduler_after_execute',  array( $this, 'untrack_action' ), 0, 0 );
+        add_action( 'action_scheduler_execution_ignored',  array( $this, 'untrack_action' ), 0, 0 );
+        add_action( 'action_scheduler_failed_execution',  array( $this, 'untrack_action' ), 0, 0 );
+    }
 
-	public function detach() {
-		$this->claim = NULL;
-		$this->untrack_action();
-		remove_action( 'shutdown', array( $this, 'handle_unexpected_shutdown' ) );
-		remove_action( 'action_scheduler_before_execute', array( $this, 'track_current_action' ), 0 );
-		remove_action( 'action_scheduler_after_execute',  array( $this, 'untrack_action' ), 0 );
-		remove_action( 'action_scheduler_execution_ignored',  array( $this, 'untrack_action' ), 0 );
-		remove_action( 'action_scheduler_failed_execution',  array( $this, 'untrack_action' ), 0 );
-	}
+    public function detach() {
+        $this->claim = NULL;
+        $this->untrack_action();
+        remove_action( 'shutdown', array( $this, 'handle_unexpected_shutdown' ) );
+        remove_action( 'action_scheduler_before_execute', array( $this, 'track_current_action' ), 0 );
+        remove_action( 'action_scheduler_after_execute',  array( $this, 'untrack_action' ), 0 );
+        remove_action( 'action_scheduler_execution_ignored',  array( $this, 'untrack_action' ), 0 );
+        remove_action( 'action_scheduler_failed_execution',  array( $this, 'untrack_action' ), 0 );
+    }
 
-	public function track_current_action( $action_id ) {
-		$this->action_id = $action_id;
-	}
+    public function track_current_action( $action_id ) {
+        $this->action_id = $action_id;
+    }
 
-	public function untrack_action() {
-		$this->action_id = 0;
-	}
+    public function untrack_action() {
+        $this->action_id = 0;
+    }
 
-	public function handle_unexpected_shutdown() {
-		if ( $error = error_get_last() ) {
-			if ( in_array( $error['type'], array( E_ERROR, E_PARSE, E_COMPILE_ERROR, E_USER_ERROR, E_RECOVERABLE_ERROR ) ) ) {
-				if ( !empty($this->action_id) ) {
-					$this->store->mark_failure( $this->action_id );
-					do_action( 'action_scheduler_unexpected_shutdown', $this->action_id, $error );
-				}
-			}
-			$this->store->release_claim( $this->claim );
-		}
-	}
+    public function handle_unexpected_shutdown() {
+        if ( $error = error_get_last() ) {
+            if ( in_array( $error['type'], array( E_ERROR, E_PARSE, E_COMPILE_ERROR, E_USER_ERROR, E_RECOVERABLE_ERROR ) ) ) {
+                if ( !empty($this->action_id) ) {
+                    $this->store->mark_failure( $this->action_id );
+                    do_action( 'action_scheduler_unexpected_shutdown', $this->action_id, $error );
+                }
+            }
+            $this->store->release_claim( $this->claim );
+        }
+    }
 }

includes/libraries/action-scheduler/classes/ActionScheduler_wcSystemStatus.php

Indentation +120 added lines, -120 removed lines

@@ -5,95 +5,95 @@ 
  */
 class ActionScheduler_wcSystemStatus {
 
-	/**
-	 * The active data stores
-	 *
-	 * @var ActionScheduler_Store
-	 */
-	protected $store;
-
-	function __construct( $store ) {
-		$this->store = $store;
-	}
-
-	/**
-	 * Display action data, including number of actions grouped by status and the oldest & newest action in each status.
-	 *
-	 * Helpful to identify issues, like a clogged queue.
-	 */
-	public function render() {
-		$action_counts     = $this->store->action_counts();
-		$status_labels     = $this->store->get_status_labels();
-		$oldest_and_newest = $this->get_oldest_and_newest( array_keys( $status_labels ) );
-
-		$this->get_template( $status_labels, $action_counts, $oldest_and_newest );
-	}
-
-	/**
-	 * Get oldest and newest scheduled dates for a given set of statuses.
-	 *
-	 * @param array $status_keys Set of statuses to find oldest & newest action for.
-	 * @return array
-	 */
-	protected function get_oldest_and_newest( $status_keys ) {
-
-		$oldest_and_newest = array();
-
-		foreach ( $status_keys as $status ) {
-			$oldest_and_newest[ $status ] = array(
-				'oldest' => '–',
-				'newest' => '–',
-			);
-
-			if ( 'in-progress' === $status ) {
-				continue;
-			}
-
-			$oldest_and_newest[ $status ]['oldest'] = $this->get_action_status_date( $status, 'oldest' );
-			$oldest_and_newest[ $status ]['newest'] = $this->get_action_status_date( $status, 'newest' );
-		}
-
-		return $oldest_and_newest;
-	}
-
-	/**
-	 * Get oldest or newest scheduled date for a given status.
-	 *
-	 * @param string $status Action status label/name string.
-	 * @param string $date_type Oldest or Newest.
-	 * @return DateTime
-	 */
-	protected function get_action_status_date( $status, $date_type = 'oldest' ) {
-
-		$order = 'oldest' === $date_type ? 'ASC' : 'DESC';
-
-		$action = $this->store->query_actions( array(
-			'claimed'  => false,
-			'status'   => $status,
-			'per_page' => 1,
-			'order'    => $order,
-		) );
-
-		if ( ! empty( $action ) ) {
-			$date_object = $this->store->get_date( $action[0] );
-			$action_date = $date_object->format( 'Y-m-d H:i:s O' );
-		} else {
-			$action_date = '–';
-		}
-
-		return $action_date;
-	}
-
-	/**
-	 * Get oldest or newest scheduled date for a given status.
-	 *
-	 * @param array $status_labels Set of statuses to find oldest & newest action for.
-	 * @param array $action_counts Number of actions grouped by status.
-	 * @param array $oldest_and_newest Date of the oldest and newest action with each status.
-	 */
-	protected function get_template( $status_labels, $action_counts, $oldest_and_newest ) {
-		$as_version = ActionScheduler_Versions::instance()->latest_version();
-		?>
+    /**
+     * The active data stores
+     *
+     * @var ActionScheduler_Store
+     */
+    protected $store;
+
+    function __construct( $store ) {
+        $this->store = $store;
+    }
+
+    /**
+     * Display action data, including number of actions grouped by status and the oldest & newest action in each status.
+     *
+     * Helpful to identify issues, like a clogged queue.
+     */
+    public function render() {
+        $action_counts     = $this->store->action_counts();
+        $status_labels     = $this->store->get_status_labels();
+        $oldest_and_newest = $this->get_oldest_and_newest( array_keys( $status_labels ) );
+
+        $this->get_template( $status_labels, $action_counts, $oldest_and_newest );
+    }
+
+    /**
+     * Get oldest and newest scheduled dates for a given set of statuses.
+     *
+     * @param array $status_keys Set of statuses to find oldest & newest action for.
+     * @return array
+     */
+    protected function get_oldest_and_newest( $status_keys ) {
+
+        $oldest_and_newest = array();
+
+        foreach ( $status_keys as $status ) {
+            $oldest_and_newest[ $status ] = array(
+                'oldest' => '–',
+                'newest' => '–',
+            );
+
+            if ( 'in-progress' === $status ) {
+                continue;
+            }
+
+            $oldest_and_newest[ $status ]['oldest'] = $this->get_action_status_date( $status, 'oldest' );
+            $oldest_and_newest[ $status ]['newest'] = $this->get_action_status_date( $status, 'newest' );
+        }
+
+        return $oldest_and_newest;
+    }
+
+    /**
+     * Get oldest or newest scheduled date for a given status.
+     *
+     * @param string $status Action status label/name string.
+     * @param string $date_type Oldest or Newest.
+     * @return DateTime
+     */
+    protected function get_action_status_date( $status, $date_type = 'oldest' ) {
+
+        $order = 'oldest' === $date_type ? 'ASC' : 'DESC';
+
+        $action = $this->store->query_actions( array(
+            'claimed'  => false,
+            'status'   => $status,
+            'per_page' => 1,
+            'order'    => $order,
+        ) );
+
+        if ( ! empty( $action ) ) {
+            $date_object = $this->store->get_date( $action[0] );
+            $action_date = $date_object->format( 'Y-m-d H:i:s O' );
+        } else {
+            $action_date = '–';
+        }
+
+        return $action_date;
+    }
+
+    /**
+     * Get oldest or newest scheduled date for a given status.
+     *
+     * @param array $status_labels Set of statuses to find oldest & newest action for.
+     * @param array $action_counts Number of actions grouped by status.
+     * @param array $oldest_and_newest Date of the oldest and newest action with each status.
+     */
+    protected function get_template( $status_labels, $action_counts, $oldest_and_newest ) {
+        $as_version = ActionScheduler_Versions::instance()->latest_version();
+        ?>
 
 		<table class="wc_status_table widefat" cellspacing="0">
 			<thead>
@@ -114,39 +114,39 @@ 
 			</thead>
 			<tbody>
 				<?php
-				foreach ( $action_counts as $status => $count ) {
-					// WC uses the 3rd column for export, so we need to display more data in that (hidden when viewed as part of the table) and add an empty 2nd column.
-					printf(
-						'<tr><td>%1$s</td><td>&nbsp;</td><td>%2$s<span style="display: none;">, Oldest: %3$s, Newest: %4$s</span></td><td>%3$s</td><td>%4$s</td></tr>',
-						esc_html( $status_labels[ $status ] ),
-						number_format_i18n( $count ),
-						$oldest_and_newest[ $status ]['oldest'],
-						$oldest_and_newest[ $status ]['newest']
-					);
-				}
-				?>
+                foreach ( $action_counts as $status => $count ) {
+                    // WC uses the 3rd column for export, so we need to display more data in that (hidden when viewed as part of the table) and add an empty 2nd column.
+                    printf(
+                        '<tr><td>%1$s</td><td>&nbsp;</td><td>%2$s<span style="display: none;">, Oldest: %3$s, Newest: %4$s</span></td><td>%3$s</td><td>%4$s</td></tr>',
+                        esc_html( $status_labels[ $status ] ),
+                        number_format_i18n( $count ),
+                        $oldest_and_newest[ $status ]['oldest'],
+                        $oldest_and_newest[ $status ]['newest']
+                    );
+                }
+                ?>
 			</tbody>
 		</table>
 
 		<?php
-	}
-
-	/**
-	 * is triggered when invoking inaccessible methods in an object context.
-	 *
-	 * @param string $name
-	 * @param array  $arguments
-	 *
-	 * @return mixed
-	 * @link https://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.methods
-	 */
-	public function __call( $name, $arguments ) {
-		switch ( $name ) {
-			case 'print':
-				_deprecated_function( __CLASS__ . '::print()', '2.2.4', __CLASS__ . '::render()' );
-				return call_user_func_array( array( $this, 'render' ), $arguments );
-		}
-
-		return null;
-	}
+    }
+
+    /**
+     * is triggered when invoking inaccessible methods in an object context.
+     *
+     * @param string $name
+     * @param array  $arguments
+     *
+     * @return mixed
+     * @link https://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.methods
+     */
+    public function __call( $name, $arguments ) {
+        switch ( $name ) {
+            case 'print':
+                _deprecated_function( __CLASS__ . '::print()', '2.2.4', __CLASS__ . '::render()' );
+                return call_user_func_array( array( $this, 'render' ), $arguments );
+        }
+
+        return null;
+    }
 }

includes/libraries/action-scheduler/classes/data-stores/ActionScheduler_wpPostStore_PostStatusRegistrar.php

Indentation +44 added lines, -44 removed lines

@@ -5,54 +5,54 @@
  * @codeCoverageIgnore
  */
 class ActionScheduler_wpPostStore_PostStatusRegistrar {
-	public function register() {
-		register_post_status( ActionScheduler_Store::STATUS_RUNNING, array_merge( $this->post_status_args(), $this->post_status_running_labels() ) );
-		register_post_status( ActionScheduler_Store::STATUS_FAILED, array_merge( $this->post_status_args(), $this->post_status_failed_labels() ) );
-	}
+    public function register() {
+        register_post_status( ActionScheduler_Store::STATUS_RUNNING, array_merge( $this->post_status_args(), $this->post_status_running_labels() ) );
+        register_post_status( ActionScheduler_Store::STATUS_FAILED, array_merge( $this->post_status_args(), $this->post_status_failed_labels() ) );
+    }
 
-	/**
-	 * Build the args array for the post type definition
-	 *
-	 * @return array
-	 */
-	protected function post_status_args() {
-		$args = array(
-			'public'                    => false,
-			'exclude_from_search'       => false,
-			'show_in_admin_all_list'    => true,
-			'show_in_admin_status_list' => true,
-		);
+    /**
+     * Build the args array for the post type definition
+     *
+     * @return array
+     */
+    protected function post_status_args() {
+        $args = array(
+            'public'                    => false,
+            'exclude_from_search'       => false,
+            'show_in_admin_all_list'    => true,
+            'show_in_admin_status_list' => true,
+        );
 
-		return apply_filters( 'action_scheduler_post_status_args', $args );
-	}
+        return apply_filters( 'action_scheduler_post_status_args', $args );
+    }
 
-	/**
-	 * Build the args array for the post type definition
-	 *
-	 * @return array
-	 */
-	protected function post_status_failed_labels() {
-		$labels = array(
-			'label'       => _x( 'Failed', 'post', 'action-scheduler' ),
-			/* translators: %s: count */
-			'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'action-scheduler' ),
-		);
+    /**
+     * Build the args array for the post type definition
+     *
+     * @return array
+     */
+    protected function post_status_failed_labels() {
+        $labels = array(
+            'label'       => _x( 'Failed', 'post', 'action-scheduler' ),
+            /* translators: %s: count */
+            'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'action-scheduler' ),
+        );
 
-		return apply_filters( 'action_scheduler_post_status_failed_labels', $labels );
-	}
+        return apply_filters( 'action_scheduler_post_status_failed_labels', $labels );
+    }
 
-	/**
-	 * Build the args array for the post type definition
-	 *
-	 * @return array
-	 */
-	protected function post_status_running_labels() {
-		$labels = array(
-			'label'       => _x( 'In-Progress', 'post', 'action-scheduler' ),
-			/* translators: %s: count */
-			'label_count' => _n_noop( 'In-Progress <span class="count">(%s)</span>', 'In-Progress <span class="count">(%s)</span>', 'action-scheduler' ),
-		);
+    /**
+     * Build the args array for the post type definition
+     *
+     * @return array
+     */
+    protected function post_status_running_labels() {
+        $labels = array(
+            'label'       => _x( 'In-Progress', 'post', 'action-scheduler' ),
+            /* translators: %s: count */
+            'label_count' => _n_noop( 'In-Progress <span class="count">(%s)</span>', 'In-Progress <span class="count">(%s)</span>', 'action-scheduler' ),
+        );
 
-		return apply_filters( 'action_scheduler_post_status_running_labels', $labels );
-	}
+        return apply_filters( 'action_scheduler_post_status_running_labels', $labels );
+    }
 }

includes/libraries/action-scheduler/classes/data-stores/ActionScheduler_HybridStore.php

Indentation +360 added lines, -360 removed lines

@@ -13,368 +13,368 @@
  * @since 3.0.0
  */
 class ActionScheduler_HybridStore extends Store {
-	const DEMARKATION_OPTION = 'action_scheduler_hybrid_store_demarkation';
-
-	private $primary_store;
-	private $secondary_store;
-	private $migration_runner;
-
-	/**
-	 * @var int The dividing line between IDs of actions created
-	 *          by the primary and secondary stores.
-	 *
-	 * Methods that accept an action ID will compare the ID against
-	 * this to determine which store will contain that ID. In almost
-	 * all cases, the ID should come from the primary store, but if
-	 * client code is bypassing the API functions and fetching IDs
-	 * from elsewhere, then there is a chance that an unmigrated ID
-	 * might be requested.
-	 */
-	private $demarkation_id = 0;
-
-	/**
-	 * ActionScheduler_HybridStore constructor.
-	 *
-	 * @param Config $config Migration config object.
-	 */
-	public function __construct( Config $config = null ) {
-		$this->demarkation_id = (int) get_option( self::DEMARKATION_OPTION, 0 );
-		if ( empty( $config ) ) {
-			$config = Controller::instance()->get_migration_config_object();
-		}
-		$this->primary_store    = $config->get_destination_store();
-		$this->secondary_store  = $config->get_source_store();
-		$this->migration_runner = new Runner( $config );
-	}
-
-	/**
-	 * Initialize the table data store tables.
-	 *
-	 * @codeCoverageIgnore
-	 */
-	public function init() {
-		add_action( 'action_scheduler/created_table', [ $this, 'set_autoincrement' ], 10, 2 );
-		$this->primary_store->init();
-		$this->secondary_store->init();
-		remove_action( 'action_scheduler/created_table', [ $this, 'set_autoincrement' ], 10 );
-	}
-
-	/**
-	 * When the actions table is created, set its autoincrement
-	 * value to be one higher than the posts table to ensure that
-	 * there are no ID collisions.
-	 *
-	 * @param string $table_name
-	 * @param string $table_suffix
-	 *
-	 * @return void
-	 * @codeCoverageIgnore
-	 */
-	public function set_autoincrement( $table_name, $table_suffix ) {
-		if ( ActionScheduler_StoreSchema::ACTIONS_TABLE === $table_suffix ) {
-			if ( empty( $this->demarkation_id ) ) {
-				$this->demarkation_id = $this->set_demarkation_id();
-			}
-			/** @var \wpdb $wpdb */
-			global $wpdb;
-			$wpdb->insert(
-				$wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE},
-				[
-					'action_id' => $this->demarkation_id,
-					'hook'      => '',
-					'status'    => '',
-				]
-			);
-			$wpdb->delete(
-				$wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE},
-				[ 'action_id' => $this->demarkation_id ]
-			);
-		}
-	}
-
-	/**
-	 * Store the demarkation id in WP options.
-	 *
-	 * @param int $id The ID to set as the demarkation point between the two stores
-	 *                Leave null to use the next ID from the WP posts table.
-	 *
-	 * @return int The new ID.
-	 *
-	 * @codeCoverageIgnore
-	 */
-	private function set_demarkation_id( $id = null ) {
-		if ( empty( $id ) ) {
-			/** @var \wpdb $wpdb */
-			global $wpdb;
-			$id = (int) $wpdb->get_var( "SELECT MAX(ID) FROM $wpdb->posts" );
-			$id ++;
-		}
-		update_option( self::DEMARKATION_OPTION, $id );
-
-		return $id;
-	}
-
-	/**
-	 * Find the first matching action from the secondary store.
-	 * If it exists, migrate it to the primary store immediately.
-	 * After it migrates, the secondary store will logically contain
-	 * the next matching action, so return the result thence.
-	 *
-	 * @param string $hook
-	 * @param array  $params
-	 *
-	 * @return string
-	 */
-	public function find_action( $hook, $params = [] ) {
-		$found_unmigrated_action = $this->secondary_store->find_action( $hook, $params );
-		if ( ! empty( $found_unmigrated_action ) ) {
-			$this->migrate( [ $found_unmigrated_action ] );
-		}
-
-		return $this->primary_store->find_action( $hook, $params );
-	}
-
-	/**
-	 * Find actions matching the query in the secondary source first.
-	 * If any are found, migrate them immediately. Then the secondary
-	 * store will contain the canonical results.
-	 *
-	 * @param array $query
-	 * @param string $query_type Whether to select or count the results. Default, select.
-	 *
-	 * @return int[]
-	 */
-	public function query_actions( $query = [], $query_type = 'select' ) {
-		$found_unmigrated_actions = $this->secondary_store->query_actions( $query, 'select' );
-		if ( ! empty( $found_unmigrated_actions ) ) {
-			$this->migrate( $found_unmigrated_actions );
-		}
-
-		return $this->primary_store->query_actions( $query, $query_type );
-	}
-
-	/**
-	 * Get a count of all actions in the store, grouped by status
-	 *
-	 * @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status.
-	 */
-	public function action_counts() {
-		$unmigrated_actions_count = $this->secondary_store->action_counts();
-		$migrated_actions_count   = $this->primary_store->action_counts();
-		$actions_count_by_status  = array();
-
-		foreach ( $this->get_status_labels() as $status_key => $status_label ) {
-
-			$count = 0;
-
-			if ( isset( $unmigrated_actions_count[ $status_key ] ) ) {
-				$count += $unmigrated_actions_count[ $status_key ];
-			}
-
-			if ( isset( $migrated_actions_count[ $status_key ] ) ) {
-				$count += $migrated_actions_count[ $status_key ];
-			}
-
-			$actions_count_by_status[ $status_key ] = $count;
-		}
-
-		$actions_count_by_status = array_filter( $actions_count_by_status );
-
-		return $actions_count_by_status;
-	}
-
-	/**
-	 * If any actions would have been claimed by the secondary store,
-	 * migrate them immediately, then ask the primary store for the
-	 * canonical claim.
-	 *
-	 * @param int           $max_actions
-	 * @param DateTime|null $before_date
-	 *
-	 * @return ActionScheduler_ActionClaim
-	 */
-	public function stake_claim( $max_actions = 10, DateTime $before_date = null, $hooks = array(), $group = '' ) {
-		$claim = $this->secondary_store->stake_claim( $max_actions, $before_date, $hooks, $group );
-
-		$claimed_actions = $claim->get_actions();
-		if ( ! empty( $claimed_actions ) ) {
-			$this->migrate( $claimed_actions );
-		}
-
-		$this->secondary_store->release_claim( $claim );
-
-		return $this->primary_store->stake_claim( $max_actions, $before_date, $hooks, $group );
-	}
-
-	/**
-	 * Migrate a list of actions to the table data store.
-	 *
-	 * @param array $action_ids List of action IDs.
-	 */
-	private function migrate( $action_ids ) {
-		$this->migration_runner->migrate_actions( $action_ids );
-	}
-
-	/**
-	 * Save an action to the primary store.
-	 *
-	 * @param ActionScheduler_Action $action Action object to be saved.
-	 * @param DateTime               $date Optional. Schedule date. Default null.
-	 */
-	public function save_action( ActionScheduler_Action $action, DateTime $date = null ) {
-		return $this->primary_store->save_action( $action, $date );
-	}
-
-	/**
-	 * Retrieve an existing action whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function fetch_action( $action_id ) {
-		if ( $action_id < $this->demarkation_id ) {
-			return $this->secondary_store->fetch_action( $action_id );
-		} else {
-			return $this->primary_store->fetch_action( $action_id );
-		}
-	}
-
-	/**
-	 * Cancel an existing action whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function cancel_action( $action_id ) {
-		if ( $action_id < $this->demarkation_id ) {
-			$this->secondary_store->cancel_action( $action_id );
-		} else {
-			$this->primary_store->cancel_action( $action_id );
-		}
-	}
-
-	/**
-	 * Delete an existing action whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function delete_action( $action_id ) {
-		if ( $action_id < $this->demarkation_id ) {
-			$this->secondary_store->delete_action( $action_id );
-		} else {
-			$this->primary_store->delete_action( $action_id );
-		}
-	}
-
-	/**
-	 * Get the schedule date an existing action whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function get_date( $action_id ) {
-		if ( $action_id < $this->demarkation_id ) {
-			return $this->secondary_store->get_date( $action_id );
-		} else {
-			return $this->primary_store->get_date( $action_id );
-		}
-	}
-
-	/**
-	 * Mark an existing action as failed whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function mark_failure( $action_id ) {
-		if ( $action_id < $this->demarkation_id ) {
-			$this->secondary_store->mark_failure( $action_id );
-		} else {
-			$this->primary_store->mark_failure( $action_id );
-		}
-	}
-
-	/**
-	 * Log the execution of an existing action whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function log_execution( $action_id ) {
-		if ( $action_id < $this->demarkation_id ) {
-			$this->secondary_store->log_execution( $action_id );
-		} else {
-			$this->primary_store->log_execution( $action_id );
-		}
-	}
-
-	/**
-	 * Mark an existing action complete whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function mark_complete( $action_id ) {
-		if ( $action_id < $this->demarkation_id ) {
-			$this->secondary_store->mark_complete( $action_id );
-		} else {
-			$this->primary_store->mark_complete( $action_id );
-		}
-	}
-
-	/**
-	 * Get an existing action status whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function get_status( $action_id ) {
-		if ( $action_id < $this->demarkation_id ) {
-			return $this->secondary_store->get_status( $action_id );
-		} else {
-			return $this->primary_store->get_status( $action_id );
-		}
-	}
-
-
-	/* * * * * * * * * * * * * * * * * * * * * * * * * * *
+    const DEMARKATION_OPTION = 'action_scheduler_hybrid_store_demarkation';
+
+    private $primary_store;
+    private $secondary_store;
+    private $migration_runner;
+
+    /**
+     * @var int The dividing line between IDs of actions created
+     *          by the primary and secondary stores.
+     *
+     * Methods that accept an action ID will compare the ID against
+     * this to determine which store will contain that ID. In almost
+     * all cases, the ID should come from the primary store, but if
+     * client code is bypassing the API functions and fetching IDs
+     * from elsewhere, then there is a chance that an unmigrated ID
+     * might be requested.
+     */
+    private $demarkation_id = 0;
+
+    /**
+     * ActionScheduler_HybridStore constructor.
+     *
+     * @param Config $config Migration config object.
+     */
+    public function __construct( Config $config = null ) {
+        $this->demarkation_id = (int) get_option( self::DEMARKATION_OPTION, 0 );
+        if ( empty( $config ) ) {
+            $config = Controller::instance()->get_migration_config_object();
+        }
+        $this->primary_store    = $config->get_destination_store();
+        $this->secondary_store  = $config->get_source_store();
+        $this->migration_runner = new Runner( $config );
+    }
+
+    /**
+     * Initialize the table data store tables.
+     *
+     * @codeCoverageIgnore
+     */
+    public function init() {
+        add_action( 'action_scheduler/created_table', [ $this, 'set_autoincrement' ], 10, 2 );
+        $this->primary_store->init();
+        $this->secondary_store->init();
+        remove_action( 'action_scheduler/created_table', [ $this, 'set_autoincrement' ], 10 );
+    }
+
+    /**
+     * When the actions table is created, set its autoincrement
+     * value to be one higher than the posts table to ensure that
+     * there are no ID collisions.
+     *
+     * @param string $table_name
+     * @param string $table_suffix
+     *
+     * @return void
+     * @codeCoverageIgnore
+     */
+    public function set_autoincrement( $table_name, $table_suffix ) {
+        if ( ActionScheduler_StoreSchema::ACTIONS_TABLE === $table_suffix ) {
+            if ( empty( $this->demarkation_id ) ) {
+                $this->demarkation_id = $this->set_demarkation_id();
+            }
+            /** @var \wpdb $wpdb */
+            global $wpdb;
+            $wpdb->insert(
+                $wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE},
+                [
+                    'action_id' => $this->demarkation_id,
+                    'hook'      => '',
+                    'status'    => '',
+                ]
+            );
+            $wpdb->delete(
+                $wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE},
+                [ 'action_id' => $this->demarkation_id ]
+            );
+        }
+    }
+
+    /**
+     * Store the demarkation id in WP options.
+     *
+     * @param int $id The ID to set as the demarkation point between the two stores
+     *                Leave null to use the next ID from the WP posts table.
+     *
+     * @return int The new ID.
+     *
+     * @codeCoverageIgnore
+     */
+    private function set_demarkation_id( $id = null ) {
+        if ( empty( $id ) ) {
+            /** @var \wpdb $wpdb */
+            global $wpdb;
+            $id = (int) $wpdb->get_var( "SELECT MAX(ID) FROM $wpdb->posts" );
+            $id ++;
+        }
+        update_option( self::DEMARKATION_OPTION, $id );
+
+        return $id;
+    }
+
+    /**
+     * Find the first matching action from the secondary store.
+     * If it exists, migrate it to the primary store immediately.
+     * After it migrates, the secondary store will logically contain
+     * the next matching action, so return the result thence.
+     *
+     * @param string $hook
+     * @param array  $params
+     *
+     * @return string
+     */
+    public function find_action( $hook, $params = [] ) {
+        $found_unmigrated_action = $this->secondary_store->find_action( $hook, $params );
+        if ( ! empty( $found_unmigrated_action ) ) {
+            $this->migrate( [ $found_unmigrated_action ] );
+        }
+
+        return $this->primary_store->find_action( $hook, $params );
+    }
+
+    /**
+     * Find actions matching the query in the secondary source first.
+     * If any are found, migrate them immediately. Then the secondary
+     * store will contain the canonical results.
+     *
+     * @param array $query
+     * @param string $query_type Whether to select or count the results. Default, select.
+     *
+     * @return int[]
+     */
+    public function query_actions( $query = [], $query_type = 'select' ) {
+        $found_unmigrated_actions = $this->secondary_store->query_actions( $query, 'select' );
+        if ( ! empty( $found_unmigrated_actions ) ) {
+            $this->migrate( $found_unmigrated_actions );
+        }
+
+        return $this->primary_store->query_actions( $query, $query_type );
+    }
+
+    /**
+     * Get a count of all actions in the store, grouped by status
+     *
+     * @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status.
+     */
+    public function action_counts() {
+        $unmigrated_actions_count = $this->secondary_store->action_counts();
+        $migrated_actions_count   = $this->primary_store->action_counts();
+        $actions_count_by_status  = array();
+
+        foreach ( $this->get_status_labels() as $status_key => $status_label ) {
+
+            $count = 0;
+
+            if ( isset( $unmigrated_actions_count[ $status_key ] ) ) {
+                $count += $unmigrated_actions_count[ $status_key ];
+            }
+
+            if ( isset( $migrated_actions_count[ $status_key ] ) ) {
+                $count += $migrated_actions_count[ $status_key ];
+            }
+
+            $actions_count_by_status[ $status_key ] = $count;
+        }
+
+        $actions_count_by_status = array_filter( $actions_count_by_status );
+
+        return $actions_count_by_status;
+    }
+
+    /**
+     * If any actions would have been claimed by the secondary store,
+     * migrate them immediately, then ask the primary store for the
+     * canonical claim.
+     *
+     * @param int           $max_actions
+     * @param DateTime|null $before_date
+     *
+     * @return ActionScheduler_ActionClaim
+     */
+    public function stake_claim( $max_actions = 10, DateTime $before_date = null, $hooks = array(), $group = '' ) {
+        $claim = $this->secondary_store->stake_claim( $max_actions, $before_date, $hooks, $group );
+
+        $claimed_actions = $claim->get_actions();
+        if ( ! empty( $claimed_actions ) ) {
+            $this->migrate( $claimed_actions );
+        }
+
+        $this->secondary_store->release_claim( $claim );
+
+        return $this->primary_store->stake_claim( $max_actions, $before_date, $hooks, $group );
+    }
+
+    /**
+     * Migrate a list of actions to the table data store.
+     *
+     * @param array $action_ids List of action IDs.
+     */
+    private function migrate( $action_ids ) {
+        $this->migration_runner->migrate_actions( $action_ids );
+    }
+
+    /**
+     * Save an action to the primary store.
+     *
+     * @param ActionScheduler_Action $action Action object to be saved.
+     * @param DateTime               $date Optional. Schedule date. Default null.
+     */
+    public function save_action( ActionScheduler_Action $action, DateTime $date = null ) {
+        return $this->primary_store->save_action( $action, $date );
+    }
+
+    /**
+     * Retrieve an existing action whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function fetch_action( $action_id ) {
+        if ( $action_id < $this->demarkation_id ) {
+            return $this->secondary_store->fetch_action( $action_id );
+        } else {
+            return $this->primary_store->fetch_action( $action_id );
+        }
+    }
+
+    /**
+     * Cancel an existing action whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function cancel_action( $action_id ) {
+        if ( $action_id < $this->demarkation_id ) {
+            $this->secondary_store->cancel_action( $action_id );
+        } else {
+            $this->primary_store->cancel_action( $action_id );
+        }
+    }
+
+    /**
+     * Delete an existing action whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function delete_action( $action_id ) {
+        if ( $action_id < $this->demarkation_id ) {
+            $this->secondary_store->delete_action( $action_id );
+        } else {
+            $this->primary_store->delete_action( $action_id );
+        }
+    }
+
+    /**
+     * Get the schedule date an existing action whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function get_date( $action_id ) {
+        if ( $action_id < $this->demarkation_id ) {
+            return $this->secondary_store->get_date( $action_id );
+        } else {
+            return $this->primary_store->get_date( $action_id );
+        }
+    }
+
+    /**
+     * Mark an existing action as failed whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function mark_failure( $action_id ) {
+        if ( $action_id < $this->demarkation_id ) {
+            $this->secondary_store->mark_failure( $action_id );
+        } else {
+            $this->primary_store->mark_failure( $action_id );
+        }
+    }
+
+    /**
+     * Log the execution of an existing action whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function log_execution( $action_id ) {
+        if ( $action_id < $this->demarkation_id ) {
+            $this->secondary_store->log_execution( $action_id );
+        } else {
+            $this->primary_store->log_execution( $action_id );
+        }
+    }
+
+    /**
+     * Mark an existing action complete whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function mark_complete( $action_id ) {
+        if ( $action_id < $this->demarkation_id ) {
+            $this->secondary_store->mark_complete( $action_id );
+        } else {
+            $this->primary_store->mark_complete( $action_id );
+        }
+    }
+
+    /**
+     * Get an existing action status whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function get_status( $action_id ) {
+        if ( $action_id < $this->demarkation_id ) {
+            return $this->secondary_store->get_status( $action_id );
+        } else {
+            return $this->primary_store->get_status( $action_id );
+        }
+    }
+
+
+    /* * * * * * * * * * * * * * * * * * * * * * * * * * *
 	 * All claim-related functions should operate solely
 	 * on the primary store.
 	 * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
-	/**
-	 * Get the claim count from the table data store.
-	 */
-	public function get_claim_count() {
-		return $this->primary_store->get_claim_count();
-	}
-
-	/**
-	 * Retrieve the claim ID for an action from the table data store.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function get_claim_id( $action_id ) {
-		return $this->primary_store->get_claim_id( $action_id );
-	}
-
-	/**
-	 * Release a claim in the table data store.
-	 *
-	 * @param ActionScheduler_ActionClaim $claim Claim object.
-	 */
-	public function release_claim( ActionScheduler_ActionClaim $claim ) {
-		$this->primary_store->release_claim( $claim );
-	}
-
-	/**
-	 * Release claims on an action in the table data store.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function unclaim_action( $action_id ) {
-		$this->primary_store->unclaim_action( $action_id );
-	}
-
-	/**
-	 * Retrieve a list of action IDs by claim.
-	 *
-	 * @param int $claim_id Claim ID.
-	 */
-	public function find_actions_by_claim_id( $claim_id ) {
-		return $this->primary_store->find_actions_by_claim_id( $claim_id );
-	}
+    /**
+     * Get the claim count from the table data store.
+     */
+    public function get_claim_count() {
+        return $this->primary_store->get_claim_count();
+    }
+
+    /**
+     * Retrieve the claim ID for an action from the table data store.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function get_claim_id( $action_id ) {
+        return $this->primary_store->get_claim_id( $action_id );
+    }
+
+    /**
+     * Release a claim in the table data store.
+     *
+     * @param ActionScheduler_ActionClaim $claim Claim object.
+     */
+    public function release_claim( ActionScheduler_ActionClaim $claim ) {
+        $this->primary_store->release_claim( $claim );
+    }
+
+    /**
+     * Release claims on an action in the table data store.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function unclaim_action( $action_id ) {
+        $this->primary_store->unclaim_action( $action_id );
+    }
+
+    /**
+     * Retrieve a list of action IDs by claim.
+     *
+     * @param int $claim_id Claim ID.
+     */
+    public function find_actions_by_claim_id( $claim_id ) {
+        return $this->primary_store->find_actions_by_claim_id( $claim_id );
+    }
 }

includes/libraries/action-scheduler/classes/data-stores/ActionScheduler_DBLogger.php

Indentation +134 added lines, -134 removed lines

@@ -9,138 +9,138 @@
  */
 class ActionScheduler_DBLogger extends ActionScheduler_Logger {
 
-	/**
-	 * Add a record to an action log.
-	 *
-	 * @param int      $action_id Action ID.
-	 * @param string   $message Message to be saved in the log entry.
-	 * @param DateTime $date Timestamp of the log entry.
-	 *
-	 * @return int     The log entry ID.
-	 */
-	public function log( $action_id, $message, DateTime $date = null ) {
-		if ( empty( $date ) ) {
-			$date = as_get_datetime_object();
-		} else {
-			$date = clone $date;
-		}
-
-		$date_gmt = $date->format( 'Y-m-d H:i:s' );
-		ActionScheduler_TimezoneHelper::set_local_timezone( $date );
-		$date_local = $date->format( 'Y-m-d H:i:s' );
-
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$wpdb->insert( $wpdb->actionscheduler_logs, [
-			'action_id'      => $action_id,
-			'message'        => $message,
-			'log_date_gmt'   => $date_gmt,
-			'log_date_local' => $date_local,
-		], [ '%d', '%s', '%s', '%s' ] );
-
-		return $wpdb->insert_id;
-	}
-
-	/**
-	 * Retrieve an action log entry.
-	 *
-	 * @param int $entry_id Log entry ID.
-	 *
-	 * @return ActionScheduler_LogEntry
-	 */
-	public function get_entry( $entry_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$entry = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE log_id=%d", $entry_id ) );
-
-		return $this->create_entry_from_db_record( $entry );
-	}
-
-	/**
-	 * Create an action log entry from a database record.
-	 *
-	 * @param object $record Log entry database record object.
-	 *
-	 * @return ActionScheduler_LogEntry
-	 */
-	private function create_entry_from_db_record( $record ) {
-		if ( empty( $record ) ) {
-			return new ActionScheduler_NullLogEntry();
-		}
-
-		$date = as_get_datetime_object( $record->log_date_gmt );
-
-		return new ActionScheduler_LogEntry( $record->action_id, $record->message, $date );
-	}
-
-	/**
-	 * Retrieve the an action's log entries from the database.
-	 *
-	 * @param int $action_id Action ID.
-	 *
-	 * @return ActionScheduler_LogEntry[]
-	 */
-	public function get_logs( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-
-		$records = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE action_id=%d", $action_id ) );
-
-		return array_map( [ $this, 'create_entry_from_db_record' ], $records );
-	}
-
-	/**
-	 * Initialize the data store.
-	 *
-	 * @codeCoverageIgnore
-	 */
-	public function init() {
-
-		$table_maker = new ActionScheduler_LoggerSchema();
-		$table_maker->register_tables();
-
-		parent::init();
-
-		add_action( 'action_scheduler_deleted_action', [ $this, 'clear_deleted_action_logs' ], 10, 1 );
-	}
-
-	/**
-	 * Delete the action logs for an action.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function clear_deleted_action_logs( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$wpdb->delete( $wpdb->actionscheduler_logs, [ 'action_id' => $action_id, ], [ '%d' ] );
-	}
-
-	/**
-	 * Bulk add cancel action log entries.
-	 *
-	 * @param array $action_ids List of action ID.
-	 */
-	public function bulk_log_cancel_actions( $action_ids ) {
-		if ( empty( $action_ids ) ) {
-			return;
-		}
-
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$date     = as_get_datetime_object();
-		$date_gmt = $date->format( 'Y-m-d H:i:s' );
-		ActionScheduler_TimezoneHelper::set_local_timezone( $date );
-		$date_local = $date->format( 'Y-m-d H:i:s' );
-		$message    = __( 'action canceled', 'action-scheduler' );
-		$format     = '(%d, ' . $wpdb->prepare( '%s, %s, %s', $message, $date_gmt, $date_local ) . ')';
-		$sql_query  = "INSERT {$wpdb->actionscheduler_logs} (action_id, message, log_date_gmt, log_date_local) VALUES ";
-		$value_rows = [];
-
-		foreach ( $action_ids as $action_id ) {
-			$value_rows[] = $wpdb->prepare( $format, $action_id );
-		}
-		$sql_query .= implode( ',', $value_rows );
-
-		$wpdb->query( $sql_query );
-	}
+    /**
+     * Add a record to an action log.
+     *
+     * @param int      $action_id Action ID.
+     * @param string   $message Message to be saved in the log entry.
+     * @param DateTime $date Timestamp of the log entry.
+     *
+     * @return int     The log entry ID.
+     */
+    public function log( $action_id, $message, DateTime $date = null ) {
+        if ( empty( $date ) ) {
+            $date = as_get_datetime_object();
+        } else {
+            $date = clone $date;
+        }
+
+        $date_gmt = $date->format( 'Y-m-d H:i:s' );
+        ActionScheduler_TimezoneHelper::set_local_timezone( $date );
+        $date_local = $date->format( 'Y-m-d H:i:s' );
+
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $wpdb->insert( $wpdb->actionscheduler_logs, [
+            'action_id'      => $action_id,
+            'message'        => $message,
+            'log_date_gmt'   => $date_gmt,
+            'log_date_local' => $date_local,
+        ], [ '%d', '%s', '%s', '%s' ] );
+
+        return $wpdb->insert_id;
+    }
+
+    /**
+     * Retrieve an action log entry.
+     *
+     * @param int $entry_id Log entry ID.
+     *
+     * @return ActionScheduler_LogEntry
+     */
+    public function get_entry( $entry_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $entry = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE log_id=%d", $entry_id ) );
+
+        return $this->create_entry_from_db_record( $entry );
+    }
+
+    /**
+     * Create an action log entry from a database record.
+     *
+     * @param object $record Log entry database record object.
+     *
+     * @return ActionScheduler_LogEntry
+     */
+    private function create_entry_from_db_record( $record ) {
+        if ( empty( $record ) ) {
+            return new ActionScheduler_NullLogEntry();
+        }
+
+        $date = as_get_datetime_object( $record->log_date_gmt );
+
+        return new ActionScheduler_LogEntry( $record->action_id, $record->message, $date );
+    }
+
+    /**
+     * Retrieve the an action's log entries from the database.
+     *
+     * @param int $action_id Action ID.
+     *
+     * @return ActionScheduler_LogEntry[]
+     */
+    public function get_logs( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+
+        $records = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE action_id=%d", $action_id ) );
+
+        return array_map( [ $this, 'create_entry_from_db_record' ], $records );
+    }
+
+    /**
+     * Initialize the data store.
+     *
+     * @codeCoverageIgnore
+     */
+    public function init() {
+
+        $table_maker = new ActionScheduler_LoggerSchema();
+        $table_maker->register_tables();
+
+        parent::init();
+
+        add_action( 'action_scheduler_deleted_action', [ $this, 'clear_deleted_action_logs' ], 10, 1 );
+    }
+
+    /**
+     * Delete the action logs for an action.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function clear_deleted_action_logs( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $wpdb->delete( $wpdb->actionscheduler_logs, [ 'action_id' => $action_id, ], [ '%d' ] );
+    }
+
+    /**
+     * Bulk add cancel action log entries.
+     *
+     * @param array $action_ids List of action ID.
+     */
+    public function bulk_log_cancel_actions( $action_ids ) {
+        if ( empty( $action_ids ) ) {
+            return;
+        }
+
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $date     = as_get_datetime_object();
+        $date_gmt = $date->format( 'Y-m-d H:i:s' );
+        ActionScheduler_TimezoneHelper::set_local_timezone( $date );
+        $date_local = $date->format( 'Y-m-d H:i:s' );
+        $message    = __( 'action canceled', 'action-scheduler' );
+        $format     = '(%d, ' . $wpdb->prepare( '%s, %s, %s', $message, $date_gmt, $date_local ) . ')';
+        $sql_query  = "INSERT {$wpdb->actionscheduler_logs} (action_id, message, log_date_gmt, log_date_local) VALUES ";
+        $value_rows = [];
+
+        foreach ( $action_ids as $action_id ) {
+            $value_rows[] = $wpdb->prepare( $format, $action_id );
+        }
+        $sql_query .= implode( ',', $value_rows );
+
+        $wpdb->query( $sql_query );
+    }
 }

includes/libraries/action-scheduler/classes/data-stores/ActionScheduler_wpPostStore_TaxonomyRegistrar.php

Indentation +16 added lines, -16 removed lines

@@ -5,22 +5,22 @@
  * @codeCoverageIgnore
  */
 class ActionScheduler_wpPostStore_TaxonomyRegistrar {
-	public function register() {
-		register_taxonomy( ActionScheduler_wpPostStore::GROUP_TAXONOMY, ActionScheduler_wpPostStore::POST_TYPE, $this->taxonomy_args() );
-	}
+    public function register() {
+        register_taxonomy( ActionScheduler_wpPostStore::GROUP_TAXONOMY, ActionScheduler_wpPostStore::POST_TYPE, $this->taxonomy_args() );
+    }
 
-	protected function taxonomy_args() {
-		$args = array(
-			'label' => __( 'Action Group', 'action-scheduler' ),
-			'public' => false,
-			'hierarchical' => false,
-			'show_admin_column' => true,
-			'query_var' => false,
-			'rewrite' => false,
-		);
+    protected function taxonomy_args() {
+        $args = array(
+            'label' => __( 'Action Group', 'action-scheduler' ),
+            'public' => false,
+            'hierarchical' => false,
+            'show_admin_column' => true,
+            'query_var' => false,
+            'rewrite' => false,
+        );
 
-		$args = apply_filters( 'action_scheduler_taxonomy_args', $args );
-		return $args;
-	}
+        $args = apply_filters( 'action_scheduler_taxonomy_args', $args );
+        return $args;
+    }
 }
- 
\ No newline at end of file
+    
\ No newline at end of file

includes/libraries/action-scheduler/classes/data-stores/ActionScheduler_wpPostStore_PostTypeRegistrar.php

Indentation +40 added lines, -40 removed lines

@@ -5,46 +5,46 @@
  * @codeCoverageIgnore
  */
 class ActionScheduler_wpPostStore_PostTypeRegistrar {
-	public function register() {
-		register_post_type( ActionScheduler_wpPostStore::POST_TYPE, $this->post_type_args() );
-	}
+    public function register() {
+        register_post_type( ActionScheduler_wpPostStore::POST_TYPE, $this->post_type_args() );
+    }
 
-	/**
-	 * Build the args array for the post type definition
-	 *
-	 * @return array
-	 */
-	protected function post_type_args() {
-		$args = array(
-			'label' => __( 'Scheduled Actions', 'action-scheduler' ),
-			'description' => __( 'Scheduled actions are hooks triggered on a cetain date and time.', 'action-scheduler' ),
-			'public' => false,
-			'map_meta_cap' => true,
-			'hierarchical' => false,
-			'supports' => array('title', 'editor','comments'),
-			'rewrite' => false,
-			'query_var' => false,
-			'can_export' => true,
-			'ep_mask' => EP_NONE,
-			'labels' => array(
-				'name' => __( 'Scheduled Actions', 'action-scheduler' ),
-				'singular_name' => __( 'Scheduled Action', 'action-scheduler' ),
-				'menu_name' => _x( 'Scheduled Actions', 'Admin menu name', 'action-scheduler' ),
-				'add_new' => __( 'Add', 'action-scheduler' ),
-				'add_new_item' => __( 'Add New Scheduled Action', 'action-scheduler' ),
-				'edit' => __( 'Edit', 'action-scheduler' ),
-				'edit_item' => __( 'Edit Scheduled Action', 'action-scheduler' ),
-				'new_item' => __( 'New Scheduled Action', 'action-scheduler' ),
-				'view' => __( 'View Action', 'action-scheduler' ),
-				'view_item' => __( 'View Action', 'action-scheduler' ),
-				'search_items' => __( 'Search Scheduled Actions', 'action-scheduler' ),
-				'not_found' => __( 'No actions found', 'action-scheduler' ),
-				'not_found_in_trash' => __( 'No actions found in trash', 'action-scheduler' ),
-			),
-		);
+    /**
+     * Build the args array for the post type definition
+     *
+     * @return array
+     */
+    protected function post_type_args() {
+        $args = array(
+            'label' => __( 'Scheduled Actions', 'action-scheduler' ),
+            'description' => __( 'Scheduled actions are hooks triggered on a cetain date and time.', 'action-scheduler' ),
+            'public' => false,
+            'map_meta_cap' => true,
+            'hierarchical' => false,
+            'supports' => array('title', 'editor','comments'),
+            'rewrite' => false,
+            'query_var' => false,
+            'can_export' => true,
+            'ep_mask' => EP_NONE,
+            'labels' => array(
+                'name' => __( 'Scheduled Actions', 'action-scheduler' ),
+                'singular_name' => __( 'Scheduled Action', 'action-scheduler' ),
+                'menu_name' => _x( 'Scheduled Actions', 'Admin menu name', 'action-scheduler' ),
+                'add_new' => __( 'Add', 'action-scheduler' ),
+                'add_new_item' => __( 'Add New Scheduled Action', 'action-scheduler' ),
+                'edit' => __( 'Edit', 'action-scheduler' ),
+                'edit_item' => __( 'Edit Scheduled Action', 'action-scheduler' ),
+                'new_item' => __( 'New Scheduled Action', 'action-scheduler' ),
+                'view' => __( 'View Action', 'action-scheduler' ),
+                'view_item' => __( 'View Action', 'action-scheduler' ),
+                'search_items' => __( 'Search Scheduled Actions', 'action-scheduler' ),
+                'not_found' => __( 'No actions found', 'action-scheduler' ),
+                'not_found_in_trash' => __( 'No actions found in trash', 'action-scheduler' ),
+            ),
+        );
 
-		$args = apply_filters('action_scheduler_post_type_args', $args);
-		return $args;
-	}
+        $args = apply_filters('action_scheduler_post_type_args', $args);
+        return $args;
+    }
 }
- 
\ No newline at end of file
+    
\ No newline at end of file