fix php warning / code review #9

Author: herewithme

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog ##
 
+## 1.0.6 - 04 Mar 2020
+* Fixed [#9](https://github.com/BeAPI/beapi-maintenance-mode/issues/9) Fix PHP warnings
+* Code refactoring
+
 ## 1.0.5 - 02 Apr 2019
 * Add [#8](https://github.com/BeAPI/beapi-maintenance-mode/issues/8) : filter is maintenance mode helper for handle custom behaviour.
 

README.md

@@ -38,7 +38,7 @@ If you are a developer and the plugin is not installed, you could also just use
 # Requirements
 
 - Tested up to 4.9.8
-- PHP 5.6+
+- PHP 7+
 
 # Installation
 

beapi-maintenance-mode.php

@@ -1,32 +1,32 @@
 <?php
 /*
- Plugin Name: BEAPI - Maintenance Mode
- Version: 1.0.5
- Plugin URI: https://github.com/BeAPI/beapi-maintenance-mode
- Description: Puts your WordPress site into maintenance mode.
- Author: Be API Technical team
- Author URI: https://beapi.fr
- Domain Path: languages
- Text Domain: beapi-maintenance-mode-mode
- Contributors: Maxime Culea, Nicolas Juen, Romain Lefort
+Plugin Name: BEAPI - Maintenance Mode
+Version: 1.0.6
+Plugin URI: https://github.com/BeAPI/beapi-maintenance-mode
+Description: Puts your WordPress site into maintenance mode.
+Author: Be API Technical team
+Author URI: https://beapi.fr
+Domain Path: languages
+Text Domain: beapi-maintenance-mode-mode
+Contributors: Maxime Culea, Nicolas Juen, Romain Lefort
 
- ----
+----
 
- Copyright 2018 Be API Technical team (human@beapi.fr)
+Copyright 2018 Be API Technical team (human@beapi.fr)
 
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
 
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
 
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 // don't load directly
@@ -42,11 +42,11 @@
 define( 'BEAPI_MAINTENANCE_MODE_URL', plugin_dir_url( __FILE__ ) );
 define( 'BEAPI_MAINTENANCE_MODE_DIR', plugin_dir_path( __FILE__ ) );
 define( 'BEAPI_MAINTENANCE_MODE_MAIN_FILE_DIR', __FILE__ );
-define( 'BEAPI_MAINTENANCE_MODE_PLUGIN_DIRNAME', basename( rtrim( dirname( __FILE__ ), '/' ) ) );
+define( 'BEAPI_MAINTENANCE_MODE_PLUGIN_DIRNAME', basename( rtrim( __DIR__, '/' ) ) );
 
 // Check PHP min version
 if ( version_compare( PHP_VERSION, BEAPI_MAINTENANCE_MODE_MIN_PHP_VERSION, '<' ) ) {
-	require_once( BEAPI_MAINTENANCE_MODE_DIR . 'compat.php' );
+	require_once BEAPI_MAINTENANCE_MODE_DIR . 'compat.php';
 
 	// possibly display a notice, trigger error
 	add_action( 'admin_init', array( 'BEAPI\Maintenance_Mode\Compatibility', 'admin_init' ) );

classes/helpers.php

@@ -1,4 +1,6 @@
-<?php namespace BEAPI\Maintenance_Mode;
+<?php
+
+namespace BEAPI\Maintenance_Mode;
 
 class Helpers {
 
@@ -12,37 +14,37 @@ class Helpers {
 	 * - current ip is from whitelist
 	 * - it is multisite activation process
 	 *
+	 * @return bool
 	 * @author Maxime CULEA
 	 *
-	 * @return bool
 	 */
 	public static function is_maintenance_mode() {
 		$is_maintenance_mode = ! is_user_logged_in() && ! self::is_allowed_ip() && ! self::is_ms_activate();
+
 		return apply_filters( 'beapi.maintenance_mode.is_maintenance_mode', $is_maintenance_mode );
 	}
 
 	/**
 	 * Check if the current IP is in whitelist
 	 *
-	 * @author Maxime CULEA
+	 * @return bool
 	 * @since  1.0.0
 	 *
-	 * @return bool
+	 * @author Maxime CULEA
 	 */
 	public static function is_allowed_ip() {
 		/**
 		 * Allow to add/remove custom ips
 		 *
 		 * @params array $whitelist_ips : Array of allowed ips
 		 *
-		 * @author Maxime CULEA
+		 * @return array
 		 * @since  1.0.0
 		 *
-		 * @return array
+		 * @author Maxime CULEA
 		 */
 		$whitelist_ips = apply_filters( 'beapi.maintenance_mode.whitelist_ips', [] );
-		if ( empty( $whitelist_ips ) ) {
-			// No whitelist, then everybody is allowed
+		if ( empty( $whitelist_ips ) ) { // No whitelist, then everybody is allowed
 			return true;
 		}
 
@@ -52,13 +54,13 @@ public static function is_allowed_ip() {
 			// No current ip set to check against
 			return false;
 		}
-		$current_ip = preg_replace_callback( '/(\d+)/', [ __SELF__, 'maintenance_replace_ip' ], $current_ip );
+		$current_ip = preg_replace_callback( '/(\d+)/', [ __CLASS__, 'maintenance_replace_ip' ], $current_ip );
 
 		// Loop on each whitelist IP
 		foreach ( $whitelist_ips as $allowed_ip ) {
-			$allowed_ip = preg_replace_callback( '/(\d+)/', [ __SELF__, 'maintenance_replace_ip' ], $allowed_ip );
+			$allowed_ip = preg_replace_callback( '/(\d+)/', [ __CLASS__, 'maintenance_replace_ip' ], $allowed_ip );
 			// Not strict mode check because user ip and whitelist ips could not be the same type
-			if ( $current_ip == $allowed_ip ) {
+			if ( $current_ip === $allowed_ip ) {
 				// We found a match into the whitelist
 				return true;
 			}
@@ -71,10 +73,10 @@ public static function is_allowed_ip() {
 	/**
 	 * Check if during multisite process to avoid not maintenance mode or not
 	 *
-	 * @author Maxime CULEA
+	 * @return bool
 	 * @since  1.0.0
 	 *
-	 * @return bool
+	 * @author Maxime CULEA
 	 */
 	public static function is_ms_activate() {
 		if ( empty( $_SERVER['SCRIPT_NAME'] ) ) {
@@ -89,38 +91,38 @@ public static function is_ms_activate() {
 	 *
 	 * @param $matches
 	 *
-	 * @author Nicolas Juen
+	 * @return string
 	 * @since  1.0.0
 	 *
-	 * @return string
+	 * @author Nicolas Juen
 	 */
-	private function maintenance_replace_ip( $matches ) {
-		return sprintf( "%03d", $matches[1] );
+	private static function maintenance_replace_ip( $matches ) {
+		return sprintf( '%03d', $matches[1] );
 	}
 
 	/**
 	 * Get the maintenance template path
 	 *
-	 * @author Maxime CULEA
+	 * @return string
 	 * @since  1.0.0
 	 *
-	 * @return string
+	 * @author Maxime CULEA
 	 */
-	static function get_template_path() {
+	public static function get_template_path() {
 		$default = BEAPI_MAINTENANCE_MODE_DIR . 'templates/maintenance.php';
 
 		/**
 		 * Filter maintenance template path to add a custom one
 		 *
-		 * @params string $whitelist_ips : The path to the custom template
+		 * @params string $default : The path to the custom template
 		 *
-		 * @author Maxime CULEA
+		 * @return array
 		 * @since  1.0.0
 		 *
-		 * @return array
+		 * @author Maxime CULEA
 		 */
 		$template = apply_filters( 'beapi.maintenance_mode.template.path', $default );
-		if ( empty( $template ) || ! file_exists( $template ) ) {
+		if ( empty( $template ) || ! is_file( $template ) ) {
 			$template = $default;
 		}
 

classes/main.php

@@ -1,4 +1,6 @@
-<?php namespace BEAPI\Maintenance_Mode;
+<?php
+
+namespace BEAPI\Maintenance_Mode;
 
 // don't load directly
 if ( ! defined( 'ABSPATH' ) ) {
@@ -33,18 +35,18 @@ protected function init() {
 	 * Change the header if maintenance mode
 	 *
 	 * @param $status_header
-	 * @param $header
-	 * @param $text
+	 * @param $code
+	 * @param $description
 	 * @param $protocol
 	 *
-	 * @author Maxime CULEA
+	 * @return string
 	 * @since  1.0.0
 	 *
-	 * @return string
+	 * @author Maxime CULEA
 	 */
-	function maintenance_header( $status_header, $header, $text, $protocol ) {
+	public function maintenance_header( $status_header, $code, $description, $protocol ) {
 		if ( ! Helpers::is_maintenance_mode() ) {
-			return $protocol;
+			return $status_header;
 		}
 
 		return "$protocol 503 Service Unavailable";
@@ -56,7 +58,7 @@ function maintenance_header( $status_header, $header, $text, $protocol ) {
 	 * @author Maxime CULEA
 	 * @since  1.0.0
 	 */
-	function maintenance_feed() {
+	public function maintenance_feed() {
 		if ( ! Helpers::is_maintenance_mode() ) {
 			return;
 		}
@@ -71,7 +73,7 @@ function maintenance_feed() {
 	 * @author Maxime CULEA
 	 * @since  1.0.0
 	 */
-	function maintenance_content() {
+	public function maintenance_content() {
 		if ( ! Helpers::is_maintenance_mode() ) {
 			return;
 		}
@@ -80,4 +82,4 @@ function maintenance_content() {
 		$page = file_get_contents( Helpers::get_template_path() );
 		die( $page );
 	}
-}
+}

classes/singleton.php

@@ -1,4 +1,6 @@
-<?php namespace BEAPI\Maintenance_Mode;
+<?php
+
+namespace BEAPI\Maintenance_Mode;
 
 trait Singleton {
 
@@ -30,7 +32,8 @@ final private function __construct() {
 	 * Implement this method in your child class
 	 * If you want to have actions send at construct
 	 */
-	protected function init() {}
+	protected function init() {
+	}
 
 	/**
 	 * prevent the instance from being cloned
@@ -45,5 +48,6 @@ final private function __clone() {
 	 *
 	 * @return void
 	 */
-	final private function __wakeup() {}
-}
+	final private function __wakeup() {
+	}
+}

templates/maintenance.php

@@ -35,7 +35,7 @@
 		}
 		.denied p.icon {
 			font-size: 30px;
-    		margin-bottom: 0px;
+    		margin-bottom: 0;
 		}
 	</style>
 </head>