2.3.2

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

@@ -6,22 +6,23 @@
  */
 abstract class ActionScheduler_Store {
 	const STATUS_COMPLETE = 'complete';
-	const STATUS_PENDING = 'pending';
-	const STATUS_RUNNING = 'in-progress';
-	const STATUS_FAILED = 'failed';
+	const STATUS_PENDING  = 'pending';
+	const STATUS_RUNNING  = 'in-progress';
+	const STATUS_FAILED   = 'failed';
+	const STATUS_CANCELED = 'canceled';
 
 	/** @var ActionScheduler_Store */
 	private static $store = NULL;
 
 	/**
 	 * @param ActionScheduler_Action $action
-	 * @param DateTime $date Optional date of the first instance
+	 * @param DateTime $scheduled_date Optional Date of the first instance
 	 *        to store. Otherwise uses the first date of the action's
 	 *        schedule.
 	 *
 	 * @return string The action ID
 	 */
-	abstract public function save_action( ActionScheduler_Action $action, DateTime $date = NULL );
+	abstract public function save_action( ActionScheduler_Action $action, DateTime $scheduled_date = NULL );
 
 	/**
 	 * @param string $action_id
@@ -44,16 +45,19 @@ abstract class ActionScheduler_Store {
 	abstract public function query_actions( $query = array() );
 
 	/**
-	 * @param string $action_id
+	 * Get a count of all actions in the store, grouped by status
 	 *
-	 * @return void
+	 * @return array
+	 */
+	abstract public function action_counts();
+
+	/**
+	 * @param string $action_id
 	 */
 	abstract public function cancel_action( $action_id );
 
 	/**
 	 * @param string $action_id
-	 *
-	 * @return void
 	 */
 	abstract public function delete_action( $action_id );
 
@@ -66,12 +70,14 @@ abstract class ActionScheduler_Store {
 
 
 	/**
-	 * @param int $max_actions
+	 * @param int      $max_actions
 	 * @param DateTime $before_date Claim only actions schedule before the given date. Defaults to now.
+	 * @param array    $hooks       Claim only actions with a hook or hooks.
+	 * @param string   $group       Claim only actions in the given group.
 	 *
 	 * @return ActionScheduler_ActionClaim
 	 */
-	abstract public function stake_claim( $max_actions = 10, DateTime $before_date = NULL );
+	abstract public function stake_claim( $max_actions = 10, DateTime $before_date = null, $hooks = array(), $group = '' );
 
 	/**
 	 * @return int
@@ -80,38 +86,115 @@ abstract class ActionScheduler_Store {
 
 	/**
 	 * @param ActionScheduler_ActionClaim $claim
-	 *
-	 * @return void
 	 */
 	abstract public function release_claim( ActionScheduler_ActionClaim $claim );
 
 	/**
 	 * @param string $action_id
-	 *
-	 * @return void
 	 */
 	abstract public function unclaim_action( $action_id );
 
 	/**
 	 * @param string $action_id
-	 *
-	 * @return void
 	 */
 	abstract public function mark_failure( $action_id );
 
 	/**
 	 * @param string $action_id
-	 * @return void
 	 */
 	abstract public function log_execution( $action_id );
 
 	/**
 	 * @param string $action_id
-	 *
-	 * @return void
 	 */
 	abstract public function mark_complete( $action_id );
 
+	/**
+	 * @param string $action_id
+	 *
+	 * @return string
+	 */
+	abstract public function get_status( $action_id );
+
+	/**
+	 * @param string $action_id
+	 * @return mixed
+	 */
+	abstract public function get_claim_id( $action_id );
+
+	/**
+	 * @param string $claim_id
+	 * @return array
+	 */
+	abstract public function find_actions_by_claim_id( $claim_id );
+
+	/**
+	 * @param string $comparison_operator
+	 * @return string
+	 */
+	protected function validate_sql_comparator( $comparison_operator ) {
+		if ( in_array( $comparison_operator, array('!=', '>', '>=', '<', '<=', '=') ) ) {
+			return $comparison_operator;
+		}
+		return '=';
+	}
+
+	/**
+	 * Get the time MySQL formated date/time string for an action's (next) scheduled date.
+	 *
+	 * @param ActionScheduler_Action $action
+	 * @param DateTime $scheduled_date (optional)
+	 * @return string
+	 */
+	protected function get_scheduled_date_string( ActionScheduler_Action $action, DateTime $scheduled_date = NULL ) {
+		$next = null === $scheduled_date ? $action->get_schedule()->next() : $scheduled_date;
+		if ( ! $next ) {
+			throw new InvalidArgumentException( __( 'Invalid schedule. Cannot save action.', 'action-scheduler' ) );
+		}
+		$next->setTimezone( new DateTimeZone( 'UTC' ) );
+
+		return $next->format( 'Y-m-d H:i:s' );
+	}
+
+	/**
+	 * Get the time MySQL formated date/time string for an action's (next) scheduled date.
+	 *
+	 * @param ActionScheduler_Action $action
+	 * @param DateTime $scheduled_date (optional)
+	 * @return string
+	 */
+	protected function get_scheduled_date_string_local( ActionScheduler_Action $action, DateTime $scheduled_date = NULL ) {
+		$next = null === $scheduled_date ? $action->get_schedule()->next() : $scheduled_date;
+		if ( ! $next ) {
+			throw new InvalidArgumentException( __( 'Invalid schedule. Cannot save action.', 'action-scheduler' ) );
+		}
+		$next->setTimezone( $this->get_local_timezone() );
+
+		return $next->format( 'Y-m-d H:i:s' );
+	}
+
+	/**
+	 * Get the site's local time. Wrapper for ActionScheduler_TimezoneHelper::get_local_timezone().
+	 *
+	 * @return DateTimeZone
+	 */
+	protected function get_local_timezone() {
+		return ActionScheduler_TimezoneHelper::get_local_timezone();
+	}
+
+	/**
+	 * @return array
+	 */
+	public function get_status_labels() {
+		return array(
+			self::STATUS_COMPLETE => __( 'Complete', 'action-scheduler' ),
+			self::STATUS_PENDING  => __( 'Pending', 'action-scheduler' ),
+			self::STATUS_RUNNING  => __( 'In-progress', 'action-scheduler' ),
+			self::STATUS_FAILED   => __( 'Failed', 'action-scheduler' ),
+			self::STATUS_CANCELED => __( 'Canceled', 'action-scheduler' ),
+		);
+	}
+
 	public function init() {}
 
 	/**
@@ -125,4 +208,3 @@ abstract class ActionScheduler_Store {
 		return self::$store;
 	}
 }
-