EmailLog\Addon\EmailLogAddon

Complexity

Total Complexity

2

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
	initialize()	0	1	?
A	__construct()	0	6	1
A	load()	0	4	1

<?php namespace EmailLog\Addon;

defined( 'ABSPATH' ) || exit; // Exit if accessed directly.

/**
 * Base Email Log Addon.
 *
 * @since 2.0.0
 */
abstract class EmailLogAddon {

	protected $addon_file;
	protected $addon_name = '';
	protected $addon_version = '';
	protected $addon_author = 'Sudar Muthu';

	/**
	 * Addon License Handler.
	 *
	 * @var EmailLog\Addon\AddonLicenseHandler.
	 */
	private $license_handler;

	/**
	 * Initialize add-on data.
	 *
	 * @access protected
	 */
	abstract protected function initialize();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

	/**
	 * Construct a new EmailLogAddon instance.
	 *
	 * @param string                             $addon_file      Addon main file.
	 * @param EmailLog\Addon\AddonLicenseHandler $license_handler Addon License Handler.
	 */
	public function __construct( $addon_file, $license_handler ) {
		$this->addon_file      = $addon_file;
		$this->license_handler = $license_handler;

		$this->initialize();
	}

	/**
	 * Load the add-on and setup hooks.
	 * This method is called on `wp-loaded` hook.
	 */
	public function load() {
		$this->license_handler->set_addon_data( $this->addon_name, $this->addon_version, $this->addon_author );
		$this->license_handler->load();
	}
}