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: 
<?php

namespace VSP;

use WPOnion\Traits\Class_Options;
use WPOnion\Traits\Hooks;

defined( 'ABSPATH' ) || exit;

/**
 * Class VSP_Class_Handler
 *
 * @author Varun Sridharan <varunsridharan23@gmail.com>
 */
class Base extends Core\Instance_Handler {
    use Class_Options;
    use Hooks;

    /**
     * Stores Plugin's Base Class Name.
     *
     * @var string
     * @since {NEWVERSION}
     */
    protected $plugin_class = '';

    /**
     * Class Clone.
     */
    public function __clone() {
        vsp_doing_it_wrong( __FUNCTION__, esc_html__( 'Cloning instances of the class is forbidden.', 'vsp-framework' ), $this->plugin()
            ->version() );
    }

    /**
     * Class Wakeup.
     */
    public function __wakeup() {
        vsp_doing_it_wrong( __FUNCTION__, esc_html__( 'Unserializing instances of the class is forbidden.', 'vsp-framework' ), $this->plugin()
            ->version() );
    }

    /**
     * Returns Plugin's Instance.
     *
     * @return \VSP\Framework
     */
    public function plugin() {
        return ( $this instanceof Framework ) ? $this : $this->get_instance( $this->plugin_class );
    }

    /**
     * Get the plugin url.
     *
     * @param string      $ex_path
     * @param bool|string $plugin_file
     *
     * @return string
     */
    public function plugin_url( $ex_path = '/', $plugin_file = false ) {
        $file = ( false !== $plugin_file ) ? $plugin_file : $this->plugin()->file();
        return untrailingslashit( plugins_url( $ex_path, $file ) );
    }

    /**
     * Get the plugin path.
     *
     * @param string      $ex_path
     * @param bool|string $plugin_file
     *
     * @return string
     */
    public function plugin_path( $ex_path = '', $plugin_file = false ) {
        $file = ( false !== $plugin_file ) ? $plugin_file : $this->plugin()->file();
        $path = untrailingslashit( plugin_dir_path( $file ) );
        return ( empty( $ex_path ) ) ? $path : $path . '/' . $ex_path;
    }

    /**
     * Loads A Required File.
     *
     * @param string $file
     * @param bool   $is_internal
     */
    public function load_file( $file = '', $is_internal = true ) {
        $file = ( $is_internal ) ? $this->plugin_path( $file ) : $file;
        vsp_load_file( $file );
    }

    /**
     * Triggers Given function
     *
     * @param string $type
     * @param array  $args
     *
     * @return mixed
     */
    private function hooker( $type = '', $args = array() ) {
        $args[0] = $this->plugin()->slug( 'hook' ) . '/' . $args[0];
        return call_user_func_array( $type, $args );
    }

    /**
     * Triggers apply_filters
     *
     * @return mixed
     * @uses \apply_filters()
     */
    public function apply_filter() {
        return $this->hooker( 'apply_filters', func_get_args() );
    }

    /**
     * Triggers do_action
     *
     * @return mixed
     * @uses \do_action()
     */
    public function do_action() {
        return $this->hooker( 'do_action', func_get_args() );
    }

    /**
     * Triggers deprecated apply_filters
     *
     * @param string      $tag
     * @param mixed       $args
     * @param string      $version
     * @param string|null $replacement
     * @param string|null $message
     *
     * @return mixed
     * @since {NEWVERSION}
     */
    public function do_deprecated_filter( $tag, $args, $version, $replacement = null, $message = null ) {
        $tag         = $this->plugin()->slug( 'hook' ) . '_' . $tag;
        $replacement = $this->plugin()->slug( 'hook' ) . '/' . $replacement;
        return wponion_apply_deprecated_filters( $tag, $args, $version, $replacement, $message );
    }

    /**
     * Triggers deprecated do_action
     *
     * @param string      $tag
     * @param mixed       $args
     * @param string      $version
     * @param string|null $replacement
     * @param string|null $message
     *
     * @since {NEWVERSION}
     */
    public function do_deprecated_action( $tag, $args, $version, $replacement = null, $message = null ) {
        $tag         = $this->plugin()->slug( 'hook' ) . '_' . $tag;
        $replacement = $this->plugin()->slug( 'hook' ) . '/' . $replacement;
        return wponion_do_deprecated_action( $tag, $args, $version, $replacement, $message );
    }
}
API documentation generated by ApiGen