degagne / libssh2

src/Sessions/Shell.php

Doc Comments +5 added lines, -6 removed lines

@@ -26,9 +26,9 @@ 
     /**
      * Constructor.
      *
-     * @param  object $configuration  Configuration class object
-     * @param  object $authentication Authentication class object
-     * @return void
+     * @param  Configuration $configuration  Configuration class object
+     * @param  Authentication $authentication Authentication class object
+     * @return string
      */
     public function __construct(Configuration $configuration, Authentication $authentication)
     {
@@ -50,7 +50,7 @@ 
 	/**
      * Returns SSH interactive shell.
      *
-     * @return resouce SSH interactive shell
+     * @return Shell SSH interactive shell
      */
 	final public function shell()
 	{
@@ -88,8 +88,7 @@ 
      * Execute remote command via SSH (shell).
      *
      * @param  string   $command  command being executed
-     * @param  instance $terminal Terminal instance
-     * @return object
+     * @return Shell
      */
     final public function write($command, $returncode = false)
     {

Indentation +56 added lines, -56 removed lines

@@ -15,13 +15,13 @@ 
 class Shell extends Connection
 {
 
-	/**
-	 * SSH interactive shell resource.
-	 *
-	 * @var resource
-	 */
-	private $stream;
-	private $command;
+    /**
+     * SSH interactive shell resource.
+     *
+     * @var resource
+     */
+    private $stream;
+    private $command;
 
     /**
      * Constructor.
@@ -34,57 +34,57 @@ 
     {
         parent::__construct($configuration, $authentication);
 
-		$this->shell();
+        $this->shell();
     }
 	
-	/**
-	 * Destructor.
-	 *
-	 * @return void
-	 */
-	public function __destruct()
-	{
-		fclose($this->stream);
-	}
+    /**
+     * Destructor.
+     *
+     * @return void
+     */
+    public function __destruct()
+    {
+        fclose($this->stream);
+    }
 
-	/**
+    /**
      * Returns SSH interactive shell.
      *
      * @return resouce SSH interactive shell
      */
-	final public function shell()
-	{
-		if (($this->stream = @ssh2_shell($this->connection)) === false)
+    final public function shell()
+    {
+        if (($this->stream = @ssh2_shell($this->connection)) === false)
         {
             throw new \RuntimeException($this->get_error_message());
         }
-		sleep(1);
-		return $this;
-	}
+        sleep(1);
+        return $this;
+    }
 
-	/**
+    /**
      * Retrieves shell command output.
      *
      * @return void
      */
-	final public function output()
-	{
-		$stdout = [];
-		while (!preg_match('/RETURN_CODE:\[([0-9]+)\]/', implode(PHP_EOL, $stdout), $retval))
-		{
-			$buffer = fgets($this->stream);
-			if (!empty($buffer))
-			{
-				$stdout[] = trim($buffer);
-				//print $buffer;
-			}
-		}
-		$stdout = preg_replace('/RETURN_CODE:\[([0-9]+)\]/', '', $stdout);
-		$this->set_output(implode(PHP_EOL, $stdout));
+    final public function output()
+    {
+        $stdout = [];
+        while (!preg_match('/RETURN_CODE:\[([0-9]+)\]/', implode(PHP_EOL, $stdout), $retval))
+        {
+            $buffer = fgets($this->stream);
+            if (!empty($buffer))
+            {
+                $stdout[] = trim($buffer);
+                //print $buffer;
+            }
+        }
+        $stdout = preg_replace('/RETURN_CODE:\[([0-9]+)\]/', '', $stdout);
+        $this->set_output(implode(PHP_EOL, $stdout));
         $this->set_exitstatus($retval[1]);
-	}
+    }
 
-	/**
+    /**
      * Execute remote command via SSH (shell).
      *
      * @param  string   $command  command being executed
@@ -93,20 +93,20 @@ 
      */
     final public function write($command, $returncode = false)
     {
-		$command = ($returncode == false) ? $command : $command . '; echo "RETURN_CODE:[$?]";';
-		$write_count = 0;
-		$string_len = strlen($command . PHP_EOL);
-		while ($write_count < $string_len)
-		{
-			$fwrite_count = fwrite($this->stream, substr($command . PHP_EOL, $write_count), 1024);
-			if ($fwrite_count === false)
-			{
-				throw new \RuntimeException('failed to write command to stream');
-			}
-			$write_count += $fwrite_count;
-		}
-		sleep(1);
-		return $this;
-	}
+        $command = ($returncode == false) ? $command : $command . '; echo "RETURN_CODE:[$?]";';
+        $write_count = 0;
+        $string_len = strlen($command . PHP_EOL);
+        while ($write_count < $string_len)
+        {
+            $fwrite_count = fwrite($this->stream, substr($command . PHP_EOL, $write_count), 1024);
+            if ($fwrite_count === false)
+            {
+                throw new \RuntimeException('failed to write command to stream');
+            }
+            $write_count += $fwrite_count;
+        }
+        sleep(1);
+        return $this;
+    }
 	
 }

Upper-Lower-Casing +4 added lines, -4 removed lines

@@ -54,7 +54,7 @@ 
      */
 	final public function shell()
 	{
-		if (($this->stream = @ssh2_shell($this->connection)) === false)
+		if (($this->stream = @ssh2_shell($this->connection)) === FALSE)
         {
             throw new \RuntimeException($this->get_error_message());
         }
@@ -91,15 +91,15 @@ 
      * @param  instance $terminal Terminal instance
      * @return object
      */
-    final public function write($command, $returncode = false)
+    final public function write($command, $returncode = FALSE)
     {
-		$command = ($returncode == false) ? $command : $command . '; echo "RETURN_CODE:[$?]";';
+		$command = ($returncode == FALSE) ? $command : $command . '; echo "RETURN_CODE:[$?]";';
 		$write_count = 0;
 		$string_len = strlen($command . PHP_EOL);
 		while ($write_count < $string_len)
 		{
 			$fwrite_count = fwrite($this->stream, substr($command . PHP_EOL, $write_count), 1024);
-			if ($fwrite_count === false)
+			if ($fwrite_count === FALSE)
 			{
 				throw new \RuntimeException('failed to write command to stream');
 			}

src/Sessions/SSH.php

Doc Comments +9 added lines, -9 removed lines

@@ -54,9 +54,9 @@ 
     /**
      * Constructor.
      *
-     * @param  instance $configuration  Configuration instance
-     * @param  instance $authentication Authentication instance
-     * @return void
+     * @param  Configuration $configuration  Configuration instance
+     * @param  Authentication $authentication Authentication instance
+     * @return string
      */
     public function __construct(Configuration $configuration, Authentication $authentication)
     {
@@ -66,7 +66,7 @@ 
     /**
      * Set execution mode.
      *
-     * @return object
+     * @return SSH
      */
     final public function set_mode($mode = self::WAIT)
     {
@@ -77,7 +77,7 @@ 
     /**
      * Set filename path.
      *
-     * @return object
+     * @return SSH
      */
     final public function set_filename($filename)
     {
@@ -109,7 +109,7 @@ 
      * Execute remote command via SSH.
      *
      * @param  string   $command  command being executed
-     * @param  instance $terminal Terminal instance
+     * @param  Terminal $terminal Terminal instance
      * @return void
      */
     final public function exec($command, Terminal $terminal = null)
@@ -147,8 +147,8 @@ 
      * Create channel stream.
      *
      * @param  string   $command  command being executed
-     * @param  instance $terminal Terminal instance
-     * @return stream   SSH connection resource stream
+     * @param  Terminal $terminal Terminal instance
+     * @return resource   SSH connection resource stream
      */
     final private function get_stream($command, Terminal $terminal)
     {
@@ -179,7 +179,7 @@ 
      * Executes a command on a remote server.
      *
      * @param  resource $stream SSH resource stream
-     * @return void
+     * @return integer|null
      */
     final private function exec_wait($stream)
     {

Indentation +17 added lines, -17 removed lines

@@ -122,19 +122,19 @@ 
         switch ($this->get_mode())
         {
             case 'execute.wait':
-				$stream = $this->get_stream($command, $terminal);
+                $stream = $this->get_stream($command, $terminal);
                 $this->exec_wait($stream);
                 break;
 
             case 'execute.realtime':
-				$command .= ' 2>&1';
-				$stream = $this->get_stream($command, $terminal);
+                $command .= ' 2>&1';
+                $stream = $this->get_stream($command, $terminal);
                 $this->exec_realtime($stream);
                 break;
 
             case 'execute.file':
-				$command .= ' 2>&1';
-				$stream = $this->get_stream($command, $terminal);
+                $command .= ' 2>&1';
+                $stream = $this->get_stream($command, $terminal);
                 $this->exec_file($stream);
                 break;
 
@@ -159,19 +159,19 @@ 
 
         $command .= '; echo "RETURN_CODE:[$?]"';
         $stream = @ssh2_exec(
-			$this->connection,
-			$command,
-			$terminal->get_pty(),
-			$terminal->get_env(),
-			$terminal->get_width(),
-			$terminal->get_height()
-		);
+            $this->connection,
+            $command,
+            $terminal->get_pty(),
+            $terminal->get_env(),
+            $terminal->get_width(),
+            $terminal->get_height()
+        );
         
-		if ($stream === false)
+        if ($stream === false)
         {
             throw new \RuntimeException($this->get_error_message());
         }
-		stream_set_blocking($stream, true);
+        stream_set_blocking($stream, true);
         return $stream;
     }
 
@@ -217,13 +217,13 @@ 
      */
     final private function exec_realtime($stream)
     {
-		while ($buffer = fgets($stream))
+        while ($buffer = fgets($stream))
         {
             if (!preg_match('/RETURN_CODE:\[([0-9]+)\]/', $buffer, $retval))
             {
-				print $buffer;
+                print $buffer;
             }
-			flush();
+            flush();
         }
         fclose($stream);
         $this->set_exitstatus($retval[1]);

Braces +1 added lines, -1 removed lines

@@ -218,7 +218,7 @@
     final private function exec_realtime($stream)
     {
 		while ($buffer = fgets($stream))
-        {
+		{
             if (!preg_match('/RETURN_CODE:\[([0-9]+)\]/', $buffer, $retval))
             {
 				print $buffer;

Upper-Lower-Casing +8 added lines, -8 removed lines

@@ -42,14 +42,14 @@ 
      *
      * @var string
      */
-    public $mode = null;
+    public $mode = NULL;
 
     /**
      * Filename path.
      *
      * @var string
      */
-    public $filename = null;
+    public $filename = NULL;
 
     /**
      * Constructor.
@@ -92,7 +92,7 @@ 
      */
     final public function get_mode()
     {
-        return ($this->mode === null) ? self::WAIT : $this->mode;
+        return ($this->mode === NULL) ? self::WAIT : $this->mode;
     }
 
     /**
@@ -112,7 +112,7 @@ 
      * @param  instance $terminal Terminal instance
      * @return void
      */
-    final public function exec($command, Terminal $terminal = null)
+    final public function exec($command, Terminal $terminal = NULL)
     {
         if (!$terminal instanceof Terminal)
         {
@@ -167,11 +167,11 @@ 
 			$terminal->get_height()
 		);
         
-		if ($stream === false)
+		if ($stream === FALSE)
         {
             throw new \RuntimeException($this->get_error_message());
         }
-		stream_set_blocking($stream, true);
+		stream_set_blocking($stream, TRUE);
         return $stream;
     }
 
@@ -191,7 +191,7 @@ 
         do
         {
             sleep(1);
-            if ($out === false || $err === false)
+            if ($out === FALSE || $err === FALSE)
             {
                 $stderr .= 'STDOUT and/or STDERR stream(s) closed unexpectedly.';
                 return 1;
@@ -237,7 +237,7 @@ 
      */
     final private function exec_file($stream)
     {
-        if ($this->get_filename() === null)
+        if ($this->get_filename() === NULL)
         {
             throw new \RuntimeException('A valid filename path must be provided.');
         }

src/ConsoleOutput.php

Indentation +7 added lines, -7 removed lines

@@ -56,18 +56,18 @@ 
     /**
      * Set STDOUT output stream.
      *
-	 * @param  mixed $stdout standard output
+     * @param  mixed $stdout standard output
      * @return object
      */
     final public function set_output($stdout)
     {
-		$this->stdout = $stdout;
+        $this->stdout = $stdout;
     }
 
     /**
      * Set STDERR output stream.
      *
-	 * @param  string $stderr standard error
+     * @param  string $stderr standard error
      * @return object
      */
     final public function set_error($stderr)
@@ -78,7 +78,7 @@ 
     /**
      * Set exit status code.
      *
-	 * @param  int $exitstatus exit status code
+     * @param  int $exitstatus exit status code
      * @return object
      */
     final public function set_exitstatus($exitstatus)
@@ -93,7 +93,7 @@ 
      */
     final public function get_output()
     {
-		return $this->stdout;
+        return $this->stdout;
     }
 
     /**
@@ -103,7 +103,7 @@ 
      */
     final public function get_error()
     {
-		return $this->stderr;
+        return $this->stderr;
     }
 
     /**
@@ -113,7 +113,7 @@ 
      */
     final public function get_exitstatus()
     {
-		return $this->exitstatus;
+        return $this->exitstatus;
     }
     
     /**

Upper-Lower-Casing +3 added lines, -3 removed lines

@@ -37,21 +37,21 @@
      *
      * @var string
      */
-    protected $error_message = null;
+    protected $error_message = NULL;
     
     /**
      * Last known error line number.
      *
      * @var int
      */
-    protected $error_line_no = null;
+    protected $error_line_no = NULL;
     
     /**
      * Last known error filename.
      *
      * @var string
      */
-    protected $error_file = null;
+    protected $error_file = NULL;
 
     /**
      * Set STDOUT output stream.

src/Terminal.php

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
      *
      * @var string
      */
-    private $pty = null;
+    private $pty = NULL;
 
     /**
      * Environmental variables (associative array).