BlockEditing
1 day ago
Convert
1 day ago
Duplicate
1 day ago
Management
1 day ago
Timestamps
1 day ago
Tracker
1 day ago
views
1 day ago
CommonMethodSettings.php
1 day ago
FreeShippingCalculator.php
1 day ago
FreeShippingThresholdRuleValidator.php
1 day ago
MethodDescription.php
1 day ago
MethodLogo.php
1 day ago
MethodLogoCheckoutBlocksAssets.php
1 day ago
MethodLogoSettingsField.php
1 day ago
MethodSettings.php
1 day ago
MethodTitle.php
1 day ago
RateCalculator.php
1 day ago
RateCalculatorFactory.php
1 day ago
SettingsDisplayPreparer.php
1 day ago
SettingsProcessor.php
1 day ago
SingleMethodSettings.php
1 day ago
MethodDescription.php
211 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Class MethodDescription |
| 4 | * |
| 5 | * @package WPDesk\FS\TableRate\ShippingMethod |
| 6 | */ |
| 7 | |
| 8 | namespace WPDesk\FS\TableRate\ShippingMethod; |
| 9 | |
| 10 | use FSVendor\WPDesk\PluginBuilder\Plugin\Hookable; |
| 11 | use FSVendor\WPDesk\View\Renderer\Renderer; |
| 12 | use WC_Shipping_Rate; |
| 13 | use WC_Shipping_Zones; |
| 14 | use WPDesk\FS\TableRate\ShippingMethodSingle; |
| 15 | use WPDesk_Flexible_Shipping; |
| 16 | |
| 17 | /** |
| 18 | * Can display method description. |
| 19 | */ |
| 20 | class MethodDescription implements Hookable { |
| 21 | |
| 22 | /** |
| 23 | * Renderer. |
| 24 | * |
| 25 | * @var Renderer; |
| 26 | */ |
| 27 | private $renderer; |
| 28 | |
| 29 | /** |
| 30 | * MethodDescription constructor. |
| 31 | * |
| 32 | * @param Renderer $renderer . |
| 33 | */ |
| 34 | public function __construct( Renderer $renderer ) { |
| 35 | $this->renderer = $renderer; |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * Hooks. |
| 40 | */ |
| 41 | public function hooks() { |
| 42 | add_action( 'woocommerce_after_shipping_rate', [ $this, 'display_description_if_present' ], 10, 2 ); |
| 43 | add_filter( 'woocommerce_package_rates', [ $this, 'add_description_to_rate_if_present' ] ); |
| 44 | } |
| 45 | |
| 46 | /** |
| 47 | * @param WC_Shipping_Rate[] $rates . |
| 48 | * |
| 49 | * @return WC_Shipping_Rate[] |
| 50 | */ |
| 51 | public function add_description_to_rate_if_present( $rates ) { |
| 52 | if ( $this->is_store_api_request() ) { |
| 53 | return $rates; |
| 54 | } |
| 55 | |
| 56 | foreach ( $rates as $rate ) { |
| 57 | if ( ! $rate instanceof WC_Shipping_Rate || ! $this->should_display_method_description( $rate ) ) { |
| 58 | continue; |
| 59 | } |
| 60 | |
| 61 | if ( ! $this->supports_native_rate_description( $rate ) ) { |
| 62 | continue; |
| 63 | } |
| 64 | |
| 65 | if ( '' !== $rate->get_description() ) { |
| 66 | continue; |
| 67 | } |
| 68 | |
| 69 | $description = $this->get_method_description_from_meta_data( $rate ); |
| 70 | |
| 71 | if ( '' === $description ) { |
| 72 | continue; |
| 73 | } |
| 74 | |
| 75 | $rate->set_description( $this->sanitize_method_description_for_rate( $description ) ); |
| 76 | } |
| 77 | |
| 78 | return $rates; |
| 79 | } |
| 80 | |
| 81 | /** |
| 82 | * @param WC_Shipping_Rate $method . |
| 83 | * @param int $index . |
| 84 | */ |
| 85 | public function display_description_if_present( $method, $index ) { |
| 86 | if ( ! $method instanceof WC_Shipping_Rate || ! $this->should_display_method_description( $method ) ) { |
| 87 | return; |
| 88 | } |
| 89 | |
| 90 | $description = $this->get_method_description( $method ); |
| 91 | $method_logo_data = $this->get_method_logo_data( $method ); |
| 92 | |
| 93 | if ( '' !== $description || '' !== $method_logo_data['url'] ) { |
| 94 | // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped |
| 95 | echo $this->renderer->render( |
| 96 | 'cart/flexible-shipping/after-shipping-rate', |
| 97 | [ |
| 98 | 'method_description' => $description, |
| 99 | 'method_logo_url' => $method_logo_data['url'], |
| 100 | 'method_logo_alt' => $method_logo_data['alt'], |
| 101 | ] |
| 102 | ); // WPCS: XSS OK. |
| 103 | // phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped |
| 104 | } |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * @param WC_Shipping_Rate $method . |
| 109 | * |
| 110 | * @return string |
| 111 | */ |
| 112 | private function get_method_description( $method ) { |
| 113 | $description = $this->get_method_description_from_meta_data( $method ); |
| 114 | |
| 115 | if ( '' !== $description ) { |
| 116 | return $description; |
| 117 | } |
| 118 | |
| 119 | if ( ! method_exists( $method, 'get_description' ) ) { |
| 120 | return ''; |
| 121 | } |
| 122 | |
| 123 | return $method->get_description(); |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * @param WC_Shipping_Rate $method . |
| 128 | * |
| 129 | * @return string |
| 130 | */ |
| 131 | private function get_method_description_from_meta_data( $method ) { |
| 132 | $meta_data = $method->get_meta_data(); |
| 133 | |
| 134 | if ( isset( $meta_data[ RateCalculator::DESCRIPTION_BASE64ENCODED ] ) && ! empty( $meta_data[ RateCalculator::DESCRIPTION_BASE64ENCODED ] ) ) { |
| 135 | // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode |
| 136 | $description = base64_decode( $meta_data[ RateCalculator::DESCRIPTION_BASE64ENCODED ] ); |
| 137 | |
| 138 | if ( $description ) { |
| 139 | return wp_kses_post( $description ); |
| 140 | } |
| 141 | } |
| 142 | |
| 143 | if ( isset( $meta_data[ RateCalculator::DESCRIPTION ] ) ) { |
| 144 | return wp_kses_post( $meta_data[ RateCalculator::DESCRIPTION ] ); |
| 145 | } |
| 146 | |
| 147 | return ''; |
| 148 | } |
| 149 | |
| 150 | /** |
| 151 | * @param WC_Shipping_Rate $method . |
| 152 | * |
| 153 | * @return array{url:string,alt:string} |
| 154 | */ |
| 155 | private function get_method_logo_data( $method ) { |
| 156 | $meta_data = $method->get_meta_data(); |
| 157 | |
| 158 | return [ |
| 159 | 'url' => (string) ( $meta_data[ RateCalculator::METHOD_LOGO_URL ] ?? '' ), |
| 160 | 'alt' => (string) ( $meta_data[ RateCalculator::METHOD_LOGO_ALT ] ?? '' ), |
| 161 | ]; |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * @param string $description . |
| 166 | * |
| 167 | * @return string |
| 168 | */ |
| 169 | private function sanitize_method_description_for_rate( $description ) { |
| 170 | return trim( wp_strip_all_tags( html_entity_decode( $description, ENT_QUOTES, 'UTF-8' ) ) ); |
| 171 | } |
| 172 | |
| 173 | /** |
| 174 | * @param object $rate . |
| 175 | * |
| 176 | * @return bool |
| 177 | */ |
| 178 | private function supports_native_rate_description( $rate ) { |
| 179 | return method_exists( $rate, 'get_description' ) && method_exists( $rate, 'set_description' ); |
| 180 | } |
| 181 | |
| 182 | /** |
| 183 | * @return bool |
| 184 | */ |
| 185 | private function is_store_api_request() { |
| 186 | if ( ! defined( 'REST_REQUEST' ) || REST_REQUEST !== true ) { |
| 187 | return false; |
| 188 | } |
| 189 | |
| 190 | $request_uri = sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ?? '' ) ); |
| 191 | |
| 192 | return false !== strpos( $request_uri, '/wc/store/' ); |
| 193 | } |
| 194 | |
| 195 | /** |
| 196 | * @param WC_Shipping_Rate $method . |
| 197 | * |
| 198 | * @return bool |
| 199 | */ |
| 200 | private function should_display_method_description( $method ) { |
| 201 | return in_array( |
| 202 | $method->get_method_id(), |
| 203 | [ |
| 204 | WPDesk_Flexible_Shipping::METHOD_ID, |
| 205 | ShippingMethodSingle::SHIPPING_METHOD_ID, |
| 206 | ], |
| 207 | true |
| 208 | ); |
| 209 | } |
| 210 | } |
| 211 |