Added command() common helper function to run a command programatically.

Author: lonnieezell

system/CLI/CLI.php

@@ -175,21 +175,30 @@ class CLI
 	 */
 	public static function init()
 	{
-		// Readline is an extension for PHP that makes interactivity with PHP
-		// much more bash-like.
-		// http://www.php.net/manual/en/readline.installation.php
-		static::$readline_support = extension_loaded('readline');
+		if (is_cli())
+		{
+			// Readline is an extension for PHP that makes interactivity with PHP
+			// much more bash-like.
+			// http://www.php.net/manual/en/readline.installation.php
+			static::$readline_support = extension_loaded('readline');
 
-		// clear segments & options to keep testing clean
-		static::$segments = [];
-		static::$options  = [];
+			// clear segments & options to keep testing clean
+			static::$segments = [];
+			static::$options  = [];
 
-		// Check our stream resource for color support
-		static::$isColored = static::hasColorSupport(STDOUT);
+			// Check our stream resource for color support
+			static::$isColored = static::hasColorSupport(STDOUT);
 
-		static::parseCommandLine();
+			static::parseCommandLine();
 
-		static::$initialized = true;
+			static::$initialized = true;
+		}
+		else
+		{
+			// If the command is being called from a controller
+			// we need to define STDOUT ourselves
+			define('STDOUT', 'php://output');
+		}
 	}
 
 	//--------------------------------------------------------------------
@@ -275,7 +284,7 @@ public static function prompt(string $field, $options = null, string $validation
 			$default = $options[0];
 		}
 
-		fwrite(STDOUT, $field . $extra_output . ': ');
+		static::fwrite(STDOUT, $field . $extra_output . ': ');
 
 		// Read the input from keyboard.
 		$input = trim(static::input()) ?: $default;
@@ -340,7 +349,7 @@ public static function print(string $text = '', string $foreground = null, strin
 
 		static::$lastWrite = null;
 
-		fwrite(STDOUT, $text);
+		static::fwrite(STDOUT, $text);
 	}
 
 	/**
@@ -363,7 +372,7 @@ public static function write(string $text = '', string $foreground = null, strin
 			static::$lastWrite = 'write';
 		}
 
-		fwrite(STDOUT, $text . PHP_EOL);
+		static::fwrite(STDOUT, $text . PHP_EOL);
 	}
 
 	//--------------------------------------------------------------------
@@ -386,7 +395,7 @@ public static function error(string $text, string $foreground = 'light_red', str
 			$text = static::color($text, $foreground, $background);
 		}
 
-		fwrite(STDERR, $text . PHP_EOL);
+		static::fwrite(STDERR, $text . PHP_EOL);
 
 		// return STDOUT color support
 		static::$isColored = $stdout;
@@ -421,7 +430,7 @@ public static function wait(int $seconds, bool $countdown = false)
 
 			while ($time > 0)
 			{
-				fwrite(STDOUT, $time . '... ');
+				static::fwrite(STDOUT, $time . '... ');
 				sleep(1);
 				$time --;
 			}
@@ -488,7 +497,7 @@ public static function clearScreen()
 		// can handle CSI sequences. For lower than Win10 we just shove in 40 new lines.
 		static::isWindows() && ! static::streamSupports('sapi_windows_vt100_support', STDOUT)
 			? static::newLine(40)
-			: fwrite(STDOUT, "\033[H\033[2J");
+			: static::fwrite(STDOUT, "\033[H\033[2J");
 	}
 
 	//--------------------------------------------------------------------
@@ -772,7 +781,7 @@ public static function showProgress($thisStep = 1, int $totalSteps = 10)
 		// restore cursor position when progress is continuing.
 		if ($inProgress !== false && $inProgress <= $thisStep)
 		{
-			fwrite(STDOUT, "\033[1A");
+			static::fwrite(STDOUT, "\033[1A");
 		}
 		$inProgress = $thisStep;
 
@@ -786,13 +795,13 @@ public static function showProgress($thisStep = 1, int $totalSteps = 10)
 			$step    = (int) round($percent / 10);
 
 			// Write the progress bar
-			fwrite(STDOUT, "[\033[32m" . str_repeat('#', $step) . str_repeat('.', 10 - $step) . "\033[0m]");
+			static::fwrite(STDOUT, "[\033[32m" . str_repeat('#', $step) . str_repeat('.', 10 - $step) . "\033[0m]");
 			// Textual representation...
-			fwrite(STDOUT, sprintf(' %3d%% Complete', $percent) . PHP_EOL);
+			static::fwrite(STDOUT, sprintf(' %3d%% Complete', $percent) . PHP_EOL);
 		}
 		else
 		{
-			fwrite(STDOUT, "\007");
+			static::fwrite(STDOUT, "\007");
 		}
 	}
 
@@ -1121,6 +1130,28 @@ public static function table(array $tbody, array $thead = [])
 	}
 
 	//--------------------------------------------------------------------
+
+	/**
+	 * While the library is intended for use on CLI commands,
+	 * commands can be called from controllers and elsewhere
+	 * so we need a way to allow them to still work.
+	 *
+	 * For now, just echo the content, but look into a better
+	 * solution down the road.
+	 *
+	 * @param $handle
+	 * @param string $string
+	 */
+	protected static function fwrite($handle, string $string)
+	{
+		if (is_cli())
+		{
+			fwrite($handle, $string);
+			return;
+		}
+
+		echo $string;
+	}
 }
 
 // Ensure the class is initialized. Done outside of code coverage

system/Common.php

@@ -112,6 +112,34 @@ function cache(string $key = null)
 	}
 }
 
+if (! function_exists('command'))
+{
+	/**
+	 * Runs a single command.
+	 * Input expected in a single string as would
+	 * be used on the command line itself:
+	 *
+	 *  > command('migrate:create SomeMigration');
+	 *
+	 * @param string $command
+	 *
+	 * @return false|string
+	 */
+	function command(string $command)
+	{
+		$runner = service('commands');
+
+		$params  = explode(' ', $command);
+		$command = array_shift($params);
+
+		ob_start();
+		$runner->run($command, $params);
+		$output = ob_get_clean();
+
+		return $output;
+	}
+}
+
 if (! function_exists('config'))
 {
 	/**

user_guide_src/source/cli/cli_commands.rst

@@ -37,6 +37,22 @@ for the information it needs to run correctly::
     > php spark migrate:version
     > Version?
 
+Calling Commands
+================
+
+Commands can also be ran from within your own code. This is most often done within a controller for cronjob tasks,
+but they can be used at any time. You do this by using the ``command()`` function. This function is always available.
+
+::
+
+    echo command('migrate:create TestMigration');
+
+The only argument is string that is the command called and any parameters. This appears exactly as you would call
+it from the command line.
+
+All output from the command that is ran is captured when not run from the command line. It is returned from the command
+so that you can choose to display it or not.
+
 ******************
 Using Help Command
 ******************