docs(caldav): improve documentation of CalDavBackend::getCalendarsForUserCount

st3iny · AndyScherzinger · commit d408898f6301 · 2025-06-12T19:08:06.000+02:00
Signed-off-by: Richard Steinmetz &lt;richard@steinmetz.cloud&gt;
diff --git a/apps/dav/lib/CalDAV/CalDavBackend.php b/apps/dav/lib/CalDAV/CalDavBackend.php
@@ -216,15 +216,13 @@ public function __construct(
 	}
 
 	/**
-	 * Return the number of calendars for a principal
+	 * Return the number of calendars owned by the given principal.
 	 *
-	 * By default this excludes the automatically generated birthday calendar
+	 * Calendars shared with the given principal are not counted!
 	 *
-	 * @param $principalUri
-	 * @param bool $excludeBirthday
-	 * @return int
+	 * By default, this excludes the automatically generated birthday calendar.
 	 */
-	public function getCalendarsForUserCount($principalUri, $excludeBirthday = true) {
+	public function getCalendarsForUserCount(string $principalUri, bool $excludeBirthday = true): int {
 		$principalUri = $this->convertPrincipal($principalUri, true);
 		$query = $this->db->getQueryBuilder();
 		$query->select($query->func()->count('*'))

Original file line number	Diff line number	Diff line change
`@@ -216,15 +216,13 @@ public function __construct(`
`216`	`216`	`}`
`217`	`217`
`218`	`218`	`/**`
`219`		`- * Return the number of calendars for a principal`
	`219`	`+ * Return the number of calendars owned by the given principal.`
`220`	`220`	`*`
`221`		`- * By default this excludes the automatically generated birthday calendar`
	`221`	`+ * Calendars shared with the given principal are not counted!`
`222`	`222`	`*`
`223`		`- * @param $principalUri`
`224`		`- * @param bool $excludeBirthday`
`225`		`- * @return int`
	`223`	`+ * By default, this excludes the automatically generated birthday calendar.`
`226`	`224`	`*/`
`227`		`- public function getCalendarsForUserCount($principalUri, $excludeBirthday = true) {`
	`225`	`+ public function getCalendarsForUserCount(string $principalUri, bool $excludeBirthday = true): int {`
`228`	`226`	`$principalUri = $this->convertPrincipal($principalUri, true);`
`229`	`227`	`$query = $this->db->getQueryBuilder();`
`230`	`228`	`$query->select($query->func()->count('*'))`