Merge pull request #32884 from nextcloud/typing/dav-sharing

Add typing to Sharing Backend

1 files changed, 16 insertions, 46 deletions

diff --git a/apps/dav/lib/CalDAV/Calendar.php b/apps/dav/lib/CalDAV/Calendar.php
index 806e99d8a05..92ad3242d78 100644
--- a/apps/dav/lib/CalDAV/Calendar.php
+++ b/apps/dav/lib/CalDAV/Calendar.php
@@ -51,27 +51,11 @@ use Sabre\DAV\PropPatch;
  * @property CalDavBackend $caldavBackend
  */
 class Calendar extends \Sabre\CalDAV\Calendar implements IRestorable, IShareable, IMoveTarget {
+	private IConfig $config;
+	protected IL10N $l10n;
+	private bool $useTrashbin = true;
+	private LoggerInterface $logger;
 
-	/** @var IConfig */
-	private $config;
-
-	/** @var IL10N */
-	protected $l10n;
-
-	/** @var bool */
-	private $useTrashbin = true;
-
-	/** @var LoggerInterface */
-	private $logger;
-
-	/**
-	 * Calendar constructor.
-	 *
-	 * @param BackendInterface $caldavBackend
-	 * @param $calendarInfo
-	 * @param IL10N $l10n
-	 * @param IConfig $config
-	 */
 	public function __construct(BackendInterface $caldavBackend, $calendarInfo, IL10N $l10n, IConfig $config, LoggerInterface $logger) {
 		// Convert deletion date to ISO8601 string
 		if (isset($calendarInfo[TrashbinPlugin::PROPERTY_DELETED_AT])) {
@@ -96,25 +80,10 @@ class Calendar extends \Sabre\CalDAV\Calendar implements IRestorable, IShareable
 	}
 
 	/**
-	 * Updates the list of shares.
-	 *
-	 * The first array is a list of people that are to be added to the
-	 * resource.
-	 *
-	 * Every element in the add array has the following properties:
-	 *   * href - A url. Usually a mailto: address
-	 *   * commonName - Usually a first and last name, or false
-	 *   * summary - A description of the share, can also be false
-	 *   * readOnly - A boolean value
-	 *
-	 * Every element in the remove array is just the address string.
-	 *
-	 * @param array $add
-	 * @param array $remove
-	 * @return void
+	 * {@inheritdoc}
 	 * @throws Forbidden
 	 */
-	public function updateShares(array $add, array $remove) {
+	public function updateShares(array $add, array $remove): void {
 		if ($this->isShared()) {
 			throw new Forbidden();
 		}
@@ -131,19 +100,16 @@ class Calendar extends \Sabre\CalDAV\Calendar implements IRestorable, IShareable
 	 *   * readOnly - boolean
 	 *   * summary - Optional, a description for the share
 	 *
-	 * @return array
+	 * @return list<array{href: string, commonName: string, status: int, readOnly: bool, '{http://owncloud.org/ns}principal': string, '{http://owncloud.org/ns}group-share': bool}>
 	 */
-	public function getShares() {
+	public function getShares(): array {
 		if ($this->isShared()) {
 			return [];
 		}
 		return $this->caldavBackend->getShares($this->getResourceId());
 	}
 
-	/**
-	 * @return int
-	 */
-	public function getResourceId() {
+	public function getResourceId(): int {
 		return $this->calendarInfo['id'];
 	}
 
@@ -155,7 +121,9 @@ class Calendar extends \Sabre\CalDAV\Calendar implements IRestorable, IShareable
 	}
 
 	/**
-	 * @return array
+	 * @param int $resourceId
+	 * @param list<array{privilege: string, principal: string, protected: bool}> $acl
+	 * @return list<array{privilege: string, principal: ?string, protected: bool}>
 	 */
 	public function getACL() {
 		$acl = [
@@ -246,16 +214,18 @@ class Calendar extends \Sabre\CalDAV\Calendar implements IRestorable, IShareable
 			parent::getOwner(),
 			'principals/system/public'
 		];
-		return array_filter($acl, function ($rule) use ($allowedPrincipals) {
+		/** @var list<array{privilege: string, principal: string, protected: bool}> $acl */
+		$acl = array_filter($acl, function (array $rule) use ($allowedPrincipals): bool {
 			return \in_array($rule['principal'], $allowedPrincipals, true);
 		});
+		return $acl;
 	}
 
 	public function getChildACL() {
 		return $this->getACL();
 	}
 
-	public function getOwner() {
+	public function getOwner(): ?string {
 		if (isset($this->calendarInfo['{http://owncloud.org/ns}owner-principal'])) {
 			return $this->calendarInfo['{http://owncloud.org/ns}owner-principal'];
 		}