Settings_Theme::generate_navigation() - Code Metrics - Inspection of "Add/settings update to CMB2" - lightspeeddevelopment/lsx-sharing - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#4)

by Warwick
created 2020-07-10 16:11 UTC
Settings_Theme::generate_navigation() B

↳ Parent: Settings_Theme
Complexity

Conditions	8
Paths	3
Size

Total Lines	12
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	8
eloc	8
c	1
b	0
f	0
nc	3
nop	4
dl	0
loc	12
rs	8.4444
<?php
namespace lsx\sharing\classes\admin;

use CMB_Tab_Field;
filter:
    dependency_paths: ["lib/*"]

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

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

	/**
	 * Will return true if this is the LSX Sharing 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_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_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\sharing\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() ) {
		if ( /** @scrutinizer ignore-call */ is_admin() ) {
			$current_screen = get_current_screen();
			$current_screen = /** @scrutinizer ignore-call */ get_current_screen();
			if ( is_object( $current_screen ) && 'settings_page_lsx-sharing-settings' === $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_sharing_settings' === $cmb_id && 'lsx-sharing-settings' === $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'] );
						$selected_tab  = /** @scrutinizer ignore-call */ sanitize_text_field( $_GET['cmb_tab'] );
						$selected_tab  = 'settings_' . $selected_tab;
					}
					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>
							<li><a href="#" class="<?php echo /** @scrutinizer ignore-call */ 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">
			<div id="<?php echo /** @scrutinizer ignore-call */ 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 ) {
	public function cmb2_render_callback_for_tab_closing( $field, $escaped_value, $object_id, $object_type, /** @scrutinizer ignore-unused */ $field_type_object ) {
		return;
	}

	public function cmb2_sanitize_tab_closing_callback( $override_value, $value ) {
	public function cmb2_sanitize_tab_closing_callback( /** @scrutinizer ignore-unused */ $override_value, $value ) {
		return '';
	}

	/**
	 * Outputs the Script for the tabbed navigation.
	 *
	 * @param string $cmb_id
	 * @param string $object_id
	 * @param string $object_type
	 * @return void
	 */
	public function navigation_js( $cmb_id, $object_id, $object_type ) {
		if ( 'lsx_sharing_settings' === $cmb_id && 'lsx-sharing-settings' === $object_id && 'options-page' === $object_type ) {
			?>
			<script>
				var LSX_SHARING_CMB2 = Object.create( null );

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

					'use strict';

					LSX_SHARING_CMB2.document = $(document);

					<?php $this->navigation_js_init(); ?>

					<?php $this->navigation_js_add_tab_input(); ?>

					<?php $this->navigation_js_prep_navigation(); ?>

					<?php $this->navigation_js_watch_navigation(); ?>

					<?php $this->navigation_js_url_param(); ?>

					LSX_SHARING_CMB2.document.ready( function() {
						LSX_SHARING_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 = /** @scrutinizer ignore-call */ 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 );
				$url = /** @scrutinizer ignore-call */ add_query_arg( 'cmb_tab', $tab_selection, $url );
			} else {
				$url = remove_query_arg( 'cmb_tab', $url );
				$url = /** @scrutinizer ignore-call */ remove_query_arg( 'cmb_tab', $url );
			}
		}
		return $url;
	}

	/**
	 * The JS function to init the navigation JS.
	 *
	 * @return void
	 */
	public function navigation_js_init() {
		?>
			/**
			* Start the JS Class
			*/
			LSX_SHARING_CMB2.init = function() {
				var tab = LSX_SHARING_CMB2.urlParam( 'cmb_tab' );
				if ( 0 === tab || '0' === tab ) {
					tab = '';
			}
			LSX_SHARING_CMB2.addTabInput( tab );
			LSX_SHARING_CMB2.prepNavigation( tab );
			LSX_SHARING_CMB2.watchNavigation();
			};
		<?php
	}
	public function navigation_js_add_tab_input() {
		?>
		LSX_SHARING_CMB2.addTabInput = function( tab = '' ) {
			var counter = 1;
			$( "form.cmb-form" ).append('<input type="hidden" name="cmb_tab" value="' + tab + '" />');
		}
		<?php
	}

	public function navigation_js_url_param() {
		?>
		LSX_SHARING_CMB2.urlParam = function(name){
			var results = new RegExp('[\?&]' + name + '=([^&#]*)').exec(window.location.href);
			if ( results == null ){
				return 0;
			} else {
				return results[1] || 0;
			}
		}
		<?php
	}
	/**
	 * The JS function to init the watch navigation JS.
	 *
	 * @return void
	 */
	public function navigation_js_watch_navigation() {
		?>
		LSX_SHARING_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);
			});
		};
		<?php
	}

	/**
	 * Preps the navigation for the js functions.
	 *
	 * @return void
	 */
	public function navigation_js_prep_navigation() {
		?>
		LSX_SHARING_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++;
			});
		}
		<?php
	}
}

lightspeeddevelopment / lsx-sharing

Pull Request — master (#4)

Settings_Theme::generate_navigation() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
