AyeCode / invoicing

vendor/ayecode/wp-ayecode-ui/includes/ayecode-ui-settings.php

Indentation +858 added lines, -858 removed lines

@@ -13,7 +13,7 @@ 
  * Bail if we are not in WP.
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -21,201 +21,201 @@ 
  */
 if ( ! class_exists( 'AyeCode_UI_Settings' ) ) {
 
-	/**
-	 * A Class to be able to change settings for Font Awesome.
-	 *
-	 * Class AyeCode_UI_Settings
-	 * @ver 1.0.0
-	 * @todo decide how to implement textdomain
-	 */
-	class AyeCode_UI_Settings {
-
-		/**
-		 * Class version version.
-		 *
-		 * @var string
-		 */
-		public $version = '1.0.1';
-
-		/**
-		 * Class textdomain.
-		 *
-		 * @var string
-		 */
-		public $textdomain = 'aui';
-
-		/**
-		 * Latest version of Bootstrap at time of publish published.
-		 *
-		 * @var string
-		 */
-		public $latest = "4.5.3";
-
-		/**
-		 * Current version of select2 being used.
-		 *
-		 * @var string
-		 */
-		public $select2_version = "4.0.11";
-
-		/**
-		 * The title.
-		 *
-		 * @var string
-		 */
-		public $name = 'AyeCode UI';
-
-		/**
-		 * The relative url to the assets.
-		 *
-		 * @var string
-		 */
-		public $url = '';
-
-		/**
-		 * Holds the settings values.
-		 *
-		 * @var array
-		 */
-		private $settings;
-
-		/**
-		 * AyeCode_UI_Settings instance.
-		 *
-		 * @access private
-		 * @since  1.0.0
-		 * @var    AyeCode_UI_Settings There can be only one!
-		 */
-		private static $instance = null;
-
-		/**
-		 * Main AyeCode_UI_Settings Instance.
-		 *
-		 * Ensures only one instance of AyeCode_UI_Settings is loaded or can be loaded.
-		 *
-		 * @since 1.0.0
-		 * @static
-		 * @return AyeCode_UI_Settings - Main instance.
-		 */
-		public static function instance() {
-			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof AyeCode_UI_Settings ) ) {
-
-				self::$instance = new AyeCode_UI_Settings;
-
-				add_action( 'init', array( self::$instance, 'init' ) ); // set settings
-
-				if ( is_admin() ) {
-					add_action( 'admin_menu', array( self::$instance, 'menu_item' ) );
-					add_action( 'admin_init', array( self::$instance, 'register_settings' ) );
-
-					// Maybe show example page
-					add_action( 'template_redirect', array( self::$instance,'maybe_show_examples' ) );
-				}
+    /**
+     * A Class to be able to change settings for Font Awesome.
+     *
+     * Class AyeCode_UI_Settings
+     * @ver 1.0.0
+     * @todo decide how to implement textdomain
+     */
+    class AyeCode_UI_Settings {
+
+        /**
+         * Class version version.
+         *
+         * @var string
+         */
+        public $version = '1.0.1';
+
+        /**
+         * Class textdomain.
+         *
+         * @var string
+         */
+        public $textdomain = 'aui';
+
+        /**
+         * Latest version of Bootstrap at time of publish published.
+         *
+         * @var string
+         */
+        public $latest = "4.5.3";
+
+        /**
+         * Current version of select2 being used.
+         *
+         * @var string
+         */
+        public $select2_version = "4.0.11";
+
+        /**
+         * The title.
+         *
+         * @var string
+         */
+        public $name = 'AyeCode UI';
+
+        /**
+         * The relative url to the assets.
+         *
+         * @var string
+         */
+        public $url = '';
+
+        /**
+         * Holds the settings values.
+         *
+         * @var array
+         */
+        private $settings;
+
+        /**
+         * AyeCode_UI_Settings instance.
+         *
+         * @access private
+         * @since  1.0.0
+         * @var    AyeCode_UI_Settings There can be only one!
+         */
+        private static $instance = null;
+
+        /**
+         * Main AyeCode_UI_Settings Instance.
+         *
+         * Ensures only one instance of AyeCode_UI_Settings is loaded or can be loaded.
+         *
+         * @since 1.0.0
+         * @static
+         * @return AyeCode_UI_Settings - Main instance.
+         */
+        public static function instance() {
+            if ( ! isset( self::$instance ) && ! ( self::$instance instanceof AyeCode_UI_Settings ) ) {
+
+                self::$instance = new AyeCode_UI_Settings;
+
+                add_action( 'init', array( self::$instance, 'init' ) ); // set settings
+
+                if ( is_admin() ) {
+                    add_action( 'admin_menu', array( self::$instance, 'menu_item' ) );
+                    add_action( 'admin_init', array( self::$instance, 'register_settings' ) );
+
+                    // Maybe show example page
+                    add_action( 'template_redirect', array( self::$instance,'maybe_show_examples' ) );
+                }
 
-				add_action( 'customize_register', array( self::$instance, 'customizer_settings' ));
-
-				do_action( 'ayecode_ui_settings_loaded' );
-			}
-
-			return self::$instance;
-		}
-
-		/**
-		 * Setup some constants.
-		 */
-		public function constants(){
-			define('AUI_PRIMARY_COLOR_ORIGINAL', "#1e73be");
-			define('AUI_SECONDARY_COLOR_ORIGINAL', '#6c757d');
-			if (!defined('AUI_PRIMARY_COLOR')) define('AUI_PRIMARY_COLOR', AUI_PRIMARY_COLOR_ORIGINAL);
-			if (!defined('AUI_SECONDARY_COLOR')) define('AUI_SECONDARY_COLOR', AUI_SECONDARY_COLOR_ORIGINAL);
-		}
-
-		/**
-		 * Initiate the settings and add the required action hooks.
-		 */
-		public function init() {
-			$this->constants();
-			$this->settings = $this->get_settings();
-			$this->url = $this->get_url();
-
-			/**
-			 * Maybe load CSS
-			 *
-			 * We load super early in case there is a theme version that might change the colors
-			 */
-			if ( $this->settings['css'] ) {
-				add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_style' ), 1 );
-			}
-			if ( $this->settings['css_backend'] && $this->load_admin_scripts() ) {
-				add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_style' ), 1 );
-			}
-
-			// maybe load JS
-			if ( $this->settings['js'] ) {
-				add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 1 );
-			}
-			if ( $this->settings['js_backend'] && $this->load_admin_scripts() ) {
-				add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ), 1 );
-			}
-
-			// Maybe set the HTML font size
-			if ( $this->settings['html_font_size'] ) {
-				add_action( 'wp_footer', array( $this, 'html_font_size' ), 10 );
-			}
-
-
-		}
-
-		/**
-		 * Check if we should load the admin scripts or not.
-		 *
-		 * @return bool
-		 */
-		public function load_admin_scripts(){
-			$result = true;
-
-			if(!empty($this->settings['disable_admin'])){
-				$url_parts = explode("\n",$this->settings['disable_admin']);
-				foreach($url_parts as $part){
-					if( strpos($_SERVER['REQUEST_URI'], trim($part)) !== false ){
-						return false; // return early, no point checking further
-					}
-				}
-			}
+                add_action( 'customize_register', array( self::$instance, 'customizer_settings' ));
+
+                do_action( 'ayecode_ui_settings_loaded' );
+            }
+
+            return self::$instance;
+        }
+
+        /**
+         * Setup some constants.
+         */
+        public function constants(){
+            define('AUI_PRIMARY_COLOR_ORIGINAL', "#1e73be");
+            define('AUI_SECONDARY_COLOR_ORIGINAL', '#6c757d');
+            if (!defined('AUI_PRIMARY_COLOR')) define('AUI_PRIMARY_COLOR', AUI_PRIMARY_COLOR_ORIGINAL);
+            if (!defined('AUI_SECONDARY_COLOR')) define('AUI_SECONDARY_COLOR', AUI_SECONDARY_COLOR_ORIGINAL);
+        }
+
+        /**
+         * Initiate the settings and add the required action hooks.
+         */
+        public function init() {
+            $this->constants();
+            $this->settings = $this->get_settings();
+            $this->url = $this->get_url();
+
+            /**
+             * Maybe load CSS
+             *
+             * We load super early in case there is a theme version that might change the colors
+             */
+            if ( $this->settings['css'] ) {
+                add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_style' ), 1 );
+            }
+            if ( $this->settings['css_backend'] && $this->load_admin_scripts() ) {
+                add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_style' ), 1 );
+            }
+
+            // maybe load JS
+            if ( $this->settings['js'] ) {
+                add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 1 );
+            }
+            if ( $this->settings['js_backend'] && $this->load_admin_scripts() ) {
+                add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ), 1 );
+            }
+
+            // Maybe set the HTML font size
+            if ( $this->settings['html_font_size'] ) {
+                add_action( 'wp_footer', array( $this, 'html_font_size' ), 10 );
+            }
+
+
+        }
+
+        /**
+         * Check if we should load the admin scripts or not.
+         *
+         * @return bool
+         */
+        public function load_admin_scripts(){
+            $result = true;
+
+            if(!empty($this->settings['disable_admin'])){
+                $url_parts = explode("\n",$this->settings['disable_admin']);
+                foreach($url_parts as $part){
+                    if( strpos($_SERVER['REQUEST_URI'], trim($part)) !== false ){
+                        return false; // return early, no point checking further
+                    }
+                }
+            }
 
-			return $result;
-		}
+            return $result;
+        }
 
-		/**
-		 * Add a html font size to the footer.
-		 */
-		public function html_font_size(){
-			$this->settings = $this->get_settings();
-			echo "<style>html{font-size:".absint($this->settings['html_font_size'])."px;}</style>";
-		}
+        /**
+         * Add a html font size to the footer.
+         */
+        public function html_font_size(){
+            $this->settings = $this->get_settings();
+            echo "<style>html{font-size:".absint($this->settings['html_font_size'])."px;}</style>";
+        }
 
-		/**
-		 * Adds the styles.
-		 */
-		public function enqueue_style() {
+        /**
+         * Adds the styles.
+         */
+        public function enqueue_style() {
 
-			$css_setting = current_action() == 'wp_enqueue_scripts' ? 'css' : 'css_backend';
+            $css_setting = current_action() == 'wp_enqueue_scripts' ? 'css' : 'css_backend';
 
-			$rtl = is_rtl() ? '-rtl' : '';
+            $rtl = is_rtl() ? '-rtl' : '';
 
-			if($this->settings[$css_setting]){
-				$compatibility = $this->settings[$css_setting]=='core' ? false : true;
-				$url = $this->settings[$css_setting]=='core' ? $this->url.'assets/css/ayecode-ui'.$rtl.'.css' : $this->url.'assets/css/ayecode-ui-compatibility'.$rtl.'.css';
-				wp_register_style( 'ayecode-ui', $url, array(), $this->latest );
-				wp_enqueue_style( 'ayecode-ui' );
+            if($this->settings[$css_setting]){
+                $compatibility = $this->settings[$css_setting]=='core' ? false : true;
+                $url = $this->settings[$css_setting]=='core' ? $this->url.'assets/css/ayecode-ui'.$rtl.'.css' : $this->url.'assets/css/ayecode-ui-compatibility'.$rtl.'.css';
+                wp_register_style( 'ayecode-ui', $url, array(), $this->latest );
+                wp_enqueue_style( 'ayecode-ui' );
 
-				// flatpickr
-				wp_register_style( 'flatpickr', $this->url.'assets/css/flatpickr.min.css', array(), $this->latest );
+                // flatpickr
+                wp_register_style( 'flatpickr', $this->url.'assets/css/flatpickr.min.css', array(), $this->latest );
 
 
-				// fix some wp-admin issues
-				if(is_admin()){
-					$custom_css = "
+                // fix some wp-admin issues
+                if(is_admin()){
+                    $custom_css = "
                 body{
                     background-color: #f1f1f1;
                     font-family: -apple-system,BlinkMacSystemFont,\"Segoe UI\",Roboto,Oxygen-Sans,Ubuntu,Cantarell,\"Helvetica Neue\",sans-serif;
@@ -251,29 +251,29 @@ 
 				}
                 ";
 
-					// @todo, remove once fixed :: fix for this bug https://github.com/WordPress/gutenberg/issues/14377
-					$custom_css .= "
+                    // @todo, remove once fixed :: fix for this bug https://github.com/WordPress/gutenberg/issues/14377
+                    $custom_css .= "
 						.edit-post-sidebar input[type=color].components-text-control__input{
 						    padding: 0;
 						}
 					";
-					wp_add_inline_style( 'ayecode-ui', $custom_css );
-				}
+                    wp_add_inline_style( 'ayecode-ui', $custom_css );
+                }
 
-				// custom changes
-				wp_add_inline_style( 'ayecode-ui', self::custom_css($compatibility) );
+                // custom changes
+                wp_add_inline_style( 'ayecode-ui', self::custom_css($compatibility) );
 
-			}
-		}
+            }
+        }
 
