lightspeeddevelopment /
lsx-currencies
| Total Complexity | 54 |
| Total Lines | 556 |
| Duplicated Lines | 0 % |
| Changes | 3 | ||
| Bugs | 0 | Features | 0 |
Complex classes like Currencies often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Currencies, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 17 | class Currencies { |
||
| 18 | |||
| 19 | /** |
||
| 20 | * Holds instance of the class |
||
| 21 | * |
||
| 22 | * @var object \lsx\currencies\classes\Currencies() |
||
| 23 | */ |
||
| 24 | private static $instance; |
||
| 25 | |||
| 26 | /** |
||
| 27 | * Holds the admin instance |
||
| 28 | * |
||
| 29 | * @var object \lsx\currencies\classes\Admin() |
||
| 30 | */ |
||
| 31 | public $admin; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Holds the frontend instance |
||
| 35 | * |
||
| 36 | * @var object \lsx\currencies\classes\Frontedn() |
||
| 37 | */ |
||
| 38 | public $frontend; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * Holds the woocommerce instance |
||
| 42 | * |
||
| 43 | * @var object \lsx\currencies\classes\WooCommerce() |
||
| 44 | */ |
||
| 45 | public $woocommerce; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * Holds the FacetWP instance |
||
| 49 | * |
||
| 50 | * @var object \lsx\currencies\classes\FacetWP() |
||
| 51 | */ |
||
| 52 | public $facetwp; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * This hold the URL, it defaults to the free exchange rates. |
||
| 56 | * |
||
| 57 | * @var string |
||
| 58 | */ |
||
| 59 | public $api_url = 'https://api.exchangeratesapi.io/latest?base=USD'; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * General Parameters |
||
| 63 | */ |
||
| 64 | /** @var string */ |
||
|
Coding Style
introduced
by
|
|||
| 65 | public $plugin_slug = 'lsx-currencies'; |
||
| 66 | |||
| 67 | /** @var array */ |
||
| 68 | public $options = false; |
||
| 69 | |||
| 70 | /** @var string */ |
||
| 71 | public $base_currency = 'USD'; |
||
| 72 | |||
| 73 | /** @var array */ |
||
| 74 | public $additional_currencies = array(); |
||
| 75 | |||
| 76 | /** @var array */ |
||
| 77 | public $available_currencies = array(); |
||
| 78 | |||
| 79 | /** @var array */ |
||
| 80 | public $flag_relations = array(); |
||
| 81 | |||
| 82 | /** @var array */ |
||
| 83 | public $currency_symbols = array(); |
||
| 84 | |||
| 85 | /** @var boolean */ |
||
| 86 | public $multi_prices = false; |
||
| 87 | |||
| 88 | /** @var boolean */ |
||
| 89 | public $convert_to_single = false; |
||
| 90 | |||
| 91 | /** @var boolean */ |
||
| 92 | public $app_id = false; |
||
| 93 | |||
| 94 | /* Currency Switcher Options */ |
||
| 95 | /** @var array */ |
||
| 96 | public $menus = false; |
||
| 97 | |||
| 98 | /** @var boolean */ |
||
| 99 | public $display_flags = false; |
||
| 100 | |||
| 101 | /** @var string */ |
||
| 102 | public $flag_position = 'left'; |
||
| 103 | |||
| 104 | /** @var string */ |
||
| 105 | public $switcher_symbol_position = 'right'; |
||
| 106 | |||
| 107 | /** @var boolean */ |
||
| 108 | public $remove_decimals = false; |
||
| 109 | |||
| 110 | /** |
||
| 111 | * Constructor |
||
| 112 | */ |
||
| 113 | public function __construct() { |
||
| 116 | } |
||
| 117 | |||
| 118 | /** |
||
| 119 | * Return an instance of this class. |
||
| 120 | * |
||
| 121 | * @return object |
||
| 122 | */ |
||
| 123 | public static function init() { |
||
| 124 | // If the single instance hasn't been set, set it now. |
||
| 125 | if ( ! isset( self::$instance ) ) { |
||
| 126 | self::$instance = new self(); |
||
| 127 | } |
||
| 128 | return self::$instance; |
||
| 129 | } |
||
| 130 | |||
| 131 | /** |
||
| 132 | * After active plugins and pluggable functions are loaded |
||
| 133 | */ |
||
| 134 | public function plugins_loaded() { |
||
| 135 | require_once LSX_CURRENCIES_PATH . 'classes/class-admin.php'; |
||
| 136 | $this->admin = \lsx\currencies\classes\Admin::init(); |
||
| 137 | |||
| 138 | require_once LSX_CURRENCIES_PATH . 'classes/class-frontend.php'; |
||
| 139 | $this->frontend = \lsx\currencies\classes\Frontend::init(); |
||
| 140 | |||
| 141 | if ( class_exists( 'WooCommerce' ) ) { |
||
| 142 | require_once LSX_CURRENCIES_PATH . 'classes/class-woocommerce.php'; |
||
| 143 | $this->woocommerce = \lsx\currencies\classes\WooCommerce::init(); |
||
| 144 | } |
||
| 145 | |||
| 146 | if ( class_exists( 'FacetWP' ) ) { |
||
| 147 | require_once LSX_CURRENCIES_PATH . 'classes/class-facetwp.php'; |
||
| 148 | $this->facetwp = \lsx\currencies\classes\FacetWP::init(); |
||
| 149 | } |
||
| 150 | |||
| 151 | require_once LSX_CURRENCIES_PATH . '/includes/template-tags.php'; |
||
| 152 | } |
||
| 153 | |||
| 154 | /** |
||
| 155 | * Get the options |
||
| 156 | */ |
||
| 157 | public function set_defaults() { |
||
| 158 | $settings_tab = 'display'; |
||
| 159 | if ( function_exists( 'tour_operator' ) ) { |
||
| 160 | $options = get_option( '_lsx-to_settings', false ); |
||
| 161 | $settings_tab = 'general'; |
||
| 162 | } else { |
||
| 163 | $options = get_option( '_lsx_settings', false ); |
||
| 164 | |||
| 165 | if ( false === $options ) { |
||
| 166 | $options = get_option( '_lsx_lsx-settings', false ); |
||
| 167 | } |
||
| 168 | } |
||
| 169 | |||
| 170 | if ( false !== $options ) { |
||
| 171 | $this->options = $options; |
||
| 172 | $this->migration_uix_to_customize(); |
||
| 173 | |||
| 174 | if ( isset( $this->options[ $settings_tab ] ) && isset( $this->options[ $settings_tab ]['currency'] ) ) { |
||
| 175 | $this->base_currency = apply_filters( 'lsx_currencies_base_currency', $this->options[ $settings_tab ]['currency'], $this ); |
||
| 176 | } |
||
| 177 | |||
| 178 | if ( isset( $this->options[ $settings_tab ]['additional_currencies'] ) && is_array( $this->options[ $settings_tab ]['additional_currencies'] ) && ! empty( $this->options[ $settings_tab ]['additional_currencies'] ) ) { |
||
| 179 | $this->additional_currencies = $this->options[ $settings_tab ]['additional_currencies']; |
||
| 180 | } |
||
| 181 | |||
| 182 | if ( isset( $this->options[ $settings_tab ]['multi_price'] ) && 'on' === $this->options[ $settings_tab ]['multi_price'] ) { |
||
| 183 | $this->multi_prices = true; |
||
| 184 | } |
||
| 185 | |||
| 186 | if ( isset( $this->options[ $settings_tab ]['convert_to_single_currency'] ) && 'on' === $this->options[ $settings_tab ]['convert_to_single_currency'] ) { |
||
| 187 | $this->convert_to_single = true; |
||
| 188 | } |
||
| 189 | |||
| 190 | if ( isset( $this->options[ $settings_tab ]['remove_decimals'] ) && 'on' === $this->options[ $settings_tab ]['remove_decimals'] ) { |
||
| 191 | $this->remove_decimals = true; |
||
| 192 | } |
||
| 193 | |||
| 194 | if ( isset( $this->options['api']['openexchange_api'] ) && '' !== $this->options['api']['openexchange_api'] ) { |
||
| 195 | $this->app_id = $this->options['api']['openexchange_api']; |
||
| 196 | $this->api_url = 'https://openexchangerates.org/api/latest.json?app_id=' . $this->app_id; |
||
| 197 | } |
||
| 198 | |||
| 199 | // Currency Switcher Options. |
||
| 200 | $this->menus = get_theme_mod( 'lsx_currencies_currency_menu_position', false ); |
||
| 201 | |||
| 202 | if ( get_theme_mod( 'lsx_currencies_display_flags', false ) ) { |
||
| 203 | $this->display_flags = true; |
||
| 204 | } |
||
| 205 | |||
| 206 | if ( get_theme_mod( 'lsx_currencies_flag_position', false ) ) { |
||
| 207 | $this->flag_position = 'right'; |
||
| 208 | } |
||
| 209 | |||
| 210 | if ( get_theme_mod( 'lsx_currencies_currency_switcher_position', false ) ) { |
||
| 211 | $this->switcher_symbol_position = 'left'; |
||
| 212 | } |
||
| 213 | } |
||
| 214 | $this->available_currencies = $this->get_available_currencies(); |
||
| 215 | $this->flag_relations = $this->get_flag_relations(); |
||
| 216 | $this->currency_symbols = $this->get_currency_symbols(); |
||
| 217 | } |
||
| 218 | |||
| 219 | /** |
||
| 220 | * Returns Currency Flag for currency code provided |
||
| 221 | * |
||
| 222 | * @param $key string |
||
| 223 | * @return string |
||
| 224 | */ |
||
| 225 | public function get_currency_flag( $key = 'USD' ) { |
||
| 228 | } |
||
| 229 | |||
| 230 | /** |
||
| 231 | * Get Currency symbol. |
||
| 232 | * |
||
| 233 | * @param string $currency |
||
| 234 | * @return string |
||
| 235 | */ |
||
| 236 | public function get_currency_symbol( $currency = '' ) { |
||
| 237 | if ( ! $currency ) { |
||
| 238 | $currency = $this->base_currency; |
||
| 239 | } |
||
| 240 | $currency_symbol = isset( $this->currency_symbols[ $currency ] ) ? $this->currency_symbols[ $currency ] : ''; |
||
| 241 | return $currency_symbol; |
||
| 242 | } |
||
| 243 | |||
| 244 | /** |
||
| 245 | * Returns an array of the available currencies |
||
| 246 | * |
||
| 247 | * @return array |
||
| 248 | */ |
||
| 249 | public function get_available_currencies() { |
||
| 250 | |||
| 251 | $paid_currencies = array( |
||
| 252 | 'BWP' => esc_html__( 'Botswana Pula', 'lsx-currencies' ), |
||
| 253 | 'KES' => esc_html__( 'Kenyan Shilling', 'lsx-currencies' ), |
||
| 254 | 'LAK' => esc_html__( 'Laos Kip', 'lsx-currencies' ), |
||
| 255 | 'MWK' => esc_html__( 'Malawian Kwacha', 'lsx-currencies' ), |
||
| 256 | 'MZN' => esc_html__( 'Mozambique Metical', 'lsx-currencies' ), |
||
| 257 | 'NAD' => esc_html__( 'Namibian Dollar', 'lsx-currencies' ), |
||
| 258 | 'TZS' => esc_html__( 'Tanzania Shilling', 'lsx-currencies' ), |
||
| 259 | 'AED' => esc_html__( 'United Arab Emirates Dirham', 'lsx-currencies' ), |
||
| 260 | 'ZMW' => esc_html__( 'Zambian Kwacha', 'lsx-currencies' ), |
||
| 261 | 'ZWL' => esc_html__( 'Zimbabwean Dollar', 'lsx-currencies' ), |
||
| 262 | ); |
||
| 263 | $free_currencies = array( |
||
| 264 | 'AUD' => esc_html__( 'Australian Dollar', 'lsx-currencies' ), |
||
| 265 | 'BRL' => esc_html__( 'Brazilian Real', 'lsx-currencies' ), |
||
| 266 | 'GBP' => esc_html__( 'British Pound Sterling', 'lsx-currencies' ), |
||
| 267 | 'CAD' => esc_html__( 'Canadian Dollar', 'lsx-currencies' ), |
||
| 268 | 'CNY' => esc_html__( 'Chinese Yuan', 'lsx-currencies' ), |
||
| 269 | 'EUR' => esc_html__( 'Euro', 'lsx-currencies' ), |
||
| 270 | 'HKD' => esc_html__( 'Hong Kong Dollar', 'lsx-currencies' ), |
||
| 271 | 'INR' => esc_html__( 'Indian Rupee', 'lsx-currencies' ), |
||
| 272 | 'IDR' => esc_html__( 'Indonesia Rupiah', 'lsx-currencies' ), |
||
| 273 | 'ILS' => esc_html__( 'Israeli Shekel', 'lsx-currencies' ), |
||
| 274 | 'JPY' => esc_html__( 'Japanese Yen', 'lsx-currencies' ), |
||
| 275 | 'MYR' => esc_html__( 'Malaysia Ringgit', 'lsx-currencies' ), |
||
| 276 | 'NOK' => esc_html__( 'Norwegian Krone', 'lsx-currencies' ), |
||
| 277 | 'NZD' => esc_html__( 'New Zealand Dollar', 'lsx-currencies' ), |
||
| 278 | 'RUB' => esc_html__( 'Russian Ruble', 'lsx-currencies' ), |
||
| 279 | 'SGD' => esc_html__( 'Singapore Dollar', 'lsx-currencies' ), |
||
| 280 | 'ZAR' => esc_html__( 'South African Rand', 'lsx-currencies' ), |
||
| 281 | 'SEK' => esc_html__( 'Swedish Krona', 'lsx-currencies' ), |
||
| 282 | 'CHF' => esc_html__( 'Swiss Franc', 'lsx-currencies' ), |
||
| 283 | 'USD' => esc_html__( 'United States Dollar', 'lsx-currencies' ), |
||
| 284 | ); |
||
| 285 | |||
| 286 | if ( false !== $this->app_id ) { |
||
| 287 | $free_currencies = array_merge( $free_currencies, $paid_currencies ); |
||
| 288 | asort( $free_currencies ); |
||
| 289 | } |
||
| 290 | |||
| 291 | return $free_currencies; |
||
| 292 | } |
||
| 293 | |||
| 294 | /** |
||
| 295 | * Returns the ISO 3 code in relation to its 2 code values. |
||
| 296 | * |
||
| 297 | * @return array |
||
| 298 | */ |
||
| 299 | public function get_flag_relations() { |
||
| 300 | return array( |
||
| 301 | 'AUD' => 'au', |
||
| 302 | 'BRL' => 'br', |
||
| 303 | 'GBP' => 'gb', |
||
| 304 | 'BWP' => 'bw', |
||
| 305 | 'CAD' => 'ca', |
||
| 306 | 'CNY' => 'cn', |
||
| 307 | 'EUR' => 'eu', |
||
| 308 | 'HKD' => 'hk', |
||
| 309 | 'INR' => 'in', |
||
| 310 | 'IDR' => 'id', |
||
| 311 | 'ILS' => 'il', |
||
| 312 | 'JPY' => 'jp', |
||
| 313 | 'KES' => 'ke', |
||
| 314 | 'LAK' => 'la', |
||
| 315 | 'MWK' => 'mw', |
||
| 316 | 'MYR' => 'my', |
||
| 317 | 'MZN' => 'mz', |
||
| 318 | 'NAD' => 'na', |
||
| 319 | 'NZD' => 'nz', |
||
| 320 | 'NOK' => 'no', |
||
| 321 | 'RUB' => 'ru', |
||
| 322 | 'SGD' => 'sg', |
||
| 323 | 'ZAR' => 'za', |
||
| 324 | 'SEK' => 'se', |
||
| 325 | 'CHF' => 'ch', |
||
| 326 | 'TZS' => 'tz', |
||
| 327 | 'USD' => 'us', |
||
| 328 | 'AED' => 'ae', |
||
| 329 | 'ZMW' => 'zm', |
||
| 330 | 'ZWL' => 'zw', |
||
| 331 | ); |
||
| 332 | } |
||
| 333 | |||
| 334 | /** |
||
| 335 | * Returns all of the currency symbols. |
||
| 336 | * |
||
| 337 | * @return array |
||
| 338 | */ |
||
| 339 | public function get_currency_symbols() { |
||
| 503 | ) ); |
||
| 504 | } |
||
| 505 | |||
| 506 | /** |
||
| 507 | * Sanitize checkbox. |
||
| 508 | * |
||
| 509 | * @param $input html |
||
| 510 | * @return mixed |
||
| 511 | */ |
||
| 512 | public function sanitize_checkbox( $input ) { |
||
| 514 | } |
||
| 515 | |||
| 516 | /** |
||
| 517 | * Sanitize select. |
||
| 518 | * |
||
| 519 | * @param $input html |
||
| 520 | * @return mixed |
||
| 521 | */ |
||
| 522 | public function sanitize_select( $input ) { |
||
| 523 | if ( is_string( $input ) || is_integer( $input ) || is_bool( $input ) ) { |
||
| 524 | return $input; |
||
| 525 | } else { |
||
| 526 | return ''; |
||
| 527 | } |
||
| 528 | } |
||
| 529 | |||
| 530 | /** |
||
| 531 | * Sanitize textarea. |
||
| 532 | * |
||
| 533 | * @param $input html |
||
| 534 | * @return mixed |
||
| 535 | */ |
||
| 536 | public function sanitize_textarea( $input ) { |
||
| 537 | return wp_kses_post( $input ); |
||
| 538 | } |
||
| 539 | |||
| 540 | /** |
||
| 541 | * Migrate the old data (from UIX) to WP Customizer settings. |
||
| 542 | * |
||
| 543 | * @since 1.1.1 |
||
| 544 | */ |
||
| 545 | public function migration_uix_to_customize() { |
||
| 573 | } |
||
| 574 | } |
||
| 575 | } |
||
| 576 |
Loading history...