lsx\search\classes\frontend\Layout

Complexity

Total Complexity

21

Size/Duplication

Total Lines	150
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	load_functions()	0	11	3
A	get_instance()	0	6	2
A	__construct()	0	2	1
A	lsx_layout_switcher_options_default()	0	7	3
A	show_layout_switcher()	0	8	3
A	get_layout_value_from_cookie()	0	12	3
A	lsx_layout_switcher_options()	0	4	1
A	sanitize_select_layout_switcher()	0	10	2
A	woocommerce_layout_class()	0	8	2
A	lsx_layout_switcher_page_key()	0	4	1

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

use LSX_Search;

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

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

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

Expected 2 blank lines before function; 1 found

		add_action( 'wp', array( $this, 'load_functions' ), 24 );
	}

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\frontend\Layout()    A single instance of this class.
	 */
	public static function get_instance() {

Method name "Layout::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

	/**
	 * Check all settings.
	 */
	public function load_functions() {

Method name "Layout::load_functions" is not in camel caps format

		$lsx_search = LSX_Search::get_instance();
		if ( $lsx_search->frontend->search_enabled ) {

Expected 0 spaces before closing bracket; 1 found

			if ( isset( $lsx_search->frontend->options['display'][ $lsx_search->frontend->search_prefix . '_layout_switcher_enable' ] ) ) {

Expected 0 spaces before closing bracket; 1 found

				add_filter( 'lsx_blog_customizer_show_switcher', array( $this, 'show_layout_switcher' ), 10, 1 );
				add_filter( 'lsx_layout_switcher_options', array( $this, 'lsx_layout_switcher_options' ), 10, 1 );
				add_filter( 'lsx_layout_switcher_page_key', array( $this, 'lsx_layout_switcher_page_key' ), 10, 1 );
				add_filter( 'lsx_layout_switcher_options_default', array( $this, 'lsx_layout_switcher_options_default' ), 10, 1 );

				// Layout Classes
				add_filter( 'woocommerce_product_loop_start', array( $this, 'woocommerce_layout_class' ), 10, 1 );
			}
		}
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Display the woocommerce archive swticher.
	 */
	public function show_layout_switcher( $show = false ) {

Method name "Layout::show_layout_switcher" is not in camel caps format

		if ( is_search() ) {

Expected 0 spaces before closing bracket; 1 found

			$archive_layout_switcher = get_theme_mod( 'lsx_blog_customizer_archive_layout_switcher', false );
			if ( true === $archive_layout_switcher ) {

Expected 0 spaces before closing bracket; 1 found

				$show = true;
			}
		}
		return $show;
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Remove the default and half-grid options from the results layouts.
	 *
	 * @param  array $layout_options
	 * @return array
	 */
	public function lsx_layout_switcher_options( $layout_options ) {

Method name "Layout::lsx_layout_switcher_options" is not in camel caps format

		unset( $layout_options['default'] );
		unset( $layout_options['half-grid'] );
		return $layout_options;
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Replace the key for the layout switcher.
	 *
	 * @param  string $page_key
	 * @return string
	 */
	public function lsx_layout_switcher_page_key( $page_key ) {

Method name "Layout::lsx_layout_switcher_page_key" is not in camel caps format

		$lsx_search = LSX_Search::get_instance();
		$page_key   = str_replace( '_search', '', $lsx_search->frontend->search_prefix );
		return $page_key;
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * CHange the default layout to a grid layout.
	 *
	 * @param  string $default
	 * @return string
	 */
	public function lsx_layout_switcher_options_default( $default = 'grid' ) {

Method name "Layout::lsx_layout_switcher_options_default" is not in camel caps format

		$lsx_search = LSX_Search::get_instance();
		$default    = 'grid';
		if ( isset( $lsx_search->frontend->options['display'][ $lsx_search->frontend->search_prefix . '_grid_list' ] ) && ! empty( $lsx_search->frontend->options['display'][ $lsx_search->frontend->search_prefix . '_grid_list' ] ) ) {

Expected 0 spaces before closing bracket; 1 found

			$default = $lsx_search->frontend->options['display'][ $lsx_search->frontend->search_prefix . '_grid_list' ];
		}
		return $default;
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Controls the layout for the woocommerce shop page.
	 */
	public function woocommerce_layout_class( $output = '' ) {

Method name "Layout::woocommerce_layout_class" is not in camel caps format

		$default_class = $this->lsx_layout_switcher_options_default();
		$selected      = $this->get_layout_value_from_cookie( 'product' );
		if ( '' !== $selected ) {

Expected 0 spaces before closing bracket; 1 found

			$default_class = $selected;
		}
		$output = str_replace( 'products', 'products ' . $default_class, $output );
		return $output;
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Get layout value from cookie
	 *
	 * @since 1.0.0
	 */
	public function get_layout_value_from_cookie( $page_key = 'blog' ) {

Method name "Layout::get_layout_value_from_cookie" is not in camel caps format

		$archive_layout = 'grid';

		if ( isset( $_COOKIE[ 'lsx-' . $page_key . '-layout' ] ) ) {

Expected 0 spaces before closing bracket; 1 found

			$archive_layout_from_cookie = sanitize_key( $_COOKIE[ 'lsx-' . $page_key . '-layout' ] );
			$archive_layout_from_cookie = $this->sanitize_select_layout_switcher( $archive_layout_from_cookie );

			if ( ! empty( $archive_layout_from_cookie ) ) {

Expected 0 spaces before closing bracket; 1 found

				$archive_layout = $archive_layout_from_cookie;
			}
		}
		return $archive_layout;
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Sanitize select (layout switcher).
	 *
	 * @since 1.0.0
	 */
	public function sanitize_select_layout_switcher( $input ) {

Method name "Layout::sanitize_select_layout_switcher" is not in camel caps format

		$valid = array(
			'list'      => esc_html__( 'List', 'lsx-search' ),

Array double arrow not aligned correctly; expected 1 space(s) between "'list'" and double arrow, but found 6.

			'grid'      => esc_html__( 'Grid', 'lsx-search' ),

Array double arrow not aligned correctly; expected 1 space(s) between "'grid'" and double arrow, but found 6.

		);

		if ( array_key_exists( $input, $valid ) ) {

Expected 0 spaces before closing bracket; 1 found

			return $input;
		} else {
			return '';
		}
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 0 found

}