lightspeeddevelopment / lsx-currencies

classes/class-currencies.php

<?php
/**
 * LSX Currency Main Class
 *
 * @package   LSX Currencies
 * @author    LightSpeed
 * @license   GPL3
 * @link
 * @copyright 2019 LightSpeed
 */

namespace lsx\currencies\classes;

/**
 * The main class
 */
class Currencies {

	/**
	 * Holds instance of the class
	 *
	 * @var object \lsx\currencies\classes\Currencies()
	 */
	private static $instance;

	/**
	 * Holds the admin instance
	 *
	 * @var object \lsx\currencies\classes\Admin()
	 */
	public $admin;

	/**
	 * Holds the frontend instance
	 *
	 * @var object \lsx\currencies\classes\Frontedn()
	 */
	public $frontend;

	/**
	 * Holds the woocommerce instance
	 *
	 * @var object \lsx\currencies\classes\WooCommerce()
	 */
	public $woocommerce;

	/**
	 * Holds the FacetWP instance
	 *
	 * @var object \lsx\currencies\classes\FacetWP()
	 */
	public $facetwp;

	/**
	 * This hold the URL, it defaults to the free exchange rates.
	 *
	 * @var string
	 */
	public $api_url = 'https://api.exchangeratesapi.io/latest?base=USD';

	/**
	 * General Parameters
	 */
	/** @var string */
	public $plugin_slug = 'lsx-currencies';

	/** @var array */
	public $options = false;

	/** @var string */
	public $base_currency = 'USD';

	/** @var array */
	public $additional_currencies = array();

	/** @var array */
	public $available_currencies = array();

	/** @var array */
	public $flag_relations = array();

	/** @var array */
	public $currency_symbols = array();

	/** @var boolean */
	public $multi_prices = false;

	/** @var boolean */
	public $convert_to_single = false;

	/** @var boolean */
	public $app_id = false;

	/*  Currency Switcher Options */
	/** @var array */
	public $menus = false;

	/** @var boolean */
	public $display_flags = false;

	/** @var string */
	public $flag_position = 'left';

	/** @var string */
	public $switcher_symbol_position = 'right';

	/** @var boolean */
	public $remove_decimals = false;

	/**
	 * Constructor
	 */
	public function __construct() {
		add_action( 'plugins_loaded', array( $this, 'plugins_loaded' ) );
		add_action( 'plugins_loaded', array( $this, 'set_defaults' ) );
	}

	/**
	 * Return an instance of this class.
	 *
	 * @return  object
	 */
	public static function init() {
		// If the single instance hasn't been set, set it now.
		if ( ! isset( self::$instance ) ) {
			self::$instance = new self();
		}
		return self::$instance;
	}

	/**
	 * After active plugins and pluggable functions are loaded
	 */
	public function plugins_loaded() {
		require_once LSX_CURRENCIES_PATH . 'classes/class-admin.php';
		$this->admin = \lsx\currencies\classes\Admin::init();

		require_once LSX_CURRENCIES_PATH . 'classes/class-frontend.php';
		$this->frontend = \lsx\currencies\classes\Frontend::init();

		if ( class_exists( 'WooCommerce' ) ) {
			require_once LSX_CURRENCIES_PATH . 'classes/class-woocommerce.php';
			$this->woocommerce = \lsx\currencies\classes\WooCommerce::init();
		}

		if ( class_exists( 'FacetWP' ) ) {
			require_once LSX_CURRENCIES_PATH . 'classes/class-facetwp.php';
			$this->facetwp = \lsx\currencies\classes\FacetWP::init();
		}

		require_once LSX_CURRENCIES_PATH . '/includes/template-tags.php';
	}

