Workout::get_instance() - Code Metrics - Inspection of "Feature tag for meals, workouts and plans" - lightspeeddevelopment/lsx-health-plan - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — add/multiplan ( 87a4af...b0643e )

by Virginia
created 2020-08-24 22:15 UTC
Workout::get_instance() A

↳ Parent: Workout
Complexity

Conditions	2
Paths	2
Size

Total Lines	6
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	3
nc	2
nop	0
dl	0
loc	6
rs	10
c	0
b	0
f	0
<?php
namespace lsx_health_plan\classes;

use function lsx_health_plan\functions\get_option;

/**
 * Contains the workout post type
 *
 * @package lsx-health-plan
 */
class Workout {

	/**
	 * Holds class instance
	 *
	 * @since 1.0.0
	 *
	 * @var      object \lsx_health_plan\classes\Workout()
	 */
	protected static $instance = null;

	/**
	 * Holds post_type slug used as an index
	 *
	 * @since 1.0.0
	 *
	 * @var      string
	 */
	public $slug = 'workout';

	/**
	 * Contructor
	 */
	public function __construct() {
		add_action( 'init', array( $this, 'register_post_type' ) );
		add_filter( 'lsx_health_plan_single_template', array( $this, 'enable_post_type' ), 10, 1 );
		add_action( 'init', array( $this, 'recipe_type_taxonomy_setup' ) );
		add_filter( 'lsx_health_plan_connections', array( $this, 'enable_connections' ), 10, 1 );
		add_action( 'cmb2_admin_init', array( $this, 'featured_metabox' ), 5 );
		add_action( 'cmb2_admin_init', array( $this, 'details_metaboxes' ) );
		add_action( 'lsx_hp_settings_page', array( $this, 'register_settings' ), 8, 1 );
		add_filter( 'get_the_archive_title', array( $this, 'get_the_archive_title' ), 100 );

		// Template Redirects.
		add_filter( 'lsx_health_plan_archive_template', array( $this, 'enable_post_type' ), 10, 1 );
	}

	/**
	 * Return an instance of this class.
	 *
	 * @since 1.0.0
	 *
	 * @return    object \lsx_health_plan\classes\Workout()    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;
	}
	/**
	 * Register the post type.
	 */
	public function register_post_type() {
		$labels = array(
			'name'               => esc_html__( 'Workouts', 'lsx-health-plan' ),
			'singular_name'      => esc_html__( 'Workout', 'lsx-health-plan' ),
			'add_new'            => esc_html_x( 'Add New', 'post type general name', 'lsx-health-plan' ),
			'add_new_item'       => esc_html__( 'Add New', 'lsx-health-plan' ),
			'edit_item'          => esc_html__( 'Edit', 'lsx-health-plan' ),
			'new_item'           => esc_html__( 'New', 'lsx-health-plan' ),
			'all_items'          => esc_html__( 'All Workouts', 'lsx-health-plan' ),
			'view_item'          => esc_html__( 'View', 'lsx-health-plan' ),
			'search_items'       => esc_html__( 'Search', 'lsx-health-plan' ),
			'not_found'          => esc_html__( 'None found', 'lsx-health-plan' ),
			'not_found_in_trash' => esc_html__( 'None found in Trash', 'lsx-health-plan' ),
			'parent_item_colon'  => '',
			'menu_name'          => esc_html__( 'Workouts', 'lsx-health-plan' ),
		);
		$args = array(
			'labels'             => $labels,
			'public'             => true,
			'publicly_queryable' => true,
			'show_ui'            => true,
			'show_in_menu'       => true,
			'show_in_rest'       => true,
			'menu_icon'          => 'dashicons-universal-access',
			'query_var'          => true,
			'rewrite'            => array(
				'slug' => \lsx_health_plan\functions\get_option( 'endpoint_workout', 'workout' ),
			),
			'capability_type'    => 'page',
			'has_archive'        => \lsx_health_plan\functions\get_option( 'endpoint_workout_archive', 'workouts' ),
			'hierarchical'       => true,
			'menu_position'      => null,
			'supports'           => array(
				'title',
				'thumbnail',
				'editor',
				'excerpt',
				'page-attributes',
				'custom-fields',
			),
		);
		register_post_type( 'workout', $args );
	}

