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

Signed-off-by: Richard Steinmetz <richard@steinmetz.cloud>
pull/53323/head
Richard Steinmetz 2025-06-04 15:05:38 +07:00
parent 54555209ac
commit 3b1947086c
No known key found for this signature in database
GPG Key ID: 27137D9E7D273FB2
1 changed files with 5 additions and 7 deletions

@ -212,15 +212,13 @@ class CalDavBackend extends AbstractBackend implements SyncSupport, Subscription
}
/**
* 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('*'))
@ -1040,7 +1038,7 @@ class CalDavBackend extends AbstractBackend implements SyncSupport, Subscription
$rs->closeCursor();
}
}
/**
* Returns all calendar objects with limited metadata for a calendar
*