	/**
	 * Get the options
	 */
	public function set_defaults() {
		$settings_tab = 'display';
		if ( function_exists( 'tour_operator' ) ) {
			$options = get_option( '_lsx-to_settings', false );
			$settings_tab = 'general';
		} else {
			$options = get_option( '_lsx_settings', false );

			if ( false === $options ) {
				$options = get_option( '_lsx_lsx-settings', false );
			}
		}

		if ( false !== $options ) {
			$this->options = $options;
			$this->migration_uix_to_customize();

			if ( isset( $this->options[ $settings_tab ] ) && isset( $this->options[ $settings_tab ]['currency'] ) ) {
				$this->base_currency = apply_filters( 'lsx_currencies_base_currency', $this->options[ $settings_tab ]['currency'], $this );
			}

			if ( isset( $this->options[ $settings_tab ]['additional_currencies'] ) && is_array( $this->options[ $settings_tab ]['additional_currencies'] ) && ! empty( $this->options[ $settings_tab ]['additional_currencies'] ) ) {
				$this->additional_currencies = $this->options[ $settings_tab ]['additional_currencies'];
			}

			if ( isset( $this->options[ $settings_tab ]['multi_price'] ) && 'on' === $this->options[ $settings_tab ]['multi_price'] ) {
				$this->multi_prices = true;
			}

			if ( isset( $this->options[ $settings_tab ]['convert_to_single_currency'] ) && 'on' === $this->options[ $settings_tab ]['convert_to_single_currency'] ) {
				$this->convert_to_single = true;
			}

			if ( isset( $this->options[ $settings_tab ]['remove_decimals'] ) && 'on' === $this->options[ $settings_tab ]['remove_decimals'] ) {
				$this->remove_decimals = true;
			}

			if ( isset( $this->options['api']['openexchange_api'] ) && '' !== $this->options['api']['openexchange_api'] ) {
				$this->app_id = $this->options['api']['openexchange_api'];
				$this->api_url = 'https://openexchangerates.org/api/latest.json?app_id=' . $this->app_id;
			}

			// Currency Switcher Options.
			$this->menus = get_theme_mod( 'lsx_currencies_currency_menu_position', false );

It seems like get_theme_mod('lsx_currencies_currency_menu_position', false) can also be of type false. However, the property $menus is declared as type array. Maybe add an additional type check?

			if ( get_theme_mod( 'lsx_currencies_display_flags', false ) ) {
				$this->display_flags = true;
			}

			if ( get_theme_mod( 'lsx_currencies_flag_position', false ) ) {
				$this->flag_position = 'right';
			}

			if ( get_theme_mod( 'lsx_currencies_currency_switcher_position', false ) ) {
				$this->switcher_symbol_position = 'left';
			}
		}
		$this->available_currencies = $this->get_available_currencies();
		$this->flag_relations = $this->get_flag_relations();
		$this->currency_symbols = $this->get_currency_symbols();
	}

	/**

Doc comment for parameter "$key" missing

	 * Returns Currency Flag for currency code provided
	 *
	 * @param $key string
	 * @return string
	 */
	public function get_currency_flag( $key = 'USD' ) {
		$key = strtoupper( $key );
		return '<span class="flag-icon flag-icon-' . $this->flag_relations[ $key ] . '"></span> ';
	}

	/**
	 * Get Currency symbol.
	 *
	 * @param string $currency

Missing parameter comment

	 * @return string
	 */
	public function get_currency_symbol( $currency = '' ) {
		if ( ! $currency ) {
			$currency = $this->base_currency;
		}
		$currency_symbol = isset( $this->currency_symbols[ $currency ] ) ? $this->currency_symbols[ $currency ] : '';
		return $currency_symbol;
	}