-		/**
-		 * Get inline script used if bootstrap enqueued
-		 *
-		 * If this remains small then its best to use this than to add another JS file.
-		 */
-		public function inline_script(){
-			ob_start();
-			?>
+        /**
+         * Get inline script used if bootstrap enqueued
+         *
+         * If this remains small then its best to use this than to add another JS file.
+         */
+        public function inline_script(){
+            ob_start();
+            ?>
 			<script>
 				
 				/**
@@ -760,25 +760,25 @@ 
 
 			</script>
 			<?php
-			$output = ob_get_clean();
+            $output = ob_get_clean();
 
-			/*
+            /*
 			 * We only add the <script> tags for code highlighting, so we strip them from the output.
 			 */
-			return str_replace( array(
-				'<script>',
-				'</script>'
-			), '', $output );
-		}
-
-		/**
-		 * Get inline script used if bootstrap file browser enqueued.
-		 *
-		 * If this remains small then its best to use this than to add another JS file.
-		 */
-		public function inline_script_file_browser(){
-			ob_start();
-			?>
+            return str_replace( array(
+                '<script>',
+                '</script>'
+            ), '', $output );
+        }
+
+        /**
+         * Get inline script used if bootstrap file browser enqueued.
+         *
+         * If this remains small then its best to use this than to add another JS file.
+         */
+        public function inline_script_file_browser(){
+            ob_start();
+            ?>
 			<script>
 				// run on doc ready
 				jQuery(document).ready(function () {
@@ -786,184 +786,184 @@ 
 				});
 			</script>
 			<?php
-			$output = ob_get_clean();
+            $output = ob_get_clean();
 
-			/*
+            /*
 			 * We only add the <script> tags for code highlighting, so we strip them from the output.
 			 */
-			return str_replace( array(
-				'<script>',
-				'</script>'
-			), '', $output );
-		}
-
-		/**
-		 * Adds the Font Awesome JS.
-		 */
-		public function enqueue_scripts() {
-
-			$js_setting = current_action() == 'wp_enqueue_scripts' ? 'js' : 'js_backend';
-
-			// select2
-			wp_register_script( 'select2', $this->url.'assets/js/select2.min.js', array('jquery'), $this->select2_version );
-
-			// flatpickr
-			wp_register_script( 'flatpickr', $this->url.'assets/js/flatpickr.min.js', array(), $this->latest );
-
-			// Bootstrap file browser
-			wp_register_script( 'aui-custom-file-input', $url = $this->url.'assets/js/bs-custom-file-input.min.js', array('jquery'), $this->select2_version );
-			wp_add_inline_script( 'aui-custom-file-input', $this->inline_script_file_browser() );
-
-			$load_inline = false;
-
-			if($this->settings[$js_setting]=='core-popper'){
-				// Bootstrap bundle
-				$url = $this->url.'assets/js/bootstrap.bundle.min.js';
-				wp_register_script( 'bootstrap-js-bundle', $url, array('select2','jquery'), $this->latest );
-				// if in admin then add to footer for compatibility.
-				is_admin() ? wp_enqueue_script( 'bootstrap-js-bundle', '', null, null, true ) : wp_enqueue_script( 'bootstrap-js-bundle');
-				$script = $this->inline_script();
-				wp_add_inline_script( 'bootstrap-js-bundle', $script );
-			}elseif($this->settings[$js_setting]=='popper'){
-				$url = $this->url.'assets/js/popper.min.js';
-				wp_register_script( 'bootstrap-js-popper', $url, array('select2','jquery'), $this->latest );
-				wp_enqueue_script( 'bootstrap-js-popper' );
-				$load_inline = true;
-			}else{
-				$load_inline = true;
-			}
-
-			// Load needed inline scripts by faking the loading of a script if the main script is not being loaded
-			if($load_inline){
-				wp_register_script( 'bootstrap-dummy', '',array('select2','jquery') );
-				wp_enqueue_script( 'bootstrap-dummy' );
-				$script = $this->inline_script();
-				wp_add_inline_script( 'bootstrap-dummy', $script  );
-			}
-
-		}
-
-		/**
-		 * Enqueue flatpickr if called.
-		 */
-		public function enqueue_flatpickr(){
-			wp_enqueue_style( 'flatpickr' );
-			wp_enqueue_script( 'flatpickr' );
-		}
-
-		/**
-		 * Get the url path to the current folder.
-		 *
-		 * @return string
-		 */
-		public function get_url() {
-
-			$url = '';
-			// check if we are inside a plugin
-			$file_dir = str_replace( "/includes","", wp_normalize_path( dirname( __FILE__ ) ) );
-
-			// add check in-case user has changed wp-content dir name.
-			$wp_content_folder_name = basename(WP_CONTENT_DIR);
-			$dir_parts = explode("/$wp_content_folder_name/",$file_dir);
-			$url_parts = explode("/$wp_content_folder_name/",plugins_url());
-
-			if(!empty($url_parts[0]) && !empty($dir_parts[1])){
-				$url = trailingslashit( $url_parts[0]."/$wp_content_folder_name/".$dir_parts[1] );
-			}
-
-			return $url;
-		}
-
-		/**
-		 * Register the database settings with WordPress.
-		 */
-		public function register_settings() {
-			register_setting( 'ayecode-ui-settings', 'ayecode-ui-settings' );
-		}
-
-		/**
-		 * Add the WordPress settings menu item.
-		 * @since 1.0.10 Calling function name direct will fail theme check so we don't.
-		 */
-		public function menu_item() {
-			$menu_function = 'add' . '_' . 'options' . '_' . 'page'; // won't pass theme check if function name present in theme
-			call_user_func( $menu_function, $this->name, $this->name, 'manage_options', 'ayecode-ui-settings', array(
-				$this,
-				'settings_page'
-			) );
-		}
-
-		/**
-		 * Get a list of themes and their default JS settings.
-		 *
-		 * @return array
-		 */
-		public function theme_js_settings(){
-			return array(
-				'ayetheme' => 'popper',
-				'listimia' => 'required',
-				'listimia_backend' => 'core-popper',
-				'avada'    => 'required',
-			);
-		}
-
-		/**
-		 * Get the current Font Awesome output settings.
-		 *
-		 * @return array The array of settings.
-		 */
-		public function get_settings() {
-
-			$db_settings = get_option( 'ayecode-ui-settings' );
-			$js_default = 'core-popper';
-			$js_default_backend = $js_default;
-
-			// maybe set defaults (if no settings set)
-			if(empty($db_settings)){
-				$active_theme = strtolower( get_template() ); // active parent theme.
-				$theme_js_settings = self::theme_js_settings();
-				if(isset($theme_js_settings[$active_theme])){
-					$js_default = $theme_js_settings[$active_theme];
-					$js_default_backend = isset($theme_js_settings[$active_theme."_backend"]) ? $theme_js_settings[$active_theme."_backend"] : $js_default;
-				}
-			}
-
-			$defaults = array(
-				'css'       => 'compatibility', // core, compatibility
-				'js'        => $js_default, // js to load, core-popper, popper
-				'html_font_size'        => '16', // js to load, core-popper, popper
-				'css_backend'       => 'compatibility', // core, compatibility
-				'js_backend'        => $js_default_backend, // js to load, core-popper, popper
-				'disable_admin'     =>  '', // URL snippets to disable loading on admin
-			);
-
-			$settings = wp_parse_args( $db_settings, $defaults );
-
-			/**
-			 * Filter the Bootstrap settings.
-			 *
-			 * @todo if we add this filer people might use it and then it defeates the purpose of this class :/
-			 */
-			return $this->settings = apply_filters( 'ayecode-ui-settings', $settings, $db_settings, $defaults );
-		}
-
-
-		/**
-		 * The settings page html output.
-		 */
-		public function settings_page() {
-			if ( ! current_user_can( 'manage_options' ) ) {
-				wp_die( __( 'You do not have sufficient permissions to access this page.', 'aui' ) );
-			}
-			?>
+            return str_replace( array(
+                '<script>',
+                '</script>'
+            ), '', $output );
+        }
+
+        /**
+         * Adds the Font Awesome JS.
+         */
+        public function enqueue_scripts() {
+
+            $js_setting = current_action() == 'wp_enqueue_scripts' ? 'js' : 'js_backend';
+
+            // select2
+            wp_register_script( 'select2', $this->url.'assets/js/select2.min.js', array('jquery'), $this->select2_version );
+
+            // flatpickr
+            wp_register_script( 'flatpickr', $this->url.'assets/js/flatpickr.min.js', array(), $this->latest );
+
+            // Bootstrap file browser
+            wp_register_script( 'aui-custom-file-input', $url = $this->url.'assets/js/bs-custom-file-input.min.js', array('jquery'), $this->select2_version );
+            wp_add_inline_script( 'aui-custom-file-input', $this->inline_script_file_browser() );
+
+            $load_inline = false;
+
+            if($this->settings[$js_setting]=='core-popper'){
+                // Bootstrap bundle
+                $url = $this->url.'assets/js/bootstrap.bundle.min.js';
+                wp_register_script( 'bootstrap-js-bundle', $url, array('select2','jquery'), $this->latest );
+                // if in admin then add to footer for compatibility.
+                is_admin() ? wp_enqueue_script( 'bootstrap-js-bundle', '', null, null, true ) : wp_enqueue_script( 'bootstrap-js-bundle');
+                $script = $this->inline_script();
+                wp_add_inline_script( 'bootstrap-js-bundle', $script );
+            }elseif($this->settings[$js_setting]=='popper'){
+                $url = $this->url.'assets/js/popper.min.js';
+                wp_register_script( 'bootstrap-js-popper', $url, array('select2','jquery'), $this->latest );
+                wp_enqueue_script( 'bootstrap-js-popper' );
+                $load_inline = true;
+            }else{
+                $load_inline = true;
+            }
+
+            // Load needed inline scripts by faking the loading of a script if the main script is not being loaded
+            if($load_inline){
+                wp_register_script( 'bootstrap-dummy', '',array('select2','jquery') );
+                wp_enqueue_script( 'bootstrap-dummy' );
+                $script = $this->inline_script();
+                wp_add_inline_script( 'bootstrap-dummy', $script  );
+            }
+
+        }
+
+        /**
+         * Enqueue flatpickr if called.
+         */
+        public function enqueue_flatpickr(){
+            wp_enqueue_style( 'flatpickr' );
+            wp_enqueue_script( 'flatpickr' );
+        }
+
+        /**
+         * Get the url path to the current folder.
+         *
+         * @return string
+         */
+        public function get_url() {
+
+            $url = '';
+            // check if we are inside a plugin
+            $file_dir = str_replace( "/includes","", wp_normalize_path( dirname( __FILE__ ) ) );
+
+            // add check in-case user has changed wp-content dir name.
+            $wp_content_folder_name = basename(WP_CONTENT_DIR);
+            $dir_parts = explode("/$wp_content_folder_name/",$file_dir);
+            $url_parts = explode("/$wp_content_folder_name/",plugins_url());
+
+            if(!empty($url_parts[0]) && !empty($dir_parts[1])){
+                $url = trailingslashit( $url_parts[0]."/$wp_content_folder_name/".$dir_parts[1] );
+            }
+
+            return $url;
+        }
+
+        /**
+         * Register the database settings with WordPress.
+         */
+        public function register_settings() {
+            register_setting( 'ayecode-ui-settings', 'ayecode-ui-settings' );
+        }
+
+        /**
+         * Add the WordPress settings menu item.
+         * @since 1.0.10 Calling function name direct will fail theme check so we don't.
+         */
+        public function menu_item() {
+            $menu_function = 'add' . '_' . 'options' . '_' . 'page'; // won't pass theme check if function name present in theme
+            call_user_func( $menu_function, $this->name, $this->name, 'manage_options', 'ayecode-ui-settings', array(
+                $this,
+                'settings_page'
+            ) );
+        }
+
+        /**
+         * Get a list of themes and their default JS settings.
+         *
+         * @return array
+         */
+        public function theme_js_settings(){
+            return array(
+                'ayetheme' => 'popper',
+                'listimia' => 'required',
+                'listimia_backend' => 'core-popper',
+                'avada'    => 'required',
+            );
+        }
+
+        /**
+         * Get the current Font Awesome output settings.
+         *
+         * @return array The array of settings.
+         */
+        public function get_settings() {
+
+            $db_settings = get_option( 'ayecode-ui-settings' );
+            $js_default = 'core-popper';
+            $js_default_backend = $js_default;
+
+            // maybe set defaults (if no settings set)
+            if(empty($db_settings)){
+                $active_theme = strtolower( get_template() ); // active parent theme.
+                $theme_js_settings = self::theme_js_settings();
+                if(isset($theme_js_settings[$active_theme])){
+                    $js_default = $theme_js_settings[$active_theme];
+                    $js_default_backend = isset($theme_js_settings[$active_theme."_backend"]) ? $theme_js_settings[$active_theme."_backend"] : $js_default;
+                }
+            }
+
+            $defaults = array(
+                'css'       => 'compatibility', // core, compatibility
+                'js'        => $js_default, // js to load, core-popper, popper
+                'html_font_size'        => '16', // js to load, core-popper, popper
+                'css_backend'       => 'compatibility', // core, compatibility
+                'js_backend'        => $js_default_backend, // js to load, core-popper, popper
+                'disable_admin'     =>  '', // URL snippets to disable loading on admin
+            );
+
+            $settings = wp_parse_args( $db_settings, $defaults );
+
+            /**
+             * Filter the Bootstrap settings.
+             *
+             * @todo if we add this filer people might use it and then it defeates the purpose of this class :/
+             */
+            return $this->settings = apply_filters( 'ayecode-ui-settings', $settings, $db_settings, $defaults );
+        }
+
+
+        /**
+         * The settings page html output.
+         */
+        public function settings_page() {
+            if ( ! current_user_can( 'manage_options' ) ) {
+                wp_die( __( 'You do not have sufficient permissions to access this page.', 'aui' ) );
+            }
+            ?>
 			<div class="wrap">
 				<h1><?php echo $this->name; ?></h1>
 				<p><?php _e("Here you can adjust settings if you are having compatibility issues.","aui");?></p>
 				<form method="post" action="options.php">
 					<?php
-					settings_fields( 'ayecode-ui-settings' );
-					do_settings_sections( 'ayecode-ui-settings' );
-					?>
+                    settings_fields( 'ayecode-ui-settings' );
+                    do_settings_sections( 'ayecode-ui-settings' );
+                    ?>
 
 					<h2><?php _e( 'Frontend', 'aui' ); ?></h2>
 					<table class="form-table wpbs-table-settings">
@@ -1043,55 +1043,55 @@ 
 					</table>
 
 					<?php
-					submit_button();
-					?>
+                    submit_button();
+                    ?>
 				</form>
 
 				<div id="wpbs-version"><?php echo $this->version; ?></div>
 			</div>
 
 			<?php
-		}
-
-		public function customizer_settings($wp_customize){
-			$wp_customize->add_section('aui_settings', array(
-				'title'    => __('AyeCode UI','aui'),
-				'priority' => 120,
-			));
-
-			//  =============================
-			//  = Color Picker              =
-			//  =============================
-			$wp_customize->add_setting('aui_options[color_primary]', array(
-				'default'           => AUI_PRIMARY_COLOR,
-				'sanitize_callback' => 'sanitize_hex_color',
-				'capability'        => 'edit_theme_options',
-				'type'              => 'option',
-				'transport'         => 'refresh',
-			));
-			$wp_customize->add_control( new WP_Customize_Color_Control($wp_customize, 'color_primary', array(
-				'label'    => __('Primary Color','aui'),
-				'section'  => 'aui_settings',
-				'settings' => 'aui_options[color_primary]',
-			)));
-
-			$wp_customize->add_setting('aui_options[color_secondary]', array(
-				'default'           => '#6c757d',
-				'sanitize_callback' => 'sanitize_hex_color',
-				'capability'        => 'edit_theme_options',
-				'type'              => 'option',
-				'transport'         => 'refresh',
-			));
-			$wp_customize->add_control( new WP_Customize_Color_Control($wp_customize, 'color_secondary', array(
-				'label'    => __('Secondary Color','aui'),
-				'section'  => 'aui_settings',
-				'settings' => 'aui_options[color_secondary]',
-			)));
-		}
-
-		public static function bs3_compat_css() {
-			ob_start();
-			?>
+        }
+
+        public function customizer_settings($wp_customize){
+            $wp_customize->add_section('aui_settings', array(
+                'title'    => __('AyeCode UI','aui'),
+                'priority' => 120,
+            ));
+
+            //  =============================
+            //  = Color Picker              =
+            //  =============================
+            $wp_customize->add_setting('aui_options[color_primary]', array(
+                'default'           => AUI_PRIMARY_COLOR,
+                'sanitize_callback' => 'sanitize_hex_color',
+                'capability'        => 'edit_theme_options',
+                'type'              => 'option',
+                'transport'         => 'refresh',
+            ));
+            $wp_customize->add_control( new WP_Customize_Color_Control($wp_customize, 'color_primary', array(
+                'label'    => __('Primary Color','aui'),
+                'section'  => 'aui_settings',
+                'settings' => 'aui_options[color_primary]',
+            )));
+
+            $wp_customize->add_setting('aui_options[color_secondary]', array(
+                'default'           => '#6c757d',
+                'sanitize_callback' => 'sanitize_hex_color',
+                'capability'        => 'edit_theme_options',
+                'type'              => 'option',
+                'transport'         => 'refresh',
+            ));
+            $wp_customize->add_control( new WP_Customize_Color_Control($wp_customize, 'color_secondary', array(
+                'label'    => __('Secondary Color','aui'),
+                'section'  => 'aui_settings',
+                'settings' => 'aui_options[color_secondary]',
+            )));
+        }
+
+        public static function bs3_compat_css() {
+            ob_start();
+            ?>
 			/* Bootstrap 3 compatibility */
 			body.modal-open .modal-backdrop.show:not(.in) {opacity:0.5;}
 			body.modal-open .modal.show:not(.in)  {opacity:1;z-index: 99999}
@@ -1109,453 +1109,453 @@ 
 
 			body.modal-open .modal.bsui .modal-dialog{left: auto;}
 			<?php
-			return ob_get_clean();
-		}
+            return ob_get_clean();
+        }
 
 
-		public static function custom_css($compatibility = true) {
-			$settings = get_option('aui_options');
+        public static function custom_css($compatibility = true) {
+            $settings = get_option('aui_options');
 
-			ob_start();
+            ob_start();
 
-			$primary_color = !empty($settings['color_primary']) ? $settings['color_primary'] : AUI_PRIMARY_COLOR;
-			$secondary_color = !empty($settings['color_secondary']) ? $settings['color_secondary'] : AUI_SECONDARY_COLOR;
-				//AUI_PRIMARY_COLOR_ORIGINAL
-			?>
+            $primary_color = !empty($settings['color_primary']) ? $settings['color_primary'] : AUI_PRIMARY_COLOR;
+            $secondary_color = !empty($settings['color_secondary']) ? $settings['color_secondary'] : AUI_SECONDARY_COLOR;
+                //AUI_PRIMARY_COLOR_ORIGINAL
+            ?>
 			<style>
 
 
 
 				<?php
 
-				// BS compat @todo add option check
-				//echo self::bs3_compat_css();
+                // BS compat @todo add option check
+                //echo self::bs3_compat_css();
 
-					if(!is_admin() && $primary_color != AUI_PRIMARY_COLOR_ORIGINAL){
-						echo self::css_primary($primary_color,$compatibility);
-					}
+                    if(!is_admin() && $primary_color != AUI_PRIMARY_COLOR_ORIGINAL){
+                        echo self::css_primary($primary_color,$compatibility);
+                    }
 
-					if(!is_admin() && $secondary_color != AUI_SECONDARY_COLOR_ORIGINAL){
-						echo self::css_secondary($settings['color_secondary'],$compatibility);
-					}
+                    if(!is_admin() && $secondary_color != AUI_SECONDARY_COLOR_ORIGINAL){
+                        echo self::css_secondary($settings['color_secondary'],$compatibility);
+                    }
                 ?>
 			</style>
 			<?php
 
 
-			/*
+            /*
 			 * We only add the <script> tags for code highlighting, so we strip them from the output.
 			 */
-			return str_replace( array(
-				'<style>',
-				'</style>'
-			), '', ob_get_clean());
-		}
-
-		public static function css_primary($color_code,$compatibility){;
-			$color_code = sanitize_hex_color($color_code);
-			if(!$color_code){return '';}
-			/**
-			 * c = color, b = background color, o = border-color, f = fill
-			 */
-			$selectors = array(
-				'a' => array('c'),
-				'.btn-primary' => array('b','o'),
-				'.btn-primary.disabled' => array('b','o'),
-				'.btn-primary:disabled' => array('b','o'),
-				'.btn-outline-primary' => array('c','o'),
-				'.btn-outline-primary:hover' => array('b','o'),
-				'.btn-outline-primary:not(:disabled):not(.disabled).active' => array('b','o'),
-				'.btn-outline-primary:not(:disabled):not(.disabled):active' => array('b','o'),
-				'.show>.btn-outline-primary.dropdown-toggle' => array('b','o'),
-				'.btn-link' => array('c'),
-				'.dropdown-item.active' => array('b'),
-				'.custom-control-input:checked~.custom-control-label::before' => array('b','o'),
-				'.custom-checkbox .custom-control-input:indeterminate~.custom-control-label::before' => array('b','o'),
+            return str_replace( array(
+                '<style>',
+                '</style>'
+            ), '', ob_get_clean());
+        }
+
+        public static function css_primary($color_code,$compatibility){;
+            $color_code = sanitize_hex_color($color_code);
+            if(!$color_code){return '';}
+            /**
+             * c = color, b = background color, o = border-color, f = fill
+             */
+            $selectors = array(
+                'a' => array('c'),
+                '.btn-primary' => array('b','o'),
+                '.btn-primary.disabled' => array('b','o'),
+                '.btn-primary:disabled' => array('b','o'),
+                '.btn-outline-primary' => array('c','o'),
+                '.btn-outline-primary:hover' => array('b','o'),
+                '.btn-outline-primary:not(:disabled):not(.disabled).active' => array('b','o'),
+                '.btn-outline-primary:not(:disabled):not(.disabled):active' => array('b','o'),
+                '.show>.btn-outline-primary.dropdown-toggle' => array('b','o'),
+                '.btn-link' => array('c'),
+                '.dropdown-item.active' => array('b'),
+                '.custom-control-input:checked~.custom-control-label::before' => array('b','o'),
+                '.custom-checkbox .custom-control-input:indeterminate~.custom-control-label::before' => array('b','o'),
 //				'.custom-range::-webkit-slider-thumb' => array('b'), // these break the inline rules...
 //				'.custom-range::-moz-range-thumb' => array('b'),
 //				'.custom-range::-ms-thumb' => array('b'),
-				'.nav-pills .nav-link.active' => array('b'),
-				'.nav-pills .show>.nav-link' => array('b'),
-				'.page-link' => array('c'),
-				'.page-item.active .page-link' => array('b','o'),
-				'.badge-primary' => array('b'),
-				'.alert-primary' => array('b','o'),
-				'.progress-bar' => array('b'),
-				'.list-group-item.active' => array('b','o'),
-				'.bg-primary' => array('b','f'),
-				'.btn-link.btn-primary' => array('c'),
-				'.select2-container .select2-results__option--highlighted.select2-results__option[aria-selected=true]' => array('b'),
-			);
-
-			$important_selectors = array(
-				'.bg-primary' => array('b','f'),
-				'.border-primary' => array('o'),
-				'.text-primary' => array('c'),
-			);
-
-			$color = array();
-			$color_i = array();
-			$background = array();
-			$background_i = array();
-			$border = array();
-			$border_i = array();
-			$fill = array();
-			$fill_i = array();
-
-			$output = '';
-
-			// build rules into each type
-			foreach($selectors as $selector => $types){
-				$selector = $compatibility ? ".bsui ".$selector : $selector;
-				$types = array_combine($types,$types);
-				if(isset($types['c'])){$color[] = $selector;}
-				if(isset($types['b'])){$background[] = $selector;}
-				if(isset($types['o'])){$border[] = $selector;}
-				if(isset($types['f'])){$fill[] = $selector;}
-			}
-
-			// build rules into each type
-			foreach($important_selectors as $selector => $types){
-				$selector = $compatibility ? ".bsui ".$selector : $selector;
-				$types = array_combine($types,$types);
-				if(isset($types['c'])){$color_i[] = $selector;}
-				if(isset($types['b'])){$background_i[] = $selector;}
-				if(isset($types['o'])){$border_i[] = $selector;}
-				if(isset($types['f'])){$fill_i[] = $selector;}
-			}
-
-			// add any color rules
-			if(!empty($color)){
-				$output .= implode(",",$color) . "{color: $color_code;} ";
-			}
-			if(!empty($color_i)){
-				$output .= implode(",",$color_i) . "{color: $color_code !important;} ";
-			}
-
-			// add any background color rules
-			if(!empty($background)){
-				$output .= implode(",",$background) . "{background-color: $color_code;} ";
-			}
-			if(!empty($background_i)){
-				$output .= implode(",",$background_i) . "{background-color: $color_code !important;} ";
-			}
-
-			// add any border color rules
-			if(!empty($border)){
-				$output .= implode(",",$border) . "{border-color: $color_code;} ";
-			}
-			if(!empty($border_i)){
-				$output .= implode(",",$border_i) . "{border-color: $color_code !important;} ";
-			}
-
-			// add any fill color rules
-			if(!empty($fill)){
-				$output .= implode(",",$fill) . "{fill: $color_code;} ";
-			}
-			if(!empty($fill_i)){
-				$output .= implode(",",$fill_i) . "{fill: $color_code !important;} ";
-			}
-
-
-			$prefix = $compatibility ? ".bsui " : "";
-
-			// darken
-			$darker_075 = self::css_hex_lighten_darken($color_code,"-0.075");
-			$darker_10 = self::css_hex_lighten_darken($color_code,"-0.10");
-			$darker_125 = self::css_hex_lighten_darken($color_code,"-0.125");
-
-			// lighten
-			$lighten_25 = self::css_hex_lighten_darken($color_code,"0.25");
-
-			// opacity see https://css-tricks.com/8-digit-hex-codes/
-			$op_25 = $color_code."40"; // 25% opacity
-
-
-			// button states
-			$output .= $prefix ." .btn-primary:hover{background-color: ".$darker_075.";    border-color: ".$darker_10.";} ";
-			$output .= $prefix ." .btn-outline-primary:not(:disabled):not(.disabled):active:focus, $prefix .btn-outline-primary:not(:disabled):not(.disabled).active:focus, .show>$prefix .btn-outline-primary.dropdown-toggle:focus{box-shadow: 0 0 0 0.2rem $op_25;} ";
-			$output .= $prefix ." .btn-primary:not(:disabled):not(.disabled):active, $prefix .btn-primary:not(:disabled):not(.disabled).active, .show>$prefix .btn-primary.dropdown-toggle{background-color: ".$darker_10.";    border-color: ".$darker_125.";} ";
-			$output .= $prefix ." .btn-primary:not(:disabled):not(.disabled):active:focus, $prefix .btn-primary:not(:disabled):not(.disabled).active:focus, .show>$prefix .btn-primary.dropdown-toggle:focus {box-shadow: 0 0 0 0.2rem $op_25;} ";
-
-
-			// dropdown's
-			$output .= $prefix ." .dropdown-item.active, $prefix .dropdown-item:active{background-color: $color_code;} ";
-
-
-			// input states
-			$output .= $prefix ." .form-control:focus{border-color: ".$lighten_25.";box-shadow: 0 0 0 0.2rem $op_25;} ";
-
-			// page link
-			$output .= $prefix ." .page-link:focus{box-shadow: 0 0 0 0.2rem $op_25;} ";
-
-			return $output;
-		}
-
-		public static function css_secondary($color_code,$compatibility){;
-			$color_code = sanitize_hex_color($color_code);
-			if(!$color_code){return '';}
-			/**
-			 * c = color, b = background color, o = border-color, f = fill
-			 */
-			$selectors = array(
-				'.btn-secondary' => array('b','o'),
-				'.btn-secondary.disabled' => array('b','o'),
-				'.btn-secondary:disabled' => array('b','o'),
-				'.btn-outline-secondary' => array('c','o'),
-				'.btn-outline-secondary:hover' => array('b','o'),
-				'.btn-outline-secondary.disabled' => array('c'),
-				'.btn-outline-secondary:disabled' => array('c'),
-				'.btn-outline-secondary:not(:disabled):not(.disabled):active' => array('b','o'),
-				'.btn-outline-secondary:not(:disabled):not(.disabled).active' => array('b','o'),
-				'.btn-outline-secondary.dropdown-toggle' => array('b','o'),
-				'.badge-secondary' => array('b'),
-				'.alert-secondary' => array('b','o'),
-				'.btn-link.btn-secondary' => array('c'),
-			);
-
-			$important_selectors = array(
-				'.bg-secondary' => array('b','f'),
-				'.border-secondary' => array('o'),
-				'.text-secondary' => array('c'),
-			);
-
-			$color = array();
-			$color_i = array();
-			$background = array();
-			$background_i = array();
-			$border = array();
-			$border_i = array();
-			$fill = array();
-			$fill_i = array();
-
-			$output = '';
-
-			// build rules into each type
-			foreach($selectors as $selector => $types){
-				$selector = $compatibility ? ".bsui ".$selector : $selector;
-				$types = array_combine($types,$types);
-				if(isset($types['c'])){$color[] = $selector;}
-				if(isset($types['b'])){$background[] = $selector;}
-				if(isset($types['o'])){$border[] = $selector;}
-				if(isset($types['f'])){$fill[] = $selector;}
-			}
-
-			// build rules into each type
-			foreach($important_selectors as $selector => $types){
-				$selector = $compatibility ? ".bsui ".$selector : $selector;
-				$types = array_combine($types,$types);
-				if(isset($types['c'])){$color_i[] = $selector;}
-				if(isset($types['b'])){$background_i[] = $selector;}
-				if(isset($types['o'])){$border_i[] = $selector;}
-				if(isset($types['f'])){$fill_i[] = $selector;}
-			}
-
-			// add any color rules
-			if(!empty($color)){
-				$output .= implode(",",$color) . "{color: $color_code;} ";
-			}
-			if(!empty($color_i)){
-				$output .= implode(",",$color_i) . "{color: $color_code !important;} ";
-			}
-
-			// add any background color rules
-			if(!empty($background)){
-				$output .= implode(",",$background) . "{background-color: $color_code;} ";
-			}
-			if(!empty($background_i)){
-				$output .= implode(",",$background_i) . "{background-color: $color_code !important;} ";
-			}
-
-			// add any border color rules
-			if(!empty($border)){
-				$output .= implode(",",$border) . "{border-color: $color_code;} ";
-			}
-			if(!empty($border_i)){
-				$output .= implode(",",$border_i) . "{border-color: $color_code !important;} ";
-			}
-
-			// add any fill color rules
-			if(!empty($fill)){
-				$output .= implode(",",$fill) . "{fill: $color_code;} ";
-			}
-			if(!empty($fill_i)){
-				$output .= implode(",",$fill_i) . "{fill: $color_code !important;} ";
-			}
-
-
-			$prefix = $compatibility ? ".bsui " : "";
-
-			// darken
-			$darker_075 = self::css_hex_lighten_darken($color_code,"-0.075");
-			$darker_10 = self::css_hex_lighten_darken($color_code,"-0.10");
-			$darker_125 = self::css_hex_lighten_darken($color_code,"-0.125");
-
-			// lighten
-			$lighten_25 = self::css_hex_lighten_darken($color_code,"0.25");
-
-			// opacity see https://css-tricks.com/8-digit-hex-codes/
-			$op_25 = $color_code."40"; // 25% opacity
-
-
-			// button states
-			$output .= $prefix ." .btn-secondary:hover{background-color: ".$darker_075.";    border-color: ".$darker_10.";} ";
-			$output .= $prefix ." .btn-outline-secondary:not(:disabled):not(.disabled):active:focus, $prefix .btn-outline-secondary:not(:disabled):not(.disabled).active:focus, .show>$prefix .btn-outline-secondary.dropdown-toggle:focus{box-shadow: 0 0 0 0.2rem $op_25;} ";
-			$output .= $prefix ." .btn-secondary:not(:disabled):not(.disabled):active, $prefix .btn-secondary:not(:disabled):not(.disabled).active, .show>$prefix .btn-secondary.dropdown-toggle{background-color: ".$darker_10.";    border-color: ".$darker_125.";} ";
-			$output .= $prefix ." .btn-secondary:not(:disabled):not(.disabled):active:focus, $prefix .btn-secondary:not(:disabled):not(.disabled).active:focus, .show>$prefix .btn-secondary.dropdown-toggle:focus {box-shadow: 0 0 0 0.2rem $op_25;} ";
-
-
-			return $output;
-		}
-
-		/**
-		 * Increases or decreases the brightness of a color by a percentage of the current brightness.
-		 *
-		 * @param   string  $hexCode        Supported formats: `#FFF`, `#FFFFFF`, `FFF`, `FFFFFF`
-		 * @param   float   $adjustPercent  A number between -1 and 1. E.g. 0.3 = 30% lighter; -0.4 = 40% darker.
-		 *
-		 * @return  string
-		 */
-		public static function css_hex_lighten_darken($hexCode, $adjustPercent) {
-			$hexCode = ltrim($hexCode, '#');
-
-			if (strlen($hexCode) == 3) {
-				$hexCode = $hexCode[0] . $hexCode[0] . $hexCode[1] . $hexCode[1] . $hexCode[2] . $hexCode[2];
-			}
-
-			$hexCode = array_map('hexdec', str_split($hexCode, 2));
-
-			foreach ($hexCode as & $color) {
-				$adjustableLimit = $adjustPercent < 0 ? $color : 255 - $color;
-				$adjustAmount = ceil($adjustableLimit * $adjustPercent);
-
-				$color = str_pad(dechex($color + $adjustAmount), 2, '0', STR_PAD_LEFT);
-			}
-
-			return '#' . implode($hexCode);
-		}
-
-		/**
-		 * Check if we should display examples.
-		 */
-		public function maybe_show_examples(){
-			if(current_user_can('manage_options') && isset($_REQUEST['preview-aui'])){
-				echo "<head>";
-				wp_head();
-				echo "</head>";
-				echo "<body>";
-				echo $this->get_examples();
-				echo "</body>";
-				exit;
-			}
-		}
-
-		/**
-		 * Get developer examples.
-		 *
-		 * @return string
-		 */
-		public function get_examples(){
-			$output = '';
-
-
-			// open form
-			$output .= "<form class='p-5 m-5 border rounded'>";
-
-			// input example
-			$output .= aui()->input(array(
-				'type'  =>  'text',
-				'id'    =>  'text-example',
-				'name'    =>  'text-example',
-				'placeholder'   => 'text placeholder',
-				'title'   => 'Text input example',
-				'value' =>  '',
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Text input example label'
-			));
-
-			// input example
-			$output .= aui()->input(array(
-				'type'  =>  'url',
-				'id'    =>  'text-example2',
-				'name'    =>  'text-example',
-				'placeholder'   => 'url placeholder',
-				'title'   => 'Text input example',
-				'value' =>  '',
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Text input example label'
-			));
-
-			// checkbox example
-			$output .= aui()->input(array(
-				'type'  =>  'checkbox',
-				'id'    =>  'checkbox-example',
-				'name'    =>  'checkbox-example',
-				'placeholder'   => 'checkbox-example',
-				'title'   => 'Checkbox example',
-				'value' =>  '1',
-				'checked'   => true,
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Checkbox checked'
-			));
-
-			// checkbox example
-			$output .= aui()->input(array(
-				'type'  =>  'checkbox',
-				'id'    =>  'checkbox-example2',
-				'name'    =>  'checkbox-example2',
-				'placeholder'   => 'checkbox-example',
-				'title'   => 'Checkbox example',
-				'value' =>  '1',
-				'checked'   => false,
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Checkbox un-checked'
-			));
-
-			// switch example
-			$output .= aui()->input(array(
-				'type'  =>  'checkbox',
-				'id'    =>  'switch-example',
-				'name'    =>  'switch-example',
-				'placeholder'   => 'checkbox-example',
-				'title'   => 'Switch example',
-				'value' =>  '1',
-				'checked'   => true,
-				'switch'    => true,
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Switch on'
-			));
-
-			// switch example
-			$output .= aui()->input(array(
-				'type'  =>  'checkbox',
-				'id'    =>  'switch-example2',
-				'name'    =>  'switch-example2',
-				'placeholder'   => 'checkbox-example',
-				'title'   => 'Switch example',
-				'value' =>  '1',
-				'checked'   => false,
-				'switch'    => true,
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Switch off'
-			));
-
-			// close form
-			$output .= "</form>";
-
-			return $output;
-		}
-
-	}
-
-	/**
-	 * Run the class if found.
-	 */
-	AyeCode_UI_Settings::instance();
+                '.nav-pills .nav-link.active' => array('b'),
+                '.nav-pills .show>.nav-link' => array('b'),
+                '.page-link' => array('c'),
+                '.page-item.active .page-link' => array('b','o'),
+                '.badge-primary' => array('b'),
+                '.alert-primary' => array('b','o'),
+                '.progress-bar' => array('b'),
+                '.list-group-item.active' => array('b','o'),
+                '.bg-primary' => array('b','f'),
+                '.btn-link.btn-primary' => array('c'),
+                '.select2-container .select2-results__option--highlighted.select2-results__option[aria-selected=true]' => array('b'),
+            );
+
+            $important_selectors = array(
+                '.bg-primary' => array('b','f'),
+                '.border-primary' => array('o'),
+                '.text-primary' => array('c'),
+            );
+
+            $color = array();
+            $color_i = array();
+            $background = array();
+            $background_i = array();
+            $border = array();
+            $border_i = array();
+            $fill = array();
+            $fill_i = array();
+
+            $output = '';
+
+            // build rules into each type
+            foreach($selectors as $selector => $types){
+                $selector = $compatibility ? ".bsui ".$selector : $selector;
+                $types = array_combine($types,$types);
+                if(isset($types['c'])){$color[] = $selector;}
+                if(isset($types['b'])){$background[] = $selector;}
+                if(isset($types['o'])){$border[] = $selector;}
+                if(isset($types['f'])){$fill[] = $selector;}
+            }
+
+            // build rules into each type
+            foreach($important_selectors as $selector => $types){
+                $selector = $compatibility ? ".bsui ".$selector : $selector;
+                $types = array_combine($types,$types);
+                if(isset($types['c'])){$color_i[] = $selector;}
+                if(isset($types['b'])){$background_i[] = $selector;}
+                if(isset($types['o'])){$border_i[] = $selector;}
+                if(isset($types['f'])){$fill_i[] = $selector;}
+            }
+
+            // add any color rules
+            if(!empty($color)){
+                $output .= implode(",",$color) . "{color: $color_code;} ";
+            }
+            if(!empty($color_i)){
+                $output .= implode(",",$color_i) . "{color: $color_code !important;} ";
+            }
+
+            // add any background color rules
+            if(!empty($background)){
+                $output .= implode(",",$background) . "{background-color: $color_code;} ";
+            }
+            if(!empty($background_i)){
+                $output .= implode(",",$background_i) . "{background-color: $color_code !important;} ";
+            }
+
+            // add any border color rules
+            if(!empty($border)){
+                $output .= implode(",",$border) . "{border-color: $color_code;} ";
+            }
+            if(!empty($border_i)){
+                $output .= implode(",",$border_i) . "{border-color: $color_code !important;} ";
+            }
+
+            // add any fill color rules
+            if(!empty($fill)){
+                $output .= implode(",",$fill) . "{fill: $color_code;} ";
+            }
+            if(!empty($fill_i)){
+                $output .= implode(",",$fill_i) . "{fill: $color_code !important;} ";
+            }
+
+
+            $prefix = $compatibility ? ".bsui " : "";
+
+            // darken
+            $darker_075 = self::css_hex_lighten_darken($color_code,"-0.075");
+            $darker_10 = self::css_hex_lighten_darken($color_code,"-0.10");
+            $darker_125 = self::css_hex_lighten_darken($color_code,"-0.125");
+
+            // lighten
+            $lighten_25 = self::css_hex_lighten_darken($color_code,"0.25");
+
+            // opacity see https://css-tricks.com/8-digit-hex-codes/
+            $op_25 = $color_code."40"; // 25% opacity
+
+
+            // button states
+            $output .= $prefix ." .btn-primary:hover{background-color: ".$darker_075.";    border-color: ".$darker_10.";} ";
+            $output .= $prefix ." .btn-outline-primary:not(:disabled):not(.disabled):active:focus, $prefix .btn-outline-primary:not(:disabled):not(.disabled).active:focus, .show>$prefix .btn-outline-primary.dropdown-toggle:focus{box-shadow: 0 0 0 0.2rem $op_25;} ";
+            $output .= $prefix ." .btn-primary:not(:disabled):not(.disabled):active, $prefix .btn-primary:not(:disabled):not(.disabled).active, .show>$prefix .btn-primary.dropdown-toggle{background-color: ".$darker_10.";    border-color: ".$darker_125.";} ";
+            $output .= $prefix ." .btn-primary:not(:disabled):not(.disabled):active:focus, $prefix .btn-primary:not(:disabled):not(.disabled).active:focus, .show>$prefix .btn-primary.dropdown-toggle:focus {box-shadow: 0 0 0 0.2rem $op_25;} ";
+
+
+            // dropdown's
+            $output .= $prefix ." .dropdown-item.active, $prefix .dropdown-item:active{background-color: $color_code;} ";
+
+
+            // input states
+            $output .= $prefix ." .form-control:focus{border-color: ".$lighten_25.";box-shadow: 0 0 0 0.2rem $op_25;} ";
+
+            // page link
+            $output .= $prefix ." .page-link:focus{box-shadow: 0 0 0 0.2rem $op_25;} ";
+
+            return $output;
+        }
+
+        public static function css_secondary($color_code,$compatibility){;
+            $color_code = sanitize_hex_color($color_code);
+            if(!$color_code){return '';}
+            /**
+             * c = color, b = background color, o = border-color, f = fill
+             */
+            $selectors = array(
+                '.btn-secondary' => array('b','o'),
+                '.btn-secondary.disabled' => array('b','o'),
+                '.btn-secondary:disabled' => array('b','o'),
+                '.btn-outline-secondary' => array('c','o'),
+                '.btn-outline-secondary:hover' => array('b','o'),
+                '.btn-outline-secondary.disabled' => array('c'),
+                '.btn-outline-secondary:disabled' => array('c'),
+                '.btn-outline-secondary:not(:disabled):not(.disabled):active' => array('b','o'),
+                '.btn-outline-secondary:not(:disabled):not(.disabled).active' => array('b','o'),
+                '.btn-outline-secondary.dropdown-toggle' => array('b','o'),
+                '.badge-secondary' => array('b'),
+                '.alert-secondary' => array('b','o'),
+                '.btn-link.btn-secondary' => array('c'),
+            );
+
+            $important_selectors = array(
+                '.bg-secondary' => array('b','f'),
+                '.border-secondary' => array('o'),
+                '.text-secondary' => array('c'),
+            );
+
+            $color = array();
+            $color_i = array();
+            $background = array();
+            $background_i = array();
+            $border = array();
+            $border_i = array();
+            $fill = array();
+            $fill_i = array();
+
+            $output = '';
+
+            // build rules into each type
+            foreach($selectors as $selector => $types){
+                $selector = $compatibility ? ".bsui ".$selector : $selector;
+                $types = array_combine($types,$types);
+                if(isset($types['c'])){$color[] = $selector;}
+                if(isset($types['b'])){$background[] = $selector;}
+                if(isset($types['o'])){$border[] = $selector;}
+                if(isset($types['f'])){$fill[] = $selector;}
+            }
+
+            // build rules into each type
+            foreach($important_selectors as $selector => $types){
+                $selector = $compatibility ? ".bsui ".$selector : $selector;
+                $types = array_combine($types,$types);
+                if(isset($types['c'])){$color_i[] = $selector;}
+                if(isset($types['b'])){$background_i[] = $selector;}
+                if(isset($types['o'])){$border_i[] = $selector;}
+                if(isset($types['f'])){$fill_i[] = $selector;}
+            }
+
+            // add any color rules
+            if(!empty($color)){
+                $output .= implode(",",$color) . "{color: $color_code;} ";
+            }
+            if(!empty($color_i)){
+                $output .= implode(",",$color_i) . "{color: $color_code !important;} ";
+            }
+
+            // add any background color rules
+            if(!empty($background)){
+                $output .= implode(",",$background) . "{background-color: $color_code;} ";
+            }
+            if(!empty($background_i)){
+                $output .= implode(",",$background_i) . "{background-color: $color_code !important;} ";
+            }
+
+            // add any border color rules
+            if(!empty($border)){
+                $output .= implode(",",$border) . "{border-color: $color_code;} ";
+            }
+            if(!empty($border_i)){
+                $output .= implode(",",$border_i) . "{border-color: $color_code !important;} ";
+            }
+
+            // add any fill color rules
+            if(!empty($fill)){
+                $output .= implode(",",$fill) . "{fill: $color_code;} ";
+            }
+            if(!empty($fill_i)){
+                $output .= implode(",",$fill_i) . "{fill: $color_code !important;} ";
+            }
+
+
+            $prefix = $compatibility ? ".bsui " : "";
+
+            // darken
+            $darker_075 = self::css_hex_lighten_darken($color_code,"-0.075");
+            $darker_10 = self::css_hex_lighten_darken($color_code,"-0.10");
+            $darker_125 = self::css_hex_lighten_darken($color_code,"-0.125");
+
+            // lighten
+            $lighten_25 = self::css_hex_lighten_darken($color_code,"0.25");
+
+            // opacity see https://css-tricks.com/8-digit-hex-codes/
+            $op_25 = $color_code."40"; // 25% opacity
+
+
+            // button states
+            $output .= $prefix ." .btn-secondary:hover{background-color: ".$darker_075.";    border-color: ".$darker_10.";} ";
+            $output .= $prefix ." .btn-outline-secondary:not(:disabled):not(.disabled):active:focus, $prefix .btn-outline-secondary:not(:disabled):not(.disabled).active:focus, .show>$prefix .btn-outline-secondary.dropdown-toggle:focus{box-shadow: 0 0 0 0.2rem $op_25;} ";
+            $output .= $prefix ." .btn-secondary:not(:disabled):not(.disabled):active, $prefix .btn-secondary:not(:disabled):not(.disabled).active, .show>$prefix .btn-secondary.dropdown-toggle{background-color: ".$darker_10.";    border-color: ".$darker_125.";} ";
+            $output .= $prefix ." .btn-secondary:not(:disabled):not(.disabled):active:focus, $prefix .btn-secondary:not(:disabled):not(.disabled).active:focus, .show>$prefix .btn-secondary.dropdown-toggle:focus {box-shadow: 0 0 0 0.2rem $op_25;} ";
+
+
+            return $output;
+        }
+
+        /**
+         * Increases or decreases the brightness of a color by a percentage of the current brightness.
+         *
+         * @param   string  $hexCode        Supported formats: `#FFF`, `#FFFFFF`, `FFF`, `FFFFFF`
+         * @param   float   $adjustPercent  A number between -1 and 1. E.g. 0.3 = 30% lighter; -0.4 = 40% darker.
+         *
+         * @return  string
+         */
+        public static function css_hex_lighten_darken($hexCode, $adjustPercent) {
+            $hexCode = ltrim($hexCode, '#');
+
+            if (strlen($hexCode) == 3) {
+                $hexCode = $hexCode[0] . $hexCode[0] . $hexCode[1] . $hexCode[1] . $hexCode[2] . $hexCode[2];
+            }
+
+            $hexCode = array_map('hexdec', str_split($hexCode, 2));
+
+            foreach ($hexCode as & $color) {
+                $adjustableLimit = $adjustPercent < 0 ? $color : 255 - $color;
+                $adjustAmount = ceil($adjustableLimit * $adjustPercent);
+
+                $color = str_pad(dechex($color + $adjustAmount), 2, '0', STR_PAD_LEFT);
+            }
+
+            return '#' . implode($hexCode);
+        }
+
+        /**
+         * Check if we should display examples.
+         */
+        public function maybe_show_examples(){
+            if(current_user_can('manage_options') && isset($_REQUEST['preview-aui'])){
+                echo "<head>";
+                wp_head();
+                echo "</head>";
+                echo "<body>";
+                echo $this->get_examples();
+                echo "</body>";
+                exit;
+            }
+        }
+
+        /**
+         * Get developer examples.
+         *
+         * @return string
+         */
+        public function get_examples(){
+            $output = '';
+
+
+            // open form
+            $output .= "<form class='p-5 m-5 border rounded'>";
+
+            // input example
+            $output .= aui()->input(array(
+                'type'  =>  'text',
+                'id'    =>  'text-example',
+                'name'    =>  'text-example',
+                'placeholder'   => 'text placeholder',
+                'title'   => 'Text input example',
+                'value' =>  '',
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Text input example label'
+            ));
+
+            // input example
+            $output .= aui()->input(array(
+                'type'  =>  'url',
+                'id'    =>  'text-example2',
+                'name'    =>  'text-example',
+                'placeholder'   => 'url placeholder',
+                'title'   => 'Text input example',
+                'value' =>  '',
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Text input example label'
+            ));
+
+            // checkbox example
+            $output .= aui()->input(array(
+                'type'  =>  'checkbox',
+                'id'    =>  'checkbox-example',
+                'name'    =>  'checkbox-example',
+                'placeholder'   => 'checkbox-example',
+                'title'   => 'Checkbox example',
+                'value' =>  '1',
+                'checked'   => true,
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Checkbox checked'
+            ));
+
+            // checkbox example
+            $output .= aui()->input(array(
+                'type'  =>  'checkbox',
+                'id'    =>  'checkbox-example2',
+                'name'    =>  'checkbox-example2',
+                'placeholder'   => 'checkbox-example',
+                'title'   => 'Checkbox example',
+                'value' =>  '1',
+                'checked'   => false,
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Checkbox un-checked'
+            ));
+
+            // switch example
+            $output .= aui()->input(array(
+                'type'  =>  'checkbox',
+                'id'    =>  'switch-example',
+                'name'    =>  'switch-example',
+                'placeholder'   => 'checkbox-example',
+                'title'   => 'Switch example',
+                'value' =>  '1',
+                'checked'   => true,
+                'switch'    => true,
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Switch on'
+            ));
+
+            // switch example
+            $output .= aui()->input(array(
+                'type'  =>  'checkbox',
+                'id'    =>  'switch-example2',
+                'name'    =>  'switch-example2',
+                'placeholder'   => 'checkbox-example',
+                'title'   => 'Switch example',
+                'value' =>  '1',
+                'checked'   => false,
+                'switch'    => true,
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Switch off'
+            ));
+
+            // close form
+            $output .= "</form>";
+
+            return $output;
+        }
+
+    }
+
+    /**
+     * Run the class if found.
+     */
+    AyeCode_UI_Settings::instance();
 }
