Settings::configure_archive_fields() - Code Metrics - Inspection of "Adding post types to the disable case statement." - lightspeeddevelopment/lsx-sharing - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( fc6536...73bf31 )

by Warwick
created 2020-07-21 16:13 UTC
Settings::configure_archive_fields() D

↳ Parent: Settings
Complexity

Conditions	22
Paths	6
Size

Total Lines	88
Code Lines	66
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
cc	22
eloc	66
c	2
b	0
f	0
nc	6
nop	1
dl	0
loc	88
rs	4.1666
How to fix Long Method Complexity

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

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

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

	/**
	 * Contructor
	 */
	public function __construct() {
		add_action( 'cmb2_admin_init', array( $this, 'register_settings_page' ) );
  add_action( 'cmb2_admin_init', array( $this, 'register_settings_page' ) );
		add_action( 'lsx_sharing_settings_page', array( $this, 'configure_general_fields' ), 15, 1 );
		add_action( 'lsx_sharing_settings_page', array( $this, 'configure_archive_fields' ), 15, 1 );
		add_action( 'admin_enqueue_scripts', array( $this, 'assets' ) );
	}

	/**
	 * Return an instance of this class.
	 *
	 * @since 1.0.0
	 *
	 * @return    object \lsx\sharing\classes\admin\Settings()    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;
	}

	/**
	 * Configure fields for the Settings page.
	 *
	 * @return void
	 */
	public function register_settings_page() {
		$args = array(
			'id'           => 'lsx_sharing_settings',
			'title'        => '<h1>' . esc_html__( 'LSX Sharing Settings', 'lsx-search' ) . ' <span class="version">' . LSX_SHARING_VER . '</span></h1>',
			'title'        => '<h1>' . /** @scrutinizer ignore-call */ esc_html__( 'LSX Sharing Settings', 'lsx-search' ) . ' <span class="version">' . LSX_SHARING_VER . '</span></h1>',
			'menu_title'   => esc_html__( 'LSX Sharing', 'search' ), // Falls back to 'title' (above).
			'object_types' => array( 'options-page' ),
			'option_key'   => 'lsx-sharing-settings', // The option key and admin menu page slug.
			'parent_slug'  => 'options-general.php',
			'capability'   => 'manage_options', // Cap required to view options-page.
		);
		$cmb  = new_cmb2_box( $args );
		$cmb  = /** @scrutinizer ignore-call */ new_cmb2_box( $args );
		do_action( 'lsx_sharing_settings_page', $cmb );
  do_action( 'lsx_sharing_settings_page', $cmb );
	}

	/**
	 * Enqueue JS and CSS.
	 */
	public function assets( $hook ) {
	public function assets( /** @scrutinizer ignore-unused */ $hook ) {
		wp_enqueue_script( 'lsx-sharing-admin', LSX_SHARING_URL . 'assets/js/src/lsx-sharing-admin.js', array( 'jquery' ), LSX_SHARING_VER, true );
  wp_enqueue_script( 'lsx-sharing-admin', LSX_SHARING_URL . 'assets/js/src/lsx-sharing-admin.js', array( 'jquery' ), LSX_SHARING_VER, true );
		wp_enqueue_style( 'lsx-sharing-admin', LSX_SHARING_URL . 'assets/css/lsx-sharing-admin.css', array(), LSX_SHARING_VER );
  wp_enqueue_style( 'lsx-sharing-admin', LSX_SHARING_URL . 'assets/css/lsx-sharing-admin.css', array(), LSX_SHARING_VER );
	}

	/**
	 * Enable Business Directory Search settings only if LSX Search plugin is enabled.
	 *
	 * @return  void
	 */
	public function configure_general_fields( $cmb ) {
		$global_args = array(
			'title' => __( 'Global', 'lsx-search' ),
			'title' => /** @scrutinizer ignore-call */ __( 'Global', 'lsx-search' ),
			'desc'  => esc_html__( 'Control the sharing WordPress post types.', 'lsx-search' ),
			'desc'  => /** @scrutinizer ignore-call */ esc_html__( 'Control the sharing WordPress post types.', 'lsx-search' ),
		);
		$this->get_fields( $cmb, 'global', $global_args );
	}

	/**
	 * Enable Sharing settings only if LSX Search plugin is enabled.
	 *
	 * @param object $cmb The CMB2() class.
	 * @param string $position either top of bottom.
	 * @return void
	 */
	public function configure_archive_fields( $cmb ) {
		$archives       = array();
		$post_type_args = array(
			'public' => true,
		);
		$post_types     = get_post_types( $post_type_args );
		$post_types     = /** @scrutinizer ignore-call */ get_post_types( $post_type_args );
		if ( ! empty( $post_types ) ) {
			foreach ( $post_types as $post_type_key => $post_type_value ) {
				switch ( $post_type_key ) {
					case 'post':
						$page_url      = home_url();
						$page_url      = /** @scrutinizer ignore-call */ home_url();
						$page_title    = __( 'Home', 'lsx-search' );
						$page_title    = /** @scrutinizer ignore-call */ __( 'Home', 'lsx-search' );
						$show_on_front = get_option( 'show_on_front' );
						$show_on_front = /** @scrutinizer ignore-call */ get_option( 'show_on_front' );
						if ( 'page' === $show_on_front ) {
							$page_for_posts = get_option( 'page_for_posts' );
							if ( '' !== $page_for_posts ) {
								$page_title   = get_the_title( $page_for_posts );
								$page_title   = /** @scrutinizer ignore-call */ get_the_title( $page_for_posts );
								$page_url     = get_permalink( $page_for_posts );
								$page_url     = /** @scrutinizer ignore-call */ get_permalink( $page_for_posts );
							}
						}
						$description = sprintf(
							/* translators: %s: The subscription info */
							__( 'Control the filters which show on your <a target="_blank" href="%1$s">%2$s</a> posts.', 'lsx-search' ),
							$page_url,
							$page_title
						);
						$archives[ $post_type_key ] = array(
							'title' => __( 'Blog', 'lsx-search' ),
							'desc'  => $description,
						);
						break;

					case 'product':
						$page_url = home_url();
						$page_title    = __( 'Shop', 'lsx-search' );
						if ( function_exists( 'wc_get_page_id' ) ) {
							$shop_page  = wc_get_page_id( 'shop' );
							$page_url   = get_permalink( $shop_page );
							$page_title = get_the_title( $shop_page );
						}
						$description = sprintf(
							/* translators: %s: The subscription info */
							__( 'Control the filters which show on your <a target="_blank" href="%1$s">%2$s</a> product pages.', 'lsx-search' ),
							$page_url,
							$page_title
						);
						$archives[ $post_type_key ] = array(
							'title' => __( 'Shop', 'lsx-search' ),
							'desc'  => $description,
						);
						break;

					case 'page':
					case 'attachment':
					case 'forum':
					case 'topic':
					case 'lesson':
					case 'quizz':
					case 'reply':
					case 'popup':
					case 'message':
					case 'envira':
					case 'soliloquy':
						break;

					default:
						$temp_post_type = get_post_type_object( $post_type_key );
						$temp_post_type = /** @scrutinizer ignore-call */ get_post_type_object( $post_type_key );
						if ( ! is_wp_error( $temp_post_type ) ) {
						if ( ! /** @scrutinizer ignore-call */ is_wp_error( $temp_post_type ) ) {
							$page_url    = get_post_type_archive_link( $temp_post_type->name );
							$page_url    = /** @scrutinizer ignore-call */ get_post_type_archive_link( $temp_post_type->name );
							$description = sprintf(
								/* translators: %s: The subscription info */
								__( 'Control the filters which show on your <a target="_blank" href="%1$s">%2$s</a> singles.', 'lsx-search' ),
								$page_url,
								$temp_post_type->label
							);

							$archives[ $post_type_key ] = array(
								'title' => $temp_post_type->label,
								'desc'  => $description,
							);
						}
						break;
				}
			}
		}
		if ( ! empty( $archives ) ) {
			foreach ( $archives as $archive_key => $archive_args ) {
				$this->get_fields( $cmb, $archive_key, $archive_args );
			}
		}
	}

	/**
	 * Gets the sharing fields and loops through them.
	 *
	 * @param object $cmb
	 * @param string $section
	 * @param array $args
	 * @return void
	 */
	public function get_fields( $cmb, $section, $args ) {
		$cmb->add_field(
			array(
				'id'          => 'settings_' . $section . '_sharing',
				'type'        => 'title',
				'name'        => $args['title'],
				'default'     => $args['title'],
				'description' => $args['desc'],
			)
		);
		if ( 'global' === $section ) {
			$cmb->add_field(
				array(
					'name'        => esc_html__( 'Disable all', 'lsx-sharing' ),
					'name'        => /** @scrutinizer ignore-call */ esc_html__( 'Disable all', 'lsx-sharing' ),
					'id'          => $section . '_disable_all',
					'description' => esc_html__( 'Disable all share buttons on the site', 'lsx-sharing' ),
					'type'        => 'checkbox',
				)
			);
		} else {
			$cmb->add_field(
				array(
					'name'        => esc_html__( 'Disable', 'lsx-sharing' ),
					'id'          => $section . '_disable_pt',
					'description' => esc_html__( 'Disable the share buttons on this post type', 'lsx-sharing' ),
					'type'        => 'checkbox',
				)
			);
		}

		$cmb->add_field(
			array(
				'name'        => esc_html__( 'Label text', 'lsx-sharing' ),
				'id'          => $section . '_label_text',
				'description' => esc_html__( 'A default label for the sharing.', 'lsx-sharing' ),
				'type'        => 'text',
			)
		);
		if ( 'global' === $section || ( 'global' !== $section && ! \lsx\sharing\includes\functions\is_button_disabled( 'global', 'facebook' ) ) ) {
			$cmb->add_field(
				array(
					'name'        => esc_html__( 'Disable Facebook', 'lsx-sharing' ),
					'id'          => $section . '_disable_facebook',
					'description' => esc_html__( 'Disable Facebook share button.', 'lsx-sharing' ),
					'type'        => 'checkbox',
				)
			);
		}
		if ( 'global' === $section || ( 'global' !== $section && ! \lsx\sharing\includes\functions\is_button_disabled( 'global', 'twitter' ) ) ) {
			$cmb->add_field(
				array(
					'name'        => esc_html__( 'Disable Twitter', 'lsx-sharing' ),
					'id'          => $section . '_disable_twitter',
					'description' => esc_html__( 'Disable Twitter share button.', 'lsx-sharing' ),
					'type'        => 'checkbox',
				)
			);
		}
		if ( 'global' === $section || ( 'global' !== $section && ! \lsx\sharing\includes\functions\is_button_disabled( 'global', 'pinterest' ) ) ) {
			$cmb->add_field(
				array(
					'name'        => esc_html__( 'Disable Pinterest', 'lsx-sharing' ),
					'id'          => $section . '_disable_pinterest',
					'description' => esc_html__( 'Disable Pinterest button.', 'lsx-sharing' ),
					'type'        => 'checkbox',
				)
			);
		}

		do_action( 'lsx_sharing_settings_section', $cmb, $section );
  do_action( 'lsx_sharing_settings_section', $cmb, $section );
		$cmb->add_field(
			array(
				'id'   => $section . '_title_closing',
				'type' => 'tab_closing',
			)
		);
	}
}

lightspeeddevelopment / lsx-sharing

Push — master ( fc6536...73bf31 )

Settings::configure_archive_fields() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
