mattbit / flat

src/Flat/Storage/FilesystemIterator.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
      */
     protected $encoder;
 
+    /**
+     * @param string $path
+     */
     public function __construct(EncoderInterface $encoder, $path)
     {
         $this->encoder = $encoder;

src/Flat/Storage/JsonEncoder.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
         return $document;
     }
 
+    /**
+     * @param DocumentInterface $document
+     */
     public function flatten($document, $prepend = '')
     {
         $results = [];

src/Flat/Collection.php

Doc Comments +6 added lines, -3 removed lines

@@ -59,7 +59,7 @@ 
     /**
      * Remove all the documents from the collection.
      *
-     * @return bool
+     * @return boolean|null
      */
     public function truncate()
     {
@@ -71,7 +71,7 @@ 
      *
      * @param DocumentInterface $document
      *
-     * @return bool
+     * @return string
      */
     public function insert(DocumentInterface $document)
     {
@@ -103,7 +103,7 @@ 
      * @param mixed $criteria
      * @param bool  $multiple
      *
-     * @return int The count of the document deleted.
+     * @return boolean The count of the document deleted.
      */
     public function remove($criteria, $multiple = false)
     {
@@ -130,6 +130,9 @@ 
         return $this->onMatch($criteria);
     }
 
+    /**
+     * @param integer $limit
+     */
     protected function onMatch($criteria, $limit = null)
     {
         $expression = $this->parser->parse($criteria);