Merge pull request #17 from BeAPI/feature/coding-standards

various fix and optimisations vs coding standards

Author: Rahe

README.md

@@ -36,10 +36,14 @@ The autoload is based on psr-4 and handled by composer.
 
 ## Changelog ##
 
+### 3.1.1
+* Fev 2021
+* Rename hook : `BEA/Helpers/locate_template/templates` in `beapi_helpers_locate_template_templates` for PHPCS
+* Improve PHPCS
+
 ### 3.1.0
 * Jan 2021
 * Update Singleton to be compatible with PHP8.0
-*
 
 ### 3.0.0
 * May 2020

bea-plugin-boilerplate.php

@@ -2,7 +2,7 @@
 /*
 Plugin Name: BEA Plugin Name
 Version: 1.0.0
-Version Boilerplate: 3.1.0
+Version Boilerplate: 3.1.1
 Plugin URI: https://beapi.fr
 Description: Your plugin description
 Author: Be API Technical team

classes/Admin/Main.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace BEA\PB\Admin;
 
 use BEA\PB\Singleton;

classes/Compatibility.php

@@ -22,11 +22,13 @@ public static function admin_init() {
 		// Load the textdomain
 		load_plugin_textdomain( 'bea-plugin-boilerplate', false, BEA_PB_PLUGIN_DIRNAME . '/languages' );
 
+		//phpcs:ignore
 		trigger_error( sprintf( __( 'Plugin Boilerplate requires PHP version %s or greater to be activated.', 'bea-plugin-boilerplate' ), BEA_PB_MIN_PHP_VERSION ) );
 
 		// Deactive self
 		deactivate_plugins( BEA_PB_DIR . 'bea-plugin-boilerplate.php' );
 
+		//phpcs:ignore
 		unset( $_GET['activate'] );
 
 		add_action( 'admin_notices', array( __CLASS__, 'admin_notices' ) );
@@ -37,7 +39,8 @@ public static function admin_init() {
 	 */
 	public static function admin_notices() {
 		echo '<div class="notice error is-dismissible">';
-		echo '<p>' . esc_html( sprintf( __( 'Plugin Boilerplate require PHP version %s or greater to be activated. Your server is currently running PHP version %s.', 'bea-plugin-boilerplate' ), BEA_PB_MIN_PHP_VERSION, PHP_VERSION ) ) . '</p>';
+		/* translators: %1$s: PHP min version %2$s: Current PHP version */
+		echo '<p>' . esc_html( sprintf( __( 'Plugin Boilerplate require PHP version %1$s or greater to be activated. Your server is currently running PHP version %2$s.', 'bea-plugin-boilerplate' ), BEA_PB_MIN_PHP_VERSION, PHP_VERSION ) ) . '</p>';
 		echo '</div>';
 	}
 }

classes/Controllers/Controller.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace BEA\PB\Controllers;
 
 use BEA\PB\Routes\Router;

classes/Cron/Cron.php

@@ -1,8 +1,9 @@
 <?php
-use \Bea_Log;
 
 namespace BEA\PB;
 
+use \Bea_Log;
+
 /**
  * This class needs Bea_Log to work
  * This class purpose is to handle cron process by :
@@ -94,8 +95,8 @@ private function get_lock_file_path() {
 	 * @author Nicolas Juen
 	 */
 	private static function get_filesystem() {
-		require_once( ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php' );
-		require_once( ABSPATH . 'wp-admin/includes/class-wp-filesystem-direct.php' );
+		require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php';
+		require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-direct.php';
 		$filesystem = new \WP_Filesystem_Direct( new \StdClass() );
 
 		return $filesystem;
@@ -139,6 +140,7 @@ protected function add_log( $message, $type = \Bea_Log::gravity_7 ) {
 		}
 		$this->log->log_this( $message, $type );
 
-		echo date( '[d-m-Y H:i:s]' ) . $message . "\n";
+		//phpcs:ignore
+		printf( '%s %s \n', date( '[d-m-Y H:i:s]' ), esc_html( $message ) );
 	}
 }

classes/Helpers.php

@@ -1,5 +1,7 @@
 <?php
+
 namespace BEA\PB;