\ No newline at end of file

includes/class-getpaid-invoice-notification-emails.php

Indentation +390 added lines, -390 removed lines

@@ -12,444 +12,444 @@
  */
 class GetPaid_Invoice_Notification_Emails {
 
-	/**
-	 * The array of invoice email actions.
-	 *
-	 * @param array
-	 */
-	public $invoice_actions;
-
-	/**
-	 * Class constructor
-	 *
-	 */
-	public function __construct() {
-
-		$this->invoice_actions = apply_filters(
-			'getpaid_notification_email_invoice_triggers',
-			array(
-				'getpaid_new_invoice'                   => array( 'new_invoice', 'user_invoice' ),
-				'getpaid_invoice_status_wpi-cancelled'  => 'cancelled_invoice',
-				'getpaid_invoice_status_wpi-failed'     => 'failed_invoice',
-				'getpaid_invoice_status_wpi-onhold'     => 'onhold_invoice',
-				'getpaid_invoice_status_wpi-processing' => 'processing_invoice',
-				'getpaid_invoice_status_publish'        => 'completed_invoice',
-				'getpaid_invoice_status_wpi-renewal'    => 'completed_invoice',
-				'getpaid_invoice_status_wpi-refunded'   => 'refunded_invoice',
-				'getpaid_new_customer_note'             => 'user_note',
-				'getpaid_daily_maintenance'             => 'overdue',
-			)
-		);
-
-		$this->init_hooks();
-
-	}
-
-	/**
-	 * Registers email hooks.
-	 */
-	public function init_hooks() {
-
-		add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 );
-		add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 );
-
-		foreach ( $this->invoice_actions as $hook => $email_type ) {
-			$this->init_email_type_hook( $hook, $email_type );
-		}
-	}
-
-	/**
-	 * Registers an email hook for an invoice action.
-	 * 
-	 * @param string $hook
-	 * @param string|array $email_type
-	 */
-	public function init_email_type_hook( $hook, $email_type ) {
-
-		$email_type = wpinv_parse_list( $email_type );
-
-		foreach ( $email_type as $type ) {
-
-			$email = new GetPaid_Notification_Email( $type );
-
-			// Abort if it is not active.
-			if ( ! $email->is_active() ) {
-				continue;
-			}
-
-			if ( method_exists( $this, $type ) ) {
-				add_action( $hook, array( $this, $type ), 100, 2 );
-				continue;
-			}
-
-			do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook );
-		}
-
-	}
-
-	/**
-	 * Filters invoice merge tags.
-	 *
-	 * @param array $merge_tags
-	 * @param mixed|WPInv_Invoice|WPInv_Subscription $object
-	 */
-	public function invoice_merge_tags( $merge_tags, $object ) {
-
-		if ( is_a( $object, 'WPInv_Invoice' ) ) {
-			return array_merge(
-				$merge_tags,
-				$this->get_invoice_merge_tags( $object )
-			);
-		}
-
-		if ( is_a( $object, 'WPInv_Subscription' ) ) {
-			return array_merge(
-				$merge_tags,
-				$this->get_invoice_merge_tags( $object->get_parent_payment() )
-			);
-		}
-
-		return $merge_tags;
-
-	}
-
-	/**
-	 * Generates invoice merge tags.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return array
-	 */
-	public function get_invoice_merge_tags( $invoice ) {
-
-		// Abort if it does not exist.
-		if ( ! $invoice->get_id() ) {
-			return array();
-		}
-
-		$merge_tags = array(
-			'{name}'                => sanitize_text_field( $invoice->get_user_full_name() ),
-			'{full_name}'           => sanitize_text_field( $invoice->get_user_full_name() ),
-			'{first_name}'          => sanitize_text_field( $invoice->get_first_name() ),
-			'{last_name}'           => sanitize_text_field( $invoice->get_last_name() ),
-			'{email}'               => sanitize_email( $invoice->get_email() ),
-			'{invoice_number}'      => sanitize_text_field( $invoice->get_number() ),
-			'{invoice_currency}'    => sanitize_text_field( $invoice->get_currency() ),
-			'{invoice_total}'       => wpinv_price( wpinv_format_amount( $invoice->get_total() ) ),
-			'{invoice_link}'        => esc_url( $invoice->get_view_url() ),
-			'{invoice_pay_link}'    => esc_url( $invoice->get_checkout_payment_url() ),
-			'{invoice_receipt_link}'=> esc_url( $invoice->get_receipt_url() ),
-			'{invoice_date}'        => getpaid_format_date_value( $invoice->get_date_created() ),
-			'{invoice_due_date}'    => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ),
-			'{invoice_quote}'       => sanitize_text_field( strtolower( $invoice->get_label() ) ),
-			'{invoice_label}'       => sanitize_text_field( ucfirst( $invoice->get_label() ) ),
-			'{invoice_description}' => wp_kses_post( $invoice->get_description() ),
-			'{subscription_name}'   => wp_kses_post( $invoice->get_subscription_name() ),
-			'{is_was}'              => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ),
-		);
-
-		return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice );
-	}
-
-	/**
-	 * Helper function to send an email.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Notification_Email $email
-	 * @param string $type
-	 * @param string|array $recipients
-	 * @param array $extra_args Extra template args.
-	 */
-	public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) {
-
-		do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email );
-
-		$mailer     = new GetPaid_Notification_Email_Sender();
-		$merge_tags = $email->get_merge_tags();
-
-		$result = $mailer->send(
-			apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ),
-			$email->add_merge_tags( $email->get_subject(), $merge_tags ),
-			$email->get_content( $merge_tags, $extra_args ),
-			$email->get_attachments()
-		);
-
-		// Maybe send a copy to the admin.
-		if ( $email->include_admin_bcc() ) {
-			$mailer->send(
-				wpinv_get_admin_email(),
-				$email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ),
-				$email->get_content( $merge_tags ),
-				$email->get_attachments()
-			);
-		}
-
-		if ( ! $result ) {
-			$invoice->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
-		}
-
-		do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email );
-
-		return $result;
-	}
-
-	/**
-	 * Also send emails to any cc users.
-	 *
-	 * @param array $recipients
-	 * @param GetPaid_Notification_Email $email
-	 */
-	public function filter_email_recipients( $recipients, $email ) {
-
-		if ( ! $email->is_admin_email() ) {
-			$cc = $email->object->get_email_cc();
-
-			if ( ! empty( $cc ) ) {
-				$cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
-				$recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
-			}
-
-		}
-
-		return $recipients;
-
-	}
-
-	/**
-	 * Sends a new invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function new_invoice( $invoice ) {
-
-		// Only send this email for invoices created via the admin page.
-		if ( ! $invoice->is_type( 'invoice' ) || $this->is_payment_form_invoice( $invoice->get_id() ) ) {
-			return;
-		}
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
-
-	}
-
-	/**
-	 * Sends a cancelled invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function cancelled_invoice( $invoice ) {
+    /**
+     * The array of invoice email actions.
+     *
+     * @param array
+     */
+    public $invoice_actions;
+
+    /**
+     * Class constructor
+     *
+     */
+    public function __construct() {
+
+        $this->invoice_actions = apply_filters(
+            'getpaid_notification_email_invoice_triggers',
+            array(
+                'getpaid_new_invoice'                   => array( 'new_invoice', 'user_invoice' ),
+                'getpaid_invoice_status_wpi-cancelled'  => 'cancelled_invoice',
+                'getpaid_invoice_status_wpi-failed'     => 'failed_invoice',
+                'getpaid_invoice_status_wpi-onhold'     => 'onhold_invoice',
+                'getpaid_invoice_status_wpi-processing' => 'processing_invoice',
+                'getpaid_invoice_status_publish'        => 'completed_invoice',
+                'getpaid_invoice_status_wpi-renewal'    => 'completed_invoice',
+                'getpaid_invoice_status_wpi-refunded'   => 'refunded_invoice',
+                'getpaid_new_customer_note'             => 'user_note',
+                'getpaid_daily_maintenance'             => 'overdue',
+            )
+        );
+
+        $this->init_hooks();
+
+    }
+
+    /**
+     * Registers email hooks.
+     */
+    public function init_hooks() {
+
+        add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 );
+        add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 );
+
+        foreach ( $this->invoice_actions as $hook => $email_type ) {
+            $this->init_email_type_hook( $hook, $email_type );
+        }
+    }
+
+    /**
+     * Registers an email hook for an invoice action.
+     * 
+     * @param string $hook
+     * @param string|array $email_type
+     */
+    public function init_email_type_hook( $hook, $email_type ) {
+
+        $email_type = wpinv_parse_list( $email_type );
+
+        foreach ( $email_type as $type ) {
+
+            $email = new GetPaid_Notification_Email( $type );
+
+            // Abort if it is not active.
+            if ( ! $email->is_active() ) {
+                continue;
+            }
+
+            if ( method_exists( $this, $type ) ) {
+                add_action( $hook, array( $this, $type ), 100, 2 );
+                continue;
+            }
+
+            do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook );
+        }
+
+    }
+
+    /**
+     * Filters invoice merge tags.
+     *
+     * @param array $merge_tags
+     * @param mixed|WPInv_Invoice|WPInv_Subscription $object
+     */
+    public function invoice_merge_tags( $merge_tags, $object ) {
+
+        if ( is_a( $object, 'WPInv_Invoice' ) ) {
+            return array_merge(
+                $merge_tags,
+                $this->get_invoice_merge_tags( $object )
+            );
+        }
+
+        if ( is_a( $object, 'WPInv_Subscription' ) ) {
+            return array_merge(
+                $merge_tags,
+                $this->get_invoice_merge_tags( $object->get_parent_payment() )
+            );
+        }
+
+        return $merge_tags;
+
+    }
+
+    /**
+     * Generates invoice merge tags.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return array
+     */
+    public function get_invoice_merge_tags( $invoice ) {
+
+        // Abort if it does not exist.
+        if ( ! $invoice->get_id() ) {
+            return array();
+        }
+
+        $merge_tags = array(
+            '{name}'                => sanitize_text_field( $invoice->get_user_full_name() ),
+            '{full_name}'           => sanitize_text_field( $invoice->get_user_full_name() ),
+            '{first_name}'          => sanitize_text_field( $invoice->get_first_name() ),
+            '{last_name}'           => sanitize_text_field( $invoice->get_last_name() ),
+            '{email}'               => sanitize_email( $invoice->get_email() ),
+            '{invoice_number}'      => sanitize_text_field( $invoice->get_number() ),
+            '{invoice_currency}'    => sanitize_text_field( $invoice->get_currency() ),
+            '{invoice_total}'       => wpinv_price( wpinv_format_amount( $invoice->get_total() ) ),
+            '{invoice_link}'        => esc_url( $invoice->get_view_url() ),
+            '{invoice_pay_link}'    => esc_url( $invoice->get_checkout_payment_url() ),
+            '{invoice_receipt_link}'=> esc_url( $invoice->get_receipt_url() ),
+            '{invoice_date}'        => getpaid_format_date_value( $invoice->get_date_created() ),
+            '{invoice_due_date}'    => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ),
+            '{invoice_quote}'       => sanitize_text_field( strtolower( $invoice->get_label() ) ),
+            '{invoice_label}'       => sanitize_text_field( ucfirst( $invoice->get_label() ) ),
+            '{invoice_description}' => wp_kses_post( $invoice->get_description() ),
+            '{subscription_name}'   => wp_kses_post( $invoice->get_subscription_name() ),
+            '{is_was}'              => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ),
+        );
+
+        return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice );
+    }
+
+    /**
+     * Helper function to send an email.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Notification_Email $email
+     * @param string $type
+     * @param string|array $recipients
+     * @param array $extra_args Extra template args.
+     */
+    public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) {
+
+        do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email );
+
+        $mailer     = new GetPaid_Notification_Email_Sender();
+        $merge_tags = $email->get_merge_tags();
+
+        $result = $mailer->send(
+            apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ),
+            $email->add_merge_tags( $email->get_subject(), $merge_tags ),
+            $email->get_content( $merge_tags, $extra_args ),
+            $email->get_attachments()
+        );
+
+        // Maybe send a copy to the admin.
+        if ( $email->include_admin_bcc() ) {
+            $mailer->send(
+                wpinv_get_admin_email(),
+                $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ),
+                $email->get_content( $merge_tags ),
+                $email->get_attachments()
+            );
+        }
+
+        if ( ! $result ) {
+            $invoice->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
+        }
+
+        do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email );
+
+        return $result;
+    }
+
+    /**
+     * Also send emails to any cc users.
+     *
+     * @param array $recipients
+     * @param GetPaid_Notification_Email $email
+     */
+    public function filter_email_recipients( $recipients, $email ) {
+
+        if ( ! $email->is_admin_email() ) {
+            $cc = $email->object->get_email_cc();
+
+            if ( ! empty( $cc ) ) {
+                $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
+                $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
+            }
+
+        }
+
+        return $recipients;
+
+    }
+
+    /**
+     * Sends a new invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function new_invoice( $invoice ) {
+
+        // Only send this email for invoices created via the admin page.
+        if ( ! $invoice->is_type( 'invoice' ) || $this->is_payment_form_invoice( $invoice->get_id() ) ) {
+            return;
+        }
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+
+    }
+
+    /**
+     * Sends a cancelled invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function cancelled_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a failed invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function failed_invoice( $invoice ) {
+    /**
+     * Sends a failed invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function failed_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is put on hold.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function onhold_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is put on hold.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function onhold_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is marked as processing payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function processing_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is marked as processing payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function processing_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is paid.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function completed_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is paid.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function completed_invoice( $invoice ) {
 
-		// (Maybe) abort if it is a renewal invoice.
-		if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) {
-			return;
-		}
+        // (Maybe) abort if it is a renewal invoice.
+        if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) {
+            return;
+        }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is refunded.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function refunded_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is refunded.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function refunded_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Notifies a user about new invoices
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function user_invoice( $invoice ) {
+    /**
+     * Notifies a user about new invoices
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function user_invoice( $invoice ) {
 
-		// Only send this email for invoices created via the admin page.
-		if ( ! $invoice->is_type( 'invoice' ) || $this->is_payment_form_invoice( $invoice->get_id() ) ) {
-			return;
-		}
+        // Only send this email for invoices created via the admin page.
+        if ( ! $invoice->is_type( 'invoice' ) || $this->is_payment_form_invoice( $invoice->get_id() ) ) {
+            return;
+        }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Checks if an invoice is a payment form invoice.
-	 *
-	 * @param int $invoice
-	 * @return bool
-	 */
-	public function is_payment_form_invoice( $invoice ) {
-		return empty( $_GET['getpaid-admin-action'] ) && 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true );
-	}
+    /**
+     * Checks if an invoice is a payment form invoice.
+     *
+     * @param int $invoice
+     * @return bool
+     */
+    public function is_payment_form_invoice( $invoice ) {
+        return empty( $_GET['getpaid-admin-action'] ) && 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true );
+    }
 
