Add Collection.size function

pierredup · pierredup · commit 1109a4766c50 · 2018-04-09T09:54:25.000+02:00
diff --git a/src/Collection/size.php b/src/Collection/size.php
@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the SolidWorx Lodash-PHP project.
+ *
+ * @author     Pierre du Plessis <open-source@solidworx.co>
+ * @copyright  Copyright (c) 2017
+ */
+
+namespace _;
+
+/**
+ * Gets the size of `collection` by returning its length for array
+ * values or the number of public properties for objects.
+ *
+ * @category Collection
+ *
+ * @param array|object|string $collection The collection to inspect.
+ *
+ * @return int Returns the collection size.
+ * @example
+ *
+ * size([1, 2, 3]);
+ * // => 3
+ *
+ * size(new class { public $a = 1; public $b = 2; private $c = 3; });
+ * // => 2
+ *
+ * size('pebbles');
+ * // => 7
+ */
+function size($collection): int
+{
+    if (\is_string($collection)) {
+        return \strlen($collection);
+    }
+
+    if (\is_array($collection) || $collection instanceof \Countable) {
+        return \count($collection);
+    }
+
+    if ($collection instanceof \Traversable) {
+        return \count(\iterator_to_array($collection));
+    }
+
+    if (\is_object($collection)) {
+        return \count(\get_object_vars($collection));
+    }
+
+    return 0;
+}
diff --git a/tests/Collection/SizeTest.php b/tests/Collection/SizeTest.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the SolidWorx Lodash-PHP project.
+ *
+ * @author     Pierre du Plessis <open-source@solidworx.co>
+ * @copyright  Copyright (c) 2017
+ */
+
+use PHPUnit\Framework\TestCase;
+use function _\size;
+
+class SizeTest extends TestCase
+{
+    public function testSize()
+    {
+        $this->assertSame(3, size([1, 2, 3]));
+        $this->assertSame(2, size(new class
+        {
+            public $a = 1;
+
+            public $b = 2;
+
+            private $c = 3;
+        }));
+
+        $this->assertSame(12, size(new class implements \Countable
+        {
+            public function count() { return 12; }
+        }));
+
+        $this->assertSame(4, size(new \ArrayIterator([1, 2, 3, 4])));
+
+        $this->assertSame(7, size('pebbles'));
+    }
+}