+
 /**
  * The purpose of the API class is to have the basic reusable methods like :
  *  - Template include
@@ -33,7 +35,7 @@ public static function locate_template( $tpl ) {
 			return false;
 		}
 
-		$path = apply_filters( 'BEA/Helpers/locate_template/templates', array( 'views/' . BEA_PB_VIEWS_FOLDER_NAME . '/' . $tpl . '.php' ), $tpl, __NAMESPACE__ );
+		$path = apply_filters( 'beapi_helpers_locate_template_templates', [ 'views/' . BEA_PB_VIEWS_FOLDER_NAME . '/' . $tpl . '.php' ], $tpl, __NAMESPACE__ );
 
 		// Locate from the theme
 		$located = locate_template( $path, false, false );
@@ -66,7 +68,7 @@ public static function include_template( $tpl ) {
 			return false;
 		}
 
-		include( $tpl_path );
+		include $tpl_path;
 
 		return true;
 	}
@@ -88,24 +90,27 @@ public static function load_template( $tpl ) {
 			return false;
 		}
 
-		return function( $data ) use ( $tpl_path ) {
+		return function ( $data ) use ( $tpl_path ) {
 			if ( ! is_array( $data ) ) {
 				$data = array( 'data' => $data );
 			}
-			extract( $data,  EXTR_OVERWRITE );
-			include( $tpl_path );
+
+			extract( $data, EXTR_OVERWRITE );
+			include $tpl_path;
 		};
 	}
 
 	/**
 	 * Render a view
 	 *
 	 * @param string $tpl : the template's name
-	 * @param array  $data : the template's data
+	 * @param array $data : the template's data
 	 */
 	public static function render( $tpl, $data = array() ) {
 		$view = self::load_template( $tpl );
-		false !== $view ? $view( $data ) : '';
+		if ( false !== $view ) {
+			$view( $data );
+		}
 	}
 
 	/**
@@ -119,7 +124,7 @@ public static function render( $tpl, $data = array() ) {
 	 */
 	public static function format_date( $date, $from_format, $to_format ) {
 		$date = \DateTime::createFromFormat( $from_format, $date );
-		if ( false == $date ) {
+		if ( false === $date ) {
 			return '';
 		}
 

classes/Main.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace BEA\PB;
 
 /**

classes/Models/Model.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace BEA\PB\Models;
 
 /**
@@ -137,12 +138,12 @@ public function get_meta( $key, $format = true ) {
 		$fields = $this->get_fields();
 
 		// Check ACF
-		if ( ! in_array( $key, $fields ) && ! isset( $fields[ $key ] ) || ! function_exists( 'get_field' ) ) {
+		if ( ! in_array( $key, $fields, true ) && ! isset( $fields[ $key ] ) || ! function_exists( 'get_field' ) ) {
 			return $this->wp_object->{$key};
 		}
-		
+
 		// On ACF given key
-		$key = in_array( $key, $fields ) ? $key : $fields[ $key ];
+		$key = in_array( $key, $fields, true ) ? $key : $fields[ $key ];
 
 		return get_field( $key, $this->get_ID(), $format );
 	}
@@ -468,10 +469,18 @@ public function get_all_data() {
 	 * @return array
 	 */
 	public static function filter_post_array( $data ) {
-		return array_intersect_key( $data, array_flip( array_filter( array_keys( $data ), array(
-			__CLASS__,
-			'filter_post_keys',
-		) ) ) );
+		return array_intersect_key(
+			$data,
+			array_flip(
+				array_filter(
+					array_keys( $data ),
+					array(
+						__CLASS__,
+						'filter_post_keys',
+					)
+				)
+			)
+		);
 	}
 
 	/**
@@ -491,7 +500,7 @@ public static function filter_post_keys( $key ) {
 		$keys[] = 'tax_input';
 		$keys[] = 'post_category';
 
-		return in_array( $key, $keys );
+		return in_array( $key, $keys, true );
 	}
 
 	/**

classes/Models/User.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace BEA\PB\Models;
 
 /**
@@ -39,7 +40,8 @@ public function __construct( \WP_User $object ) {
 	/**
 	 * Create user
 	 *
-	 * @param array  $args
+	 * @param array $args
+	 *
 	 * @deprecated 2.1.3 $user_email Use first argument as array.
 	 *
 	 * @return false or user model
@@ -54,13 +56,14 @@ public static function create( $args, $user_email = null ) {
 				'user_email' => $user_email,
 			];
 		}
+
 		return self::_create( $args );
 	}
 
 	/**
 	 * User creation method
 	 *
-	 * @param array  $args
+	 * @param array $args
 	 *
 	 * @return User|bool
 	 *