lightspeeddevelopment / lsx-team

classes/admin/class-settings.php

<?php
/**
 * Contains the settings class for LSX
 *
 * @package lsx-team
 */

namespace lsx\team\classes\admin;

class Settings {

Missing doc comment for class Settings

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

	/**
	 * Option key, and option page slug
	 *
	 * @var string
	 */
	protected $screen_id = 'lsx_team_settings';

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

Expected 2 blank lines before function; 1 found

		add_action( 'cmb2_admin_init', array( $this, 'register_settings_page' ) );
		add_action( 'lsx_team_settings_page', array( $this, 'general_settings' ), 1, 1 );
		add_action( 'lsx_team_settings_page', array( $this, 'global_defaults' ), 3, 1 );
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Return an instance of this class.
	 *
	 * @since 1.0.0
	 *
	 * @return    object 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 ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

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

No blank line found after control structure

		return self::$instance;
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Hook in and register a submenu options page for the Page post-type menu.
	 */
	public function register_settings_page() {
		$cmb = new_cmb2_box(
			array(
				'id'           => $this->screen_id,
				'title'        => esc_html__( 'Settings', 'lsx-team' ),
				'object_types' => array( 'options-page' ),
				'option_key'   => 'lsx_team_options', // The option key and admin menu page slug.
				'parent_slug'  => 'edit.php?post_type=team', // Make options page a submenu item of the themes menu.
				'capability'   => 'manage_options', // Cap required to view options-page.
			)
		);
		do_action( 'lsx_team_settings_page', $cmb );
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Registers the general settings.
	 *
	 * @param object $cmb new_cmb2_box().
	 * @return void
	 */
	public function general_settings( $cmb ) {
		$cmb->add_field(
			array(
				'id'      => 'settings_general_title',
				'type'    => 'title',
				'name'    => __( 'General', 'lsx-team' ),
				'default' => __( 'General', 'lsx-team' ),
			)
		);
		$cmb->add_field(
			array(
				'name'        => __( 'Disable Single Posts', 'lsx-team' ),
				'id'          => 'team_disable_single',
				'type'        => 'checkbox',
				'value'       => 1,
				'default'     => 0,
				'description' => __( 'Disable Single Posts.', 'lsx-health-plan' ),
			)
		);

		$cmb->add_field(
			array(
				'name'        => __( 'Group By Role', 'lsx-team' ),
				'id'          => 'group_by_role',
				'type'        => 'checkbox',
				'value'       => 1,
				'default'     => 0,
				'description' => __( 'This setting creates Role sub-headings on the Team Member archive.', 'lsx-health-plan' ),
			)
		);
		$cmb->add_field( array(

The opening parenthesis of a multi-line function call should be the last content on the line.

			'name'    => 'Placeholder',
			'desc'    => __( 'This image displays on the archive, search results and team members single if no featured image is set.', 'lsx-health-plan' ),
			'id'      => 'team_placeholder',
			'type'    => 'file',
			'options' => array(
				'url' => false, // Hide the text input for the url.
			),
			'text'    => array(
				'add_upload_file_text' => 'Choose Image',
			),
		) );

For multi-line function calls, the closing parenthesis should be on a new line.

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

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Registers the global default settings.
	 *
	 * @param object $cmb new_cmb2_box().
	 * @return void
	 */
	public function global_defaults( $cmb ) {
		$cmb->add_field(
			array(
				'id'      => 'global_defaults_title',
				'type'    => 'title',
				'name'    => __( 'Careers CTA', 'lsx-team' ),
				'default' => __( 'Careers CTA', 'lsx-team' ),
			)
		);

		$cmb->add_field(
			array(
				'name'        => __( 'Enable careers CTA', 'lsx-team' ),
				'id'          => 'team_careers_cta_enable',
				'type'        => 'checkbox',
				'value'       => 1,
				'default'     => 0,
				'description' => __( 'Displays careers CTA mystery man on team archive.', 'lsx-health-plan' ),
			)
		);

		$cmb->add_field(
			array(
				'name' => __( 'Title', 'lsx-team' ),
				'id'   => 'team_careers_cta_title',
				'type' => 'text',
			)
		);

		$cmb->add_field(
			array(
				'name' => __( 'Tagline', 'lsx-team' ),
				'id'   => 'team_careers_cta_tagline',
				'type' => 'text',
			)
		);

		$cmb->add_field(
			array(
				'name' => __( 'Link Text', 'lsx-team' ),
				'id'   => 'team_careers_cta_link_text',
				'type' => 'text',
			)
		);

		$cmb->add_field(
			array(
				'name' => __( 'Careers page link', 'lsx-team' ),
				'id'   => 'team_careers_cta_link',
				'type' => 'text',
			)
		);

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

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

}