WooCommerce_MyParcel

The WooCommerce MyParcel WooCommerce MyParcel class.

Defined (1)

The class is defined in the following location(s).

/woocommerce-myparcel.php  
  1. class WooCommerce_MyParcel { 
  2.  
  3.     public $version = '2.2.0'; 
  4.     public $plugin_basename; 
  5.  
  6.     protected static $_instance = null; 
  7.  
  8.     /** 
  9.      * Main Plugin Instance 
  10.      * 
  11.      * Ensures only one instance of plugin is loaded or can be loaded. 
  12.      */ 
  13.     public static function instance() { 
  14.         if ( is_null( self::$_instance ) ) { 
  15.             self::$_instance = new self(); 
  16.         } 
  17.         return self::$_instance; 
  18.     } 
  19.  
  20.     /** 
  21.      * Constructor 
  22.      */ 
  23.               
  24.     public function __construct() { 
  25.         $this->define( 'WC_MYPARCEL_VERSION', $this->version ); 
  26.         $this->plugin_basename = plugin_basename(__FILE__); 
  27.  
  28.         // Load settings 
  29.         $this->general_settings = get_option( 'woocommerce_myparcel_general_settings' ); 
  30.         $this->export_defaults = get_option( 'woocommerce_myparcel_export_defaults_settings' ); 
  31.         $this->checkout_settings = get_option( 'woocommerce_myparcel_checkout_settings' ); 
  32.  
  33.         // load the localisation & classes 
  34.         add_action( 'plugins_loaded', array( $this, 'translations' ) ); 
  35.         add_action( 'init', array( $this, 'load_classes' ) ); 
  36.  
  37.         // run lifecycle methods 
  38.         if ( is_admin() && ! defined( 'DOING_AJAX' ) ) { 
  39.             add_action( 'wp_loaded', array( $this, 'do_install' ) ); 
  40.         } 
  41.     } 
  42.  
  43.     /** 
  44.      * Define constant if not already set 
  45.      * @param  string $name 
  46.      * @param  string|bool $value 
  47.      */ 
  48.     private function define( $name, $value ) { 
  49.         if ( ! defined( $name ) ) { 
  50.             define( $name, $value ); 
  51.         } 
  52.     } 
  53.  
  54.     /** 
  55.      * Load the translation / textdomain files 
  56.      *  
  57.      * Note: the first-loaded translation file overrides any following ones if the same translation is present 
  58.      */ 
  59.     public function translations() { 
  60.         $locale = apply_filters( 'plugin_locale', get_locale(), 'woocommerce-myparcel' ); 
  61.         $dir = trailingslashit( WP_LANG_DIR ); 
  62.  
  63.         /** 
  64.          * Frontend/global Locale. Looks in: 
  65.          * 
  66.          *         - WP_LANG_DIR/woocommerce-myparcel/woocommerce-myparcel-LOCALE.mo 
  67.          *          - WP_LANG_DIR/plugins/woocommerce-myparcel-LOCALE.mo 
  68.          *          - woocommerce-myparcel/languages/woocommerce-myparcel-LOCALE.mo (which if not found falls back to:) 
  69.          *          - WP_LANG_DIR/plugins/woocommerce-myparcel-LOCALE.mo 
  70.          */ 
  71.         load_textdomain( 'woocommerce-myparcel', $dir . 'woocommerce-myparcel/woocommerce-myparcel-' . $locale . '.mo' ); 
  72.         load_textdomain( 'woocommerce-myparcel', $dir . 'plugins/woocommerce-myparcel-' . $locale . '.mo' ); 
  73.         load_plugin_textdomain( 'woocommerce-myparcel', false, dirname( plugin_basename(__FILE__) ) . '/languages' ); 
  74.     } 
  75.  
  76.     /** 
  77.      * Load the main plugin classes and functions 
  78.      */ 
  79.     public function includes() { 
  80.         // include compatibility classes 
  81.         include_once( 'includes/compatibility/abstract-wc-data-compatibility.php' ); 
  82.         include_once( 'includes/compatibility/class-wc-date-compatibility.php' ); 
  83.         include_once( 'includes/compatibility/class-wc-core-compatibility.php' ); 
  84.         include_once( 'includes/compatibility/class-wc-order-compatibility.php' ); 
  85.         include_once( 'includes/compatibility/class-wc-product-compatibility.php' ); 
  86.  
  87.         include_once( 'includes/class-wcmp-assets.php' ); 
  88.         $this->admin = include_once( 'includes/class-wcmp-admin.php' ); 
  89.         include_once( 'includes/class-wcmp-frontend.php' ); 
  90.         include_once( 'includes/class-wcmp-settings.php' ); 
  91.         $this->export = include_once( 'includes/class-wcmp-export.php' ); 
  92.         include_once( 'includes/class-wcmp-nlpostcode-fields.php' ); 
  93.     } 
  94.  
  95.     /** 
  96.      * Instantiate classes when woocommerce is activated 
  97.      */ 
  98.     public function load_classes() { 
  99.         if ( $this->is_woocommerce_activated() === false ) { 
  100.             add_action( 'admin_notices', array ( $this, 'need_woocommerce' ) ); 
  101.             return; 
  102.         } 
  103.  
  104.         if ( version_compare( PHP_VERSION, '5.3', '<' ) ) { 
  105.             add_action( 'admin_notices', array ( $this, 'required_php_version' ) ); 
  106.             return; 
  107.         } 
  108.  
  109.         // all systems ready - GO! 
  110.         $this->includes(); 
  111.     } 
  112.  
  113.     /** 
  114.      * Check if woocommerce is activated 
  115.      */ 
  116.     public function is_woocommerce_activated() { 
  117.         $blog_plugins = get_option( 'active_plugins', array() ); 
  118.         $site_plugins = get_site_option( 'active_sitewide_plugins', array() ); 
  119.  
  120.         if ( in_array( 'woocommerce/woocommerce.php', $blog_plugins ) || isset( $site_plugins['woocommerce/woocommerce.php'] ) ) { 
  121.             return true; 
  122.         } else { 
  123.             return false; 
  124.         } 
  125.     } 
  126.      
  127.     /** 
  128.      * WooCommerce not active notice. 
  129.      * 
  130.      * @return string Fallack notice. 
  131.      */ 
  132.       
  133.     public function need_woocommerce() { 
  134.         $error = sprintf( __( 'WooCommerce MyParcel requires %sWooCommerce%s to be installed & activated!' , 'woocommerce-myparcel' ), '<a href="http://wordpress.org/extend/plugins/woocommerce/">', '</a>' ); 
  135.  
  136.         $message = '<div class="error"><p>' . $error . '</p></div>'; 
  137.      
  138.         echo $message; 
  139.     } 
  140.  
  141.     /** 
  142.      * PHP version requirement notice 
  143.      */ 
  144.      
  145.     public function required_php_version() { 
  146.         $error = __( 'WooCommerce MyParcel requires PHP 5.3 or higher (5.6 or later recommended).', 'woocommerce-myparcel' ); 
  147.         $how_to_update = __( 'How to update your PHP version', 'woocommerce-myparcel' ); 
  148.         $message = sprintf('<div class="error"><p>%s</p><p><a href="%s">%s</a></p></div>', $error, 'http://docs.wpovernight.com/general/how-to-update-your-php-version/', $how_to_update); 
  149.      
  150.         echo $message; 
  151.     } 
  152.  
  153.     /** Lifecycle methods ******************************************************* 
  154.      * Because register_activation_hook only runs when the plugin is manually 
  155.      * activated by the user, we're checking the current version against the 
  156.      * version stored in the database 
  157.     ****************************************************************************/ 
  158.  
  159.     /** 
  160.      * Handles version checking 
  161.      */ 
  162.     public function do_install() { 
  163.         $version_setting = 'woocommerce_myparcel_version'; 
  164.         $installed_version = get_option( $version_setting ); 
  165.  
  166.         // installed version lower than plugin version? 
  167.         if ( version_compare( $installed_version, $this->version, '<' ) ) { 
  168.  
  169.             if ( ! $installed_version ) { 
  170.                 $this->install(); 
  171.             } else { 
  172.                 $this->upgrade( $installed_version ); 
  173.             } 
  174.  
  175.             // new version number 
  176.             update_option( $version_setting, $this->version ); 
  177.         } 
  178.     } 
  179.  
  180.  
  181.     /** 
  182.      * Plugin install method. Perform any installation tasks here 
  183.      */ 
  184.     protected function install() { 
  185.         // copy old settings if available (pre 2.0 didn't store the version, so technically, this is a new install) 
  186.         $old_settings = get_option( 'wcmyparcel_settings' ); 
  187.         if (!empty($old_settings)) { 
  188.             // copy old settins to new 
  189.             // Deprecated 
  190.             // api_username 
  191.             // pakjegemak 
  192.             // pakjegemak_description 
  193.             // pakjegemak_button 
  194.             // shipment_type 
  195.             // huishand 
  196.  
  197.             // map old key => new_key 
  198.             $general_settings_keys = array( 
  199.                 'api_key' => 'api_key',  
  200.                 'download_display' => 'download_display',  
  201.                 'email_tracktrace' => 'email_tracktrace',  
  202.                 'myaccount_tracktrace' => 'myaccount_tracktrace',  
  203.                 'process' => 'process_directly',  
  204.                 'keep_consignments' => 'keep_shipments',  
  205.                 'error_logging' => 'error_logging',  
  206.  ); 
  207.  
  208.             $general_settings = array(); 
  209.             foreach ($general_settings_keys as $old_key => $new_key) { 
  210.                 if (!empty($old_settings[$old_key])) { 
  211.                     $general_settings[$new_key] = $old_settings[$old_key]; 
  212.                 } 
  213.             } 
  214.             // auto_complete breaks down into: 
  215.             // order_status_automation & automatic_order_status 
  216.             if (!empty($old_settings['auto_complete'])) { 
  217.                 $general_settings['order_status_automation'] = 1; 
  218.                 $general_settings['automatic_order_status'] = 'completed'; 
  219.             } 
  220.              
  221.             // map old key => new_key 
  222.             $defaults_settings_keys = array( 
  223.                 'email' => 'connect_email',  
  224.                 'telefoon' => 'connect_phone',  
  225.                 'extragroot' => 'large_format',  
  226.                 'huisadres' => 'only_recipient',  
  227.                 'handtekening' => 'signature',  
  228.                 'retourbgg' => 'return',  
  229.                 'kenmerk' => 'label_description',  
  230.                 'verpakkingsgewicht' => 'empty_parcel_weight',  
  231.                 'verzekerd' => 'insured',  
  232.                 'verzekerdbedrag' => 'insured_amount',  
  233.  ); 
  234.             $defaults_settings = array(); 
  235.             foreach ($defaults_settings_keys as $old_key => $new_key) { 
  236.                 if (!empty($old_settings[$old_key])) { 
  237.                     $defaults_settings[$new_key] = $old_settings[$old_key]; 
  238.                 } 
  239.             } 
  240.             // set custom insurance amount 
  241.             if (!empty($defaults_settings['insured']) && (int) $defaults_settings['insured_amount'] > 249) { 
  242.                 $defaults_settings['insured_amount'] = 0; 
  243.                 $defaults_settings['insured_amount_custom'] = $old_settings['verzekerdbedrag']; 
  244.             } 
  245.              
  246.             // add options 
  247.             update_option( 'woocommerce_myparcel_general_settings', $general_settings ); 
  248.             update_option( 'woocommerce_myparcel_export_defaults_settings', $defaults_settings ); 
  249.         } 
  250.     } 
  251.  
  252.     /** 
  253.      * Plugin upgrade method.  Perform any required upgrades here 
  254.      * 
  255.      * @param string $installed_version the currently installed ('old') version 
  256.      */ 
  257.     protected function upgrade( $installed_version ) { 
  258.         # stub 
  259.     }         
  260.  
  261.     /** 
  262.      * Get the plugin url. 
  263.      * @return string 
  264.      */ 
  265.     public function plugin_url() { 
  266.         return untrailingslashit( plugins_url( '/', __FILE__ ) ); 
  267.     } 
  268.  
  269.     /** 
  270.      * Get the plugin path. 
  271.      * @return string 
  272.      */ 
  273.     public function plugin_path() { 
  274.         return untrailingslashit( plugin_dir_path( __FILE__ ) ); 
  275.     } 
  276.  
  277. } // class WooCommerce_MyParcel