	/**
	 * Returns an array of the available currencies
	 *
	 * @return array
	 */
	public function get_available_currencies() {

		$paid_currencies = array(
			'BWP' => esc_html__( 'Botswana Pula', 'lsx-currencies' ),
			'KES' => esc_html__( 'Kenyan Shilling', 'lsx-currencies' ),
			'LAK' => esc_html__( 'Laos Kip', 'lsx-currencies' ),
			'MWK' => esc_html__( 'Malawian Kwacha', 'lsx-currencies' ),
			'MZN' => esc_html__( 'Mozambique Metical', 'lsx-currencies' ),
			'NAD' => esc_html__( 'Namibian Dollar', 'lsx-currencies' ),
			'TZS' => esc_html__( 'Tanzania Shilling', 'lsx-currencies' ),
			'AED' => esc_html__( 'United Arab Emirates Dirham', 'lsx-currencies' ),
			'ZMW' => esc_html__( 'Zambian Kwacha', 'lsx-currencies' ),
			'ZWL' => esc_html__( 'Zimbabwean Dollar', 'lsx-currencies' ),
		);
		$free_currencies = array(
			'AUD' => esc_html__( 'Australian Dollar', 'lsx-currencies' ),
			'BRL' => esc_html__( 'Brazilian Real', 'lsx-currencies' ),
			'GBP' => esc_html__( 'British Pound Sterling', 'lsx-currencies' ),
			'CAD' => esc_html__( 'Canadian Dollar', 'lsx-currencies' ),
			'CNY' => esc_html__( 'Chinese Yuan', 'lsx-currencies' ),
			'EUR' => esc_html__( 'Euro', 'lsx-currencies' ),
			'HKD' => esc_html__( 'Hong Kong Dollar', 'lsx-currencies' ),
			'INR' => esc_html__( 'Indian Rupee', 'lsx-currencies' ),
			'IDR' => esc_html__( 'Indonesia Rupiah', 'lsx-currencies' ),
			'ILS' => esc_html__( 'Israeli Shekel', 'lsx-currencies' ),
			'JPY' => esc_html__( 'Japanese Yen', 'lsx-currencies' ),
			'MYR' => esc_html__( 'Malaysia Ringgit', 'lsx-currencies' ),
			'NOK' => esc_html__( 'Norwegian Krone', 'lsx-currencies' ),
			'NZD' => esc_html__( 'New Zealand Dollar', 'lsx-currencies' ),
			'RUB' => esc_html__( 'Russian Ruble', 'lsx-currencies' ),
			'SGD' => esc_html__( 'Singapore Dollar', 'lsx-currencies' ),
			'ZAR' => esc_html__( 'South African Rand', 'lsx-currencies' ),
			'SEK' => esc_html__( 'Swedish Krona', 'lsx-currencies' ),
			'CHF' => esc_html__( 'Swiss Franc', 'lsx-currencies' ),
			'USD' => esc_html__( 'United States Dollar', 'lsx-currencies' ),
		);

		if ( false !== $this->app_id ) {
			$free_currencies = array_merge( $free_currencies, $paid_currencies );
			asort( $free_currencies );
		}

		return $free_currencies;
	}

	/**
	 * Returns the ISO 3 code in relation to its 2 code values.
	 *
	 * @return array
	 */
	public function get_flag_relations() {
		return array(
			'AUD' => 'au',
			'BRL' => 'br',
			'GBP' => 'gb',
			'BWP' => 'bw',
			'CAD' => 'ca',
			'CNY' => 'cn',
			'EUR' => 'eu',
			'HKD' => 'hk',
			'INR' => 'in',
			'IDR' => 'id',
			'ILS' => 'il',
			'JPY' => 'jp',
			'KES' => 'ke',
			'LAK' => 'la',
			'MWK' => 'mw',
			'MYR' => 'my',
			'MZN' => 'mz',
			'NAD' => 'na',
			'NZD' => 'nz',
			'NOK' => 'no',
			'RUB' => 'ru',
			'SGD' => 'sg',
			'ZAR' => 'za',
			'SEK' => 'se',
			'CHF' => 'ch',
			'TZS' => 'tz',
			'USD' => 'us',
			'AED' => 'ae',
			'ZMW' => 'zm',
			'ZWL' => 'zw',
		);
	}

