locomotivemtl / charcoal-base

src/Charcoal/User/AbstractUser.php

Doc Comments +4 added lines, -4 removed lines

@@ -104,7 +104,7 @@ 
      *
      * @param string $username The username (also the login name).
      * @throws InvalidArgumentException If the username is not a string.
-     * @return User Chainable
+     * @return AbstractUser Chainable
      */
     public function setUsername($username)
     {
@@ -128,7 +128,7 @@ 
     /**
      * @param string $email The user email.
      * @throws InvalidArgumentException If the email is not a string.
-     * @return User Chainable
+     * @return AbstractUser Chainable
      */
     public function setEmail($email)
     {
@@ -195,7 +195,7 @@ 
     }
 
     /**
-     * @param string|DateTime|null $lastLoginDate The last login date.
+     * @param string $lastLoginDate The last login date.
      * @throws InvalidArgumentException If the ts is not a valid date/time.
      * @return AbstractUser Chainable
      */
@@ -263,7 +263,7 @@ 
     }
 
     /**
-     * @param string|DateTime|null $lastPasswordDate The last password date.
+     * @param string $lastPasswordDate The last password date.
      * @throws InvalidArgumentException If the passsword date is not a valid DateTime.
      * @return UserInterface Chainable
      */

src/Charcoal/Object/ObjectRoute.php

Doc Comments +2 added lines, -2 removed lines

@@ -193,7 +193,7 @@ 
     }
 
     /**
-     * @param \DateTime|string|null $creationDate The Creation Date date/time.
+     * @param string $creationDate The Creation Date date/time.
      * @throws InvalidArgumentException If the date/time is invalid.
      * @return ObjectRoute Chainable
      */
@@ -215,7 +215,7 @@ 
         return $this;
     }
     /**
-     * @param \DateTime|string|null $lastModificationDate The Last modification date date/time.
+     * @param string $lastModificationDate The Last modification date date/time.
      * @throws InvalidArgumentException If the date/time is invalid.
      * @return ObjectRoute Chainable
      */

src/Charcoal/Object/UserData.php

Doc Comments +1 added lines, -1 removed lines

