nextcloud / server

lib/private/Files/Filesystem.php

Doc Comments +28 added lines, -2 removed lines

@@ -338,6 +338,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $root
+	 */
 	static public function init($user, $root) {
 		if (self::$defaultInstance) {
 			return false;
@@ -521,7 +524,7 @@ 
 	/**
 	 * mount an \OC\Files\Storage\Storage in our virtual filesystem
 	 *
-	 * @param \OC\Files\Storage\Storage|string $class
+	 * @param string $class
 	 * @param array $arguments
 	 * @param string $mountpoint
 	 */
@@ -653,6 +656,9 @@ 
 		return self::$defaultInstance->is_dir($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function is_file($path) {
 		return self::$defaultInstance->is_file($path);
 	}
@@ -665,6 +671,9 @@ 
 		return self::$defaultInstance->filetype($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function filesize($path) {
 		return self::$defaultInstance->filesize($path);
 	}
@@ -677,6 +686,9 @@ 
 		return self::$defaultInstance->isCreatable($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function isReadable($path) {
 		return self::$defaultInstance->isReadable($path);
 	}
@@ -689,6 +701,9 @@ 
 		return self::$defaultInstance->isDeletable($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function isSharable($path) {
 		return self::$defaultInstance->isSharable($path);
 	}
@@ -706,6 +721,7 @@ 
 	}
 
 	/**
+	 * @param string $path
 	 * @return string
 	 */
 	static public function file_get_contents($path) {
@@ -728,6 +744,10 @@ 
 		return self::$defaultInstance->copy($path1, $path2);
 	}
 
+	/**
+	 * @param string $path
+	 * @param string $mode
+	 */
 	static public function fopen($path, $mode) {
 		return self::$defaultInstance->fopen($path, $mode);
 	}
@@ -743,6 +763,9 @@ 
 		return self::$defaultInstance->fromTmpFile($tmpFile, $path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function getMimeType($path) {
 		return self::$defaultInstance->getMimeType($path);
 	}
@@ -755,6 +778,9 @@ 
 		return self::$defaultInstance->free_space($path);
 	}
 
+	/**
+	 * @param string $query
+	 */
 	static public function search($query) {
 		return self::$defaultInstance->search($query);
 	}
@@ -868,7 +894,7 @@ 
 	 * @param string $path
 	 * @param boolean $includeMountPoints whether to add mountpoint sizes,
 	 * defaults to true
-	 * @return \OC\Files\FileInfo|bool False if file does not exist
+	 * @return \OCP\Files\FileInfo|null False if file does not exist
 	 */
 	public static function getFileInfo($path, $includeMountPoints = true) {
 		return self::$defaultInstance->getFileInfo($path, $includeMountPoints);

apps/dav/lib/SystemTag/SystemTagsObjectMappingCollection.php

Doc Comments +3 added lines

@@ -89,6 +89,9 @@
 		$this->user = $user;
 	}
 
+	/**
+	 * @param string $tagId
+	 */
 	function createFile($tagId, $data = null) {
 		try {
 			$tags = $this->tagManager->getTagsByIds([$tagId]);

lib/private/DB/Migrator.php

Doc Comments +8 added lines

@@ -273,6 +273,10 @@ 
 		return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
 	}
 
+	/**
+	 * @param integer $step
+	 * @param integer $max
+	 */
 	protected function emit($sql, $step, $max) {
 		if ($this->noEmit) {
 			return;
@@ -283,6 +287,10 @@ 
 		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step+1, $max]));
 	}
 
+	/**
+	 * @param integer $step
+	 * @param integer $max
+	 */
 	private function emitCheckStep($tableName, $step, $max) {
 		if(is_null($this->dispatcher)) {
 			return;

lib/private/User/Session.php

Doc Comments +4 added lines, -1 removed lines

@@ -300,7 +300,7 @@ 
 	 * @param IRequest $request
 	 * @throws LoginException
 	 * @throws PasswordLoginForbiddenException
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function logClientIn($user, $password, IRequest $request) {
 		$isTokenPassword = $this->isTokenPassword($password);
@@ -340,6 +340,9 @@ 
 		return $this->config->getSystemValue('token_auth_enforced', false);
 	}
 
+	/**
+	 * @param string $username
+	 */
 	protected function isTwoFactorEnforced($username) {
 		Util::emitHook(
 			'\OCA\Files_Sharing\API\Server2Server',

apps/federatedfilesharing/lib/RequestHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -567,7 +567,7 @@
 	/**
 	 * update permissions in database
 	 *
-	 * @param IShare $share
+	 * @param Share\IShare $share
 	 * @param int $permissions
 	 */
 	protected function updatePermissionsInDatabase(IShare $share, $permissions) {

apps/user_ldap/lib/Access.php

Doc Comments +9 added lines, -7 removed lines

@@ -397,7 +397,7 @@ 
 
 	/**
 	 * returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure
-	 * @param string $dn the dn of the user object
+	 * @param string $fdn the dn of the user object
 	 * @param string $ldapName optional, the display name of the object
 	 * @return string|false with with the name to use in ownCloud
 	 */
@@ -414,7 +414,7 @@ 
 
 	/**
 	 * returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN
-	 * @param string $dn the dn of the user object
+	 * @param string $fdn the dn of the user object
 	 * @param string $ldapName optional, the display name of the object
 	 * @param bool $isUser optional, whether it is a user object (otherwise group assumed)
 	 * @return string|false with with the name to use in ownCloud
@@ -674,7 +674,7 @@ 
 	 * the login filter.
 	 *
 	 * @param string $loginName
-	 * @param array $attributes optional, list of attributes to read
+	 * @param string[] $attributes optional, list of attributes to read
 	 * @return array
 	 */
 	public function fetchUsersByLoginName($loginName, $attributes = array('dn')) {
@@ -747,7 +747,7 @@ 
 
 	/**
 	 * @param string $filter
-	 * @param string|string[] $attr
+	 * @param string[] $attr
 	 * @param int $limit
 	 * @param int $offset
 	 * @return array
@@ -795,7 +795,7 @@ 
 
 	/**
 	 * @param string $filter
-	 * @param string|string[] $attr
+	 * @param string[] $attr
 	 * @param int $limit
 	 * @param int $offset
 	 * @return false|int
@@ -845,6 +845,7 @@ 
 	 * retrieved. Results will according to the order in the array.
 	 * @param int $limit optional, maximum results to be counted
 	 * @param int $offset optional, a starting point
+	 * @param string $filter
 	 * @return array|false array with the search result as first value and pagedSearchOK as
 	 * second | false if not successful
 	 */
@@ -891,7 +892,7 @@ 
 	 * @param bool $pagedSearchOK whether a paged search has been executed
 	 * @param bool $skipHandling required for paged search when cookies to
 	 * prior results need to be gained
-	 * @return bool cookie validity, true if we have more pages, false otherwise.
+	 * @return null|boolean cookie validity, true if we have more pages, false otherwise.
 	 */
 	private function processPagedSearchStatus($sr, $filter, $base, $iFoundItems, $limit, $offset, $pagedSearchOK, $skipHandling) {
 		$cookie = null;
@@ -1100,7 +1101,7 @@ 
 
 	/**
 	 * @param string $name
-	 * @return bool|mixed|string
+	 * @return string
 	 */
 	public function sanitizeUsername($name) {
 		if($this->connection->ldapIgnoreNamingRules) {
@@ -1124,6 +1125,7 @@ 
 	* escapes (user provided) parts for LDAP filter
 	* @param string $input, the provided value
 	* @param bool $allowAsterisk whether in * at the beginning should be preserved
+	* @param string $input
 	* @return string the escaped string
 	*/
 	public function escapeFilterPart($input, $allowAsterisk = false) {

apps/user_ldap/lib/Wizard.php

Doc Comments +1 added lines, -1 removed lines

@@ -1104,7 +1104,7 @@
 	}
 
 	/**
-	 * @param array $reqs
+	 * @param string[] $reqs
 	 * @return bool
 	 */
 	private function checkRequirements($reqs) {

lib/private/Files/Cache/Wrapper/CacheJail.php

Doc Comments +4 added lines, -1 removed lines

@@ -71,7 +71,7 @@ 
 
 	/**
 	 * @param array $entry
-	 * @return array
+	 * @return string
 	 */
 	protected function formatCacheEntry($entry) {
 		if (isset($entry['path'])) {
@@ -190,6 +190,9 @@ 
 		return $this->cache->getStatus($this->getSourcePath($file));
 	}
 
+	/**
+	 * @param \OCP\Files\Cache\ICacheEntry[] $results
+	 */
 	private function formatSearchResults($results) {
 		$results = array_filter($results, array($this, 'filterCacheEntry'));
 		$results = array_values($results);

lib/private/IntegrityCheck/Helpers/FileAccessHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
 	 * Wrapper around file_put_contents($filename, $data)
 	 *
 	 * @param string $filename
-	 * @param $data
+	 * @param string $data
 	 * @return int|false
 	 */
 	public function file_put_contents($filename, $data) {