	/**
	 * Returns all of the currency symbols.
	 *
	 * @return array
	 */
	public function get_currency_symbols() {
		return apply_filters( 'lsx_currencies_symbols', array(
			'AED' => 'د.إ',
			'AFN' => '؋',
			'ALL' => 'L',
			'AMD' => 'AMD',
			'ANG' => 'ƒ',
			'AOA' => 'Kz',
			'ARS' => '$',
			'AUD' => '$',
			'AWG' => 'Afl.',
			'AZN' => 'AZN',
			'BAM' => 'KM',
			'BBD' => '$',
			'BDT' => '৳ ',
			'BGN' => 'лв.',
			'BHD' => '.د.ب',
			'BIF' => 'Fr',
			'BMD' => '$',
			'BND' => '$',
			'BOB' => 'Bs.',
			'BRL' => 'R$',
			'BSD' => '$',
			'BTC' => '฿',
			'BTN' => 'Nu.',
			'BWP' => 'P',
			'BYR' => 'Br',
			'BZD' => '$',
			'CAD' => '$',
			'CDF' => 'Fr',
			'CHF' => 'CHF',
			'CLP' => '$',
			'CNY' => '¥',
			'COP' => '$',
			'CRC' => '₡',
			'CUC' => '$',
			'CUP' => '$',
			'CVE' => '$',
			'CZK' => 'Kč',
			'DJF' => 'Fr',
			'DKK' => 'DKK',
			'DOP' => 'RD$',
			'DZD' => 'د.ج',
			'EGP' => 'EGP',
			'ERN' => 'Nfk',
			'ETB' => 'Br',
			'EUR' => '€',
			'FJD' => '$',
			'FKP' => '£',
			'GBP' => '£',
			'GEL' => 'ლ',
			'GGP' => '£',
			'GHS' => '₵',
			'GIP' => '£',
			'GMD' => 'D',
			'GNF' => 'Fr',
			'GTQ' => 'Q',
			'GYD' => '$',
			'HKD' => '$',
			'HNL' => 'L',
			'HRK' => 'Kn',
			'HTG' => 'G',
			'HUF' => 'Ft',
			'IDR' => 'Rp',
			'ILS' => '₪',
			'IMP' => '£',
			'INR' => '₹',
			'IQD' => 'ع.د',
			'IRR' => '﷼',
			'IRT' => 'تومان',
			'ISK' => 'kr.',
			'JEP' => '£',
			'JMD' => '$',
			'JOD' => 'د.ا',
			'JPY' => '¥',
			'KES' => 'KSh',
			'KGS' => 'сом',
			'KHR' => '៛',
			'KMF' => 'Fr',
			'KPW' => '₩',
			'KRW' => '₩',
			'KWD' => 'د.ك',
			'KYD' => '$',
			'KZT' => 'KZT',
			'LAK' => '₭',
			'LBP' => 'ل.ل',
			'LKR' => 'රු',
			'LRD' => '$',
			'LSL' => 'L',
			'LYD' => 'ل.د',
			'MAD' => 'د.م.',
			'MDL' => 'MDL',
			'MGA' => 'Ar',
			'MKD' => 'ден',
			'MMK' => 'Ks',
			'MNT' => '₮',
			'MOP' => 'P',
			'MRO' => 'UM',
			'MUR' => '₨',
			'MVR' => '.ރ',
			'MWK' => 'MK',
			'MXN' => '$',
			'MYR' => 'RM',
			'MZN' => 'MT',
			'NAD' => '$',
			'NGN' => '₦',
			'NIO' => 'C$',
			'NOK' => 'kr',
			'NPR' => '₨',
			'NZD' => '$',
			'OMR' => 'ر.ع.',
			'PAB' => 'B/.',
			'PEN' => 'S/.',
			'PGK' => 'K',
			'PHP' => '₱',
			'PKR' => '₨',
			'PLN' => 'zł',
			'PRB' => 'р.',
			'PYG' => '₲',
			'QAR' => 'ر.ق',
			'RMB' => '¥',
			'RON' => 'lei',
			'RSD' => 'дин.',
			'RUB' => '₽',
			'RWF' => 'Fr',
			'SAR' => 'ر.س',
			'SBD' => '$',
			'SCR' => '₨',
			'SDG' => 'ج.س.',
			'SEK' => 'kr',
			'SGD' => '$',
			'SHP' => '£',
			'SLL' => 'Le',
			'SOS' => 'Sh',
			'SRD' => '$',
			'SSP' => '£',
			'STD' => 'Db',
			'SYP' => 'ل.س',
			'SZL' => 'L',
			'THB' => '฿',
			'TJS' => 'ЅМ',
			'TMT' => 'm',
			'TND' => 'د.ت',
			'TOP' => 'T$',
			'TRY' => '₺',
			'TTD' => '$',
			'TWD' => 'NT$',
			'TZS' => 'Sh',
			'UAH' => '₴',
			'UGX' => 'UGX',
			'USD' => '$',
			'UYU' => '$',
			'UZS' => 'UZS',
			'VEF' => 'Bs F',
			'VND' => '₫',
			'VUV' => 'Vt',
			'WST' => 'T',
			'XAF' => 'Fr',
			'XCD' => '$',
			'XOF' => 'Fr',
			'XPF' => 'Fr',
			'YER' => '﷼',
			'ZAR' => 'R',
			'ZMW' => 'ZK',
		) );
	}

