php-kitchen / platform

src/Contract/Collection/Base/ArrayBasedCollection.php

Doc Comments +37 added lines

@@ -13,16 +13,32 @@ 
  * @author Dmitry Kolodko <prowwid@gmail.com>
  */
 interface ArrayBasedCollection extends ArrayAccess, Countable, IteratorAggregate, JsonSerializable {
+
+    /**
+     * @return \PHPKitchen\Platform\Collection\Base\ArrayBasedCollection
+     */
     public static function from($data);
 
     ///region ----------------- DATA CLEANING METHODS -----------------
 
+    /**
+     * @return void
+     */
     public function clear(): void;
 
+    /**
+     * @return void
+     */
     public function remove($element): void;
 
+    /**
+     * @return void
+     */
     public function removeAll($element): void;
 
+    /**
+     * @return void
+     */
     public function removeAt($index): void;
 
     ////endregion
@@ -33,10 +49,19 @@ 
 
     public function onEachRecursive(callable $do): bool;
 
+    /**
+     * @return void
+     */
     public function filter(callable $by): void;
 
+    /**
+     * @return void
+     */
     public function map(callable $by): void;
 
+    /**
+     * @return void
+     */
     public function reduce(callable $by): void;
 
     ///endregion
@@ -57,12 +82,24 @@ 
 
     public function lastKeyOf($element);
 
+    /**
+     * @return \PHPKitchen\Platform\Collection\Base\ArrayBasedCollection
+     */
     public function allKeysOf($element);
 
+    /**
+     * @return \PHPKitchen\Platform\Collection\Base\ArrayBasedCollection
+     */
     public function getKeys();
 
+    /**
+     * @return \PHPKitchen\Platform\Collection\Base\ArrayBasedCollection
+     */
     public function getValues();
 
+    /**
+     * @return \PHPKitchen\Platform\Collection\Base\ArrayBasedCollection
+     */
     public function countValues();
 
     public function calculateAverage();

src/Contract/Collection/Collection.php

Doc Comments +7 added lines

@@ -11,8 +11,15 @@
  * @author Dmitry Kolodko <prowwid@gmail.com>
  */
 interface Collection extends Base\ArrayBasedCollection, ValueObject {
+
+    /**
+     * @return void
+     */
     public function add($element);
 
+    /**
+     * @return \PHPKitchen\Platform\Collection\Collection
+     */
     public function chunkKeepingKeysBy(int $size);
 
     public function pushToTheEnd(...$elements): bool;

src/Contract/Collection/Map.php

Doc Comments +10 added lines

@@ -11,11 +11,21 @@
  * @author Dmitry Kolodko <prowwid@gmail.com>
  */
 interface Map extends Base\ArrayBasedCollection, ValueObject {
+
+    /**
+     * @return void
+     */
     public function add(string $key, $element);
 
     public function get(string $key);
 
+    /**
+     * @return void
+     */
     public function keysToLowerCase(): void;
 
+    /**
+     * @return void
+     */
     public function keysToUpperCase(): void;
 }
\ No newline at end of file