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)
     {

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/ObjectSchedule.php

Doc Comments +1 added lines, -1 removed lines

@@ -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
      */

src/Charcoal/Object/UserData.php

Doc Comments +1 added lines, -1 removed lines

@@ -195,7 +195,7 @@
     /**
      * Set when the object was created.
      *
-     * @param  DateTimeInterface|string|null $timestamp The timestamp at object's creation.
+     * @param  string $timestamp The timestamp at object's creation.
      *     NULL is accepted and instances of DateTimeInterface are recommended;
      *     any other value will be converted (if possible) into one.
      * @throws InvalidArgumentException If the timestamp is invalid.