PHPDoc cleanup - clean code \o/

diff --git a/apps/encryption/hooks/userhooks.php b/apps/encryption/hooks/userhooks.php
index 742c7d7580be007a268cfcf108c27fb0fe4cff69..1ec0950d9413dcef62a9d7f1ba51ad2d94d464c9 100644 (file)
--- a/apps/encryption/hooks/userhooks.php
+++ b/apps/encryption/hooks/userhooks.php
@@ -205,8 +205,6 @@ class UserHooks implements IHook {
         * Change a user's encryption passphrase
         *
         * @param array $params keys: uid, password
-        * @param IUserSession $user
-        * @param Util $util
         * @return bool
         */
        public function setPassphrase($params) {

diff --git a/apps/encryption/lib/crypto/crypt.php b/apps/encryption/lib/crypto/crypt.php
index 80878b3ddb2bc1cd296dedf66f63d0f47f7a0cac..c0b737a3daa021b8df1320b77e59f05a5c64ce4a 100644 (file)
--- a/apps/encryption/lib/crypto/crypt.php
+++ b/apps/encryption/lib/crypto/crypt.php
@@ -34,11 +34,10 @@ use OCP\IUserSession;
 
 class Crypt {
 
-       const BLOCKSIZE = 8192;
        const DEFAULT_CIPHER = 'AES-256-CFB';
 
-       const HEADERSTART = 'HBEGIN';
-       const HEADEREND = 'HEND';
+       const HEADER_START = 'HBEGIN';
+       const HEADER_END = 'HEND';
        /**
         * @var ILogger
         */
@@ -64,7 +63,7 @@ class Crypt {
        }
 
        /**
-        *
+        * @return array|bool
         */
        public function createKeyPair() {
 
@@ -121,8 +120,8 @@ class Crypt {
        }
 
        /**
-        * @param $plainContent
-        * @param $passPhrase
+        * @param string $plainContent
+        * @param string $passPhrase
         * @return bool|string
         * @throws GenericEncryptionException
         */
@@ -148,8 +147,8 @@ class Crypt {
        }
 
        /**
-        * @param $plainContent
-        * @param $iv
+        * @param string $plainContent
+        * @param string $iv
         * @param string $passPhrase
         * @param string $cipher
         * @return string
@@ -187,8 +186,8 @@ class Crypt {
        }
 
        /**
-        * @param $encryptedContent
-        * @param $iv
+        * @param string $encryptedContent
+        * @param string $iv
         * @return string
         */
        private function concatIV($encryptedContent, $iv) {
@@ -204,20 +203,20 @@ class Crypt {
        }
 
        /**
-        * @param $recoveryKey
-        * @param $password
+        * @param string $recoveryKey
+        * @param string $password
         * @return bool|string
         */
        public function decryptPrivateKey($recoveryKey, $password) {
 
                $header = $this->parseHeader($recoveryKey);
-               $cipher = $this->getCipher($header);
+               $cipher = $this->getCipher();
 
                // If we found a header we need to remove it from the key we want to decrypt
                if (!empty($header)) {
                        $recoveryKey = substr($recoveryKey,
                                strpos($recoveryKey,
-                                       self::HEADEREND) + strlen(self::HEADERSTART));
+                                       self::HEADER_END) + strlen(self::HEADER_START));
                }
 
                $plainKey = $this->symmetricDecryptFileContent($recoveryKey,
@@ -318,17 +317,17 @@ class Crypt {
        private function parseHeader($data) {
                $result = [];
 
-               if (substr($data, 0, strlen(self::HEADERSTART)) === self::HEADERSTART) {
-                       $endAt = strpos($data, self::HEADEREND);
-                       $header = substr($data, 0, $endAt + strlen(self::HEADEREND));
+               if (substr($data, 0, strlen(self::HEADER_START)) === self::HEADER_START) {
+                       $endAt = strpos($data, self::HEADER_END);
+                       $header = substr($data, 0, $endAt + strlen(self::HEADER_END));
 
                        // +1 not to start with an ':' which would result in empty element at the beginning
                        $exploded = explode(':',
-                               substr($header, strlen(self::HEADERSTART) + 1));
+                               substr($header, strlen(self::HEADER_START) + 1));
 
                        $element = array_shift($exploded);
 
-                       while ($element != self::HEADEREND) {
+                       while ($element != self::HEADER_END) {
                                $result[$element] = array_shift($exploded);
                                $element = array_shift($exploded);
                        }

diff --git a/lib/private/encryption/util.php b/lib/private/encryption/util.php
index 54d587715bf72bce5762aa725c26408b407f7065..6312d8813e332e0915eacf748e2e5f6c0c1d93a1 100644 (file)
--- a/lib/private/encryption/util.php
+++ b/lib/private/encryption/util.php
@@ -57,7 +57,7 @@ class Util {
        /** @var array */
        protected $ocHeaderKeys;
 
-       /** @var Manager */
+       /** @var \OC\User\Manager */
        protected $userManager;
 
        /** @var IConfig */

diff --git a/lib/private/files/storage/wrapper/encryption.php b/lib/private/files/storage/wrapper/encryption.php
index 946e7bfbe404e762e7f4d8360bd542c06752e830..bc0b5c87adc0a103a71670a5ce6478665f186490 100644 (file)
--- a/lib/private/files/storage/wrapper/encryption.php
+++ b/lib/private/files/storage/wrapper/encryption.php
@@ -394,7 +394,7 @@ class Encryption extends Wrapper {
        }
 
        /**
-        * @param string $encryptionModule
+        * @param string $encryptionModuleId
         * @return \OCP\Encryption\Keys\IStorage
         */
        protected function getKeyStorage($encryptionModuleId) {

diff --git a/lib/private/hook.php b/lib/private/hook.php
index 824bb7250778d4ccad0f46a031ae2df0ed2eec20..c4ea1999b09fa1b60df804922dbbb0aa057376e5 100644 (file)
--- a/lib/private/hook.php
+++ b/lib/private/hook.php
@@ -32,38 +32,39 @@ class OC_Hook{
 
        /**
         * connects a function to a hook
-        * @param string $signalclass class name of emitter
-        * @param string $signalname name of signal
-        * @param string $slotclass class name of slot
-        * @param string $slotname name of slot
+        *
+        * @param string $signalClass class name of emitter
+        * @param string $signalName name of signal
+        * @param string|object $slotClass class name of slot
+        * @param string $slotName name of slot
         * @return bool
         *
         * This function makes it very easy to connect to use hooks.
         *
         * TODO: write example
         */
-       static public function connect( $signalclass, $signalname, $slotclass, $slotname ) {
+       static public function connect($signalClass, $signalName, $slotClass, $slotName ) {
                // If we're trying to connect to an emitting class that isn't
                // yet registered, register it
-               if( !array_key_exists( $signalclass, self::$registered )) {
-                       self::$registered[$signalclass] = array();
+               if( !array_key_exists($signalClass, self::$registered )) {
+                       self::$registered[$signalClass] = array();
                }
                // If we're trying to connect to an emitting method that isn't
                // yet registered, register it with the emitting class
-               if( !array_key_exists( $signalname, self::$registered[$signalclass] )) {
-                       self::$registered[$signalclass][$signalname] = array();
+               if( !array_key_exists( $signalName, self::$registered[$signalClass] )) {
+                       self::$registered[$signalClass][$signalName] = array();
                }
 
                // dont connect hooks twice
-               foreach (self::$registered[$signalclass][$signalname] as $hook) {
-                       if ($hook['class'] === $slotclass and $hook['name'] === $slotname) {
+               foreach (self::$registered[$signalClass][$signalName] as $hook) {
+                       if ($hook['class'] === $slotClass and $hook['name'] === $slotName) {
                                return false;
                        }
                }
                // Connect the hook handler to the requested emitter
-               self::$registered[$signalclass][$signalname][] = array(
-                               "class" => $slotclass,
-                               "name" => $slotname
+               self::$registered[$signalClass][$signalName][] = array(
+                               "class" => $slotClass,
+                               "name" => $slotName
                );
 
                // No chance for failure ;-)

diff --git a/lib/public/util.php b/lib/public/util.php
index 37cb1b5448537f181643b21039151fa2cd64c0b4..721bcaadb62f83f925e0643addc163595a5e87b6 100644 (file)
--- a/lib/public/util.php
+++ b/lib/public/util.php
@@ -394,18 +394,19 @@ class Util {
 
        /**
         * connects a function to a hook
-        * @param string $signalclass class name of emitter
-        * @param string $signalname name of signal
-        * @param string $slotclass class name of slot
-        * @param string $slotname name of slot
+        *
+        * @param string $signalClass class name of emitter
+        * @param string $signalName name of signal
+        * @param string|object $slotClass class name of slot
+        * @param string $slotName name of slot
         * @return bool
         *
         * This function makes it very easy to connect to use hooks.
         *
         * TODO: write example
         */
-       static public function connectHook( $signalclass, $signalname, $slotclass, $slotname ) {
-               return(\OC_Hook::connect( $signalclass, $signalname, $slotclass, $slotname ));
+       static public function connectHook($signalClass, $signalName, $slotClass, $slotName ) {
+               return(\OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName ));
        }
 
        /**