lightspeeddevelopment / wetu-importer

classes/class-lsx-wetu-importer-post-columns.php

<?php
/**
 * The Post Columns code for the Importer Plugin
 *
 * @package   lsx_wetu_importer
 * @author    LightSpeed
 * @license   GPL-3.0+
 * @link
 * @copyright 2019 LightSpeed
 **/

/**
 * The Post Columns code for the Importer Plugin
 */
class LSX_WETU_Importer_Post_Columns {

	/**
	 * Holds instance of the class
	 *
	 * @var object
	 */
	private static $instance;

	/**
	 * Initialize the plugin by setting localization, filters, and administration functions.
	 *
	 * @since 1.0.0
	 *
	 * @access private
	 */
	public function __construct() {

Expected 2 blank lines before function; 1 found

		add_filter( 'manage_tour_posts_columns', array( $this, 'register_tour_columns' ) );
		add_action( 'manage_tour_posts_custom_column', array( $this, 'output_tour_ref_column' ), 10, 2 );

		// Sortables Columns, sorting needs to be fixed

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

		// add_filter( 'manage_edit-tour_sortable_columns', array( $this, 'register_sortable_columns' ) );
		// add_action( 'pre_get_posts', array( $this, 'columns_posts_orderby' ) );

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

	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Return an instance of this class.
	 *
	 * @return  object
	 */
	public static function get_instance() {
		// If the single instance hasn't been set, set it now.
		if ( ! isset( 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 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Display the importer welcome screen
	 */
	public function display_page() {

	}

Expected 2 blank lines after function; 1 found

	/**
	 * Registers the tour ref column
	 *
	 * @param array $columns

Missing parameter comment

	 * @return array
	 */
	public function register_tour_columns( $columns ) {
		$new_columns = array(
			'cb'       => $columns['cb'],
			'title'    => $columns['title'],
			'wetu_ref' => __( 'Ref', 'lsx-wetu-importer' ),
		);
		unset( $columns['cb'] );
		unset( $columns['title'] );
		foreach ( $columns as $column_key => $column_label ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$new_columns[ $column_key ] = $column_label;
		}

No blank line found after control structure

		$columns = $new_columns;
		return $columns;
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Outputs the tour reference column
	 *
	 * @param string $column

Missing parameter comment

	 * @param string $post_id

Missing parameter comment

	 * @return void
	 */
	public function output_tour_ref_column( $column, $post_id ) {
		if ( 'wetu_ref' === $column ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			echo esc_attr( get_post_meta( $post_id, 'lsx_wetu_ref', true ) );

$post_id of type string is incompatible with the type integer expected by parameter $post_id of get_post_meta().

It seems like get_post_meta($post_id, 'lsx_wetu_ref', true) can also be of type false; however, parameter $text of esc_attr() does only seem to accept string, maybe add an additional type check?

		}
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Register the columns that will be sortable
	 *
	 * @param array $columns

Missing parameter comment

	 * @return array
	 */
	public function register_sortable_columns( $columns = array() ) {
		$columns['wetu_ref'] = 'price_per_month';
		return $columns;
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Sort the columns
	 *
	 * @param object $query WP_Query()

Parameter comment must end with a full stop

	 * @return void
	 */
	public function columns_posts_orderby( $query ) {
		if ( ! is_admin() || ! $query->is_main_query() ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			return;
		}

No blank line found after control structure

		if ( 'wetu_ref' === $query->get( 'orderby' ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$query->set( 'orderby', 'meta_value' );
			$query->set( 'meta_key', 'lsx_wetu_reference' );
		}

No blank line found after control structure

		/*

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

Empty line required before block comment

		if ( $query->is_search() && 'tour' === $query->get( 'post_type' ) ) {

Block comments must start with a capital letter

			$meta_query = array(
				'relation' => 'OR',
				array(
					'key' => 'lsx_wetu_ref',
					'value' => get_search_query(),
					'compare' => 'LIKE',
				),
			);
			$query->set( 'meta_query', $meta_query );
		}*/

Comment closer must be on a new line

	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 0 found

}