Suppress warnings to avoid headers already sent notices

Author: unfulvio

.circleci/apache_ci.conf

@@ -1,7 +1,8 @@
 # Changelog
 
-### 1.5.4 (28 May 2019)
+### 1.5.4 (30 May 2019)
  * Fix: Temporarily suppress PHP warnings while connecting with PHP Console to avoid headers already sent warnings, then restore all errors reporting
+ * Misc: Improved PHP and WordPress compatibility loader
 
 ### 1.5.3 (22 May 2019)
  * Fix: Try to get rid of PHP errors related to "Unable to set PHP Console server cookie" and "Cannot modify header information - headers already sent"

.circleci/config.yml

@@ -2,7 +2,7 @@
   "name": "unfulvio/wp-php-console",
   "description": "A WordPress implementation of PHP Console.",
   "type": "wordpress-plugin",
-  "version": "1.5.3",
+  "version": "1.5.4",
   "keywords": ["wordpress", "debug", "debugging", "development", "php-console", "console", "terminal", "command-line", "cli" ],
   "homepage": "https://github.com/unfulvio/wp-php-console",
   "license": "GPLv2.0+",
@@ -15,24 +15,9 @@
     }
   ],
   "require": {
-    "php": ">=5.6.0",
-    "composer/installers": "^1.0",
-    "nekojira/wp-requirements": "^1.4",
-    "php-console/php-console": "3.1.7",
-    "xrstf/composer-php52": "1.*"
+    "php-console/php-console": "3.1.7"
   },
   "require-dev": {
     "lucatume/wp-browser": "2.2.7"
-  },
-  "scripts": {
-    "post-install-cmd": [
-      "xrstf\\Composer52\\Generator::onPostInstallCmd"
-    ],
-    "post-update-cmd": [
-      "xrstf\\Composer52\\Generator::onPostInstallCmd"
-    ],
-    "post-autoload-dump": [
-      "xrstf\\Composer52\\Generator::onPostInstallCmd"
-    ]
   }
 }

ChangeLog.md

@@ -0,0 +1,28 @@
+<?php
+/**
+ * WP PHP Console
+ *
+ * This source file is subject to the GNU General Public License v3.0
+ * that is bundled with this package in the file license.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://www.gnu.org/licenses/gpl-3.0.html
+ *
+ * @author    Fulvio Notarstefano <[email protected]>
+ * @copyright Copyright (c) 2014-2019 Fulvio Notarstefano
+ * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
+ */
+
+defined( 'ABSPATH' ) or exit;
+
+
+/**
+ * Gets the WP PHP Console instance.
+ *
+ * @since 1.5.4
+ *
+ * @return WP_PHP_Console\Plugin
+ */
+function wp_php_console() {
+
+	return new \WP_PHP_Console\Plugin();
+}

LICENSE.txt

@@ -1,4 +1,16 @@
 <?php
+/**
+ * WP PHP Console
+ *
+ * This source file is subject to the GNU General Public License v3.0
+ * that is bundled with this package in the file license.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://www.gnu.org/licenses/gpl-3.0.html
+ *
+ * @author    Fulvio Notarstefano <[email protected]>
+ * @copyright Copyright (c) 2014-2019 Fulvio Notarstefano
+ * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
+ */
 
 namespace WP_PHP_Console;
 
@@ -22,7 +34,7 @@ class Plugin {
 
 
 	/** @var array settings options */
-	protected $options = [];
+	private $options = [];
 
 	/** @var PhpConsole\Connector instance */
 	public $connector;
@@ -35,24 +47,38 @@ class Plugin {
 	 */
 	public function __construct() {
 
-		// handle translations
-		add_action( 'plugins_loaded', [ $this, 'set_locale' ] );
+		$this->set_debug_mode();
+		$this->set_options();
+		$this->set_admin();
+		$this->set_hooks();
+	}
 
-		// set options
-		$this->options = $this->get_options();
 
-		// load admin
-		$this->set_admin();
+	/**
+	 * Sets constants and elevates PHP error reporting.
+	 *
+	 * @since 1.5.4
+	 */
+	private function set_debug_mode() {
 
-		// bail out if PHP Console can't be found
-		if ( ! class_exists( 'PhpConsole\Connector' ) ) {
-			return;
+		@error_reporting( E_ALL );
+
+		foreach ( [ 'WP_DEBUG',	'WP_DEBUG_LOG', 'WP_DEBUG_DISPLAY', ] as $wp_debug_constant ) {
+			if ( ! defined( $wp_debug_constant ) ) {
+				define ( $wp_debug_constant, true );
+			}
 		}
+	}
 
-		// connect to PHP Console
-		add_action( 'init',      [ $this, 'connect' ], -1000 );
-		// delay further PHP Console initialisation to have more context during Remote PHP execution
-		add_action( 'wp_loaded', [ $this, 'init' ], -1000 );
+
+	/**
+	 * Sets the plugin options.
+	 *
+	 * @since 1.5.4
+	 */
+	private function set_options() {
+
+		$this->options = $this->get_options();
 	}
 
 
@@ -88,14 +114,32 @@ private function set_admin() {
 				], $actions );
 			} );
 
