AI
3 days ago
Beacon
3 days ago
ContextualInfo
3 days ago
Debug
3 days ago
Exception
3 days ago
FreeShipping
3 days ago
ImporterExporter
3 days ago
Order
3 days ago
Rates
3 days ago
Rule
3 days ago
ShippingMethod
3 days ago
ShippingMethodsIntegration
3 days ago
Tax
3 days ago
views
3 days ago
Beacon.php
3 days ago
DefaultRulesSettings.php
3 days ago
MultiCurrency.php
3 days ago
RulesSettingsField.php
3 days ago
RulesTableSettings.php
3 days ago
ShippingMethodSingle.php
3 days ago
UserFeedback.php
3 days ago
RulesSettingsField.php
323 lines
| 1 | <?php |
| 2 | /** |
| 3 | * @package WPDesk\FS\TableRate |
| 4 | */ |
| 5 | |
| 6 | namespace WPDesk\FS\TableRate; |
| 7 | |
| 8 | use WPDesk\FS\TableRate\Rule\Condition\ConditionsFactory; |
| 9 | use WPDesk\FS\TableRate\Rule\Cost\RuleAdditionalCostFieldsFactory; |
| 10 | use WPDesk\FS\TableRate\Rule\Cost\RuleAdditionalCostFactory; |
| 11 | use WPDesk\FS\TableRate\Rule\Cost\RuleCostFieldsFactory; |
| 12 | use WPDesk\FS\TableRate\Rule\PreconfiguredScenarios\PreconfiguredScenariosFactory; |
| 13 | use WPDesk\FS\TableRate\Rule\SpecialAction\SpecialActionFieldsFactory; |
| 14 | use WPDesk\FS\TableRate\Rule\SpecialAction\SpecialActionFactory; |
| 15 | use WPDesk\FS\ProFeatures; |
| 16 | use WPDesk\FS\TableRate\Rule\PreconfiguredScenarios; |
| 17 | |
| 18 | /** |
| 19 | * Class RulesSettings |
| 20 | */ |
| 21 | class RulesSettingsField { |
| 22 | |
| 23 | const FIELD_TYPE = 'shipping_rules'; |
| 24 | |
| 25 | private const AI_PURCHASE_URL = 'https://octol.io/flexibleshipping-ai'; |
| 26 | private const AI_PURCHASE_URL_PL = 'https://octol.io/flexibleshipping-ai-pl'; |
| 27 | |
| 28 | /** |
| 29 | * @var string |
| 30 | */ |
| 31 | protected static $assets_url; |
| 32 | |
| 33 | /** |
| 34 | * @var string |
| 35 | */ |
| 36 | private $settings_field_id; |
| 37 | |
| 38 | /** |
| 39 | * @var string |
| 40 | */ |
| 41 | private $settings_field_name; |
| 42 | |
| 43 | /** |
| 44 | * @var string |
| 45 | */ |
| 46 | private $settings_field_title; |
| 47 | |
| 48 | /** |
| 49 | * @var array |
| 50 | */ |
| 51 | private $settings; |
| 52 | |
| 53 | /** |
| 54 | * @var array |
| 55 | */ |
| 56 | private $value; |
| 57 | |
| 58 | /** |
| 59 | * @var array |
| 60 | */ |
| 61 | private $shipping_method_settings; |
| 62 | |
| 63 | /** |
| 64 | * RulesSettings constructor. |
| 65 | * |
| 66 | * @param string $settings_field_id . |
| 67 | * @param string $settings_field_name . |
| 68 | * @param string $settings_field_title . |
| 69 | * @param array $settings . |
| 70 | * @param array $value . |
| 71 | * @param array $shipping_method_settings . |
| 72 | */ |
| 73 | public function __construct( $settings_field_id, $settings_field_name, $settings_field_title, $settings, $value = null, $shipping_method_settings = [] ) { |
| 74 | $this->settings_field_id = $settings_field_id; |
| 75 | $this->settings_field_name = $settings_field_name; |
| 76 | $this->settings_field_title = $settings_field_title; |
| 77 | $this->settings = $settings; |
| 78 | $this->value = $value; |
| 79 | $this->shipping_method_settings = $shipping_method_settings; |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * @param string $assets_url . |
| 84 | */ |
| 85 | public static function set_assets_url( $assets_url ) { |
| 86 | self::$assets_url = $assets_url; |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * Render settings. |
| 91 | * |
| 92 | * @return string |
| 93 | */ |
| 94 | public function render() { |
| 95 | ob_start(); |
| 96 | $settings_field_id = $this->settings_field_id; |
| 97 | $settings_field_name = $this->settings_field_name; |
| 98 | $settings_field_title = $this->settings_field_title; |
| 99 | $available_conditions = $this->get_available_conditions(); |
| 100 | $rules_settings = $this->get_normalized_settings( $available_conditions ); |
| 101 | $available_conditions = array_values( $available_conditions ); |
| 102 | $translations = $this->get_translations(); |
| 103 | $pro_features_data = $this->get_pro_features_data(); |
| 104 | $table_settings = $this->get_table_settings(); |
| 105 | |
| 106 | $cost_settings_fields = $this->get_available_cost_settings(); |
| 107 | $additional_cost_fields = $this->get_additional_cost_fields(); |
| 108 | $special_action_fields = $this->get_special_actions_fields(); |
| 109 | $preconfigured_scenarios = $this->get_preconfigured_scenarios(); |
| 110 | |
| 111 | $shop_settings = $this->get_shop_settings(); |
| 112 | |
| 113 | $is_pro_activated = defined( 'FLEXIBLE_SHIPPING_PRO_VERSION' ); |
| 114 | |
| 115 | $rules_table_settings = [ |
| 116 | 'rules_settings' => $rules_settings, |
| 117 | 'table_settings' => $table_settings, |
| 118 | 'translations' => $translations, |
| 119 | 'available_conditions' => $available_conditions, |
| 120 | 'cost_settings_fields' => $cost_settings_fields, |
| 121 | 'special_action_fields' => $special_action_fields, |
| 122 | 'additional_cost_fields' => $additional_cost_fields, |
| 123 | 'preconfigured_scenarios' => $preconfigured_scenarios, |
| 124 | 'is_pro_activated' => $is_pro_activated, |
| 125 | 'pro_features_data' => $pro_features_data, |
| 126 | 'paste_available' => true, |
| 127 | 'ai_button_available' => false, |
| 128 | 'ai_button_url' => 'https://octol.io/fs-rules-table-ai', |
| 129 | 'ai_local_button_available' => true, |
| 130 | 'ai_local_message_title' => __( 'Let AI build your rules table', 'flexible-shipping' ), |
| 131 | 'ai_local_message' => $this->get_ai_local_message(), |
| 132 | 'ai_local_message_action' => __( 'Get Flexible Shipping PRO →', 'flexible-shipping' ), |
| 133 | 'ai_local_message_action_url' => $this->get_ai_purchase_url(), |
| 134 | 'shop_settings' => $shop_settings, |
| 135 | ]; |
| 136 | |
| 137 | $rules_table_settings = $this->filter_rules_table_settings( $rules_table_settings ); |
| 138 | |
| 139 | include __DIR__ . '/views/shipping-method-settings-rules.php'; |
| 140 | |
| 141 | return ob_get_clean(); |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Filters rules table settings. |
| 146 | * |
| 147 | * @param array $rules_table_settings Rules table settings. |
| 148 | * |
| 149 | * @return array |
| 150 | */ |
| 151 | protected function filter_rules_table_settings( array $rules_table_settings ): array { |
| 152 | // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
| 153 | return apply_filters( 'flexible-shipping/rules-table/settings', $rules_table_settings, $this->shipping_method_settings ); |
| 154 | } |
| 155 | |
| 156 | private function get_ai_local_message(): string { |
| 157 | $message = sprintf( |
| 158 | // Translators: 1: opening content tag, 2: closing content tag, 3: opening line break and strong tags, 4: closing strong tag, 5: opening list tag, 6: closing list tag, 7: opening list item tag, 8: closing list item tag, 9: opening strong tag, 10: closing strong tag. |
| 159 | __( |
| 160 | '%1$sThe AI Shipping Assistant is included with an active Flexible Shipping PRO subscription. Describe your shipping scenario in plain language, and it generates a ready-to-use rules table for you. |
| 161 | %3$sWith an active subscription, you get:%4$s |
| 162 | %5$s |
| 163 | %7$s%9$sShipping configuration%10$s in under 60 seconds thanks to AI%8$s |
| 164 | %7$s%9$sAutomatic plugin updates%10$s for as long as your subscription is active%8$s |
| 165 | %7$s%9$sHuman 1-on-1 support%10$s, whenever you need it%8$s |
| 166 | %6$s |
| 167 | %2$s', |
| 168 | 'flexible-shipping' |
| 169 | ), |
| 170 | '<span class="fspro-ai-subscription-content">', |
| 171 | '</span>', |
| 172 | '<br><br><strong>', |
| 173 | '</strong>', |
| 174 | '<ul class="fspro-ai-subscription-benefits">', |
| 175 | '</ul>', |
| 176 | '<li>', |
| 177 | '</li>', |
| 178 | '<strong>', |
| 179 | '</strong>' |
| 180 | ); |
| 181 | |
| 182 | return $message . sprintf( |
| 183 | '<span class="fspro-ai-subscription-footer"><button type="button" class="fspro-ai-maybe-later">%1$s</button><small>%2$s</small></span>', |
| 184 | esc_html__( 'Maybe later', 'flexible-shipping' ), |
| 185 | esc_html__( '30-day money-back guarantee · Cancel anytime', 'flexible-shipping' ) |
| 186 | ); |
| 187 | } |
| 188 | |
| 189 | private function get_ai_purchase_url(): string { |
| 190 | return get_user_locale() === 'pl_PL' ? self::AI_PURCHASE_URL_PL : self::AI_PURCHASE_URL; |
| 191 | } |
| 192 | |
| 193 | private function get_shop_settings() { |
| 194 | return [ |
| 195 | 'currency' => get_woocommerce_currency(), |
| 196 | 'currency_symbol' => get_woocommerce_currency_symbol(), |
| 197 | 'locale' => get_user_locale(), |
| 198 | 'weight_unit' => get_option( 'woocommerce_weight_unit' ), |
| 199 | 'dimension_unit' => get_option( 'woocommerce_dimension_unit' ), |
| 200 | 'price_num_decimals' => wc_get_price_decimals(), |
| 201 | ]; |
| 202 | } |
| 203 | |
| 204 | /** |
| 205 | * @return array |
| 206 | */ |
| 207 | private function get_pro_features_data(): array { |
| 208 | return [ |
| 209 | 'ajax_url' => admin_url( 'admin-ajax.php' ), |
| 210 | 'ajax_action' => ProFeatures\Tracker\AjaxTracker::AJAX_ACTION, |
| 211 | 'ajax_nonce' => wp_create_nonce( ProFeatures\Tracker\AjaxTracker::AJAX_ACTION ), |
| 212 | 'fs_pro_link' => 'pl_PL' === get_user_locale() |
| 213 | ? 'https://octol.io/fs-pro-features-pl' |
| 214 | : 'https://octol.io/fs-pro-features', |
| 215 | ]; |
| 216 | } |
| 217 | |
| 218 | /** |
| 219 | * @return array |
| 220 | */ |
| 221 | private function get_translations() { |
| 222 | return [ |
| 223 | 'assets_url' => self::$assets_url, |
| 224 | 'ajax_url_scenarios_tracking' => admin_url( 'admin-ajax.php?action=' . PreconfiguredScenarios\Tracker\AjaxTracker::AJAX_ACTION ), |
| 225 | 'scenarios_tracking_nonce' => wp_create_nonce( PreconfiguredScenarios\Tracker\AjaxTracker::AJAX_ACTION ), |
| 226 | 'scenarios_docs_link' => |
| 227 | 'pl_PL' === get_locale() |
| 228 | ? 'https://octol.io/fs-scenarios-pl' |
| 229 | : 'https://octol.io/fs-scenarios', |
| 230 | ]; |
| 231 | } |
| 232 | |
| 233 | /** |
| 234 | * @return array |
| 235 | */ |
| 236 | private function get_available_cost_settings() { |
| 237 | $rule_costs_fields_factory = new RuleCostFieldsFactory(); |
| 238 | |
| 239 | return $rule_costs_fields_factory->get_normalized_cost_fields(); |
| 240 | } |
| 241 | |
| 242 | /** |
| 243 | * @return array |
| 244 | */ |
| 245 | private function get_additional_cost_fields() { |
| 246 | $rule_additional_costs_fields_factory = new RuleAdditionalCostFieldsFactory( ( new RuleAdditionalCostFactory() )->get_additional_costs() ); |
| 247 | |
| 248 | return $rule_additional_costs_fields_factory->get_normalized_cost_fields(); |
| 249 | } |
| 250 | |
| 251 | /** |
| 252 | * @return array |
| 253 | */ |
| 254 | private function get_special_actions_fields() { |
| 255 | $special_actions_fields_factory = new SpecialActionFieldsFactory( ( new SpecialActionFactory() )->get_special_actions() ); |
| 256 | |
| 257 | return $special_actions_fields_factory->get_normalized_cost_fields(); |
| 258 | } |
| 259 | |
| 260 | /** |
| 261 | * @retrun array |
| 262 | */ |
| 263 | private function get_preconfigured_scenarios() { |
| 264 | return ( new PreconfiguredScenariosFactory() )->get_scenarios(); |
| 265 | } |
| 266 | |
| 267 | /** |
| 268 | * @return array |
| 269 | */ |
| 270 | private function get_table_settings() { |
| 271 | return ( new RulesTableSettings() )->get_table_settings(); |
| 272 | } |
| 273 | |
| 274 | /** |
| 275 | * @return Rule\Condition\Condition[] |
| 276 | */ |
| 277 | private function get_available_conditions() { |
| 278 | return ( new ConditionsFactory() )->get_conditions(); |
| 279 | } |
| 280 | |
| 281 | /** |
| 282 | * @param Rule\Condition\Condition[] $available_conditions . |
| 283 | * |
| 284 | * @return array |
| 285 | */ |
| 286 | private function get_normalized_settings( $available_conditions ) { |
| 287 | $rules_settings = RulesSettingsFactory::create_from_array( $this->get_field_value() ); |
| 288 | |
| 289 | return $this->process_select_options_for_conditions( $rules_settings->get_normalized_settings(), $available_conditions ); |
| 290 | } |
| 291 | |
| 292 | /** |
| 293 | * @return array |
| 294 | */ |
| 295 | private function get_field_value(): array { |
| 296 | $value = ! isset( $this->value ) ? ( $this->settings['default'] ?? [] ) : $this->value; |
| 297 | if ( ! is_array( $value ) ) { |
| 298 | $value = []; |
| 299 | } |
| 300 | return $value; |
| 301 | } |
| 302 | |
| 303 | /** |
| 304 | * @param array $settings . |
| 305 | * @param Rule\Condition\Condition[] $available_conditions . |
| 306 | * |
| 307 | * @return array |
| 308 | */ |
| 309 | private function process_select_options_for_conditions( array $settings, $available_conditions ) { |
| 310 | foreach ( $settings as $rule_key => $rule ) { |
| 311 | $conditions = isset( $rule['conditions'] ) && is_array( $rule['conditions'] ) ? $rule['conditions'] : []; |
| 312 | foreach ( $conditions as $condition_key => $condition ) { |
| 313 | if ( isset( $available_conditions[ $condition['condition_id'] ] ) ) { |
| 314 | $settings[ $rule_key ]['conditions'][ $condition_key ] = $available_conditions[ $condition['condition_id'] ]->prepare_settings( $condition ); |
| 315 | } |
| 316 | } |
| 317 | $settings[ $rule_key ]['conditions'] = array_values( $settings[ $rule_key ]['conditions'] ); |
| 318 | } |
| 319 | |
| 320 | return $settings; |
| 321 | } |
| 322 | } |
| 323 |