true-resident-badge-system.php

<?php namespace True_Resident\Badge_System;
/**
 * Plugin Name: True Resident BadgeOS Customization
 * Description: Customize badeOS plugin with website badge system functions
 * Version: 1.5.3
 * Author: Nabeel Molham
 * Author URI: http://nabeel.molham.me/
 * Text Domain: true-resident-badge-system
 * Domain Path: /languages
 * License: GNU General Public License, version 3, http://www.gnu.org/licenses/gpl-3.0.en.html
 */

use True_Resident\Badge_System\Widgets\Listify_Listing_Badges;

if ( ! defined( 'WPINC' ) ) {
	// Exit if accessed directly
	die();
}

if ( 'cli' !== php_sapi_name() && ( PHP_SESSION_NONE === session_status() || '' === session_id() ) ) {
	// start session of not there
	session_start();
}

/**
 * Constants
 */

// plugin master file
define( 'TRBS_MAIN_FILE', __FILE__ );

// plugin DIR
define( 'TRBS_DIR', plugin_dir_path( TRBS_MAIN_FILE ) );

// plugin URI
define( 'TRBS_URI', plugin_dir_url( TRBS_MAIN_FILE ) );

// localization text Domain
define( 'TRBS_DOMAIN', 'true-resident-badge-system' );

require_once TRBS_DIR . 'includes/classes/Singular.php';
require_once TRBS_DIR . 'includes/helpers.php';
require_once TRBS_DIR . 'includes/functions.php';

/**
 * Plugin main component
 *
 * @package True_Resident\Badge_System
 */
class Plugin extends Singular {

	/**
	 * Plugin version
	 *
	 * @var string
	 */
	public $version = '1.5.3';

	/**
	 * Backend
	 *
	 * @var Backend
	 */
	public $backend;

	/**
	 * Backend
	 *
	 * @var Frontend
	 */
	public $frontend;

	/**
	 * Bookmarks
	 *
	 * @var Bookmarks
	 */
	public $bookmarks;

	/**
	 * Backend
	 *
	 * @var Ajax_Handler
	 */
	public $ajax;

	/**
	 * BadgeOS rewards
	 *
	 * @var Rewards
	 */
	public $rewards;

	/**
	 * List of dependency plugin(s)
	 *
	 * @var array
	 */
	protected $dependency_plugins;

	/**
	 * Initialization
	 *
	 * @return void
	 * @throws \Exception
	 */
	protected function init() {

		// load language files
		add_action( 'plugins_loaded', [ $this, 'load_language' ] );

		// autoloader register
		spl_autoload_register( [ $this, 'autoloader' ] );

		// modules
		$this->rewards   = Rewards::get_instance();
		$this->bookmarks = Bookmarks::get_instance();
		$this->ajax      = Ajax_Handler::get_instance();
		$this->backend   = Backend::get_instance();
		$this->frontend  = Frontend::get_instance();

		// plugin loaded hook
		do_action_ref_array( 'trbs_loaded', [ $this ] );

		// WP Widgets initialization
		// add_action( 'widgets_init', [ $this, 'register_widgets' ] );

		// plugin activation
		register_activation_hook( TRBS_MAIN_FILE, [ $this, 'plugin_activation_setups' ] );
	}

	/**
	 * Trigger plugin setups upon activation
	 *
	 * @return void
	 */
	public function plugin_activation_setups() {

		// Database tables
		$this->backend->update_db_tables();

	}

	/**
	 * Register plugin widgets
	 *
	 * @return void
	 */
	public function register_widgets() {

		// listing's badges
		register_widget( Listify_Listing_Badges::class );

	}

	/**
	 * Display error messages for missing plugins
	 *
	 * @return void
	 */
	public function missing_dependency_plugin_notice() {

		$missing_plugins = array_map( function ( $item ) {

			return sprintf( '<a href="%s" target="_blank">%s</a>', esc_url( $item['link'] ), $item['title'] );
		}, array_filter( $this->dependency_plugins, function ( $item ) {

			return $item['inactive'];
		} ) );

		echo '<div class="error" style="padding:15px; position:relative;">',
		sprintf( __( '<b>[True Resident BadgeOS Customization]</b> Missing dependency plugins: <b>%s</b>', TRBS_DOMAIN ), implode( ', ', $missing_plugins ) ),
		'</div>';
	}

	/**
	 * Whether plugin caching is disabled or not
	 *
	 * @return bool
	 */
	public function cache_disabled() {

		return defined( 'TRBS_DISABLE_CACHE' ) && TRBS_DISABLE_CACHE;

	}

	/**
	 * Load view template
	 *
	 * @param string $view_name
	 * @param array  $args ( optional )
	 *
	 * @return void
	 */
	public function load_view( $view_name, $args = null ) {

		// build view file path
		$__view_name     = $view_name;
		$__template_path = TRBS_DIR . 'views/' . $__view_name . '.php';
		if ( ! file_exists( $__template_path ) ) {
			// file not found!
			wp_die( sprintf( __( 'Template <code>%s</code> File not found, calculated path: <code>%s</code>', TRBS_DOMAIN ), $__view_name, $__template_path ) );
		}

		if ( ! empty( $args ) ) {
			// extract passed args into variables
			extract( $args, EXTR_OVERWRITE );
		}

		/**
		 * Before loading template hook
		 *
		 * @param string $__template_path
		 * @param string $__view_name
		 */
		do_action_ref_array( 'trbs_load_template_before', [ $__template_path, $__view_name, $args ] );

		/**
		 * Loading template file path filter
		 *
		 * @param string $__template_path
		 * @param string $__view_name
		 *
		 * @return string
		 */
		require apply_filters( 'trbs_load_template_path', $__template_path, $__view_name, $args );

		/**
		 * After loading template hook
		 *
		 * @param string $__template_path
		 * @param string $__view_name
		 */
		do_action( 'trbs_load_template_after', $__template_path, $__view_name, $args );
	}

	/**
	 * Language file loading
	 *
	 * @return void
	 */
	public function load_language() {

		load_plugin_textdomain( TRBS_DOMAIN, false, dirname( plugin_basename( TRBS_MAIN_FILE ) ) . '/languages' );
	}

	/**
	 * System classes loader
	 *
	 * @param $class_name
	 *
	 * @return void
	 */
	public function autoloader( $class_name ) {

		if ( strpos( $class_name, __NAMESPACE__ ) === false ) {
			// skip non related classes
			return;
		}

		$class_path = TRBS_DIR . 'includes' . DIRECTORY_SEPARATOR . 'classes' . str_replace( [
				__NAMESPACE__,
				'\\',
			], [ '', DIRECTORY_SEPARATOR ], $class_name ) . '.php';

		if ( file_exists( $class_path ) ) {
			// load class file if found
			require_once $class_path;
		}
	}
}

// boot up the system
true_resident_badge_system();