KnpLabs / Gaufrette

src/Gaufrette/Adapter/Apc.php

Doc Comments +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
     /**
      * @param  string       $key    - by default ''
      * @param  integer      $format - by default APC_ITER_NONE
-     * @return \APCIterator
+     * @return \Traversable
      *
      */
     protected function getCachedKeysIterator($key = '', $format = APC_ITER_NONE)

src/Gaufrette/Adapter/AwsS3.php

Doc Comments +6 added lines

@@ -272,6 +272,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $key
+     */
     protected function getOptions($key, array $options = array())
     {
         $options['ACL'] = $this->options['acl'];
@@ -287,6 +290,9 @@ 
         return $options;
     }
 
+    /**
+     * @return string
+     */
     protected function computePath($key)
     {
         if (empty($this->options['directory'])) {

src/Gaufrette/Adapter/DoctrineDbal.php

Doc Comments +4 added lines

@@ -152,6 +152,10 @@
         return false;
     }
 
+    /**
+     * @param string $key
+     * @param string $column
+     */
     private function getColumnValue($key, $column)
     {
         $value = $this->connection->fetchColumn(

src/Gaufrette/Adapter/GridFS.php

Doc Comments +3 added lines

@@ -145,6 +145,9 @@
         return isset($this->metadata[$key]) ? $this->metadata[$key] : array();
     }
 
+    /**
+     * @param string $key
+     */
     private function find($key, array $fields = array())
     {
         return $this->gridFS->findOne($key, $fields);

src/Gaufrette/Adapter/MogileFS.php

Doc Comments +3 added lines, -3 removed lines

@@ -252,7 +252,7 @@ 
     /**
      * Makes request to MogileFS tracker
      *
-     * @param cmd Command
+     * @param cmd string
      * @param args Array of arguments
      * @return mixed Array on success, false on failure
      */
@@ -303,7 +303,7 @@ 
     /**
      * Get file location at server from MogileFS tracker
      *
-     * @param key File key
+     * @param key string key
      * @return mixed Array on success, false on failure
      */
     private function getPaths($key)
@@ -318,7 +318,7 @@ 
      * Sends file to MogileFS tracker
      *
      * @param path Save path at server
-     * @param data Data to save
+     * @param data string to save
      * @return boolean
      */
     private function putFile($path, $data)

src/Gaufrette/Adapter/PhpseclibSftp.php

Doc Comments +7 added lines

@@ -187,6 +187,10 @@ 
         $this->initialized = true;
     }
 
+    /**
+     * @param string|null $directory
+     * @param boolean $create
+     */
     protected function ensureDirectoryExists($directory, $create)
     {
         $pwd = $this->sftp->pwd();
@@ -201,6 +205,9 @@ 
         }
     }
 
+    /**
+     * @param string $key
+     */
     protected function computePath($key)
     {
         return $this->directory.'/'.ltrim($key, '/');

src/Gaufrette/Adapter/Zip.php

Doc Comments +1 added lines, -1 removed lines

@@ -136,7 +136,7 @@
      * Returns the stat of a file in the zip archive
      *  (name, index, crc, mtime, compression size, compression method, filesize)
      *
-     * @param $key
+     * @param string $key
      * @return array|bool
      */
     public function getStat($key)

src/Gaufrette/Filesystem.php

Doc Comments +2 added lines, -2 removed lines

@@ -268,7 +268,7 @@ 
     /**
      * Gets a new stream instance of the specified file.
      *
-     * @param $key
+     * @param string $key
      * @return Stream|Stream\InMemoryBuffer
      */
     public function createStream($key)
@@ -283,7 +283,7 @@ 
     /**
      * Creates a new file in a filesystem.
      *
-     * @param $key
+     * @param string $key
      * @return File
      */
     public function createFile($key)

src/Gaufrette/StreamWrapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
 
     /**
      * @param  string $path
-     * @return mixed
+     * @return boolean
      */
     public function unlink($path)
     {