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

namespace VSP\Core\Abstracts;

use ReflectionClass;
use VSP\Base;
use WPOnion\Traits\Class_Options;
use WPOnion\Traits\Hooks;

defined( 'ABSPATH' ) || exit;

/**
 * Class VSP_Log_Handler
 *
 * @author Varun Sridharan <varunsridharan23@gmail.com>
 * @todo each plugin should create a plugin method and provide a valid instance of the plugin.
 */
abstract class Addon extends Base {
    use Class_Options;
    use Hooks;

    /**
     * Stors Addon File Location String.
     *
     * @var string
     */
    private $addon_file = '';

    /**
     * Stores Hook Priority
     *
     * @var int
     */
    protected $settings_priority = 20;

    /**
     * Addon constructor.
     */
    public function __construct() {
        $slug = $this->plugin()->slug( 'hook' );
        $this->add_action( $slug . '/settings/fields', 'settings', $this->settings_priority );
        $this->add_action( $slug . '/init', 'init' );
    }

    /**
     * Triggers Right After construct Call.
     *
     * @return mixed
     */
    abstract protected function init();

    /**
     * Finds And Returns Valid Addon Path File.
     *
     * @return false|string
     */
    protected function addon_file() {
        if ( empty( $this->addon_file ) ) {
            $reflector        = new ReflectionClass( static::class );
            $this->addon_file = $reflector->getFileName();
        }
        return $this->addon_file;
    }

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

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

    /**
     * @param \WPO\Builder $builder WPOnion's Builder Instance.
     */
    abstract public function settings( $builder );

    /**
     * Appends Custom Slug.
     *
     * @return mixed
     */
    public function do_action() {
        $args    = func_get_args();
        $args[0] = 'addon/' . $args[0];
        return parent::do_action( ...$args );
    }

    /**
     * Appends Custom Slug.
     *
     * @return mixed
     */
    public function apply_filter() {
        $args    = func_get_args();
        $args[0] = 'addon/' . $args[0];
        return parent::apply_filter( ...$args );
    }

}
API documentation generated by ApiGen