diff options
author | Vincent Petry <pvince81@owncloud.com> | 2015-03-17 11:42:52 +0100 |
---|---|---|
committer | Vincent Petry <pvince81@owncloud.com> | 2015-03-17 11:42:52 +0100 |
commit | e5e30924b14c22cc68b2fe0c47144f06c4a997aa (patch) | |
tree | 49587b067c21416edd230b69e27f77ede30c6b85 /apps/files_external/controller | |
parent | 847880803e9bdbaae332762e197ac13ffe552233 (diff) | |
download | nextcloud-server-e5e30924b14c22cc68b2fe0c47144f06c4a997aa.tar.gz nextcloud-server-e5e30924b14c22cc68b2fe0c47144f06c4a997aa.zip |
Fix PHPDoc in files_external, add missing tag
Fix various PHPDoc issues in external storage app.
Added missing NoAdminRequired tag
Diffstat (limited to 'apps/files_external/controller')
3 files changed, 27 insertions, 8 deletions
diff --git a/apps/files_external/controller/globalstoragescontroller.php b/apps/files_external/controller/globalstoragescontroller.php index 815f24ee2be..819cccdbde8 100644 --- a/apps/files_external/controller/globalstoragescontroller.php +++ b/apps/files_external/controller/globalstoragescontroller.php @@ -23,6 +23,9 @@ use \OCA\Files_external\Service\GlobalStoragesService; use \OCA\Files_external\NotFoundException; use \OCA\Files_external\Lib\StorageConfig; +/** + * Global storages controller + */ class GlobalStoragesController extends StoragesController { /** * Creates a new global storages controller. @@ -37,7 +40,7 @@ class GlobalStoragesController extends StoragesController { IRequest $request, IL10N $l10n, GlobalStoragesService $globalStoragesService - ){ + ) { parent::__construct( $AppName, $request, @@ -151,4 +154,3 @@ class GlobalStoragesController extends StoragesController { } } - diff --git a/apps/files_external/controller/storagescontroller.php b/apps/files_external/controller/storagescontroller.php index 5cdbfe735e2..b454dff7027 100644 --- a/apps/files_external/controller/storagescontroller.php +++ b/apps/files_external/controller/storagescontroller.php @@ -23,14 +23,21 @@ use \OCA\Files_external\Service\StoragesService; use \OCA\Files_external\NotFoundException; use \OCA\Files_external\Lib\StorageConfig; +/** + * Base class for storages controllers + */ abstract class StoragesController extends Controller { /** + * L10N service + * * @var IL10N */ protected $l10n; /** + * Storages service + * * @var StoragesService */ protected $service; @@ -48,7 +55,7 @@ abstract class StoragesController extends Controller { IRequest $request, IL10N $l10n, StoragesService $storagesService - ){ + ) { parent::__construct($AppName, $request); $this->l10n = $l10n; $this->service = $storagesService; @@ -94,7 +101,7 @@ abstract class StoragesController extends Controller { * Note that this operation can be time consuming depending * on whether the remote storage is available or not. * - * @param StorageConfig $storage + * @param StorageConfig $storage storage configuration */ protected function updateStorageStatus(StorageConfig &$storage) { // update status (can be time-consuming) diff --git a/apps/files_external/controller/userstoragescontroller.php b/apps/files_external/controller/userstoragescontroller.php index ed7ec453ccd..86557988ea3 100644 --- a/apps/files_external/controller/userstoragescontroller.php +++ b/apps/files_external/controller/userstoragescontroller.php @@ -23,6 +23,9 @@ use \OCA\Files_external\Service\UserStoragesService; use \OCA\Files_external\NotFoundException; use \OCA\Files_external\Lib\StorageConfig; +/** + * User storages controller + */ class UserStoragesController extends StoragesController { /** * Creates a new user storages controller. @@ -37,7 +40,7 @@ class UserStoragesController extends StoragesController { IRequest $request, IL10N $l10n, UserStoragesService $userStoragesService - ){ + ) { parent::__construct( $AppName, $request, @@ -76,8 +79,11 @@ class UserStoragesController extends StoragesController { } /** + * Return storage + * * @NoAdminRequired - * @{inheritdoc} + * + * {@inheritdoc} */ public function show($id) { return parent::show($id); @@ -131,6 +137,8 @@ class UserStoragesController extends StoragesController { * @param array $mountOptions backend-specific mount options * * @return DataResponse + * + * @NoAdminRequired */ public function update( $id, @@ -171,11 +179,13 @@ class UserStoragesController extends StoragesController { } /** - * {@inheritdoc} + * Delete storage + * * @NoAdminRequired + * + * {@inheritdoc} */ public function destroy($id) { return parent::destroy($id); } } - |