\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
\t\t\t\t| \t\t\t\t\t\t\t\t\t\t\t\t\t\t \t\t\t\t\t\t\t\t\t\t\t\t\t\t\t \t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t | \t\t\t\t\t
+
+
+
+ + +
++ + + + + +
+ +-
+
+ steps as $id => $step ) : ?>
+
+ current_step ) : ?>
+
+ is_step_complete( $id ) ) : ?>
+
- + + + + + + + + +
+
+ is_finished() ) : ?>
+
+ render_finished(); ?>
+
+ complete_setup(); ?>
+
+
+
+
+ is_started() ) : ?>
+ render_welcome(); ?>
+
+
+
+
+ render_error( $error_message ); ?>
+
+
+
+
+
+
+
+ %s', esc_html( $message ) );
+ }
+ }
+
+
+ /**
+ * Renders a default welcome note.
+ *
+ * @since 5.2.2
+ */
+ protected function render_welcome() {
+
+ ?>
+ render_welcome_heading()?>
+render_welcome_text(); ?>
+ get_plugin()->get_plugin_name() + ); + } + + + /** + * Renders the default welcome note text. + * + * @since 5.2.2 + */ + protected function render_welcome_text() { + + esc_html_e( 'This quick setup wizard will help you configure the basic settings and get you started.', 'woocommerce-plugin-framework' ); + } + + + /** + * Renders the finished screen markup. + * + * This is what gets displayed after all of the steps have been completed or skipped. + * + * @since 5.2.2 + */ + protected function render_finished() { + + ?> +get_plugin()->get_plugin_name() ) ); ?>
+ render_before_next_steps(); ?> + render_next_steps(); ?> + render_after_next_steps(); ?> + get_next_steps(); + $additional_actions = $this->get_additional_actions(); + + if ( ! empty( $next_steps ) || ! empty( $additional_actions ) ) : + + ?> + + get_plugin()->get_documentation_url() ) { + + $steps['view-docs'] = array( + 'name' => __( 'View the Docs', 'woocommerce-plugin-framework' ), + 'label' => __( 'See more setup options', 'woocommerce-plugin-framework' ), + 'description' => __( 'Learn more about customizing the plugin', 'woocommerce-plugin-framework' ), + 'url' => $this->get_plugin()->get_documentation_url(), + ); + } + + return $steps; + } + + + /** + * Gets the additional steps. + * + * These are secondary actions. + * + * @since 5.2.2 + * + * @return array + */ + protected function get_additional_actions() { + + $next_steps = $this->get_next_steps(); + $actions = array(); + + if ( $this->get_plugin()->get_settings_url() ) { + $actions[ __( 'Review Your Settings', 'woocommerce-plugin-framework' ) ] = $this->get_plugin()->get_settings_url(); + } + + if ( empty( $next_steps['view-docs'] ) && $this->get_plugin()->get_documentation_url() ) { + $actions[ __( 'View the Docs', 'woocommerce-plugin-framework' ) ] = $this->get_plugin()->get_documentation_url(); + } + + if ( $this->get_plugin()->get_reviews_url() ) { + $actions[ __( 'Leave a Review', 'woocommerce-plugin-framework' ) ] = $this->get_plugin()->get_reviews_url(); + } + + return $actions; + } + + + /** + * Renders a given step's markup. + * + * This will display a title, whatever get's rendered by the step's view + * callback, then the navigation buttons. + * + * @since 5.2.2 + * + * @param string $step_id step ID to render + */ + protected function render_step( $step_id ) { + + call_user_func( $this->steps[ $step_id ]['view'], $this ); + + ?> ++ + + + steps[ $step_id ]['save'] ) ) : ?> + + + + + + + + +
+ render_toggle_form_field( $key, $args, $value ); + } else { + woocommerce_form_field( $key, $args, $value ); + } + } + + + /** + * Renders the toggle form field. + * + * This requires special markup for the toggle UI. + * + * @since 5.2.2 + * + * @param string $key field key + * @param array $args field args - @see woocommerce_form_field() + * @param string|null $value field value + */ + public function render_toggle_form_field( $key, $args, $value ) { + + $args = wp_parse_args( $args, array( + 'type' => 'text', + 'label' => '', + 'description' => '', + 'required' => false, + 'id' => $key, + 'class' => array(), + 'label_class' => array(), + 'input_class' => array(), + 'custom_attributes' => array(), + 'default' => false, + 'allow_html' => false, + ) ); + + $args['class'][] = 'toggle'; + + if ( $args['required'] ) { + $args['class'][] = 'validate-required'; + } + + if ( null === $value ) { + $value = $args['default']; + } + + $custom_attributes = array(); + $args['custom_attributes'] = array_filter( (array) $args['custom_attributes'], 'strlen' ); + + if ( $args['description'] ) { + $args['custom_attributes']['aria-describedby'] = $args['id'] . '-description'; + } + + if ( ! empty( $args['custom_attributes'] ) && is_array( $args['custom_attributes'] ) ) { + foreach ( $args['custom_attributes'] as $attribute => $attribute_value ) { + $custom_attributes[] = esc_attr( $attribute ) . '="' . esc_attr( $attribute_value ) . '"'; + } + } + + $enabled = $value || $args['default']; + + if ( $enabled ) { + $args['class'][] = 'enabled'; + } + + ?> +
+
+
+
+
+
+
+ is_finished() ) : ?>
+
+ is_started() ) : ?>
+
+
+
+
+ has_step( $id ) ) {
+ throw new Framework\SV_WC_Plugin_Exception( 'Invalid step ID' );
+ }
+
+ // invalid name
+ if ( ! is_string( $name ) || empty( $name ) ) {
+ throw new Framework\SV_WC_Plugin_Exception( 'Invalid step name' );
+ }
+
+ // invalid view callback
+ if ( ! is_callable( $view_callback ) ) {
+ throw new Framework\SV_WC_Plugin_Exception( 'Invalid view callback' );
+ }
+
+ // invalid save callback
+ if ( null !== $save_callback && ! is_callable( $save_callback ) ) {
+ throw new Framework\SV_WC_Plugin_Exception( 'Invalid save callback' );
+ }
+
+ $this->steps[ $id ] = array(
+ 'name' => $name,
+ 'view' => $view_callback,
+ 'save' => $save_callback,
+ );
+
+ return true;
+
+ } catch ( Framework\SV_WC_Plugin_Exception $exception ) {
+
+ wc_doing_it_wrong( __METHOD__, $exception->getMessage(), '5.2.2' );
+
+ return false;
+ }
+ }
+
+
+ /**
+ * Marks the setup as complete.
+ *
+ * @since 5.2.2
+ *
+ * @return bool
+ */
+ public function complete_setup() {
+
+ return update_option( "wc_{$this->id}_setup_wizard_complete", 'yes' );
+ }
+
+
+ /** Conditional Methods *******************************************************************************************/
+
+
+ /**
+ * Determines if the current page is the setup wizard page.
+ *
+ * @since 5.2.2
+ *
+ * @return bool
+ */
+ public function is_setup_page() {
+
+ return is_admin() && $this->get_slug() === Framework\SV_WC_Helper::get_requested_value( 'page' );
+ }
+
+
+ /**
+ * Determines if a step is the current one displayed.
+ *
+ * @since 5.2.2
+ *
+ * @param string $step_id step ID
+ * @return bool
+ */
+ public function is_current_step( $step_id ) {
+
+ return $this->current_step === $step_id;
+ }
+
+
+ /**
+ * Determines if setup has started.
+ *
+ * @since 5.2.2
+ *
+ * @return bool
+ */
+ public function is_started() {
+
+ $steps = array_keys( $this->steps );
+
+ return $this->current_step && $this->current_step === reset( $steps );
+ }
+
+
+ /**
+ * Determines if setup has completed all of the steps.
+ *
+ * @since 5.2.2
+ *
+ * @return bool
+ */
+ public function is_finished() {
+
+ return self::ACTION_FINISH === Framework\SV_WC_Helper::get_requested_value( 'action' );
+ }
+
+
+ /**
+ * Determines if the setup wizard has been completed.
+ *
+ * This will be true if any user has been redirected back to the regular
+ * WordPress dashboard, either manually or after finishing the steps.
+ *
+ * @since 5.2.2
+ *
+ * @return bool
+ */
+ public function is_complete() {
+
+ return 'yes' === get_option( "wc_{$this->id}_setup_wizard_complete", 'no' );
+ }
+
+
+ /**
+ * Determines if the given step has been completed.
+ *
+ * @since 5.2.2
+ *
+ * @param string $step_id step ID to check
+ * @return bool
+ */
+ public function is_step_complete( $step_id ) {
+
+ return array_search( $this->current_step, array_keys( $this->steps ), true ) > array_search( $step_id, array_keys( $this->steps ), true ) || $this->is_finished();
+ }
+
+
+ /**
+ * Determines if the wizard has steps to display.
+ *
+ * @since 5.2.2
+ *
+ * @return bool
+ */
+ public function has_steps() {
+
+ return is_array( $this->steps ) && ! empty( $this->steps );
+ }
+
+
+ /**
+ * Determines if this setup handler has a given step.
+ *
+ * @since 5.2.2
+ *
+ * @param string $step_id step ID to check
+ * @return bool
+ */
+ public function has_step( $step_id ) {
+
+ return ! empty( $this->steps[ $step_id ] );
+ }
+
+
+ /** Getter Methods ************************************************************************************************/
+
+
+ /**
+ * Gets a given step's title.
+ *
+ * @since 5.2.2
+ *
+ * @param string $step_id step ID (optional: will assume the current step if unspecified)
+ * @return string
+ */
+ public function get_step_title( $step_id = '' ) {
+
+ $step_title = '';
+
+ if ( ! $step_id ) {
+ $step_id = $this->current_step;
+ }
+
+ if ( isset( $this->steps[ $step_id ]['name'] ) ) {
+ $step_title = $this->steps[ $step_id ]['name'];
+ }
+
+ return $step_title;
+ }
+
+
+ /**
+ * Gets the Setup Wizard URL.
+ *
+ * @since 5.2.2
+ *
+ * @return string
+ */
+ public function get_setup_url() {
+
+ return add_query_arg( 'page', $this->get_slug(), admin_url( 'index.php' ) );
+ }
+
+
+ /**
+ * Gets the URL for the next step based on a current step.
+ *
+ * @since 5.2.2
+ *
+ * @param string $step_id step ID to base "next" off of - defaults to this class's internal pointer
+ * @return string
+ */
+ public function get_next_step_url( $step_id = '' ) {
+
+ if ( ! $step_id ) {
+ $step_id = $this->current_step;
+ }
+
+ $steps = array_keys( $this->steps );
+
+ // if on the last step, next is the final finish step
+ if ( end( $steps ) === $step_id ) {
+
+ $url = $this->get_finish_url();
+
+ } else {
+
+ $step_index = array_search( $step_id, $steps, true );
+
+ // if the current step is found, use the next in the array. otherwise, the first
+ $step = false !== $step_index ? $steps[ $step_index + 1 ] : reset( $steps );
+
+ $url = add_query_arg( 'step', $step );
+ }
+
+ return $url;
+ }
+
+
+ /**
+ * Gets a given step's URL.
+ *
+ * @since 5.2.2
+ *
+ * @param string $step_id step ID
+ * @return string|false
+ */
+ public function get_step_url( $step_id ) {
+
+ $url = false;
+
+ if ( $this->has_step( $step_id ) ) {
+ $url = add_query_arg( 'step', $step_id, remove_query_arg( 'action' ) );
+ }
+
+ return $url;
+ }
+
+
+ /**
+ * Gets the "finish" action URL.
+ *
+ * @since 5.2.2
+ *
+ * @return string
+ */
+ protected function get_finish_url() {
+
+ return add_query_arg( 'action', self::ACTION_FINISH, remove_query_arg( 'step' ) );
+ }
+
+
+ /**
+ * Gets the return URL.
+ *
+ * Can be used to return the user to the dashboard. The plugin's settings URL
+ * will be used if it exists, otherwise the general dashboard URL.
+ *
+ * @since 5.2.2
+ *
+ * @return string
+ */
+ protected function get_dashboard_url() {
+
+ $settings_url = $this->get_plugin()->get_settings_url();
+ $dashboard_url = ! empty( $settings_url ) ? $settings_url : admin_url();
+
+ return add_query_arg( "wc_{$this->id}_setup_wizard_complete", true, $dashboard_url );
+ }
+
+
+ /**
+ * Gets the setup setup handler's slug.
+ *
+ * @since 5.2.2
+ *
+ * @return string
+ */
+ protected function get_slug() {
+
+ return 'wc-' . $this->get_plugin()->get_id_dasherized() . '-setup';
+ }
+
+
+ /**
+ * Gets the plugin instance.
+ *
+ * @since 5.2.2
+ *
+ * @return Framework\SV_WC_Plugin|Framework\SV_WC_Payment_Gateway_Plugin
+ */
+ protected function get_plugin() {
+
+ return $this->plugin;
+ }
+
+
+}
+
+
+endif;
diff --git a/vendor/skyverge/wc-plugin-framework/woocommerce/api/Abstract_Cacheable_API_Base.php b/vendor/skyverge/wc-plugin-framework/woocommerce/api/Abstract_Cacheable_API_Base.php
new file mode 100644
index 0000000..22ee924
--- /dev/null
+++ b/vendor/skyverge/wc-plugin-framework/woocommerce/api/Abstract_Cacheable_API_Base.php
@@ -0,0 +1,273 @@
+is_request_cacheable() && ! $this->get_request()->should_refresh() && $response = $this->load_response_from_cache() ) {
+
+ $this->response_loaded_from_cache = true;
+
+ return $response;
+ }
+
+ return parent::do_remote_request( $request_uri, $request_args );
+ }
+
+
+ /**
+ * Handle and parse the response
+ *
+ * @since 5.10.10
+ *
+ * @param array|\WP_Error $response response data
+ * @throws SV_WC_API_Exception network issues, timeouts, API errors, etc
+ * @return SV_WC_API_Request|object request class instance that implements SV_WC_API_Request
+ */
+ protected function handle_response( $response ) {
+
+ parent::handle_response( $response );
+
+ // cache the response
+ if ( ! $this->is_response_loaded_from_cache() && $this->is_request_cacheable() ) {
+
+ $this->save_response_to_cache( $response );
+ }
+
+ return $this->response; // this param is set by the parent method
+ }
+
+
+ /**
+ * Resets the API response members to their default values.
+ *
+ * @since 5.10.10
+ */
+ protected function reset_response() {
+
+ $this->response_loaded_from_cache = false;
+
+ parent::reset_response();
+ }
+
+
+ /**
+ * Gets the request transient key for the current plugin and request data.
+ *
+ * Request transients can be disabled by using the filter below.
+ *
+ * @since 5.10.10
+ *
+ * @return string transient key
+ */
+ protected function get_request_transient_key() : string {
+
+ // ex: wc_
+
+
+
+
+
+
+
+
+ />
+
+
+
+ %5$s
'; + echo $_GET['sv_wc_framework_deactivate_newer'] > 1 ? + sprintf( 'Deactivated %d plugins', $_GET['sv_wc_framework_deactivate_newer'] ) : + 'Deactivated one plugin'; + echo '
';
+
+ // describe the problem
+ echo '
';
+ }
+
+ // must update WC notice
+ if ( ! empty( $this->incompatible_wc_version_plugins ) ) {
+
+ printf( ''; + echo esc_html( _n( 'The following plugin is disabled because it is out of date and incompatible with newer plugins on your site:', 'The following plugins are disabled because they are out of date and incompatible with newer plugins on your site:', $plugin_count, 'woocommerce-plugin-framework' ) ); + echo '
'; + + // add a incompatible plugin list + echo '- ';
+ foreach ( $this->incompatible_framework_plugins as $plugin ) {
+ printf( '
- %s ', esc_html( $plugin['plugin_name'] ) ); + } + echo '
'; + printf( + /** translators: Placeholders: %1$s - tag, %2$s - tag, %3$s - tag, %4$s - tag, %5$s - tag, %6$s - tag, %7$s - tag, %8$s - tag */ + esc_html( _n( 'To resolve this, please %1$supdate%2$s (recommended) %3$sor%4$s %5$sdeactivate%6$s the above plugin, or %7$sdeactivate the following%8$s:', 'To resolve this, please %1$supdate%2$s (recommended) %3$sor%4$s %5$sdeactivate%6$s the above plugins, or %7$sdeactivate the following%8$s:', $plugin_count, 'woocommerce-plugin-framework' ) ), + '', '', + '', '', + '', '', + '', '' + ); + echo '
'; + + // add the list of active plugins + echo '- ';
+ foreach ( $this->active_plugins as $plugin ) {
+ printf( '
- %s ', esc_html( $plugin['plugin_name'] ) ); + } + echo '
%s
- ', count( $this->incompatible_wc_version_plugins ) > 1 ? esc_html__( 'The following plugins are inactive because they require a newer version of WooCommerce:', 'woocommerce-plugin-framework' ) : esc_html__( 'The following plugin is inactive because it requires a newer version of WooCommerce:', 'woocommerce-plugin-framework' ) );
+
+ foreach ( $this->incompatible_wc_version_plugins as $plugin ) {
+
+ /* translators: Placeholders: %1$s - plugin name, %2$s - WooCommerce version number */
+ echo '
- ' . sprintf( esc_html__( '%1$s requires WooCommerce %2$s or newer', 'woocommerce-plugin-framework' ), esc_html( $plugin['plugin_name'] ), esc_html( $plugin['args']['minimum_wc_version'] ) ) . ' '; + } + + /* translators: Placeholders: %1$s - tag, %2$s - tag */ + echo '
' . sprintf( esc_html__( 'Please %1$supdate WooCommerce%2$s', 'woocommerce-plugin-framework' ), '', ' »' ) . '
%s
- ', count( $this->incompatible_wp_version_plugins ) > 1 ? 'The following plugins are inactive because they require a newer version of WordPress:' : 'The following plugin is inactive because it requires a newer version of WordPress:' );
+
+ foreach ( $this->incompatible_wp_version_plugins as $plugin ) {
+ printf( '
- %s requires WordPress %s or newer ', esc_html( $plugin['plugin_name'] ), esc_html( $plugin['args']['minimum_wp_version'] ) ); + } + + echo '
Please update WordPress »
- ';
+
+ foreach ( $bad_settings as $setting => $values ) {
+
+ $setting_message = '
- ' . $setting_message . ' '; + } + + $message .= '
' . $setting . ' = ' . $values['expected'] . '';
+
+ if ( ! empty( $values['type'] ) && 'min' === $values['type'] ) {
+
+ $setting_message = sprintf(
+ /** translators: Placeholders: %s - a PHP setting value */
+ __( '%s or higher', 'woocommerce-plugin-framework' ),
+ $setting_message
+ );
+ }
+
+ $message .= ''; + + $message .= sprintf( + /* translators: Placeholders: %1$s - , %2$s - */ + __( 'Hey there! We\'ve noticed that your server is running %1$san outdated version of PHP%2$s, which is the programming language that WooCommerce and its extensions are built on. + The PHP version that is currently used for your site is no longer maintained, nor %1$sreceives security updates%2$s; newer versions are faster and more secure. + As a result, %3$s no longer supports this version and you should upgrade PHP as soon as possible. + Your hosting provider can do this for you. %4$sHere are some resources to help you upgrade%5$s and to explain PHP versions further.', 'woocommerce-plugin-framework' ), + '', '', + esc_html( $this->get_plugin()->get_plugin_name() ), + '', '' + ); + + $message .= '
'; + + $this->add_admin_notice( 'sv-wc-deprecated-php-version', $message, 'error' ); + } + } + + + /** + * Adds an admin notice. + * + * @since 5.2.0 + * + * @param string $id notice ID + * @param string $message notice message + * @param string $type notice type + */ + protected function add_admin_notice( $id, $message, $type = 'info' ) { + + $notice_class = $type; + + // translate the types into WP notice classes + switch ( $type ) { + + case 'error': + $notice_class = 'notice-error'; + break; + + case 'warning': + $notice_class = 'notice-warning'; + break; + + case 'info': + $notice_class = 'notice-info'; + break; + + case 'success': + $notice_class = 'notice-success'; + break; + } + + $this->get_plugin()->get_admin_notice_handler()->add_admin_notice( $message, $id, array( + 'notice_class' => $notice_class, + ) ); + } + + + /** + * Returns the active scripts optimization plugins. + * + * Returns a key-value array where the key contains the plugin file identifier and the value is the name of the plugin. + * + * @since 5.7.0 + * + * @return array + */ + public function get_active_scripts_optimization_plugins() { + + /** + * Filters script optimization plugins to look for. + * + * @since 5.7.0 + * + * @param array $plugins an array of file identifiers (keys) and plugin names (values) + */ + $plugins = (array) apply_filters( 'wc_' . $this->get_plugin()->get_id() . '_scripts_optimization_plugins', [ + 'async-javascript.php' => 'Async JavaScript', + 'autoptimize.php' => 'Autoptimize', + 'wp-hummingbird.php' => 'Hummingbird', + 'sg-optimizer.php' => 'SG Optimizer', + 'w3-total-cache.php' => 'W3 Total Cache', + 'wpFastestCache.php' => 'WP Fastest Cache', + 'wp-rocket.php' => 'WP Rocket', + ] ); + + $active_plugins = []; + + foreach ( $plugins as $filename => $plugin_name ) { + + if ( $this->get_plugin()->is_plugin_active( $filename ) ) { + + $active_plugins[ $filename ] = $plugin_name; + } + } + + return $active_plugins; + } + + + /** + * Returns true if any of the known scripts optimization plugins is active. + * + * @since 5.7.0 + * + * @return bool + */ + public function is_scripts_optimization_plugin_active() { + + return ! empty( $this->get_active_scripts_optimization_plugins() ); + } + + + /** Getter methods ********************************************************/ + + + /** + * Gets any missing PHP extensions. + * + * @since 5.2.0 + * + * @return array + */ + public function get_missing_php_extensions() { + + $missing_extensions = []; + + foreach ( $this->get_php_extensions() as $extension ) { + + if ( ! extension_loaded( $extension ) ) { + $missing_extensions[] = $extension; + } + } + + return $missing_extensions; + } + + + /** + * Gets the required PHP extensions. + * + * @since 5.2.0 + * + * @return array + */ + public function get_php_extensions() { + + return $this->php_extensions; + } + + + /** + * Gets any missing PHP functions. + * + * @since 5.2.0 + * + * @return array + */ + public function get_missing_php_functions() { + + $missing_functions = []; + + foreach ( $this->get_php_functions() as $function ) { + + if ( ! extension_loaded( $function ) ) { + $missing_functions[] = $function; + } + } + + return $missing_functions; + } + + + /** + * Gets the required PHP functions. + * + * @since 5.2.0 + * + * @return array + */ + public function get_php_functions() { + + return $this->php_functions; + } + + + /** + * Gets any incompatible PHP settings. + * + * @since 5.2.0 + * + * @return array + */ + public function get_incompatible_php_settings() { + + $incompatible_settings = []; + + if ( function_exists( 'ini_get' ) ) { + + foreach ( $this->get_php_settings() as $setting => $expected ) { + + $actual = ini_get( $setting ); + + if ( ! $actual ) { + continue; + } + + if ( is_int( $expected ) ) { + + // determine if this is a size string, like "10MB" + $is_size = ! is_numeric( substr( $actual, -1 ) ); + + $actual_num = $is_size ? wc_let_to_num( $actual ) : $actual; + + if ( $actual_num < $expected ) { + + $incompatible_settings[ $setting ] = [ + 'expected' => $is_size ? size_format( $expected ) : $expected, + 'actual' => $is_size ? size_format( $actual_num ) : $actual, + 'type' => 'min', + ]; + } + + } elseif ( $actual !== $expected ) { + + $incompatible_settings[ $setting ] = [ + 'expected' => $expected, + 'actual' => $actual, + ]; + } + } + } + + return $incompatible_settings; + } + + + /** + * Gets the required PHP settings. + * + * @since 5.2.0 + * + * @return array + */ + public function get_php_settings() { + + return $this->php_settings; + } + + + /** + * Gets the plugin instance. + * + * @since 5.2.0 + * + * @return SV_WC_Plugin + */ + protected function get_plugin() { + + return $this->plugin; + } + + +} + + +endif; diff --git a/vendor/skyverge/wc-plugin-framework/woocommerce/class-sv-wc-plugin-exception.php b/vendor/skyverge/wc-plugin-framework/woocommerce/class-sv-wc-plugin-exception.php new file mode 100644 index 0000000..9429f67 --- /dev/null +++ b/vendor/skyverge/wc-plugin-framework/woocommerce/class-sv-wc-plugin-exception.php @@ -0,0 +1,38 @@ +id = $id; + $this->version = $version; + + $args = wp_parse_args( $args, [ + 'text_domain' => '', + 'supports_hpos' => false, + 'dependencies' => [], + ] ); + + $this->text_domain = $args['text_domain']; + $this->supports_hpos = $args['supports_hpos']; + + // includes that are required to be available at all times + $this->includes(); + + // initialize the dependencies manager + $this->init_dependencies( $args['dependencies'] ); + + // build the admin message handler instance + $this->init_admin_message_handler(); + + // build the admin notice handler instance + $this->init_admin_notice_handler(); + + // build the hook deprecator instance + $this->init_hook_deprecator(); + + // build the lifecycle handler instance + $this->init_lifecycle_handler(); + + // build the REST API handler instance + $this->init_rest_api_handler(); + + // build the setup handler instance + $this->init_setup_wizard_handler(); + + // add the action & filter hooks + $this->add_hooks(); + } + + + /** Init methods **********************************************************/ + + + /** + * Initializes the plugin dependency handler. + * + * @since 5.2.0 + * + * @param array $dependencies { + * PHP extension, function, and settings dependencies + * + * @type array $php_extensions PHP extension dependencies + * @type array $php_functions PHP function dependencies + * @type array $php_settings PHP settings dependencies + * } + */ + protected function init_dependencies( $dependencies ) { + + $this->dependency_handler = new SV_WC_Plugin_Dependencies( $this, $dependencies ); + } + + + /** + * Builds the admin message handler instance. + * + * Plugins can override this with their own handler. + * + * @since 5.2.0 + */ + protected function init_admin_message_handler() { + + $this->message_handler = new SV_WP_Admin_Message_Handler( $this->get_id() ); + } + + + /** + * Builds the admin notice handler instance. + * + * Plugins can override this with their own handler. + * + * @since 5.2.0 + */ + protected function init_admin_notice_handler() { + + $this->admin_notice_handler = new SV_WC_Admin_Notice_Handler( $this ); + } + + + /** + * Builds the hook deprecator instance. + * + * Plugins can override this with their own handler. + * + * @since 5.2.0 + */ + protected function init_hook_deprecator() { + + $this->hook_deprecator = new SV_WC_Hook_Deprecator( $this->get_plugin_name(), array_merge( $this->get_framework_deprecated_hooks(), $this->get_deprecated_hooks() ) ); + } + + + /** + * Builds the lifecycle handler instance. + * + * Plugins can override this with their own handler to perform install and + * upgrade routines. + * + * @since 5.2.0 + */ + protected function init_lifecycle_handler() { + + $this->lifecycle_handler = new Plugin\Lifecycle( $this ); + } + + + /** + * Builds the REST API handler instance. + * + * Plugins can override this to add their own data and/or routes. + * + * @since 5.2.0 + */ + protected function init_rest_api_handler() { + + $this->rest_api_handler = new REST_API( $this ); + } + + + /** + * Builds the Setup Wizard handler instance. + * + * Plugins can override and extend this method to add their own setup wizard. + * + * @since 5.3.0 + */ + protected function init_setup_wizard_handler() { + + require_once( $this->get_framework_path() . '/admin/abstract-sv-wc-plugin-admin-setup-wizard.php' ); + } + + + /** + * Adds the action & filter hooks. + * + * @since 5.2.0 + */ + private function add_hooks() { + + // initialize the plugin + add_action( 'plugins_loaded', array( $this, 'init_plugin' ), 15 ); + + // initialize the plugin admin + add_action( 'admin_init', array( $this, 'init_admin' ), 0 ); + + // hook for translations separately to ensure they're loaded + add_action( 'init', array( $this, 'load_translations' ) ); + + // handle HPOS compatibility + add_action( 'before_woocommerce_init', [ $this, 'handle_hpos_compatibility' ] ); + + // add the admin notices + add_action( 'admin_notices', array( $this, 'add_admin_notices' ) ); + add_action( 'admin_footer', array( $this, 'add_delayed_admin_notices' ) ); + + // add a 'Configure' link to the plugin action links + add_filter( 'plugin_action_links_' . plugin_basename( $this->get_plugin_file() ), array( $this, 'plugin_action_links' ) ); + + // automatically log HTTP requests from SV_WC_API_Base + $this->add_api_request_logging(); + + // add any PHP incompatibilities to the system status report + add_filter( 'woocommerce_system_status_environment_rows', array( $this, 'add_system_status_php_information' ) ); + } + + + /** + * Cloning instances is forbidden due to singleton pattern. + * + * @since 3.1.0 + */ + public function __clone() { + /* translators: Placeholders: %s - plugin name */ + _doing_it_wrong( __FUNCTION__, sprintf( esc_html__( 'You cannot clone instances of %s.', 'woocommerce-plugin-framework' ), esc_html( $this->get_plugin_name() ) ), '3.1.0' ); + } + + + /** + * Unserializing instances is forbidden due to singleton pattern. + * + * @since 3.1.0 + */ + public function __wakeup() { + /* translators: Placeholders: %s - plugin name */ + _doing_it_wrong( __FUNCTION__, sprintf( esc_html__( 'You cannot unserialize instances of %s.', 'woocommerce-plugin-framework' ), esc_html( $this->get_plugin_name() ) ), '3.1.0' ); + } + + + /** + * Load plugin & framework text domains. + * + * @internal + * + * @since 4.2.0 + */ + public function load_translations() { + + $this->load_framework_textdomain(); + + // if this plugin passes along its text domain, load its translation files + if ( $this->text_domain ) { + $this->load_plugin_textdomain(); + } + } + + + /** + * Loads the framework textdomain. + * + * @since 4.5.0 + */ + protected function load_framework_textdomain() { + $this->load_textdomain( 'woocommerce-plugin-framework', dirname( plugin_basename( $this->get_framework_file() ) ) ); + } + + + /** + * Loads the plugin textdomain. + * + * @since 4.5.0 + */ + protected function load_plugin_textdomain() { + $this->load_textdomain( $this->text_domain, dirname( plugin_basename( $this->get_plugin_file() ) ) ); + } + + + /** + * Loads the plugin textdomain. + * + * @since 4.5.0 + * @param string $textdomain the plugin textdomain + * @param string $path the i18n path + */ + protected function load_textdomain( $textdomain, $path ) { + + // user's locale if in the admin for WP 4.7+, or the site locale otherwise + $locale = is_admin() && is_callable( 'get_user_locale' ) ? get_user_locale() : get_locale(); + + $locale = apply_filters( 'plugin_locale', $locale, $textdomain ); + + load_textdomain( $textdomain, WP_LANG_DIR . '/' . $textdomain . '/' . $textdomain . '-' . $locale . '.mo' ); + + load_plugin_textdomain( $textdomain, false, untrailingslashit( $path ) . '/i18n/languages' ); + } + + + /** + * Initializes the plugin. + * + * Plugins can override this to set up any handlers after WordPress is ready. + * + * @since 5.2.0 + */ + public function init_plugin() { + + // stub + } + + + /** + * Initializes the plugin admin. + * + * Plugins can override this to set up any handlers after the WordPress admin is ready. + * + * @since 5.2.0 + */ + public function init_admin() { + + // stub + } + + + /** + * Include any critical files which must be available as early as possible, + * + * @since 2.0.0 + */ + private function includes() { + + $framework_path = $this->get_framework_path(); + + // common exception class + require_once( $framework_path . '/class-sv-wc-plugin-exception.php' ); + + // addresses + require_once( $framework_path . '/Addresses/Address.php' ); + require_once( $framework_path . '/Addresses/Customer_Address.php' ); + + // Settings API + require_once( $framework_path . '/Settings_API/Abstract_Settings.php' ); + require_once( $framework_path . '/Settings_API/Setting.php' ); + require_once( $framework_path . '/Settings_API/Control.php' ); + + // common utility methods + require_once( $framework_path . '/class-sv-wc-helper.php' ); + require_once( $framework_path . '/Country_Helper.php' ); + require_once( $framework_path . '/admin/Notes_Helper.php' ); + + // backwards compatibility for older WC versions + require_once( $framework_path . '/class-sv-wc-plugin-compatibility.php' ); + require_once( $framework_path . '/compatibility/abstract-sv-wc-data-compatibility.php' ); + require_once( $framework_path . '/compatibility/class-sv-wc-order-compatibility.php' ); + + // generic API base + require_once( $framework_path . '/api/class-sv-wc-api-exception.php' ); + require_once( $framework_path . '/api/class-sv-wc-api-base.php' ); + require_once( $framework_path . '/api/interface-sv-wc-api-request.php' ); + require_once( $framework_path . '/api/interface-sv-wc-api-response.php' ); + + // XML API base + require_once( $framework_path . '/api/abstract-sv-wc-api-xml-request.php' ); + require_once( $framework_path . '/api/abstract-sv-wc-api-xml-response.php' ); + + // JSON API base + require_once( $framework_path . '/api/abstract-sv-wc-api-json-request.php' ); + require_once( $framework_path . '/api/abstract-sv-wc-api-json-response.php' ); + + // Cacheable API + require_once( $framework_path . '/api/traits/Cacheable_Request_Trait.php' ); + require_once( $framework_path . '/api/Abstract_Cacheable_API_Base.php' ); + + // REST API Controllers + require_once( $framework_path . '/rest-api/Controllers/Settings.php' ); + + // Handlers + require_once( $framework_path . '/Handlers/Script_Handler.php' ); + require_once( $framework_path . '/class-sv-wc-plugin-dependencies.php' ); + require_once( $framework_path . '/class-sv-wc-hook-deprecator.php' ); + require_once( $framework_path . '/class-sv-wp-admin-message-handler.php' ); + require_once( $framework_path . '/class-sv-wc-admin-notice-handler.php' ); + require_once( $framework_path . '/Lifecycle.php' ); + require_once( $framework_path . '/rest-api/class-sv-wc-plugin-rest-api.php' ); + } + + + /** + * Gets a list of framework deprecated/removed hooks. + * + * @see SV_WC_Plugin::init_hook_deprecator() + * @see SV_WC_Plugin::get_deprecated_hooks() + * + * @since 5.8.0 + * + * @return array associative array + */ + private function get_framework_deprecated_hooks() { + + $plugin_id = $this->get_id(); + $deprecated_hooks = []; + $deprecated_filters = [ + /** @see SV_WC_Payment_Gateway_My_Payment_Methods handler - once migrated to WC core tokens UI, we removed these and have no replacement */ + // TODO: remove deprecated hooks handling by version 6.0.0 or by 2021-02-25 {FN 2020-02-25} + "wc_{$plugin_id}_my_payment_methods_table_html", + "wc_{$plugin_id}_my_payment_methods_table_head_html", + "wc_{$plugin_id}_my_payment_methods_table_title", + "wc_{$plugin_id}_my_payment_methods_table_title_html", + "wc_{$plugin_id}_my_payment_methods_table_row_html", + "wc_{$plugin_id}_my_payment_methods_table_body_html", + "wc_{$plugin_id}_my_payment_methods_table_body_row_data", + "wc_{$plugin_id}_my_payment_methods_table_method_expiry_html", + "wc_{$plugin_id}_my_payment_methods_table_actions_html", + ]; + + foreach ( $deprecated_filters as $deprecated_filter ) { + $deprecated_hooks[ $deprecated_filter ] = [ + 'removed' => true, + 'replacement' => false, + 'version' => '5.8.1' + ]; + } + + return $deprecated_hooks; + } + + + /** + * Gets a list of the plugin's deprecated/removed hooks. + * + * Implementing classes should override this and return an array of deprecated/removed hooks in the following format: + * + * $old_hook_name = array { + * @type string $version version the hook was deprecated/removed in + * @type bool $removed if present and true, the message will indicate the hook was removed instead of deprecated + * @type string|bool $replacement if present and a string, the message will indicate the replacement hook to use, + * otherwise (if bool and false) the message will indicate there is no replacement available. + * } + * + * @since 4.3.0 + * + * @return array + */ + protected function get_deprecated_hooks() { + + // stub method + return []; + } + + + /** Admin methods ******************************************************/ + + + /** + * Returns true if on the admin plugin settings page, if any + * + * @since 2.0.0 + * @return boolean true if on the admin plugin settings page + */ + public function is_plugin_settings() { + // optional method, not all plugins *have* a settings page + return false; + } + + + /** + * Adds admin notices upon initialization. + * + * @internal + * + * @since 3.0.0 + */ + public function add_admin_notices() { + // stub method + } + + + /** + * Convenience method to add delayed admin notices, which may depend upon + * some setting being saved prior to determining whether to render + * + * @since 3.0.0 + */ + public function add_delayed_admin_notices() { + // stub method + } + + + /** + * Return the plugin action links. This will only be called if the plugin + * is active. + * + * @since 2.0.0 + * @param array $actions associative array of action names to anchor tags + * @return array associative array of plugin action links + */ + public function plugin_action_links( $actions ) { + + $custom_actions = array(); + + // settings url(s) + if ( $this->get_settings_link( $this->get_id() ) ) { + $custom_actions['configure'] = $this->get_settings_link( $this->get_id() ); + } + + // documentation url if any + if ( $this->get_documentation_url() ) { + /* translators: Docs as in Documentation */ + $custom_actions['docs'] = sprintf( '%s', $this->get_documentation_url(), esc_html__( 'Docs', 'woocommerce-plugin-framework' ) ); + } + + // support url if any + if ( $this->get_support_url() ) { + $custom_actions['support'] = sprintf( '%s', $this->get_support_url(), esc_html_x( 'Support', 'noun', 'woocommerce-plugin-framework' ) ); + } + + // review url if any + if ( $this->get_reviews_url() ) { + $custom_actions['review'] = sprintf( '%s', $this->get_reviews_url(), esc_html_x( 'Review', 'verb', 'woocommerce-plugin-framework' ) ); + } + + // add the links to the front of the actions list + return array_merge( $custom_actions, $actions ); + } + + + /** + * Declares HPOS compatibility if the plugin is compatible with HPOS. + * + * @internal + * + * @since 5.11.0 + */ + public function handle_hpos_compatibility() { + + if ( class_exists( \Automattic\WooCommerce\Utilities\FeaturesUtil::class ) ) { + \Automattic\WooCommerce\Utilities\FeaturesUtil::declare_compatibility( 'custom_order_tables', $this->get_plugin_file(), $this->is_hpos_compatible() ); + } + } + + + /** Helper methods ******************************************************/ + + + /** + * Automatically log API requests/responses when using SV_WC_API_Base + * + * @since 2.2.0 + * @see SV_WC_API_Base::broadcast_request() + */ + public function add_api_request_logging() { + + if ( ! has_action( 'wc_' . $this->get_id() . '_api_request_performed' ) ) { + add_action( 'wc_' . $this->get_id() . '_api_request_performed', array( $this, 'log_api_request' ), 10, 2 ); + } + } + + + /** + * Log API requests/responses + * + * @since 2.2.0 + * @param array $request request data, see SV_WC_API_Base::broadcast_request() for format + * @param array $response response data + * @param string|null $log_id log to write data to + */ + public function log_api_request( $request, $response, $log_id = null ) { + + $this->log( "Request\n" . $this->get_api_log_message( $request ), $log_id ); + + if ( ! empty( $response ) ) { + $this->log( "Response\n" . $this->get_api_log_message( $response ), $log_id ); + } + } + + + /** + * Transform the API request/response data into a string suitable for logging + * + * @since 2.2.0 + * @param array $data + * @return string + */ + public function get_api_log_message( $data ) { + + $messages = array(); + + $messages[] = isset( $data['uri'] ) && $data['uri'] ? 'Request' : 'Response'; + + foreach ( (array) $data as $key => $value ) { + + if ( is_array( $value ) || ( is_object( $value ) && 'stdClass' === get_class( $value ) ) ) { + $value = print_r( (array) $value, true ); + } elseif ( is_bool( $value ) ) { + $value = wc_bool_to_string( $value ); + } + + $messages[] = trim( sprintf( '%s: %s', $key, $value ) ); + } + + return implode( "\n", $messages ) . "\n"; + } + + + /** + * Adds any PHP incompatibilities to the system status report. + * + * @since 4.5.0 + * + * @param array $rows WooCommerce system status rows + * @return array + */ + public function add_system_status_php_information( $rows ) { + + foreach ( $this->get_dependency_handler()->get_incompatible_php_settings() as $setting => $values ) { + + if ( isset( $values['type'] ) && 'min' === $values['type'] ) { + + // if this setting already has a higher minimum from another plugin, skip it + if ( isset( $rows[ $setting ]['expected'] ) && $values['expected'] < $rows[ $setting ]['expected'] ) { + continue; + } + + $note = __( '%1$s - A minimum of %2$s is required.', 'woocommerce-plugin-framework' ); + + } else { + + // if this requirement is already listed, skip it + if ( isset( $rows[ $setting ] ) ) { + continue; + } + + $note = __( 'Set as %1$s - %2$s is required.', 'woocommerce-plugin-framework' ); + } + + $note = sprintf( $note, $values['actual'], $values['expected'] ); + + $rows[ $setting ] = array( + 'name' => $setting, + 'note' => $note, + 'success' => false, + 'expected' => $values['expected'], // WC doesn't use this, but it's useful for us + ); + } + + return $rows; + } + + + /** + * Saves errors or messages to WooCommerce Log (woocommerce/logs/plugin-id-xxx.txt) + * + * @since 2.0.0 + * @param string $message error or message to save to log + * @param string $log_id optional log id to segment the files by, defaults to plugin id + */ + public function log( $message, $log_id = null ) { + + if ( is_null( $log_id ) ) { + $log_id = $this->get_id(); + } + + if ( ! is_object( $this->logger ) ) { + $this->logger = new \WC_Logger(); + } + + $this->logger->add( $log_id, $message ); + } + + + /** + * Require and instantiate a class + * + * @since 4.2.0 + * @param string $local_path path to class file in plugin, e.g. '/includes/class-wc-foo.php' + * @param string $class_name class to instantiate + * @return object instantiated class instance + */ + public function load_class( $local_path, $class_name ) { + + require_once( $this->get_plugin_path() . $local_path ); + + return new $class_name; + } + + + /** + * Determines if TLS v1.2 is required for API requests. + * + * Subclasses should override this to return true if TLS v1.2 is required. + * + * @since 5.5.2 + * + * @return bool + */ + public function require_tls_1_2() { + + return false; + } + + + /** + * Determines if TLS 1.2 is available. + * + * @since 5.5.2 + * + * @return bool + */ + public function is_tls_1_2_available() { + + // assume availability to avoid notices for unknown SSL types + $is_available = true; + + // check the cURL version if installed + if ( is_callable( 'curl_version' ) ) { + + $versions = curl_version(); + + // cURL 7.34.0 is considered the minimum version that supports TLS 1.2 + if ( version_compare( $versions['version'], '7.34.0', '<' ) ) { + $is_available = false; + } + } + + return $is_available; + } + + + /** + * Determines whether the plugin supports HPOS. + * + * @since 5.11.0 + * + * @return bool + */ + public function is_hpos_compatible() : bool + { + return $this->supports_hpos && SV_WC_Plugin_Compatibility::is_wc_version_gte('7.6'); + } + + + /** Getter methods ******************************************************/ + + + /** + * Gets the main plugin file. + * + * @since 5.0.0 + * + * @return string + */ + public function get_plugin_file() { + + $slug = dirname( plugin_basename( $this->get_file() ) ); + + return trailingslashit( $slug ) . $slug . '.php'; + } + + + /** + * The implementation for this abstract method should simply be: + * + * return __FILE__; + * + * @since 2.0.0 + * @return string the full path and filename of the plugin file + */ + abstract protected function get_file(); + + + /** + * Returns the plugin id + * + * @since 2.0.0 + * @return string plugin id + */ + public function get_id() { + return $this->id; + } + + + /** + * Returns the plugin id with dashes in place of underscores, and + * appropriate for use in frontend element names, classes and ids + * + * @since 2.0.0 + * @return string plugin id with dashes in place of underscores + */ + public function get_id_dasherized() { + return str_replace( '_', '-', $this->get_id() ); + } + + + /** + * Returns the plugin full name including "WooCommerce", ie + * "WooCommerce X". This method is defined abstract for localization purposes + * + * @since 2.0.0 + * @return string plugin name + */ + abstract public function get_plugin_name(); + + + /** Handler methods *******************************************************/ + + + /** + * Gets the dependency handler. + * + * @since 5.2.0.1 + * + * @return SV_WC_Plugin_Dependencies + */ + public function get_dependency_handler() { + + return $this->dependency_handler; + } + + + /** + * Gets the lifecycle handler instance. + * + * @since 5.1.0 + * + * @return Plugin\Lifecycle + */ + public function get_lifecycle_handler() { + + return $this->lifecycle_handler; + } + + + /** + * Gets the Setup Wizard handler instance. + * + * @since 5.3.0 + * + * @return null|Admin\Setup_Wizard + */ + public function get_setup_wizard_handler() { + + return $this->setup_wizard_handler; + } + + + /** + * Gets the admin message handler. + * + * @since 2.0.0 + * + * @return SV_WP_Admin_Message_Handler + */ + public function get_message_handler() { + + return $this->message_handler; + } + + + /** + * Gets the admin notice handler instance. + * + * @since 3.0.0 + * + * @return SV_WC_Admin_Notice_Handler + */ + public function get_admin_notice_handler() { + + return $this->admin_notice_handler; + } + + + /** + * Gets the settings API handler instance. + * + * Plugins can use this to init the settings API handler. + * + * @since 5.7.0 + * + * @return void|Settings_API\Abstract_Settings + */ + public function get_settings_handler() { + + return; + } + + + /** + * Returns the plugin version name. Defaults to wc_{plugin id}_version + * + * @since 2.0.0 + * @return string the plugin version name + */ + public function get_plugin_version_name() { + + return 'wc_' . $this->get_id() . '_version'; + } + + + /** + * Returns the current version of the plugin + * + * @since 2.0.0 + * @return string plugin version + */ + public function get_version() { + return $this->version; + } + + + /** + * Returns the "Configure" plugin action link to go directly to the plugin + * settings page (if any) + * + * @since 2.0.0 + * @see SV_WC_Plugin::get_settings_url() + * @param string $plugin_id optional plugin identifier. Note that this can be a + * sub-identifier for plugins with multiple parallel settings pages + * (ie a gateway that supports both credit cards and echecks) + * @return string plugin configure link + */ + public function get_settings_link( $plugin_id = null ) { + + $settings_url = $this->get_settings_url( $plugin_id ); + + if ( $settings_url ) { + return sprintf( '%s', $settings_url, esc_html__( 'Configure', 'woocommerce-plugin-framework' ) ); + } + + // no settings + return ''; + } + + + /** + * Gets the plugin configuration URL + * + * @since 2.0.0 + * @see SV_WC_Plugin::get_settings_link() + * @param string $plugin_id optional plugin identifier. Note that this can be a + * sub-identifier for plugins with multiple parallel settings pages + * (ie a gateway that supports both credit cards and echecks) + * @return string plugin settings URL + */ + public function get_settings_url( $plugin_id = null ) { + + // stub method + return ''; + } + + + /** + * Returns true if the current page is the admin general configuration page + * + * @since 3.0.0 + * @return boolean true if the current page is the admin general configuration page + */ + public function is_general_configuration_page() { + + return isset( $_GET['page'] ) && 'wc-settings' === $_GET['page'] && ( ! isset( $_GET['tab'] ) || 'general' === $_GET['tab'] ); + } + + + /** + * Returns the admin configuration url for the admin general configuration page + * + * @since 3.0.0 + * @return string admin configuration url for the admin general configuration page + */ + public function get_general_configuration_url() { + + return admin_url( 'admin.php?page=wc-settings&tab=general' ); + } + + + /** + * Gets the plugin documentation url, used for the 'Docs' plugin action + * + * @since 2.0.0 + * @return string documentation URL + */ + public function get_documentation_url() { + + return null; + } + + + /** + * Gets the support URL, used for the 'Support' plugin action link + * + * @since 4.0.0 + * @return string support url + */ + public function get_support_url() { + + return null; + } + + + /** + * Gets the plugin sales page URL. + * + * @since 5.1.0 + * + * @return string + */ + public function get_sales_page_url() { + + return ''; + } + + + /** + * Gets the plugin reviews page URL. + * + * Used for the 'Reviews' plugin action and review prompts. + * + * @since 5.1.0 + * + * @return string + */ + public function get_reviews_url() { + + return $this->get_sales_page_url() ? $this->get_sales_page_url() . '#comments' : ''; + } + + + /** + * Gets the plugin's path without a trailing slash. + * + * e.g. /path/to/wp-content/plugins/plugin-directory + * + * @since 2.0.0 + * + * @return string + */ + public function get_plugin_path() { + + if ( null === $this->plugin_path ) { + $this->plugin_path = untrailingslashit( plugin_dir_path( $this->get_file() ) ); + } + + return $this->plugin_path; + } + + + /** + * Gets the plugin's URL without a trailing slash. + * + * E.g. http://skyverge.com/wp-content/plugins/plugin-directory + * + * @since 2.0.0 + * + * @return string + */ + public function get_plugin_url() { + + if ( null === $this->plugin_url ) { + $this->plugin_url = untrailingslashit( plugins_url( '/', $this->get_file() ) ); + } + + return $this->plugin_url; + } + + + /** + * Gets the woocommerce uploads path, without trailing slash. + * + * Oddly WooCommerce core does not provide a way to get this. + * + * @since 2.0.0 + * + * @return string + */ + public static function get_woocommerce_uploads_path() { + + $upload_dir = wp_upload_dir(); + + return $upload_dir['basedir'] . '/woocommerce_uploads'; + } + + + /** + * Returns the loaded framework __FILE__ + * + * @since 4.0.0 + * @return string + */ + public function get_framework_file() { + + return __FILE__; + } + + + /** + * Gets the loaded framework path, without trailing slash. + * + * This matches the path to the highest version of the framework currently loaded. + * + * @since 4.0.0 + * @return string + */ + public function get_framework_path() { + + return untrailingslashit( plugin_dir_path( $this->get_framework_file() ) ); + } + + + /** + * Gets the absolute path to the loaded framework image directory, without a trailing slash. + * + * @since 4.0.0 + * + * @return string + */ + public function get_framework_assets_path() { + + return $this->get_framework_path() . '/assets'; + } + + + /** + * Gets the loaded framework assets URL without a trailing slash. + * + * @since 4.0.0 + * + * @return string + */ + public function get_framework_assets_url() { + + return untrailingslashit( plugins_url( '/assets', $this->get_framework_file() ) ); + } + + + /** + * Gets the plugin default template path, without a trailing slash. + * + * @since 5.5.0 + * + * @return string + */ + public function get_template_path() { + + if ( null === $this->template_path ) { + $this->template_path = $this->get_plugin_path() . '/templates'; + } + + return $this->template_path; + } + + + /** + * Loads and outputs a template file HTML. + * + * @see \wc_get_template() except we define automatically the default path + * + * @since 5.5.0 + * + * @param string $template template name/part + * @param array $args associative array of optional template arguments + * @param string $path optional template path, can be empty, as themes can override this + * @param string $default_path optional default template path, will normally use the plugin's own template path unless overridden + */ + public function load_template( $template, array $args = [], $path = '', $default_path = '' ) { + + if ( '' === $default_path || ! is_string( $default_path ) ) { + $default_path = trailingslashit( $this->get_template_path() ); + } + + wc_get_template( $template, $args, $path, $default_path ); + } + + + /** + * Determines whether a plugin is active. + * + * @since 2.0.0 + * + * @param string $plugin_name plugin name, as the plugin-filename.php + * @return boolean true if the named plugin is installed and active + */ + public function is_plugin_active( $plugin_name ) { + + $is_active = false; + + if ( is_string( $plugin_name ) ) { + + if ( ! array_key_exists( $plugin_name, $this->active_plugins ) ) { + + $active_plugins = (array) get_option( 'active_plugins', array() ); + + if ( is_multisite() ) { + $active_plugins = array_merge( $active_plugins, array_keys( get_site_option( 'active_sitewide_plugins', array() ) ) ); + } + + $plugin_filenames = array(); + + foreach ( $active_plugins as $plugin ) { + + if ( SV_WC_Helper::str_exists( $plugin, '/' ) ) { + + // normal plugin name (plugin-dir/plugin-filename.php) + list( , $filename ) = explode( '/', $plugin ); + + } else { + + // no directory, just plugin file + $filename = $plugin; + } + + $plugin_filenames[] = $filename; + } + + $this->active_plugins[ $plugin_name ] = in_array( $plugin_name, $plugin_filenames, true ); + } + + $is_active = (bool) $this->active_plugins[ $plugin_name ]; + } + + return $is_active; + } + + +} + + +endif; diff --git a/vendor/skyverge/wc-plugin-framework/woocommerce/class-sv-wp-admin-message-handler.php b/vendor/skyverge/wc-plugin-framework/woocommerce/class-sv-wp-admin-message-handler.php new file mode 100644 index 0000000..5d6a42f --- /dev/null +++ b/vendor/skyverge/wc-plugin-framework/woocommerce/class-sv-wp-admin-message-handler.php @@ -0,0 +1,438 @@ +add_message( 'Hello World!' ); + * ` + * + * Then show the messages wherever you need, either with the built-in method + * or by writing your own: + * + * `$admin_message_handler->show_messages();` + * + * @version 1.0.1 + */ +class SV_WP_Admin_Message_Handler { + + + /** transient message prefix */ + const MESSAGE_TRANSIENT_PREFIX = '_wp_admin_message_'; + + /** the message id GET name */ + const MESSAGE_ID_GET_NAME = 'wpamhid'; + + + /** @var string unique message identifier, defaults to __FILE__ unless otherwise set */ + private $message_id; + + /** @var array array of messages */ + private $messages = array(); + + /** @var array array of error messages */ + private $errors = array(); + + /** @var array array of warning messages */ + private $warnings = array(); + + /** @var array array of info messages */ + private $infos = array(); + + + /** + * Construct and initialize the admin message handler class + * + * @since 1.0.0 + * @param string $message_id optional message id. Best practice is to set + * this to a unique identifier based on the client plugin, such as __FILE__ + */ + public function __construct( $message_id = null ) { + + $this->message_id = $message_id; + + // load any available messages + $this->load_messages(); + + add_filter( 'wp_redirect', array( $this, 'redirect' ), 1, 2 ); + } + + + /** + * Persist messages + * + * @since 1.0.0 + * @return boolean true if any messages were set, false otherwise + */ + public function set_messages() { + + // any messages to persist? + if ( $this->message_count() > 0 || $this->info_count() > 0 || $this->warning_count() > 0 || $this->error_count() > 0 ) { + + set_transient( + self::MESSAGE_TRANSIENT_PREFIX . $this->get_message_id(), + array( + 'errors' => $this->errors, + 'warnings' => $this->warnings, + 'infos' => $this->infos, + 'messages' => $this->messages, + ), + 60 * 60 + ); + + return true; + } + + return false; + } + + + /** + * Loads messages + * + * @since 1.0.0 + */ + public function load_messages() { + + if ( isset( $_GET[ self::MESSAGE_ID_GET_NAME ] ) && $this->get_message_id() == $_GET[ self::MESSAGE_ID_GET_NAME ] ) { + + $memo = get_transient( self::MESSAGE_TRANSIENT_PREFIX . $_GET[ self::MESSAGE_ID_GET_NAME ] ); + + if ( isset( $memo['errors'] ) ) $this->errors = $memo['errors']; + if ( isset( $memo['warnings'] ) ) $this->warnings = $memo['warnings']; + if ( isset( $memo['infos'] ) ) $this->infos = $memo['infos']; + if ( isset( $memo['messages'] ) ) $this->messages = $memo['messages']; + + $this->clear_messages( $_GET[ self::MESSAGE_ID_GET_NAME ] ); + } + } + + + /** + * Clear messages and errors + * + * @since 1.0.0 + * @param string $id the messages identifier + */ + public function clear_messages( $id ) { + delete_transient( self::MESSAGE_TRANSIENT_PREFIX . $id ); + } + + + /** + * Add an error message. + * + * @since 1.0.0 + * @param string $error error message + */ + public function add_error( $error ) { + $this->errors[] = $error; + } + + + /** + * Adds a warning message. + * + * @since 5.1.0 + * + * @param string $message warning message to add + */ + public function add_warning( $message ) { + $this->warnings[] = $message; + } + + + /** + * Adds a info message. + * + * @since 5.1.0 + * + * @param string $message info message to add + */ + public function add_info( $message ) { + $this->infos[] = $message; + } + + + /** + * Add a message. + * + * @since 1.0.0 + * @param string $message the message to add + */ + public function add_message( $message ) { + $this->messages[] = $message; + } + + + /** + * Get error count. + * + * @since 1.0.0 + * @return int error message count + */ + public function error_count() { + return sizeof( $this->errors ); + } + + + /** + * Gets the warning message count. + * + * @since 5.1.0 + * + * @return int warning message count + */ + public function warning_count() { + return sizeof( $this->warnings ); + } + + + /** + * Gets the info message count. + * + * @since 5.1.0 + * + * @return int info message count + */ + public function info_count() { + return sizeof( $this->infos ); + } + + + /** + * Get message count. + * + * @since 1.0.0 + * @return int message count + */ + public function message_count() { + return sizeof( $this->messages ); + } + + + /** + * Get error messages + * + * @since 1.0.0 + * @return array of error message strings + */ + public function get_errors() { + return $this->errors; + } + + + /** + * Get an error message + * + * @since 1.0.0 + * @param int $index the error index + * @return string the error message + */ + public function get_error( $index ) { + return isset( $this->errors[ $index ] ) ? $this->errors[ $index ] : ''; + } + + + /** + * Gets all warning messages. + * + * @since 5.1.0 + * + * @return array + */ + public function get_warnings() { + return $this->warnings; + } + + + /** + * Gets a specific warning message. + * + * @since 5.1.0 + * + * @param int $index warning message index + * @return string + */ + public function get_warning( $index ) { + return isset( $this->warnings[ $index ] ) ? $this->warnings[ $index ] : ''; + } + + + /** + * Gets all info messages. + * + * @since 5.1.0 + * + * @return array + */ + public function get_infos() { + return $this->infos; + } + + + /** + * Gets a specific info message. + * + * @since 5.0.0 + * + * @param int $index info message index + * @return string + */ + public function get_info( $index ) { + return isset( $this->infos[ $index ] ) ? $this->infos[ $index ] : ''; + } + + + /** + * Get messages + * + * @since 1.0.0 + * @return array of message strings + */ + public function get_messages() { + return $this->messages; + } + + + /** + * Get a message + * + * @since 1.0.0 + * @param int $index the message index + * @return string the message + */ + public function get_message( $index ) { + return isset( $this->messages[ $index ] ) ? $this->messages[ $index ] : ''; + } + + + /** + * Render the errors and messages. + * + * @since 1.0.0 + * @param array $params { + * Optional parameters. + * + * @type array $capabilities Any user capabilities to check if the user is allowed to view the messages, + * default: `manage_woocommerce` + * } + */ + public function show_messages( $params = array() ) { + + $params = wp_parse_args( $params, array( + 'capabilities' => array( + 'manage_woocommerce', + ), + ) ); + + $check_user_capabilities = array(); + + // check if user has at least one capability that allows to see messages + foreach ( $params['capabilities'] as $capability ) { + $check_user_capabilities[] = current_user_can( $capability ); + } + + // bail out if user has no minimum capabilities to see messages + if ( ! in_array( true, $check_user_capabilities, true ) ) { + return; + } + + $output = ''; + + if ( $this->error_count() > 0 ) { + $output .= '- ' . implode( '
- ', $this->get_errors() ) . '
- ' . implode( '
- ', $this->get_warnings() ) . '
- ' . implode( '
- ', $this->get_infos() ) . '
- ' . implode( '
- ', $this->get_messages() ) . '
+
+ =' );
+ }
+
+
+ /**
+ * Returns the message for display when the environment is incompatible with this plugin.
+ *
+ * @since 1.10.0
+ *
+ * @return string
+ */
+ protected function get_environment_message() {
+
+ return sprintf( 'The minimum PHP version required for this plugin is %1$s. You are running %2$s.', self::MINIMUM_PHP_VERSION, PHP_VERSION );
+ }
+
+
+ /**
+ * Returns the main plugin loader instance.
+ *
+ * Ensures only one instance can be loaded.
+ *
+ * @since 1.10.0
+ *
+ * @return \WC_Tab_Manager_Loader
+ */
+ public static function instance() {
+
+ if ( null === self::$instance ) {
+
+ self::$instance = new self();
+ }
+
+ return self::$instance;
+ }
+
+
+}
+
+// fire it up!
+WC_Tab_Manager_Loader::instance();
diff --git a/wpml-config.xml b/wpml-config.xml
new file mode 100644
index 0000000..ee3ac3f
--- /dev/null
+++ b/wpml-config.xml
@@ -0,0 +1,22 @@
+array( 'href' => array() ) ) ); ?>
+