Carbon_Breadcrumb_Admin

Complexity

Total Complexity

14

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	admin_menu()	0	4	1
A	init()	0	4	1
A	register_settings()	0	4	1
A	include_files()	0	8	1
A	apply_settings()	0	12	3
A	is_enabled()	0	18	4
A	current_dir()	0	3	1

<?php
/**
 * The main breadcrumb administration class.
 *
 * Includes, wraps and manages the administration functionality.
 */
class Carbon_Breadcrumb_Admin {

	/**
	 * Settings container.
	 *
	 * @access public
	 *
	 * @var Carbon_Breadcrumb_Admin_Settings
	 */
	public $settings = null;

	/**
	 * Constructor.
	 *
	 * Creates the administration functionality wrapper.
	 *
	 * @access public
	 */
	public function __construct() {
		// include the plugin files
		$this->include_files();

		// if administration is enabled, initialize
		if ( $this->is_enabled() ) {
			add_action( 'init', array( $this, 'init' ) );
			add_action( 'admin_menu', array( $this, 'admin_menu' ), 20 );
		}
	}

	/**
	 * Include the administration files.
	 *
	 * @access public
	 */
	public function include_files() {
		$dir = dirname( __FILE__ );

		include_once($dir . '/Carbon_Breadcrumb_Admin_Settings.php');
		include_once($dir . '/Carbon_Breadcrumb_Admin_Settings_Field.php');
		include_once($dir . '/Carbon_Breadcrumb_Admin_Settings_Field_Text.php');
		include_once($dir . '/Carbon_Breadcrumb_Admin_Settings_Field_Checkbox.php');
	}

	/**
	 * Initialize breadcrumb administration.
	 *
	 * @access public
	 */
	public function admin_menu() {
		// register settings
		$this->register_settings();
	}

	/**
	 * Initialize breadcrumb frontend.
	 *
	 * @access public
	 */
	public function init() {
		// apply the breadcrumb renderer settings
		add_filter( 'carbon_breadcrumbs_renderer_default_options', array( $this, 'apply_settings' ), 20 );
	}

	/**
	 * Register and setup the settings page and fields.
	 *
	 * @access public
	 */
	public function register_settings() {
		// register the settings page and fields
		$this->settings = new Carbon_Breadcrumb_Admin_Settings();
	}

	/**
	 * Apply the settings to the breadcrumb trail renderer
	 *
	 * @access public
	 *
	 * @param array $settings The default settings.
	 * @return array $settings The modified settings.
	 */
	public function apply_settings( $settings = array() ) {
		$settings_fields = Carbon_Breadcrumb_Admin_Settings::get_field_data();

		foreach ( $settings_fields as $field_id => $field ) {
			$settings[ $field_id ] = get_option( 'carbon_breadcrumbs_' . $field_id );
			if ( 'checkbox' == $field['type'] ) {
				$settings[ $field_id ] = (bool) $settings[ $field_id ];
			}
		}

		return $settings;
	}

	/**
	 * Whether the administration interface should be enabled.
	 *
	 * @access public
	 *
	 * @return bool $is_enabled True if the admin interface is enabled.
	 */
	public function is_enabled() {
		$enabled = false;

		// enabled if this plugin is installed as a regular WordPress plugin
		$plugin_path = untrailingslashit( ABSPATH ) . DIRECTORY_SEPARATOR . 'wp-content' . DIRECTORY_SEPARATOR . 'plugins';
		$current_dir = $this->current_dir();
		if ( false !== strpos( $current_dir, $plugin_path ) ) {
			$enabled = true;
		}

		// enabled if the CARBON_BREADCRUMB_ENABLE_ADMIN is defined as `true`
		if ( defined( 'CARBON_BREADCRUMB_ENABLE_ADMIN' ) && CARBON_BREADCRUMB_ENABLE_ADMIN ) {
			$enabled = true;
		}

		// allow manual enabling/disabling
		return apply_filters( 'carbon_breadcrumb_enable_admin', $enabled );
	}

	/**
	 * Returns the current directory.
	 * Useful for covering multiple cases in unit tests.
	 *
	 * @access public
	 *
	 * @return string The absolute directory of the current file.
	 */
	public function current_dir() {
		return dirname( __FILE__ );
	}

}