lightspeeddevelopment / lsx-search

classes/admin/class-settings-theme.php

<?php
namespace lsx\search\classes\admin;

use CMB_Tab_Field;

The type CMB_Tab_Field was not found. Maybe you did not declare it correctly or list all dependencies?

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

Class name "Settings_Theme" is not in PascalCase format

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

	/**
	 * Will return true if this is the LSX Search 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() {

Expected 2 blank lines before function; 1 found

		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 );
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Return an instance of this class.
	 *
	 * @since 1.0.0
	 *
	 * @return    object \lsx\search\classes\admin\Settings_Theme()    A single instance of this class.
	 */
	public static function get_instance() {

Method name "Settings_Theme::get_instance" is not in camel caps format

		// If the single instance hasn't been set, set it now.
		if ( null == self::$instance ) {

Found: ==. Use strict comparisons (=== or !==).

Expected 0 spaces before closing bracket; 1 found

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

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

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

Method name "Settings_Theme::disable_cmb2_styles" is not in camel caps format

		if ( is_admin() ) {

Expected 0 spaces before closing bracket; 1 found

			$current_screen = get_current_screen();
			if ( is_object( $current_screen ) && 'settings_page_lsx-search-settings' === $current_screen->id ) {

Expected 0 spaces before closing bracket; 1 found

				$enabled = false;
			}
		}
		return $enabled;
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * 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 ) {

Method name "Settings_Theme::generate_navigation" is not in camel caps format

		if ( 'lsx_search_settings' === $cmb_id && 'lsx-search-settings' === $object_id && 'options-page' === $object_type ) {

Expected 0 spaces before closing bracket; 1 found

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

It seems like true of type true is incompatible with the declared type array of property $is_options_page.

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

Expected 0 spaces before closing bracket; 1 found

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

Expected 0 spaces before closing bracket; 1 found

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

Expected 0 spaces before closing bracket; 1 found

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

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Outputs the WP style navigation for the Settings page.
	 *
	 * @return void
	 */
	public function output_navigation() {

Method name "Settings_Theme::output_navigation" is not in camel caps format

		if ( ! empty( $this->navigation ) ) {

Expected 0 spaces before closing bracket; 1 found

			?>
			<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'] ) {

Processing form data without nonce verification.

Expected 0 spaces before closing bracket; 1 found

						$selected_tab  = sanitize_text_field( $_GET['cmb_tab'] );

Equals sign not aligned with surrounding assignments; expected 1 space but found 2 spaces

Processing form data without nonce verification.

$_GET data not unslashed before sanitization. Use wp_unslash() or similar

						$selected_tab  = 'settings_' . $selected_tab;

Equals sign not aligned with surrounding assignments; expected 1 space but found 2 spaces

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

Expected 0 spaces before closing bracket; 1 found

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

Expected 0 spaces before closing bracket; 1 found

							$first_tab   = false;
							$current_css = 'current';
						}
						if ( $count === $total ) {

Expected 0 spaces before closing bracket; 1 found

							$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
		}
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Outputs the opening tab div.
	 *
	 * @param object $field CMB2_Field();
	 * @return void
	 */
	public function output_tab_open_div( $field ) {

Method name "Settings_Theme::output_tab_open_div" is not in camel caps format

		if ( true === $this->is_options_page && isset( $field->args['type'] ) && 'title' === $field->args['type'] ) {

The condition true === $this->is_options_page is always false.

Expected 0 spaces before closing bracket; 1 found

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

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Outputs the opening closing div.
	 *
	 * @param object $field CMB2_Field();
	 * @return void
	 */
	public function output_tab_closing_div( $field ) {

Method name "Settings_Theme::output_tab_closing_div" is not in camel caps format

		if ( true === $this->is_options_page && isset( $field->args['type'] ) && 'tab_closing' === $field->args['type'] ) {

The condition true === $this->is_options_page is always false.

Expected 0 spaces before closing bracket; 1 found

			?>
			</div>
			<?php
		}
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

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

Method name "Settings_Theme::cmb2_render_callback_for_tab_closing" is not in camel caps format

		return;

Empty return statement not required here

	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	public function cmb2_sanitize_tab_closing_callback( $override_value, $value ) {

Method name "Settings_Theme::cmb2_sanitize_tab_closing_callback" is not in camel caps format

		return '';
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * 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 ) {

Method name "Settings_Theme::navigation_js" is not in camel caps format

		if ( 'lsx_search_settings' === $cmb_id && 'lsx-search-settings' === $object_id && 'options-page' === $object_type ) {

Expected 0 spaces before closing bracket; 1 found

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

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

					'use strict';

					LSX_SEARCH_CMB2.document = $(document);

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

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

					LSX_SEARCH_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_SEARCH_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_SEARCH_CMB2.urlParam = function(name){
						var results = new RegExp('[\?&]' + name + '=([^&#]*)').exec(window.location.href);
						if ( results == null ){
							return 0;
						} else {
							return results[1] || 0;
						}
					}

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

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

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * This will add the tab selection to the url.
	 *
	 * @param string $url
	 * @return void
	 */
	public function add_tab_argument( $url ) {

Method name "Settings_Theme::add_tab_argument" is not in camel caps format

		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 ) {

Expected 0 spaces before closing bracket; 1 found

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

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 0 found

}