Merge pull request #22253 from nextcloud/debt/noid/docblocks

Fix some MissingDocblockType or InvalidDocblock warnings.
This commit is contained in:
Morris Jobke 2020-08-17 17:45:11 +02:00 committed by GitHub
commit 00cb8e6c54
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
19 changed files with 30 additions and 34 deletions

View File

@ -37,6 +37,7 @@ use OCP\AppFramework\OCSController;
use OCP\IConfig;
use OCP\IRequest;
use OCP\IUserSession;
use OCP\PreConditionNotMetException;
class ConfigController extends OCSController {
@ -103,7 +104,7 @@ class ConfigController extends OCSController {
*
* @param string $key theme or font
* @return DataResponse
* @throws Exception
* @throws OCSBadRequestException|PreConditionNotMetException
*/
public function setConfig(string $key, $value): DataResponse {
if ($key === 'theme' || $key === 'font' || $key === 'highcontrast') {
@ -137,7 +138,7 @@ class ConfigController extends OCSController {
*
* @param string $key theme or font
* @return DataResponse
* @throws Exception
* @throws OCSBadRequestException
*/
public function deleteConfig(string $key): DataResponse {
if ($key === 'theme' || $key === 'font' || $key === 'highcontrast') {

View File

@ -325,7 +325,7 @@ EOF;
* Returns a list of addresses that are associated with a principal.
*
* @param string $principal
* @return string?
* @return string|null
*/
protected function getCalendarUserTypeForPrincipal($principal):?string {
$calendarUserType = '{' . self::NS_CALDAV . '}calendar-user-type';

View File

@ -82,7 +82,6 @@ class AddressBookImpl implements IAddressBook {
/**
* @return string defining the unique uri
* @since 16.0.0
* @return string
*/
public function getUri(): string {
return $this->addressBookInfo['uri'];

View File

@ -36,6 +36,7 @@ use OCP\Files\SimpleFS\ISimpleFile;
use OCP\Files\SimpleFS\ISimpleFolder;
use OCP\ILogger;
use Sabre\CardDAV\Card;
use Sabre\VObject\Parameter;
use Sabre\VObject\Property\Binary;
use Sabre\VObject\Reader;

View File

@ -276,7 +276,6 @@ class FilesPlugin extends ServerPlugin {
if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
//Add OC-Checksum header
/** @var $node File */
$checksum = $node->getChecksum();
if ($checksum !== null && $checksum !== '') {
$response->addHeader('OC-Checksum', $checksum);
@ -383,7 +382,6 @@ class FilesPlugin extends ServerPlugin {
if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
$propFind->handle(self::DOWNLOADURL_PROPERTYNAME, function () use ($node) {
/** @var $node \OCA\DAV\Connector\Sabre\File */
try {
$directDownloadUrl = $node->getDirectDownload();
if (isset($directDownloadUrl['url'])) {

View File

@ -26,6 +26,7 @@ namespace OCA\Encryption;
use OCA\Encryption\Hooks\Contracts\IHook;
class HookManager {
/** @var IHook[] */
private $hookInstances = [];
/**
@ -51,8 +52,6 @@ class HookManager {
foreach ($this->hookInstances as $instance) {
/**
* Fire off the add hooks method of each instance stored in cache
*
* @var $instance IHook
*/
$instance->addHooks();
}

View File

@ -332,7 +332,7 @@ class ApiController extends Controller {
*
* @NoAdminRequired
*
* @param string
* @param string $folderpath
* @return string
* @throws \OCP\Files\NotFoundException
*/

View File

@ -1,4 +1,4 @@
<?php /** @var $l \OCP\IL10N */ ?>
<?php /** @var \OCP\IL10N $l */ ?>
<?php $_['appNavigation']->printPage(); ?>
<div id="app-content">

View File

@ -1,4 +1,4 @@
<?php /** @var $l \OCP\IL10N */ ?>
<?php /** @var \OCP\IL10N $l */ ?>
<div id='notification'></div>
<div id="emptycontent" class="hidden"></div>

View File

@ -97,15 +97,13 @@ class ListCommand extends Base {
}
protected function execute(InputInterface $input, OutputInterface $output): int {
/** @var StorageConfig[] $mounts */
if ($input->getOption('all')) {
/** @var $mounts StorageConfig[] */
$mounts = $this->globalService->getStorageForAllUsers();
$userId = self::ALL;
} else {
$userId = $input->getArgument('user_id');
$storageService = $this->getStorageService($userId);
/** @var $mounts StorageConfig[] */
$mounts = $storageService->getAllStorages();
}
@ -114,7 +112,7 @@ class ListCommand extends Base {
}
/**
* @param $userId $userId
* @param string $userId
* @param StorageConfig[] $mounts
* @param InputInterface $input
* @param OutputInterface $output

View File

@ -55,7 +55,7 @@ trait UserTrait {
* Override the user from the session
* Unset with ->resetUser() when finished!
*
* @param IUser
* @param IUser $user
* @return self
*/
public function setUser(IUser $user) {

View File

@ -1,4 +1,4 @@
<?php /** @var $l \OCP\IL10N */ ?>
<?php /** @var \OCP\IL10N $l */ ?>
<div id="controls">
<div id="file_action_panel"></div>
</div>

View File

@ -1466,7 +1466,7 @@ class ShareAPIController extends OCSController {
/**
* Cleanup the remaining locks
* @throws @LockedException
* @throws LockedException
*/
public function cleanup() {
if ($this->lockedNode !== null) {
@ -1642,7 +1642,7 @@ class ShareAPIController extends OCSController {
*
* @param Node|null $path
* @param boolean $reshares
* @return void
* @return IShare[]
*/
private function getAllShares(?Node $path = null, bool $reshares = false) {
// Get all shares

View File

@ -54,7 +54,7 @@ use function usort;
class ShareesAPIController extends OCSController {
/** @var userId */
/** @var string */
protected $userId;
/** @var IConfig */

View File

@ -63,7 +63,7 @@ class Helper {
/**
* get default share folder
*
* @param \OC\Files\View
* @param \OC\Files\View $view
* @return string
*/
public static function getShareFolder($view = null) {

View File

@ -215,7 +215,7 @@ class SharedMount extends MountPoint implements MoveableMount {
*/
public function removeMount() {
$mountManager = \OC\Files\Filesystem::getMountManager();
/** @var $storage \OCA\Files_Sharing\SharedStorage */
/** @var \OCA\Files_Sharing\SharedStorage $storage */
$storage = $this->getStorage();
$result = $storage->unshareStorage();
$mountManager->removeMount($this->mountPoint);

View File

@ -1,4 +1,4 @@
<?php /** @var $l \OCP\IL10N */ ?>
<?php /** @var \OCP\IL10N $l */ ?>
<div id='notification'></div>
<div id="emptycontent" class="hidden"></div>

View File

@ -1,6 +1,6 @@
<?php
/** @var $l \OCP\IL10N */
/** @var $_ array */
/** @var \OCP\IL10N $_ */
/** @var array $_ */
?>
<div id="app-content">
<?php if ($_['previewSupported']): /* This enables preview images for links (e.g. on Facebook, Google+, ...)*/?>

View File

@ -290,7 +290,7 @@ class Server extends ServerContainer implements IServerContainer {
return new PreviewManager(
$c->getConfig(),
$c->getRootFolder(),
new \OC\Preview\Storage\Root($c->getRootFolder(), $c->getSystemConfig(), 'preview'),
new \OC\Preview\Storage\Root($c->getRootFolder(), $c->getSystemConfig()),
$c->getEventDispatcher(),
$c->getGeneratorHelper(),
$c->getSession()->get('user_id')
@ -301,7 +301,7 @@ class Server extends ServerContainer implements IServerContainer {
$this->registerService(\OC\Preview\Watcher::class, function (Server $c) {
return new \OC\Preview\Watcher(
new \OC\Preview\Storage\Root($c->getRootFolder(), $c->getSystemConfig(), 'preview')
new \OC\Preview\Storage\Root($c->getRootFolder(), $c->getSystemConfig())
);
});
@ -519,7 +519,7 @@ class Server extends ServerContainer implements IServerContainer {
$dispatcher->dispatchTyped(new BeforeUserCreatedEvent($uid, $password));
});
$userSession->listen('\OC\User', 'postCreateUser', function ($user, $password) {
/** @var $user \OC\User\User */
/** @var \OC\User\User $user */
\OC_Hook::emit('OC_User', 'post_createUser', ['uid' => $user->getUID(), 'password' => $password]);
/** @var IEventDispatcher $dispatcher */
@ -527,7 +527,7 @@ class Server extends ServerContainer implements IServerContainer {
$dispatcher->dispatchTyped(new UserCreatedEvent($user, $password));
});
$userSession->listen('\OC\User', 'preDelete', function ($user) use ($legacyDispatcher) {
/** @var $user \OC\User\User */
/** @var \OC\User\User $user */
\OC_Hook::emit('OC_User', 'pre_deleteUser', ['run' => true, 'uid' => $user->getUID()]);
$legacyDispatcher->dispatch('OCP\IUser::preDelete', new GenericEvent($user));
@ -536,7 +536,7 @@ class Server extends ServerContainer implements IServerContainer {
$dispatcher->dispatchTyped(new BeforeUserDeletedEvent($user));
});
$userSession->listen('\OC\User', 'postDelete', function ($user) {
/** @var $user \OC\User\User */
/** @var \OC\User\User $user */
\OC_Hook::emit('OC_User', 'post_deleteUser', ['uid' => $user->getUID()]);
/** @var IEventDispatcher $dispatcher */
@ -544,7 +544,7 @@ class Server extends ServerContainer implements IServerContainer {
$dispatcher->dispatchTyped(new UserDeletedEvent($user));
});
$userSession->listen('\OC\User', 'preSetPassword', function ($user, $password, $recoveryPassword) {
/** @var $user \OC\User\User */
/** @var \OC\User\User $user */
\OC_Hook::emit('OC_User', 'pre_setPassword', ['run' => true, 'uid' => $user->getUID(), 'password' => $password, 'recoveryPassword' => $recoveryPassword]);
/** @var IEventDispatcher $dispatcher */
@ -552,7 +552,7 @@ class Server extends ServerContainer implements IServerContainer {
$dispatcher->dispatchTyped(new BeforePasswordUpdatedEvent($user, $password, $recoveryPassword));
});
$userSession->listen('\OC\User', 'postSetPassword', function ($user, $password, $recoveryPassword) {
/** @var $user \OC\User\User */
/** @var \OC\User\User $user */
\OC_Hook::emit('OC_User', 'post_setPassword', ['run' => true, 'uid' => $user->getUID(), 'password' => $password, 'recoveryPassword' => $recoveryPassword]);
/** @var IEventDispatcher $dispatcher */
@ -567,7 +567,7 @@ class Server extends ServerContainer implements IServerContainer {
$dispatcher->dispatchTyped(new BeforeUserLoggedInEvent($uid, $password));
});
$userSession->listen('\OC\User', 'postLogin', function ($user, $password, $isTokenLogin) {
/** @var $user \OC\User\User */
/** @var \OC\User\User $user */
\OC_Hook::emit('OC_User', 'post_login', ['run' => true, 'uid' => $user->getUID(), 'password' => $password, 'isTokenLogin' => $isTokenLogin]);
/** @var IEventDispatcher $dispatcher */
@ -600,7 +600,7 @@ class Server extends ServerContainer implements IServerContainer {
$dispatcher->dispatchTyped(new UserLoggedOutEvent($user));
});
$userSession->listen('\OC\User', 'changeUser', function ($user, $feature, $value, $oldValue) {
/** @var $user \OC\User\User */
/** @var \OC\User\User $user */
\OC_Hook::emit('OC_User', 'changeUser', ['run' => true, 'user' => $user, 'feature' => $feature, 'value' => $value, 'old_value' => $oldValue]);
/** @var IEventDispatcher $dispatcher */