Merge pull request #30 from BeAPI/feature/psalm

Feature/psalm

Author: Rahe

bea-plugin-boilerplate.php

@@ -65,7 +65,7 @@
 /**
  * Init the plugin
  */
-function init_bea_pb_plugin() {
+function init_bea_pb_plugin(): void {
 	// Client
 	\BEA\PB\Main::get_instance();
 

classes/Admin/Main.php

@@ -16,6 +16,6 @@ class Main {
 	 */
 	use Singleton;
 
-	public function __construct() {
+	public function init(): void {
 	}
 }

classes/Blocks.php

@@ -16,7 +16,7 @@ class Blocks {
 
 	use Singleton;
 
-	public function init() {
+	public function init(): void {
 		add_action( 'init', [ $this, 'register_blocks' ], 1 );
 		add_action( 'beapi_helpers_locate_template_templates', [ $this, 'block_templates' ], 10, 2 );
 	}

classes/Compatibility.php

@@ -8,7 +8,7 @@ class Compatibility {
 	 *
 	 * @since 0.1
 	 */
-	public static function admin_init() {
+	public static function admin_init() : void {
 		// Not on ajax
 		if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
 			return;
@@ -37,7 +37,7 @@ public static function admin_init() {
 	/**
 	 * Notify the user about the incompatibility issue.
 	 */
-	public static function admin_notices() {
+	public static function admin_notices(): void {
 		echo '<div class="notice error is-dismissible">';
 		/* 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>';

classes/Controllers/Controller.php

@@ -57,8 +57,8 @@ protected function is_page() {
 	 * @return false|string
 	 * @author Nicolas Juen
 	 */
-	public function get_form_url( $args = array() ) {
-		return Router::get_url_complex( array( $this->page_slug ), $args );
+	public function get_form_url( $args = [] ) {
+		return Router::get_url_complex( [ $this->page_slug ], $args );
 	}
 
 	/**
@@ -68,7 +68,7 @@ public function get_form_url( $args = array() ) {
 	 *
 	 * @author Nicolas Juen
 	 */
-	protected function redirect( $args = array() ) {
+	protected function redirect( $args = [] ): void {
 		wp_safe_redirect( $this->get_form_url( $args ) );
 		exit;
 	}
@@ -80,7 +80,7 @@ protected function redirect( $args = array() ) {
 	 * @return \WP_Error|self
 	 */
 	public static function get_current_controller() {
-		$classes = array_filter( get_declared_classes(), array( __CLASS__, 'filter_classes' ) );
+		$classes = array_filter( get_declared_classes(), [ __CLASS__, 'filter_classes' ] );
 
 		// Check there is classes
 		if ( empty( $classes ) ) {
@@ -97,12 +97,12 @@ public static function get_current_controller() {
 	/**
 	 * Get among all classes the right one
 	 *
-	 * @param $class
+	 * @param string $class
 	 *
 	 * @return bool
 	 * @author Nicolas Juen
 	 */
-	public static function filter_classes( $class ) {
+	public static function filter_classes( string $class ): bool {
 		if ( false === is_subclass_of( $class, '\BEA\PB\Controller', true ) ) {
 			return false;
 		}
@@ -118,6 +118,6 @@ public static function filter_classes( $class ) {
 	 * @author Nicolas Juen
 	 */
 	public function get_default_data() {
-		return array();
+		return [];
 	}
 }

classes/Cron/Cron.php

@@ -23,12 +23,12 @@ abstract class Cron {
 	protected $type = '';
 
 	/**
-	 * @var $log \Bea_Log
+	 * @var \Bea_Log $log
 	 */
 	private $log;
 
 	/**
-	 * @var $filesystem \WP_Filesystem_Direct
+	 * @var \WP_Filesystem_Direct $filesystem
 	 */
 	protected $filesystem;
 
@@ -130,10 +130,10 @@ private function get_log_file_path( $extension = true ) {
 	/**
 	 * Log a message for the current type
 	 *
-	 * @param $message : message to write on the log file
-	 * @param $type : log level message
+	 * @param string $message : message to write on the log file
+	 * @param string $type : log level message
 	 */
-	protected function add_log( $message, $type = \Bea_Log::gravity_7 ) {
+	protected function add_log( string $message, string $type = \Bea_Log::gravity_7 ): void {
 		// Log if bea log or not
 		if ( ! is_a( $this->log, '\Bea_Log' ) ) {
 			$this->log = new \Bea_Log( $this->get_log_file_path( false ), '.log' );

classes/Helpers.php

@@ -30,7 +30,7 @@ class Helpers {
 	 *
 	 * @return bool|string
 	 */
-	public static function locate_template( $tpl ) {
+	public static function locate_template( string $tpl ) {
 		if ( empty( $tpl ) ) {
 			return false;
 		}
@@ -58,7 +58,7 @@ public static function locate_template( $tpl ) {
 	 *
 	 * @return bool
 	 */
-	public static function include_template( $tpl ) {
+	public static function include_template( string $tpl ): bool {
 		if ( empty( $tpl ) ) {
 			return false;
 		}
@@ -80,7 +80,7 @@ public static function include_template( $tpl ) {
 	 *
 	 * @return \Closure|false
 	 */
-	public static function load_template( $tpl ) {
+	public static function load_template( string $tpl ) {
 		if ( empty( $tpl ) ) {
 			return false;
 		}
@@ -90,11 +90,12 @@ public static function load_template( $tpl ) {
 			return false;
 		}
 
-		return function ( $data ) use ( $tpl_path ) {
+		return static function ( $data ) use ( $tpl_path ) {
 			if ( ! is_array( $data ) ) {
 				$data = array( 'data' => $data );
 			}
 
+			// phpcs:ignore WordPress.PHP.DontExtract.extract_extract
 			extract( $data, EXTR_OVERWRITE );
 			include $tpl_path;
 		};
@@ -106,7 +107,7 @@ public static function load_template( $tpl ) {
 	 * @param string $tpl : the template's name
 	 * @param array $data : the template's data
 	 */
-	public static function render( $tpl, $data = array() ) {
+	public static function render( string $tpl, $data = array() ): void {
 		$view = self::load_template( $tpl );
 		if ( false !== $view ) {
 			$view( $data );
@@ -116,13 +117,13 @@ public static function render( $tpl, $data = array() ) {
 	/**
 	 * Transform a date to a given format if possible
 	 *
-	 * @param string $date : date to transform
-	 * @param $from_format : the from date format
-	 * @param $to_format : the format to transform in
+	 * @param string $date        : date to transform
+	 * @param string $from_format : the from date format
+	 * @param string $to_format   : the format to transform in
 	 *
 	 * @return string the date formatted
 	 */
-	public static function format_date( $date, $from_format, $to_format ) {
+	public static function format_date( string $date, string $from_format, string $to_format ): string {
 		$date = \DateTime::createFromFormat( $from_format, $date );
 		if ( false === $date ) {
 			return '';
@@ -139,7 +140,7 @@ public static function format_date( $date, $from_format, $to_format ) {
 	 *
 	 * @return string
 	 */
-	public static function datetime_i18n( $format, \DateTime $date ) {
+	public static function datetime_i18n( string $format, \DateTime $date ): string {
 		return date_i18n( $format, $date->format( 'U' ) );
 	}
 

classes/Main.php

@@ -19,14 +19,14 @@ class Main {
 	 */
 	use Singleton;
 
-	protected function init() {
-		add_action( 'init', array( $this, 'init_translations' ) );
+	protected function init(): void {
+		add_action( 'init', [ $this, 'init_translations' ] );
 	}
 
 	/**
 	 * Load the plugin translation
 	 */
-	public function init_translations() {
+	public function init_translations(): void {
 		// Load translations
 		load_plugin_textdomain( 'bea-plugin-boilerplate', false, BEA_PB_PLUGIN_DIRNAME . '/languages' );
 	}