Object code cleanup

getgrav · Sep 8, 2017 · 6238997 · 6238997
1 parent c0e1e15
commit 6238997
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 50 deletions.
diff --git a/system/src/Grav/Common/GravTrait.php b/system/src/Grav/Common/GravTrait.php
@@ -9,7 +9,7 @@
 namespace Grav\Common;
 
 /**
- * @deprecated in Grav 2.0
+ * @deprecated 2.0
  */
 trait GravTrait
 {

diff --git a/system/src/Grav/Framework/Object/ArrayObject.php b/system/src/Grav/Framework/Object/ArrayObject.php
@@ -9,7 +9,7 @@
 namespace Grav\Framework\Object;
 
 /**
- * Object class.
+ * ArrayObject class.
  *
  * @package Grav\Framework\Object
  */

diff --git a/system/src/Grav/Framework/Object/Object.php b/system/src/Grav/Framework/Object/Object.php
@@ -25,14 +25,14 @@ class Object implements ObjectInterface
      *
      * @example $value = $this->get('this.is.my.nested.variable');
      *
-     * @param string  $name       Dot separated path to the requested value.
+     * @param string  $property   Dot separated path to the requested value.
      * @param mixed   $default    Default value (or null).
      * @param string  $separator  Separator, defaults to '.'
      * @return mixed  Value.
      */
-    public function getProperty($name, $default = null, $separator = '.')
+    public function getProperty($property, $default = null, $separator = '.')
     {
-        $path = explode($separator, $name);
+        $path = explode($separator, $property);
         $offset = array_shift($path);
         $current = $this->__get($offset);
 
@@ -66,14 +66,14 @@ public function getProperty($name, $default = null, $separator = '.')
      *
      * @example $data->set('this.is.my.nested.variable', $value);
      *
-     * @param string  $name       Dot separated path to the requested value.
+     * @param string  $property   Dot separated path to the requested value.
      * @param mixed   $value      New value.
      * @param string  $separator  Separator, defaults to '.'
      * @return $this
      */
-    public function setProperty($name, $value, $separator = '.')
+    public function setProperty($property, $value, $separator = '.')
     {
-        $path = explode($separator, $name);
+        $path = explode($separator, $property);
         $offset = array_shift($path);
 
         // Set simple variable.
@@ -122,16 +122,16 @@ public function setProperty($name, $value, $separator = '.')
      *
      * @example $data->defProperty('this.is.my.nested.variable', $value);
      *
-     * @param string  $name       Dot separated path to the requested value.
+     * @param string  $property   Dot separated path to the requested value.
      * @param mixed   $value      New value.
      * @param string  $separator  Separator, defaults to '.'
      * @return $this
      */
-    public function defProperty($name, $value, $separator = '.')
+    public function defProperty($property, $value, $separator = '.')
     {
         $test = new \stdClass;
-        if ($this->getProperty($name, $test, $separator) === $test) {
-            $this->setProperty($name, $value, $separator);
+        if ($this->getProperty($property, $test, $separator) === $test) {
+            $this->setProperty($property, $value, $separator);
         }
 
         return $this;
@@ -203,20 +203,6 @@ protected function toArray()
         return $this->items;
     }
 
-    /**
-     * Implements JsonSerializable interface.
-     *
-     * @return array
-     */
-    public function jsonSerialize()
-    {
-        return [
-            'key' => $this->getKey(),
-            'type' => $this->getType(true),
-            'object' => $this->toArray()
-        ];
-    }
-
     protected function &getRef($offset, $new = false)
     {
         if ($this->isPropertyDefined($offset)) {

diff --git a/system/src/Grav/Framework/Object/ObjectCollection.php b/system/src/Grav/Framework/Object/ObjectCollection.php
@@ -46,14 +46,4 @@ public function setKey($key)
 
         return $this;
     }
-
-    /**
-     * 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
@@ -41,12 +41,6 @@ public function getObjectKeys();
      */
     public function getProperty($property, $default = null);
 
-    /**
-     * @param string $property  Object property to be updated.
-     * @param string $value     New value.
-     */
-    public function setProperty($property, $value);
-
     /**
      * @param string $name          Method name.
      * @param array  $arguments     List of arguments passed to the function.

diff --git a/system/src/Grav/Framework/Object/ObjectCollectionTrait.php b/system/src/Grav/Framework/Object/ObjectCollectionTrait.php
@@ -24,7 +24,7 @@ trait ObjectCollectionTrait
     public function copy()
     {
         $list = [];
-        foreach ($this as $key => $value) {
+        foreach ($this->getIterator() as $key => $value) {
             $list[$key] = is_object($value) ? clone $value : $value;
         }
 
@@ -54,7 +54,7 @@ public function getProperty($property, $default = null)
         $list = [];
 
         /** @var ObjectInterface $element */
-        foreach ($this as $id => $element) {
+        foreach ($this->getIterator() as $id => $element) {
             $list[$id] = $element->getProperty($property, $default);
         }
 
@@ -69,13 +69,28 @@ public function getProperty($property, $default = null)
     public function setProperty($property, $value)
     {
         /** @var ObjectInterface $element */
-        foreach ($this as $element) {
+        foreach ($this->getIterator() as $element) {
             $element->setProperty($property, $value);
         }
 
         return $this;
     }
 
+    /**
+     * @param string $property  Object property to be updated.
+     * @param string $value     New value.
+     * @return $this
+     */
+    public function defProperty($property, $value)
+    {
+        /** @var ObjectInterface $element */
+        foreach ($this->getIterator() as $element) {
+            $element->defProperty($property, $value);
+        }
+
+        return $this;
+    }
+
     /**
      * @param string $method        Method name.
      * @param array  $arguments     List of arguments passed to the function.
@@ -85,7 +100,7 @@ public function call($method, array $arguments = [])
     {
         $list = [];
 
-        foreach ($this as $id => $element) {
+        foreach ($this->getIterator() as $id => $element) {
             $list[$id] = method_exists($element, $method)
                 ? call_user_func_array([$element, $method], $arguments) : null;
         }
@@ -105,10 +120,15 @@ public function group($property)
         $list = [];
 
         /** @var ObjectInterface $element */
-        foreach ($this as $element) {
+        foreach ($this->getIterator() as $element) {
             $list[(string) $element->getProperty($property)][] = $element;
         }
 
         return $list;
     }
+
+    /**
+     * @return \Traversable
+     */
+    abstract public function getIterator();
 }
diff --git a/system/src/Grav/Framework/Object/ObjectInterface.php b/system/src/Grav/Framework/Object/ObjectInterface.php
@@ -38,8 +38,16 @@ public function getKey();
     public function getProperty($property, $default = null);
 
     /**
-     * @param string $property  Object property to be updated.
-     * @param string $value     New value.
+     * @param string $property      Object property to be updated.
+     * @param string $value         New value.
+     * @return $this
      */
     public function setProperty($property, $value);
+
+    /**
+     * @param string  $property     Object property to be defined.
+     * @param mixed   $value        Default value.
+     * @return $this
+     */
+    public function defProperty($property, $value);
 }
diff --git a/system/src/Grav/Framework/Object/ObjectTrait.php b/system/src/Grav/Framework/Object/ObjectTrait.php
@@ -46,7 +46,7 @@ public function __construct(array $elements = [], $key = null)
      * @param bool $prefix
      * @return string
      */
-    public function getType($prefix = false)
+    public function getType($prefix = true)
     {
         if (static::$type) {
             return ($prefix ? static::$prefix : '') . static::$type;
@@ -64,6 +64,16 @@ public function getKey()
         return $this->key;
     }
 
+    /**
+     * Implements JsonSerializable interface.
+     *
+     * @return array
+     */
+    public function jsonSerialize()
+    {
+        return ['key' => (string) $this, 'type' => $this->getType(), 'elements' => $this->toArray()];
+    }
+
     /**
      * Returns a string representation of this object.
      *