Settings_Theme::output_navigation() - Code Metrics - lightspeeddevelopment/lsx-projects - Measure and Improve Code Quality continuously with Scrutinizer

Settings_Theme::output_navigation() B
last analyzed 2021-12-07 01:29 UTC

↳ Parent: Settings_Theme

Complexity

Conditions	9
Paths	11

Size

Total Lines	31
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	9
eloc	29
c	1
b	0
f	0
nc	11
nop	0
dl	0
loc	31
rs	8.0555

<?php


namespace lsx\projects\classes\admin;

//use CMB_Tab_Field;


/**
 * Houses the functions for the CMB2 Settings page.
 *
 * @package lsx-projects
 */
class Settings_Theme {

	/**
	 * Holds class instance
	 *
	 * @since 1.0.0
	 *
	 * @var      object \lsx\projects\classes\admin\Settings_Theme()
	 */
	protected static $instance = null;

	/**
	 * Will return true if this is the LSX projects settings page.
	 *
	 * @var array
	 */
	public $is_options_page = false;

	/**
	 * Holds the id and labels for the navigation.
	 *
	 * @var array
	 */
	public $navigation = array();

	/**
	 * Contructor
	 */
	public function __construct() {

		add_filter( 'cmb2_enqueue_css', array( $this, 'disable_cmb2_styles' ), 1, 1 );
		add_action( 'cmb2_before_form', array( $this, 'generate_navigation' ), 10, 4 );
		add_action( 'cmb2_before_title_field_row', array( $this, 'output_tab_open_div' ), 10, 1 );
		add_action( 'cmb2_after_tab_closing_field_row', array( $this, 'output_tab_closing_div' ), 10, 1 );
		add_action( 'cmb2_render_tab_closing', array( $this, 'cmb2_render_callback_for_tab_closing' ), 10, 5 );
		add_filter( 'cmb2_sanitize_tab_closing', array( $this, 'cmb2_sanitize_tab_closing_callback' ), 10, 2 );
		add_action( 'cmb2_after_form', array( $this, 'navigation_js' ), 10, 4 );
		add_filter( 'cmb2_options_page_redirect_url', array( $this, 'add_tab_argument' ), 10, 1 );
	}


	/**
	 * Return an instance of this class.
	 *
	 * @since 1.0.0
	 *
	 * @return    object \lsx\projects\classes\admin\Settings_Theme()    A single instance of this class.
	 */
	public static function get_instance() {
		// If the single instance hasn't been set, set it now.
		if ( null == self::$instance ) {

			self::$instance = new self();
		}

		return self::$instance;
	}


	/**

	 * Disable CMB2 styles on front end forms.
	 *
	 * @return bool $enabled Whether to enable (enqueue) styles.
	 */
	public function disable_cmb2_styles( $enabled ) {
		if ( is_admin() ) {

			$current_screen = get_current_screen();
			if ( is_object( $current_screen ) && 'project_page_lsx_projects_options' === $current_screen->id ) {

				$enabled = false;
			}
		}

		return $enabled;
	}


	/**
	 * Generates the tabbed navigation for the settings page.
	 *
	 * @param string $cmb_id

	 * @param string $object_id

	 * @param string $object_type

	 * @param object $cmb2_obj

	 * @return void
	 */
	public function generate_navigation( $cmb_id, $object_id, $object_type, $cmb2_obj ) {
		if ( 'lsx_projects_settings' === $cmb_id && 'lsx_projects_options' === $object_id && 'options-page' === $object_type ) {

			$this->navigation      = array();
			$this->is_options_page = true;

			if ( isset( $cmb2_obj->meta_box['fields'] ) && ! empty( $cmb2_obj->meta_box['fields'] ) ) {

				foreach ( $cmb2_obj->meta_box['fields'] as $field_index => $field ) {

					if ( 'title' === $field['type'] ) {

						$this->navigation[ $field_index ] = $field['name'];
					}
				}
			}

			$this->output_navigation();
		}
	}