-	/**
-	 * Notifies admin about new invoice notes
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param string $note
-	 */
-	public function user_note( $invoice, $note ) {
+    /**
+     * Notifies admin about new invoice notes
+     *
+     * @param WPInv_Invoice $invoice
+     * @param string $note
+     */
+    public function user_note( $invoice, $note ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) );
-
-	}
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) );
+
+    }
 
-	/**
-	 * (Force) Sends overdue notices.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function force_send_overdue_notice( $invoice ) {
-		$email = new GetPaid_Notification_Email( 'overdue', $invoice );
-		return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() );
-	}
-
-	/**
-	 * Sends overdue notices.
-	 *
-	 * @TODO: Create an invoices query class.
-	 */
-	public function overdue() {
-		global $wpdb;
-
-		$email = new GetPaid_Notification_Email( __FUNCTION__ );
-
-		// Fetch reminder days.
-		$reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
-
-		// Abort if non is set.
-		if ( empty( $reminder_days ) ) {
-			return;
-		}
-
-		// Retrieve date query.
-		$date_query = $this->get_date_query( $reminder_days );
-
-		// Invoices table.
-		$table = $wpdb->prefix . 'getpaid_invoices';
-
-		// Fetch invoices.
-		$invoices  = $wpdb->get_col(
-			"SELECT posts.ID FROM $wpdb->posts as posts
+    /**
+     * (Force) Sends overdue notices.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function force_send_overdue_notice( $invoice ) {
+        $email = new GetPaid_Notification_Email( 'overdue', $invoice );
+        return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() );
+    }
+
+    /**
+     * Sends overdue notices.
+     *
+     * @TODO: Create an invoices query class.
+     */
+    public function overdue() {
+        global $wpdb;
+
+        $email = new GetPaid_Notification_Email( __FUNCTION__ );
+
+        // Fetch reminder days.
+        $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
+
+        // Abort if non is set.
+        if ( empty( $reminder_days ) ) {
+            return;
+        }
+
+        // Retrieve date query.
+        $date_query = $this->get_date_query( $reminder_days );
+
+        // Invoices table.
+        $table = $wpdb->prefix . 'getpaid_invoices';
+
+        // Fetch invoices.
+        $invoices  = $wpdb->get_col(
+            "SELECT posts.ID FROM $wpdb->posts as posts
 			LEFT JOIN $table as invoices ON invoices.post_id = posts.ID
 			WHERE posts.post_type = 'wpi_invoice' AND posts.post_status = 'wpi-pending' $date_query");
 
-		foreach ( $invoices as $invoice ) {
+        foreach ( $invoices as $invoice ) {
 
-			// Only send this email for invoices created via the admin page.
-			if ( ! $this->is_payment_form_invoice( $invoice ) ) {
-				$invoice       = new WPInv_Invoice( $invoice );
-				$email->object = $invoice;
+            // Only send this email for invoices created via the admin page.
+            if ( ! $this->is_payment_form_invoice( $invoice ) ) {
+                $invoice       = new WPInv_Invoice( $invoice );
+                $email->object = $invoice;
 
-				if ( $invoice->needs_payment() ) {
-					$this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() );
-				}
+                if ( $invoice->needs_payment() ) {
+                    $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() );
+                }
 
-			}
+            }
 
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Calculates the date query for an invoices query
-	 *
-	 * @param array $reminder_days
-	 * @return string
-	 */
-	public function get_date_query( $reminder_days ) {
+    /**
+     * Calculates the date query for an invoices query
+     *
+     * @param array $reminder_days
+     * @return string
+     */
+    public function get_date_query( $reminder_days ) {
 
-		$date_query = array(
-			'relation'  => 'OR'
-		);
+        $date_query = array(
+            'relation'  => 'OR'
+        );
 
-		foreach ( $reminder_days as $days ) {
-			$date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) );
+        foreach ( $reminder_days as $days ) {
+            $date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) );
 
-			$date_query[] = array(
-				'year'  => $date['year'],
-				'month' => $date['month'],
-				'day'   => $date['day'],
-			);
+            $date_query[] = array(
+                'year'  => $date['year'],
+                'month' => $date['month'],
+                'day'   => $date['day'],
+            );
 
-		}
+        }
 
-		$date_query = new WP_Date_Query( $date_query, 'invoices.due_date' );
+        $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' );
 
-		return $date_query->get_sql();
+        return $date_query->get_sql();
 
-	}
+    }
 
 }