	/**
	 * Register the Type taxonomy.
	 */
	public function recipe_type_taxonomy_setup() {
		$labels = array(
			'name'              => esc_html_x( 'Workout Type', 'taxonomy general name', 'lsx-health-plan' ),
			'singular_name'     => esc_html_x( 'Workout Type', 'taxonomy singular name', 'lsx-health-plan' ),
			'search_items'      => esc_html__( 'Search', 'lsx-health-plan' ),
			'all_items'         => esc_html__( 'All', 'lsx-health-plan' ),
			'parent_item'       => esc_html__( 'Parent', 'lsx-health-plan' ),
			'parent_item_colon' => esc_html__( 'Parent:', 'lsx-health-plan' ),
			'edit_item'         => esc_html__( 'Edit', 'lsx-health-plan' ),
			'update_item'       => esc_html__( 'Update', 'lsx-health-plan' ),
			'add_new_item'      => esc_html__( 'Add New', 'lsx-health-plan' ),
			'new_item_name'     => esc_html__( 'New Name', 'lsx-health-plan' ),
			'menu_name'         => esc_html__( 'Workout Types', 'lsx-health-plan' ),
		);

		$args = array(
			'hierarchical'      => true,
			'labels'            => $labels,
			'show_ui'           => true,
			'show_admin_column' => true,
			'query_var'         => true,
			'rewrite'           => array(
				'slug' => 'workout-type',
			),
		);

		register_taxonomy( 'workout-type', array( 'workout' ), $args );
	}

	/**
	 * Adds the post type to the different arrays.
	 *
	 * @param array $post_types
	 * @return array
	 */
	public function enable_post_type( $post_types = array() ) {
		$post_types[] = $this->slug;
		return $post_types;
	}

	/**
	 * Enables the Bi Directional relationships
	 *
	 * @param array $connections
	 * @return void
	 */
	public function enable_connections( $connections = array() ) {
		$connections['workout']['connected_plans'] = 'connected_workouts';
		$connections['plan']['connected_workouts'] = 'connected_plans';

		$connections['workout']['connected_videos'] = 'connected_workouts';
		$connections['video']['connected_workouts'] = 'connected_videos';

		$connections['workout']['connected_posts'] = 'connected_workouts';
		$connections['post']['connected_workouts'] = 'connected_posts';
		return $connections;
	}

	/**
	 * Remove the "Archives:" from the post type workouts.
	 *
	 * @param string $title the term title.
	 * @return string
	 */
	public function get_the_archive_title( $title ) {
		if ( is_post_type_archive( 'workout' ) ) {
			$title = __( 'Workouts', 'lsx-health-plan' );
		}
		return $title;
	}

	/**
	 * Define the metabox and field configurations.
	 */
	public function featured_metabox() {
		$cmb = new_cmb2_box(
			array(
				'id'           => $this->slug . '_featured_metabox_workout',
				'title'        => __( 'Featured Workout', 'lsx-health-plan' ),
				'object_types' => array( $this->slug ), // Post type
				'context'      => 'side',
				'priority'     => 'high',
				'show_names'   => true,
			)
		);
		$cmb->add_field(
			array(
				'name'       => __( 'Featured Workout', 'lsx-health-plan' ),
				'desc'       => __( 'Enable a featured plan' ),
				'id'         => $this->slug . '_featured_workout',
				'type'       => 'checkbox',
				'show_on_cb' => 'cmb2_hide_if_no_cats',
			)
		);
	}