	/**
	 * Outputs the WP style navigation for the Settings page.
	 *
	 * @return void
	 */
	public function output_navigation() {
		if ( ! empty( $this->navigation ) ) {

			?>
			<div class="wp-filter hide-if-no-js">
				<ul class="filter-links">
					<?php
					$first_tab    = true;
					$total        = count( $this->navigation );
					$count        = 0;
					$separator    = ' |';
					$selected_tab = '';
					if ( isset( $_GET['cmb_tab'] ) && '' !== $_GET['cmb_tab'] ) {

						$selected_tab  = sanitize_text_field( $_GET['cmb_tab'] );
$a = "a";
$ab = "ab";
$abc = "abc";
						$selected_tab  = 'settings_' . $selected_tab;
$a = "a";
$ab = "ab";
$abc = "abc";
					}

					foreach ( $this->navigation as $key => $label ) {

						$count++;
						$current_css = '';
						if ( ( true === $first_tab && '' === $selected_tab ) || $key === $selected_tab ) {

							$first_tab   = false;
							$current_css = 'current';
						}

						if ( $count === $total ) {

							$separator = '';
						}
						?>
							<li><a href="#" class="<?php echo esc_attr( $current_css ); ?>" data-sort="<?php echo esc_attr( $key ); ?>_tab"><?php echo esc_attr( $label ); ?></a><?php echo esc_attr( $separator ); ?></li>
						<?php
					}
					?>
				</ul>
			</div>
			<?php
		}
	}


	/**
	 * Outputs the opening tab div.
	 *
	 * @param object $field CMB2_Field();

	 * @return void
	 */
	public function output_tab_open_div( $field ) {
		if ( true === $this->is_options_page && isset( $field->args['type'] ) && 'title' === $field->args['type'] ) {

			?>
			<div id="<?php echo esc_attr( $field->args['id'] ); ?>_tab" class="tab tab-nav hidden">
			<?php
		}
	}


	/**
	 * Outputs the opening closing div.
	 *
	 * @param object $field CMB2_Field();

	 * @return void
	 */
	public function output_tab_closing_div( $field ) {
		if ( true === $this->is_options_page && isset( $field->args['type'] ) && 'tab_closing' === $field->args['type'] ) {

			?>
			</div>
			<?php
		}
	}


	public function cmb2_render_callback_for_tab_closing( $field, $escaped_value, $object_id, $object_type, $field_type_object ) {

		return;

	}


	public function cmb2_sanitize_tab_closing_callback( $override_value, $value ) {

		return '';
	}