	/**

Doc comment for parameter "$input" missing

	 * Sanitize checkbox.
	 *
	 * @param $input html
	 * @return mixed
	 */
	public function sanitize_checkbox( $input ) {
		return ( 1 === absint( $input ) ) ? 1 : 0;
	}

	/**

Doc comment for parameter "$input" missing

	 * Sanitize select.
	 *
	 * @param $input html
	 * @return mixed
	 */
	public function sanitize_select( $input ) {
		if ( is_string( $input ) || is_integer( $input ) || is_bool( $input ) ) {
			return $input;
		} else {
			return '';
		}
	}

	/**

Doc comment for parameter "$input" missing

	 * Sanitize textarea.
	 *
	 * @param $input html
	 * @return mixed
	 */
	public function sanitize_textarea( $input ) {
		return wp_kses_post( $input );
	}

	/**
	 * Migrate the old data (from UIX) to WP Customizer settings.
	 *
	 * @since 1.1.1
	 */
	public function migration_uix_to_customize() {
		$visual_tab_migration = get_theme_mod( 'lsx_currencies_visual_tab_migration', false );

		if ( empty( $visual_tab_migration ) ) {
			if ( isset( $this->options['display'] ) ) {
				if ( isset( $this->options['display']['currency_menu_switcher'] ) && is_array( $this->options['display']['currency_menu_switcher'] ) && ! empty( $this->options['display']['currency_menu_switcher'] ) ) {
					$currency_menu_position = $this->options['display']['currency_menu_switcher'];

					foreach ( $currency_menu_position as $key => $value ) {
						set_theme_mod( 'lsx_currencies_currency_menu_position', $key );
						break;
					}
				}

				if ( isset( $this->options['display']['display_flags'] ) && 'on' === $this->options['display']['display_flags'] ) {
					set_theme_mod( 'lsx_currencies_display_flags', true );
				}

				if ( isset( $this->options['display']['flag_position'] ) && 'on' === $this->options['display']['flag_position'] ) {
					set_theme_mod( 'lsx_currencies_flag_position', 'right' );
				}

				if ( isset( $this->options['display']['currency_switcher_position'] ) && 'on' === $this->options['display']['currency_switcher_position'] ) {
					set_theme_mod( 'lsx_currencies_currency_switcher_position', 'left' );
				}
			}

			set_theme_mod( 'lsx_currencies_visual_tab_migration', true );
		}
	}
}