	/**
	 * Define the metabox and field configurations.
	 */
	public function details_metaboxes() {

		$cmb = new_cmb2_box( array(
			'id'           => $this->slug . '_details_metabox',
			'title'        => __( 'Workout Details', 'lsx-health-plan' ),
			'object_types' => array( $this->slug ), // Post type
			'context'      => 'normal',
			'priority'     => 'high',
			'show_names'   => true,
		) );

		$cmb->add_field( array(
			'name' => __( 'Workout Short Description', 'lsx-health-plan' ),
			'id'   => $this->slug . '_short_description',
			'type' => 'textarea_small',
			'desc' => __( 'Add a small description for this workout (optional)', 'lsx-health-plan' ),
		) );

		$workout_sections = apply_filters( 'lsx_health_plan_workout_sections_amount', 6 );
		if ( false !== $workout_sections && null !== $workout_sections ) {
			$i = 1;
			while ( $i <= $workout_sections ) {

				$cmb_group = new_cmb2_box( array(
					'id'           => $this->slug . '_section_' . $i . '_metabox',
					'title'        => esc_html__( 'Exercise Group ', 'lsx-health-plan' ) . $i,
					'object_types' => array( $this->slug ),
				) );

				$cmb_group->add_field( array(
					'name'       => __( 'Title', 'lsx-health-plan' ),
					'id'         => $this->slug . '_section_' . $i . '_title',
					'type'       => 'text',
					'show_on_cb' => 'cmb2_hide_if_no_cats',
				) );

				$cmb_group->add_field(
					array(
						'name'       => __( 'Description', 'lsx-health-plan' ),
						'id'         => $this->slug . '_section_' . $i . '_description',
						'type'       => 'wysiwyg',
						'show_on_cb' => 'cmb2_hide_if_no_cats',
						'options'    => array(
							'textarea_rows' => 5,
						),
					)
				);

				/**
				 * Repeatable Field Groups
				 */
				// $group_field_id is the field id string, so in this case: $prefix . 'demo'
				$group_field_id = $cmb_group->add_field(
					array(
						'id'      => $this->slug . '_section_' . $i,
						'type'    => 'group',
						'options' => array(
							'group_title'   => esc_html__( 'Exercise {#}', 'lsx-health-plan' ), // {#} gets replaced by row number
							'add_button'    => esc_html__( 'Add New', 'lsx-health-plan' ),
							'remove_button' => esc_html__( 'Delete', 'lsx-health-plan' ),
							'sortable'      => true,
						),
					)
				);

				if ( false !== \lsx_health_plan\functions\get_option( 'exercise_enabled', false ) ) {
					$cmb_group->add_group_field(
						$group_field_id,
						/** @scrutinizer ignore-type */ $group_field_id,
						array(
							'name'       => __( 'Exercise related to this workout', 'lsx-health-plan' ),
							'id'         => 'connected_exercises',
							'type'       => 'post_search_ajax',
							// Optional :
							'limit'      => 1, // Limit selection to X items only (default 1)
							'sortable'   => true,  // Allow selected items to be sortable (default false)
							'query_args' => array(
								'post_type'      => array( 'exercise' ),
								'post_status'    => array( 'publish' ),
								'posts_per_page' => -1,
							),
						)
					);
				} else {
					$cmb_group->add_group_field(
						$group_field_id,
						array(
							'name'       => __( 'Video related to this workout', 'lsx-health-plan' ),
							'id'         => 'connected_videos',
							'type'       => 'post_search_ajax',
							// Optional :
							'limit'      => 1, // Limit selection to X items only (default 1)
							'sortable'   => true,  // Allow selected items to be sortable (default false)
							'query_args' => array(
								'post_type'      => array( 'video' ),
								'post_status'    => array( 'publish' ),
								'posts_per_page' => -1,
							),
						)
					);
					$cmb_group->add_group_field(
						$group_field_id,
						array(
							'name' => esc_html__( 'Workout Name', 'lsx-health-plan' ),
							'id'   => 'name',
							'type' => 'text',
							// 'repeatable' => true, // Repeatable fields are supported w/in repeatable groups (for most types)
						)
					);

					$cmb_group->add_group_field(
						$group_field_id,
						array(
							'name'    => __( 'Description', 'lsx-health-plan' ),
							'id'      => 'description',
							'type'    => 'wysiwyg',
							'options' => array(
								'textarea_rows' => 2,
							),
						)
					);
				}

				$cmb_group->add_group_field(
					$group_field_id,
					array(
						'name' => esc_html__( 'Exercise title (Optional)', 'lsx-health-plan' ),
						'id'   => 'alt_title',
						'type' => 'text',
					)
				);
				$cmb_group->add_group_field(
					$group_field_id,
					array(
						'name' => esc_html__( 'Exercise Description (Optional)', 'lsx-health-plan' ),
						'id'   => 'alt_description',
						'type' => 'textarea_small',
					)
				);
				$cmb_group->add_group_field(
					$group_field_id,
					array(
						'name' => esc_html__( 'Reps / Time / Distance', 'lsx-health-plan' ),
						'id'   => 'reps',
						'type' => 'text',
						// 'repeatable' => true, // Repeatable fields are supported w/in repeatable groups (for most types)
					)
				);
				$cmb_group->add_group_field(
					$group_field_id,
					array(
						'name'         => __( 'Exercise Image (Optional)', 'lsx-health-plan' ),
						'id'           => 'exercise_alt_thumbnail',
						'type'         => 'file',
						'text'         => array(
							'add_upload_file_text' => __( 'Add File', 'lsx-health-plan' ),
						),
						'desc'         => __( 'Upload an image 300px x 300px in size.', 'lsx-health-plan' ),
						'query_args'   => array(
							'type' => array(
								'image/gif',
								'image/jpeg',
								'image/png',
							),
						),
						'preview_size' => 'thumbnail',
						'classes'      => 'lsx-field-col lsx-field-add-field  lsx-field-col-25',
					)
				);

				$i++;
			};
		}
	}

