GetStats.php

<?php
/**
 * Get stats for a give post ID or all posts.
 *
 * @since 1.15.0
 *
 * @package Accessibility_Checker
 */

namespace EqualizeDigital\AccessibilityChecker\WPCLI\Command;

use EDAC\Inc\Summary_Generator;
use WP_CLI;
use WP_CLI\ExitException;

/**
 * Get stats for a give post ID or all posts.
 *
 * @since 1.15.0
 *
 * @package AccessibilityCheckerCLI
 */
class GetStats implements CLICommandInterface {

	/**
	 * The WP-CLI instance.
	 *
	 * This lets a mock be passed in for testing.
	 *
	 * @var mixed|WP_CLI
	 */
	private $wp_cli;

	/**
	 * An array of valid stats keys.
	 *
	 * @since 1.15.0
	 *
	 * @var array|string[]
	 */
	private static array $valid_stats = [
		'passed_tests',
		'errors',
		'warnings',
		'ignored',
		'contrast_errors',
		'content_grade',
		'readability',
		'simplified_summary',
	];

	/**
	 * GetStats constructor.
	 *
	 * @param mixed|WP_CLI $wp_cli The WP-CLI instance.
	 */
	public function __construct( $wp_cli = null ) {
		$this->wp_cli = $wp_cli ?? new WP_CLI();
	}

	/**
	 * Get the name of the command.
	 *
	 * @since 1.15.0
	 *
	 * @return string
	 */
	public static function get_name(): string {
		return 'accessibility-checker get-stats';
	}

	/**
	 * Get the short name of the command.
	 *
	 * @since 1.33.0
	 *
	 * @return string
	 */
	public static function get_shortname(): string {
		return 'edac get-stats';
	}

	/**
	 * Get the arguments for the command
	 *
	 * @since 1.15.0
	 *
	 * @return array
	 */
	public static function get_args(): array {
		return [
			'synopsis' => [
				[
					'type'        => 'positional',
					'name'        => 'post_id',
					'description' => esc_html__( 'The ID of the post to get stats for.', 'accessibility-checker' ),
					'optional'    => true,
					'default'     => 0,
					'repeating'   => false,
				],
				[
					'type'        => 'assoc',
					'name'        => 'stat',
					'description' => sprintf(
						// translators: 1: a comma separated list of valid stats keys that should not be translated.
						'Keys to show in the results. Defaults to all keys. Pass items in as a comma separated list if you want multiple. Valid keys are: %1$s.',
						implode( ', ', self::$valid_stats )
					),
					'optional'    => true,
					'default'     => null,
					'repeating'   => true,
				],
			],
		];
	}

	/**
	 * Gets the accessibility-checker stats for a given post ID.
	 *
	 * @since 1.15.0
	 *
	 * @param array $options The positional argument, the post ID in this case.
	 * @param array $arguments The associative argument, the stat key in this case.
	 *
	 * @return void
	 * @throws ExitException If the post ID does not exist, or the class we need isn't available.
	 */
	public function __invoke( array $options = [], array $arguments = [] ) {
		$post_id = $options[0] ?? null;

		$post_exists = (bool) get_post( $post_id );

		if ( ! $post_exists ) {
			$this->wp_cli::error(
				sprintf(
					// translators: 1: a post ID.
					esc_html__( 'Post ID %1$d does not exist.', 'accessibility-checker' ),
					$post_id
				)
			);
			return;
		}

		$stats = ( new Summary_Generator( $post_id ) )->generate_summary();

		if (
			empty( $stats ) ||
			( 100 === (int) $stats['passed_tests'] && 0 === (int) $stats['ignored'] )
		) {
			$this->wp_cli::success(
				sprintf(
					// translators: 1: a post ID.
					esc_html__( 'Either the post is not yet scanned or all tests passed for post ID %1$d.', 'accessibility-checker' ),
					$post_id
				)
			);
			return;
		}

		if ( ! empty( $arguments['stat'] ) ) {
			$items_to_return = [];
			$requested_stats = explode( ',', $arguments['stat'] );
			foreach ( $requested_stats as $key ) {
				$stats_key = trim( $key );
				if ( ! in_array( $stats_key, self::$valid_stats, true ) || ! isset( $stats[ $stats_key ] ) ) {
					$this->wp_cli::error(
						sprintf(
						// translators: 1: a stat key, 2: a comma separated list of valid stats keys.
							'Invalid stat key: %1$s. Valid keys are: %2$s.',
							$stats_key,
							implode( ', ', self::$valid_stats )
						)
					);

					return;
				}
				$items_to_return[ $stats_key ] = $stats[ $stats_key ];
			}

			if ( $items_to_return ) {
				$this->wp_cli::success( wp_json_encode( $items_to_return, JSON_PRETTY_PRINT ) );
				return;
			}
		}

		$this->wp_cli::success( wp_json_encode( $stats, JSON_PRETTY_PRINT ) );
	}
}