Updated service namings and docuentation

Author: nowiko

README.md

@@ -5,7 +5,8 @@ Symfony2 Helpers - SFTP bundle
 
 This bundle provide simple interface for transfer files by [SFTP](https://en.wikipedia.org/wiki/SFTP) protocol.
 
-Installation:
+Installation
+==============
 
 1) Install libssh2-php library:
 
@@ -35,5 +36,18 @@ Installation:
              // ... other code
         }
     ```
+Usage
+=======
 
-4) Use service `sftp` for transfering files by SFTP. Details about service usage see here.
+1) Use service `sf2h.sftp` to transfer files over SFTP:
+    
+    ```php
+       $this->get('sf2h.sftp')->copy('/path/to/remoteFile', '/path/to/localFile');
+       // or
+       $this->get('sf2h.sftp')->send('/path/to/localFile', '/path/to/remoteFile');
+    ```
+
+2) From CLI could be used one of the following commands:
+   
+    - `php app(bin)/console sftp:copy` - to copy files from remote server to local machine
+    - `php app(bin)/console sftp:send` - to copy files from local server to remote machine

Resources/config/services.xml

@@ -5,11 +5,11 @@
            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <parameters>
-        <parameter key="sftp.class">SF2Helpers\SFTPBundle\SFTP\SFTP</parameter>
+        <parameter key="sf2h.sftp.class">SF2Helpers\SFTPBundle\SFTP\SFTP</parameter>
     </parameters>
 
     <services>
-        <service id="sftp" class="%sftp.class%" />
+        <service id="sf2h.sftp" class="%sf2h.sftp.class%" />
     </services>
 
 </container>

SFTP/ConnectionInterface.php

@@ -5,12 +5,27 @@
 interface ConnectionInterface
 {
     /**
+     * Establish connection with remote host via username and password
+     *
      * @param $host
      * @param $username
      * @param $password
-     * @return mixed
      */
     public function connect($host, $username, $password);
 
+    /**
+     * Establish connection with remote host via public and private keys
+     *
+     * @param $host
+     * @param $username
+     * @param $pubkeyfile
+     * @param $privkeyfile
+     * @param null $passphrase
+     */
+    public function connectWithKey($host, $username, $pubkeyfile, $privkeyfile, $passphrase = null);
+
+    /**
+     * Implementation of this function should close established connection
+     */
     public function disconnect();
 }

SFTP/ResourceTransferInterface.php

@@ -5,16 +5,28 @@
 interface ResourceTransferInterface
 {
     /**
+     * Copy remote file to local machine
+     *
      * @param $remoteFile
      * @param $localFile
      * @return mixed
      */
     public function copy($remoteFile, $localFile);
 
     /**
+     * Copy file from local machine to remote
+     *
      * @param $localFile
      * @param $remoteFile
      * @return mixed
      */
     public function send($localFile, $remoteFile);
+
+    /**
+     * Return array of files names from remote dir
+     *
+     * @param $remoteDir
+     * @return array
+     */
+    public function getRemoteFilesList($remoteDir);
 }

SFTP/SFTP.php

@@ -19,9 +19,7 @@ class SFTP implements ConnectionInterface, ResourceTransferInterface
     private $sftp;
 
     /**
-     * @param string      $host
-     * @param string      $username
-     * @param string|null $password
+     * @inheritdoc
      */
     public function connect($host, $username, $password = null)
     {
@@ -34,11 +32,7 @@ public function connect($host, $username, $password = null)
     }
 
     /**
-     * @param string      $host
-     * @param string      $username
-     * @param string      $pubkeyfile
-     * @param string      $privkeyfile
-     * @param string|null $passphrase
+     * @inheritdoc
      */
     public function connectWithKey($host, $username, $pubkeyfile, $privkeyfile, $passphrase = null)
     {
@@ -51,9 +45,7 @@ public function connectWithKey($host, $username, $pubkeyfile, $privkeyfile, $pas
     }
 
     /**
-     * @param $remoteFile
-     * @param $localFile
-     * @throws \Exception
+     * @inheritdoc
      */
     public function copy($remoteFile, $localFile)
     {
@@ -66,9 +58,7 @@ public function copy($remoteFile, $localFile)
     }
 
     /**
-     * @param $localFile
-     * @param $remoteFile
-     * @throws \Exception
+     * @inheritdoc
      */
     public function send($localFile, $remoteFile)
     {
@@ -80,10 +70,9 @@ public function send($localFile, $remoteFile)
     }
 
     /**
-     * @param $dir
-     * @return array
+     * @inheritdoc
      */
-    public function getFilesList($dir)
+    public function getRemoteFilesList($dir)
     {
         $handle = opendir("ssh2.sftp://$this->sftp" . $dir);
         $files  = [];
@@ -95,6 +84,9 @@ public function getFilesList($dir)
         return $files;
     }
 
+    /**
+     * @inheritdoc
+     */
     public function disconnect()
     {
         ssh2_exec($this->connection, 'exit');