	/**
	 * Registers the lsx_search_settings
	 *
	 * @param object $cmb new_cmb2_box().
	 * @return void
	 */
	public function register_settings( $cmb ) {
		if ( false !== \lsx_health_plan\functions\get_option( 'exercise_enabled', false ) ) {
			$cmb->add_field(
				array(
					'id'          => 'workout_settings_title',
					'type'        => 'title',
					'name'        => __( 'Workout Settings', 'lsx-health-plan' ),
					'description' => __( 'Choose the layout, content and link settings for your exercises.', 'lsx-health-plan' ),
				)
			);

			$cmb->add_field(
				array(
					'id'          => 'workout_tab_layout',
					'type'        => 'select',
					'name'        => __( 'Workout Tab Layout', 'lsx-health-plan' ),
					'description' => __( 'Choose the layout for the workouts.', 'lsx-health-plan' ),
					'options'     => array(
						'table' => __( 'Table', 'lsx-health-plan' ),
						'list'  => __( 'List', 'lsx-health-plan' ),
						'grid'  => __( 'Grid', 'lsx-health-plan' ),
					),
				)
			);
			$cmb->add_field(
				array(
					'id'          => 'workout_tab_link',
					'type'        => 'select',
					'name'        => __( 'Workout Tab Link', 'lsx-health-plan' ),
					'description' => __( 'Choose to show the excerpt, full content or nothing.', 'lsx-health-plan' ),
					'options'     => array(
						''       => __( 'None', 'lsx-health-plan' ),
						'single' => __( 'Single', 'lsx-health-plan' ),
						'modal'  => __( 'Modal', 'lsx-health-plan' ),
					),
					'default' => 'modal',
				)
			);
			$cmb->add_field(
				array(
					'id'          => 'workout_tab_modal_content',
					'type'        => 'select',
					'name'        => __( 'Modal Content', 'lsx-health-plan' ),
					'description' => __( 'Choose to show the excerpt, full content or nothing. For the modal content only', 'lsx-health-plan' ),
					'options'     => array(
						''        => __( 'None', 'lsx-health-plan' ),
						'excerpt' => __( 'Excerpt', 'lsx-health-plan' ),
						'full'    => __( 'Full Content', 'lsx-health-plan' ),
					),
					'default' => '',
				)
			);
			$cmb->add_field(
				array(
					'id'          => 'workout_tab_columns',
					'type'        => 'select',
					'name'        => __( 'Grid Columns', 'lsx-health-plan' ),
					'description' => __( 'If you are displaying a grid, set the amount of columns you want to use.', 'lsx-health-plan' ),
					'options'     => array(
						'12' => __( '1', 'lsx-health-plan' ),
						'6'  => __( '2', 'lsx-health-plan' ),
						'4'  => __( '3', 'lsx-health-plan' ),
						'3'  => __( '4', 'lsx-health-plan' ),
						'2'  => __( '6', 'lsx-health-plan' ),
					),
					'default' => '4',
				)
			);
			$cmb->add_field(
				array(
					'id'          => 'workout_tab_content',
					'type'        => 'select',
					'name'        => __( 'Grid Content', 'lsx-health-plan' ),
					'description' => __( 'Choose to show the excerpt, full content or nothing. For the grid layout only', 'lsx-health-plan' ),
					'options'     => array(
						''        => __( 'None', 'lsx-health-plan' ),
						'excerpt' => __( 'Excerpt', 'lsx-health-plan' ),
						'full'    => __( 'Full Content', 'lsx-health-plan' ),
					),
					'default' => '',
				)
			);

			do_action( 'lsx_hp_workout_settings_page', $cmb );

			$cmb->add_field(
				array(
					'id'   => 'settings_workouts_closing',
					'type' => 'tab_closing',
				)
			);
		}
	}
}

lightspeeddevelopment / lsx-health-plan

Push — add/multiplan ( 87a4af...b0643e )

Workout::get_instance() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