widgets/getpaid.php

Indentation +102 added lines, -102 removed lines

@@ -36,36 +36,36 @@ 
                     'desc_tip'    => true,
                     'default'     => '',
                     'advanced'    => false
-				),
+                ),
 
                 'form'  => array(
-	                'title'       => __( 'Form', 'invoicing' ),
-	                'desc'        => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ),
-	                'type'        => 'text',
-	                'desc_tip'    => true,
-	                'default'     => '',
-	                'placeholder' => __('1','invoicing'),
-	                'advanced'    => false
-				),
-
-				'item'  => array(
-	                'title'       => __( 'Items', 'invoicing' ),
-	                'desc'        => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ),
-	                'type'        => 'text',
-	                'desc_tip'    => true,
-	                'default'     => '',
-	                'placeholder' => __('1','invoicing'),
-	                'advanced'    => false
-				),
+                    'title'       => __( 'Form', 'invoicing' ),
+                    'desc'        => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ),
+                    'type'        => 'text',
+                    'desc_tip'    => true,
+                    'default'     => '',
+                    'placeholder' => __('1','invoicing'),
+                    'advanced'    => false
+                ),
+
+                'item'  => array(
+                    'title'       => __( 'Items', 'invoicing' ),
+                    'desc'        => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ),
+                    'type'        => 'text',
+                    'desc_tip'    => true,
+                    'default'     => '',
+                    'placeholder' => __('1','invoicing'),
+                    'advanced'    => false
+                ),
 
                 'button'  => array(
-	                'title'       => __( 'Button', 'invoicing' ),
-	                'desc'        => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ),
-	                'type'        => 'text',
-	                'desc_tip'    => true,
-	                'default'     => '',
-	                'advanced'    => false
-				)
+                    'title'       => __( 'Button', 'invoicing' ),
+                    'desc'        => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ),
+                    'type'        => 'text',
+                    'desc_tip'    => true,
+                    'default'     => '',
+                    'advanced'    => false
+                )
 
             )
 
@@ -75,96 +75,96 @@ 
         parent::__construct( $options );
     }
 
-	/**
-	 * The Super block output function.
-	 *
-	 * @param array $args
-	 * @param array $widget_args
-	 * @param string $content
-	 *
-	 * @return string
-	 */
+    /**
+     * The Super block output function.
+     *
+     * @param array $args
+     * @param array $widget_args
+     * @param string $content
+     *
+     * @return string
+     */
     public function output( $args = array(), $widget_args = array(), $content = '' ) {
 
-	    // Is the shortcode set up correctly?
-		if ( empty( $args['form'] ) && empty( $args['item'] ) ) {
-			return aui()->alert(
-				array(
-					'type'    => 'warning',
-					'content' => __( 'No payment form or item selected', 'invoicing' ),
-				)
-			);
-		}
-
-		// Payment form or button?
-		if ( ! empty( $args['form'] ) ) {
-			return $this->handle_payment_form(  $args );
-		} else {
-			return $this->handle_buy_item(  $args );
-		}
-
-	}
-
-	/**
-	 * Displaying a payment form
-	 *
-	 * @return string
-	 */
+        // Is the shortcode set up correctly?
+        if ( empty( $args['form'] ) && empty( $args['item'] ) ) {
+            return aui()->alert(
+                array(
+                    'type'    => 'warning',
+                    'content' => __( 'No payment form or item selected', 'invoicing' ),
+                )
+            );
+        }
+
+        // Payment form or button?
+        if ( ! empty( $args['form'] ) ) {
+            return $this->handle_payment_form(  $args );
+        } else {
+            return $this->handle_buy_item(  $args );
+        }
+
+    }
+
+    /**
+     * Displaying a payment form
+     *
+     * @return string
+     */
     protected function handle_payment_form( $args = array() ) {
 
-		if ( empty( $args['button'] ) ) {
-			ob_start();
-			getpaid_display_payment_form( $args['form'] );
-			return ob_get_clean();
-		}
+        if ( empty( $args['button'] ) ) {
+            ob_start();
+            getpaid_display_payment_form( $args['form'] );
+            return ob_get_clean();
+        }
 
-		return $this->payment_form_button( $args['form'], $args['button'] );
-	}
+        return $this->payment_form_button( $args['form'], $args['button'] );
+    }
 
-	/**
-	 * Displays a payment form button.
-	 *
-	 * @return string
-	 */
+    /**
+     * Displays a payment form button.
+     *
+     * @return string
+     */
     protected function payment_form_button( $form, $button ) {
-		return getpaid_get_payment_button( $button, $form );
-	}
-
-	/**
-	 * Selling an item
-	 *
-	 * @return string
-	 */
+        return getpaid_get_payment_button( $button, $form );
+    }
+
+    /**
+     * Selling an item
+     *
+     * @return string
+     */
     protected function handle_buy_item( $args = array() ) {
 
-		if ( empty( $args['button'] ) ) {
-			return $this->buy_item_form( $args['item'] );
-		}
+        if ( empty( $args['button'] ) ) {
+            return $this->buy_item_form( $args['item'] );
+        }
 
-		return $this->buy_item_button( $args['item'], $args['button'] );
+        return $this->buy_item_button( $args['item'], $args['button'] );
 
-	}
+    }
 
-	/**
-	 * Displays a buy item form.
-	 *
-	 * @return string
-	 */
+    /**
+     * Displays a buy item form.
+     *
+     * @return string
+     */
     protected function buy_item_form( $item ) {
-		$items = getpaid_convert_items_to_array( $item );
-		ob_start();
-		getpaid_display_item_payment_form( $items );
-		return ob_get_clean();
-	}
-
-	/**
-	 * Displays a buy item button.
-	 *
-	 * @return string
-	 */
+        $items = getpaid_convert_items_to_array( $item );
+        ob_start();
+        getpaid_display_item_payment_form( $items );
+        return ob_get_clean();
+    }
+
+    /**
+     * Displays a buy item button.
+     *
+     * @return string
+     */
     protected function buy_item_button( $item, $button ) {
-		$button = getpaid_get_payment_button( $button, null, $item );
-		return apply_filters( 'getpaid_buy_item_button_widget', $button, $item );
+        $button = getpaid_get_payment_button( $button, null, $item );
+        return apply_filters( 'getpaid_buy_item_button_widget', $button, $item );
     }
 
 }

includes/gateways/class-getpaid-authorize-net-gateway.php

Indentation +226 added lines, -226 removed lines

@@ -13,58 +13,58 @@ 
 class GetPaid_Authorize_Net_Gateway extends GetPaid_Authorize_Net_Legacy_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'authorizenet';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription', 'sandbox', 'tokens', 'addons' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
+     * Payment method order.
+     *
+     * @var int
+     */
     public $order = 4;
 
     /**
-	 * Endpoint for requests from Authorize.net.
-	 *
-	 * @var string
-	 */
-	protected $notify_url;
-
-	/**
-	 * Endpoint for requests to Authorize.net.
-	 *
-	 * @var string
-	 */
+     * Endpoint for requests from Authorize.net.
+     *
+     * @var string
+     */
+    protected $notify_url;
+
+    /**
+     * Endpoint for requests to Authorize.net.
+     *
+     * @var string
+     */
     protected $endpoint;
 
     /**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' );
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' );
 
     /**
-	 * URL to view a transaction.
-	 *
-	 * @var string
-	 */
+     * URL to view a transaction.
+     *
+     * @var string
+     */
     public $view_transaction_url = 'https://{sandbox}authorize.net/ui/themes/sandbox/Transaction/TransactionReceipt.aspx?transid=%s';
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
 
         $this->title                = __( 'Credit Card / Debit Card', 'invoicing' );
         $this->method_title         = __( 'Authorize.Net', 'invoicing' );
