From 2a6a9a8cefcf68f48d95e124db0c1b7edc9fe356 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= <jfd@butonic.de>
Date: Thu, 6 Feb 2014 16:30:58 +0100
Subject: [PATCH] polish documentation based on scrutinizer patches
---
apps/files_encryption/hooks/hooks.php | 4 +-
apps/files_encryption/lib/crypt.php | 18 ++++-----
apps/files_encryption/lib/helper.php | 8 ++--
apps/files_encryption/lib/keymanager.php | 6 ++-
apps/files_encryption/lib/session.php | 2 +-
apps/files_encryption/lib/util.php | 5 ++-
apps/files_encryption/tests/crypt.php | 2 +-
apps/files_encryption/tests/keymanager.php | 4 ++
apps/files_encryption/tests/util.php | 2 +-
apps/files_external/lib/amazons3.php | 3 ++
apps/files_external/lib/config.php | 8 +++-
apps/files_external/lib/dropbox.php | 5 ++-
apps/files_external/lib/google.php | 2 +-
apps/files_external/lib/irods.php | 1 +
apps/files_external/lib/sftp.php | 6 +++
apps/files_external/lib/streamwrapper.php | 11 ++++++
apps/files_external/lib/swift.php | 6 +++
apps/files_external/lib/webdav.php | 9 +++++
apps/files_sharing/lib/cache.php | 3 ++
apps/files_sharing/lib/permissions.php | 4 ++
apps/files_sharing/lib/sharedstorage.php | 1 +
apps/files_sharing/tests/watcher.php | 1 +
apps/files_trashbin/lib/trashbin.php | 33 +++++++++++------
apps/files_versions/lib/versions.php | 4 +-
apps/files_versions/tests/versions.php | 3 ++
apps/user_ldap/lib/access.php | 37 +++++++++++++++----
apps/user_ldap/lib/configuration.php | 5 ++-
apps/user_ldap/lib/connection.php | 8 +++-
apps/user_ldap/lib/ildapwrapper.php | 18 ++++-----
apps/user_ldap/lib/ldap.php | 9 +++--
apps/user_ldap/lib/proxy.php | 11 +++++-
apps/user_ldap/lib/wizard.php | 17 ++++++---
apps/user_ldap/user_ldap.php | 6 +--
core/lostpassword/controller.php | 8 ++++
lib/base.php | 2 +-
lib/private/activitymanager.php | 1 -
lib/private/api.php | 3 ++
lib/private/app.php | 11 ++++--
lib/private/appconfig.php | 7 +++-
.../dependencyinjection/dicontainer.php | 2 +-
lib/private/appframework/http.php | 2 +-
.../appframework/http/redirectresponse.php | 2 +-
lib/private/appframework/http/request.php | 2 +-
.../middleware/middlewaredispatcher.php | 2 +-
.../middleware/security/securityexception.php | 1 -
.../routing/routeactionhandler.php | 4 ++
.../appframework/routing/routeconfig.php | 1 -
.../appframework/utility/simplecontainer.php | 2 +-
lib/private/archive.php | 5 ++-
lib/private/archive/tar.php | 4 +-
lib/private/archive/zip.php | 9 ++++-
lib/private/arrayparser.php | 24 ++++++++++++
lib/private/backgroundjob.php | 4 +-
lib/private/backgroundjob/joblist.php | 4 +-
lib/private/cache/file.php | 9 +++++
lib/private/cache/fileglobal.php | 7 ++++
lib/private/connector/sabre/file.php | 3 ++
lib/private/connector/sabre/node.php | 5 +--
lib/private/connector/sabre/principal.php | 2 +-
lib/private/connector/sabre/quotaplugin.php | 1 -
lib/private/connector/sabre/server.php | 1 +
lib/private/davclient.php | 1 +
lib/private/db.php | 10 ++---
lib/private/db/connection.php | 2 +-
lib/private/db/connectionwrapper.php | 4 +-
lib/private/db/mdb2schemamanager.php | 2 +-
lib/private/db/mdb2schemawriter.php | 5 ++-
lib/private/db/statementwrapper.php | 3 ++
lib/private/defaults.php | 3 ++
lib/private/filechunking.php | 10 ++++-
lib/private/fileproxy.php | 12 ++++++
lib/private/files.php | 11 +++++-
lib/private/files/cache/backgroundwatcher.php | 3 ++
lib/private/files/cache/cache.php | 2 +-
lib/private/files/cache/homecache.php | 3 ++
lib/private/files/cache/legacy.php | 5 ++-
lib/private/files/cache/storage.php | 6 +++
lib/private/files/cache/updater.php | 2 +-
lib/private/files/filesystem.php | 6 +++
lib/private/files/mapper.php | 18 +++++++--
lib/private/files/mount/manager.php | 2 +-
lib/private/files/node/node.php | 1 +
lib/private/files/node/root.php | 4 +-
lib/private/files/storage/common.php | 10 +++++
lib/private/files/storage/loader.php | 4 ++
lib/private/files/storage/local.php | 9 +++++
lib/private/files/storage/mappedlocal.php | 13 +++++++
lib/private/files/storage/wrapper/quota.php | 3 ++
lib/private/files/stream/close.php | 3 ++
lib/private/files/stream/dir.php | 3 ++
lib/private/files/utils/scanner.php | 3 ++
lib/private/files/view.php | 8 +++-
lib/private/hooks/emitter.php | 2 +
lib/private/image.php | 11 +++---
lib/private/installer.php | 6 ++-
lib/private/json.php | 1 +
lib/private/l10n.php | 3 ++
lib/private/l10n/string.php | 3 ++
lib/private/mail.php | 2 +-
lib/private/memcache/factory.php | 2 +-
lib/private/migrate.php | 10 ++---
lib/private/migration/content.php | 14 ++++---
lib/private/ocs.php | 10 ++++-
lib/private/ocsclient.php | 4 ++
lib/private/preview.php | 10 +++--
lib/private/preview/provider.php | 2 +-
lib/private/request.php | 4 ++
lib/private/response.php | 6 +--
lib/private/search.php | 1 -
lib/private/search/result.php | 1 +
lib/private/session/memory.php | 2 +-
lib/private/tags.php | 11 +++---
lib/private/template.php | 7 +++-
lib/private/template/base.php | 16 +++++++-
lib/private/template/functions.php | 5 ++-
lib/private/template/resourcelocator.php | 8 ++++
lib/private/template/templatefilelocator.php | 6 +++
lib/private/templatelayout.php | 4 ++
lib/private/user.php | 7 ++--
lib/private/user/database.php | 2 +-
lib/private/user/dummy.php | 2 +-
lib/private/user/http.php | 2 +-
lib/private/user/interface.php | 2 +
lib/private/user/manager.php | 4 +-
lib/private/user/session.php | 2 +-
lib/private/util.php | 9 ++++-
lib/public/activity/imanager.php | 1 +
lib/public/app.php | 7 ++--
lib/public/appframework/http/response.php | 2 +-
lib/public/appframework/iapi.php | 4 ++
lib/public/appframework/iappcontainer.php | 4 +-
lib/public/backgroundjob.php | 12 +++---
lib/public/config.php | 2 +-
lib/public/contacts/imanager.php | 8 +++-
lib/public/db.php | 8 ++--
lib/public/files.php | 1 +
lib/public/files/file.php | 1 +
lib/public/files/node.php | 2 +
lib/public/files/storage.php | 1 +
lib/public/iavatar.php | 2 +-
lib/public/iconfig.php | 3 ++
lib/public/il10n.php | 4 +-
lib/public/inavigationmanager.php | 2 +
lib/public/irequest.php | 5 +++
lib/public/itags.php | 2 +-
lib/public/iusersession.php | 1 +
lib/public/json.php | 2 +-
lib/public/share.php | 31 ++++++++++------
lib/public/template.php | 15 ++++----
lib/public/user.php | 6 ++-
150 files changed, 649 insertions(+), 219 deletions(-)
diff --git a/apps/files_encryption/hooks/hooks.php b/apps/files_encryption/hooks/hooks.php
index 4c4b3f2040f..d599665644b 100644
--- a/apps/files_encryption/hooks/hooks.php
+++ b/apps/files_encryption/hooks/hooks.php
@@ -635,7 +635,7 @@ class Hooks {
/**
* @brief if the file was really deleted we remove the encryption keys
* @param array $params
- * @return boolean
+ * @return boolean|null
*/
public static function postDelete($params) {
@@ -675,7 +675,7 @@ class Hooks {
/**
* @brief remember the file which should be deleted and it's owner
* @param array $params
- * @return boolean
+ * @return boolean|null
*/
public static function preDelete($params) {
$path = $params[\OC\Files\Filesystem::signal_param_path];
diff --git a/apps/files_encryption/lib/crypt.php b/apps/files_encryption/lib/crypt.php
index 9155d238c77..caca13acece 100755
--- a/apps/files_encryption/lib/crypt.php
+++ b/apps/files_encryption/lib/crypt.php
@@ -182,6 +182,7 @@ class Crypt {
* @param $data
* @param string $relPath The path of the file, relative to user/data;
* e.g. filename or /Docs/filename, NOT admin/files/filename
+ * @param boolean $isCatFileContent
* @return boolean
*/
public static function isLegacyEncryptedContent($isCatFileContent, $relPath) {
@@ -209,8 +210,8 @@ class Crypt {
/**
* @brief Symmetrically encrypt a string
- * @param $plainContent
- * @param $iv
+ * @param string $plainContent
+ * @param string $iv
* @param string $passphrase
* @return string encrypted file content
*/
@@ -229,9 +230,9 @@ class Crypt {
/**
* @brief Symmetrically decrypt a string
- * @param $encryptedContent
- * @param $iv
- * @param $passphrase
+ * @param string $encryptedContent
+ * @param string $iv
+ * @param string $passphrase
* @throws \Exception
* @return string decrypted file content
*/
@@ -292,8 +293,7 @@ class Crypt {
* @brief Symmetrically encrypts a string and returns keyfile content
* @param string $plainContent content to be encrypted in keyfile
* @param string $passphrase
- * @return bool|string
- * @return string encrypted content combined with IV
+ * @return false|string encrypted content combined with IV
* @note IV need not be specified, as it will be stored in the returned keyfile
* and remain accessible therein.
*/
@@ -326,7 +326,7 @@ class Crypt {
* @param $keyfileContent
* @param string $passphrase
* @throws \Exception
- * @return bool|string
+ * @return string|false
* @internal param string $source
* @internal param string $target
* @internal param string $key the decryption key
@@ -438,7 +438,7 @@ class Crypt {
* @param $encryptedContent
* @param $shareKey
* @param $privateKey
- * @return bool
+ * @return false|string
* @internal param string $plainContent content to be encrypted
* @returns string $plainContent decrypted string
* @note symmetricDecryptFileContent() can be used to decrypt files created using this method
diff --git a/apps/files_encryption/lib/helper.php b/apps/files_encryption/lib/helper.php
index bb06a57c714..0ab32020d69 100755
--- a/apps/files_encryption/lib/helper.php
+++ b/apps/files_encryption/lib/helper.php
@@ -103,7 +103,7 @@ class Helper {
* @brief enable recovery
*
* @param $recoveryKeyId
- * @param $recoveryPassword
+ * @param string $recoveryPassword
* @internal param \OCA\Encryption\Util $util
* @internal param string $password
* @return bool
@@ -209,7 +209,7 @@ class Helper {
/**
* @brief disable recovery
*
- * @param $recoveryPassword
+ * @param string $recoveryPassword
* @return bool
*/
public static function adminDisableRecovery($recoveryPassword) {
@@ -344,6 +344,7 @@ class Helper {
/**
* @brief redirect to a error page
+ * @param Session $session
*/
public static function redirectToErrorPage($session, $errorCode = null) {
@@ -423,6 +424,7 @@ class Helper {
/**
* @brief glob uses different pattern than regular expressions, escape glob pattern only
* @param unescaped path
+ * @param string $path
* @return escaped path
*/
public static function escapeGlobPattern($path) {
@@ -441,7 +443,7 @@ class Helper {
/**
* @brief get the path of the original file
* @param string $tmpFile path of the tmp file
- * @return mixed path of the original file or false
+ * @return string|false path of the original file or false
*/
public static function getPathFromTmpFile($tmpFile) {
if (isset(self::$tmpFileMapping[$tmpFile])) {
diff --git a/apps/files_encryption/lib/keymanager.php b/apps/files_encryption/lib/keymanager.php
index 7abc565f609..cb9f5e64af3 100755
--- a/apps/files_encryption/lib/keymanager.php
+++ b/apps/files_encryption/lib/keymanager.php
@@ -170,7 +170,7 @@ class Keymanager {
* @brief retrieve keyfile for an encrypted file
* @param \OC_FilesystemView $view
* @param \OCA\Encryption\Util $util
- * @param $filePath
+ * @param string|false $filePath
* @internal param \OCA\Encryption\file $string name
* @return string file key or false
* @note The keyfile returned is asymmetrically encrypted. Decryption
@@ -513,6 +513,8 @@ class Keymanager {
/**
* @brief Make preparations to vars and filesystem for saving a keyfile
+ * @param string|boolean $path
+ * @param string $basePath
*/
public static function keySetPreparation(\OC_FilesystemView $view, $path, $basePath, $userId) {
@@ -542,7 +544,7 @@ class Keymanager {
/**
* @brief extract filename from share key name
* @param string $shareKey (filename.userid.sharekey)
- * @return mixed filename or false
+ * @return string|false filename or false
*/
protected static function getFilenameFromShareKey($shareKey) {
$parts = explode('.', $shareKey);
diff --git a/apps/files_encryption/lib/session.php b/apps/files_encryption/lib/session.php
index 25f2198181f..ca36fa6e6d5 100644
--- a/apps/files_encryption/lib/session.php
+++ b/apps/files_encryption/lib/session.php
@@ -195,7 +195,7 @@ class Session {
/**
* @brief Sets user legacy key to session
- * @param $legacyKey
+ * @param string $legacyKey
* @return bool
*/
public function setLegacyKey($legacyKey) {
diff --git a/apps/files_encryption/lib/util.php b/apps/files_encryption/lib/util.php
index ae3e2a2e15a..47f020ed29c 100644
--- a/apps/files_encryption/lib/util.php
+++ b/apps/files_encryption/lib/util.php
@@ -563,7 +563,7 @@ class Util {
/**
- * @param $path
+ * @param string $path
* @return bool
*/
public function isSharedPath($path) {
@@ -1031,7 +1031,7 @@ class Util {
* @brief Decrypt a keyfile
* @param string $filePath
* @param string $privateKey
- * @return bool|string
+ * @return false|string
*/
private function decryptKeyfile($filePath, $privateKey) {
@@ -1110,6 +1110,7 @@ class Util {
/**
* @brief Find, sanitise and format users sharing a file
* @note This wraps other methods into a portable bundle
+ * @param boolean $sharingEnabled
*/
public function getSharingUsersArray($sharingEnabled, $filePath, $currentUserId = false) {
diff --git a/apps/files_encryption/tests/crypt.php b/apps/files_encryption/tests/crypt.php
index 388980ad4fd..123943ea26a 100755
--- a/apps/files_encryption/tests/crypt.php
+++ b/apps/files_encryption/tests/crypt.php
@@ -661,7 +661,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase {
/**
* @brief encryption using legacy blowfish method
- * @param $data string data to encrypt
+ * @param string $data data to encrypt
* @param $passwd string password
* @return string
*/
diff --git a/apps/files_encryption/tests/keymanager.php b/apps/files_encryption/tests/keymanager.php
index 6f32c50743c..0caf12e91a3 100644
--- a/apps/files_encryption/tests/keymanager.php
+++ b/apps/files_encryption/tests/keymanager.php
@@ -250,6 +250,10 @@ class Test_Encryption_Keymanager extends \PHPUnit_Framework_TestCase {
* dummy class to access protected methods of \OCA\Encryption\Keymanager for testing
*/
class TestProtectedKeymanagerMethods extends \OCA\Encryption\Keymanager {
+
+ /**
+ * @param string $sharekey
+ */
public static function testGetFilenameFromShareKey($sharekey) {
return self::getFilenameFromShareKey($sharekey);
}
diff --git a/apps/files_encryption/tests/util.php b/apps/files_encryption/tests/util.php
index 97e3c518dac..9eaff79d850 100755
--- a/apps/files_encryption/tests/util.php
+++ b/apps/files_encryption/tests/util.php
@@ -461,7 +461,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase {
* helper function to set migration status to the right value
* to be able to test the migration path
*
- * @param $status needed migration status for test
+ * @param integer $status needed migration status for test
* @param $user for which user the status should be set
* @return boolean
*/
diff --git a/apps/files_external/lib/amazons3.php b/apps/files_external/lib/amazons3.php
index 00baacd488c..06ccd5d16fa 100644
--- a/apps/files_external/lib/amazons3.php
+++ b/apps/files_external/lib/amazons3.php
@@ -54,6 +54,9 @@ class AmazonS3 extends \OC\Files\Storage\Common {
*/
private $timeout = 15;
+ /**
+ * @param string $path
+ */
private function normalizePath($path) {
$path = trim($path, '/');
diff --git a/apps/files_external/lib/config.php b/apps/files_external/lib/config.php
index 01d588b3721..76b8b5fa9fb 100755
--- a/apps/files_external/lib/config.php
+++ b/apps/files_external/lib/config.php
@@ -35,7 +35,7 @@ class OC_Mount_Config {
* If the configuration parameter is a boolean, add a '!' to the beginning of the value
* If the configuration parameter is optional, add a '&' to the beginning of the value
* If the configuration parameter is hidden, add a '#' to the beginning of the value
- * @return array
+ * @return string
*/
public static function getBackends() {
@@ -269,6 +269,10 @@ class OC_Mount_Config {
* @param string MOUNT_TYPE_GROUP | MOUNT_TYPE_USER
* @param string User or group to apply mount to
* @param bool Personal or system mount point i.e. is this being called from the personal or admin page
+ * @param string $mountPoint
+ * @param string $class
+ * @param string $mountType
+ * @param string $applicable
* @return bool
*/
public static function addMountPoint($mountPoint,
@@ -344,6 +348,7 @@ class OC_Mount_Config {
/**
* Read the mount points in the config file into an array
* @param bool Personal or system config file
+ * @param boolean $isPersonal
* @return array
*/
private static function readData($isPersonal) {
@@ -374,6 +379,7 @@ class OC_Mount_Config {
* Write the mount points to the config file
* @param bool Personal or system config file
* @param array Mount points
+ * @param boolean $isPersonal
*/
private static function writeData($isPersonal, $data) {
if ($isPersonal) {
diff --git a/apps/files_external/lib/dropbox.php b/apps/files_external/lib/dropbox.php
index f7d8d98cf03..0214e18020c 100755
--- a/apps/files_external/lib/dropbox.php
+++ b/apps/files_external/lib/dropbox.php
@@ -50,6 +50,9 @@ class Dropbox extends \OC\Files\Storage\Common {
}
}
+ /**
+ * @param string $path
+ */
private function deleteMetaData($path) {
$path = $this->root.$path;
if (isset($this->metaData[$path])) {
@@ -61,7 +64,7 @@ class Dropbox extends \OC\Files\Storage\Common {
/**
* @brief Returns the path's metadata
- * @param $path path for which to return the metadata
+ * @param string $path path for which to return the metadata
* @param $list if true, also return the directory's contents
* @return directory contents if $list is true, file metadata if $list is
* false, null if the file doesn't exist or "false" if the operation failed
diff --git a/apps/files_external/lib/google.php b/apps/files_external/lib/google.php
index 426caf008ec..436469236ba 100644
--- a/apps/files_external/lib/google.php
+++ b/apps/files_external/lib/google.php
@@ -67,7 +67,7 @@ class Google extends \OC\Files\Storage\Common {
/**
* Get the Google_DriveFile object for the specified path
* @param string $path
- * @return Google_DriveFile
+ * @return Google_DriveFile|false
*/
private function getDriveFile($path) {
// Remove leading and trailing slashes
diff --git a/apps/files_external/lib/irods.php b/apps/files_external/lib/irods.php
index 6d4f66e856e..7a7e900fbf0 100644
--- a/apps/files_external/lib/irods.php
+++ b/apps/files_external/lib/irods.php
@@ -134,6 +134,7 @@ class iRODS extends \OC\Files\Storage\StreamWrapper{
/**
* get the best guess for the modification time of an iRODS collection
+ * @param string $path
*/
private function collectionMTime($path) {
$dh = $this->opendir($path);
diff --git a/apps/files_external/lib/sftp.php b/apps/files_external/lib/sftp.php
index cd8a0e78864..a0816e2870d 100644
--- a/apps/files_external/lib/sftp.php
+++ b/apps/files_external/lib/sftp.php
@@ -75,6 +75,9 @@ class SFTP extends \OC\Files\Storage\Common {
return 'sftp::' . $this->user . '@' . $this->host . '/' . $this->root;
}
+ /**
+ * @param string $path
+ */
private function absPath($path) {
return $this->root . $this->cleanPath($path);
}
@@ -277,6 +280,9 @@ class SFTP extends \OC\Files\Storage\Common {
}
}
+ /**
+ * @param string $path
+ */
public function constructUrl($path) {
$url = 'sftp://'.$this->user.':'.$this->password.'@'.$this->host.$this->root.$path;
return $url;
diff --git a/apps/files_external/lib/streamwrapper.php b/apps/files_external/lib/streamwrapper.php
index e484325e2fb..3e3dc3e3af5 100644
--- a/apps/files_external/lib/streamwrapper.php
+++ b/apps/files_external/lib/streamwrapper.php
@@ -9,6 +9,10 @@
namespace OC\Files\Storage;
abstract class StreamWrapper extends Common {
+
+ /**
+ * @return string|null
+ */
abstract public function constructUrl($path);
public function mkdir($path) {
@@ -76,10 +80,17 @@ abstract class StreamWrapper extends Common {
}
}
+ /**
+ * @param string $path
+ * @param string $target
+ */
public function getFile($path, $target) {
return copy($this->constructUrl($path), $target);
}
+ /**
+ * @param string $target
+ */
public function uploadFile($path, $target) {
return copy($path, $this->constructUrl($target));
}
diff --git a/apps/files_external/lib/swift.php b/apps/files_external/lib/swift.php
index b615d24ce76..7a56fcfc8b7 100644
--- a/apps/files_external/lib/swift.php
+++ b/apps/files_external/lib/swift.php
@@ -52,6 +52,9 @@ class Swift extends \OC\Files\Storage\Common {
*/
private static $tmpFiles = array();
+ /**
+ * @param string $path
+ */
private function normalizePath($path) {
$path = trim($path, '/');
@@ -62,6 +65,9 @@ class Swift extends \OC\Files\Storage\Common {
return $path;
}
+ /**
+ * @param string $path
+ */
private function doesObjectExist($path) {
try {
$object = $this->container->DataObject($path);
diff --git a/apps/files_external/lib/webdav.php b/apps/files_external/lib/webdav.php
index f6f4cb16e87..c64b2d8b73a 100644
--- a/apps/files_external/lib/webdav.php
+++ b/apps/files_external/lib/webdav.php
@@ -247,6 +247,10 @@ class DAV extends \OC\Files\Storage\Common{
return true;
}
+ /**
+ * @param string $path
+ * @param string $target
+ */
public function getFile($path, $target) {
$this->init();
$source=$this->fopen($path, 'r');
@@ -338,6 +342,11 @@ class DAV extends \OC\Files\Storage\Common{
return substr($path, 1);
}
+ /**
+ * @param string $method
+ * @param string $path
+ * @param integer $expected
+ */
private function simpleResponse($method, $path, $body, $expected) {
$path=$this->cleanPath($path);
try {
diff --git a/apps/files_sharing/lib/cache.php b/apps/files_sharing/lib/cache.php
index 86e324409fe..cf89f3ea629 100644
--- a/apps/files_sharing/lib/cache.php
+++ b/apps/files_sharing/lib/cache.php
@@ -32,6 +32,9 @@ class Shared_Cache extends Cache {
private $storage;
private $files = array();
+ /**
+ * @param \OC\Files\Storage\Shared $storage
+ */
public function __construct($storage) {
$this->storage = $storage;
}
diff --git a/apps/files_sharing/lib/permissions.php b/apps/files_sharing/lib/permissions.php
index 1dc53428a7f..31b7ac361ae 100644
--- a/apps/files_sharing/lib/permissions.php
+++ b/apps/files_sharing/lib/permissions.php
@@ -42,6 +42,10 @@ class Shared_Permissions extends Permissions {
}
}
+ /**
+ * @param integer $fileId
+ * @param string $user
+ */
private function getFile($fileId, $user) {
if ($fileId == -1) {
return \OCP\PERMISSION_READ;
diff --git a/apps/files_sharing/lib/sharedstorage.php b/apps/files_sharing/lib/sharedstorage.php
index afe5dffdebd..ebd16f081ba 100644
--- a/apps/files_sharing/lib/sharedstorage.php
+++ b/apps/files_sharing/lib/sharedstorage.php
@@ -64,6 +64,7 @@ class Shared extends \OC\Files\Storage\Common {
/**
* @brief Get the source file path for a shared file
* @param string Shared target file path
+ * @param string $target
* @return string source file path or false if not found
*/
public function getSourcePath($target) {
diff --git a/apps/files_sharing/tests/watcher.php b/apps/files_sharing/tests/watcher.php
index 1a9a54cbcf8..5ab716e829f 100644
--- a/apps/files_sharing/tests/watcher.php
+++ b/apps/files_sharing/tests/watcher.php
@@ -145,6 +145,7 @@ class Test_Files_Sharing_Watcher extends Test_Files_Sharing_Base {
/**
* Returns the sizes of the path and its parent dirs in a hash
* where the key is the path and the value is the size.
+ * @param string $path
*/
function getOwnerDirSizes($path) {
$result = array();
diff --git a/apps/files_trashbin/lib/trashbin.php b/apps/files_trashbin/lib/trashbin.php
index 7544980e071..6d2d3f08112 100644
--- a/apps/files_trashbin/lib/trashbin.php
+++ b/apps/files_trashbin/lib/trashbin.php
@@ -61,6 +61,11 @@ class Trashbin {
}
+ /**
+ * @param string $owner
+ * @param integer $timestamp
+ * @param string $type
+ */
private static function copyFilesToOwner($sourcePath, $owner, $ownerPath, $timestamp, $type, $mime) {
self::setUpTrash($owner);
@@ -169,7 +174,7 @@ class Trashbin {
*
* @param $file_path path to original file
* @param $filename of deleted file
- * @param $timestamp when the file was deleted
+ * @param integer $timestamp when the file was deleted
*
* @return size of stored versions
*/
@@ -214,7 +219,7 @@ class Trashbin {
*
* @param $file_path path to original file
* @param $filename of deleted file
- * @param $timestamp when the file was deleted
+ * @param integer $timestamp when the file was deleted
*
* @return size of encryption keys
*/
@@ -406,7 +411,7 @@ class Trashbin {
* @param \OC\Files\View $view file view
* @param $file complete path to file
* @param $filename name of file once it was deleted
- * @param $uniqueFilename new file name to restore the file without overwriting existing files
+ * @param string $uniqueFilename new file name to restore the file without overwriting existing files
* @param $location location if file
* @param $timestamp deleteion time
*
@@ -460,7 +465,7 @@ class Trashbin {
* @param \OC\Files\View $view
* @param $file complete path to file
* @param $filename name of file
- * @param $uniqueFilename new file name to restore the file without overwriting existing files
+ * @param string $uniqueFilename new file name to restore the file without overwriting existing files
* @param $location location of file
* @param $timestamp deleteion time
*
@@ -621,6 +626,9 @@ class Trashbin {
return $size;
}
+ /**
+ * @param \OC\Files\View $view
+ */
private static function deleteVersions($view, $file, $filename, $timestamp) {
$size = 0;
if (\OCP\App::isEnabled('files_versions')) {
@@ -643,6 +651,9 @@ class Trashbin {
return $size;
}
+ /**
+ * @param \OC\Files\View $view
+ */
private static function deleteEncryptionKeys($view, $file, $filename, $timestamp) {
$size = 0;
if (\OCP\App::isEnabled('files_encryption')) {
@@ -713,7 +724,7 @@ class Trashbin {
/**
* calculate remaining free space for trash bin
*
- * @param $trashbinSize current size of the trash bin
+ * @param integer $trashbinSize current size of the trash bin
* @return available free space for trash bin
*/
private static function calculateFreeSpace($trashbinSize) {
@@ -826,9 +837,9 @@ class Trashbin {
/**
* recursive copy to copy a whole directory
*
- * @param $source source path, relative to the users files directory
- * @param $destination destination path relative to the users root directoy
- * @param $view file view for the users root directory
+ * @param string $source source path, relative to the users files directory
+ * @param string $destination destination path relative to the users root directoy
+ * @param \OC\Files\View $view file view for the users root directory
*/
private static function copy_recursive($source, $destination, $view) {
$size = 0;
@@ -887,7 +898,7 @@ class Trashbin {
* find unique extension for restored file if a file with the same name already exists
* @param $location where the file should be restored
* @param $filename name of the file
- * @param $view filesystem view relative to users root directory
+ * @param \OC\Files\View $view filesystem view relative to users root directory
* @return string with unique extension
*/
private static function getUniqueFilename($location, $filename, $view) {
@@ -916,8 +927,8 @@ class Trashbin {
/**
* @brief get the size from a given root folder
- * @param $view file view on the root folder
- * @return size of the folder
+ * @param \OC\Files\View $view file view on the root folder
+ * @return integer size of the folder
*/
private static function calculateSize($view) {
$root = \OCP\Config::getSystemValue('datadirectory') . $view->getAbsolutePath('');
diff --git a/apps/files_versions/lib/versions.php b/apps/files_versions/lib/versions.php
index 328ed4305f4..6eb39d21cf3 100644
--- a/apps/files_versions/lib/versions.php
+++ b/apps/files_versions/lib/versions.php
@@ -372,7 +372,7 @@ class Storage {
/**
* @brief returns all stored file versions from a given user
- * @param $uid id to the user
+ * @param string $uid id of the user
* @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
*/
private static function getAllVersions($uid) {
@@ -420,7 +420,7 @@ class Storage {
/**
* @brief get list of files we want to expire
- * @param int $currentTime timestamp of current time
+ * @param integer $currentTime timestamp of current time
* @param array $versions list of versions
* @return array containing the list of to deleted versions and the size of them
*/
diff --git a/apps/files_versions/tests/versions.php b/apps/files_versions/tests/versions.php
index 25490aa1a04..9f15b86d981 100644
--- a/apps/files_versions/tests/versions.php
+++ b/apps/files_versions/tests/versions.php
@@ -181,6 +181,9 @@ class Test_Files_Versioning extends \PHPUnit_Framework_TestCase {
// extend the original class to make it possible to test protected methods
class VersionStorageToTest extends \OCA\Files_Versions\Storage {
+ /**
+ * @param integer $time
+ */
public function callProtectedGetExpireList($time, $versions) {
return self::getExpireList($time, $versions);
diff --git a/apps/user_ldap/lib/access.php b/apps/user_ldap/lib/access.php
index 72f9c740921..579aedeefc3 100644
--- a/apps/user_ldap/lib/access.php
+++ b/apps/user_ldap/lib/access.php
@@ -107,8 +107,8 @@ class Access extends LDAPUtility {
/**
* @brief checks wether the given attribute`s valua is probably a DN
- * @param $attr the attribute in question
- * @return if so true, otherwise false
+ * @param string $attr the attribute in question
+ * @return boolean if so true, otherwise false
*/
private function resemblesDN($attr) {
$resemblingAttributes = array(
@@ -175,7 +175,7 @@ class Access extends LDAPUtility {
/**
* @brief returns the LDAP DN for the given internal ownCloud name of the group
- * @param $name the ownCloud name in question
+ * @param string $name the ownCloud name in question
* @returns string with the LDAP DN on success, otherwise false
*
* returns the LDAP DN for the given internal ownCloud name of the group
@@ -211,7 +211,7 @@ class Access extends LDAPUtility {
/**
* @brief returns the LDAP DN for the given internal ownCloud name
* @param $name the ownCloud name in question
- * @param $isUser is it a user? otherwise group
+ * @param boolean $isUser is it a user? otherwise group
* @returns string with the LDAP DN on success, otherwise false
*
* returns the LDAP DN for the given internal ownCloud name
@@ -417,6 +417,9 @@ class Access extends LDAPUtility {
}
+ /**
+ * @param boolean $isUsers
+ */
private function ldap2ownCloudNames($ldapObjects, $isUsers) {
if($isUsers) {
$nameAttribute = $this->connection->ldapUserDisplayName;
@@ -509,7 +512,7 @@ class Access extends LDAPUtility {
/**
* @brief creates a unique name for internal ownCloud use.
* @param $name the display name of the object
- * @param $isUser boolean, whether name should be created for a user (true) or a group (false)
+ * @param boolean $isUser whether name should be created for a user (true) or a group (false)
* @returns string with with the name to use in ownCloud or false if unsuccessful
*/
private function createAltInternalOwnCloudName($name, $isUser) {
@@ -545,6 +548,9 @@ class Access extends LDAPUtility {
return $this->mappedComponents(true);
}
+ /**
+ * @param boolean $isUsers
+ */
private function mappedComponents($isUsers) {
$table = $this->getMapTable($isUsers);
@@ -601,14 +607,26 @@ class Access extends LDAPUtility {
return true;
}
+ /**
+ * @param integer $limit
+ * @param integer $offset
+ */
public function fetchListOfUsers($filter, $attr, $limit = null, $offset = null) {
return $this->fetchList($this->searchUsers($filter, $attr, $limit, $offset), (count($attr) > 1));
}
+ /**
+ * @param string $filter
+ * @param integer $limit
+ * @param integer $offset
+ */
public function fetchListOfGroups($filter, $attr, $limit = null, $offset = null) {
return $this->fetchList($this->searchGroups($filter, $attr, $limit, $offset), (count($attr) > 1));
}
+ /**
+ * @param boolean $manyAttributes
+ */
private function fetchList($list, $manyAttributes) {
if(is_array($list)) {
if($manyAttributes) {
@@ -634,6 +652,9 @@ class Access extends LDAPUtility {
return $this->search($filter, $this->connection->ldapBaseUsers, $attr, $limit, $offset);
}
+ /**
+ * @param string $filter
+ */
public function countUsers($filter, $attr = array('dn'), $limit = null, $offset = null) {
return $this->count($filter, $this->connection->ldapBaseGroups, $attr, $limit, $offset);
}
@@ -702,7 +723,7 @@ class Access extends LDAPUtility {
* @param $limit maximum results to be counted
* @param $offset a starting point
* @param $pagedSearchOK whether a paged search has been executed
- * @param $skipHandling required for paged search when cookies to
+ * @param boolean $skipHandling required for paged search when cookies to
* prior results need to be gained
* @returns array with the search result as first value and pagedSearchOK as
* second | false if not successful
@@ -920,7 +941,7 @@ class Access extends LDAPUtility {
/**
* @brief combines the input filters with given operator
* @param $filters array, the filters to connect
- * @param $operator either & or |
+ * @param string $operator either & or |
* @returns the combined filter
*
* Combines Filter arguments with AND
@@ -1173,7 +1194,7 @@ class Access extends LDAPUtility {
/**
* @brief check wether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search.
- * @return true on success, null or false otherwise
+ * @return boolean|null true on success, null or false otherwise
*/
public function getPagedSearchResultState() {
$result = $this->pagedSearchedSuccessful;
diff --git a/apps/user_ldap/lib/configuration.php b/apps/user_ldap/lib/configuration.php
index 93f044e3152..954d0501fad 100644
--- a/apps/user_ldap/lib/configuration.php
+++ b/apps/user_ldap/lib/configuration.php
@@ -78,6 +78,9 @@ class Configuration {
'lastJpegPhotoLookup' => null,
);
+ /**
+ * @param string $configPrefix
+ */
public function __construct($configPrefix, $autoread = true) {
$this->configPrefix = $configPrefix;
if($autoread) {
@@ -106,7 +109,7 @@ class Configuration {
* @param $config array that holds the config parameters in an associated
* array
* @param &$applied optional; array where the set fields will be given to
- * @return null
+ * @return false|null
*/
public function setConfiguration($config, &$applied = null) {
if(!is_array($config)) {
diff --git a/apps/user_ldap/lib/connection.php b/apps/user_ldap/lib/connection.php
index 7fbabda7106..19870550163 100644
--- a/apps/user_ldap/lib/connection.php
+++ b/apps/user_ldap/lib/connection.php
@@ -140,6 +140,9 @@ class Connection extends LDAPUtility {
return $prefix.md5($key);
}
+ /**
+ * @param string $key
+ */
public function getFromCache($key) {
if(!$this->configured) {
$this->readConfiguration();
@@ -167,6 +170,9 @@ class Connection extends LDAPUtility {
return $this->cache->hasKey($key);
}
+ /**
+ * @param string $key
+ */
public function writeToCache($key, $value) {
if(!$this->configured) {
$this->readConfiguration();
@@ -201,7 +207,7 @@ class Connection extends LDAPUtility {
* @brief set LDAP configuration with values delivered by an array, not read from configuration
* @param $config array that holds the config parameters in an associated array
* @param &$setParameters optional; array where the set fields will be given to
- * @return true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
+ * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
*/
public function setConfiguration($config, &$setParameters = null) {
if(is_null($setParameters)) {
diff --git a/apps/user_ldap/lib/ildapwrapper.php b/apps/user_ldap/lib/ildapwrapper.php
index 20587cba7db..3cda2aac7a5 100644
--- a/apps/user_ldap/lib/ildapwrapper.php
+++ b/apps/user_ldap/lib/ildapwrapper.php
@@ -29,7 +29,7 @@ interface ILDAPWrapper {
/**
* @brief Bind to LDAP directory
- * @param $link LDAP link resource
+ * @param resource $link LDAP link resource
* @param $dn an RDN to log in with
* @param $password the password
* @return true on success, false otherwise
@@ -50,7 +50,7 @@ interface ILDAPWrapper {
* @brief Send LDAP pagination control
* @param $link LDAP link resource
* @param $pagesize number of results per page
- * @param $isCritical Indicates whether the pagination is critical of not.
+ * @param boolean $isCritical Indicates whether the pagination is critical of not.
* @param $cookie structure sent by LDAP server
* @return true on success, false otherwise
*/
@@ -61,7 +61,7 @@ interface ILDAPWrapper {
* @param $link LDAP link resource
* @param $result LDAP result resource
* @param $cookie structure sent by LDAP server
- * @return true on success, false otherwise
+ * @return boolean on success, false otherwise
*
* Corresponds to ldap_control_paged_result_response
*/
@@ -124,7 +124,7 @@ interface ILDAPWrapper {
/**
* @brief Return next result id
* @param $link LDAP link resource
- * @param $result LDAP entry result resource
+ * @param resource $result LDAP entry result resource
* @return an LDAP search result resource
* */
public function nextEntry($link, $result);
@@ -153,7 +153,7 @@ interface ILDAPWrapper {
* @brief Sets the value of the specified option to be $value
* @param $link LDAP link resource
* @param $option a defined LDAP Server option
- * @param $value the new value for the option
+ * @param integer $value the new value for the option
* @return true on success, false otherwise
*/
public function setOption($link, $option, $value);
@@ -175,7 +175,7 @@ interface ILDAPWrapper {
/**
* @brief Unbind from LDAP directory
- * @param $link LDAP link resource
+ * @param resource $link LDAP link resource
* @return true on success, false otherwise
*/
public function unbind($link);
@@ -184,20 +184,20 @@ interface ILDAPWrapper {
/**
* @brief Checks whether the server supports LDAP
- * @return true if it the case, false otherwise
+ * @return boolean if it the case, false otherwise
* */
public function areLDAPFunctionsAvailable();
/**
* @brief Checks whether PHP supports LDAP Paged Results
- * @return true if it the case, false otherwise
+ * @return boolean if it the case, false otherwise
* */
public function hasPagedResultSupport();
/**
* @brief Checks whether the submitted parameter is a resource
* @param $resource the resource variable to check
- * @return true if it is a resource, false otherwise
+ * @return boolean if it is a resource, false otherwise
*/
public function isResource($resource);
diff --git a/apps/user_ldap/lib/ldap.php b/apps/user_ldap/lib/ldap.php
index dda8533c41f..ffd97ab83f9 100644
--- a/apps/user_ldap/lib/ldap.php
+++ b/apps/user_ldap/lib/ldap.php
@@ -108,7 +108,7 @@ class LDAP implements ILDAPWrapper {
/**
* @brief Checks whether the server supports LDAP
- * @return true if it the case, false otherwise
+ * @return boolean if it the case, false otherwise
* */
public function areLDAPFunctionsAvailable() {
return function_exists('ldap_connect');
@@ -116,7 +116,7 @@ class LDAP implements ILDAPWrapper {
/**
* @brief Checks whether PHP supports LDAP Paged Results
- * @return true if it the case, false otherwise
+ * @return boolean if it the case, false otherwise
* */
public function hasPagedResultSupport() {
$hasSupport = function_exists('ldap_control_paged_result')
@@ -127,7 +127,7 @@ class LDAP implements ILDAPWrapper {
/**
* @brief Checks whether the submitted parameter is a resource
* @param $resource the resource variable to check
- * @return true if it is a resource, false otherwise
+ * @return boolean if it is a resource, false otherwise
*/
public function isResource($resource) {
return is_resource($resource);
@@ -144,6 +144,9 @@ class LDAP implements ILDAPWrapper {
}
}
+ /**
+ * @param string $functionName
+ */
private function preFunctionCall($functionName, $args) {
$this->curFunc = $functionName;
$this->curArgs = $args;
diff --git a/apps/user_ldap/lib/proxy.php b/apps/user_ldap/lib/proxy.php
index 30e1875901c..b68910ff97f 100644
--- a/apps/user_ldap/lib/proxy.php
+++ b/apps/user_ldap/lib/proxy.php
@@ -54,13 +54,16 @@ abstract class Proxy {
return 'group-'.$gid.'-lastSeenOn';
}
+ /**
+ * @param boolean $passOnWhen
+ */
abstract protected function callOnLastSeenOn($id, $method, $parameters, $passOnWhen);
abstract protected function walkBackends($id, $method, $parameters);
/**
* @brief Takes care of the request to the User backend
* @param $uid string, the uid connected to the request
- * @param $method string, the method of the user backend that shall be called
+ * @param string $method string, the method of the user backend that shall be called
* @param $parameters an array of parameters to be passed
* @return mixed, the result of the specified method
*/
@@ -80,6 +83,9 @@ abstract class Proxy {
return $prefix.md5($key);
}
+ /**
+ * @param string $key
+ */
public function getFromCache($key) {
if(!$this->isCached($key)) {
return null;
@@ -94,6 +100,9 @@ abstract class Proxy {
return $this->cache->hasKey($key);
}
+ /**
+ * @param string $key
+ */
public function writeToCache($key, $value) {
$key = $this->getCacheKey($key);
$value = base64_encode(serialize($value));
diff --git a/apps/user_ldap/lib/wizard.php b/apps/user_ldap/lib/wizard.php
index b70ede8599c..7160cdc04f2 100644
--- a/apps/user_ldap/lib/wizard.php
+++ b/apps/user_ldap/lib/wizard.php
@@ -176,7 +176,7 @@ class Wizard extends LDAPUtility {
/**
* @brief return the state of the mode of the specified filter
- * @param $confkey string, contains the access key of the Configuration
+ * @param string $confkey string, contains the access key of the Configuration
*/
private function getFilterMode($confkey) {
$mode = $this->configuration->$confkey;
@@ -241,6 +241,8 @@ class Wizard extends LDAPUtility {
/**
* @brief detects the available LDAP groups
* @returns the instance's WizardResult instance
+ * @param string $dbkey
+ * @param string $confkey
*/
private function determineGroups($dbkey, $confkey, $testMemberOf = true) {
if(!$this->checkRequirements(array('ldapHost',
@@ -554,7 +556,7 @@ class Wizard extends LDAPUtility {
/**
* @brief Checks whether for a given BaseDN results will be returned
- * @param $base the BaseDN to test
+ * @param string $base the BaseDN to test
* @return bool true on success, false otherwise
*/
private function testBaseDN($base) {
@@ -615,7 +617,7 @@ class Wizard extends LDAPUtility {
/**
* @brief creates an LDAP Filter from given configuration
- * @param $filterType int, for which use case the filter shall be created
+ * @param integer $filterType int, for which use case the filter shall be created
* can be any of self::LFILTER_USER_LIST, self::LFILTER_LOGIN or
* self::LFILTER_GROUP_LIST
* @return mixed, string with the filter on success, false otherwise
@@ -842,6 +844,9 @@ class Wizard extends LDAPUtility {
|| (empty($agent) && empty($pwd)));
}
+ /**
+ * @param string[] $reqs
+ */
private function checkRequirements($reqs) {
$this->checkAgentRequirements();
foreach($reqs as $option) {
@@ -860,7 +865,7 @@ class Wizard extends LDAPUtility {
* @param $attr the attribute of which a list of values shall be returned
* @param $lfw bool, whether the last filter is a wildcard which shall not
* be processed if there were already findings, defaults to true
- * @param $maxF string. if not null, this variable will have the filter that
+ * @param string $maxF string. if not null, this variable will have the filter that
* yields most result entries
* @return mixed, an array with the values on success, false otherwise
*
@@ -922,8 +927,8 @@ class Wizard extends LDAPUtility {
/**
* @brief determines if and which $attr are available on the LDAP server
- * @param $objectclasses the objectclasses to use as search filter
- * @param $attr the attribute to look for
+ * @param string[] $objectclasses the objectclasses to use as search filter
+ * @param string $attr the attribute to look for
* @param $dbkey the dbkey of the setting the feature is connected to
* @param $confkey the confkey counterpart for the $dbkey as used in the
* Configuration class
diff --git a/apps/user_ldap/user_ldap.php b/apps/user_ldap/user_ldap.php
index a19af86086c..f983c7835af 100644
--- a/apps/user_ldap/user_ldap.php
+++ b/apps/user_ldap/user_ldap.php
@@ -139,9 +139,9 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface {
/**
* @brief Check if the password is correct
- * @param $uid The username
- * @param $password The password
- * @returns true/false
+ * @param string $uid The username
+ * @param string $password The password
+ * @return boolean
*
* Check if the password is correct without logging in the user
*/
diff --git a/core/lostpassword/controller.php b/core/lostpassword/controller.php
index 3c8099591a1..fd20c6ba249 100644
--- a/core/lostpassword/controller.php
+++ b/core/lostpassword/controller.php
@@ -8,6 +8,11 @@
namespace OC\Core\LostPassword;
class Controller {
+
+ /**
+ * @param boolean $error
+ * @param boolean $requested
+ */
protected static function displayLostPasswordPage($error, $requested) {
$isEncrypted = \OC_App::isEnabled('files_encryption');
\OC_Template::printGuestPage('core/lostpassword', 'lostpassword',
@@ -16,6 +21,9 @@ class Controller {
'isEncrypted' => $isEncrypted));
}
+ /**
+ * @param boolean $success
+ */
protected static function displayResetPasswordPage($success, $args) {
$route_args = array();
$route_args['token'] = $args['token'];
diff --git a/lib/base.php b/lib/base.php
index f2d9251294d..a5f064bdb4b 100644
--- a/lib/base.php
+++ b/lib/base.php
@@ -385,7 +385,7 @@ class OC {
}
/**
- * @return int
+ * @return string
*/
private static function getSessionLifeTime() {
return OC_Config::getValue('session_lifetime', 60 * 60 * 24);
diff --git a/lib/private/activitymanager.php b/lib/private/activitymanager.php
index 7e7e2257874..685809581ac 100755
--- a/lib/private/activitymanager.php
+++ b/lib/private/activitymanager.php
@@ -59,7 +59,6 @@ class ActivityManager implements IManager {
*
* $callable has to return an instance of OCA\Activity\IConsumer
*
- * @param string $key
* @param \Closure $callable
*/
function registerConsumer(\Closure $callable) {
diff --git a/lib/private/api.php b/lib/private/api.php
index c713368125c..3f96196e6df 100644
--- a/lib/private/api.php
+++ b/lib/private/api.php
@@ -328,6 +328,9 @@ class OC_API {
}
}
+ /**
+ * @param XMLWriter $writer
+ */
private static function toXML($array, $writer) {
foreach($array as $k => $v) {
if ($k[0] === '@') {
diff --git a/lib/private/app.php b/lib/private/app.php
index da09021cf3f..e60a8a4e0b1 100644
--- a/lib/private/app.php
+++ b/lib/private/app.php
@@ -38,7 +38,7 @@ class OC_App{
/**
* @brief clean the appid
- * @param $app Appid that needs to be cleaned
+ * @param string|boolean $app Appid that needs to be cleaned
* @return string
*/
public static function cleanAppId($app) {
@@ -261,7 +261,7 @@ class OC_App{
/**
* @brief disables an app
* @param string $app app
- * @return bool
+ * @return boolean|null
*
* This function set an app as disabled in appconfig.
*/
@@ -342,7 +342,7 @@ class OC_App{
/**
* @brief Returns the Settings Navigation
- * @return array
+ * @return string
*
* This function returns an array containing all settings pages added. The
* entries are sorted by the key 'order' ascending.
@@ -437,6 +437,7 @@ class OC_App{
/**
* Get the path where to install apps
+ * @return string
*/
public static function getInstallPath() {
if(OC_Config::getValue('appstoreenabled', true)==false) {
@@ -490,6 +491,7 @@ class OC_App{
/**
* get the last version of the app, either from appinfo/version or from appinfo/info.xml
+ * @return string
*/
public static function getAppVersion($appid) {
$file= self::getAppPath($appid).'/appinfo/version';
@@ -570,7 +572,7 @@ class OC_App{
/**
* @brief Returns the navigation
- * @return array
+ * @return string
*
* This function returns an array containing all entries added. The
* entries are sorted by the key 'order' ascending. Additional to the keys
@@ -854,6 +856,7 @@ class OC_App{
/**
* check if the app needs updating and update when needed
+ * @param string $app
*/
public static function checkUpgrade($app) {
if (in_array($app, self::$checkedApps)) {
diff --git a/lib/private/appconfig.php b/lib/private/appconfig.php
index da0b2ff8604..4dbbfbcf85d 100644
--- a/lib/private/appconfig.php
+++ b/lib/private/appconfig.php
@@ -84,6 +84,9 @@ class OC_Appconfig {
return $keys;
}
+ /**
+ * @param string $app
+ */
private static function getAppValues($app) {
if (!isset(self::$cache[$app])) {
self::$cache[$app] = array();
@@ -145,7 +148,7 @@ class OC_Appconfig {
* @param string $app app
* @param string $key key
* @param string $value value
- * @return bool
+ * @return boolean|null
*
* Sets a value. If the key did not exist before it will be created.
*/
@@ -212,6 +215,8 @@ class OC_Appconfig {
*
* @param app
* @param key
+ * @param boolean $app
+ * @param string $key
* @return array
*/
public static function getValues($app, $key) {
diff --git a/lib/private/appframework/dependencyinjection/dicontainer.php b/lib/private/appframework/dependencyinjection/dicontainer.php
index e2ea974e104..b6ccf60db4b 100644
--- a/lib/private/appframework/dependencyinjection/dicontainer.php
+++ b/lib/private/appframework/dependencyinjection/dicontainer.php
@@ -135,7 +135,7 @@ class DIContainer extends SimpleContainer implements IAppContainer{
/**
* @param Middleware $middleWare
- * @return boolean
+ * @return boolean|null
*/
function registerMiddleWare(Middleware $middleWare) {
array_push($this->middleWares, $middleWare);
diff --git a/lib/private/appframework/http.php b/lib/private/appframework/http.php
index 41fc0db6b38..65d926105f1 100644
--- a/lib/private/appframework/http.php
+++ b/lib/private/appframework/http.php
@@ -108,7 +108,7 @@ class Http extends BaseHttp {
* Gets the correct header
* @param Http::CONSTANT $status the constant from the Http class
* @param \DateTime $lastModified formatted last modified date
- * @param string $Etag the etag
+ * @param string $ETag the etag
*/
public function getStatusHeader($status, \DateTime $lastModified=null,
$ETag=null) {
diff --git a/lib/private/appframework/http/redirectresponse.php b/lib/private/appframework/http/redirectresponse.php
index c4e21059480..5c4e1c06dc3 100644
--- a/lib/private/appframework/http/redirectresponse.php
+++ b/lib/private/appframework/http/redirectresponse.php
@@ -25,7 +25,7 @@
namespace OC\AppFramework\Http;
use OCP\AppFramework\Http\Response,
- OCP\AppFramework\Http;
+ OCP\AppFramework\Http;
/**
diff --git a/lib/private/appframework/http/request.php b/lib/private/appframework/http/request.php
index 3e1f4ff87ed..40f47a7bd2f 100644
--- a/lib/private/appframework/http/request.php
+++ b/lib/private/appframework/http/request.php
@@ -114,7 +114,7 @@ class Request implements \ArrayAccess, \Countable, IRequest {
* $request['myvar'] = 'something'; // This throws an exception.
*
* @param string $offset The key to lookup
- * @return string|null
+ * @return boolean
*/
public function offsetExists($offset) {
return isset($this->items['parameters'][$offset]);
diff --git a/lib/private/appframework/middleware/middlewaredispatcher.php b/lib/private/appframework/middleware/middlewaredispatcher.php
index 681140c2242..598743e523f 100644
--- a/lib/private/appframework/middleware/middlewaredispatcher.php
+++ b/lib/private/appframework/middleware/middlewaredispatcher.php
@@ -56,7 +56,7 @@ class MiddlewareDispatcher {
/**
* Adds a new middleware
- * @param Middleware $middleware the middleware which will be added
+ * @param Middleware $middleWare the middleware which will be added
*/
public function registerMiddleware(Middleware $middleWare){
array_push($this->middlewares, $middleWare);
diff --git a/lib/private/appframework/middleware/security/securityexception.php b/lib/private/appframework/middleware/security/securityexception.php
index b32a2769ff5..e551675acdf 100644
--- a/lib/private/appframework/middleware/security/securityexception.php
+++ b/lib/private/appframework/middleware/security/securityexception.php
@@ -32,7 +32,6 @@ class SecurityException extends \Exception {
/**
* @param string $msg the security error message
- * @param bool $ajax true if it resulted because of an ajax request
*/
public function __construct($msg, $code = 0) {
parent::__construct($msg, $code);
diff --git a/lib/private/appframework/routing/routeactionhandler.php b/lib/private/appframework/routing/routeactionhandler.php
index 2b9dc38dc43..6a5c64745ae 100644
--- a/lib/private/appframework/routing/routeactionhandler.php
+++ b/lib/private/appframework/routing/routeactionhandler.php
@@ -30,6 +30,10 @@ class RouteActionHandler {
private $actionName;
private $container;
+ /**
+ * @param string $controllerName
+ * @param string $actionName
+ */
public function __construct(DIContainer $container, $controllerName, $actionName) {
$this->controllerName = $controllerName;
$this->actionName = $actionName;
diff --git a/lib/private/appframework/routing/routeconfig.php b/lib/private/appframework/routing/routeconfig.php
index 53ab11bf2f5..716358444a2 100644
--- a/lib/private/appframework/routing/routeconfig.php
+++ b/lib/private/appframework/routing/routeconfig.php
@@ -37,7 +37,6 @@ class RouteConfig {
/**
* @param \OC\AppFramework\DependencyInjection\DIContainer $container
* @param \OC_Router $router
- * @param string $pathToYml
* @internal param $appName
*/
public function __construct(DIContainer $container, \OC_Router $router, $routes) {
diff --git a/lib/private/appframework/utility/simplecontainer.php b/lib/private/appframework/utility/simplecontainer.php
index e631e657756..d08a4879e34 100644
--- a/lib/private/appframework/utility/simplecontainer.php
+++ b/lib/private/appframework/utility/simplecontainer.php
@@ -31,7 +31,7 @@ class SimpleContainer extends \Pimple implements \OCP\IContainer {
* Created instance will be cached in case $shared is true.
*
* @param string $name name of the service to register another backend for
- * @param callable $closure the closure to be called on service creation
+ * @param \Closure $closure the closure to be called on service creation
*/
function registerService($name, \Closure $closure, $shared = true)
{
diff --git a/lib/private/archive.php b/lib/private/archive.php
index 85bfae57295..9fe553f7141 100644
--- a/lib/private/archive.php
+++ b/lib/private/archive.php
@@ -10,6 +10,7 @@ abstract class OC_Archive{
/**
* open any of the supported archive types
* @param string path
+ * @param string $path
* @return OC_Archive
*/
public static function open($path) {
@@ -33,6 +34,7 @@ abstract class OC_Archive{
/**
* add an empty folder to the archive
* @param string path
+ * @param string $path
* @return bool
*/
abstract function addFolder($path);
@@ -40,6 +42,7 @@ abstract class OC_Archive{
* add a file to the archive
* @param string path
* @param string source either a local file or string data
+ * @param string $path
* @return bool
*/
abstract function addFile($path, $source='');
@@ -116,7 +119,7 @@ abstract class OC_Archive{
* add a folder and all its content
* @param string $path
* @param string source
- * @return bool
+ * @return boolean|null
*/
function addRecursive($path, $source) {
$dh = opendir($source);
diff --git a/lib/private/archive/tar.php b/lib/private/archive/tar.php
index a1c0535b1c3..224c8b82cc7 100644
--- a/lib/private/archive/tar.php
+++ b/lib/private/archive/tar.php
@@ -31,7 +31,7 @@ class OC_Archive_TAR extends OC_Archive{
/**
* try to detect the type of tar compression
* @param string file
- * @return str
+ * @return integer
*/
static public function getTarType($file) {
if(strpos($file, '.')) {
@@ -211,6 +211,7 @@ class OC_Archive_TAR extends OC_Archive{
* extract a single file from the archive
* @param string path
* @param string dest
+ * @param string $dest
* @return bool
*/
function extractFile($path, $dest) {
@@ -233,6 +234,7 @@ class OC_Archive_TAR extends OC_Archive{
* extract the archive
* @param string path
* @param string dest
+ * @param string $dest
* @return bool
*/
function extract($dest) {
diff --git a/lib/private/archive/zip.php b/lib/private/archive/zip.php
index 8a866716a79..4cb83087e29 100644
--- a/lib/private/archive/zip.php
+++ b/lib/private/archive/zip.php
@@ -51,7 +51,7 @@ class OC_Archive_ZIP extends OC_Archive{
* rename a file or folder in the archive
* @param string source
* @param string dest
- * @return bool
+ * @return boolean|null
*/
function rename($source, $dest) {
$source=$this->stripPath($source);
@@ -117,7 +117,8 @@ class OC_Archive_ZIP extends OC_Archive{
* extract a single file from the archive
* @param string path
* @param string dest
- * @return bool
+ * @param string $dest
+ * @return boolean|null
*/
function extractFile($path, $dest) {
$fp = $this->zip->getStream($path);
@@ -127,6 +128,7 @@ class OC_Archive_ZIP extends OC_Archive{
* extract the archive
* @param string path
* @param string dest
+ * @param string $dest
* @return bool
*/
function extract($dest) {
@@ -191,6 +193,9 @@ class OC_Archive_ZIP extends OC_Archive{
}
}
+ /**
+ * @return string
+ */
private function stripPath($path) {
if(!$path || $path[0]=='/') {
return substr($path, 1);
diff --git a/lib/private/arrayparser.php b/lib/private/arrayparser.php
index 3bb394a5163..c4ad1264fbb 100644
--- a/lib/private/arrayparser.php
+++ b/lib/private/arrayparser.php
@@ -30,6 +30,9 @@ class ArrayParser {
const TYPE_STRING = 3;
const TYPE_ARRAY = 4;
+ /**
+ * @param string $string
+ */
function parsePHP($string) {
$string = $this->stripPHPTags($string);
$string = $this->stripAssignAndReturn($string);
@@ -47,6 +50,9 @@ class ArrayParser {
return $string;
}
+ /**
+ * @param string $string
+ */
function stripAssignAndReturn($string) {
$string = trim($string);
if (substr($string, 0, 6) === 'return') {
@@ -74,6 +80,9 @@ class ArrayParser {
return null;
}
+ /**
+ * @param string $string
+ */
function getType($string) {
$string = strtolower($string);
$first = substr($string, 0, 1);
@@ -90,19 +99,31 @@ class ArrayParser {
}
}
+ /**
+ * @param string $string
+ */
function parseString($string) {
return substr($string, 1, -1);
}
+ /**
+ * @param string $string
+ */
function parseNum($string) {
return intval($string);
}
+ /**
+ * @param string $string
+ */
function parseBool($string) {
$string = strtolower($string);
return $string === 'true';
}
+ /**
+ * @param string $string
+ */
function parseArray($string) {
$body = substr($string, 5);
$body = trim($body);
@@ -131,6 +152,9 @@ class ArrayParser {
return $result;
}
+ /**
+ * @param string $body
+ */
function splitArray($body) {
$inSingleQuote = false;//keep track if we are inside quotes
$inDoubleQuote = false;
diff --git a/lib/private/backgroundjob.php b/lib/private/backgroundjob.php
index 9619dcb732c..aa740a89532 100644
--- a/lib/private/backgroundjob.php
+++ b/lib/private/backgroundjob.php
@@ -37,8 +37,8 @@ class OC_BackgroundJob{
/**
* @brief sets the background jobs execution type
- * @param $type execution type
- * @return boolean
+ * @param string $type execution type
+ * @return boolean|null
*
* This method sets the execution type of the background jobs. Possible types
* are "none", "ajax", "webcron", "cron"
diff --git a/lib/private/backgroundjob/joblist.php b/lib/private/backgroundjob/joblist.php
index 99743a70c77..82287816090 100644
--- a/lib/private/backgroundjob/joblist.php
+++ b/lib/private/backgroundjob/joblist.php
@@ -34,7 +34,7 @@ class JobList {
}
/**
- * @param Job|string $job
+ * @param Job $job
* @param mixed $argument
*/
public function remove($job, $argument = null) {
@@ -154,7 +154,7 @@ class JobList {
/**
* get the id of the last ran job
*
- * @return int
+ * @return string
*/
public function getLastJob() {
return \OC_Appconfig::getValue('backgroundjob', 'lastjob', 0);
diff --git a/lib/private/cache/file.php b/lib/private/cache/file.php
index b0738d2a92b..8a6ef39f61b 100644
--- a/lib/private/cache/file.php
+++ b/lib/private/cache/file.php
@@ -29,6 +29,9 @@ class File {
}
}
+ /**
+ * @param string $key
+ */
public function get($key) {
$result = null;
$proxyStatus = \OC_FileProxy::$enabled;
@@ -59,6 +62,9 @@ class File {
return $result;
}
+ /**
+ * @param string $key
+ */
public function set($key, $value, $ttl=0) {
$storage = $this->getStorage();
$result = false;
@@ -87,6 +93,9 @@ class File {
return false;
}
+ /**
+ * @param string $key
+ */
public function remove($key) {
$storage = $this->getStorage();
if(!$storage) {
diff --git a/lib/private/cache/fileglobal.php b/lib/private/cache/fileglobal.php
index bd049bba4d0..cdf2a11da3c 100644
--- a/lib/private/cache/fileglobal.php
+++ b/lib/private/cache/fileglobal.php
@@ -21,6 +21,9 @@ class FileGlobal {
return str_replace('/', '_', $key);
}
+ /**
+ * @param string $key
+ */
public function get($key) {
$key = $this->fixKey($key);
if ($this->hasKey($key)) {
@@ -30,6 +33,10 @@ class FileGlobal {
return null;
}
+ /**
+ * @param string $key
+ * @param string $value
+ */
public function set($key, $value, $ttl=0) {
$key = $this->fixKey($key);
$cache_dir = self::getCacheDir();
diff --git a/lib/private/connector/sabre/file.php b/lib/private/connector/sabre/file.php
index ed27cef440d..5ef6365f657 100644
--- a/lib/private/connector/sabre/file.php
+++ b/lib/private/connector/sabre/file.php
@@ -206,6 +206,9 @@ class OC_Connector_Sabre_File extends OC_Connector_Sabre_Node implements Sabre_D
}
+ /**
+ * @param resource $data
+ */
private function createFileChunked($data)
{
list($path, $name) = \Sabre_DAV_URLUtil::splitPath($this->path);
diff --git a/lib/private/connector/sabre/node.php b/lib/private/connector/sabre/node.php
index 993aa73faeb..05d2d2291ec 100644
--- a/lib/private/connector/sabre/node.php
+++ b/lib/private/connector/sabre/node.php
@@ -153,9 +153,8 @@ abstract class OC_Connector_Sabre_Node implements Sabre_DAV_INode, Sabre_DAV_IPr
/**
* @brief Updates properties on this node,
- * @param array $mutations
* @see Sabre_DAV_IProperties::updateProperties
- * @return bool|array
+ * @return boolean
*/
public function updateProperties($properties) {
$existing = $this->getProperties(array());
@@ -267,7 +266,7 @@ abstract class OC_Connector_Sabre_Node implements Sabre_DAV_INode, Sabre_DAV_IPr
}
/**
- * @return mixed
+ * @return string|null
*/
public function getFileId()
{
diff --git a/lib/private/connector/sabre/principal.php b/lib/private/connector/sabre/principal.php
index 59a96797c16..2075aa55c86 100644
--- a/lib/private/connector/sabre/principal.php
+++ b/lib/private/connector/sabre/principal.php
@@ -62,7 +62,7 @@ class OC_Connector_Sabre_Principal implements Sabre_DAVACL_IPrincipalBackend {
* Returns the list of members for a group-principal
*
* @param string $principal
- * @return array
+ * @return string[]
*/
public function getGroupMemberSet($principal) {
// TODO: for now the group principal has only one member, the user itself
diff --git a/lib/private/connector/sabre/quotaplugin.php b/lib/private/connector/sabre/quotaplugin.php
index ea2cb81d1f7..d6255325343 100644
--- a/lib/private/connector/sabre/quotaplugin.php
+++ b/lib/private/connector/sabre/quotaplugin.php
@@ -45,7 +45,6 @@ class OC_Connector_Sabre_QuotaPlugin extends Sabre_DAV_ServerPlugin {
/**
* This method is called before any HTTP method and validates there is enough free space to store the file
*
- * @param string $method
* @throws Sabre_DAV_Exception
* @return bool
*/
diff --git a/lib/private/connector/sabre/server.php b/lib/private/connector/sabre/server.php
index 41e8885917a..2660b043f46 100644
--- a/lib/private/connector/sabre/server.php
+++ b/lib/private/connector/sabre/server.php
@@ -67,6 +67,7 @@ class OC_Connector_Sabre_Server extends Sabre_DAV_Server {
/**
* Small helper to support PROPFIND with DEPTH_INFINITY.
+ * @param string $path
*/
private function addPathNodesRecursively(&$nodes, $path) {
foreach($this->tree->getChildren($path) as $childNode) {
diff --git a/lib/private/davclient.php b/lib/private/davclient.php
index 28f48f3b921..f93b175f352 100644
--- a/lib/private/davclient.php
+++ b/lib/private/davclient.php
@@ -32,6 +32,7 @@ class OC_DAVClient extends \Sabre_DAV_Client {
/**
* @brief Sets the request timeout or 0 to disable timeout.
* @param int timeout in seconds or 0 to disable
+ * @param integer $timeout
*/
public function setRequestTimeout($timeout) {
$this->requestTimeout = (int)$timeout;
diff --git a/lib/private/db.php b/lib/private/db.php
index 562065259fa..31132d82c0c 100644
--- a/lib/private/db.php
+++ b/lib/private/db.php
@@ -51,7 +51,7 @@ class OC_DB {
/**
* @brief connects to the database
- * @return bool true if connection can be established or false on error
+ * @return boolean|null true if connection can be established or false on error
*
* Connects to the database as specified in config.php
*/
@@ -196,7 +196,7 @@ class OC_DB {
* @param int $offset
* @param bool $isManipulation
* @throws DatabaseException
- * @return \Doctrine\DBAL\Statement prepared SQL query
+ * @return OC_DB_StatementWrapper prepared SQL query
*
* SQL query via Doctrine prepare(), needs to be execute()'d!
*/
@@ -298,7 +298,7 @@ class OC_DB {
/**
* @brief gets last value of autoincrement
* @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix
- * @return int id
+ * @return string id
* @throws DatabaseException
*
* \Doctrine\DBAL\Connection lastInsertId
@@ -315,7 +315,7 @@ class OC_DB {
* @brief Insert a row if a matching row doesn't exists.
* @param string $table. The table to insert into in the form '*PREFIX*tableName'
* @param array $input. An array of fieldname/value pairs
- * @return int number of updated rows
+ * @return boolean number of updated rows
*/
public static function insertIfNotExist($table, $input) {
self::connect();
@@ -368,7 +368,7 @@ class OC_DB {
* @brief update the database schema
* @param string $file file to read structure from
* @throws Exception
- * @return bool
+ * @return string|boolean
*/
public static function updateDbFromStructure($file) {
$schemaManager = self::getMDB2SchemaManager();
diff --git a/lib/private/db/connection.php b/lib/private/db/connection.php
index 2581969dbd0..2bd7b093020 100644
--- a/lib/private/db/connection.php
+++ b/lib/private/db/connection.php
@@ -94,7 +94,7 @@ class Connection extends \Doctrine\DBAL\Connection {
* If an SQLLogger is configured, the execution is logged.
*
* @param string $query The SQL query to execute.
- * @param array $params The parameters to bind to the query, if any.
+ * @param string[] $params The parameters to bind to the query, if any.
* @param array $types The types the previous parameters are in.
* @param QueryCacheProfile $qcp
* @return \Doctrine\DBAL\Driver\Statement The executed statement.
diff --git a/lib/private/db/connectionwrapper.php b/lib/private/db/connectionwrapper.php
index 93d4fb57f74..c2cfc21d204 100644
--- a/lib/private/db/connectionwrapper.php
+++ b/lib/private/db/connectionwrapper.php
@@ -31,8 +31,8 @@ class ConnectionWrapper implements \OCP\IDBConnection {
/**
* Used to get the id of the just inserted element
- * @param string $tableName the name of the table where we inserted the item
- * @return int the id of the inserted element
+ * @param string $table the name of the table where we inserted the item
+ * @return string the id of the inserted element
*/
public function lastInsertId($table = null)
{
diff --git a/lib/private/db/mdb2schemamanager.php b/lib/private/db/mdb2schemamanager.php
index 6378c769055..c050d47b499 100644
--- a/lib/private/db/mdb2schemamanager.php
+++ b/lib/private/db/mdb2schemamanager.php
@@ -53,7 +53,7 @@ class MDB2SchemaManager {
/**
* @brief update the database scheme
* @param string $file file to read structure from
- * @return bool
+ * @return string|boolean
*/
public function updateDbFromStructure($file, $generateSql = false) {
$sm = $this->conn->getSchemaManager();
diff --git a/lib/private/db/mdb2schemawriter.php b/lib/private/db/mdb2schemawriter.php
index 21b43cbfe80..42d5bbab112 100644
--- a/lib/private/db/mdb2schemawriter.php
+++ b/lib/private/db/mdb2schemawriter.php
@@ -9,7 +9,7 @@
class OC_DB_MDB2SchemaWriter {
/**
- * @param $file
+ * @param string $file
* @param \Doctrine\DBAL\Schema\AbstractSchemaManager $sm
* @return bool
*/
@@ -26,6 +26,9 @@ class OC_DB_MDB2SchemaWriter {
return true;
}
+ /**
+ * @param SimpleXMLElement $xml
+ */
private static function saveTable($table, $xml) {
$xml->addChild('name', $table->getName());
$declaration = $xml->addChild('declaration');
diff --git a/lib/private/db/statementwrapper.php b/lib/private/db/statementwrapper.php
index 5e89261d936..2da10741ce6 100644
--- a/lib/private/db/statementwrapper.php
+++ b/lib/private/db/statementwrapper.php
@@ -17,6 +17,9 @@ class OC_DB_StatementWrapper {
private $isManipulation = false;
private $lastArguments = array();
+ /**
+ * @param boolean $isManipulation
+ */
public function __construct($statement, $isManipulation) {
$this->statement = $statement;
$this->isManipulation = $isManipulation;
diff --git a/lib/private/defaults.php b/lib/private/defaults.php
index cec9a65c7f3..0b97497baa1 100644
--- a/lib/private/defaults.php
+++ b/lib/private/defaults.php
@@ -39,6 +39,9 @@ class OC_Defaults {
}
}
+ /**
+ * @param string $method
+ */
private function themeExist($method) {
if (OC_Util::getTheme() !== '' && method_exists('OC_Theme', $method)) {
return true;
diff --git a/lib/private/filechunking.php b/lib/private/filechunking.php
index aa4f73c7c05..09b30af48b2 100644
--- a/lib/private/filechunking.php
+++ b/lib/private/filechunking.php
@@ -16,6 +16,9 @@ class OC_FileChunking {
return $matches;
}
+ /**
+ * @param string[] $info
+ */
public function __construct($info) {
$this->info = $info;
}
@@ -37,7 +40,7 @@ class OC_FileChunking {
/**
* Stores the given $data under the given $key - the number of stored bytes is returned
*
- * @param $index
+ * @param string $index
* @param $data
* @return int
*/
@@ -87,7 +90,7 @@ class OC_FileChunking {
/**
* Removes one specific chunk
- * @param $index
+ * @param string $index
*/
public function remove($index) {
$cache = $this->getCache();
@@ -124,6 +127,9 @@ class OC_FileChunking {
);
}
+ /**
+ * @param string $path
+ */
public function file_assemble($path) {
$absolutePath = \OC\Files\Filesystem::normalizePath(\OC\Files\Filesystem::getView()->getAbsolutePath($path));
$data = '';
diff --git a/lib/private/fileproxy.php b/lib/private/fileproxy.php
index 2997aaf81b6..62187e1ec74 100644
--- a/lib/private/fileproxy.php
+++ b/lib/private/fileproxy.php
@@ -67,6 +67,9 @@ class OC_FileProxy{
self::$proxies[]=$proxy;
}
+ /**
+ * @param string $operation
+ */
public static function getProxies($operation = null) {
if ($operation === null) {
// return all
@@ -81,6 +84,10 @@ class OC_FileProxy{
return $proxies;
}
+ /**
+ * @param string $operation
+ * @param string|boolean $filepath
+ */
public static function runPreProxies($operation,&$filepath,&$filepath2=null) {
if(!self::$enabled) {
return true;
@@ -101,6 +108,11 @@ class OC_FileProxy{
return true;
}
+ /**
+ * @param string $operation
+ *
+ * @return string
+ */
public static function runPostProxies($operation, $path, $result) {
if(!self::$enabled) {
return $result;
diff --git a/lib/private/files.php b/lib/private/files.php
index 8ce632013cf..6fb7d9ff41d 100644
--- a/lib/private/files.php
+++ b/lib/private/files.php
@@ -40,7 +40,7 @@ class OC_Files {
* return the content of a file or return a zip file containing multiple files
*
* @param string $dir
- * @param string $file ; separated list of files to download
+ * @param string $files ; separated list of files to download
* @param boolean $only_header ; boolean to only send header of the request
*/
public static function get($dir, $files, $only_header = false) {
@@ -170,6 +170,9 @@ class OC_Files {
}
}
+ /**
+ * @param false|string $filename
+ */
private static function addSendfileHeader($filename) {
if (isset($_SERVER['MOD_X_SENDFILE_ENABLED'])) {
header("X-Sendfile: " . $filename);
@@ -194,6 +197,10 @@ class OC_Files {
}
}
+ /**
+ * @param string $dir
+ * @param ZipArchive $zip
+ */
public static function zipAddDir($dir, $zip, $internalDir='') {
$dirname=basename($dir);
$zip->addEmptyDir($internalDir.$dirname);
@@ -215,7 +222,7 @@ class OC_Files {
/**
* checks if the selected files are within the size constraint. If not, outputs an error page.
*
- * @param dir $dir
+ * @param string $dir
* @param files $files
*/
static function validateZipDownload($dir, $files) {
diff --git a/lib/private/files/cache/backgroundwatcher.php b/lib/private/files/cache/backgroundwatcher.php
index 923804f48d0..2194651233d 100644
--- a/lib/private/files/cache/backgroundwatcher.php
+++ b/lib/private/files/cache/backgroundwatcher.php
@@ -24,6 +24,9 @@ class BackgroundWatcher {
return $row['id'];
}
+ /**
+ * @param integer $id
+ */
static private function checkUpdate($id) {
$cacheItem = Cache::getById($id);
if (is_null($cacheItem)) {
diff --git a/lib/private/files/cache/cache.php b/lib/private/files/cache/cache.php
index 1e7936ca26d..4cab4619149 100644
--- a/lib/private/files/cache/cache.php
+++ b/lib/private/files/cache/cache.php
@@ -487,7 +487,7 @@ class Cache {
/**
* update the folder size and the size of all parent folders
*
- * @param $path
+ * @param string|boolean $path
*/
public function correctFolderSize($path) {
$this->calculateFolderSize($path);
diff --git a/lib/private/files/cache/homecache.php b/lib/private/files/cache/homecache.php
index 71bb944da71..a7c310a3782 100644
--- a/lib/private/files/cache/homecache.php
+++ b/lib/private/files/cache/homecache.php
@@ -38,6 +38,9 @@ class HomeCache extends Cache {
return $totalSize;
}
+ /**
+ * @param string $path
+ */
public function get($path) {
$data = parent::get($path);
if ($path === '' or $path === '/') {
diff --git a/lib/private/files/cache/legacy.php b/lib/private/files/cache/legacy.php
index 8eed1f67a5d..4d5f58741e9 100644
--- a/lib/private/files/cache/legacy.php
+++ b/lib/private/files/cache/legacy.php
@@ -16,6 +16,9 @@ class Legacy {
private $cacheHasItems = null;
+ /**
+ * @param string $user
+ */
public function __construct($user) {
$this->user = $user;
}
@@ -69,7 +72,7 @@ class Legacy {
/**
* get an item from the legacy cache
*
- * @param string|int $path
+ * @param string $path
* @return array
*/
function get($path) {
diff --git a/lib/private/files/cache/storage.php b/lib/private/files/cache/storage.php
index 5657cf06e12..59972667287 100644
--- a/lib/private/files/cache/storage.php
+++ b/lib/private/files/cache/storage.php
@@ -47,6 +47,9 @@ class Storage {
return $this->numericId;
}
+ /**
+ * @return string
+ */
public static function getStorageId($numericId) {
$sql = 'SELECT `id` FROM `*PREFIX*storages` WHERE `numeric_id` = ?';
@@ -58,6 +61,9 @@ class Storage {
}
}
+ /**
+ * @param string $storageId
+ */
public static function exists($storageId) {
if (strlen($storageId) > 64) {
$storageId = md5($storageId);
diff --git a/lib/private/files/cache/updater.php b/lib/private/files/cache/updater.php
index 73bc30e538f..e4114e572fe 100644
--- a/lib/private/files/cache/updater.php
+++ b/lib/private/files/cache/updater.php
@@ -112,7 +112,7 @@ class Updater {
/**
* @brief get file owner and path
* @param string $filename
- * @return array with the oweners uid and the owners path
+ * @return string[] with the oweners uid and the owners path
*/
private static function getUidAndFilename($filename) {
diff --git a/lib/private/files/filesystem.php b/lib/private/files/filesystem.php
index a83e9aa86d2..d1ebad3490c 100644
--- a/lib/private/files/filesystem.php
+++ b/lib/private/files/filesystem.php
@@ -614,6 +614,9 @@ class Filesystem {
return self::$defaultInstance->touch($path, $mtime);
}
+ /**
+ * @return string
+ */
static public function file_get_contents($path) {
return self::$defaultInstance->file_get_contents($path);
}
@@ -638,6 +641,9 @@ class Filesystem {
return self::$defaultInstance->fopen($path, $mode);
}
+ /**
+ * @return string
+ */
static public function toTmpFile($path) {
return self::$defaultInstance->toTmpFile($path);
}
diff --git a/lib/private/files/mapper.php b/lib/private/files/mapper.php
index 47abd4e52fe..833d4bd8d1c 100644
--- a/lib/private/files/mapper.php
+++ b/lib/private/files/mapper.php
@@ -44,7 +44,7 @@ class Mapper
/**
* @param string $path
* @param bool $isLogicPath indicates if $path is logical or physical
- * @param $recursive
+ * @param boolean $recursive
* @return void
*/
public function removePath($path, $isLogicPath, $recursive) {
@@ -60,8 +60,8 @@ class Mapper
}
/**
- * @param $path1
- * @param $path2
+ * @param string $path1
+ * @param string $path2
* @throws \Exception
*/
public function copy($path1, $path2)
@@ -99,7 +99,7 @@ class Mapper
/**
* @param $path
* @param $root
- * @return bool|string
+ * @return false|string
*/
public function stripRootFolder($path, $root) {
if (strpos($path, $root) !== 0) {
@@ -120,6 +120,9 @@ class Mapper
return $path;
}
+ /**
+ * @param string $logicPath
+ */
private function resolveLogicPath($logicPath) {
$logicPath = $this->stripLast($logicPath);
$sql = 'SELECT * FROM `*PREFIX*file_map` WHERE `logic_path_hash` = ?';
@@ -141,6 +144,10 @@ class Mapper
return $result['logic_path'];
}
+ /**
+ * @param string $logicPath
+ * @param boolean $store
+ */
private function create($logicPath, $store) {
$logicPath = $this->stripLast($logicPath);
$index = 0;
@@ -167,6 +174,9 @@ class Mapper
\OC_DB::executeAudited($sql, array($logicPath, $physicalPath, md5($logicPath), md5($physicalPath)));
}
+ /**
+ * @param integer $index
+ */
public function slugifyPath($path, $index=null) {
$path = $this->stripRootFolder($path, $this->unchangedPhysicalRoot);
diff --git a/lib/private/files/mount/manager.php b/lib/private/files/mount/manager.php
index 4c432dcf724..ff4a336f347 100644
--- a/lib/private/files/mount/manager.php
+++ b/lib/private/files/mount/manager.php
@@ -106,7 +106,7 @@ class Manager {
* Find mounts by numeric storage id
*
* @param string $id
- * @return Mount
+ * @return Mount[]
*/
public function findByNumericId($id) {
$storageId = \OC\Files\Cache\Storage::getStorageId($id);
diff --git a/lib/private/files/node/node.php b/lib/private/files/node/node.php
index 063e2424a64..604a881c4a1 100644
--- a/lib/private/files/node/node.php
+++ b/lib/private/files/node/node.php
@@ -33,6 +33,7 @@ class Node implements \OCP\Files\Node {
* @param \OC\Files\View $view
* @param \OC\Files\Node\Root Root $root
* @param string $path
+ * @param Root $root
*/
public function __construct($root, $view, $path) {
$this->view = $view;
diff --git a/lib/private/files/node/root.php b/lib/private/files/node/root.php
index e3d58476e9c..a22a2aaf4e9 100644
--- a/lib/private/files/node/root.php
+++ b/lib/private/files/node/root.php
@@ -95,7 +95,7 @@ class Root extends Folder implements Emitter {
/**
* @param string $scope
* @param string $method
- * @param array $arguments
+ * @param Node[] $arguments
*/
public function emit($scope, $method, $arguments = array()) {
$this->emitter->emit($scope, $method, $arguments);
@@ -154,7 +154,7 @@ class Root extends Folder implements Emitter {
* @param string $path
* @throws \OCP\Files\NotFoundException
* @throws \OCP\Files\NotPermittedException
- * @return Node
+ * @return string
*/
public function get($path) {
$path = $this->normalizePath($path);
diff --git a/lib/private/files/storage/common.php b/lib/private/files/storage/common.php
index 678bf419023..35464035209 100644
--- a/lib/private/files/storage/common.php
+++ b/lib/private/files/storage/common.php
@@ -202,6 +202,9 @@ abstract class Common implements \OC\Files\Storage\Storage {
return $this->toTmpFile($path);
}
+ /**
+ * @param string $path
+ */
private function toTmpFile($path) { //no longer in the storage api, still useful here
$source = $this->fopen($path, 'r');
if (!$source) {
@@ -224,6 +227,10 @@ abstract class Common implements \OC\Files\Storage\Storage {
return $baseDir;
}
+ /**
+ * @param string $path
+ * @param string $target
+ */
private function addLocalFolder($path, $target) {
$dh = $this->opendir($path);
if (is_resource($dh)) {
@@ -241,6 +248,9 @@ abstract class Common implements \OC\Files\Storage\Storage {
}
}
+ /**
+ * @param string $query
+ */
protected function searchInDir($query, $dir = '') {
$files = array();
$dh = $this->opendir($dir);
diff --git a/lib/private/files/storage/loader.php b/lib/private/files/storage/loader.php
index 2572ef443bc..734131261c8 100644
--- a/lib/private/files/storage/loader.php
+++ b/lib/private/files/storage/loader.php
@@ -25,6 +25,10 @@ class Loader {
$this->storageWrappers[] = $callback;
}
+ /**
+ * @param string|boolean $mountPoint
+ * @param string $class
+ */
public function load($mountPoint, $class, $arguments) {
return $this->wrap($mountPoint, new $class($arguments));
}
diff --git a/lib/private/files/storage/local.php b/lib/private/files/storage/local.php
index db3c6bfca3a..ba5e036cd8e 100644
--- a/lib/private/files/storage/local.php
+++ b/lib/private/files/storage/local.php
@@ -203,6 +203,9 @@ if (\OC_Util::runningOnWindows()) {
return $return;
}
+ /**
+ * @param string $dir
+ */
private function delTree($dir) {
$dirRelative = $dir;
$dir = $this->datadir . $dir;
@@ -224,6 +227,9 @@ if (\OC_Util::runningOnWindows()) {
return $return;
}
+ /**
+ * @param string $fullPath
+ */
private static function getFileSizeFromOS($fullPath) {
$name = strtolower(php_uname('s'));
// Windows OS: we use COM to access the filesystem
@@ -274,6 +280,9 @@ if (\OC_Util::runningOnWindows()) {
return $this->datadir . $path;
}
+ /**
+ * @param string $query
+ */
protected function searchInDir($query, $dir = '') {
$files = array();
foreach (scandir($this->datadir . $dir) as $item) {
diff --git a/lib/private/files/storage/mappedlocal.php b/lib/private/files/storage/mappedlocal.php
index 6c37d445867..c8b22cfb39f 100644
--- a/lib/private/files/storage/mappedlocal.php
+++ b/lib/private/files/storage/mappedlocal.php
@@ -210,6 +210,9 @@ class MappedLocal extends \OC\Files\Storage\Common{
return $return;
}
+ /**
+ * @param string $dir
+ */
private function delTree($dir, $isLogicPath=true) {
$dirRelative=$dir;
if ($isLogicPath) {
@@ -244,6 +247,9 @@ class MappedLocal extends \OC\Files\Storage\Common{
return $return;
}
+ /**
+ * @param string $fullPath
+ */
private static function getFileSizeFromOS($fullPath) {
$name = strtolower(php_uname('s'));
// Windows OS: we use COM to access the filesystem
@@ -288,6 +294,9 @@ class MappedLocal extends \OC\Files\Storage\Common{
return $this->buildPath($path);
}
+ /**
+ * @param string $query
+ */
protected function searchInDir($query, $dir='') {
$files=array();
$physicalDir = $this->buildPath($dir);
@@ -331,6 +340,10 @@ class MappedLocal extends \OC\Files\Storage\Common{
$this->mapper->removePath($fullPath, $isLogicPath, $recursive);
}
+ /**
+ * @param string $path1
+ * @param string $path2
+ */
private function copyMapping($path1, $path2) {
$path1 = $this->stripLeading($path1);
$path2 = $this->stripLeading($path2);
diff --git a/lib/private/files/storage/wrapper/quota.php b/lib/private/files/storage/wrapper/quota.php
index a430e3e4617..1bcdca7f47a 100644
--- a/lib/private/files/storage/wrapper/quota.php
+++ b/lib/private/files/storage/wrapper/quota.php
@@ -23,6 +23,9 @@ class Quota extends Wrapper {
$this->quota = $parameters['quota'];
}
+ /**
+ * @param string $path
+ */
protected function getSize($path) {
$cache = $this->getCache();
$data = $cache->get($path);
diff --git a/lib/private/files/stream/close.php b/lib/private/files/stream/close.php
index 80de3497c36..0e1f088fcf9 100644
--- a/lib/private/files/stream/close.php
+++ b/lib/private/files/stream/close.php
@@ -94,6 +94,9 @@ class Close {
return unlink($path);
}
+ /**
+ * @param string $path
+ */
public static function registerCallback($path, $callback) {
self::$callBacks[$path] = $callback;
}
diff --git a/lib/private/files/stream/dir.php b/lib/private/files/stream/dir.php
index 6ca884fc994..2483385c1d8 100644
--- a/lib/private/files/stream/dir.php
+++ b/lib/private/files/stream/dir.php
@@ -41,6 +41,9 @@ class Dir {
return true;
}
+ /**
+ * @param string $path
+ */
public static function register($path, $content) {
self::$dirs[$path] = $content;
}
diff --git a/lib/private/files/utils/scanner.php b/lib/private/files/utils/scanner.php
index 2cad7dd77bd..558bc60cf06 100644
--- a/lib/private/files/utils/scanner.php
+++ b/lib/private/files/utils/scanner.php
@@ -81,6 +81,9 @@ class Scanner extends PublicEmitter {
}
}
+ /**
+ * @param string $dir
+ */
public function scan($dir) {
$mounts = $this->getMounts($dir);
foreach ($mounts as $mount) {
diff --git a/lib/private/files/view.php b/lib/private/files/view.php
index d97544b865e..147bbed1ef3 100644
--- a/lib/private/files/view.php
+++ b/lib/private/files/view.php
@@ -48,7 +48,7 @@ class View {
* change the root to a fake root
*
* @param string $fakeRoot
- * @return bool
+ * @return boolean|null
*/
public function chroot($fakeRoot) {
if (!$fakeRoot == '') {
@@ -352,6 +352,9 @@ class View {
return $this->basicOperation('unlink', $path, array('delete'));
}
+ /**
+ * @param string $directory
+ */
public function deleteAll($directory, $empty = false) {
return $this->rmdir($directory);
}
@@ -735,6 +738,9 @@ class View {
return (strlen($this->fakeRoot) > strlen($defaultRoot)) && (substr($this->fakeRoot, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/');
}
+ /**
+ * @param string $path
+ */
private function runHooks($hooks, $path, $post = false) {
$path = $this->getHookPath($path);
$prefix = ($post) ? 'post_' : '';
diff --git a/lib/private/hooks/emitter.php b/lib/private/hooks/emitter.php
index 8e9074bad67..8d58dd936cc 100644
--- a/lib/private/hooks/emitter.php
+++ b/lib/private/hooks/emitter.php
@@ -20,6 +20,7 @@ interface Emitter {
* @param string $scope
* @param string $method
* @param callable $callback
+ * @return void
*/
public function listen($scope, $method, $callback);
@@ -27,6 +28,7 @@ interface Emitter {
* @param string $scope optional
* @param string $method optional
* @param callable $callback optional
+ * @return void
*/
public function removeListener($scope = null, $method = null, $callback = null);
}
diff --git a/lib/private/image.php b/lib/private/image.php
index 7761a3c7737..54232234fe7 100644
--- a/lib/private/image.php
+++ b/lib/private/image.php
@@ -396,7 +396,7 @@ class OC_Image {
/**
* @brief Loads an image from an open file handle.
* It is the responsibility of the caller to position the pointer at the correct place and to close the handle again.
- * @param $handle
+ * @param resource $handle
* @returns An image resource or false on error
*/
public function loadFromFileHandle($handle) {
@@ -563,7 +563,7 @@ class OC_Image {
* Create a new image from file or URL
* @link http://www.programmierer-forum.de/function-imagecreatefrombmp-laeuft-mit-allen-bitraten-t143137.htm
* @version 1.00
- * @param string $filename <p>
+ * @param string $fileName <p>
* Path to the BMP image.
* </p>
* @return resource an image resource identifier on success, <b>FALSE</b> on errors.
@@ -704,7 +704,7 @@ class OC_Image {
/**
* @brief Resizes the image preserving ratio.
- * @param $maxsize The maximum size of either the width or height.
+ * @param integer $maxsize The maximum size of either the width or height.
* @returns bool
*/
public function resize($maxSize) {
@@ -891,8 +891,7 @@ if ( ! function_exists( 'imagebmp') ) {
* @link http://www.programmierer-forum.de/imagebmp-gute-funktion-gefunden-t143716.htm
* @author mgutt <marc@gutt.it>
* @version 1.00
- * @param resource $image
- * @param string $filename [optional] <p>The path to save the file to.</p>
+ * @param string $fileName [optional] <p>The path to save the file to.</p>
* @param int $bit [optional] <p>Bit depth, (default is 24).</p>
* @param int $compression [optional]
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
@@ -1008,7 +1007,7 @@ if ( ! function_exists( 'exif_imagetype' ) ) {
/**
* Workaround if exif_imagetype does not exist
* @link http://www.php.net/manual/en/function.exif-imagetype.php#80383
- * @param string $filename
+ * @param string $fileName
* @return string|boolean
*/
function exif_imagetype ( $fileName ) {
diff --git a/lib/private/installer.php b/lib/private/installer.php
index 835b6b4c01a..43785adc006 100644
--- a/lib/private/installer.php
+++ b/lib/private/installer.php
@@ -55,6 +55,7 @@ class OC_Installer{
*
* It is the task of oc_app_install to create the tables and do whatever is
* needed to get the app working.
+ * @return string
*/
public static function installApp( $data = array()) {
$l = \OC_L10N::get('lib');
@@ -270,7 +271,7 @@ class OC_Installer{
/**
* @brief Check if an update for the app is available
* @param $name name of the application
- * @return boolean false or the version number of the update
+ * @return string|false false or the version number of the update
*
* The function will check if an update for a version is available
*/
@@ -313,7 +314,7 @@ class OC_Installer{
/**
* @brief Removes an app
- * @param $name name of the application to remove
+ * @param string $name name of the application to remove
* @param $options array with options
* @returns true/false
*
@@ -395,6 +396,7 @@ class OC_Installer{
* install an app already placed in the app folder
* @param string $app id of the app to install
* @returns array see OC_App::getAppInfo
+ * @return string
*/
public static function installShippedApp($app) {
//install the database
diff --git a/lib/private/json.php b/lib/private/json.php
index 5c5d7e3a3da..4ccdb490a6c 100644
--- a/lib/private/json.php
+++ b/lib/private/json.php
@@ -21,6 +21,7 @@ class OC_JSON{
/**
* Check if the app is enabled, send json error msg if not
+ * @param string $app
*/
public static function checkAppEnabled($app) {
if( !OC_App::isEnabled($app)) {
diff --git a/lib/private/l10n.php b/lib/private/l10n.php
index 98665c84c55..0aa949ba9be 100644
--- a/lib/private/l10n.php
+++ b/lib/private/l10n.php
@@ -529,6 +529,9 @@ class OC_L10N implements \OCP\IL10N {
return $available;
}
+ /**
+ * @param string $lang
+ */
public static function languageExists($app, $lang) {
if ($lang == 'en') {//english is always available
return true;
diff --git a/lib/private/l10n/string.php b/lib/private/l10n/string.php
index 88c85b32e70..04eaacab57b 100644
--- a/lib/private/l10n/string.php
+++ b/lib/private/l10n/string.php
@@ -27,6 +27,9 @@ class OC_L10N_String{
*/
protected $count;
+ /**
+ * @param OC_L10N $l10n
+ */
public function __construct($l10n, $text, $parameters, $count = 1) {
$this->l10n = $l10n;
$this->text = $text;
diff --git a/lib/private/mail.php b/lib/private/mail.php
index b339b33e962..90c3e343199 100644
--- a/lib/private/mail.php
+++ b/lib/private/mail.php
@@ -25,7 +25,7 @@ class OC_Mail {
* @param string $mailtext
* @param string $fromaddress
* @param string $fromname
- * @param bool|int $html
+ * @param integer $html
* @param string $altbody
* @param string $ccaddress
* @param string $ccname
diff --git a/lib/private/memcache/factory.php b/lib/private/memcache/factory.php
index 334cf9a1f0e..d60b157efe2 100644
--- a/lib/private/memcache/factory.php
+++ b/lib/private/memcache/factory.php
@@ -57,7 +57,7 @@ class Factory implements ICacheFactory {
* get a in-server cache instance, will return null if no backend is available
*
* @param string $prefix
- * @return \OC\Memcache\Cache
+ * @return null|Cache
*/
public static function createLowLatency($prefix = '') {
if (XCache::isAvailable()) {
diff --git a/lib/private/migrate.php b/lib/private/migrate.php
index 0b319177400..7266d7772cd 100644
--- a/lib/private/migrate.php
+++ b/lib/private/migrate.php
@@ -50,7 +50,7 @@ class OC_Migrate{
/**
* register a new migration provider
- * @param OC_Migrate_Provider $provider
+ * @param OC_Migration_Provider $provider
*/
public static function registerProvider($provider) {
self::$providers[]=$provider;
@@ -76,7 +76,7 @@ class OC_Migrate{
* @param optional $uid string user id of user to export if export type is user, defaults to current
* @param ootional $type string type of export, defualts to user
* @param otional $path string path to zip output folder
- * @return false on error, path to zip on success
+ * @return string on error, path to zip on success
*/
public static function export( $uid=null, $type='user', $path=null ) {
$datadir = OC_Config::getValue( 'datadirectory' );
@@ -311,7 +311,7 @@ class OC_Migrate{
/**
* @brief recursively deletes a directory
- * @param $dir string path of dir to delete
+ * @param string $dir string path of dir to delete
* $param optional $deleteRootToo bool delete the root directory
* @return bool
*/
@@ -429,7 +429,7 @@ class OC_Migrate{
/**
* @brief generates json containing export info, and merges any data supplied
* @param optional $array array of data to include in the returned json
- * @return bool
+ * @return string
*/
static private function getExportInfo( $array=array() ) {
$info = array(
@@ -602,7 +602,7 @@ class OC_Migrate{
/**
* @brief imports a new user
- * @param $db string path to migration.db
+ * @param string $db string path to migration.db
* @param $info object of migration info
* @param $uid optional uid to use
* @return array of apps with import statuses, or false on failure.
diff --git a/lib/private/migration/content.php b/lib/private/migration/content.php
index 4413d722731..81b53817433 100644
--- a/lib/private/migration/content.php
+++ b/lib/private/migration/content.php
@@ -34,9 +34,9 @@ class OC_Migration_Content{
/**
* @brief sets up the
- * @param $zip ZipArchive object
+ * @param ZipArchive $zip ZipArchive object
* @param optional $db a MDB2 database object (required for exporttype user)
- * @return bool
+ * @return boolean|null
*/
public function __construct( $zip, $db=null ) {
@@ -47,6 +47,10 @@ class OC_Migration_Content{
// @brief prepares the db
// @param $query the sql query to prepare
+
+ /**
+ * @param string $query
+ */
public function prepare( $query ) {
// Only add database to tmpfiles if actually used
@@ -179,7 +183,7 @@ class OC_Migration_Content{
/**
* @brief adds a directory to the zip object
- * @param $dir string path of the directory to add
+ * @param boolean|string $dir string path of the directory to add
* @param $recursive bool
* @param $internaldir string path of folder to add dir to in zip
* @return bool
@@ -214,8 +218,8 @@ class OC_Migration_Content{
/**
* @brief adds a file to the zip from a given string
- * @param $data string of data to add
- * @param $path the relative path inside of the zip to save the file to
+ * @param string $data string of data to add
+ * @param string $path the relative path inside of the zip to save the file to
* @return bool
*/
public function addFromString( $data, $path ) {
diff --git a/lib/private/ocs.php b/lib/private/ocs.php
index e067196cf11..41eb0b303ac 100644
--- a/lib/private/ocs.php
+++ b/lib/private/ocs.php
@@ -39,7 +39,10 @@ class OC_OCS {
* @param string Parameter to read
* @param string Variable type to format data
* @param mixed Default value to return if the key is not found
- * @return mixed Data or if the key is not found and no default is set it will exit with a 400 Bad request
+ * @param string $method
+ * @param string $key
+ * @param string $default
+ * @return string Data or if the key is not found and no default is set it will exit with a 400 Bad request
*/
public static function readData($method, $key, $type = 'raw', $default = null) {
if ($method == 'get') {
@@ -96,7 +99,7 @@ class OC_OCS {
/**
* generated some debug information to make it easier to find faild API calls
- * @return debug data string
+ * @return string data string
*/
private static function getDebugOutput() {
$txt='';
@@ -214,6 +217,9 @@ class OC_OCS {
}
}
+ /**
+ * @param string $node
+ */
public static function toXml($writer, $data, $node) {
foreach($data as $key => $value) {
if (is_numeric($key)) {
diff --git a/lib/private/ocsclient.php b/lib/private/ocsclient.php
index e35556d92b8..fa6e3fac1bb 100644
--- a/lib/private/ocsclient.php
+++ b/lib/private/ocsclient.php
@@ -50,6 +50,7 @@ class OC_OCSClient{
* @brief Get the content of an OCS url call.
* @returns string of the response
* This function calls an OCS server and returns the response. It also sets a sane timeout
+ * @param string $url
*/
private static function getOCSresponse($url) {
$data = \OC_Util::getUrlContent($url);
@@ -92,6 +93,8 @@ class OC_OCSClient{
* @returns array with application data
*
* This function returns a list of all the applications on the OCS server
+ * @param integer $page
+ * @param string $filter
*/
public static function getApplications($categories, $page, $filter) {
if(OC_Config::getValue('appstoreenabled', true)==false) {
@@ -184,6 +187,7 @@ class OC_OCSClient{
* @returns array with application data
*
* This function returns an download url for an applications from the OCS server
+ * @param integer $item
*/
public static function getApplicationDownload($id, $item) {
if(OC_Config::getValue('appstoreenabled', true)==false) {
diff --git a/lib/private/preview.php b/lib/private/preview.php
index ff93f438f73..80fd003ed8d 100755
--- a/lib/private/preview.php
+++ b/lib/private/preview.php
@@ -138,7 +138,7 @@ class Preview {
/**
* @brief returns the max scale factor
- * @return integer
+ * @return string
*/
public function getMaxScaleFactor() {
return $this->maxScaleFactor;
@@ -146,7 +146,7 @@ class Preview {
/**
* @brief returns the max width set in ownCloud's config
- * @return integer
+ * @return string
*/
public function getConfigMaxX() {
return $this->configMaxX;
@@ -154,7 +154,7 @@ class Preview {
/**
* @brief returns the max height set in ownCloud's config
- * @return integer
+ * @return string
*/
public function getConfigMaxY() {
return $this->configMaxY;
@@ -570,7 +570,6 @@ class Preview {
/**
* @brief register a new preview provider to be used
- * @param string $provider class name of a Preview_Provider
* @param array $options
* @return void
*/
@@ -619,6 +618,9 @@ class Preview {
$preview->deleteAllPreviews();
}
+ /**
+ * @param string $mimetype
+ */
public static function isMimeSupported($mimetype) {
if(!\OC_Config::getValue('enable_previews', true)) {
return false;
diff --git a/lib/private/preview/provider.php b/lib/private/preview/provider.php
index 65d09705f40..88337d64e4b 100644
--- a/lib/private/preview/provider.php
+++ b/lib/private/preview/provider.php
@@ -15,7 +15,7 @@ abstract class Provider {
* @param string $path Path of file
* @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
* @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
- * @param bool $scalingUp Disable/Enable upscaling of previews
+ * @param bool $scalingup Disable/Enable upscaling of previews
* @param object $fileview fileview object of user folder
* @return mixed
* false if no preview was generated
diff --git a/lib/private/request.php b/lib/private/request.php
index d9d5ae08e28..14144992388 100755
--- a/lib/private/request.php
+++ b/lib/private/request.php
@@ -86,6 +86,7 @@ class OC_Request {
*
* Returns the request uri, even if the website uses one or more
* reverse proxies
+ * @return string
*/
public static function requestUri() {
$uri = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '';
@@ -101,6 +102,7 @@ class OC_Request {
*
* Returns the script name, even if the website uses one or more
* reverse proxies
+ * @return string
*/
public static function scriptName() {
$name = $_SERVER['SCRIPT_NAME'];
@@ -115,6 +117,7 @@ class OC_Request {
/**
* @brief get Path info from request
* @returns string Path info or false when not found
+ * @return string
*/
public static function getPathInfo() {
if (array_key_exists('PATH_INFO', $_SERVER)) {
@@ -139,6 +142,7 @@ class OC_Request {
/**
* @brief get Path info from request, not urldecoded
* @returns string Path info or false when not found
+ * @return string
*/
public static function getRawPathInfo() {
$requestUri = $_SERVER['REQUEST_URI'];
diff --git a/lib/private/response.php b/lib/private/response.php
index 04746437347..5e941acbb4b 100644
--- a/lib/private/response.php
+++ b/lib/private/response.php
@@ -15,7 +15,7 @@ class OC_Response {
/**
* @brief Enable response caching by sending correct HTTP headers
- * @param $cache_time time to cache the response
+ * @param integer $cache_time time to cache the response
* >0 cache time in seconds
* 0 and <0 enable default browser caching
* null cache indefinitly
@@ -80,7 +80,7 @@ class OC_Response {
/**
* @brief Send redirect response
- * @param $location to redirect to
+ * @param string $location to redirect to
*/
static public function redirect($location) {
self::setStatus(self::STATUS_TEMPORARY_REDIRECT);
@@ -163,7 +163,7 @@ class OC_Response {
/**
* @brief Send file as response, checking and setting caching headers
- * @param $filepath of file to send
+ * @param string $filepath of file to send
*/
static public function sendFile($filepath) {
$fp = fopen($filepath, 'rb');
diff --git a/lib/private/search.php b/lib/private/search.php
index b9c75dfc333..70d670e048e 100644
--- a/lib/private/search.php
+++ b/lib/private/search.php
@@ -38,7 +38,6 @@ class OC_Search{
/**
* register a new search provider to be used
- * @param string $provider class name of a OC_Search_Provider
*/
public static function registerProvider($class, $options=array()) {
self::$registeredProviders[]=array('class'=>$class, 'options'=>$options);
diff --git a/lib/private/search/result.php b/lib/private/search/result.php
index 42275c2df11..ceefeab2dae 100644
--- a/lib/private/search/result.php
+++ b/lib/private/search/result.php
@@ -15,6 +15,7 @@ class OC_Search_Result{
* @param string $text some more information about the result
* @param string $link link for the result
* @param string $type the type of result as human readable string ('File', 'Music', etc)
+ * @param string $container
*/
public function __construct($name, $text, $link, $type, $container) {
$this->name=$name;
diff --git a/lib/private/session/memory.php b/lib/private/session/memory.php
index 134cee582ed..1b9ac452575 100644
--- a/lib/private/session/memory.php
+++ b/lib/private/session/memory.php
@@ -25,7 +25,7 @@ class Memory extends Session {
/**
* @param string $key
- * @param mixed $value
+ * @param integer $value
*/
public function set($key, $value) {
$this->data[$key] = $value;
diff --git a/lib/private/tags.php b/lib/private/tags.php
index fe7de1073a0..06550068f76 100644
--- a/lib/private/tags.php
+++ b/lib/private/tags.php
@@ -73,6 +73,7 @@ class Tags implements \OCP\ITags {
* Constructor.
*
* @param string $user The user whos data the object will operate on.
+ * @param string $type
*/
public function __construct($user, $type, $defaultTags = array()) {
$this->user = $user;
@@ -83,8 +84,6 @@ class Tags implements \OCP\ITags {
/**
* Load tags from db.
*
- * @param string $type The type identifier e.g. 'contact' or 'event'.
- * @param array $defaultTags An array of default tags to be used if none are stored.
*/
protected function loadTags($defaultTags=array()) {
$this->tags = array();
@@ -176,7 +175,7 @@ class Tags implements \OCP\ITags {
*
* Throws an exception if the tag could not be found.
*
- * @param string|integer $tag Tag id or name.
+ * @param string $tag Tag id or name.
* @return array An array of object ids or false on error.
*/
public function getIdsForTag($tag) {
@@ -235,7 +234,7 @@ class Tags implements \OCP\ITags {
* Add a new tag.
*
* @param string $name A string with a name of the tag
- * @return int the id of the added tag or false if it already exists.
+ * @return false|string the id of the added tag or false if it already exists.
*/
public function add($name) {
$name = trim($name);
@@ -512,7 +511,7 @@ class Tags implements \OCP\ITags {
* Creates a tag/object relation.
*
* @param int $objid The id of the object
- * @param int|string $tag The id or name of the tag
+ * @param string $tag The id or name of the tag
* @return boolean Returns false on database error.
*/
public function tagAs($objid, $tag) {
@@ -544,7 +543,7 @@ class Tags implements \OCP\ITags {
* Delete single tag/object relation from the db
*
* @param int $objid The id of the object
- * @param int|string $tag The id or name of the tag
+ * @param string $tag The id or name of the tag
* @return boolean
*/
public function unTag($objid, $tag) {
diff --git a/lib/private/template.php b/lib/private/template.php
index b2c3a20f281..c6851c6cc8d 100644
--- a/lib/private/template.php
+++ b/lib/private/template.php
@@ -156,6 +156,9 @@ class OC_Template extends \OC\Template\Base {
*
* Will select the template file for the selected theme and formfactor.
* Checking all the possible locations.
+ * @param string $theme
+ * @param string $app
+ * @param string $fext
*/
protected function findTemplate($theme, $app, $name, $fext) {
// Check if it is a app template or not.
@@ -182,7 +185,7 @@ class OC_Template extends \OC\Template\Base {
/**
* @brief Process the template
- * @return bool
+ * @return boolean|string
*
* This function process the template. If $this->renderas is set, it
* will produce a full page.
@@ -223,7 +226,7 @@ class OC_Template extends \OC\Template\Base {
* @param string $application The application we render the template for
* @param string $name Name of the template
* @param array $parameters Parameters for the template
- * @return bool
+ * @return boolean|null
*/
public static function printUserPage( $application, $name, $parameters = array() ) {
$content = new OC_Template( $application, $name, "user" );
diff --git a/lib/private/template/base.php b/lib/private/template/base.php
index 88941bc7132..e698d855a91 100644
--- a/lib/private/template/base.php
+++ b/lib/private/template/base.php
@@ -14,6 +14,11 @@ class Base {
private $l10n; // The l10n-Object
private $theme; // theme defaults
+ /**
+ * @param string $template
+ * @param \OC_L10N $l10n
+ * @param \OC_Defaults $theme
+ */
public function __construct( $template, $requesttoken, $l10n, $theme ) {
$this->vars = array();
$this->vars['requesttoken'] = $requesttoken;
@@ -22,6 +27,10 @@ class Base {
$this->theme = $theme;
}
+ /**
+ * @param string $serverroot
+ * @param string|false $app_dir
+ */
protected function getAppTemplateDirs($theme, $app, $serverroot, $app_dir) {
// Check if the app is in the app folder or in the root
if( file_exists($app_dir.'/templates/' )) {
@@ -36,6 +45,9 @@ class Base {
);
}
+ /**
+ * @param string $serverroot
+ */
protected function getCoreTemplateDirs($theme, $serverroot) {
return array(
$serverroot.'/themes/'.$theme.'/core/templates/',
@@ -63,7 +75,7 @@ class Base {
* @brief Appends a variable
* @param string $key key
* @param string $value value
- * @return bool
+ * @return boolean|null
*
* This function assigns a variable in an array context. If the key already
* exists, the value will be appended. It can be accessed via
@@ -97,7 +109,7 @@ class Base {
/**
* @brief Process the template
- * @return bool
+ * @return string
*
* This function processes the template.
*/
diff --git a/lib/private/template/functions.php b/lib/private/template/functions.php
index ce42633b364..a72d41f72da 100644
--- a/lib/private/template/functions.php
+++ b/lib/private/template/functions.php
@@ -78,6 +78,9 @@ function preview_icon( $path ) {
return OC_Helper::previewIcon( $path );
}
+/**
+ * @param string $path
+ */
function publicPreview_icon ( $path, $token ) {
return OC_Helper::publicPreviewIcon( $path, $token );
}
@@ -110,7 +113,7 @@ function strip_time($timestamp){
* @param int $timestamp timestamp to format
* @param int $fromTime timestamp to compare from, defaults to current time
* @param bool $dateOnly whether to strip time information
- * @return formatted timestamp
+ * @return OC_L10N_String timestamp
*/
function relative_modified_date($timestamp, $fromTime = null, $dateOnly = false) {
$l=OC_L10N::get('lib');
diff --git a/lib/private/template/resourcelocator.php b/lib/private/template/resourcelocator.php
index 9f83673664d..8a3dd5e7fa9 100644
--- a/lib/private/template/resourcelocator.php
+++ b/lib/private/template/resourcelocator.php
@@ -19,6 +19,10 @@ abstract class ResourceLocator {
protected $resources = array();
+ /**
+ * @param string $theme
+ * @param string $form_factor
+ */
public function __construct( $theme, $form_factor, $core_map, $party_map ) {
$this->theme = $theme;
$this->form_factor = $form_factor;
@@ -53,6 +57,10 @@ abstract class ResourceLocator {
* @param $file the filename
* @param $web base for path, default map $root to $webroot
*/
+ /**
+ * @param string $file
+ * @param string|false $webroot
+ */
protected function appendIfExist($root, $file, $webroot = null) {
if (is_file($root.'/'.$file)) {
if (!$webroot) {
diff --git a/lib/private/template/templatefilelocator.php b/lib/private/template/templatefilelocator.php
index d5a484b1a14..05cd752cd4f 100644
--- a/lib/private/template/templatefilelocator.php
+++ b/lib/private/template/templatefilelocator.php
@@ -13,11 +13,17 @@ class TemplateFileLocator {
protected $dirs;
private $path;
+ /**
+ * @param string[] $dirs
+ */
public function __construct( $form_factor, $dirs ) {
$this->form_factor = $form_factor;
$this->dirs = $dirs;
}
+ /**
+ * @param string $template
+ */
public function find( $template ) {
if ($template === '') {
throw new \InvalidArgumentException('Empty template name');
diff --git a/lib/private/templatelayout.php b/lib/private/templatelayout.php
index d5cd5039753..7bca5bc4836 100644
--- a/lib/private/templatelayout.php
+++ b/lib/private/templatelayout.php
@@ -7,6 +7,10 @@
*/
class OC_TemplateLayout extends OC_Template {
+
+ /**
+ * @param string $renderas
+ */
public function __construct( $renderas ) {
// Decide which page we show
diff --git a/lib/private/user.php b/lib/private/user.php
index 98ebebbe5c1..c78fb094c4d 100644
--- a/lib/private/user.php
+++ b/lib/private/user.php
@@ -219,7 +219,7 @@ class OC_User {
* @brief Try to login a user
* @param $uid The username of the user to log in
* @param $password The password of the user
- * @return bool
+ * @return boolean|null
*
* Log in a user and regenerate a new session - if the password is ok
*/
@@ -287,6 +287,7 @@ class OC_User {
/**
* @brief Sets user display name for session
+ * @param string $uid
*/
public static function setDisplayName($uid, $displayName = null) {
if (is_null($displayName)) {
@@ -478,7 +479,7 @@ class OC_User {
* @brief Check if the password is correct
* @param string $uid The username
* @param string $password The password
- * @return mixed user id a string on success, false otherwise
+ * @return string|false user id a string on success, false otherwise
*
* Check if the password is correct without logging in the user
* returns the user id or false
@@ -606,7 +607,7 @@ class OC_User {
/**
* @brief Returns the first active backend from self::$_usedBackends.
- * @return null if no backend active, otherwise OCP\Authentication\IApacheBackend
+ * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
*/
private static function findFirstActiveUsedBackend() {
foreach (self::$_usedBackends as $backend) {
diff --git a/lib/private/user/database.php b/lib/private/user/database.php
index 1a63755b980..094a8f2e2a4 100644
--- a/lib/private/user/database.php
+++ b/lib/private/user/database.php
@@ -236,7 +236,7 @@ class OC_User_Database extends OC_User_Backend {
/**
* @brief get the user's home directory
* @param string $uid the username
- * @return boolean
+ * @return string|false
*/
public function getHome($uid) {
if ($this->userExists($uid)) {
diff --git a/lib/private/user/dummy.php b/lib/private/user/dummy.php
index fc15a630cf3..2fb51d02de3 100644
--- a/lib/private/user/dummy.php
+++ b/lib/private/user/dummy.php
@@ -100,7 +100,7 @@ class OC_User_Dummy extends OC_User_Backend {
* @param string $search
* @param int $limit
* @param int $offset
- * @return array with all uids
+ * @return string[] with all uids
*
* Get a list of all users.
*/
diff --git a/lib/private/user/http.php b/lib/private/user/http.php
index e99afe59ba7..a0394521012 100644
--- a/lib/private/user/http.php
+++ b/lib/private/user/http.php
@@ -98,7 +98,7 @@ class OC_User_HTTP extends OC_User_Backend {
/**
* @brief get the user's home directory
* @param string $uid the username
- * @return boolean
+ * @return string|false
*/
public function getHome($uid) {
if($this->userExists($uid)) {
diff --git a/lib/private/user/interface.php b/lib/private/user/interface.php
index c72bdfaf3fd..cdcab3e5d00 100644
--- a/lib/private/user/interface.php
+++ b/lib/private/user/interface.php
@@ -30,6 +30,7 @@ interface OC_User_Interface {
*
* Returns the supported actions as int to be
* compared with OC_USER_BACKEND_CREATE_USER etc.
+ * @return boolean
*/
public function implementsActions($actions);
@@ -39,6 +40,7 @@ interface OC_User_Interface {
* @returns true/false
*
* Deletes a user
+ * @return boolean
*/
public function deleteUser($uid);
diff --git a/lib/private/user/manager.php b/lib/private/user/manager.php
index 90970ef9963..8583a451f2d 100644
--- a/lib/private/user/manager.php
+++ b/lib/private/user/manager.php
@@ -144,8 +144,8 @@ class Manager extends PublicEmitter {
/**
* Check if the password is valid for the user
*
- * @param $loginname
- * @param $password
+ * @param string $loginname
+ * @param string $password
* @return mixed the User object on success, false otherwise
*/
public function checkPassword($loginname, $password) {
diff --git a/lib/private/user/session.php b/lib/private/user/session.php
index 1e299416fb3..1740bad5abe 100644
--- a/lib/private/user/session.php
+++ b/lib/private/user/session.php
@@ -149,7 +149,7 @@ class Session implements Emitter, \OCP\IUserSession {
*
* @param string $uid
* @param string $password
- * @return bool
+ * @return boolean|null
*/
public function login($uid, $password) {
$this->manager->emit('\OC\User', 'preLogin', array($uid, $password));
diff --git a/lib/private/util.php b/lib/private/util.php
index 0585749d615..40a510ab1eb 100755
--- a/lib/private/util.php
+++ b/lib/private/util.php
@@ -90,6 +90,9 @@ class OC_Util {
return true;
}
+ /**
+ * @param string $user
+ */
public static function getUserQuota($user){
$userQuota = OC_Preferences::getValue($user, 'files', 'quota', 'default');
if($userQuota === 'default') {
@@ -513,6 +516,7 @@ class OC_Util {
/**
* @brief Check for correct file permissions of data directory
* @paran string $dataDirectory
+ * @param string $dataDirectory
* @return array arrays with error messages and hints
*/
public static function checkDataDirectoryPermissions($dataDirectory) {
@@ -625,7 +629,7 @@ class OC_Util {
/**
* @brief Check if the user is a subadmin, redirects to home if not
- * @return array $groups where the current user is subadmin
+ * @return null|boolean $groups where the current user is subadmin
*/
public static function checkSubAdminUser() {
OC_Util::checkLoggedIn();
@@ -924,7 +928,7 @@ class OC_Util {
/**
* @brief Check if the connection to the internet is disabled on purpose
- * @return bool
+ * @return string
*/
public static function isInternetConnectionEnabled(){
return \OC_Config::getValue("has_internet_connection", true);
@@ -1129,6 +1133,7 @@ class OC_Util {
}
/**
+ * @param boolean|string $file
* @return string
*/
public static function basename($file) {
diff --git a/lib/public/activity/imanager.php b/lib/public/activity/imanager.php
index 086e430d677..449fdcc934d 100644
--- a/lib/public/activity/imanager.php
+++ b/lib/public/activity/imanager.php
@@ -53,6 +53,7 @@ interface IManager {
* $callable has to return an instance of OCA\Activity\IConsumer
*
* @param \Closure $callable
+ * @return void
*/
function registerConsumer(\Closure $callable);
diff --git a/lib/public/app.php b/lib/public/app.php
index e0b5682242b..0cb22545362 100644
--- a/lib/public/app.php
+++ b/lib/public/app.php
@@ -92,8 +92,8 @@ class App {
/**
* Register a Configuration Screen that should appear in the Admin section.
- * @param $app string appid
- * @param $page string page to be included
+ * @param string $app string appid
+ * @param string $page string page to be included
*/
public static function registerAdmin( $app, $page ) {
\OC_App::registerAdmin( $app, $page );
@@ -112,6 +112,7 @@ class App {
/**
* checks whether or not an app is enabled
* @param string
+ * @param string $app
* @return boolean
*
* This function checks whether or not an app is enabled.
@@ -131,7 +132,7 @@ class App {
/**
* Get the last version of the app, either from appinfo/version or from appinfo/info.xml
* @param string
- * @return boolean
+ * @return string
*/
public static function getAppVersion( $app ) {
return \OC_App::getAppVersion( $app );
diff --git a/lib/public/appframework/http/response.php b/lib/public/appframework/http/response.php
index 0f5a18ca4fe..d223621d4fd 100644
--- a/lib/public/appframework/http/response.php
+++ b/lib/public/appframework/http/response.php
@@ -155,7 +155,7 @@ class Response {
/**
* Get "last modified" date
- * @return string RFC2822 formatted last modified date
+ * @return \DateTime RFC2822 formatted last modified date
*/
public function getLastModified() {
return $this->lastModified;
diff --git a/lib/public/appframework/iapi.php b/lib/public/appframework/iapi.php
index 963e870f79b..c4aeea2d4e5 100644
--- a/lib/public/appframework/iapi.php
+++ b/lib/public/appframework/iapi.php
@@ -45,6 +45,7 @@ interface IApi {
* Adds a new javascript file
* @param string $scriptName the name of the javascript in js/ without the suffix
* @param string $appName the name of the app, defaults to the current one
+ * @return void
*/
function addScript($scriptName, $appName = null);
@@ -53,6 +54,7 @@ interface IApi {
* Adds a new css file
* @param string $styleName the name of the css file in css/without the suffix
* @param string $appName the name of the app, defaults to the current one
+ * @return void
*/
function addStyle($styleName, $appName = null);
@@ -60,6 +62,7 @@ interface IApi {
/**
* shorthand for addScript for files in the 3rdparty directory
* @param string $name the name of the file without the suffix
+ * @return void
*/
function add3rdPartyScript($name);
@@ -67,6 +70,7 @@ interface IApi {
/**
* shorthand for addStyle for files in the 3rdparty directory
* @param string $name the name of the file without the suffix
+ * @return void
*/
function add3rdPartyStyle($name);
diff --git a/lib/public/appframework/iappcontainer.php b/lib/public/appframework/iappcontainer.php
index 7e6ec6016b7..e4f5f37cad2 100644
--- a/lib/public/appframework/iappcontainer.php
+++ b/lib/public/appframework/iappcontainer.php
@@ -66,8 +66,8 @@ interface IAppContainer extends IContainer{
function isAdminUser();
/**
- * @param $message
- * @param $level
+ * @param string $message
+ * @param string $level
* @return mixed
*/
function log($message, $level);
diff --git a/lib/public/backgroundjob.php b/lib/public/backgroundjob.php
index a7f54491dfa..dcf67da9570 100644
--- a/lib/public/backgroundjob.php
+++ b/lib/public/backgroundjob.php
@@ -59,7 +59,7 @@ class BackgroundJob {
* sets the background jobs execution type
*
* @param string $type execution type
- * @return boolean
+ * @return boolean|null
*
* This method sets the execution type of the background jobs. Possible types
* are "none", "ajax", "webcron", "cron"
@@ -69,7 +69,7 @@ class BackgroundJob {
}
/**
- * @param \OC\BackgroundJob\Job|string $job
+ * @param string $job
* @param mixed $argument
*/
public static function registerJob($job, $argument = null) {
@@ -82,7 +82,7 @@ class BackgroundJob {
* creates a regular task
* @param string $klass class name
* @param string $method method name
- * @return true
+ * @return boolean|null
*/
public static function addRegularTask($klass, $method) {
if (!\OC::needUpgrade()) {
@@ -115,7 +115,7 @@ class BackgroundJob {
* @deprecated
* Gets one queued task
* @param int $id ID of the task
- * @return associative array
+ * @return \OC\BackgroundJob\Job|null array
*/
public static function findQueuedTask($id) {
$jobList = new JobList();
@@ -170,7 +170,7 @@ class BackgroundJob {
* @param string $class class name
* @param string $method method name
* @param string $parameters all useful data as text
- * @return int id of task
+ * @return boolean id of task
*/
public static function addQueuedTask($app, $class, $method, $parameters) {
self::registerJob('OC\BackgroundJob\Legacy\QueuedJob', array('app' => $app, 'klass' => $class, 'method' => $method, 'parameters' => $parameters));
@@ -181,7 +181,7 @@ class BackgroundJob {
* @deprecated
* deletes a queued task
* @param int $id id of task
- * @return bool
+ * @return boolean|null
*
* Deletes a report
*/
diff --git a/lib/public/config.php b/lib/public/config.php
index d9355a0605f..2d450e0d0d2 100644
--- a/lib/public/config.php
+++ b/lib/public/config.php
@@ -89,7 +89,7 @@ class Config {
* @param string $app app
* @param string $key key
* @param string $value value
- * @return string true/false
+ * @return boolean true/false
*
* Sets a value. If the key did not exist before it will be created.
*/
diff --git a/lib/public/contacts/imanager.php b/lib/public/contacts/imanager.php
index 973d48be5ec..da9bca75525 100644
--- a/lib/public/contacts/imanager.php
+++ b/lib/public/contacts/imanager.php
@@ -96,7 +96,7 @@ namespace OCP\Contacts {
* This function can be used to delete the contact identified by the given id
*
* @param object $id the unique identifier to a contact
- * @param $address_book_key
+ * @param $address_book_key
* @return bool successful or not
*/
function delete($id, $address_book_key);
@@ -106,7 +106,7 @@ namespace OCP\Contacts {
* Otherwise the contact will be updated by replacing the entire data set.
*
* @param array $properties this array if key-value-pairs defines a contact
- * @param $address_book_key string to identify the address book in which the contact shall be created or updated
+ * @param $address_book_key string to identify the address book in which the contact shall be created or updated
* @return array representing the contact just created or updated
*/
function createOrUpdate($properties, $address_book_key);
@@ -122,6 +122,7 @@ namespace OCP\Contacts {
* Registers an address book
*
* @param \OCP\IAddressBook $address_book
+ * @return void
*/
function registerAddressBook(\OCP\IAddressBook $address_book);
@@ -129,6 +130,7 @@ namespace OCP\Contacts {
* Unregisters an address book
*
* @param \OCP\IAddressBook $address_book
+ * @return void
*/
function unregisterAddressBook(\OCP\IAddressBook $address_book);
@@ -138,6 +140,7 @@ namespace OCP\Contacts {
*
* @param string $key
* @param \Closure $callable
+ * @return void
*/
function register($key, \Closure $callable);
@@ -148,6 +151,7 @@ namespace OCP\Contacts {
/**
* removes all registered address book instances
+ * @return void
*/
function clear();
}
diff --git a/lib/public/db.php b/lib/public/db.php
index 4a19d78d444..adb1f14cc4d 100644
--- a/lib/public/db.php
+++ b/lib/public/db.php
@@ -39,7 +39,7 @@ class DB {
* @param string $query Query string
* @param int $limit Limit of the SQL statement
* @param int $offset Offset of the SQL statement
- * @return \Doctrine\DBAL\Statement prepared SQL query
+ * @return \OC_DB_StatementWrapper prepared SQL query
*
* SQL query via Doctrine prepare(), needs to be execute()'d!
*/
@@ -49,7 +49,7 @@ class DB {
/**
* Insert a row if a matching row doesn't exists.
- * @param $table string The table name (will replace *PREFIX*) to perform the replace on.
+ * @param string $table string The table name (will replace *PREFIX*) to perform the replace on.
* @param $input array
*
* The input array if in the form:
@@ -70,8 +70,8 @@ class DB {
/**
* Gets last value of autoincrement
- * @param $table string The optional table name (will replace *PREFIX*) and add sequence suffix
- * @return int
+ * @param string $table string The optional table name (will replace *PREFIX*) and add sequence suffix
+ * @return string
*
* \Doctrine\DBAL\Connection lastInsertID()
*
diff --git a/lib/public/files.php b/lib/public/files.php
index d36d74fdf77..bc8fe2b7997 100644
--- a/lib/public/files.php
+++ b/lib/public/files.php
@@ -109,6 +109,7 @@ class Files {
* Gets the Storage for an app - creates the needed folder if they are not
* existant
* @param string appid
+ * @param string $app
* @return \OC\Files\View
*/
public static function getStorage( $app ) {
diff --git a/lib/public/files/file.php b/lib/public/files/file.php
index c6cda59f9b0..6208aeff426 100644
--- a/lib/public/files/file.php
+++ b/lib/public/files/file.php
@@ -43,6 +43,7 @@ interface File extends Node {
*
* @param string $data
* @throws \OCP\Files\NotPermittedException
+ * @return void
*/
public function putContent($data);
diff --git a/lib/public/files/node.php b/lib/public/files/node.php
index 972b1cfa492..a380394095b 100644
--- a/lib/public/files/node.php
+++ b/lib/public/files/node.php
@@ -41,6 +41,7 @@ interface Node {
/**
* Delete the file or folder
+ * @return void
*/
public function delete();
@@ -58,6 +59,7 @@ interface Node {
*
* @param int $mtime (optional) modified date as unix timestamp
* @throws \OCP\Files\NotPermittedException
+ * @return void
*/
public function touch($mtime = null);
diff --git a/lib/public/files/storage.php b/lib/public/files/storage.php
index 194b42a6481..01a15851d46 100644
--- a/lib/public/files/storage.php
+++ b/lib/public/files/storage.php
@@ -39,6 +39,7 @@ interface Storage {
* $parameters is a free form array with the configuration options needed to construct the storage
*
* @param array $parameters
+ * @return void
*/
public function __construct($parameters);
diff --git a/lib/public/iavatar.php b/lib/public/iavatar.php
index 2cbec0d45c3..43fa32556de 100644
--- a/lib/public/iavatar.php
+++ b/lib/public/iavatar.php
@@ -22,7 +22,7 @@ interface IAvatar {
/**
* @brief sets the users avatar
- * @param $data mixed imagedata or path to set a new avatar
+ * @param Image $data mixed imagedata or path to set a new avatar
* @throws Exception if the provided file is not a jpg or png image
* @throws Exception if the provided image is not valid
* @throws \OCP\NotSquareException if the image is not square
diff --git a/lib/public/iconfig.php b/lib/public/iconfig.php
index 1d0f8e0015c..f1124a2dd0b 100644
--- a/lib/public/iconfig.php
+++ b/lib/public/iconfig.php
@@ -59,6 +59,7 @@ interface IConfig {
* @param string $appName the appName that we want to store the value under
* @param string $key the key of the value, under which will be saved
* @param string $value the value that should be stored
+ * @return void
*/
public function setAppValue($appName, $key, $value);
@@ -80,6 +81,7 @@ interface IConfig {
* @param string $appName the appName that we want to store the value under
* @param string $key the key under which the value is being stored
* @param string $value the value that you want to store
+ * @return void
*/
public function setUserValue($userId, $appName, $key, $value);
@@ -90,6 +92,7 @@ interface IConfig {
* @param string $appName the appName that we stored the value under
* @param string $key the key under which the value is being stored
* @param string $default the default value to be returned if the value isn't set
+ * @return string
*/
public function getUserValue($userId, $appName, $key, $default = '');
}
diff --git a/lib/public/il10n.php b/lib/public/il10n.php
index 817b299b0b7..1c025e7824f 100644
--- a/lib/public/il10n.php
+++ b/lib/public/il10n.php
@@ -25,7 +25,7 @@ interface IL10N {
* Translating
* @param $text String The text we need a translation for
* @param array $parameters default:array() Parameters for sprintf
- * @return \OC_L10N_String|string Translation or the same text
+ * @return \OC_L10N_String Translation or the same text
*
* Returns the translation. If no translation is found, $text will be
* returned.
@@ -38,7 +38,7 @@ interface IL10N {
* @param $text_plural String the string to translate for n objects
* @param $count Integer Number of objects
* @param array $parameters default:array() Parameters for sprintf
- * @return \OC_L10N_String|string Translation or the same text
+ * @return \OC_L10N_String Translation or the same text
*
* Returns the translation. If no translation is found, $text will be
* returned. %n will be replaced with the number of objects.
diff --git a/lib/public/inavigationmanager.php b/lib/public/inavigationmanager.php
index 73e85d03761..9497d3fd08e 100644
--- a/lib/public/inavigationmanager.php
+++ b/lib/public/inavigationmanager.php
@@ -37,12 +37,14 @@ interface INavigationManager {
/**
* Creates a new navigation entry
* @param array $entry containing: id, name, order, icon and href key
+ * @return void
*/
public function add(array $entry);
/**
* Sets the current navigation entry of the currently running app
* @param string $appId id of the app entry to activate (from added $entry)
+ * @return void
*/
public function setActiveEntry($appId);
}
diff --git a/lib/public/irequest.php b/lib/public/irequest.php
index ca23e12b7f5..d77a9bc887a 100644
--- a/lib/public/irequest.php
+++ b/lib/public/irequest.php
@@ -55,6 +55,11 @@ namespace OCP;
interface IRequest {
+ /**
+ * @param string $name
+ *
+ * @return string
+ */
function getHeader($name);
/**
diff --git a/lib/public/itags.php b/lib/public/itags.php
index ea62fb38ecb..7965d4152f9 100644
--- a/lib/public/itags.php
+++ b/lib/public/itags.php
@@ -49,7 +49,7 @@ interface ITags {
/**
* Check if any tags are saved for this type and user.
*
- * @return boolean.
+ * @return boolean
*/
public function isEmpty();
diff --git a/lib/public/iusersession.php b/lib/public/iusersession.php
index 131b326ab90..adc706cc7c3 100644
--- a/lib/public/iusersession.php
+++ b/lib/public/iusersession.php
@@ -45,6 +45,7 @@ interface IUserSession {
/**
* Logs the user out including all the session data
* Logout, destroys session
+ * @return void
*/
public function logout();
diff --git a/lib/public/json.php b/lib/public/json.php
index cd5d233ef90..e7371ad63f3 100644
--- a/lib/public/json.php
+++ b/lib/public/json.php
@@ -81,7 +81,7 @@ class JSON {
* parameter to the ajax call, then assign it to the template and finally
* add a hidden input field also named 'requesttoken' containing the value.
*
- * @return string json formatted error string if not valid.
+ * @return \json|null json formatted error string if not valid.
*/
public static function callCheck() {
return(\OC_JSON::callCheck());
diff --git a/lib/public/share.php b/lib/public/share.php
index f832d04a70f..bc8a54bc350 100644
--- a/lib/public/share.php
+++ b/lib/public/share.php
@@ -78,7 +78,7 @@ class Share {
* @param string Backend class
* @param string (optional) Depends on item type
* @param array (optional) List of supported file extensions if this item type depends on files
- * @return Returns true if backend is registered or false if error
+ * @return boolean true if backend is registered or false if error
*/
public static function registerBackend($itemType, $class, $collectionOf = null, $supportedFileExtensions = null) {
if (self::isEnabled()) {
@@ -104,7 +104,7 @@ class Share {
/**
* Check if the Share API is enabled
- * @return Returns true if enabled or false
+ * @return boolean true if enabled or false
*
* The Share API is enabled by default if not configured
*/
@@ -135,7 +135,7 @@ class Share {
/**
* Find which users can access a shared item
- * @param $path to the file
+ * @param string $path to the file
* @param $user owner of the file
* @param include owner to the list of users with access to the file
* @return array
@@ -247,6 +247,7 @@ class Share {
* @param mixed Parameters (optional)
* @param int Number of items to return (optional) Returns all by default
* @param bool include collections (optional)
+ * @param string $itemType
* @return Return depends on format
*/
public static function getItemsSharedWith($itemType, $format = self::FORMAT_NONE,
@@ -262,7 +263,7 @@ class Share {
* @param int $format (optional) Format type must be defined by the backend
* @param mixed Parameters (optional)
* @param bool include collections (optional)
- * @return Return depends on format
+ * @return string depends on format
*/
public static function getItemSharedWith($itemType, $itemTarget, $format = self::FORMAT_NONE,
$parameters = null, $includeCollections = false) {
@@ -646,7 +647,7 @@ class Share {
* @param string Item source
* @param int SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
* @param string User or group the item is being shared with
- * @return Returns true on success or false on failure
+ * @return boolean true on success or false on failure
*/
public static function unshare($itemType, $itemSource, $shareType, $shareWith) {
if ($item = self::getItems($itemType, $itemSource, $shareType, $shareWith, \OC_User::getUser(),
@@ -661,7 +662,7 @@ class Share {
* Unshare an item from all users, groups, and remove all links
* @param string Item type
* @param string Item source
- * @return Returns true on success or false on failure
+ * @return boolean true on success or false on failure
*/
public static function unshareAll($itemType, $itemSource) {
// Get all of the owners of shares of this item.
@@ -693,7 +694,7 @@ class Share {
* Unshare an item shared with the current user
* @param string Item type
* @param string Item target
- * @return Returns true on success or false on failure
+ * @return boolean true on success or false on failure
*
* Unsharing from self is not allowed for items inside collections
*/
@@ -754,7 +755,8 @@ class Share {
* @param int SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
* @param string User or group the item is being shared with
* @param int CRUDS permissions
- * @return Returns true on success or false on failure
+ * @param integer|null $permissions
+ * @return boolean true on success or false on failure
*/
public static function setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions) {
if ($item = self::getItems($itemType, $itemSource, $shareType, $shareWith,
@@ -836,7 +838,7 @@ class Share {
* @param string $itemType
* @param string $itemSource
* @param string $date expiration date
- * @return Share_Backend
+ * @return boolean
*/
public static function setExpirationDate($itemType, $itemSource, $date) {
if ($items = self::getItems($itemType, $itemSource, null, null, \OC_User::getUser(),
@@ -930,7 +932,7 @@ class Share {
/**
* Check if resharing is allowed
- * @return Returns true if allowed or false
+ * @return boolean true if allowed or false
*
* Resharing is allowed by default if not configured
*/
@@ -1389,6 +1391,11 @@ class Share {
* @param bool|array Parent folder target (optional)
* @param string token (optional)
* @param string name of the source item (optional)
+ * @param string $itemType
+ * @param string $itemSource
+ * @param integer $shareType
+ * @param integer $permissions
+ * @param string $itemSourceName
* @return bool Returns true on success or false on failure
*/
private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
@@ -1936,7 +1943,7 @@ interface Share_Backend {
* Get the source of the item to be stored in the database
* @param string Item source
* @param string Owner of the item
- * @return mixed|array|false Source
+ * @return boolean Source
*
* Return an array if the item is file dependent, the array needs two keys: 'item' and 'file'
* Return false if the item does not exist for the user
@@ -1961,6 +1968,7 @@ interface Share_Backend {
* Converts the shared item sources back into the item in the specified format
* @param array Shared items
* @param int Format
+ * @param integer $format
* @return TODO
*
* The items array is a 3-dimensional array with the item_source as the
@@ -1992,6 +2000,7 @@ interface Share_Backend_File_Dependent extends Share_Backend {
* Get the file path of the item
* @param string Item source
* @param string User that is the owner of shared item
+ * @return boolean
*/
public function getFilePath($itemSource, $uidOwner);
diff --git a/lib/public/template.php b/lib/public/template.php
index 320b7c6393f..0d86acbd060 100644
--- a/lib/public/template.php
+++ b/lib/public/template.php
@@ -35,7 +35,7 @@ namespace OCP;
* Make OC_Helper::imagePath available as a simple function
* @param string app
* @param string image
- * @return link to the image
+ * @return string to the image
*
* @see OC_Helper::imagePath
*/
@@ -47,7 +47,7 @@ function image_path( $app, $image ) {
/**
* Make OC_Helper::mimetypeIcon available as a simple function
* @param string mimetype
- * @return path to the image of this file type.
+ * @return string to the image of this file type.
*/
function mimetype_icon( $mimetype ) {
return(\mimetype_icon( $mimetype ));
@@ -56,7 +56,7 @@ function mimetype_icon( $mimetype ) {
/**
* Make preview_icon available as a simple function
* @param string path of file
- * @return path to the preview of the image
+ * @return string to the preview of the image
*/
function preview_icon( $path ) {
return(\preview_icon( $path ));
@@ -67,6 +67,7 @@ function preview_icon( $path ) {
* Returns the path to the preview of the image.
* @param string path of file
* @param string token
+ * @param string $path
* @return link to the preview
*/
function publicPreview_icon ( $path, $token ) {
@@ -77,7 +78,7 @@ function publicPreview_icon ( $path, $token ) {
* Make OC_Helper::humanFileSize available as a simple function
* Example: 2048 to 2 kB.
* @param int size in bytes
- * @return size as string
+ * @return string as string
*/
function human_file_size( $bytes ) {
return(\human_file_size( $bytes ));
@@ -88,7 +89,7 @@ function human_file_size( $bytes ) {
* Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
* @param int unix timestamp
* @param boolean date only
- * @return human readable interpretation of the timestamp
+ * @return OC_L10N_String readable interpretation of the timestamp
*/
function relative_modified_date( $timestamp, $dateOnly = false ) {
return(\relative_modified_date($timestamp, null, $dateOnly));
@@ -99,7 +100,7 @@ function relative_modified_date( $timestamp, $dateOnly = false ) {
* Return a human readable outout for a file size.
* @deprecated human_file_size() instead
* @param integer size of a file in byte
- * @return human readable interpretation of a file size
+ * @return string readable interpretation of a file size
*/
function simple_file_size($bytes) {
return(\human_file_size($bytes));
@@ -111,7 +112,7 @@ function simple_file_size($bytes) {
* @param $options the options
* @param $selected which one is selected?
* @param array the parameters
- * @return html options
+ * @return string options
*/
function html_select_options($options, $selected, $params=array()) {
return(\html_select_options($options, $selected, $params));
diff --git a/lib/public/user.php b/lib/public/user.php
index acc0e3b737b..3f98a636a01 100644
--- a/lib/public/user.php
+++ b/lib/public/user.php
@@ -48,6 +48,8 @@ class User {
* @param string search pattern
* @param int limit
* @param int offset
+ * @param integer $limit
+ * @param integer $offset
* @return array with all uids
*/
public static function getUsers( $search = '', $limit = null, $offset = null ) {
@@ -103,7 +105,9 @@ class User {
* Check if the password is correct
* @param string The username
* @param string The password
- * @return mixed username on success, false otherwise
+ * @param string $uid
+ * @param string $password
+ * @return string|false username on success, false otherwise
*
* Check if the password is correct without logging in the user
*/
--
GitLab