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: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 
<?php

defined( 'ABSPATH' ) || exit;

if ( ! class_exists( 'VSP_Framework_Loader' ) ) {
    /**
     * Class VSP_Framework_Loader
     *
     * @author Varun Sridharan <varunsridharan23@gmail.com>
     */
    final class VSP_Framework_Loader {
        /**
         * Variable to store VSP_Framework_Loader Class instance
         *
         * @var \VSP_Framework_Loader
         */
        public static $_instance = null;

        /**
         * Stores the loaded vsp framework information
         *
         * @var array
         */
        public static $_loaded = array();

        /**
         * Maintaines All Plugins VSP Framework Details and provides them when required
         *
         * @var array
         */
        public static $data = array();

        /**
         * Array of callback to init all plugins after vsp_framework loaded
         *
         * @var array
         */
        public static $callbacks = array();

        /**
         * VSP_Framework_Loader constructor.
         */
        public function __construct() {
            add_action( 'wponion/loaded', [ &$this, 'load_framework' ], 0 );
            add_action( 'vsp/loaded', [ &$this, 'load_plugins' ], -1 );
            add_action( 'wponion/sysinfo/datas', [ &$this, 'add_extra_info' ] );
        }

        /**
         * Adds Custom Information To SysPage.
         *
         * @param array $_meta .
         *
         * @return array
         */
        public function add_extra_info( $_meta = array() ) {
            $meta       = array();
            $vsp_loaded = $this->loaded();

            $meta['Framework Version']     = $vsp_loaded['Version'];
            $meta['Textdomain']            = $vsp_loaded['TextDomain'];
            $meta['DomainPath']            = $vsp_loaded['DomainPath'];
            $meta['Framework Plugin Path'] = $vsp_loaded['plugin_path'];
            $meta['Framework Path']        = $vsp_loaded['framework_path'];
            $meta['Framework Included']    = self::$data;
            $_meta['VSP Framework']        = $meta;
            return $_meta;
        }

        /**
         * Loads Framework From A Plugin which has the latest version
         */
        public function load_framework() {
            if ( empty( self::$_loaded ) ) {
                $lists  = self::get();
                $latest = max( array_keys( $lists ) );
                $info   = ( isset( $lists[ $latest ] ) ) ? $lists[ $latest ] : [];
                if ( empty( $info ) ) {
                    $msg = base64_encode( wp_json_encode( self::$data ) );
                    $ms  = 'Unable To Load VSP Framework. Please Contact The Author';
                    $ms  = $ms . '<p style="word-break: break-all;"> <strong>' . 'ERROR ID : ' . '</strong>' . $msg . '</p>';
                    wp_die( $ms );
                }
                self::$_loaded = $info;
                require_once $info['framework_path'] . 'vsp-bootstrap.php';
            }
        }

        /**
         * Creates A Static Instances
         *
         * @return \VSP_Framework_Loader
         */
        public static function instance() {
            if ( null === self::$_instance ) {
                self::$_instance = new self();
            }
            return self::$_instance;
        }

        /**
         * Stores Framework Version & its details
         *
         * @param string $version framework version.
         * @param array  $data other information.
         *
         * @return $this
         */
        public function add( $version = '', $data = array() ) {
            self::$data[ $version ] = $data;
            return $this;
        }

        /**
         * Registers a plugin and stores its deta to $data
         *
         * @param string $plugin_path Exact Plugin path.
         * @param string $framework_path Foldername of the framework path.
         *
         * @return $this
         */
        public function register_plugin( $plugin_path = '', $framework_path = '/vsp-framework/' ) {
            $plugin_path    = trailingslashit( $plugin_path );
            $framework_path = trailingslashit( $plugin_path . $framework_path );

            if ( file_exists( $framework_path . 'vsp-bootstrap.php' ) ) {
                $info                   = get_file_data( $framework_path . 'vsp-bootstrap.php', [
                    'Name'       => 'Framework Name',
                    'Version'    => 'Version',
                    'TextDomain' => 'Text Domain',
                    'DomainPath' => 'Domain Path',
                ] );
                $info['plugin_path']    = trailingslashit( $plugin_path );
                $info['framework_path'] = $framework_path;
                self::add( $info['Version'], $info );
            }
            return $this;
        }

        /**
         * Returns all registered plugins information
         *
         * @return array
         */
        public function get() {
            return self::$data;
        }

        /**
         * Returns currectly loaded framework information
         *
         * @return array
         */
        public function loaded() {
            return self::$_loaded;
        }

        /**
         * Registers a callback to trigger when vsp_framework is loaded
         * usefull for plugins that dose not path vsp in-it
         *
         * @param array $callback .
         *
         * @return bool
         */
        public function register_callback( $callback = array() ) {
            self::$callbacks[] = $callback;
            return true;
        }

        /**
         * Loads all plugin that is registered with VSP Framework
         */
        public function load_plugins() {
            if ( ! empty( self::$callbacks ) ) {
                foreach ( self::$callbacks as $callback ) {
                    call_user_func_array( $callback, [] );
                }
            }
        }
    }
}

if ( ! function_exists( 'vsp_maybe_load' ) ) {
    /**
     * Adds Passed Plugin path to the list array which later used to compare and
     * load the framework from a plugin which has the latest version of framework
     *
     * @param array  $callback Custom function to callback when VSP is loaded.
     * @param string $plugin_path Plugin Path To register With VSP.
     * @param string $framework_path Exact path of the vsp framework in the plugin.
     */
    function vsp_maybe_load( $callback = [], $plugin_path = '', $framework_path = 'vsp-framework' ) {
        $plugin_path = ( ! empty( $plugin_path ) ) ? $plugin_path : __DIR__ . '/';
        VSP_Framework_Loader::instance()
            ->register_plugin( $plugin_path, $framework_path )
            ->register_callback( $callback );
    }
}

if ( ! function_exists( 'vsp_register_plugin' ) ) {
    /**
     * Registers Plugins To VSP Callback.
     *
     * @param array $callback .
     *
     * @return bool
     */
    function vsp_register_plugin( $callback = [] ) {
        return VSP_Framework_Loader::instance()->register_callback( $callback );
    }
}

if ( ! function_exists( 'vsp_force_load' ) ) {
    /**
     * This function is used to force load framework @ anytime.
     * This should be mainly used on Plugin Activation and deactivation.
     * Should not be used anywhere else.
     */
    function vsp_force_load() {
        VSP_Framework_Loader::instance()->load_framework();
    }
}

if ( ! function_exists( 'vsp_force_load_vendors' ) ) {
    /**
     * Loads Its libs.
     *
     * @return bool
     */
    function vsp_force_load_vendors() {
        if ( file_exists( __DIR__ . '/vendor/autoload.php' ) ) {
            include __DIR__ . '/vendor/autoload.php';
            return true;
        }
        return false;
    }
}
API documentation generated by ApiGen