class-module.php
207 lines
| 1 | <?php |
| 2 | /** |
| 3 | * PEF module |
| 4 | * |
| 5 | * @package AdvancedAds |
| 6 | * @author Advanced Ads <info@wpadvancedads.com> |
| 7 | */ |
| 8 | |
| 9 | namespace AdvancedAds\Modules\ProductExperimentationFramework; |
| 10 | |
| 11 | /** |
| 12 | * Module main class |
| 13 | */ |
| 14 | class Module { |
| 15 | /** |
| 16 | * User meta key where the dismiss flag is stored. |
| 17 | * |
| 18 | * @var string |
| 19 | */ |
| 20 | const USER_META = 'advanced_ads_pef_dismiss'; |
| 21 | |
| 22 | /** |
| 23 | * Sum of all weights |
| 24 | * |
| 25 | * @var int |
| 26 | */ |
| 27 | private $weight_sum = 0; |
| 28 | |
| 29 | /** |
| 30 | * ID => weight association |
| 31 | * |
| 32 | * @var int[] |
| 33 | */ |
| 34 | private $weights = []; |
| 35 | |
| 36 | /** |
| 37 | * Whether the PEF can be displayed based on user meta |
| 38 | * |
| 39 | * @var bool |
| 40 | */ |
| 41 | private $can_display = true; |
| 42 | |
| 43 | /** |
| 44 | * Return the singleton. Create it if needed |
| 45 | * |
| 46 | * @return Module |
| 47 | */ |
| 48 | public static function get_instance(): Module { |
| 49 | static $instance; |
| 50 | |
| 51 | if ( null === $instance ) { |
| 52 | $instance = new self(); |
| 53 | } |
| 54 | |
| 55 | return $instance; |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Singleton design |
| 60 | */ |
| 61 | private function __construct() { |
| 62 | add_action( 'admin_init', [ $this, 'admin_init' ] ); |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * Initialization |
| 67 | * |
| 68 | * @return void |
| 69 | */ |
| 70 | public function admin_init(): void { |
| 71 | $meta = get_user_meta( get_current_user_id(), self::USER_META, true ); |
| 72 | if ( $meta && $this->get_minor_version( ADVADS_VERSION ) === $this->get_minor_version( $meta ) ) { |
| 73 | $this->can_display = false; |
| 74 | |
| 75 | return; |
| 76 | } |
| 77 | |
| 78 | $this->collect_weights(); |
| 79 | add_action( 'wp_ajax_advanced_ads_pef', [ $this, 'dismiss' ] ); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Ajax action to hie PEF for the current user until next plugin update |
| 84 | * |
| 85 | * @return void |
| 86 | */ |
| 87 | public function dismiss(): void { |
| 88 | if ( ! check_ajax_referer( 'advanced_ads_pef' ) ) { |
| 89 | wp_send_json_error( 'Unauthorized', 401 ); |
| 90 | } |
| 91 | |
| 92 | update_user_meta( get_current_user_id(), self::USER_META, ADVADS_VERSION ); |
| 93 | wp_send_json_success( 'OK', 200 ); |
| 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Get a random feature based on weights and a random number |
| 98 | * |
| 99 | * @return array |
| 100 | */ |
| 101 | public function get_winner_feature(): array { |
| 102 | $random_weight = wp_rand( 1, $this->weight_sum ); |
| 103 | $current_weight = 0; |
| 104 | foreach ( $this->get_features() as $id => $feature ) { |
| 105 | $current_weight += $this->weights[ $id ]; |
| 106 | if ( $random_weight <= $current_weight ) { |
| 107 | return array_merge( |
| 108 | [ |
| 109 | 'id' => $id, |
| 110 | 'weight' => $this->weights[ $id ], |
| 111 | ], |
| 112 | $this->get_features()[ $id ] |
| 113 | ); |
| 114 | } |
| 115 | } |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Render PEF |
| 120 | * |
| 121 | * @param string $screen the screen on which PEF is displayed, used in the utm_campaign parameter. |
| 122 | * |
| 123 | * @return void |
| 124 | */ |
| 125 | public function render( $screen ): void { // phpcs:ignore |
| 126 | // Early bail!! |
| 127 | if ( ! $this->can_display ) { |
| 128 | return; |
| 129 | } |
| 130 | $winner = $this->get_winner_feature(); |
| 131 | |
| 132 | require_once DIR . '/views/template.php'; |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Get minor part of a version |
| 137 | * |
| 138 | * @param string $version version to get the minor part from. |
| 139 | * |
| 140 | * @return string |
| 141 | */ |
| 142 | public function get_minor_version( $version ): string { |
| 143 | return explode( '.', $version )[1] ?? '0'; |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Build the link for the winner feature with all its utm parameters |
| 148 | * |
| 149 | * @param array $winner the winner feature. |
| 150 | * @param string $screen the screen on which it was displayed. |
| 151 | * |
| 152 | * @return string |
| 153 | */ |
| 154 | public function build_link( $winner, $screen ): string { |
| 155 | $utm_source = 'advanced-ads'; |
| 156 | $utm_medium = 'link'; |
| 157 | $utm_campaign = sprintf( '%s-aa-labs', $screen ); |
| 158 | $utm_term = sprintf( |
| 159 | 'b%s-w%d-%d', |
| 160 | str_replace( '.', '-', ADVADS_VERSION ), |
| 161 | $winner['weight'], |
| 162 | $this->weight_sum |
| 163 | ); |
| 164 | $utm_content = $winner['id']; |
| 165 | |
| 166 | return sprintf( |
| 167 | 'https://wpadvancedads.com/advanced-ads-labs/?utm_source=%s&utm_medium=%s&utm_campaign=%s&utm_term=%s&utm_content=%s', |
| 168 | $utm_source, |
| 169 | $utm_medium, |
| 170 | $utm_campaign, |
| 171 | $utm_term, |
| 172 | $utm_content |
| 173 | ); |
| 174 | } |
| 175 | |
| 176 | /** |
| 177 | * Set the features/banners |
| 178 | * |
| 179 | * @return array |
| 180 | */ |
| 181 | public function get_features(): array { |
| 182 | return [ |
| 183 | 'labs-amazon-integration' => [ |
| 184 | 'subheading' => __( 'FROM THE ADVANCED ADS LABS:', 'advanced-ads' ), |
| 185 | 'heading' => __( 'The Amazon Integration', 'advanced-ads' ), |
| 186 | 'weight' => 1, |
| 187 | 'text' => __( 'Our latest product concept puts Amazon affiliate marketing at your fingertips—right within Advanced Ads. It offers features like direct product import via Amazon API, multiple product display formats, and efficient ad tracking. We aim to create a one-stop solution for featuring Amazon products on your site without resorting to expensive third-party plugins.', 'advanced-ads' ), |
| 188 | 'cta' => __( 'Are you interested in this product concept?', 'advanced-ads' ), |
| 189 | 'cta_button' => __( 'Yes, I want to know more!', 'advanced-ads' ), |
| 190 | ], |
| 191 | ]; |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * Collect feature ID with their weight as recorded in the class constant. Also calculate the weight sum |
| 196 | */ |
| 197 | private function collect_weights() { |
| 198 | if ( 0 !== $this->weight_sum ) { |
| 199 | return; |
| 200 | } |
| 201 | foreach ( $this->get_features() as $id => $feature ) { |
| 202 | $this->weights[ $id ] = (int) $feature['weight']; |
| 203 | $this->weight_sum += $this->weights[ $id ]; |
| 204 | } |
| 205 | } |
| 206 | } |
| 207 |