@@ -76,11 +76,11 @@ 
     }
 
     /**
-	 * Displays the payment method select field.
-	 *
-	 * @param int $invoice_id 0 or invoice id.
-	 * @param GetPaid_Payment_Form $form Current payment form.
-	 */
+     * Displays the payment method select field.
+     *
+     * @param int $invoice_id 0 or invoice id.
+     * @param GetPaid_Payment_Form $form Current payment form.
+     */
     public function payment_fields( $invoice_id, $form ) {
 
         // Let the user select a payment method.
@@ -91,16 +91,16 @@ 
     }
 
     /**
-	 * Creates a customer profile.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
+     * Creates a customer profile.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
      * @param array $submission_data Posted checkout fields.
      * @param bool $save Whether or not to save the payment as a token.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile
-	 * @return string|WP_Error Payment profile id.
-	 */
-	public function create_customer_profile( $invoice, $submission_data, $save = true ) {
+     * @return string|WP_Error Payment profile id.
+     */
+    public function create_customer_profile( $invoice, $submission_data, $save = true ) {
 
         // Remove non-digits from the number
         $submission_data['authorizenet']['cc_number'] = preg_replace('/\D/', '', $submission_data['authorizenet']['cc_number'] );
@@ -167,14 +167,14 @@ 
     }
 
     /**
-	 * Retrieves a customer profile.
-	 *
-	 *
-	 * @param string $profile_id profile id.
-	 * @return string|WP_Error Profile id.
+     * Retrieves a customer profile.
+     *
+     *
+     * @param string $profile_id profile id.
+     * @return string|WP_Error Profile id.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile
-	 */
-	public function get_customer_profile( $profile_id ) {
+     */
+    public function get_customer_profile( $profile_id ) {
 
         // Generate args.
         $args = array(
@@ -189,17 +189,17 @@ 
     }
 
     /**
-	 * Creates a customer profile.
-	 *
-	 *
+     * Creates a customer profile.
+     *
+     *
      * @param string $profile_id profile id.
-	 * @param WPInv_Invoice $invoice Invoice.
+     * @param WPInv_Invoice $invoice Invoice.
      * @param array $submission_data Posted checkout fields.
      * @param bool $save Whether or not to save the payment as a token.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile
-	 * @return string|WP_Error Profile id.
-	 */
-	public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) {
+     * @return string|WP_Error Profile id.
+     */
+    public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) {
 
         // Remove non-digits from the number
         $submission_data['authorizenet']['cc_number'] = preg_replace('/\D/', '', $submission_data['authorizenet']['cc_number'] );
@@ -259,15 +259,15 @@ 
     }
 
     /**
-	 * Retrieves a customer payment profile.
-	 *
-	 *
-	 * @param string $customer_profile_id customer profile id.
+     * Retrieves a customer payment profile.
+     *
+     *
+     * @param string $customer_profile_id customer profile id.
      * @param string $payment_profile_id payment profile id.
-	 * @return string|WP_Error Profile id.
+     * @return string|WP_Error Profile id.
      * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile
-	 */
-	public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) {
+     */
+    public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) {
 
         // Generate args.
         $args = array(
@@ -283,15 +283,15 @@ 
     }
 
     /**
-	 * Charges a customer payment profile.
-	 *
+     * Charges a customer payment profile.
+     *
      * @param string $customer_profile_id customer profile id.
      * @param string $payment_profile_id payment profile id.
-	 * @param WPInv_Invoice $invoice Invoice.
+     * @param WPInv_Invoice $invoice Invoice.
      * @link https://developer.authorize.net/api/reference/index.html#payment-transactions-charge-a-customer-profile
-	 * @return WP_Error|object
-	 */
-	public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) {
+     * @return WP_Error|object
+     */
+    public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) {
 
         // Generate args.
         $args = array(
@@ -337,41 +337,41 @@ 
     }
 
     /**
-	 * Processes a customer charge.
-	 *
+     * Processes a customer charge.
+     *
      * @param stdClass $result Api response.
-	 * @param WPInv_Invoice $invoice Invoice.
-	 */
-	public function process_charge_response( $result, $invoice ) {
+     * @param WPInv_Invoice $invoice Invoice.
+     */
+    public function process_charge_response( $result, $invoice ) {
 
         wpinv_clear_errors();
-		$response_code = (int) $result->transactionResponse->responseCode;
+        $response_code = (int) $result->transactionResponse->responseCode;
 
-		// Succeeded.
-		if ( 1 == $response_code || 4 == $response_code ) {
+        // Succeeded.
+        if ( 1 == $response_code || 4 == $response_code ) {
 
-			// Maybe set a transaction id.
-			if ( ! empty( $result->transactionResponse->transId ) ) {
-				$invoice->set_transaction_id( $result->transactionResponse->transId );
-			}
+            // Maybe set a transaction id.
+            if ( ! empty( $result->transactionResponse->transId ) ) {
+                $invoice->set_transaction_id( $result->transactionResponse->transId );
+            }
 
-			$invoice->add_note( sprintf( __( 'Authentication code: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true );
+            $invoice->add_note( sprintf( __( 'Authentication code: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true );
 
-			if ( 1 == $response_code ) {
-				return $invoice->mark_paid();
-			}
+            if ( 1 == $response_code ) {
+                return $invoice->mark_paid();
+            }
 
-			$invoice->set_status( 'wpi-onhold' );
-        	$invoice->add_note(
+            $invoice->set_status( 'wpi-onhold' );
+            $invoice->add_note(
                 sprintf(
                     __( 'Held for review: %s', 'invoicing' ),
                     $result->transactionResponse->messages->message[0]->description
                 )
-			);
+            );
 
-			return $invoice->save();
+            return $invoice->save();
 
-		}
+        }
 
         wpinv_set_error( 'card_declined', __( 'Credit card declined.', 'invoicing' ) );
 
@@ -383,13 +383,13 @@ 
     }
 
     /**
-	 * Returns payment information.
-	 *
-	 *
-	 * @param array $card Card details.
-	 * @return array
-	 */
-	public function get_payment_information( $card ) {
+     * Returns payment information.
+     *
+     *
+     * @param array $card Card details.
+     * @return array
+     */
+    public function get_payment_information( $card ) {
         return array(
 
             'creditCard'         => array (
@@ -402,25 +402,25 @@ 
     }
 
     /**
-	 * Returns the customer profile meta name.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @return string
-	 */
-	public function get_customer_profile_meta_name( $invoice ) {
+     * Returns the customer profile meta name.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @return string
+     */
+    public function get_customer_profile_meta_name( $invoice ) {
         return $this->is_sandbox( $invoice ) ? 'getpaid_authorizenet_sandbox_customer_profile_id' : 'getpaid_authorizenet_customer_profile_id';
     }
 
     /**
-	 * Validates the submitted data.
-	 *
-	 *
-	 * @param array $submission_data Posted checkout fields.
+     * Validates the submitted data.
+     *
+     *
+     * @param array $submission_data Posted checkout fields.
      * @param WPInv_Invoice $invoice
-	 * @return WP_Error|string The payment profile id
-	 */
-	public function validate_submission_data( $submission_data, $invoice ) {
+     * @return WP_Error|string The payment profile id
+     */
+    public function validate_submission_data( $submission_data, $invoice ) {
 
         // Validate authentication details.
         $auth = $this->get_auth_params();
@@ -452,13 +452,13 @@ 
     }
 
     /**
-	 * Returns invoice line items.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @return array
-	 */
-	public function get_line_items( $invoice ) {
+     * Returns invoice line items.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @return array
+     */
+    public function get_line_items( $invoice ) {
         $items = array();
 
         foreach ( $invoice->get_items() as $item ) {
@@ -496,15 +496,15 @@ 
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Validate the submitted data.
         $payment_profile_id = $this->validate_submission_data( $submission_data, $invoice );
@@ -537,69 +537,69 @@ 
 
         exit;
 
-	}
+    }
 	
-	/**
-	 * Processes the initial payment.
-	 *
+    /**
+     * Processes the initial payment.
+     *
      * @param WPInv_Invoice $invoice Invoice.
-	 */
-	protected function process_initial_payment( $invoice ) {
+     */
+    protected function process_initial_payment( $invoice ) {
 
-		$payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
+        $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
         $customer_profile   = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true );
-		$result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice );
+        $result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice );
 
-		// Do we have an error?
-		if ( is_wp_error( $result ) ) {
-			wpinv_set_error( $result->get_error_code(), $result->get_error_message() );
-			wpinv_send_back_to_checkout( $invoice );
-		}
+        // Do we have an error?
+        if ( is_wp_error( $result ) ) {
+            wpinv_set_error( $result->get_error_code(), $result->get_error_message() );
+            wpinv_send_back_to_checkout( $invoice );
+        }
 
-		// Process the response.
-		$this->process_charge_response( $result, $invoice );
+        // Process the response.
+        $this->process_charge_response( $result, $invoice );
 
-		if ( wpinv_get_errors() ) {
-			wpinv_send_back_to_checkout( $invoice );
-		}
+        if ( wpinv_get_errors() ) {
+            wpinv_send_back_to_checkout( $invoice );
+        }
 
-	}
+    }
 
     /**
-	 * Processes recurring payments.
-	 *
+     * Processes recurring payments.
+     *
      * @param WPInv_Invoice $invoice Invoice.
      * @param WPInv_Subscription $subscription Subscription.
-	 */
-	public function process_subscription( $invoice, $subscription ) {
+     */
+    public function process_subscription( $invoice, $subscription ) {
 
         // Check if there is an initial amount to charge.
         if ( (float) $invoice->get_total() > 0 ) {
-			$this->process_initial_payment( $invoice );
+            $this->process_initial_payment( $invoice );
         }
 
         // Activate the subscription.
         $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
         $expiry   = date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) );
 
-		$subscription->set_next_renewal_date( $expiry );
-		$subscription->set_date_created( current_time( 'mysql' ) );
-		$subscription->set_profile_id( $invoice->generate_key() );
-		$subscription->activate();
+        $subscription->set_next_renewal_date( $expiry );
+        $subscription->set_date_created( current_time( 'mysql' ) );
+        $subscription->set_profile_id( $invoice->generate_key() );
+        $subscription->activate();
 
-		// Redirect to the success page.
+        // Redirect to the success page.
         wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
 
     }
 
-	/**
-	 * (Maybe) renews an authorize.net subscription profile.
-	 *
-	 *
-	 * @param bool $should_expire
+    /**
+     * (Maybe) renews an authorize.net subscription profile.
+     *
+     *
+     * @param bool $should_expire
      * @param WPInv_Subscription $subscription
-	 */
-	public function maybe_renew_subscription( $should_expire, $subscription ) {
+     */
+    public function maybe_renew_subscription( $should_expire, $subscription ) {
 
         // Ensure its our subscription && it's active.
         if ( $this->id != $subscription->get_gateway() || ! $subscription->has_status( 'active trialling' ) ) {
@@ -616,18 +616,18 @@ 
 
         return false;
 
-	}
+    }
 
     /**
-	 * Renews a subscription.
-	 *
+     * Renews a subscription.
+     *
      * @param WPInv_Subscription $subscription
-	 */
-	public function renew_subscription( $subscription ) {
+     */
+    public function renew_subscription( $subscription ) {
 
-		// Generate the renewal invoice.
-		$new_invoice = $subscription->create_payment();
-		$old_invoice = $subscription->get_parent_payment();
+        // Generate the renewal invoice.
+        $new_invoice = $subscription->create_payment();
+        $old_invoice = $subscription->get_parent_payment();
 
         if ( empty( $new_invoice ) ) {
             $old_invoice->add_note( __( 'Error generating a renewal invoice.', 'invoicing' ), false, false, false );
@@ -636,37 +636,37 @@ 
         }
 
         // Charge the payment method.
-		$payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
-		$customer_profile   = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true );
-		$result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice );
-
-		// Do we have an error?
-		if ( is_wp_error( $result ) ) {
-
-			$old_invoice->add_note(
-				sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ),
-				true,
-				false,
-				true
-			);
-			$subscription->failing();
-			return;
-
-		}
-
-		// Process the response.
-		$this->process_charge_response( $result, $new_invoice );
-
-		if ( wpinv_get_errors() ) {
-
-			$old_invoice->add_note(
-				sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ),
-				true,
-				false,
-				true
-			);
-			$subscription->failing();
-			return;
+        $payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
+        $customer_profile   = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true );
+        $result             = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice );
+
+        // Do we have an error?
+        if ( is_wp_error( $result ) ) {
+
+            $old_invoice->add_note(
+                sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ),
+                true,
+                false,
+                true
+            );
+            $subscription->failing();
+            return;
+
+        }
+
+        // Process the response.
+        $this->process_charge_response( $result, $new_invoice );
+
+        if ( wpinv_get_errors() ) {
+
+            $old_invoice->add_note(
+                sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ),
+                true,
+                false,
+                true
+            );
+            $subscription->failing();
+            return;
 
         }
 
@@ -675,13 +675,13 @@ 
     }
 
     /**
-	 * Processes invoice addons.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	public function process_addons( $invoice, $items ) {
+     * Processes invoice addons.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    public function process_addons( $invoice, $items ) {
 
         global $getpaid_authorize_addons;
 
@@ -701,7 +701,7 @@ 
         $invoice->recalculate_total();
 
         $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true );
-		$customer_profile   = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true );
+        $customer_profile   = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true );
 
         add_filter( 'getpaid_authorizenet_charge_customer_payment_profile_args', array( $this, 'filter_addons_request' ), 10, 2 );
         $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice );
@@ -716,11 +716,11 @@ 
     }
 
     /**
-	 * Processes invoice addons.
-	 *
+     * Processes invoice addons.
+     *
      * @param array $args
-	 * @return array
-	 */
+     * @return array
+     */
     public function filter_addons_request( $args ) {
 
         global $getpaid_authorize_addons;
@@ -754,11 +754,11 @@ 
     }
 
     /**
-	 * Filters the gateway settings.
-	 *
-	 * @param array $admin_settings
-	 */
-	public function admin_settings( $admin_settings ) {
+     * Filters the gateway settings.
+     *
+     * @param array $admin_settings
+     */
+    public function admin_settings( $admin_settings ) {
 
         $currencies = sprintf(
             __( 'Supported Currencies: %s', 'invoicing' ),
@@ -798,7 +798,7 @@ 
             'readonly' => true,
         );
 
-		return $admin_settings;
-	}
+        return $admin_settings;
+    }
 
 }

includes/wpinv-payment-functions.php

Indentation +1 added lines, -1 removed lines

@@ -235,7 +235,7 @@
         do_action( 'getpaid_checkout_invoice_exception', $invoice );
     }
 
-	// Do we have any errors?
+    // Do we have any errors?
     if ( wpinv_get_errors() ) {
         wp_send_json_error( getpaid_get_errors_html( true, false ) );
     }

includes/payments/class-getpaid-checkout.php

Indentation +246 added lines, -246 removed lines

@@ -12,176 +12,176 @@ 
  */
 class GetPaid_Checkout {
 
-	/**
-	 * @var GetPaid_Payment_Form_Submission
-	 */
-	protected $payment_form_submission;
-
-	/**
-	 * Class constructor.
-	 * 
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-		$this->payment_form_submission = $submission;
-	}
-
-	/**
-	 * Processes the checkout.
-	 *
-	 */
-	public function process_checkout() {
-
-		// Validate the submission.
-		$this->validate_submission();
-
-		// Prepare the invoice.
-		$items      = $this->get_submission_items();
-		$invoice    = $this->get_submission_invoice();
-		$invoice    = $this->process_submission_invoice( $invoice, $items );
-		$prepared   = $this->prepare_submission_data_for_saving();
-
-		$this->prepare_billing_info( $invoice );
-
-		$shipping   = $this->prepare_shipping_info( $invoice );
-
-		// Save the invoice.
-		$invoice->recalculate_total();
+    /**
+     * @var GetPaid_Payment_Form_Submission
+     */
+    protected $payment_form_submission;
+
+    /**
+     * Class constructor.
+     * 
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+        $this->payment_form_submission = $submission;
+    }
+
+    /**
+     * Processes the checkout.
+     *
+     */
+    public function process_checkout() {
+
+        // Validate the submission.
+        $this->validate_submission();
+
+        // Prepare the invoice.
+        $items      = $this->get_submission_items();
+        $invoice    = $this->get_submission_invoice();
+        $invoice    = $this->process_submission_invoice( $invoice, $items );
+        $prepared   = $this->prepare_submission_data_for_saving();
+
+        $this->prepare_billing_info( $invoice );
+
+        $shipping   = $this->prepare_shipping_info( $invoice );
+
+        // Save the invoice.
+        $invoice->recalculate_total();
         $invoice->save();
 
-		do_action( 'getpaid_checkout_invoice_updated', $invoice );
+        do_action( 'getpaid_checkout_invoice_updated', $invoice );
 
-		// Send to the gateway.
-		$this->post_process_submission( $invoice, $prepared, $shipping );
-	}
+        // Send to the gateway.
+        $this->post_process_submission( $invoice, $prepared, $shipping );
+    }
 
-	/**
-	 * Validates the submission.
-	 *
-	 */
-	protected function validate_submission() {
+    /**
+     * Validates the submission.
+     *
+     */
+    protected function validate_submission() {
 
-		$submission = $this->payment_form_submission;
-		$data       = $submission->get_data();
+        $submission = $this->payment_form_submission;
+        $data       = $submission->get_data();
 
-		// Do we have an error?
+        // Do we have an error?
         if ( ! empty( $submission->last_error ) ) {
-			wp_send_json_error( $submission->last_error );
+            wp_send_json_error( $submission->last_error );
         }
 
-		// We need a billing email.
+        // We need a billing email.
         if ( ! $submission->has_billing_email() ) {
             wp_send_json_error( __( 'Provide a valid billing email.', 'invoicing' ) );
-		}
+        }
 
-		// Non-recurring gateways should not be allowed to process recurring invoices.
-		if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
-			wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
-		}
+        // Non-recurring gateways should not be allowed to process recurring invoices.
+        if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
+            wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
+        }
 
-		// Ensure the gateway is active.
-		if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
-			wpinv_set_error( 'invalid_gateway', __( 'The selected payment gateway is not active', 'invoicing' ) );
-		}
+        // Ensure the gateway is active.
+        if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
+            wpinv_set_error( 'invalid_gateway', __( 'The selected payment gateway is not active', 'invoicing' ) );
+        }
 
-		// Clear any existing errors.
-		wpinv_clear_errors();
+        // Clear any existing errors.
+        wpinv_clear_errors();
 
-		// Allow themes and plugins to hook to errors
-		do_action( 'getpaid_checkout_error_checks', $submission );
+        // Allow themes and plugins to hook to errors
+        do_action( 'getpaid_checkout_error_checks', $submission );
 
-		// Do we have any errors?
+        // Do we have any errors?
         if ( wpinv_get_errors() ) {
             wp_send_json_error( getpaid_get_errors_html() );
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Retrieves submission items.
-	 *
-	 * @return GetPaid_Form_Item[]
-	 */
-	protected function get_submission_items() {
+    /**
+     * Retrieves submission items.
+     *
+     * @return GetPaid_Form_Item[]
+     */
+    protected function get_submission_items() {
 
-		$items = $this->payment_form_submission->get_items();
+        $items = $this->payment_form_submission->get_items();
 
         // Ensure that we have items.
         if ( empty( $items ) && ! $this->payment_form_submission->has_fees() ) {
             wp_send_json_error( __( 'Please provide at least one item or amount.', 'invoicing' ) );
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Retrieves submission invoice.
-	 *
-	 * @return WPInv_Invoice
-	 */
-	protected function get_submission_invoice() {
-		$submission = $this->payment_form_submission;
-
-		if ( ! $submission->has_invoice() ) {
-			$invoice = new WPInv_Invoice();
-			$invoice->created_via( 'payment_form' );
-			return $invoice;
         }
 
-		$invoice = $submission->get_invoice();
+        return $items;
+    }
 
-		// Make sure that it is neither paid or refunded.
-		if ( $invoice->is_paid() || $invoice->is_refunded() ) {
-			wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
-		}
+    /**
+     * Retrieves submission invoice.
+     *
+     * @return WPInv_Invoice
+     */
+    protected function get_submission_invoice() {
+        $submission = $this->payment_form_submission;
 
-		return $invoice;
-	}
+        if ( ! $submission->has_invoice() ) {
+            $invoice = new WPInv_Invoice();
+            $invoice->created_via( 'payment_form' );
+            return $invoice;
+        }
 
-	/**
-	 * Processes the submission invoice.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	protected function process_submission_invoice( $invoice, $items ) {
+        $invoice = $submission->get_invoice();
 
-		$submission = $this->payment_form_submission;
-		$data       = $submission->get_data();
+        // Make sure that it is neither paid or refunded.
+        if ( $invoice->is_paid() || $invoice->is_refunded() ) {
+            wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
+        }
 
-		// Set-up the invoice details.
-		$invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
-		$invoice->set_user_id( $this->get_submission_customer() );
-		$invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
+        return $invoice;
+    }
+
+    /**
+     * Processes the submission invoice.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    protected function process_submission_invoice( $invoice, $items ) {
+
+        $submission = $this->payment_form_submission;
+        $data       = $submission->get_data();
+
+        // Set-up the invoice details.
+        $invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
+        $invoice->set_user_id( $this->get_submission_customer() );
+        $invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
         $invoice->set_items( $items );
         $invoice->set_fees( $submission->get_fees() );
         $invoice->set_taxes( $submission->get_taxes() );
-		$invoice->set_discounts( $submission->get_discounts() );
-		$invoice->set_gateway( $data['wpi-gateway'] );
+        $invoice->set_discounts( $submission->get_discounts() );
+        $invoice->set_gateway( $data['wpi-gateway'] );
 
-		if ( $submission->has_discount_code() ) {
+        if ( $submission->has_discount_code() ) {
             $invoice->set_discount_code( $submission->get_discount_code() );
-		}
-
-		getpaid_maybe_add_default_address( $invoice );
-		return $invoice;
-	}
-
-	/**
-	 * Retrieves the submission's customer.
-	 *
-	 * @return int The customer id.
-	 */
-	protected function get_submission_customer() {
-		$submission = $this->payment_form_submission;
-
-		// If this is an existing invoice...
-		if ( $submission->has_invoice() ) {
-			return $submission->get_invoice()->get_user_id();
-		}
-
-		// (Maybe) create the user.
+        }
+
+        getpaid_maybe_add_default_address( $invoice );
+        return $invoice;
+    }
+
+    /**
+     * Retrieves the submission's customer.
+     *
+     * @return int The customer id.
+     */
+    protected function get_submission_customer() {
+        $submission = $this->payment_form_submission;
+
+        // If this is an existing invoice...
+        if ( $submission->has_invoice() ) {
+            return $submission->get_invoice()->get_user_id();
+        }
+
+        // (Maybe) create the user.
         $user = get_current_user_id();
 
         if ( empty( $user ) ) {
@@ -198,31 +198,31 @@ 
 
         if ( is_numeric( $user ) ) {
             return $user;
-		}
+        }
 
-		return $user->ID;
+        return $user->ID;
 
-	}
+    }
 
-	/**
+    /**
      * Prepares submission data for saving to the database.
      *
-	 * @return array
+     * @return array
      */
     public function prepare_submission_data_for_saving() {
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Prepared submission details.
+        // Prepared submission details.
         $prepared = array();
 
         // Raw submission details.
-		$data     = $submission->get_data();
+        $data     = $submission->get_data();
 
-		// Loop through the submitted details.
+        // Loop through the submitted details.
         foreach ( $submission->get_payment_form()->get_elements() as $field ) {
 
-			// Skip premade fields.
+            // Skip premade fields.
             if ( ! empty( $field['premade'] ) || $field['type'] == 'address' ) {
                 continue;
             }
@@ -240,93 +240,93 @@ 
                     $label = $field['label'];
                 }
 
-				$prepared[ wpinv_clean( $label ) ] = wp_kses_post( $data[ $field['id'] ] );
+                $prepared[ wpinv_clean( $label ) ] = wp_kses_post( $data[ $field['id'] ] );
 
             }
 
-		}
+        }
 
-		return $prepared;
+        return $prepared;
 
-	}
+    }
 
