one-click-accessibility/modules/reviews/module.php
Nirbhay Singh f4bff716ed
Update modules/reviews/module.php
Co-authored-by: gitstream-cm[bot] <111687743+gitstream-cm[bot]@users.noreply.github.com>
2025-06-19 10:59:49 +05:30

169 lines
3.6 KiB
PHP

<?php
namespace EA11y\Modules\Reviews;
use EA11y\Classes\Module_Base;
use EA11y\Classes\Utils;
use EA11y\Modules\Settings\Module as SettingsModule;
use Throwable;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
/**
* Class Module
*/
class Module extends Module_Base {
const REVIEW_DATA_OPTION = SettingsModule::SETTING_PREFIX . 'review_data';
/**
* Get module name.
* Retrieve the module name.
*
* @access public
* @return string Module name.
*/
public function get_name(): string {
return 'Reviews';
}
public static function routes_list() : array {
return [
'Feedback',
];
}
public function render_app(): void {
echo '<div id="reviews-app"></div>';
}
/**
* Enqueue Scripts and Styles
*/
public function enqueue_scripts( $hook ): void {
if ( SettingsModule::SETTING_PAGE_SLUG !== $hook ) {
return;
}
if ( ! $this->maybe_show_review_popup() ) {
return;
}
Utils\Assets::enqueue_app_assets( 'reviews' );
wp_localize_script(
'reviews',
'ea11yReviewData',
[
'wpRestNonce' => wp_create_nonce( 'wp_rest' ),
'reviewData' => $this->get_review_data(),
'isRTL' => is_rtl(),
]
);
$this->render_app();
}
public function register_base_data(): void {
if ( get_option( self::REVIEW_DATA_OPTION ) ) {
return;
}
$data = [
'dismissals' => 0,
'hide_for_days' => 0,
'last_dismiss' => null,
'rating' => null,
'feedback' => null,
'added_on' => gmdate( 'Y-m-d H:i:s' ),
'submitted' => false,
'repo_review_clicked' => false,
];
update_option( self::REVIEW_DATA_OPTION, $data, false );
}
/**
* Register settings.
*
* Register settings for the plugin.
*
* @return void
* @throws Throwable
*/
public function register_settings(): void {
$settings = [
'review_data' => [
'type' => 'object',
'show_in_rest' => [
'schema' => [
'type' => 'object',
'additionalProperties' => true,
],
],
],
];
foreach ( $settings as $setting => $args ) {
if ( ! isset( $args['show_in_rest'] ) ) {
$args['show_in_rest'] = true;
}
register_setting( 'options', SettingsModule::SETTING_PREFIX . $setting, $args );
}
}
public function get_review_data(): array {
return get_option( self::REVIEW_DATA_OPTION );
}
public function get_days_since_installed() {
return 10; //TODO: Update rendering logic
}
public function maybe_show_review_popup() {
if ( $this->get_days_since_installed() > 7 ) {
$review_data = $this->get_review_data();
// Don't show if user has already submitted feedback when rating is less than 4.
if ( isset( $review_data['rating'] ) && (int) $review_data['rating'] < 4 ) {
return false;
}
// Hide if rating is submitted but repo review is not clicked.
if ( (int) $review_data['rating'] > 3 && $review_data['repo_review_clicked'] ) {
return false;
}
// Don't show if user has dismissed the popup 3 times.
if ( 3 === (int) $review_data['dismissals'] ) {
return false;
}
if ( isset( $review_data['hide_for_days'] ) && $review_data['hide_for_days'] > 0 ) {
$hide_for_days = $review_data['hide_for_days'];
$last_dismiss = strtotime( $review_data['last_dismiss'] );
$days_since_dismiss = floor( ( time() - $last_dismiss ) / DAY_IN_SECONDS );
if ( $days_since_dismiss < $hide_for_days ) {
return false;
}
}
return true;
}
return false;
}
public function __construct() {
add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_scripts' ] );
add_action( 'admin_init', [ $this, 'register_base_data' ] );
add_action( 'rest_api_init', [ $this, 'register_settings' ] );
$this->register_routes();
}
}