locomotivemtl / charcoal-base

src/Charcoal/User/AbstractUser.php

Doc Comments +6 added lines, -6 removed lines

@@ -108,7 +108,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)
     {
@@ -132,7 +132,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)
     {
@@ -230,7 +230,7 @@ 
     }
 
     /**
-     * @param string|DateTimeInterface|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
      */
@@ -259,7 +259,7 @@ 
     }
 
     /**
-     * @return DateTimeInterface|null
+     * @return DateTime|null
      */
     public function lastLoginDate()
     {
@@ -298,7 +298,7 @@ 
     }
 
     /**
-     * @param string|DateTimeInterface|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
      */
@@ -327,7 +327,7 @@ 
     }
 
     /**
-     * @return DateTimeInterface|null
+     * @return DateTime|null
      */
     public function lastPasswordDate()
     {

src/Charcoal/User/Acl/Manager.php

Unused Use Statements -1 removed lines

@@ -13,7 +13,6 @@
 // Dependencies from `zendframework/zend-permissions`
 use Zend\Permissions\Acl\Acl;
 use Zend\Permissions\Acl\Role\GenericRole as Role;
-use Zend\Permissions\Acl\Resource\GenericResource as Resource;
 
 /**
  * Manage ACL roles and permissions from config (arrays) or database.

Spacing +3 added lines, -3 removed lines

@@ -39,7 +39,7 @@ 
      * @param string $resource    The Acl resource (string identifier) to load roles and permissions into.
      * @return void
      */
-    public function loadPermissions(Acl &$acl, array $permissions, $resource = '')
+    public function loadPermissions(Acl & $acl, array $permissions, $resource = '')
     {
         foreach ($permissions as $role => $rolePermissions) {
             $this->addRoleAndPermissions($acl, $role, $rolePermissions, $resource);
@@ -53,7 +53,7 @@ 
      * @param string $resource The Acl resource (string identifier) to load roles and permissions into.
      * @return void
      */
-    public function loadDatabasePermissions(Acl &$acl, PDO $db, $table, $resource = '')
+    public function loadDatabasePermissions(Acl & $acl, PDO $db, $table, $resource = '')
     {
         // Quick-and-dirty sanitization
         $table = preg_replace('/[^A-Za-z0-9 ]/', '', $table);
@@ -90,7 +90,7 @@ 
      * @param string $resource    The Acl resource (string identifier) to add roles and permissions into.
      * @return void
      */
-    private function addRoleAndPermissions(Acl &$acl, $role, array $permissions, $resource)
+    private function addRoleAndPermissions(Acl & $acl, $role, array $permissions, $resource)
     {
         if (!$acl->hasRole($role)) {
             // Add role

src/Charcoal/User/Acl/Role.php

Doc Comments +5 added lines, -5 removed lines

@@ -64,7 +64,7 @@ 
 
     /**
      * @param string $parent Role's parent.
-     * @return AclRole Chainable
+     * @return Role Chainable
      */
     public function setParent($parent)
     {
@@ -83,7 +83,7 @@ 
     /**
      * @param string[]|string|null $allowed The allowed permissions for this role.
      * @throws InvalidArgumentException If the passed arguments is not an array, null, or a comma-separated string.
-     * @return AclRole Chainable
+     * @return Role Chainable
      */
     public function setAllowed($allowed)
     {
@@ -116,7 +116,7 @@ 
     /**
      * @param string[]|string|null $denied The denied permissions for this role.
      * @throws InvalidArgumentException If the passed arguments is not an array, null, or a comma-separated string.
-     * @return AclRole Chainable
+     * @return Role Chainable
      */
     public function setDenied($denied)
     {
@@ -148,7 +148,7 @@ 
 
     /**
      * @param boolean $isSuper The superuser flag.
-     * @return AclRole Chainable
+     * @return Role Chainable
      */
     public function setSuperuser($isSuper)
     {
@@ -166,7 +166,7 @@ 
 
     /**
      * @param integer $position The role's ordering position.
-     * @return AclRole Chainable
+     * @return Role Chainable
      */
     public function setPosition($position)
     {

src/Charcoal/User/AuthToken.php

Doc Comments +11 added lines, -11 removed lines

@@ -101,7 +101,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)
     {
@@ -123,9 +123,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)
     {
@@ -154,9 +154,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)
     {
@@ -177,7 +177,7 @@ 
     }
 
     /**
-     * @return DateTime|null
+     * @return DateTimeInterface
      */
     public function created()
     {
@@ -185,9 +185,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)
     {
@@ -303,7 +303,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)
     {
@@ -313,7 +313,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)
     {
@@ -370,7 +370,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)
     {