226 lines
6.1 KiB
PHP
226 lines
6.1 KiB
PHP
<?php
|
|
|
|
/**
|
|
* The file that defines the core plugin class
|
|
*
|
|
* A class definition that includes attributes and functions used across both the
|
|
* public-facing side of the site and the admin area.
|
|
*
|
|
* @link http://example.com
|
|
* @since 1.0.0
|
|
*
|
|
* @package apigoat_doc
|
|
* @subpackage apigoat_doc/includes
|
|
*/
|
|
|
|
/**
|
|
* The core plugin class.
|
|
*
|
|
* This is used to define internationalization, admin-specific hooks, and
|
|
* public-facing site hooks.
|
|
*
|
|
* Also maintains the unique identifier of this plugin as well as the current
|
|
* version of the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @package apigoat_doc
|
|
* @subpackage apigoat_doc/includes
|
|
* @author Your Name <email@example.com>
|
|
*/
|
|
class apigoat_doc
|
|
{
|
|
|
|
/**
|
|
* The loader that's responsible for maintaining and registering all hooks that power
|
|
* the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @access protected
|
|
* @var apigoat_doc_Loader $loader Maintains and registers all hooks for the plugin.
|
|
*/
|
|
protected $loader;
|
|
|
|
/**
|
|
* The unique identifier of this plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @access protected
|
|
* @var string $apigoat_doc The string used to uniquely identify this plugin.
|
|
*/
|
|
protected $apigoat_doc;
|
|
|
|
/**
|
|
* The current version of the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @access protected
|
|
* @var string $version The current version of the plugin.
|
|
*/
|
|
protected $version;
|
|
|
|
/**
|
|
* Define the core functionality of the plugin.
|
|
*
|
|
* Set the plugin name and the plugin version that can be used throughout the plugin.
|
|
* Load the dependencies, define the locale, and set the hooks for the admin area and
|
|
* the public-facing side of the site.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function __construct()
|
|
{
|
|
if (defined('apigoat_doc_VERSION')) {
|
|
$this->version = apigoat_doc_VERSION;
|
|
} else {
|
|
$this->version = '1.0.0';
|
|
}
|
|
$this->apigoat_doc = 'apigoat_doc';
|
|
|
|
$this->load_dependencies();
|
|
$this->set_locale();
|
|
$this->define_admin_hooks();
|
|
$this->define_public_hooks();
|
|
}
|
|
|
|
/**
|
|
* Load the required dependencies for this plugin.
|
|
*
|
|
* Include the following files that make up the plugin:
|
|
*
|
|
* - apigoat_doc_Loader. Orchestrates the hooks of the plugin.
|
|
* - apigoat_doc_i18n. Defines internationalization functionality.
|
|
* - apigoat_doc_Admin. Defines all hooks for the admin area.
|
|
* - apigoat_doc_Public. Defines all hooks for the public side of the site.
|
|
*
|
|
* Create an instance of the loader which will be used to register the hooks
|
|
* with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*/
|
|
private function load_dependencies()
|
|
{
|
|
|
|
/**
|
|
* The class responsible for orchestrating the actions and filters of the
|
|
* core plugin.
|
|
*/
|
|
require_once plugin_dir_path(dirname(__FILE__)) . 'includes/class-apigoat_doc-loader.php';
|
|
|
|
/**
|
|
* The class responsible for defining internationalization functionality
|
|
* of the plugin.
|
|
*/
|
|
require_once plugin_dir_path(dirname(__FILE__)) . 'includes/class-apigoat_doc-i18n.php';
|
|
|
|
/**
|
|
* The class responsible for defining all actions that occur in the admin area.
|
|
*/
|
|
require_once plugin_dir_path(dirname(__FILE__)) . 'admin/class-apigoat_doc-admin.php';
|
|
|
|
/**
|
|
* The class responsible for defining all actions that occur in the public-facing
|
|
* side of the site.
|
|
*/
|
|
require_once plugin_dir_path(dirname(__FILE__)) . 'public/class-apigoat_doc-public.php';
|
|
|
|
require plugin_dir_path(dirname(__FILE__)) . 'classes/APIgoatListModifiers.php';
|
|
require plugin_dir_path(dirname(__FILE__)) . 'classes/APIgoatListExamples.php';
|
|
|
|
$this->loader = new apigoat_doc_Loader();
|
|
}
|
|
|
|
/**
|
|
* Define the locale for this plugin for internationalization.
|
|
*
|
|
* Uses the apigoat_doc_i18n class in order to set the domain and to register the hook
|
|
* with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*/
|
|
private function set_locale()
|
|
{
|
|
|
|
$plugin_i18n = new apigoat_doc_i18n();
|
|
|
|
$this->loader->add_action('plugins_loaded', $plugin_i18n, 'load_plugin_textdomain');
|
|
}
|
|
|
|
/**
|
|
* Register all of the hooks related to the admin area functionality
|
|
* of the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*/
|
|
private function define_admin_hooks()
|
|
{
|
|
$plugin_admin = new apigoat_doc_Admin($this->get_apigoat_doc(), $this->get_version());
|
|
$this->loader->add_action('init', $plugin_admin, 'register_session', 1);
|
|
$this->loader->add_action('admin_enqueue_scripts', $plugin_admin, 'enqueue_styles');
|
|
$this->loader->add_action('admin_enqueue_scripts', $plugin_admin, 'enqueue_scripts');
|
|
}
|
|
|
|
/**
|
|
* Register all of the hooks related to the public-facing functionality
|
|
* of the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*/
|
|
private function define_public_hooks()
|
|
{
|
|
$plugin_public = new apigoat_doc_Public($this->get_apigoat_doc(), $this->get_version());
|
|
$this->loader->add_action('init', $plugin_public, 'register_session', 1);
|
|
$this->loader->add_action('wp_enqueue_scripts', $plugin_public, 'enqueue_styles');
|
|
$this->loader->add_action('wp_enqueue_scripts', $plugin_public, 'enqueue_scripts');
|
|
$this->loader->add_shortcode('APIgoat_list_modifiers', $plugin_public, array('APIgoatListModifiers', 'init'));
|
|
$this->loader->add_shortcode('APIgoat_list_examples', $plugin_public, array('APIgoatListExamples', 'init'));
|
|
}
|
|
|
|
/**
|
|
* Run the loader to execute all of the hooks with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function run()
|
|
{
|
|
$this->loader->run();
|
|
}
|
|
|
|
/**
|
|
* The name of the plugin used to uniquely identify it within the context of
|
|
* WordPress and to define internationalization functionality.
|
|
*
|
|
* @since 1.0.0
|
|
* @return string The name of the plugin.
|
|
*/
|
|
public function get_apigoat_doc()
|
|
{
|
|
return $this->apigoat_doc;
|
|
}
|
|
|
|
/**
|
|
* The reference to the class that orchestrates the hooks with the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @return apigoat_doc_Loader Orchestrates the hooks of the plugin.
|
|
*/
|
|
public function get_loader()
|
|
{
|
|
return $this->loader;
|
|
}
|
|
|
|
/**
|
|
* Retrieve the version number of the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @return string The version number of the plugin.
|
|
*/
|
|
public function get_version()
|
|
{
|
|
return $this->version;
|
|
}
|
|
}
|