allow setting tooltips for external storage config options

allows explaining non-obvious config options a bit more

Signed-off-by: Robin Appelman <robin@icewind.nl>

1 files changed, 21 insertions, 1 deletions

diff --git a/apps/files_external/lib/Lib/DefinitionParameter.php b/apps/files_external/lib/Lib/DefinitionParameter.php
index 7250a77e6c1..2e1ce7fb1dd 100644
--- a/apps/files_external/lib/Lib/DefinitionParameter.php
+++ b/apps/files_external/lib/Lib/DefinitionParameter.php
@@ -48,6 +48,9 @@ class DefinitionParameter implements \JsonSerializable {
 	/** @var string human-readable parameter text */
 	private $text;
 
+	/** @var string human-readable parameter tooltip */
+	private $tooltip = '';
+
 	/** @var int value type, see self::VALUE_* constants */
 	private $type = self::VALUE_TEXT;
 
@@ -147,6 +150,22 @@ class DefinitionParameter implements \JsonSerializable {
 	}
 
 	/**
+	 * @return string
+	 */
+	public function getTooltip(): string {
+		return $this->tooltip;
+	}
+
+	/**
+	 * @param string $tooltip
+	 * @return self
+	 */
+	public function setTooltip(string $tooltip) {
+		$this->tooltip = $tooltip;
+		return $this;
+	}
+
+	/**
 	 * Serialize into JSON for client-side JS
 	 *
 	 * @return string
@@ -155,7 +174,8 @@ class DefinitionParameter implements \JsonSerializable {
 		return [
 			'value' => $this->getText(),
 			'flags' => $this->getFlags(),
-			'type' => $this->getType()
+			'type' => $this->getType(),
+			'tooltip' => $this->getTooltip(),
 		];
 	}