-	/**
+    /**
      * Retrieves address details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
-	 * @param string $type
+     * @return array
+     * @param WPInv_Invoice $invoice
+     * @param string $type
      */
     public function prepare_address_details( $invoice, $type = 'billing' ) {
 
-		$data     = $this->payment_form_submission->get_data();
-		$type     = sanitize_key( $type );
-		$address  = array();
-		$prepared = array();
+        $data     = $this->payment_form_submission->get_data();
+        $type     = sanitize_key( $type );
+        $address  = array();
+        $prepared = array();
 
-		if ( ! empty( $data[ $type ] ) ) {
-			$address = $data[ $type ];
-		}
+        if ( ! empty( $data[ $type ] ) ) {
+            $address = $data[ $type ];
+        }
 
-		// Clean address details.
-		foreach ( $address as $key => $value ) {
-			$key             = sanitize_key( $key );
-			$key             = str_replace( 'wpinv_', '', $key );
-			$value           = wpinv_clean( $value );
-			$prepared[ $key] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
-		}
+        // Clean address details.
+        foreach ( $address as $key => $value ) {
+            $key             = sanitize_key( $key );
+            $key             = str_replace( 'wpinv_', '', $key );
+            $value           = wpinv_clean( $value );
+            $prepared[ $key] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
+        }
 
-		// Filter address details.
-		$prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
+        // Filter address details.
+        $prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
 
-		// Remove non-whitelisted values.
-		return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
+        // Remove non-whitelisted values.
+        return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the billing details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_billing_info( &$invoice ) {
 
-		$billing_address = $this->prepare_address_details( $invoice, 'billing' );
+        $billing_address = $this->prepare_address_details( $invoice, 'billing' );
 
-		// Update the invoice with the billing details.
-		$invoice->set_props( $billing_address );
+        // Update the invoice with the billing details.
+        $invoice->set_props( $billing_address );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the shipping details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_shipping_info( $invoice ) {
 
-		$data = $this->payment_form_submission->get_data();
+        $data = $this->payment_form_submission->get_data();
 
-		if ( empty( $data['same-shipping-address'] ) ) {
-			return $this->prepare_address_details( $invoice, 'shipping' );
-		}
+        if ( empty( $data['same-shipping-address'] ) ) {
+            return $this->prepare_address_details( $invoice, 'shipping' );
+        }
 
-		return $this->prepare_address_details( $invoice, 'billing' );
+        return $this->prepare_address_details( $invoice, 'billing' );
 
-	}
+    }
 
-	/**
-	 * Confirms the submission is valid and send users to the gateway.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param array $prepared_payment_form_data
-	 * @param array $shipping
-	 */
-	protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
+    /**
+     * Confirms the submission is valid and send users to the gateway.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param array $prepared_payment_form_data
+     * @param array $shipping
+     */
+    protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
 
-		// Ensure the invoice exists.
+        // Ensure the invoice exists.
         if ( ! $invoice->exists() ) {
             wp_send_json_error( __( 'An error occured while saving your invoice. Please try again.', 'invoicing' ) );
         }
@@ -334,81 +334,81 @@ 
         // Save payment form data.
         if ( ! empty( $prepared_payment_form_data ) ) {
             update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data );
-		}
+        }
 
-		// Save payment form data.
+        // Save payment form data.
         if ( ! empty( $shipping ) ) {
             update_post_meta( $invoice->get_id(), 'shipping_address', $shipping );
-		}
+        }
 
-		// Backwards compatibility.
+        // Backwards compatibility.
         add_filter( 'wp_redirect', array( $this, 'send_redirect_response' ) );
 
-		$this->process_payment( $invoice );
+        $this->process_payment( $invoice );
 
         // If we are here, there was an error.
-		wpinv_send_back_to_checkout( $invoice );
+        wpinv_send_back_to_checkout( $invoice );
 
-	}
+    }
 
-	/**
-	 * Processes the actual payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_payment( $invoice ) {
+    /**
+     * Processes the actual payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_payment( $invoice ) {
 
-		// Clear any checkout errors.
-		wpinv_clear_errors();
+        // Clear any checkout errors.
+        wpinv_clear_errors();
 
-		// No need to send free invoices to the gateway.
-		if ( $invoice->is_free() ) {
-			$this->process_free_payment( $invoice );
-		}
+        // No need to send free invoices to the gateway.
+        if ( $invoice->is_free() ) {
+            $this->process_free_payment( $invoice );
+        }
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Fires before sending to the gateway.
-		do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
+        // Fires before sending to the gateway.
+        do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
 
-		// Allow the sumission data to be modified before it is sent to the gateway.
-		$submission_data    = $submission->get_data();
-		$submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
-		$submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
+        // Allow the sumission data to be modified before it is sent to the gateway.
+        $submission_data    = $submission->get_data();
+        $submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
+        $submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
 
-		// Validate the currency.
-		if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
-			wpinv_set_error( 'invalid_currency', __( 'The chosen payment gateway does not support this currency', 'invoicing' ) );
-		}
+        // Validate the currency.
+        if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
+            wpinv_set_error( 'invalid_currency', __( 'The chosen payment gateway does not support this currency', 'invoicing' ) );
+        }
 
-		// Check to see if we have any errors.
-		if ( wpinv_get_errors() ) {
-			wpinv_send_back_to_checkout( $invoice );
-		}
+        // Check to see if we have any errors.
+        if ( wpinv_get_errors() ) {
+            wpinv_send_back_to_checkout( $invoice );
+        }
 
-		// Send info to the gateway for payment processing
-		do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
+        // Send info to the gateway for payment processing
+        do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
 
-		// Backwards compatibility.
-		wpinv_send_to_gateway( $submission_gateway, $invoice );
+        // Backwards compatibility.
+        wpinv_send_to_gateway( $submission_gateway, $invoice );
 
-	}
+    }
 
-	/**
-	 * Marks the invoice as paid in case the checkout is free.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_free_payment( $invoice ) {
+    /**
+     * Marks the invoice as paid in case the checkout is free.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_free_payment( $invoice ) {
 
-		$invoice->set_gateway( 'none' );
-		$invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
-		$invoice->mark_paid();
-		wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
+        $invoice->set_gateway( 'none' );
+        $invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
+        $invoice->mark_paid();
+        wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
 
-	}
+    }
 
-	/**
+    /**
      * Sends a redrect response to payment details.
      *
      */

includes/geolocation/class-getpaid-geolocation.php

Indentation +259 added lines, -259 removed lines

