From 22effeac4208fa3b3adda4a41af9c8ea6c00da80 Mon Sep 17 00:00:00 2001
From: Matias Griese <matias@kunena.org>
Date: Thu, 13 Apr 2017 12:04:14 +0300
Subject: [PATCH] Move new Collection/Object classes into Grav\Framework

---
 .../Object/AbstractObjectCollection.php       | 23 -------------
 .../Collection/Collection.php                 | 14 +++++++-
 .../Collection/CollectionInterface.php        | 14 +++++++-
 .../Object/AbstractObject.php                 | 12 +++++--
 .../Object/AbstractObjectCollection.php       | 32 +++++++++++++++++++
 .../Object/AbstractObjectFinder.php           | 15 +++++++--
 .../Object}/ObjectCollectionInterface.php     | 15 ++++++++-
 .../Object}/ObjectCollectionTrait.php         | 19 ++++++++++-
 .../Object/ObjectFinderInterface.php          | 13 +++++++-
 .../Object/ObjectInterface.php                | 13 +++++++-
 .../Object/ObjectStorageTrait.php             | 17 ++++++----
 .../Object/Storage/FilesystemStorage.php      | 13 +++++++-
 .../Object/Storage/StorageInterface.php       | 13 +++++++-
 13 files changed, 172 insertions(+), 41 deletions(-)
 delete mode 100644 system/src/Grav/Common/Object/AbstractObjectCollection.php
 rename system/src/Grav/{Common => Framework}/Collection/Collection.php (70%)
 rename system/src/Grav/{Common => Framework}/Collection/CollectionInterface.php (52%)
 rename system/src/Grav/{Common => Framework}/Object/AbstractObject.php (93%)
 create mode 100644 system/src/Grav/Framework/Object/AbstractObjectCollection.php
 rename system/src/Grav/{Common => Framework}/Object/AbstractObjectFinder.php (95%)
 rename system/src/Grav/{Common/Collection => Framework/Object}/ObjectCollectionInterface.php (71%)
 rename system/src/Grav/{Common/Collection => Framework/Object}/ObjectCollectionTrait.php (81%)
 rename system/src/Grav/{Common => Framework}/Object/ObjectFinderInterface.php (84%)
 rename system/src/Grav/{Common => Framework}/Object/ObjectInterface.php (91%)
 rename system/src/Grav/{Common => Framework}/Object/ObjectStorageTrait.php (96%)
 rename system/src/Grav/{Common => Framework}/Object/Storage/FilesystemStorage.php (90%)
 rename system/src/Grav/{Common => Framework}/Object/Storage/StorageInterface.php (73%)

diff --git a/system/src/Grav/Common/Object/AbstractObjectCollection.php b/system/src/Grav/Common/Object/AbstractObjectCollection.php
deleted file mode 100644
index 4cd61bff3..000000000
--- a/system/src/Grav/Common/Object/AbstractObjectCollection.php
+++ /dev/null
@@ -1,23 +0,0 @@
-<?php
-namespace Grav\Common\Object;
-
-use Grav\Common\Collection\Collection;
-use Grav\Common\Collection\ObjectCollectionInterface;
-use Grav\Common\Collection\ObjectCollectionTrait;
-
-abstract class AbstractObjectCollection extends Collection implements ObjectCollectionInterface
-{
-    use ObjectCollectionTrait, ObjectStorageTrait;
-
-    protected $id;
-
-    public function setId($id)
-    {
-        $this->id = $id;
-    }
-
-    public function getId()
-    {
-        return $this->id;
-    }
-}
diff --git a/system/src/Grav/Common/Collection/Collection.php b/system/src/Grav/Framework/Collection/Collection.php
similarity index 70%
rename from system/src/Grav/Common/Collection/Collection.php
rename to system/src/Grav/Framework/Collection/Collection.php
index 5ee2198f0..ec23e60bc 100644
--- a/system/src/Grav/Common/Collection/Collection.php
+++ b/system/src/Grav/Framework/Collection/Collection.php
@@ -1,8 +1,20 @@
 <?php
