Overview

Namespaces

  • None
  • VSP
    • Core
      • Abstracts
      • Interfaces
      • Traits
        • WC_Compatibility
    • Deprecation
    • Helper
    • Modules
      • Addons
      • Logger

Classes

  • VSP\Ajax
  • VSP\Ajaxer
  • VSP\Base
  • VSP\Cache
  • VSP\Core\Abstracts\Addon
  • VSP\Core\Abstracts\Log_Handler
  • VSP\Core\Abstracts\Plugin_Settings
  • VSP\Core\Instance_Handler
  • VSP\Deprecation\Actions
  • VSP\Deprecation\Filters
  • VSP\Error
  • VSP\Framework
  • VSP\Framework_Admin
  • VSP\Framework_Base
  • VSP\Framework_Modules
  • VSP\Helper
  • VSP\Helper\Price_Calculation
  • VSP\Modules\Addons
  • VSP\Modules\Addons\Admin
  • VSP\Modules\Addons\Core
  • VSP\Modules\Logger
  • VSP\Modules\Logger\File_Handler
  • VSP\Modules\Logger\Levels
  • VSP\Modules\Shortcode
  • VSP\Modules\System_Logs
  • VSP\Modules\System_Tools
  • VSP\Modules\WPOnion
  • VSP\Setup
  • VSP\WC_Compatibility
  • VSP_Framework_Loader

Interfaces

  • VSP\Core\Interfaces\Log_Handler
  • VSP\Core\Interfaces\Logger

Traits

  • VSP\Core\Traits\Array_Helper
  • VSP\Core\Traits\Framework
  • VSP\Core\Traits\String_Helper
  • VSP\Core\Traits\URL
  • VSP\Core\Traits\WC_Compatibility\Product
  • VSP\Core\Traits\WC_Compatibility\Version
  • VSP\Core\Traits\WC_Helper
  • VSP\Core\Traits\WP

Functions

  • vsp_add_wc_required_notice
  • vsp_ajax_action
  • vsp_current_screen
  • vsp_date_format
  • vsp_delete_cache
  • vsp_doing_it_wrong
  • vsp_force_load
  • vsp_force_load_vendors
  • vsp_get_cache
  • vsp_get_cache_defaults
  • vsp_get_file_paths
  • vsp_get_logger
  • vsp_get_time_in_seconds
  • vsp_is_admin
  • vsp_is_ajax
  • vsp_is_cron
  • vsp_is_error
  • vsp_is_frontend
  • vsp_is_heartbeat
  • vsp_is_json
  • vsp_is_request
  • vsp_is_screen
  • vsp_json_last_error
  • vsp_list_files
  • vsp_list_log_files
  • vsp_load_core_assets
  • vsp_load_file
  • vsp_log_msg
  • vsp_logger
  • vsp_make_log_list_tree
  • vsp_maybe_load
  • vsp_placeholder_img
  • vsp_print_log_files_ui
  • vsp_register_assets
  • vsp_register_plugin
  • vsp_send_callback_error
  • vsp_send_callback_success
  • vsp_send_json_callback
  • vsp_set_cache
  • vsp_set_time_limit
  • vsp_slashit
  • vsp_time_format
  • vsp_unslashit
  • vsp_url
  • vsp_validate_required_plugin
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 
<?php

defined( 'ABSPATH' ) || exit;

if ( ! function_exists( 'vsp_url' ) ) {
    /**
     * Returns VSP Framework url
     *
     * @param string $extra
     * @param bool   $is_url
     *
     * @return string
     */
    function vsp_url( $extra = '', $is_url = true ) {
        return ( $is_url ) ? VSP_URL . $extra : VSP_PATH . $extra;
    }
}

if ( ! function_exists( 'vsp_load_file' ) ) {
    /**
     * Search and loads files based on the search parameter
     *
     * @param         $search_type
     * @param boolean $is_require
     * @param bool    $once
     *
     * @uses    vsp_get_file_paths
     * @example vsp_load_file("mypath/*.php")
     * @example vsp_load_file("mypath/class-*.php")
     */
    function vsp_load_file( $search_type, $is_require = true, $once = false ) {
        foreach ( vsp_get_file_paths( $search_type ) as $src ) {
            if ( $is_require && $once ) {
                require_once $src;
            } elseif ( $is_require ) {
                require $src;
            } elseif ( $once ) {
                include_once $src;
            } else {
                include $src;
            }
        }
    }
}

if ( ! function_exists( 'vsp_get_file_paths' ) ) {
    /**
     * Returns files in a given path
     *
     * @param $path .
     *
     * @return array
     * @example vsp_load_file("mypath/*.php")
     * @example vsp_load_file("mypath/class-*.php")
     */
    function vsp_get_file_paths( $path ) {
        return glob( $path );
    }
}

if ( ! function_exists( 'vsp_list_files' ) ) {
    /**
     * Generates Nested Array Output of Files inside a folder.
     *
     * @param       $path
     * @param int   $levels
     * @param array $exclusions
     *
     * @return bool|string|array
     */
    function vsp_list_files( $path, $levels = 100, $exclusions = array() ) {
        if ( ! function_exists( 'list_files' ) ) {
            require_once ABSPATH . 'wp-admin/includes/file.php';
        }
        return list_files( $path, $levels, $exclusions );
    }
}