@@ -167,7 +167,7 @@
     /**
      * Set when the object was created.
      *
-     * @param  DateTime|string|null $timestamp The timestamp at object's creation. NULL is accepted and instances
+     * @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.
      * @return UserDataInterface Chainable

src/Charcoal/User/AuthToken.php

Doc Comments +10 added lines, -10 removed lines

@@ -99,7 +99,7 @@ 
      *
      * @param string $username The username (also the login name).
      * @throws InvalidArgumentException If the username is not a string.
-     * @return User Chainable
+     * @return AuthToken Chainable
      */
     public function setUsername($username)
     {
@@ -121,9 +121,9 @@ 
     }
 
     /**
-     * @param DateTime|string|null $expiry The date/time at object's creation.
+     * @param string $expiry The date/time at object's creation.
      * @throws InvalidArgumentException If the date/time is invalid.
-     * @return Content Chainable
+     * @return AuthToken Chainable
      */
     public function setExpiry($expiry)
     {
@@ -152,9 +152,9 @@ 
     }
 
     /**
-     * @param DateTime|string|null $created The date/time at object's creation.
+     * @param string $created The date/time at object's creation.
      * @throws InvalidArgumentException If the date/time is invalid.
-     * @return Content Chainable
+     * @return AuthToken Chainable
      */
     public function setCreated($created)
     {
@@ -183,9 +183,9 @@ 
     }
 
     /**
-     * @param DateTime|string|null $lastModified The last modified date/time.
+     * @param string $lastModified The last modified date/time.
      * @throws InvalidArgumentException If the date/time is invalid.
-     * @return Content Chainable
+     * @return AuthToken Chainable
      */
     public function setLastModified($lastModified)
     {
@@ -301,7 +301,7 @@ 
     /**
      * @param mixed  $ident The auth-token identifier.
      * @param string $token The token key to validate against.
-     * @return mixed The user id.
+     * @return string The user id.
      */
     public function getUserId($ident, $token)
     {
@@ -311,7 +311,7 @@ 
     /**
      * @param mixed  $ident The auth-token identifier (username).
      * @param string $token The token to validate against.
-     * @return mixed The user id. An empty string if no token match.
+     * @return string The user id. An empty string if no token match.
      */
     public function getUsernameFromToken($ident, $token)
     {
@@ -371,7 +371,7 @@ 
      * DescribableTrait > create_metadata().
      *
      * @param array $data Optional data to intialize the Metadata object with.
-     * @return MetadataInterface
+     * @return AuthTokenMetadata
      */
     protected function createMetadata(array $data = null)
     {

src/Charcoal/Object/ObjectSchedule.php

Doc Comments +7 added lines, -7 removed lines

@@ -83,7 +83,7 @@ 
      * Set an object model factory.
      *
      * @param FactoryInterface $factory The model factory, to create objects.
-     * @return ObjectContainerInterface Chainable
+     * @return ObjectSchedule Chainable
      */
     public function setModelFactory(FactoryInterface $factory)
     {
@@ -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()
     {
@@ -214,7 +214,7 @@ 
      *
      * @param  null|string|DateTimeInterface $ts A date/time string or object.
      * @throws InvalidArgumentException If the date/time is invalid.
-     * @return QueueItemInterface Chainable
+     * @return ObjectSchedule Chainable
      */
     public function setScheduledDate($ts)
     {
@@ -257,9 +257,9 @@ 
     /**
      * 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 QueueItemInterface Chainable
+     * @return ObjectSchedule Chainable
      */
     public function setProcessedDate($ts)
     {
@@ -304,7 +304,7 @@ 
      *
      * Presets the item as _to-be_ processed and queued now.
      *
-     * @return QueueItemInterface Chainable
+     * @return boolean Chainable
      */
     public function preSave()
     {

src/Charcoal/Object/Content.php

Doc Comments +3 added lines, -3 removed lines

@@ -80,7 +80,7 @@ 
 
     /**
      * @param FactoryInterface $factory The factory used to create models.
-     * @return AdminScript Chainable
+     * @return Content Chainable
      */
     protected function setModelFactory(FactoryInterface $factory)
     {
@@ -143,7 +143,7 @@ 
     }
 
     /**
-     * @param \DateTimeInterface|string|null $created The date/time at object's creation.
+     * @param string $created The date/time at object's creation.
      * @throws InvalidArgumentException If the date/time is invalid.
      * @return Content Chainable
      */
@@ -192,7 +192,7 @@ 
     }
 
     /**
-     * @param \DateTimeInterface|string|null $lastModified The last modified date/time.
+     * @param string $lastModified The last modified date/time.
      * @throws InvalidArgumentException If the date/time is invalid.
      * @return Content Chainable
      */

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/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()
     {
@@ -66,7 +66,7 @@ 
      * Set this object's immediate parent.
      *
      * @param mixed $master The object's parent (or master).
-     * @return HierarchicalInterface Chainable
+     * @return HierarchicalTrait Chainable
      */
     public function setMaster($master)
     {
@@ -253,7 +253,7 @@ 
 
     /**
      * @param array $children The children to set.
-     * @return HierarchicalInterface Chainable
+     * @return HierarchicalTrait Chainable
      */
     public function setChildren(array $children)
     {
@@ -266,7 +266,7 @@ 
 
     /**
      * @param mixed $child The child object (or ident) to add.
-     * @return HierarchicalInterface Chainable
+     * @return HierarchicalTrait Chainable
      */
     public function addChild($child)
     {
@@ -309,7 +309,7 @@ 
 
     /**
      * @param mixed $master The master object (or ident) to check against.
-     * @return boolean
+     * @return false|null
      */
     public function recursiveIsChildOf($master)
     {
@@ -444,7 +444,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/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)
     {