	/**
	 * Outputs the Script for the tabbed navigation.
	 *
	 * @param string $cmb_id

	 * @param string $object_id

	 * @param string $object_type

	 * @param object $cmb2_obj

	 * @return void
	 */
	public function navigation_js( $cmb_id, $object_id, $object_type, $cmb2_obj ) {
		if ( 'lsx_projects_settings' === $cmb_id && 'lsx_projects_options' === $object_id && 'options-page' === $object_type ) {

			?>
			<script>
				var LSX_PROJECTS_CMB2 = Object.create( null );

				;( function( $, window, document, undefined ) {

					'use strict';

					LSX_PROJECTS_CMB2.document = $(document);

					/**
					 * Start the JS Class
					 */
					LSX_PROJECTS_CMB2.init = function() {
						var tab = LSX_PROJECTS_CMB2.urlParam( 'cmb_tab' );
						if ( 0 === tab || '0' === tab ) {
							tab = '';
						}
						LSX_PROJECTS_CMB2.addTabInput( tab );
						LSX_PROJECTS_CMB2.prepNavigation( tab );
						LSX_PROJECTS_CMB2.watchNavigation();
					};

					LSX_PROJECTS_CMB2.addTabInput = function( tab = '' ) {
						var counter = 1;
						$( "form.cmb-form" ).append('<input type="hidden" name="cmb_tab" value="' + tab + '" />');
					}

					LSX_PROJECTS_CMB2.prepNavigation = function( tab = '' ) {
						var counter = 1;
						$( ".tab.tab-nav" ).each(function(){
							console.log( tab );
							if ( ( 1 !== counter && '' === tab ) || ( '' !== tab && 'settings_' + tab + '_tab' !== $( this ).attr('id') ) ) {
								$( this ).hide().removeClass('hidden');
							} else {
								$( this ).addClass( 'current' ).removeClass('hidden');
							}
							counter++;
						});
					}

					LSX_PROJECTS_CMB2.watchNavigation = function() {
						$( ".wp-filter li a" ).on( 'click', function(event){
							event.preventDefault();
							// Change the current Tab heading.
							$( ".wp-filter li a" ).removeClass('current');
							$( this ).addClass('current');

							// Change the current tab div.
							var target = $( this ).attr('data-sort');
							$( ".tab.tab-nav.current" ).hide().removeClass('current');
							$( "#"+target ).show().addClass('current');
							$( 'input[name="cmb_tab"]').val(target);
						});
					};

					LSX_PROJECTS_CMB2.urlParam = function(name){
						var results = new RegExp('[\?&]' + name + '=([^&#]*)').exec(window.location.href);
						if ( results == null ){
							return 0;
						} else {
							return results[1] || 0;
						}
					}

					LSX_PROJECTS_CMB2.document.ready( function() {
						LSX_PROJECTS_CMB2.init();
					} );

				} )( jQuery, window, document );
			</script>
			<?php
		}
	}


	/**
	 * This will add the tab selection to the url.
	 *
	 * @param string $url

	 * @return void

	 */
	public function add_tab_argument( $url ) {
		if ( isset( $_POST['cmb_tab'] ) && '' !== $_POST['cmb_tab'] ) { // @codingStandardsIgnoreLine
			$tab_selection = sanitize_text_field( $_POST['cmb_tab'] ); // @codingStandardsIgnoreLine
			$tab_selection = str_replace( array( 'settings_', '_tab' ), '', $tab_selection ); // @codingStandardsIgnoreLine
			if ( 'single' !== $tab_selection ) {

				$url = add_query_arg( 'cmb_tab', $tab_selection, $url );
			} else {
				$url = remove_query_arg( 'cmb_tab', $url );
			}
		}

		return $url;
	}

}


1			<?php
			0 ignored issues – show Coding Style introduced 2020-08-28 11:43 UTC by Report Bug Copy Issue Report This file is missing a doc comment. Loading history...
2
3			namespace lsx\projects\classes\admin;
4
5			//use CMB_Tab_Field;
			0 ignored issues – show Unused Code Comprehensibility introduced 2020-08-28 11:43 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history... Coding Style introduced 2020-08-28 11:43 UTC by Report Bug Copy Issue Report No space found before comment text; expected "// use CMB_Tab_Field;" but found "//use CMB_Tab_Field;" Loading history... Coding Style introduced 2020-08-28 11:43 UTC by Report Bug Copy Issue Report Inline comments must end in full-stops, exclamation marks, or question marks Loading history...
6
7			/**
8			* Houses the functions for the CMB2 Settings page.
9			*
10			* @package lsx-projects
11			*/
12			class Settings_Theme {
13
14			/**
15			* Holds class instance
16			*
17			* @since 1.0.0
18			*
19			* @var object \lsx\projects\classes\admin\Settings_Theme()
20			*/
21			protected static $instance = null;
22
23			/**
24			* Will return true if this is the LSX projects settings page.
25			*
26			* @var array
27			*/
28			public $is_options_page = false;
29
30			/**
31			* Holds the id and labels for the navigation.
32			*
33			* @var array
34			*/
35			public $navigation = array();
36
37			/**
38			* Contructor

lightspeeddevelopment / lsx-projects

Settings_Theme::output_navigation() B last analyzed 2021-12-07 01:29 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Settings_Theme::output_navigation() B
last analyzed 2021-12-07 01:29 UTC