From 857957b45e563b9ac789adec0374d486c71a96ed Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Thu, 2 Apr 2020 17:22:42 +0200 Subject: allow setting tooltips for external storage config options allows explaining non-obvious config options a bit more Signed-off-by: Robin Appelman --- .../files_external/lib/Lib/DefinitionParameter.php | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) (limited to 'apps/files_external/lib') 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; @@ -146,6 +149,22 @@ class DefinitionParameter implements \JsonSerializable { return (bool)($this->flags & $flag); } + /** + * @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 * @@ -155,7 +174,8 @@ class DefinitionParameter implements \JsonSerializable { return [ 'value' => $this->getText(), 'flags' => $this->getFlags(), - 'type' => $this->getType() + 'type' => $this->getType(), + 'tooltip' => $this->getTooltip(), ]; } -- cgit v1.2.3