silverstripe / silverstripe-hybridsessions

code/HybridSessionStore.php

Doc Comments +8 added lines, -5 removed lines

@@ -56,8 +56,8 @@ 
     private $saltedKey;
 
     /**
-     * @param $key a per-site secret string which is used as the base encryption key.
-     * @param $salt a per-session random string which is used as a salt to generate a per-session key
+     * @param string $key a per-site secret string which is used as the base encryption key.
+     * @param string $salt a per-session random string which is used as a salt to generate a per-session key
      *
      * The base encryption key needs to stay secret. If an attacker ever gets it, they can read their session,
      * and even modify & re-sign it.
@@ -82,7 +82,7 @@ 
     /**
      * Encrypt and then sign some cleartext
      *
-     * @param $cleartext - The cleartext to encrypt and sign
+     * @param string $cleartext - The cleartext to encrypt and sign
      * @return string - The encrypted-and-signed message as base64 ASCII.
      */
     public function encrypt($cleartext)
@@ -105,8 +105,8 @@ 
     /**
      * Check the signature on an encrypted-and-signed message, and if valid decrypt the content
      *
-     * @param $data - The encrypted-and-signed message as base64 ASCII
-     * @return bool|string - The decrypted cleartext or false if signature failed
+     * @param string $data - The encrypted-and-signed message as base64 ASCII
+     * @return string|false - The decrypted cleartext or false if signature failed
      */
     public function decrypt($data)
     {
@@ -467,6 +467,9 @@ 
         $this->setKey($this->getKey());
     }
 
+    /**
+     * @param string $key
+     */
     public function setKey($key)
     {
         parent::setKey($key);