-namespace Grav\Common\Collection;
+/**
+ * @package    Grav\Framework\Collection
+ *
+ * @copyright  Copyright (C) 2014 - 2017 RocketTheme, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Framework\Collection;
 
 use Doctrine\Common\Collections\ArrayCollection;
 
+/**
+ * General JSON serializable collection.
+ *
+ * @package Grav\Framework\Collection
+ */
 class Collection extends ArrayCollection implements CollectionInterface
 {
     /**
diff --git a/system/src/Grav/Common/Collection/CollectionInterface.php b/system/src/Grav/Framework/Collection/CollectionInterface.php
similarity index 52%
rename from system/src/Grav/Common/Collection/CollectionInterface.php
rename to system/src/Grav/Framework/Collection/CollectionInterface.php
index 7d3ea9a28..ef46e00ec 100644
--- a/system/src/Grav/Common/Collection/CollectionInterface.php
+++ b/system/src/Grav/Framework/Collection/CollectionInterface.php
@@ -1,8 +1,20 @@
 <?php
-namespace Grav\Common\Collection;
+/**
+ * @package    Grav\Framework\Collection
+ *
+ * @copyright  Copyright (C) 2014 - 2017 RocketTheme, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Framework\Collection;
 
 use Doctrine\Common\Collections\Collection;
 
+/**
+ * Collection Interface.
+ *
+ * @package Grav\Framework\Collection
+ */
 interface CollectionInterface extends Collection, \JsonSerializable
 {
     /**
diff --git a/system/src/Grav/Common/Object/AbstractObject.php b/system/src/Grav/Framework/Object/AbstractObject.php
similarity index 93%
rename from system/src/Grav/Common/Object/AbstractObject.php
rename to system/src/Grav/Framework/Object/AbstractObject.php
index 9a462afbb..8d3b3d180 100644
--- a/system/src/Grav/Common/Object/AbstractObject.php
+++ b/system/src/Grav/Framework/Object/AbstractObject.php
@@ -1,5 +1,12 @@
 <?php
-namespace Grav\Common\Object;
+/**
+ * @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;
@@ -8,6 +15,7 @@ use RocketTheme\Toolbox\ArrayTraits\Export;
  * Abstract base class for stored objects.
  *
  * @property string $id
+ * @package Grav\Framework\Object
  */
 abstract class AbstractObject implements ObjectInterface
 {
@@ -39,7 +47,7 @@ abstract class AbstractObject implements ObjectInterface
     /**
      * @var string
      */
-    static protected $collectionClass = 'Grav\\Common\\Object\\AbstractObjectCollection';
+    static protected $collectionClass = 'Grav\\Framework\\Object\\AbstractObjectCollection';
 
     /**
      * Properties of the object.
diff --git a/system/src/Grav/Framework/Object/AbstractObjectCollection.php b/system/src/Grav/Framework/Object/AbstractObjectCollection.php
new file mode 100644
index 000000000..1878b1b35
--- /dev/null
+++ b/system/src/Grav/Framework/Object/AbstractObjectCollection.php
@@ -0,0 +1,32 @@
+<?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\Collection;
+
+/**
+ * Abstract Object Collection
+ * @package Grav\Framework\Object
+ */
+abstract class AbstractObjectCollection extends Collection implements ObjectCollectionInterface
+{
+    use ObjectCollectionTrait, ObjectStorageTrait;
+
+    protected $id;
+
+    public function setId($id)
+    {
+        $this->id = $id;
+    }
+
+    public function getId()
+    {
+        return $this->id;
+    }
+}
diff --git a/system/src/Grav/Common/Object/AbstractObjectFinder.php b/system/src/Grav/Framework/Object/AbstractObjectFinder.php
similarity index 95%
rename from system/src/Grav/Common/Object/AbstractObjectFinder.php
rename to system/src/Grav/Framework/Object/AbstractObjectFinder.php
index 9c93f12c0..fc638d0d1 100644
--- a/system/src/Grav/Common/Object/AbstractObjectFinder.php
+++ b/system/src/Grav/Framework/Object/AbstractObjectFinder.php
@@ -1,8 +1,19 @@
 <?php
-namespace Grav\Common\Object;
+/**
+ * @package    Grav\Framework\Object
+ *
+ * @copyright  Copyright (C) 2014 - 2017 RocketTheme, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
 
-use Grav\Common\Object\Storage\StorageInterface;
+namespace Grav\Framework\Object;
 
+use Grav\Framework\Object\Storage\StorageInterface;
+
+/**
+ * Abstract Object Finder
+ * @package Grav\Framework\Object
+ */
 abstract class AbstractObjectFinder implements ObjectFinderInterface
 {
     /**
diff --git a/system/src/Grav/Common/Collection/ObjectCollectionInterface.php b/system/src/Grav/Framework/Object/ObjectCollectionInterface.php
similarity index 71%
rename from system/src/Grav/Common/Collection/ObjectCollectionInterface.php
rename to system/src/Grav/Framework/Object/ObjectCollectionInterface.php
index 5da91cd2d..ecacee917 100644
--- a/system/src/Grav/Common/Collection/ObjectCollectionInterface.php
+++ b/system/src/Grav/Framework/Object/ObjectCollectionInterface.php
@@ -1,6 +1,19 @@
 <?php
-namespace Grav\Common\Collection;
+/**
+ * @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\CollectionInterface;
+
+/**
+ * ObjectCollection Interface
+ * @package Grav\Framework\Collection
+ */
 interface ObjectCollectionInterface extends CollectionInterface
 {
     /**
diff --git a/system/src/Grav/Common/Collection/ObjectCollectionTrait.php b/system/src/Grav/Framework/Object/ObjectCollectionTrait.php
similarity index 81%
rename from system/src/Grav/Common/Collection/ObjectCollectionTrait.php
rename to system/src/Grav/Framework/Object/ObjectCollectionTrait.php
index a05b92dc9..51e48061b 100644
--- a/system/src/Grav/Common/Collection/ObjectCollectionTrait.php
+++ b/system/src/Grav/Framework/Object/ObjectCollectionTrait.php
@@ -1,8 +1,25 @@
 <?php
-namespace Grav\Common\Collection;
+/**
+ * @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;
+
+/**
+ * ObjectCollection Trait
+ * @package Grav\Framework\Object
+ */
 trait ObjectCollectionTrait
 {
+    /**
+     * @param array $elements
+     * @return static
+     */
+    abstract public function createFrom(array $elements);
+
     /**
      * Create a copy from this collection by cloning all objects in the collection.
      *
diff --git a/system/src/Grav/Common/Object/ObjectFinderInterface.php b/system/src/Grav/Framework/Object/ObjectFinderInterface.php
similarity index 84%
rename from system/src/Grav/Common/Object/ObjectFinderInterface.php
rename to system/src/Grav/Framework/Object/ObjectFinderInterface.php
index 9bcf267fd..04391719d 100644
--- a/system/src/Grav/Common/Object/ObjectFinderInterface.php
+++ b/system/src/Grav/Framework/Object/ObjectFinderInterface.php
@@ -1,6 +1,17 @@
 <?php
-namespace Grav\Common\Object;
+/**
+ * @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;
+
+/**
+ * Object Finder Interface
+ * @package Grav\Framework\Object
+ */
 interface ObjectFinderInterface
 {
     /**
diff --git a/system/src/Grav/Common/Object/ObjectInterface.php b/system/src/Grav/Framework/Object/ObjectInterface.php
similarity index 91%
rename from system/src/Grav/Common/Object/ObjectInterface.php
rename to system/src/Grav/Framework/Object/ObjectInterface.php
index ed8ab87f6..ac5e29d39 100644
--- a/system/src/Grav/Common/Object/ObjectInterface.php
+++ b/system/src/Grav/Framework/Object/ObjectInterface.php
@@ -1,6 +1,17 @@
 <?php
-namespace Grav\Common\Object;
+/**
+ * @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;
+
+/**
+ * Object Interface
+ * @package Grav\Framework\Object
+ */
 interface ObjectInterface extends \ArrayAccess, \JsonSerializable
 {
     /**
diff --git a/system/src/Grav/Common/Object/ObjectStorageTrait.php b/system/src/Grav/Framework/Object/ObjectStorageTrait.php
similarity index 96%
rename from system/src/Grav/Common/Object/ObjectStorageTrait.php
rename to system/src/Grav/Framework/Object/ObjectStorageTrait.php
index 148ab2933..96ab28f74 100644
--- a/system/src/Grav/Common/Object/ObjectStorageTrait.php
+++ b/system/src/Grav/Framework/Object/ObjectStorageTrait.php
@@ -1,12 +1,20 @@
 <?php
-namespace Grav\Common\Object;
+/**
+ * @package    Grav\Framework\Object
+ *
+ * @copyright  Copyright (C) 2014 - 2017 RocketTheme, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
 
-use Grav\Common\Object\Storage\StorageInterface;
+namespace Grav\Framework\Object;
+
+use Grav\Framework\Object\Storage\StorageInterface;
 
 /**
- * Abstract base class for stored objects.
+ * Trait for implementing stored objects.
  *
  * @property string $id
+ * @package Grav\Framework\Object
  */
 trait ObjectStorageTrait
 {
@@ -358,9 +366,6 @@ trait ObjectStorageTrait
         return $this->getStorageKey();
     }
 
-
-    //abstract public function setStorageKey(array $keys = []);
-
     /**
      * @return StorageInterface
      */
diff --git a/system/src/Grav/Common/Object/Storage/FilesystemStorage.php b/system/src/Grav/Framework/Object/Storage/FilesystemStorage.php
similarity index 90%
rename from system/src/Grav/Common/Object/Storage/FilesystemStorage.php
rename to system/src/Grav/Framework/Object/Storage/FilesystemStorage.php
index a9ee5495c..196be8f7c 100644
--- a/system/src/Grav/Common/Object/Storage/FilesystemStorage.php
+++ b/system/src/Grav/Framework/Object/Storage/FilesystemStorage.php
@@ -1,10 +1,21 @@
 <?php
-namespace Grav\Common\Object\Storage;
+/**
+ * @package    Grav\Framework\Object\Storage
+ *
+ * @copyright  Copyright (C) 2014 - 2017 RocketTheme, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Framework\Object\Storage;
 
 use Grav\Common\Grav;
 use RocketTheme\Toolbox\File\FileInterface;
 use RocketTheme\Toolbox\ResourceLocator\UniformResourceLocator;
 
+/**
+ * FilesystemStorage
+ * @package Grav\Framework\Object\Storage
+ */
 class FilesystemStorage implements StorageInterface
 {
     /**
diff --git a/system/src/Grav/Common/Object/Storage/StorageInterface.php b/system/src/Grav/Framework/Object/Storage/StorageInterface.php
similarity index 73%
rename from system/src/Grav/Common/Object/Storage/StorageInterface.php
rename to system/src/Grav/Framework/Object/Storage/StorageInterface.php
index a13ad396c..a05e38740 100644
--- a/system/src/Grav/Common/Object/Storage/StorageInterface.php
+++ b/system/src/Grav/Framework/Object/Storage/StorageInterface.php
@@ -1,6 +1,17 @@
 <?php
-namespace Grav\Common\Object\Storage;
+/**
+ * @package    Grav\Framework\Object\Storage
+ *
+ * @copyright  Copyright (C) 2014 - 2017 RocketTheme, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
 
+namespace Grav\Framework\Object\Storage;
+
+/**
+ * Interface StorageInterface
+ * @package Grav\Framework\Object\Storage
+ */
 interface StorageInterface
 {
     /**