-			// init settings
-			require_once __DIR__ . '/class-wp-php-console-settings.php';
-
 			new Settings( $this->options );
 		}
 	}
 
 
+	/**
+	 * Sets plugin hooks.
+	 *
+	 * @since 1.5.4
+	 */
+	private function set_hooks() {
+
+		// bail out if PHP Console can't be found
+		if ( ! class_exists( 'PhpConsole\Connector' ) ) {
+			return;
+		}
+
+		// handle translations
+		add_action( 'plugins_loaded', [ $this, 'set_locale' ] );
+		// connect to PHP Console
+		add_action( 'init',           [ $this, 'connect' ], -1000 );
+		// delay further PHP Console initialisation to have more context during Remote PHP execution
+		add_action( 'wp_loaded',      [ $this, 'init' ], -1000 );
+	}
+
+
 	/**
 	 * Connects to PHP Console.
 	 *
@@ -110,21 +154,27 @@ public function connect() {
 		// workaround for avoiding headers already sent warnings
 		@error_reporting( E_ALL & ~E_WARNING );
 
-		if ( empty( @session_id() ) ) {
+		if ( ! @session_id() ) {
 			@session_start();
 		}
 
+		$connected = true;
+
 		if ( ! $this->connector instanceof PhpConsole\Connector ) {
 			try {
 				$this->connector = PhpConsole\Connector::getInstance();
-			} catch ( \Exception $e ) {}
+			} catch ( \Exception $e ) {
+				$connected = false;
+			}
 		}
 
 		// restore error reporting
 		@error_reporting( E_ALL );
 
 		// apply PHP Console options
-		$this->apply_options();
+		if ( $connected ) {
+			$this->apply_options();
+		}
 	}
 
 
@@ -215,9 +265,20 @@ public function init() {
 		// get PHP Console instance if wasn't set yet
 		if ( ! $this->connector instanceof PhpConsole\Connector ) {
 
+			// workaround for avoiding headers already sent warnings
+			@error_reporting( E_ALL & ~E_WARNING );
+
 			try {
 				$this->connector = PhpConsole\Connector::getInstance();
+				$connected       = true;
 			} catch ( \Exception $e ) {
+				$connected       = false;
+			}
+
+			// restore error reporting
+			@error_reporting( E_ALL );
+
+			if ( ! $connected ) {
 				return;
 			}
 		}
@@ -321,7 +382,7 @@ public function password_notice() {
 		?>
 		<div class="update-nag">
 			<p><?php printf(
-				/* translators: Placeholders: %1$s - WP Php Console name, %2$s - opening HTML <a> link tag; %3$s closing HTML </a> link tag */
+				/* translators: Placeholders: %1$s - WP PHP Console name, %2$s - opening HTML <a> link tag; %3$s closing HTML </a> link tag */
 				__( '%1$s: Please remember to %2$sset a password%3$s if you want to enable the terminal.', 'wp-php-console' ),
 				'<strong>' . self::NAME . '</strong>',
 				'<a href="' . esc_url( admin_url( 'options-general.php?page=wp-php-console' ) ) .'">',

codeception.yml

@@ -1,4 +1,16 @@
 <?php
+/**
+ * WP PHP Console
+ *
+ * This source file is subject to the GNU General Public License v3.0
+ * that is bundled with this package in the file license.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://www.gnu.org/licenses/gpl-3.0.html
+ *
+ * @author    Fulvio Notarstefano <[email protected]>
+ * @copyright Copyright (c) 2014-2019 Fulvio Notarstefano
+ * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
+ */
 
 namespace WP_PHP_Console;
 

composer.json

@@ -2,7 +2,7 @@
   "name": "wp-php-console",
   "title": "WP PHP Console",
   "description": "An implementation of PHP Console as a WordPress plugin. Use Chrome Dev Tools to debug your WordPress installation!",
-  "version": "1.5.3",
+  "version": "1.5.4",
   "homepage": "https://wordpress.org/plugins/wp-php-console/",
   "repository": {
     "type": "git",