Greatly simplify Object classes

getgrav · May 11, 2017 · 77c2e47 · 77c2e47
1 parent ec4d451
commit 77c2e47
Show file tree

Hide file tree

Showing 12 changed files with 206 additions and 901 deletions.
diff --git a/system/src/Grav/Framework/Object/AbstractObject.php b/system/src/Grav/Framework/Object/AbstractObject.php
diff --git a/system/src/Grav/Framework/Object/AbstractObjectCollection.php b/system/src/Grav/Framework/Object/AbstractObjectCollection.php
diff --git a/system/src/Grav/Framework/Object/Object.php b/system/src/Grav/Framework/Object/Object.php
@@ -0,0 +1,58 @@
+<?php
+/**
+ * @package    Grav\Framework\Object
+ *
+ * @copyright  Copyright (C) 2014 - 2017 RocketTheme, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Framework\Object;
+
+use RocketTheme\Toolbox\ArrayTraits\ArrayAccessWithGetters;
+use RocketTheme\Toolbox\ArrayTraits\Export;
+
+/**
+ * Object class.
+ *
+ * @package Grav\Framework\Object
+ */
+class Object implements ObjectInterface
+{
+    use ObjectTrait, ArrayAccessWithGetters, Export;
+
+    /**
+     * Properties of the object.
+     * @var array
+     */
+    protected $items;
+
+    /**
+     * @var string
+     */
+    private $key;
+
+    /**
+     * @param array $elements
+     * @param string $key
+     */
+    public function __construct(array $elements = [], $key = null)
+    {
+
+        $this->items = $elements;
+        $this->key = $key !== null ? $key : $this->getKey();
+
+        if ($this->key === null) {
+            throw new \InvalidArgumentException('Object cannot be created without assigning a key');
+        }
+    }
+
+    /**
+     * Implements JsonSerializable interface.
+     *
+     * @return array
+     */
+    public function jsonSerialize()
+    {
+        return ['key' => $this->getKey(), 'object' => $this->toArray()];
+    }
+}
diff --git a/system/src/Grav/Framework/Object/ObjectCollection.php b/system/src/Grav/Framework/Object/ObjectCollection.php
@@ -0,0 +1,50 @@
+<?php
+/**
+ * @package    Grav\Framework\Object
+ *
+ * @copyright  Copyright (C) 2014 - 2017 RocketTheme, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Framework\Object;
+
+use Grav\Framework\Collection\ArrayCollection;
+
+/**
+ * Object Collection
+ * @package Grav\Framework\Object
+ */
+class ObjectCollection extends ArrayCollection implements ObjectCollectionInterface
+{
+    use ObjectCollectionTrait;
+
+    /**
+     * @var string
+     */
+    private $key;
+
+    /**
+     * @param array $elements
+     * @param string $key
+     */
+    public function __construct(array $elements = [], $key = null)
+    {
+        parent::__construct($elements);
+
+        $this->key = $key !== null ? $key : $this->getKey();
+
+        if ($this->key === null) {
+            throw new \InvalidArgumentException('Object cannot be created without assigning a key');
+        }
+    }
+
+    /**
+     * Implements JsonSerializable interface.
+     *
+     * @return array
+     */
+    public function jsonSerialize()
+    {
+        return ['key' => $this->getKey(), 'objects' => $this->toArray()];
+    }
+}
diff --git a/system/src/Grav/Framework/Object/ObjectCollectionInterface.php b/system/src/Grav/Framework/Object/ObjectCollectionInterface.php
@@ -14,7 +14,7 @@
  * ObjectCollection Interface
  * @package Grav\Framework\Collection
  */
-interface ObjectCollectionInterface extends CollectionInterface
+interface ObjectCollectionInterface extends CollectionInterface, ObjectInterface
 {
     /**
      * Create a copy from this collection by cloning all objects in the collection.
@@ -23,6 +23,11 @@ interface ObjectCollectionInterface extends CollectionInterface
      */
     public function copy();
 
+    /**
+     * @return array
+     */
+    public function getObjectKeys();
+
     /**
      * @param string $property      Object property to be fetched.
      * @return array                Values of the property.
@@ -42,4 +47,12 @@ public function setProperty($property, $value);
      * @return array                Return values.
      */
     public function call($name, array $arguments);
+
+    /**
+     * Group items in the collection by a field.
+     *
+     * @param string $property
+     * @return array
+     */
+    public function group($property);
 }