aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_external/lib/Lib/FrontendDefinitionTrait.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_external/lib/Lib/FrontendDefinitionTrait.php')
-rw-r--r--apps/files_external/lib/Lib/FrontendDefinitionTrait.php93
1 files changed, 20 insertions, 73 deletions
diff --git a/apps/files_external/lib/Lib/FrontendDefinitionTrait.php b/apps/files_external/lib/Lib/FrontendDefinitionTrait.php
index 25b3cb4fc29..0f280d1d486 100644
--- a/apps/files_external/lib/Lib/FrontendDefinitionTrait.php
+++ b/apps/files_external/lib/Lib/FrontendDefinitionTrait.php
@@ -1,94 +1,57 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2017-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OCA\Files_External\Lib;
-use \OCA\Files_External\Lib\DefinitionParameter;
-use \OCA\Files_External\Lib\StorageConfig;
-
/**
* Trait for objects that have a frontend representation
*/
trait FrontendDefinitionTrait {
/** @var string human-readable mechanism name */
- private $text;
+ private string $text = '';
- /** @var DefinitionParameter[] parameters for mechanism */
- private $parameters = [];
+ /** @var array<string, DefinitionParameter> parameters for mechanism */
+ private array $parameters = [];
/** @var string[] custom JS */
- private $customJs = [];
+ private array $customJs = [];
- /**
- * @return string
- */
- public function getText() {
+ public function getText(): string {
return $this->text;
}
- /**
- * @param string $text
- * @return $this
- */
- public function setText($text) {
+ public function setText(string $text): self {
$this->text = $text;
return $this;
}
- /**
- * @param FrontendDefinitionTrait $a
- * @param FrontendDefinitionTrait $b
- * @return int
- */
- public static function lexicalCompare(FrontendDefinitionTrait $a, FrontendDefinitionTrait $b) {
+ public static function lexicalCompare(IFrontendDefinition $a, IFrontendDefinition $b): int {
return strcmp($a->getText(), $b->getText());
}
/**
- * @return DefinitionParameter[]
+ * @return array<string, DefinitionParameter>
*/
- public function getParameters() {
+ public function getParameters(): array {
return $this->parameters;
}
/**
- * @param DefinitionParameter[] $parameters
- * @return self
+ * @param list<DefinitionParameter> $parameters
*/
- public function addParameters(array $parameters) {
+ public function addParameters(array $parameters): self {
foreach ($parameters as $parameter) {
$this->addParameter($parameter);
}
return $this;
}
- /**
- * @param DefinitionParameter $parameter
- * @return self
- */
- public function addParameter(DefinitionParameter $parameter) {
+ public function addParameter(DefinitionParameter $parameter): self {
$this->parameters[$parameter->getName()] = $parameter;
return $this;
}
@@ -96,7 +59,7 @@ trait FrontendDefinitionTrait {
/**
* @return string[]
*/
- public function getCustomJs() {
+ public function getCustomJs(): array {
return $this->customJs;
}
@@ -104,27 +67,15 @@ trait FrontendDefinitionTrait {
* @param string $custom
* @return self
*/
- public function addCustomJs($custom) {
+ public function addCustomJs(string $custom): self {
$this->customJs[] = $custom;
return $this;
}
/**
- * @param string $custom
- * @return self
- * @deprecated 9.1.0, use addCustomJs() instead
- */
- public function setCustomJs($custom) {
- $this->customJs = [$custom];
- return $this;
- }
-
- /**
* Serialize into JSON for client-side JS
- *
- * @return array
*/
- public function jsonSerializeDefinition() {
+ public function jsonSerializeDefinition(): array {
$configuration = [];
foreach ($this->getParameters() as $parameter) {
$configuration[$parameter->getName()] = $parameter;
@@ -140,11 +91,8 @@ trait FrontendDefinitionTrait {
/**
* Check if parameters are satisfied in a StorageConfig
- *
- * @param StorageConfig $storage
- * @return bool
*/
- public function validateStorageDefinition(StorageConfig $storage) {
+ public function validateStorageDefinition(StorageConfig $storage): bool {
foreach ($this->getParameters() as $name => $parameter) {
$value = $storage->getBackendOption($name);
if (!is_null($value) || !$parameter->isOptional()) {
@@ -156,5 +104,4 @@ trait FrontendDefinitionTrait {
}
return true;
}
-
}