JSON.php
188 lines
| 1 | <?php |
| 2 | /** |
| 3 | * JSON Exporter. |
| 4 | * |
| 5 | * @package WPDesk\FS\TableRate\Exporter |
| 6 | */ |
| 7 | |
| 8 | namespace WPDesk\FS\TableRate\ImporterExporter\Exporter; |
| 9 | |
| 10 | use WPDesk\FS\TableRate\ImporterExporter\ShippingClassTrait; |
| 11 | use WPDesk\FS\TableRate\ShippingMethod\CommonMethodSettings; |
| 12 | use WPDesk_Flexible_Shipping; |
| 13 | |
| 14 | /** |
| 15 | * Class JSON |
| 16 | */ |
| 17 | class JSON { |
| 18 | use ShippingClassTrait; |
| 19 | |
| 20 | /** |
| 21 | * @var string |
| 22 | */ |
| 23 | private $instance_id; |
| 24 | |
| 25 | /** |
| 26 | * @var int[] |
| 27 | */ |
| 28 | private $methods; |
| 29 | |
| 30 | /** |
| 31 | * JSON constructor. |
| 32 | * |
| 33 | * @param string $instance_id Instance ID. |
| 34 | * @param int[] $methods Method IDs. |
| 35 | */ |
| 36 | public function __construct( $instance_id, $methods ) { |
| 37 | $this->instance_id = $instance_id; |
| 38 | $this->methods = $methods; |
| 39 | |
| 40 | $this->init_shipping_class(); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * @return array |
| 45 | */ |
| 46 | public function get_exported_data() { |
| 47 | $all_shipping_methods = flexible_shipping_get_all_shipping_methods(); |
| 48 | |
| 49 | /** @var WPDesk_Flexible_Shipping $flexible_shipping */ |
| 50 | $flexible_shipping = $all_shipping_methods['flexible_shipping']; |
| 51 | $flexible_shipping_rates = $flexible_shipping->get_all_rates(); |
| 52 | |
| 53 | $this->filter_by_instance_id( $flexible_shipping_rates, $this->instance_id ); |
| 54 | $this->filter_by_methods( $flexible_shipping_rates, $this->methods ); |
| 55 | |
| 56 | $flexible_shipping_rates = $this->get_prepared_shipping_rates( $flexible_shipping_rates ); |
| 57 | |
| 58 | /** |
| 59 | * Filters whether shipping rates for export. |
| 60 | * |
| 61 | * @param array $flexible_shipping_rates . |
| 62 | * @param string $instance_id . |
| 63 | * @param array $methods . |
| 64 | * @param JSON $exporter . |
| 65 | * |
| 66 | * @since 3.17.0 |
| 67 | */ |
| 68 | $flexible_shipping_rates = apply_filters( 'flexible-shipping/exporter/data', $flexible_shipping_rates, $this->instance_id, $this->methods, $this ); |
| 69 | |
| 70 | return array_values( $flexible_shipping_rates ); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Preparing fields to export. |
| 75 | * |
| 76 | * @param array $flexible_shipping_rates . |
| 77 | * |
| 78 | * @return array |
| 79 | */ |
| 80 | private function get_prepared_shipping_rates( $flexible_shipping_rates ) { |
| 81 | $allowed_fields = array( |
| 82 | 'id', |
| 83 | 'method_title', |
| 84 | 'method_description', |
| 85 | CommonMethodSettings::METHOD_LOGO_ID, |
| 86 | 'method_free_shipping_requires', |
| 87 | 'method_free_shipping', |
| 88 | 'method_free_shipping_ignore_discounts', |
| 89 | 'method_free_shipping_cart_notice', |
| 90 | 'method_max_cost', |
| 91 | 'method_calculation_method', |
| 92 | 'cart_calculation', |
| 93 | 'method_visibility', |
| 94 | 'method_default', |
| 95 | 'method_debug_mode', |
| 96 | 'method_integration', |
| 97 | 'method_rules', |
| 98 | ); |
| 99 | |
| 100 | /** |
| 101 | * Filters whether allowed fields for export. |
| 102 | * |
| 103 | * @param array $allowed_fields . |
| 104 | * |
| 105 | * @since 3.17.0 |
| 106 | */ |
| 107 | $allowed_fields = apply_filters( 'flexible-shipping/exporter/allowed_fields', $allowed_fields ); |
| 108 | |
| 109 | foreach ( $flexible_shipping_rates as $id => $flexible_shipping_rate ) { |
| 110 | $row = array(); |
| 111 | |
| 112 | foreach ( $allowed_fields as $field ) { |
| 113 | $row[ $field ] = isset( $flexible_shipping_rate[ $field ] ) ? $flexible_shipping_rate[ $field ] : ''; |
| 114 | } |
| 115 | |
| 116 | if ( isset( $flexible_shipping_rate['method_free_shipping_label'] ) ) { |
| 117 | $row['method_free_shipping_label'] = $flexible_shipping_rate['method_free_shipping_label']; |
| 118 | } |
| 119 | |
| 120 | /** |
| 121 | * Filters whether fields for export. |
| 122 | * |
| 123 | * @param array $row . |
| 124 | * @param array $flexible_shipping_rate . |
| 125 | * @param string $id . |
| 126 | * |
| 127 | * @since 3.17.0 |
| 128 | */ |
| 129 | $row = apply_filters( 'flexible-shipping/exporter/rate/data', $row, $flexible_shipping_rate, $id ); |
| 130 | |
| 131 | $flexible_shipping_rates[ $id ] = $row; |
| 132 | } |
| 133 | |
| 134 | return $flexible_shipping_rates; |
| 135 | } |
| 136 | |
| 137 | /** |
| 138 | * @param array $flexible_shipping_rates Shipping Rates. |
| 139 | * @param string $instance_id Instance ID. |
| 140 | */ |
| 141 | private function filter_by_instance_id( &$flexible_shipping_rates, $instance_id ) { |
| 142 | $flexible_shipping_rates = array_filter( |
| 143 | $flexible_shipping_rates, |
| 144 | function ( $shipping_rate ) use ( $instance_id ) { |
| 145 | return isset( $shipping_rate['instance_id'] ) && (int) $shipping_rate['instance_id'] === (int) $instance_id; |
| 146 | } |
| 147 | ); |
| 148 | } |
| 149 | |
| 150 | /** |
| 151 | * @param array $flexible_shipping_rates Shipping Rates. |
| 152 | * @param int[] $methods Method IDs. |
| 153 | */ |
| 154 | private function filter_by_methods( &$flexible_shipping_rates, $methods ) { |
| 155 | $flexible_shipping_rates = array_filter( |
| 156 | $flexible_shipping_rates, |
| 157 | function ( $shipping_rate ) use ( $methods ) { |
| 158 | return in_array( (int) $shipping_rate['id'], wp_parse_id_list( $methods ), true ); |
| 159 | } |
| 160 | ); |
| 161 | } |
| 162 | |
| 163 | /** |
| 164 | * @param string $filename Name of exported file. |
| 165 | * @param array $data Data to export. |
| 166 | */ |
| 167 | public function download_file( $filename, $data ) { |
| 168 | header( 'Content-Type: application/json; charset=utf-8' ); |
| 169 | header( 'Content-Disposition: attachment; filename=' . sanitize_file_name( $filename ) ); |
| 170 | |
| 171 | echo wp_json_encode( $data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE ); |
| 172 | die(); |
| 173 | } |
| 174 | |
| 175 | /** |
| 176 | * @param array $data . |
| 177 | * |
| 178 | * @return string |
| 179 | */ |
| 180 | public function get_filename( $data ) { |
| 181 | $host = wp_parse_url( site_url(), PHP_URL_HOST ); |
| 182 | |
| 183 | $filename = 'fs_' . $host . '_fs-' . $this->instance_id . '-' . join( '_', wp_list_pluck( $data, 'id' ) ); |
| 184 | |
| 185 | return sanitize_file_name( $filename . '.json' ); |
| 186 | } |
| 187 | } |
| 188 |