Cancel_Command.php
6 months ago
Create_Command.php
6 months ago
Delete_Command.php
6 months ago
Generate_Command.php
6 months ago
Get_Command.php
6 months ago
List_Command.php
6 months ago
Next_Command.php
6 months ago
Run_Command.php
6 months ago
Run_Command.php
195 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Action_Scheduler\WP_CLI\Action; |
| 4 | |
| 5 | /** |
| 6 | * WP-CLI command: action-scheduler action run |
| 7 | */ |
| 8 | class Run_Command extends \ActionScheduler_WPCLI_Command { |
| 9 | |
| 10 | /** |
| 11 | * Array of action IDs to execute. |
| 12 | * |
| 13 | * @var int[] |
| 14 | */ |
| 15 | protected $action_ids = array(); |
| 16 | |
| 17 | /** |
| 18 | * Number of executed, failed, ignored, invalid, and total actions. |
| 19 | * |
| 20 | * @var array<string, int> |
| 21 | */ |
| 22 | protected $action_counts = array( |
| 23 | 'executed' => 0, |
| 24 | 'failed' => 0, |
| 25 | 'ignored' => 0, |
| 26 | 'invalid' => 0, |
| 27 | 'total' => 0, |
| 28 | ); |
| 29 | |
| 30 | /** |
| 31 | * Construct. |
| 32 | * |
| 33 | * @param string[] $args Positional arguments. |
| 34 | * @param array<string, string> $assoc_args Keyed arguments. |
| 35 | */ |
| 36 | public function __construct( array $args, array $assoc_args ) { |
| 37 | parent::__construct( $args, $assoc_args ); |
| 38 | |
| 39 | $this->action_ids = array_map( 'absint', $args ); |
| 40 | $this->action_counts['total'] = count( $this->action_ids ); |
| 41 | |
| 42 | add_action( 'action_scheduler_execution_ignored', array( $this, 'on_action_ignored' ) ); |
| 43 | add_action( 'action_scheduler_after_execute', array( $this, 'on_action_executed' ) ); |
| 44 | add_action( 'action_scheduler_failed_execution', array( $this, 'on_action_failed' ), 10, 2 ); |
| 45 | add_action( 'action_scheduler_failed_validation', array( $this, 'on_action_invalid' ), 10, 2 ); |
| 46 | } |
| 47 | |
| 48 | /** |
| 49 | * Execute. |
| 50 | * |
| 51 | * @return void |
| 52 | */ |
| 53 | public function execute() { |
| 54 | $runner = \ActionScheduler::runner(); |
| 55 | |
| 56 | $progress_bar = \WP_CLI\Utils\make_progress_bar( |
| 57 | sprintf( |
| 58 | /* translators: %d: number of actions */ |
| 59 | _n( 'Executing %d action', 'Executing %d actions', $this->action_counts['total'], 'action-scheduler' ), |
| 60 | number_format_i18n( $this->action_counts['total'] ) |
| 61 | ), |
| 62 | $this->action_counts['total'] |
| 63 | ); |
| 64 | |
| 65 | foreach ( $this->action_ids as $action_id ) { |
| 66 | $runner->process_action( $action_id, 'Action Scheduler CLI' ); |
| 67 | $progress_bar->tick(); |
| 68 | } |
| 69 | |
| 70 | $progress_bar->finish(); |
| 71 | |
| 72 | foreach ( array( |
| 73 | 'ignored', |
| 74 | 'invalid', |
| 75 | 'failed', |
| 76 | ) as $type ) { |
| 77 | $count = $this->action_counts[ $type ]; |
| 78 | |
| 79 | if ( empty( $count ) ) { |
| 80 | continue; |
| 81 | } |
| 82 | |
| 83 | /* |
| 84 | * translators: |
| 85 | * %1$d: count of actions evaluated. |
| 86 | * %2$s: type of action evaluated. |
| 87 | */ |
| 88 | $format = _n( '%1$d action %2$s.', '%1$d actions %2$s.', $count, 'action-scheduler' ); |
| 89 | |
| 90 | \WP_CLI::warning( |
| 91 | sprintf( |
| 92 | $format, |
| 93 | number_format_i18n( $count ), |
| 94 | $type |
| 95 | ) |
| 96 | ); |
| 97 | } |
| 98 | |
| 99 | \WP_CLI::success( |
| 100 | sprintf( |
| 101 | /* translators: %d: number of executed actions */ |
| 102 | _n( 'Executed %d action.', 'Executed %d actions.', $this->action_counts['executed'], 'action-scheduler' ), |
| 103 | number_format_i18n( $this->action_counts['executed'] ) |
| 104 | ) |
| 105 | ); |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Action: action_scheduler_execution_ignored |
| 110 | * |
| 111 | * @param int $action_id Action ID. |
| 112 | * @return void |
| 113 | */ |
| 114 | public function on_action_ignored( $action_id ) { |
| 115 | if ( 'action_scheduler_execution_ignored' !== current_action() ) { |
| 116 | return; |
| 117 | } |
| 118 | |
| 119 | $action_id = absint( $action_id ); |
| 120 | |
| 121 | if ( ! in_array( $action_id, $this->action_ids, true ) ) { |
| 122 | return; |
| 123 | } |
| 124 | |
| 125 | $this->action_counts['ignored']++; |
| 126 | \WP_CLI::debug( sprintf( 'Action %d was ignored.', $action_id ) ); |
| 127 | } |
| 128 | |
| 129 | /** |
| 130 | * Action: action_scheduler_after_execute |
| 131 | * |
| 132 | * @param int $action_id Action ID. |
| 133 | * @return void |
| 134 | */ |
| 135 | public function on_action_executed( $action_id ) { |
| 136 | if ( 'action_scheduler_after_execute' !== current_action() ) { |
| 137 | return; |
| 138 | } |
| 139 | |
| 140 | $action_id = absint( $action_id ); |
| 141 | |
| 142 | if ( ! in_array( $action_id, $this->action_ids, true ) ) { |
| 143 | return; |
| 144 | } |
| 145 | |
| 146 | $this->action_counts['executed']++; |
| 147 | \WP_CLI::debug( sprintf( 'Action %d was executed.', $action_id ) ); |
| 148 | } |
| 149 | |
| 150 | /** |
| 151 | * Action: action_scheduler_failed_execution |
| 152 | * |
| 153 | * @param int $action_id Action ID. |
| 154 | * @param \Exception $e Exception. |
| 155 | * @return void |
| 156 | */ |
| 157 | public function on_action_failed( $action_id, \Exception $e ) { |
| 158 | if ( 'action_scheduler_failed_execution' !== current_action() ) { |
| 159 | return; |
| 160 | } |
| 161 | |
| 162 | $action_id = absint( $action_id ); |
| 163 | |
| 164 | if ( ! in_array( $action_id, $this->action_ids, true ) ) { |
| 165 | return; |
| 166 | } |
| 167 | |
| 168 | $this->action_counts['failed']++; |
| 169 | \WP_CLI::debug( sprintf( 'Action %d failed execution: %s', $action_id, $e->getMessage() ) ); |
| 170 | } |
| 171 | |
| 172 | /** |
| 173 | * Action: action_scheduler_failed_validation |
| 174 | * |
| 175 | * @param int $action_id Action ID. |
| 176 | * @param \Exception $e Exception. |
| 177 | * @return void |
| 178 | */ |
| 179 | public function on_action_invalid( $action_id, \Exception $e ) { |
| 180 | if ( 'action_scheduler_failed_validation' !== current_action() ) { |
| 181 | return; |
| 182 | } |
| 183 | |
| 184 | $action_id = absint( $action_id ); |
| 185 | |
| 186 | if ( ! in_array( $action_id, $this->action_ids, true ) ) { |
| 187 | return; |
| 188 | } |
| 189 | |
| 190 | $this->action_counts['invalid']++; |
| 191 | \WP_CLI::debug( sprintf( 'Action %d failed validation: %s', $action_id, $e->getMessage() ) ); |
| 192 | } |
| 193 | |
| 194 | } |
| 195 |