/**
 * WordPress Specific Functions
 */

if ( ! function_exists( 'vsp_validate_required_plugin' ) ) {
    /**
     * @param array $args
     *
     * @return bool
     */
    function vsp_validate_required_plugin( $args = array() ) {
        $msg  = false;
        $args = wp_parse_args( $args, array(
            'plugin_name'     => false, // Your Plugin Name.
            'req_plugin'      => false, // Plugin File Eg : woocommerce/woocommerce.php
            'req_plugin_name' => false, // Name of the plugin.
            'version'         => false, // Plugin Version
            'compare'         => 'gte', // Eg : gte,gt.lt,lte
        ) );

        if ( ! wp_is_plugin_active( $args['req_plugin'] ) ) {
            // translators: Add Requested Plugin Name & Required Plugin Name
            $msg = esc_html__( '%1$s Requires %2$s to be installed & activated.', 'vsp-framework' );
            $msg = sprintf( $msg, '<strong>' . $args['plugin_name'] . '</strong>', '<strong><i>' . $args['req_plugin_name'] . '</i></strong>' );
        }

        if ( false !== $args['version'] && false === $msg ) {
            switch ( $args['compare'] ) {
                case 'gte':
                case '>=':
                    if ( ! plugin_version_gte( $args['req_plugin'], $args['version'] ) ) {
                        // translators: Add Requested Plugin Name & Required Plugin Name & Required Plugin Version.
                        $msg = esc_html__( '%1$s Requires %2$s Version %3$s Or Higher. Please Update Your %2$s To %3$s', 'vsp-framework' );
                        $msg = sprintf( $msg, '<strong>' . $args['plugin_name'] . '</strong>', '<strong>' . $args['req_plugin_name'] . '</strong>', '<code>' . $args['version'] . '</code>' );
                    }
                    break;
                case 'gt':
                case '>':
                    if ( ! plugin_version_gt( $args['req_plugin'], $args['version'] ) ) {
                        // translators: Add Requested Plugin Name & Required Plugin Name & Required Plugin Version.
                        $msg = esc_html__( '%1$s Requires %2$s Version %3$s. Please Update Your %2$s To %3$s', 'vsp-framework' );
                        $msg = sprintf( $msg, '<strong>' . $args['plugin_name'] . '</strong>', '<strong>' . $args['req_plugin_name'] . '</strong>', '<code>' . $args['version'] . '</code>' );
                    }
                    break;
                case 'lt':
                case '<':
                    if ( ! plugin_version_lt( $args['req_plugin'], $args['version'] ) ) {
                        // translators: Add Requested Plugin Name & Required Plugin Name & Required Plugin Version.
                        $msg = esc_html__( '%1$s Requires %2$s Version %3$s. Please Downgrade Your %2$s', 'vsp-framework' );
                        $msg = sprintf( $msg, '<strong>' . $args['plugin_name'] . '</strong>', '<strong>' . $args['req_plugin_name'] . '</strong>', '<code>' . $args['version'] . '</code>' );
                    }
                    break;

                case 'lte':
                case '<=':
                    if ( ! plugin_version_lte( $args['req_plugin'], $args['version'] ) ) {
                        // translators: Add Requested Plugin Name & Required Plugin Name & Required Plugin Version.
                        $msg = esc_html__( '%1$s Requires %2$s Version %3$s Or Lower. Please Downgrade Your %2$s To %3$s', 'vsp-framework' );
                        $msg = sprintf( $msg, '<strong>' . $args['plugin_name'] . '</strong>', '<strong>' . $args['req_plugin_name'] . '</strong>', '<code>' . $args['version'] . '</code>' );
                    }
                    break;
            }
        }

        if ( false !== $msg ) {
            if ( ! did_action( 'wponion_loaded' ) ) {
                $add_error = function () use ( $msg ) {
                    wponion_error_admin_notice( $msg );
                };
                add_action( 'wponion_loaded', $add_error );
            } else {
                wponion_error_admin_notice( $msg );
            }
        }

        return ( false !== $msg );
    }
}

if ( ! function_exists( 'vsp_add_wc_required_notice' ) ) {
    /**
     * Adds WooCommerce Plugin Required Notice if not exists.
     * Also checks for version based on plugin's input.
     *
     * @param string $name
     * @param string $version
     * @param string $compare
     *
     * @return bool
     */
    function vsp_add_wc_required_notice( $name = '', $version = '3.0', $compare = '>=' ) {
        return vsp_validate_required_plugin( array(
            'plugin_name'     => $name,
            'req_plugin'      => 'woocommerce/woocommerce.php',
            'req_plugin_name' => 'WooCommerce',
            'version'         => $version,
            'compare'         => $compare,
        ) );
    }
}

vsp_load_file( VSP_PATH . 'includes/functions/*.php' );
API documentation generated by ApiGen