charlesportwoodii / yii2-api-rest-components

api/models/User.php

Doc Comments +1 added lines, -1 removed lines

@@ -224,7 +224,7 @@
     
     /**
      * Provisions TOTP for the account
-     * @return boolean|string
+     * @return false|string
      */
     public function provisionOTP()
     {

filters/auth/HMACSignatureAuth.php

Doc Comments +2 added lines, -1 removed lines

@@ -87,6 +87,7 @@ 
      * @param string $accessToken
      * @param string $salt
      * @param \yii\web\request $request
+     * @param string $ikm
      * @return bool
      */
     private function isHMACSignatureValid($accessToken, $ikm, $salt, $request, $hmac = null)
@@ -152,7 +153,7 @@ 
     
     /**
      * Gets the datetime drift that has occured since the request was sent
-     * @param yii\web\Request $request
+     * @param \yii\web\Request $request
      * @return int
      */
     private function getTimeDrift($request)

api/forms/ResetPassword.php

Doc Comments +2 added lines

@@ -94,6 +94,8 @@
     /**
      * Validates the users OTP code, if they provided
      * @inheritdoc
+     * @param string $attributes
+     * @param string $params
      */
     public function validateOTP($attributes, $params)
     {

components/Queue.php

Doc Comments +2 added lines, -2 removed lines

@@ -22,7 +22,7 @@ 
     /**
      * Adds client connections
      * @param array $clients
-     * @return true
+     * @return boolean
      */
     public function setClients($clients = [])
     {
@@ -35,7 +35,7 @@ 
 
     /**
      * Retrieves the queue
-     * @return Disque\Client
+     * @return Client
      */
     public function get()
     {

api/actions/AuthenticationAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
 
     /**
      * Deauthenticates a user
-     * @return mixed
+     * @return boolean
      */
     public function delete($params)
     {

api/actions/RegisterAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
 {
     /**
      * Handles registration of users
-     * @return mixed
+     * @return boolean
      */
     public function post($params)
     {

api/models/Token.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
      * Generates a new auth and refresh token pair
      * @param int $userId
      * @param bool $pubkey
-     * @return array
+     * @return Token
      */
     public static function generate($userId = null, $pubkey = null)
     {

api/models/TokenKeyPair.php

Doc Comments +3 added lines, -2 removed lines

@@ -48,7 +48,7 @@ 
     }
 
     /**
-     * @return \Sodium\crypto_box_publickey
+     * @return string
      */
     public function getBoxPublicKey()
     {
@@ -56,7 +56,7 @@ 
     }
 
     /**
-     * @return \Sodium\crypto_sign_publickey
+     * @return string
      */
     public function getSignPublicKey()
     {
@@ -86,6 +86,7 @@ 
     /**
      * Generates a new crypt token
      * @param int $type
+     * @param boolean $pubkey
      * @return $array
      */
     public static function generate($type = TokenKeyPair::DEFAULT_TYPE, $pubkey = null)