BD_Addon

Complexity

Total Complexity

7

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setup_license_handler()	0	8	1
A	setup()	0	5	2
A	__construct()	0	2	1
A	get_addon_class_name()	0	2	1
A	dependencies_met()	0	2	1
A	setup_translation()	0	5	1

<?php
/**
 * Base class for all BD Addons.
 *
 * @since   5.5
 *
 * @author  Sudar
 *
 * @package BulkDelete\Addons\Base
 */
defined( 'ABSPATH' ) || exit; // Exit if accessed directly

/**
 * Base class for BD Addons.
 *
 * @abstract
 *
 * @since 5.5
 */
abstract class BD_Addon {
	/**
	 * @var string Addon Name.
	 */
	protected $addon_name;

	/**
	 * @var string Addon Code.
	 */
	protected $addon_code;

	/**
	 * @var string Addon File.
	 */
	protected $addon_file;

	/**
	 * @var string Addon Version.
	 */
	protected $addon_version;

	/**
	 * @var string Addon Author.
	 */
	protected $addon_author = 'Sudar Muthu';

	/**
	 * @var Module Name.
	 */
	protected $module;

	/**
	 * @var object License Handler.
	 */
	protected $license_handler;

	/**
	 * Initialize and setup variables.
	 *
	 * @since 5.5
	 * @abstract
	 *
	 * @return void
	 */
	abstract protected function initialize();

	/**
	 * Use `factory()` method to create instance of this class.
	 * Don't create instances directly.
	 *
	 * @since 5.5
	 * @see factory()
	 */
	public function __construct() {
		$this->setup();
	}

	/**
	 * Setup the module.
	 *
	 * @access protected
	 *
	 * @since 5.5
	 */
	protected function setup() {
		$this->initialize();
		$this->setup_translation();
		if ( $this->dependencies_met() ) {
			$this->setup_hooks();
		}
	}

	/**
	 * Check if all dependencies are met.
	 * To check for dependencies overload this method in the child class.
	 *
	 * @return bool True if dependencies met, False otherwise.
	 */
	protected function dependencies_met() {
		return true;
	}

	/**
	 * Setup translation.
	 *
	 * @access protected
	 *
	 * @since 5.5
	 */
	protected function setup_translation() {
		$bd = BULK_DELETE();

		// Load translation files from Bulk Delete language folder
		load_plugin_textdomain( 'bulk-delete', false, $bd->translations );
	}

	/**
	 * Setup license handler.
	 *
	 * @since 5.5
	 *
	 * @param string $plugin_file Addon file name relative to plugin directory.
	 */
	public function setup_license_handler( $plugin_file ) {
		$this->addon_file      = $plugin_file;
		$this->license_handler = new BD_License_Handler(
			$this->addon_name,
			$this->addon_code,
			$this->addon_version,
			$this->addon_file,
			$this->addon_author
		);
	}

	/**
	 * Get addon class name.
	 *
	 * @since 5.5
	 *
	 * @return string Addon class name
	 */
	protected function get_addon_class_name() {
		return bd_get_addon_class_name( $this->addon_name );
	}
}