YIKES\EasyForms\PluginHelper

Complexity

Total Complexity

8

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	get_main_file()	0	3	1
A	get_root_dir()	0	3	1
A	get_version()	0	3	1
A	get_plugin_url()	0	3	1
A	get_main_filename()	0	3	1
A	get_basename()	0	3	1
A	is_new_editor_enabled()	0	15	2

<?php
/**
 * YIKES Inc. Easy Mailchimp Forms Plugin.
 *
 * @package   Yikes\EasyForms
 * @author    Freddie Mixell
 * @license   GPL2
 */

namespace YIKES\EasyForms;

/**
 * Trait PluginHelper.
 *
 * Handle basic WordPress plugin variables like the plugin's path and URL.
 *
 * @since   %VERSION%
 * @package Yikes\EasyForms
 */
trait PluginHelper {

	/**
	 * Get the main plugin file.
	 *
	 * @since %VERSION%
	 * @return string
	 */
	protected function get_main_file() {
		return "{$this->get_root_dir()}/{$this->get_main_filename()}";
	}

	/**
	 * Get the root directory for the plugin.
	 *
	 * @since %VERSION%
	 * @return string
	 */
	protected function get_root_dir() {
		return dirname( __DIR__ );
	}

	/**
	 * Get the version of the plugin.
	 *
	 * @since %VERSION%
	 * @return string
	 */
	protected function get_version() {
		return '1.0.0';
	}

	/**
	 * Get the url for the plugin.
	 *
	 * @since %VERSION%
	 *
	 * @param string $path The URL path.
	 *
	 * @return string
	 */
	protected function get_plugin_url( $path = '' ) {
		return plugins_url( $path, $this->get_main_file() );
	}

	/**
	 * Get the filename for the plugin.
	 *
	 * @since %VERSION%
	 * @return string
	 */
	protected function get_main_filename() {
		return 'easy-mailchimp-forms.php';
	}

	/**
	 * Get the WordPress plugin name for this plugin.
	 *
	 * @since %VERSION%
	 * @return string
	 */
	protected function get_basename() {
		return plugin_basename( $this->get_main_file() );
	}

	/**
	 * Is the new editor is enabled?
	 *
	 * Check if the register_block_type function exists to see if the new editor is available. Then check if the classic editor plugin is enabled to see if the editor is being disabled.
	 *
	 * @since %VERSION%
	 * @return bool
	 */
	protected function is_new_editor_enabled() {
		/**
		 * Filter whether the new editor is enabled.
		 *
		 * There are situations where the new editor is disabled even though our check returns true. This filter allows you to turn on/off our new editor functionality.
		 *
		 * @param bool $is_enabled.
		 *
		 * @return bool True if the new editor is enabled.
		 */
		return apply_filters(
			'emf_is_new_editor_enabled',
			function_exists( 'register_block_type' ) && ! class_exists( 'Classic_Editor' )
		);
	}
}