Refactor for --type support of ee site command

composer.json

@@ -12,7 +12,11 @@
             "": "src/",
             "AcmePhp\\Cli\\": "AcmePhp/Cli"
         },
-        "files": [ "site-command.php" ]
+        "files": [
+            "src/helper/hooks.php",
+            "src/helper/site-utils.php",
+            "site-command.php"
+        ]
     },
     "extra": {
         "branch-alias": {

site-command.php

@@ -13,11 +13,5 @@
 	require_once $autoload;
 }
 
-// Load utility functions.
-require_once 'src/helper/site-utils.php';
-
-// Load hooks.
-require_once 'src/helper/hooks.php';
-
 EE::add_command( 'site', 'Site_Command' );
 Site_Command::add_site_type( 'html', 'EE\Site\Type\HTML' );

src/Site_Command.php

@@ -38,7 +38,7 @@ public static function instance() {
 	public static function add_site_type( $name, $callback ) {
 
 		if ( isset( self::$instance->site_types[ $name ] ) ) {
-			EE::warning( sprintf( '%s site-type has already been previously registered by %s. It will be over-written by the new package class %s. Please update your packages to resolve this.', $name, self::$instance->site_types[ $name ], $callback ) );
+			EE::warning( sprintf( '%s site-type had already been previously registered by %s. It is overridden by the new package class %s. Please update your packages to resolve this.', $name, self::$instance->site_types[ $name ], $callback ) );
 		}
 		self::$instance->site_types[ $name ] = $callback;
 	}
@@ -53,6 +53,7 @@ public static function get_site_types() {
 	}
 
 	/**
+	 * Performs site operations. Check `ee help site` for more info.
 	 * Invoked function of site-type routing. Called when `ee site` is invoked.
 	 * Performs the routing to respective site-type passed using either `--type=`,
 	 * Or discovers the type from the site-name and fetches the type from it,
@@ -73,9 +74,7 @@ public function __invoke( $args, $assoc_args ) {
 
 		if ( ! isset( $site_types[ $type ] ) ) {
 			$error = sprintf(
-				"'%s' is not a registered site type of 'ee site --type=%s'. See 'ee help site --type=%s' for available subcommands.",
-				$type,
-				$type,
+				'\'%1$s\' is not a registered site type of \'ee site --type=%1$s\'. See \'ee help site --type=%1$s\' for available subcommands.',
 				$type
 			);
 			EE::error( $error );
@@ -106,10 +105,6 @@ private function determine_type( $args ) {
 		// default site-type
 		$type = 'html';
 
-		// TODO: get type from config file as below
-		// $config_type = EE::get_config('type');
-		// $type        = empty( $config_type ) ? 'html' : $config_type;
-
 		$last_arg = array_pop( $args );
 		if ( substr( $last_arg, 0, 4 ) === 'http' ) {
 			$last_arg = str_replace( [ 'https://', 'http://' ], '', $last_arg );

src/helper/class-ee-site.php

@@ -37,6 +37,13 @@ abstract class EE_Site_Command {
 	private $site;
 
 	public function __construct() {
+
+		pcntl_signal( SIGTERM, [ $this, "rollback" ] );
+		pcntl_signal( SIGHUP, [ $this, "rollback" ] );
+		pcntl_signal( SIGUSR1, [ $this, "rollback" ] );
+		pcntl_signal( SIGINT, [ $this, "rollback" ] );
+		$shutdown_handler = new Shutdown_Handler();
+		register_shutdown_function( [ $shutdown_handler, "cleanup" ], [ &$this ] );
 	}
 
 	/**
@@ -538,6 +545,25 @@ private function populate_site_info( $args ) {
 		}
 	}
 
+	/**
+	 * Shutdown function to catch and rollback from fatal errors.
+	 */
+	protected function shutDownFunction() {
+
+		$logger = \EE::get_file_logger()->withName( 'site-command' );
+		$error  = error_get_last();
+		if ( isset( $error ) && $error['type'] === E_ERROR ) {
+			\EE::warning( 'An Error occurred. Initiating clean-up.' );
+			$logger->error( 'Type: ' . $error['type'] );
+			$logger->error( 'Message: ' . $error['message'] );
+			$logger->error( 'File: ' . $error['file'] );
+			$logger->error( 'Line: ' . $error['line'] );
+			$this->rollback();
+		}
+	}
+
 	abstract public function create( $args, $assoc_args );
 
+	abstract protected function rollback();
+
 }

src/helper/hooks.php

@@ -1,37 +1,47 @@
 <?php
 
+if ( ! class_exists( 'EE' ) ) {
+	return;
+}
+
 use EE\Dispatcher\CommandFactory;
 
 /**
- * Add hook before the invocation of help command to appropriately handle the help for given site-type.
+ * Callback function of `before_invoke:help` hook: Add routing for "ee help site" command before the invocation of help
+ * command.
+ *
+ * @param array $args       Commandline arguments passed to help command.
+ * @param array $assoc_args Associative arguments passed to help command.
  */
-function Before_Help_Command( $args, $assoc_args ) {
-
-	if ( isset( $args[0] ) && 'site' === $args[0] ) {
-		$site_types = Site_Command::get_site_types();
-		if ( isset( $assoc_args['type'] ) ) {
-			$type = $assoc_args['type'];
-		} else {
-			//TODO: get from config.
-			$type = 'html';
-		}
-
-		if ( isset( $site_types[ $type ] ) ) {
-			$callback = $site_types[ $type ];
-
-			$command      = EE::get_root_command();
-			$leaf_command = CommandFactory::create( 'site', $callback, $command );
-			$command->add_subcommand( 'site', $leaf_command );
-		} else {
-			$error = sprintf(
-				"'%s' is not a registered site type of 'ee site --type=%s'. See 'ee help site --type=%s' for available subcommands.",
-				$type,
-				$type,
-				$type
-			);
-			EE::error( $error );
-		}
+function ee_site_help_cmd_routing( $args, $assoc_args ) {
+
+	if ( ( ! isset( $args[0] ) ) || ( 'site' !== $args[0] ) ) {
+		return;
+	}
+
+	$site_types = Site_Command::get_site_types();
+	if ( isset( $assoc_args['type'] ) ) {
+		$type = $assoc_args['type'];
+	} else {
+		$type = 'html';
 	}
+
+	if ( isset( $site_types[ $type ] ) ) {
+		$callback = $site_types[ $type ];
+
+		$command      = EE::get_root_command();
+		$leaf_command = CommandFactory::create( 'site', $callback, $command );
+		$command->add_subcommand( 'site', $leaf_command );
+	} else {
+		$error = sprintf(
+			"'%s' is not a registered site type of 'ee site --type=%s'. See 'ee help site --type=%s' for available subcommands.",
+			$type,
+			$type,
+			$type
+		);
+		EE::error( $error );
+	}
+
 }
 
-EE::add_hook( 'before_invoke:help', 'Before_Help_Command' );
+EE::add_hook( 'before_invoke:help', 'ee_site_help_cmd_routing' );

src/site-type/HTML.php → src/site-type/html.php

@@ -63,15 +63,10 @@ class HTML extends EE_Site_Command {
 
 	public function __construct() {
 
-		$this->level = 0;
-		pcntl_signal( SIGTERM, [ $this, "rollback" ] );
-		pcntl_signal( SIGHUP, [ $this, "rollback" ] );
-		pcntl_signal( SIGUSR1, [ $this, "rollback" ] );
-		pcntl_signal( SIGINT, [ $this, "rollback" ] );
-		$shutdown_handler = new Shutdown_Handler();
-		register_shutdown_function( [ $shutdown_handler, "cleanup" ], [ &$this ] );
+		parent::__construct();
+		$this->level  = 0;
 		$this->docker = \EE::docker();
-		$this->logger = \EE::get_file_logger()->withName( 'site_command' );
+		$this->logger = \EE::get_file_logger()->withName( 'html_type' );
 		$this->fs     = new Filesystem();
 	}
 
@@ -329,7 +324,7 @@ private function catch_clean( $e ) {
 	/**
 	 * Roll back on interrupt.
 	 */
-	private function rollback() {
+	protected function rollback() {
 
 		\EE::warning( 'Exiting gracefully after rolling back. This may take some time.' );
 		if ( $this->level > 0 ) {
@@ -339,19 +334,4 @@ private function rollback() {
 		exit;
 	}
 
-	/**
-	 * Shutdown function to catch and rollback from fatal errors.
-	 */
-	private function shutDownFunction() {
-
-		$error = error_get_last();
-		if ( isset( $error ) && $error['type'] === E_ERROR ) {
-			\EE::warning( 'An Error occurred. Initiating clean-up.' );
-			$this->logger->error( 'Type: ' . $error['type'] );
-			$this->logger->error( 'Message: ' . $error['message'] );
-			$this->logger->error( 'File: ' . $error['file'] );
-			$this->logger->error( 'Line: ' . $error['line'] );
-			$this->rollback();
-		}
-	}
 }