1 files changed, 121 insertions, 0 deletions
diff --git a/apps/files_external/lib/Lib/VisibilityTrait.php b/apps/files_external/lib/Lib/VisibilityTrait.php
new file mode 100644
index 00000000000..62b26f3edb1
--- /dev/null
+++ b/apps/files_external/lib/Lib/VisibilityTrait.php
@@ -0,0 +1,121 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2019-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\Service\BackendService;
+
+/**
+ * Trait to implement visibility mechanics for a configuration class
+ *
+ * The standard visibility defines which users/groups can use or see the
+ * object. The allowed visibility defines the maximum visibility allowed to be
+ * set on the object. The standard visibility is often set dynamically by
+ * stored configuration parameters that can be modified by the administrator,
+ * while the allowed visibility is set directly by the object and cannot be
+ * modified by the administrator.
+ */
+trait VisibilityTrait {
+
+	/** @var int visibility */
+	protected $visibility = BackendService::VISIBILITY_DEFAULT;
+
+	/** @var int allowed visibilities */
+	protected $allowedVisibility = BackendService::VISIBILITY_DEFAULT;
+
+	/**
+	 * @return int
+	 */
+	public function getVisibility() {
+		return $this->visibility;
+	}
+
+	/**
+	 * Check if the backend is visible for a user type
+	 *
+	 * @param int $visibility
+	 * @return bool
+	 */
+	public function isVisibleFor($visibility) {
+		if ($this->visibility & $visibility) {
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * @param int $visibility
+	 * @return self
+	 */
+	public function setVisibility($visibility) {
+		$this->visibility = $visibility;
+		$this->allowedVisibility |= $visibility;
+		return $this;
+	}
+
+	/**
+	 * @param int $visibility
+	 * @return self
+	 */
+	public function addVisibility($visibility) {
+		return $this->setVisibility($this->visibility | $visibility);
+	}
+
+	/**
+	 * @param int $visibility
+	 * @return self
+	 */
+	public function removeVisibility($visibility) {
+		return $this->setVisibility($this->visibility & ~$visibility);
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getAllowedVisibility() {
+		return $this->allowedVisibility;
+	}
+
+	/**
+	 * Check if the backend is allowed to be visible for a user type
+	 *
+	 * @param int $allowedVisibility
+	 * @return bool
+	 */
+	public function isAllowedVisibleFor($allowedVisibility) {
+		if ($this->allowedVisibility & $allowedVisibility) {
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * @param int $allowedVisibility
+	 * @return self
+	 */
+	public function setAllowedVisibility($allowedVisibility) {
+		$this->allowedVisibility = $allowedVisibility;
+		$this->visibility &= $allowedVisibility;
+		return $this;
+	}
+
+	/**
+	 * @param int $allowedVisibility
+	 * @return self
+	 */
+	public function addAllowedVisibility($allowedVisibility) {
+		return $this->setAllowedVisibility($this->allowedVisibility | $allowedVisibility);
+	}
+
+	/**
+	 * @param int $allowedVisibility
+	 * @return self
+	 */
+	public function removeAllowedVisibility($allowedVisibility) {
+		return $this->setAllowedVisibility($this->allowedVisibility & ~$allowedVisibility);
+	}
+}