lightspeeddevelopment / lsx-team

classes/class-lsx-team-admin.php

<?php

This file is missing a doc comment.

/**
 * LSX Team Admin Class
 *
 * @package   LSX Team
 * @author    LightSpeed
 * @license   GPL3
 * @link
 * @copyright 2018 LightSpeed
 */

There must be no blank lines after the class comment

class LSX_Team_Admin {

	public function __construct() {

Missing doc comment for function __construct()

Expected 2 blank lines before function; 1 found

		$this->load_classes();

		add_action( 'init', array( $this, 'post_type_setup' ) );
		add_action( 'init', array( $this, 'taxonomy_setup' ) );

		add_action( 'cmb2_admin_init', array( $this, 'details_metabox' ) );
		add_action( 'cmb2_admin_init', array( $this, 'projects_details_metabox' ) );
		add_action( 'cmb2_admin_init', array( $this, 'services_details_metabox' ) );
		add_action( 'cmb2_admin_init', array( $this, 'testimonials_details_metabox' ) );

		add_action( 'admin_enqueue_scripts', array( $this, 'assets' ) );

		add_filter( 'type_url_form_media', array( $this, 'change_attachment_field_button' ), 20, 1 );
		add_filter( 'enter_title_here', array( $this, 'change_title_text' ) );
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Loads the admin subclasses
	 */
	private function load_classes() {
		require_once LSX_TEAM_PATH . 'classes/admin/class-settings.php';
		$this->settings = \lsx\team\classes\admin\Settings::get_instance();

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

		require_once LSX_TEAM_PATH . 'classes/admin/class-settings-theme.php';
		$this->settings_theme = \lsx\team\classes\admin\Settings_Theme::get_instance();

The property settings_theme does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	public function post_type_setup() {

Missing doc comment for function post_type_setup()

		$labels = array(
			'name'               => esc_html_x( 'Team Members', 'post type general name', 'lsx-team' ),
			'singular_name'      => esc_html_x( 'Team Member', 'post type singular name', 'lsx-team' ),
			'add_new'            => esc_html_x( 'Add New', 'post type general name', 'lsx-team' ),
			'add_new_item'       => esc_html__( 'Add New Team Member', 'lsx-team' ),
			'edit_item'          => esc_html__( 'Edit Team Member', 'lsx-team' ),
			'new_item'           => esc_html__( 'New Team Member', 'lsx-team' ),
			'all_items'          => esc_html__( 'All Team Members', 'lsx-team' ),
			'view_item'          => esc_html__( 'View Team Member', 'lsx-team' ),
			'search_items'       => esc_html__( 'Search Team Members', 'lsx-team' ),
			'not_found'          => esc_html__( 'No team members found', 'lsx-team' ),
			'not_found_in_trash' => esc_html__( 'No team members found in Trash', 'lsx-team' ),
			'parent_item_colon'  => '',
			'menu_name'          => esc_html_x( 'Team Members', 'admin menu', 'lsx-team' ),
		);

		$args = array(
			'labels'             => $labels,
			'public'             => true,
			'publicly_queryable' => true,
			'show_ui'            => true,
			'show_in_menu'       => true,
			'menu_icon'          => 'dashicons-groups',
			'query_var'          => true,
			'rewrite'            => array(
				'slug' => 'team',
			),
			'capability_type'    => 'post',
			'has_archive'        => 'team',
			'hierarchical'       => false,
			'menu_position'      => null,
			'supports'           => array(
				'title',
				'editor',
				'excerpt',
				'thumbnail',
				'custom-fields',
			),
			'show_in_rest'          => true,

Array double arrow not aligned correctly; expected 7 space(s) between "'show_in_rest'" and double arrow, but found 10.

		);

		register_post_type( 'team', $args );
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	public function taxonomy_setup() {

Missing doc comment for function taxonomy_setup()

		$labels = array(
			'name'              => esc_html_x( 'Roles', 'taxonomy general name', 'lsx-team' ),
			'singular_name'     => esc_html_x( 'Role', 'taxonomy singular name', 'lsx-team' ),
			'search_items'      => esc_html__( 'Search Roles', 'lsx-team' ),
			'all_items'         => esc_html__( 'All Roles', 'lsx-team' ),
			'parent_item'       => esc_html__( 'Parent Role', 'lsx-team' ),
			'parent_item_colon' => esc_html__( 'Parent Role:', 'lsx-team' ),
			'edit_item'         => esc_html__( 'Edit Role', 'lsx-team' ),
			'update_item'       => esc_html__( 'Update Role', 'lsx-team' ),
			'add_new_item'      => esc_html__( 'Add New Role', 'lsx-team' ),
			'new_item_name'     => esc_html__( 'New Role Name', 'lsx-team' ),
			'menu_name'         => esc_html__( 'Roles', 'lsx-team' ),
		);

		$args = array(
			'hierarchical'      => true,
			'labels'            => $labels,
			'show_ui'           => true,
			'show_admin_column' => true,
			'query_var'         => true,
			'rewrite'           => array(
				'slug' => 'team-role',
			),
			'show_in_rest'          => true,

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

		);

		register_taxonomy( 'team_role', array( 'team' ), $args );
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

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

Expected 0 blank lines after opening function brace; 1 found

		$prefix = 'lsx_';

		$users = get_transient( 'lsx_team_users' );

		if ( false === $users || '' === $users ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$users = get_users( array(

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

				'role__in' => array( 'administrator', 'editor', 'author' ),
			) );

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

			set_transient( 'lsx_team_users', $users, 5 * 60 );
		}

		foreach ( $users as $user ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$user_array[$user->ID] = $user->user_login;

Array keys must be surrounded by spaces unless they contain a string or an integer.

		}

		$cmb = new_cmb2_box(
			array(
				'id'           => $prefix . '_team',
				'title'        => esc_html__( 'Team Member Details', 'lsx-team' ),
				'object_types' => 'team',
				'context'      => 'normal',
				'priority'     => 'low',
				'show_names'   => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Featured:', 'lsx-team' ),
				'id'           => $prefix . 'featured',
				'type'         => 'checkbox',
				'value'        => 1,
				'default'      => 0,
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Site User', 'lsx-team' ),
				'id'           => $prefix . 'site_user',
				'allow_none'   => true,
				'type'         => 'select',
				'options'      => $user_array,
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Job Title:', 'lsx-team' ),
				'id'           => $prefix . 'job_title',
				'type'         => 'text',
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Location:', 'lsx-team' ),
				'id'           => $prefix . 'location',
				'type'         => 'text',
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Contact Email Address:', 'lsx-team' ),
				'id'           => $prefix . 'email_contact',
				'type'         => 'text',
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Gravatar Email Address:', 'lsx-team' ),
				'desc'         => esc_html__( 'Used for Gravatar if a featured image is not set', 'lsx-team' ),
				'id'           => $prefix . 'email_gravatar',
				'type'         => 'text',
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Telephone Number:', 'lsx-team' ),
				'id'           => $prefix . 'tel',
				'type'         => 'text',
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Skype Name:', 'lsx-team' ),
				'id'           => $prefix . 'skype',
				'type'         => 'text',
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Facebook URL', 'lsx-team' ),
				'id'           => $prefix . 'facebook',
				'type'         => 'text_url',
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Twitter URL', 'lsx-team' ),
				'id'           => $prefix . 'twitter',
				'type'         => 'text_url',
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'LinkedIn URL', 'lsx-team' ),
				'id'           => $prefix . 'linkedin',
				'type'         => 'text_url',
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'Github URL', 'lsx-team' ),
				'id'           => $prefix . 'github',
				'type'         => 'text_url',
				'show_in_rest' => true,
			)
		);

		$cmb->add_field(
			array(
				'name'         => esc_html__( 'WordPress URL', 'lsx-team' ),
				'id'           => $prefix . 'wordpress',
				'type'         => 'text_url',
				'show_in_rest' => true,
			)
		);
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

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

Expected 0 blank lines after opening function brace; 1 found

		if ( class_exists( 'LSX_Projects' ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

Blank line found at start of control structure

			$prefix = 'lsx_';

			$cmb = new_cmb2_box(
				array(
					'id'           => $prefix . '_team',
					'context'      => 'normal',
					'priority'     => 'low',
					'show_names'   => true,
					'object_types' => array( 'team' ),
				)
			);
			$cmb->add_field(
				array(
					'name'       => __( 'Projects:', 'lsx-team' ),
					'id'         => 'project_to_team',
					'type'       => 'post_search_ajax',
					'limit'      => 15,
					'sortable'   => true,
					'query_args' => array(
						'post_type'      => array( 'project' ),
						'post_status'    => array( 'publish' ),
						'posts_per_page' => -1,
					),
				)
			);
		}
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

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

Expected 0 blank lines after opening function brace; 1 found

		if ( class_exists( 'LSX_Services' ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

Blank line found at start of control structure

			$prefix = 'lsx_';

			$cmb = new_cmb2_box(
				array(
					'id'           => $prefix . '_team',
					'context'      => 'normal',
					'priority'     => 'low',
					'show_names'   => true,
					'object_types' => array( 'team' ),
				)
			);
			$cmb->add_field(
				array(
					'name'       => __( 'Services:', 'lsx-team' ),
					'id'         => 'service_to_team',
					'type'       => 'post_search_ajax',
					'limit'      => 15,
					'sortable'   => true,
					'query_args' => array(
						'post_type'      => array( 'service' ),
						'post_status'    => array( 'publish' ),
						'posts_per_page' => -1,
					),
				)
			);
		}
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

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

Expected 0 blank lines after opening function brace; 1 found

		if ( class_exists( 'LSX_Testimonials' ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

Blank line found at start of control structure

			$prefix = 'lsx_';

			$cmb = new_cmb2_box(
				array(
					'id'           => $prefix . '_team',
					'context'      => 'normal',
					'priority'     => 'low',
					'show_names'   => true,
					'object_types' => array( 'team' ),
				)
			);
			$cmb->add_field(
				array(
					'name'       => __( 'Testimonials:', 'lsx-team' ),
					'id'         => 'testimonial_to_team',
					'type'       => 'post_search_ajax',
					'limit'      => 15,
					'sortable'   => true,
					'query_args' => array(
						'post_type'      => array( 'testimonial' ),
						'post_status'    => array( 'publish' ),
						'posts_per_page' => -1,
					),
				)
			);
		}

	}

Expected 2 blank lines after function; 1 found

	/**

Doc comment for parameter "$post_id" missing

Doc comment for parameter "$field" missing

Doc comment for parameter "$value" missing

	 * Sets up the "post relations".
	 */
	public function post_relations( $post_id, $field, $value ) {
		$connections = array(
			'team_to_testimonial',
			'testimonial_to_team',

			'team_to_project',
			'project_to_team',

			'team_to_service',
			'service_to_team',
		);

		if ( in_array( $field['id'], $connections ) ) {

Expected 0 spaces after opening bracket; 1 found

Not using strict comparison for in_array; supply true for third argument.

Expected 0 spaces before closing bracket; 1 found

			$this->save_related_post( $connections, $post_id, $field, $value );
		}
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**

Doc comment for parameter "$connections" missing

Doc comment for parameter "$post_id" missing

Doc comment for parameter "$field" missing

Doc comment for parameter "$value" missing

	 * Save the reverse post relation.
	 */
	public function save_related_post( $connections, $post_id, $field, $value ) {
		$ids = explode( '_to_', $field['id'] );

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

		$relation = $ids[1] . '_to_' . $ids[0];

		if ( in_array( $relation, $connections ) ) {

Expected 0 spaces after opening bracket; 1 found

Not using strict comparison for in_array; supply true for third argument.

Expected 0 spaces before closing bracket; 1 found

			$previous_values = get_post_meta( $post_id, $field['id'], false );

			if ( ! empty( $previous_values ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

				foreach ( $previous_values as $v ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

					delete_post_meta( $v, $relation, $post_id );
				}
			}

			if ( is_array( $value ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

				foreach ( $value as $v ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

					if ( ! empty( $v ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

						add_post_meta( $v, $relation, $post_id );
					}
				}
			}
		}
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	public function assets() {

Missing doc comment for function assets()

		//wp_enqueue_media();

75% of this comment could be valid code. Did you maybe forget this after debugging?

No space found before comment text; expected "// wp_enqueue_media();" but found "//wp_enqueue_media();"

Inline comments must end in full-stops, exclamation marks, or question marks

		wp_enqueue_script( 'media-upload' );
		wp_enqueue_script( 'thickbox' );
		wp_enqueue_style( 'thickbox' );

		wp_enqueue_script( 'lsx-team-admin', LSX_TEAM_URL . 'assets/js/lsx-team-admin.min.js', array( 'jquery' ), LSX_TEAM_VER );

In footer ($in_footer) is not set explicitly wp_enqueue_script; It is recommended to load scripts in the footer. Please set this value to true to load it in the footer, or explicitly false if it should be loaded in the header.

		wp_enqueue_style( 'lsx-team-admin', LSX_TEAM_URL . 'assets/css/lsx-team-admin.css', array(), LSX_TEAM_VER );
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**

Doc comment for parameter "$html" missing

	 * Change the "Insert into Post" button text when media modal is used for feature images
	 */
	public function change_attachment_field_button( $html ) {
		if ( isset( $_GET['feature_image_text_button'] ) ) {

Expected 0 spaces after opening bracket; 1 found

Processing form data without nonce verification.

Expected 0 spaces before closing bracket; 1 found

			$html = str_replace( 'value="Insert into Post"', sprintf( 'value="%s"', esc_html__( 'Select featured image', 'lsx-team' ) ), $html );
		}

		return $html;
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	public function change_title_text( $title ) {

Missing doc comment for function change_title_text()

		$screen = get_current_screen();

		if ( 'team' === $screen->post_type ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$title = esc_attr__( 'Enter team member name', 'lsx-team' );
		}

		return $title;
	}

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

}

$lsx_team_admin = new LSX_Team_Admin();