@@ -13,264 +13,264 @@
  */
 class GetPaid_Geolocation {
 
-	/**
-	 * Holds the current user's IP Address.
-	 *
-	 * @var string
-	 */
-	public static $current_user_ip;
-
-	/**
-	 * API endpoints for looking up a user IP address.
-	 *
-	 * For example, in case a user is on localhost.
-	 *
-	 * @var array
-	 */
-	protected static $ip_lookup_apis = array(
-		'ipify'             => 'http://api.ipify.org/',
-		'ipecho'            => 'http://ipecho.net/plain',
-		'ident'             => 'http://ident.me',
-		'whatismyipaddress' => 'http://bot.whatismyipaddress.com',
-	);
-
-	/**
-	 * API endpoints for geolocating an IP address
-	 *
-	 * @var array
-	 */
-	protected static $geoip_apis = array(
-		'ip-api.com' => 'http://ip-api.com/json/%s',
-		'ipinfo.io'  => 'https://ipinfo.io/%s/json',
-	);
-
-	/**
-	 * Get current user IP Address.
-	 *
-	 * @return string
-	 */
-	public static function get_ip_address() {
-		return wpinv_get_ip();
-	}
-
-	/**
-	 * Get user IP Address using an external service.
-	 * This can be used as a fallback for users on localhost where
-	 * get_ip_address() will be a local IP and non-geolocatable.
-	 *
-	 * @return string
-	 */
-	public static function get_external_ip_address() {
-
-		$transient_name = 'external_ip_address_0.0.0.0';
-
-		if ( '' !== self::get_ip_address() ) {
-			$transient_name      = 'external_ip_address_' . self::get_ip_address();
-		}
-
-		// Try retrieving from cache.
-		$external_ip_address = get_transient( $transient_name );
-
-		if ( false === $external_ip_address ) {
-			$external_ip_address     = '0.0.0.0';
-			$ip_lookup_services      = apply_filters( 'getpaid_geolocation_ip_lookup_apis', self::$ip_lookup_apis );
-			$ip_lookup_services_keys = array_keys( $ip_lookup_services );
-			shuffle( $ip_lookup_services_keys );
-
-			foreach ( $ip_lookup_services_keys as $service_name ) {
-				$service_endpoint = $ip_lookup_services[ $service_name ];
-				$response         = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) );
-
-				if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) {
-					$external_ip_address = apply_filters( 'getpaid_geolocation_ip_lookup_api_response', wpinv_clean( $response['body'] ), $service_name );
-					break;
-				}
-
-			}
-
-			set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS );
-		}
-
-		return $external_ip_address;
-	}
-
-	/**
-	 * Geolocate an IP address.
-	 *
-	 * @param  string $ip_address   IP Address.
-	 * @param  bool   $fallback     If true, fallbacks to alternative IP detection (can be slower).
-	 * @param  bool   $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower).
-	 * @return array
-	 */
-	public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) {
-
-		if ( empty( $ip_address ) ) {
-			$ip_address = self::get_ip_address();
-		}
-
-		// Update the current user's IP Address.
-		self::$current_user_ip = $ip_address;
-
-		// Filter to allow custom geolocation of the IP address.
-		$country_code = apply_filters( 'getpaid_geolocate_ip', false, $ip_address, $fallback, $api_fallback );
-
-		if ( false !== $country_code ) {
-
-			return array(
-				'country'  => $country_code,
-				'state'    => '',
-				'city'     => '',
-				'postcode' => '',
-			);
-
-		}
-
-		$country_code = self::get_country_code_from_headers();
-
-		/**
-		 * Get geolocation filter.
-		 *
-		 * @since 1.0.19
-		 * @param array  $geolocation Geolocation data, including country, state, city, and postcode.
-		 * @param string $ip_address  IP Address.
-		 */
-		$geolocation  = apply_filters(
-			'getpaid_get_geolocation',
-			array(
-				'country'  => $country_code,
-				'state'    => '',
-				'city'     => '',
-				'postcode' => '',
-			),
-			$ip_address
-		);
-
-		// If we still haven't found a country code, let's consider doing an API lookup.
-		if ( '' === $geolocation['country'] && $api_fallback ) {
-			$geolocation['country'] = self::geolocate_via_api( $ip_address );
-		}
-
-		// It's possible that we're in a local environment, in which case the geolocation needs to be done from the
-		// external address.
-		if ( '' === $geolocation['country'] && $fallback ) {
-			$external_ip_address = self::get_external_ip_address();
-
-			// Only bother with this if the external IP differs.
-			if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) {
-				return self::geolocate_ip( $external_ip_address, false, $api_fallback );
-			}
-
-		}
-
-		return array(
-			'country'  => $geolocation['country'],
-			'state'    => $geolocation['state'],
-			'city'     => $geolocation['city'],
-			'postcode' => $geolocation['postcode'],
-		);
-
-	}
-
-	/**
-	 * Fetches the country code from the request headers, if one is available.
-	 *
-	 * @since 1.0.19
-	 * @return string The country code pulled from the headers, or empty string if one was not found.
-	 */
-	protected static function get_country_code_from_headers() {
-		$country_code = '';
-
-		$headers = array(
-			'MM_COUNTRY_CODE',
-			'GEOIP_COUNTRY_CODE',
-			'HTTP_CF_IPCOUNTRY',
-			'HTTP_X_COUNTRY_CODE',
-		);
-
-		foreach ( $headers as $header ) {
-			if ( empty( $_SERVER[ $header ] ) ) {
-				continue;
-			}
-
-			$country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) );
-			break;
-		}
-
-		return $country_code;
-	}
-
-	/**
-	 * Use APIs to Geolocate the user.
-	 *
-	 * Geolocation APIs can be added through the use of the getpaid_geolocation_geoip_apis filter.
-	 * Provide a name=>value pair for service-slug=>endpoint.
-	 *
-	 * If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result
-	 * will be cached in a transient.
-	 *
-	 * @param  string $ip_address IP address.
-	 * @return string
-	 */
-	protected static function geolocate_via_api( $ip_address ) {
-
-		// Retrieve from cache...
-		$country_code = get_transient( 'geoip_' . $ip_address );
-
-		// If missing, retrieve from the API.
-		if ( false === $country_code ) {
-			$geoip_services = apply_filters( 'getpaid_geolocation_geoip_apis', self::$geoip_apis );
-
-			if ( empty( $geoip_services ) ) {
-				return '';
-			}
-
-			$geoip_services_keys = array_keys( $geoip_services );
-
-			shuffle( $geoip_services_keys );
-
-			foreach ( $geoip_services_keys as $service_name ) {
-
-				$service_endpoint = $geoip_services[ $service_name ];
-				$response         = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) );
-				$country_code     = sanitize_text_field( strtoupper( self::handle_geolocation_response( $response, $service_name ) ) );
-
-				if ( ! empty( $country_code ) ) {
-					break;
-				}
-
-			}
-
-			set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS );
-		}
-
-		return $country_code;
-	}
-
-	/**
-	 * Handles geolocation response
-	 *
-	 * @param  WP_Error|String $geolocation_response
-	 * @param  String $geolocation_service
-	 * @return string Country code
-	 */
-	protected static function handle_geolocation_response( $geolocation_response, $geolocation_service ) {
-
-		if ( is_wp_error( $geolocation_response ) || empty( $geolocation_response['body'] ) ) {
-			return '';
-		}
-
-		if ( $geolocation_service === 'ipinfo.io' ) {
-			$data = json_decode( $geolocation_response['body'] );
-			return empty( $data ) ? '' : $data->country;
-		}
-
-		if ( $geolocation_service === 'ip-api.com' ) {
-			$data = json_decode( $geolocation_response['body'] );
-			return empty( $data ) ? '' : $data->countryCode;
-		}
-
-		return apply_filters( 'getpaid_geolocation_geoip_response_' . $geolocation_service, '', $geolocation_response['body'] );
-
-	}
+    /**
+     * Holds the current user's IP Address.
+     *
+     * @var string
+     */
+    public static $current_user_ip;
+
+    /**
+     * API endpoints for looking up a user IP address.
+     *
+     * For example, in case a user is on localhost.
+     *
+     * @var array
+     */
+    protected static $ip_lookup_apis = array(
+        'ipify'             => 'http://api.ipify.org/',
+        'ipecho'            => 'http://ipecho.net/plain',
+        'ident'             => 'http://ident.me',
+        'whatismyipaddress' => 'http://bot.whatismyipaddress.com',
+    );
+
+    /**
+     * API endpoints for geolocating an IP address
+     *
+     * @var array
+     */
+    protected static $geoip_apis = array(
+        'ip-api.com' => 'http://ip-api.com/json/%s',
+        'ipinfo.io'  => 'https://ipinfo.io/%s/json',
+    );
+
+    /**
+     * Get current user IP Address.
+     *
+     * @return string
+     */
+    public static function get_ip_address() {
+        return wpinv_get_ip();
+    }
+
+    /**
+     * Get user IP Address using an external service.
+     * This can be used as a fallback for users on localhost where
+     * get_ip_address() will be a local IP and non-geolocatable.
+     *
+     * @return string
+     */
+    public static function get_external_ip_address() {
+
+        $transient_name = 'external_ip_address_0.0.0.0';
+
+        if ( '' !== self::get_ip_address() ) {
+            $transient_name      = 'external_ip_address_' . self::get_ip_address();
+        }
+
+        // Try retrieving from cache.
+        $external_ip_address = get_transient( $transient_name );
+
+        if ( false === $external_ip_address ) {
+            $external_ip_address     = '0.0.0.0';
+            $ip_lookup_services      = apply_filters( 'getpaid_geolocation_ip_lookup_apis', self::$ip_lookup_apis );
+            $ip_lookup_services_keys = array_keys( $ip_lookup_services );
+            shuffle( $ip_lookup_services_keys );
+
+            foreach ( $ip_lookup_services_keys as $service_name ) {
+                $service_endpoint = $ip_lookup_services[ $service_name ];
+                $response         = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) );
+
+                if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) {
+                    $external_ip_address = apply_filters( 'getpaid_geolocation_ip_lookup_api_response', wpinv_clean( $response['body'] ), $service_name );
+                    break;
+                }
+
+            }
+
+            set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS );
+        }
+
+        return $external_ip_address;
+    }
+
+    /**
+     * Geolocate an IP address.
+     *
+     * @param  string $ip_address   IP Address.
+     * @param  bool   $fallback     If true, fallbacks to alternative IP detection (can be slower).
+     * @param  bool   $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower).
+     * @return array
+     */
+    public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) {
+
+        if ( empty( $ip_address ) ) {
+            $ip_address = self::get_ip_address();
+        }
+
+        // Update the current user's IP Address.
+        self::$current_user_ip = $ip_address;
+
+        // Filter to allow custom geolocation of the IP address.
+        $country_code = apply_filters( 'getpaid_geolocate_ip', false, $ip_address, $fallback, $api_fallback );
+
+        if ( false !== $country_code ) {
+
+            return array(
+                'country'  => $country_code,
+                'state'    => '',
+                'city'     => '',
+                'postcode' => '',
+            );
+
+        }
+
+        $country_code = self::get_country_code_from_headers();
+
+        /**
+         * Get geolocation filter.
+         *
+         * @since 1.0.19
+         * @param array  $geolocation Geolocation data, including country, state, city, and postcode.
+         * @param string $ip_address  IP Address.
+         */
+        $geolocation  = apply_filters(
+            'getpaid_get_geolocation',
+            array(
+                'country'  => $country_code,
+                'state'    => '',
+                'city'     => '',
+                'postcode' => '',
+            ),
+            $ip_address
+        );
+
+        // If we still haven't found a country code, let's consider doing an API lookup.
+        if ( '' === $geolocation['country'] && $api_fallback ) {
+            $geolocation['country'] = self::geolocate_via_api( $ip_address );
+        }
+
+        // It's possible that we're in a local environment, in which case the geolocation needs to be done from the
+        // external address.
+        if ( '' === $geolocation['country'] && $fallback ) {
+            $external_ip_address = self::get_external_ip_address();
+
+            // Only bother with this if the external IP differs.
+            if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) {
+                return self::geolocate_ip( $external_ip_address, false, $api_fallback );
+            }
+
+        }
+
+        return array(
+            'country'  => $geolocation['country'],
+            'state'    => $geolocation['state'],
+            'city'     => $geolocation['city'],
+            'postcode' => $geolocation['postcode'],
+        );
+
+    }
+
+    /**
+     * Fetches the country code from the request headers, if one is available.
+     *
+     * @since 1.0.19
+     * @return string The country code pulled from the headers, or empty string if one was not found.
+     */
+    protected static function get_country_code_from_headers() {
+        $country_code = '';
+
+        $headers = array(
+            'MM_COUNTRY_CODE',
+            'GEOIP_COUNTRY_CODE',
+            'HTTP_CF_IPCOUNTRY',
+            'HTTP_X_COUNTRY_CODE',
+        );
+
+        foreach ( $headers as $header ) {
+            if ( empty( $_SERVER[ $header ] ) ) {
+                continue;
+            }
+
+            $country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) );
+            break;
+        }
+
+        return $country_code;
+    }
+
+    /**
+     * Use APIs to Geolocate the user.
+     *
+     * Geolocation APIs can be added through the use of the getpaid_geolocation_geoip_apis filter.
+     * Provide a name=>value pair for service-slug=>endpoint.
+     *
+     * If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result
+     * will be cached in a transient.
+     *
+     * @param  string $ip_address IP address.
+     * @return string
+     */
+    protected static function geolocate_via_api( $ip_address ) {
+
+        // Retrieve from cache...
+        $country_code = get_transient( 'geoip_' . $ip_address );
+
+        // If missing, retrieve from the API.
+        if ( false === $country_code ) {
+            $geoip_services = apply_filters( 'getpaid_geolocation_geoip_apis', self::$geoip_apis );
+
+            if ( empty( $geoip_services ) ) {
+                return '';
+            }
+
+            $geoip_services_keys = array_keys( $geoip_services );
+
+            shuffle( $geoip_services_keys );
+
+            foreach ( $geoip_services_keys as $service_name ) {
+
+                $service_endpoint = $geoip_services[ $service_name ];
+                $response         = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) );
+                $country_code     = sanitize_text_field( strtoupper( self::handle_geolocation_response( $response, $service_name ) ) );
+
+                if ( ! empty( $country_code ) ) {
+                    break;
+                }
+
+            }
+
+            set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS );
+        }
+
+        return $country_code;
+    }
+
+    /**
+     * Handles geolocation response
+     *
+     * @param  WP_Error|String $geolocation_response
+     * @param  String $geolocation_service
+     * @return string Country code
+     */
+    protected static function handle_geolocation_response( $geolocation_response, $geolocation_service ) {
+
+        if ( is_wp_error( $geolocation_response ) || empty( $geolocation_response['body'] ) ) {
+            return '';
+        }
+
+        if ( $geolocation_service === 'ipinfo.io' ) {
+            $data = json_decode( $geolocation_response['body'] );
+            return empty( $data ) ? '' : $data->country;
+        }
+
+        if ( $geolocation_service === 'ip-api.com' ) {
+            $data = json_decode( $geolocation_response['body'] );
+            return empty( $data ) ? '' : $data->countryCode;
+        }
+
+        return apply_filters( 'getpaid_geolocation_geoip_response_' . $geolocation_service, '', $geolocation_response['body'] );
+
+    }
 
 }

includes/class-wpinv-ajax.php

Indentation +58 added lines, -58 removed lines

@@ -14,70 +14,70 @@ 
 class WPInv_Ajax {
 
     /**
-	 * Hook in ajax handlers.
-	 */
-	public static function init() {
-		add_action( 'init', array( __CLASS__, 'define_ajax' ), 0 );
-		add_action( 'template_redirect', array( __CLASS__, 'do_wpinv_ajax' ), 0 );
-		self::add_ajax_events();
+     * Hook in ajax handlers.
+     */
+    public static function init() {
+        add_action( 'init', array( __CLASS__, 'define_ajax' ), 0 );
+        add_action( 'template_redirect', array( __CLASS__, 'do_wpinv_ajax' ), 0 );
+        self::add_ajax_events();
     }
 
     /**
-	 * Set GetPaid AJAX constant and headers.
-	 */
-	public static function define_ajax() {
-
-		if ( ! empty( $_GET['wpinv-ajax'] ) ) {
-			getpaid_maybe_define_constant( 'DOING_AJAX', true );
-			getpaid_maybe_define_constant( 'WPInv_DOING_AJAX', true );
-			if ( ! WP_DEBUG || ( WP_DEBUG && ! WP_DEBUG_DISPLAY ) ) {
-				/** @scrutinizer ignore-unhandled */ @ini_set( 'display_errors', 0 );
-			}
-			$GLOBALS['wpdb']->hide_errors();
-		}
+     * Set GetPaid AJAX constant and headers.
+     */
+    public static function define_ajax() {
+
+        if ( ! empty( $_GET['wpinv-ajax'] ) ) {
+            getpaid_maybe_define_constant( 'DOING_AJAX', true );
+            getpaid_maybe_define_constant( 'WPInv_DOING_AJAX', true );
+            if ( ! WP_DEBUG || ( WP_DEBUG && ! WP_DEBUG_DISPLAY ) ) {
+                /** @scrutinizer ignore-unhandled */ @ini_set( 'display_errors', 0 );
+            }
+            $GLOBALS['wpdb']->hide_errors();
+        }
 
     }
     
     /**
-	 * Send headers for GetPaid Ajax Requests.
-	 *
-	 * @since 1.0.18
-	 */
-	private static function wpinv_ajax_headers() {
-		if ( ! headers_sent() ) {
-			send_origin_headers();
-			send_nosniff_header();
-			nocache_headers();
-			header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
-			header( 'X-Robots-Tag: noindex' );
-			status_header( 200 );
-		}
+     * Send headers for GetPaid Ajax Requests.
+     *
+     * @since 1.0.18
+     */
+    private static function wpinv_ajax_headers() {
+        if ( ! headers_sent() ) {
+            send_origin_headers();
+            send_nosniff_header();
+            nocache_headers();
+            header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
+            header( 'X-Robots-Tag: noindex' );
+            status_header( 200 );
+        }
     }
     
     /**
-	 * Check for GetPaid Ajax request and fire action.
-	 */
-	public static function do_wpinv_ajax() {
-		global $wp_query;
+     * Check for GetPaid Ajax request and fire action.
+     */
+    public static function do_wpinv_ajax() {
+        global $wp_query;
 
-		if ( ! empty( $_GET['wpinv-ajax'] ) ) {
-			$wp_query->set( 'wpinv-ajax', sanitize_text_field( wp_unslash( $_GET['wpinv-ajax'] ) ) );
-		}
+        if ( ! empty( $_GET['wpinv-ajax'] ) ) {
+            $wp_query->set( 'wpinv-ajax', sanitize_text_field( wp_unslash( $_GET['wpinv-ajax'] ) ) );
+        }
 
-		$action = $wp_query->get( 'wpinv-ajax' );
+        $action = $wp_query->get( 'wpinv-ajax' );
 
-		if ( $action ) {
-			self::wpinv_ajax_headers();
-			$action = sanitize_text_field( $action );
-			do_action( 'wpinv_ajax_' . $action );
-			wp_die();
-		}
+        if ( $action ) {
+            self::wpinv_ajax_headers();
+            $action = sanitize_text_field( $action );
+            do_action( 'wpinv_ajax_' . $action );
+            wp_die();
+        }
 
     }
 
     /**
-	 * Hook in ajax methods.
-	 */
+     * Hook in ajax methods.
+     */
     public static function add_ajax_events() {
 
         // array( 'event' => is_frontend )
@@ -255,24 +255,24 @@ 
         check_ajax_referer( 'getpaid_form_nonce' );
 
         // Is the request set up correctly?
-		if ( empty( $_GET['form'] ) && empty( $_GET['item'] ) ) {
-			echo aui()->alert(
-				array(
-					'type'    => 'warning',
-					'content' => __( 'No payment form or item provided', 'invoicing' ),
-				)
+        if ( empty( $_GET['form'] ) && empty( $_GET['item'] ) ) {
+            echo aui()->alert(
+                array(
+                    'type'    => 'warning',
+                    'content' => __( 'No payment form or item provided', 'invoicing' ),
+                )
             );
             exit;
         }
 
         // Payment form or button?
-		if ( ! empty( $_GET['form'] ) ) {
+        if ( ! empty( $_GET['form'] ) ) {
             getpaid_display_payment_form( urldecode( $_GET['form'] ) );
-		} else if( ! empty( $_GET['invoice'] ) ) {
-		    getpaid_display_invoice_payment_form( urldecode( $_GET['invoice'] ) );
+        } else if( ! empty( $_GET['invoice'] ) ) {
+            getpaid_display_invoice_payment_form( urldecode( $_GET['invoice'] ) );
         } else {
-			$items = getpaid_convert_items_to_array( urldecode( $_GET['item'] ) );
-		    getpaid_display_item_payment_form( $items );
+            $items = getpaid_convert_items_to_array( urldecode( $_GET['item'] ) );
+            getpaid_display_item_payment_form( $items );
         }
 
         exit;

includes/user-functions.php

Indentation +19 added lines, -19 removed lines

@@ -159,11 +159,11 @@ 
  */
 function wpinv_get_capability( $capalibilty = 'manage_invoicing' ) {
 
-	if ( current_user_can( 'manage_options' ) ) {
-		return 'manage_options';
-	};
+    if ( current_user_can( 'manage_options' ) ) {
+        return 'manage_options';
+    };
 
-	return $capalibilty;
+    return $capalibilty;
 }
 
 /**
@@ -185,10 +185,10 @@ 
 function wpinv_create_user( $email ) {
 
     // Prepare user values.
-	$args = array(
-		'user_login' => wpinv_generate_user_name( $email ),
-		'user_pass'  => wp_generate_password(),
-		'user_email' => $email,
+    $args = array(
+        'user_login' => wpinv_generate_user_name( $email ),
+        'user_pass'  => wp_generate_password(),
+        'user_email' => $email,
         'role'       => 'subscriber',
     );
 
@@ -205,20 +205,20 @@ 
 function wpinv_generate_user_name( $prefix = '' ) {
 
     // If prefix is an email, retrieve the part before the email.
-	$prefix = strtok( $prefix, '@' );
+    $prefix = strtok( $prefix, '@' );
 
-	// Trim to 4 characters max.
-	$prefix = sanitize_user( $prefix );
+    // Trim to 4 characters max.
+    $prefix = sanitize_user( $prefix );
 
-	$illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
-	if ( empty( $prefix ) || in_array( strtolower( $prefix ), array_map( 'strtolower', $illegal_logins ), true ) ) {
-		$prefix = 'gtp';
-	}
+    $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
+    if ( empty( $prefix ) || in_array( strtolower( $prefix ), array_map( 'strtolower', $illegal_logins ), true ) ) {
+        $prefix = 'gtp';
+    }
 
-	$username = $prefix . '_' . zeroise( wp_rand( 0, 9999 ), 4 );
-	if ( username_exists( $username ) ) {
-		return wpinv_generate_user_name( $username );
-	}
+    $username = $prefix . '_' . zeroise( wp_rand( 0, 9999 ), 4 );
+    if ( username_exists( $username ) ) {
+        return wpinv_generate_user_name( $username );
+    }
 
     return $username;
 }