locomotivemtl / charcoal-object

src/Charcoal/Object/HierarchicalTrait.php

Doc Comments +6 added lines, -6 removed lines

@@ -53,7 +53,7 @@ 
      *
      * The object's hierarchy can be rebuilt with {@see self::hierarchy()}.
      *
-     * @return HierarchicalInterface Chainable
+     * @return HierarchicalTrait Chainable
      */
     public function resetHierarchy()
     {
@@ -67,7 +67,7 @@ 
      *
      * @param  mixed $master The object's parent (or master).
      * @throws UnexpectedValueException The current object cannot be its own parent.
-     * @return HierarchicalInterface Chainable
+     * @return HierarchicalTrait Chainable
      */
     public function setMaster($master)
     {
@@ -265,7 +265,7 @@ 
 
     /**
      * @param array $children The children to set.
-     * @return HierarchicalInterface Chainable
+     * @return HierarchicalTrait Chainable
      */
     public function setChildren(array $children)
     {
@@ -279,7 +279,7 @@ 
     /**
      * @param mixed $child The child object (or ident) to add.
      * @throws UnexpectedValueException The current object cannot be its own child.
-     * @return HierarchicalInterface Chainable
+     * @return HierarchicalTrait Chainable
      */
     public function addChild($child)
     {
@@ -332,7 +332,7 @@ 
 
     /**
      * @param mixed $master The master object (or ident) to check against.
-     * @return boolean
+     * @return false|null
      */
     public function recursiveIsChildOf($master)
     {
@@ -467,7 +467,7 @@ 
      * Add an object to the cache store.
      *
      * @param ModelInterface $obj The object to store.
-     * @return HierarchicalInterface Chainable
+     * @return HierarchicalTrait Chainable
      */
     private function addObjectToCache(ModelInterface $obj)
     {

src/Charcoal/Object/ObjectRevision.php

Doc Comments +1 added lines, -1 removed lines

@@ -179,7 +179,7 @@
     }
 
     /**
-     * @param mixed $revTs The revision's timestamp.
+     * @param string $revTs The revision's timestamp.
      * @throws InvalidArgumentException If the timestamp is invalid.
      * @return ObjectRevision Chainable
      */

src/Charcoal/Object/RevisionableTrait.php

Doc Comments +2 added lines, -2 removed lines

@@ -33,7 +33,7 @@ 
 
     /**
      * @param boolean $enabled The (revision) enabled flag.
-     * @return RevisionableInterface Chainable
+     * @return RevisionableTrait Chainable
      */
     public function setRevisionEnabled($enabled)
     {
@@ -66,7 +66,7 @@ 
      *
      * @param  string $className The class name of the object revision model.
      * @throws InvalidArgumentException If the class name is not a string.
-     * @return AbstractPropertyDisplay Chainable
+     * @return RevisionableTrait Chainable
      */
     protected function setObjectRevisionClass($className)
     {

src/Charcoal/Object/RoutableTrait.php

Doc Comments +3 added lines, -3 removed lines

@@ -87,7 +87,7 @@ 
      * Set the object's URL slug pattern.
      *
      * @param  mixed $pattern The slug pattern.
-     * @return RoutableInterface Chainable
+     * @return RoutableTrait Chainable
      */
     public function setSlugPattern($pattern)
     {
@@ -193,7 +193,7 @@ 
      * Set the object's URL slug.
      *
      * @param  mixed $slug The slug.
-     * @return RoutableInterface Chainable
+     * @return RoutableTrait Chainable
      */
     public function setSlug($slug)
     {
@@ -677,7 +677,7 @@ 
      *
      * @param  string $className The class name of the object route model.
      * @throws InvalidArgumentException If the class name is not a string.
-     * @return AbstractPropertyDisplay Chainable
+     * @return RoutableTrait Chainable
      */
     protected function setObjectRouteClass($className)
     {

Spacing +3 added lines, -3 removed lines

@@ -290,7 +290,7 @@ 
         if ($this instanceof ViewableInterface && $this->view() !== null) {
             $route = $this->view()->render($pattern, $this->viewController());
         } else {
-            $route = preg_replace_callback('~\{\{\s*(.*?)\s*\}\}~i', [ $this, 'parseRouteToken' ], $pattern);
+            $route = preg_replace_callback('~\{\{\s*(.*?)\s*\}\}~i', [$this, 'parseRouteToken'], $pattern);
         }
 
         return $this->slugify($route);
@@ -313,7 +313,7 @@ 
         }
 
         $token = trim($token);
-        $method = [ $this, $token ];
+        $method = [$this, $token];
 
         if (is_callable($method)) {
             $value = call_user_func($method);
@@ -426,7 +426,7 @@ 
                     'route_options'       => $data['route_options'],
                     'route_options_ident' => $data['route_options_ident']
                 ]);
-                $oldRoute->update([ 'route_template', 'route_options' ]);
+                $oldRoute->update(['route_template', 'route_options']);
                 continue;
             }
 

src/Charcoal/Object/ObjectSchedule.php

Doc Comments +4 added lines, -4 removed lines

@@ -164,7 +164,7 @@ 
 
     /**
      * @param array|string $data The data diff.
-     * @return ObjectRevision
+     * @return ObjectSchedule
      */
     public function setDataDiff($data)
     {
@@ -179,7 +179,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string
      */
     public function dataDiff()
     {
@@ -259,7 +259,7 @@ 
     /**
      * Set the date/time the item was processed at.
      *
-     * @param  null|string|DateTimeInterface $ts A date/time string or object.
+     * @param  string $ts A date/time string or object.
      * @throws InvalidArgumentException If the date/time is invalid.
      * @return ObjectScheduleInterface Chainable
      */
@@ -308,7 +308,7 @@ 
      *
      * Presets the item as _to-be_ processed and queued now.
      *
-     * @return ObjectScheduleInterface Chainable
+     * @return boolean Chainable
      */
     public function preSave()
     {

src/Charcoal/Object/ObjectRoute.php

Doc Comments +2 added lines, -2 removed lines

@@ -287,7 +287,7 @@ 
     /**
      * Set the route's last creation date.
      *
-     * @param  string|DateTimeInterface|null $time The date/time value.
+     * @param  string $time The date/time value.
      * @throws InvalidArgumentException If the date/time value is invalid.
      * @return self
      */
@@ -323,7 +323,7 @@ 
     /**
      * Set the route's last modification date.
      *
-     * @param  string|DateTimeInterface|null $time The date/time value.
+     * @param  string $time The date/time value.
      * @throws InvalidArgumentException If the date/time value is invalid.
      * @return self
      */

src/Charcoal/Object/HierarchicalCollection.php

Doc Comments +2 added lines, -2 removed lines

@@ -281,7 +281,7 @@ 
     /**
      * @param  integer $page The current page. Start at 0.
      * @throws InvalidArgumentException If the parameter is not numeric or < 0.
-     * @return Pagination (Chainable)
+     * @return HierarchicalCollection (Chainable)
      */
     public function setPage($page)
     {
@@ -314,7 +314,7 @@ 
     /**
      * @param  integer $num The number of results to retrieve, per page.
      * @throws InvalidArgumentException If the parameter is not numeric or < 0.
-     * @return Pagination (Chainable)
+     * @return HierarchicalCollection (Chainable)
      */
     public function setNumPerPage($num)
     {

Spacing +3 added lines, -3 removed lines

@@ -73,7 +73,7 @@ 
             // Repair bad hierarchy.
             if ($object->hasMaster() && $object->master()->id() === $object->id()) {
                 $object->setMaster(0);
-                $object->update([ 'master' ]);
+                $object->update(['master']);
             }
 
             if ($object->hasMaster()) {
@@ -112,7 +112,7 @@ 
                 }
             }
         } else {
-            $start = (( $pageNum - 1 ) * $perPage);
+            $start = (($pageNum - 1) * $perPage);
             $end   = ($start + $perPage);
 
             foreach ($this->objects as $object) {
@@ -225,7 +225,7 @@ 
                 }
             }
         } else {
-            $start = (( $pageNum - 1 ) * $perPage);
+            $start = (($pageNum - 1) * $perPage);
             $end   = ($start + $perPage);
 
             foreach ($childObjects[$parentObj->id()] as $object) {