Merge pull request #1661 from CarlSchwan/carl/add-type-annotations

Add some type annotations

Author: phil-davis

lib/CalDAV/CalendarHome.php

@@ -28,24 +28,18 @@ class CalendarHome implements DAV\IExtendedCollection, DAVACL\IACL
 
     /**
      * CalDAV backend.
-     *
-     * @var Backend\BackendInterface
      */
-    protected $caldavBackend;
+    protected Backend\BackendInterface $caldavBackend;
 
     /**
      * Principal information.
-     *
-     * @var array
      */
-    protected $principalInfo;
+    protected array $principalInfo;
 
     /**
      * Constructor.
-     *
-     * @param array $principalInfo
      */
-    public function __construct(Backend\BackendInterface $caldavBackend, $principalInfo)
+    public function __construct(Backend\BackendInterface $caldavBackend, array $principalInfo)
     {
         $this->caldavBackend = $caldavBackend;
         $this->principalInfo = $principalInfo;
@@ -65,10 +59,8 @@ public function getName()
 
     /**
      * Updates the name of this object.
-     *
-     * @param string $name
      */
-    public function setName($name)
+    public function setName(string $name)
     {
         throw new DAV\Exception\Forbidden();
     }
@@ -96,10 +88,9 @@ public function getLastModified()
      *
      * This is currently not allowed
      *
-     * @param string   $name
      * @param resource $data
      */
-    public function createFile($name, $data = null)
+    public function createFile(string $name, $data = null)
     {
         throw new DAV\Exception\MethodNotAllowed('Creating new files in this collection is not supported');
     }
@@ -108,22 +99,18 @@ public function createFile($name, $data = null)
      * Creates a new directory under this object.
      *
      * This is currently not allowed.
-     *
-     * @param string $filename
      */
-    public function createDirectory($filename)
+    public function createDirectory(string $filename)
     {
         throw new DAV\Exception\MethodNotAllowed('Creating new collections in this collection is not supported');
     }
 
     /**
      * Returns a single calendar, by name.
      *
-     * @param string $name
-     *
      * @return Calendar
      */
-    public function getChild($name)
+    public function getChild(string $name)
     {
         // Special nodes
         if ('inbox' === $name && $this->caldavBackend instanceof Backend\SchedulingSupport) {
@@ -161,11 +148,9 @@ public function getChild($name)
     /**
      * Checks if a calendar exists.
      *
-     * @param string $name
-     *
      * @return bool
      */
-    public function childExists($name)
+    public function childExists(string $name)
     {
         try {
             return (bool) $this->getChild($name);
@@ -214,11 +199,9 @@ public function getChildren()
     /**
      * Creates a new calendar or subscription.
      *
-     * @param string $name
-     *
      * @throws DAV\Exception\InvalidResourceType
      */
-    public function createExtendedCollection($name, MkCol $mkCol)
+    public function createExtendedCollection(string $name, MkCol $mkCol)
     {
         $isCalendar = false;
         $isSubscription = false;
@@ -274,7 +257,7 @@ public function getOwner()
      *   * 'protected' (optional), indicating that this ACE is not allowed to
      *      be updated.
      *
-     * @return array
+     * @return list<array{principal: string, privilege: string, protected?: bool}>
      */
     public function getACL()
     {

lib/CalDAV/CalendarObject.php

@@ -192,7 +192,7 @@ public function getOwner()
      *   * 'protected' (optional), indicating that this ACE is not allowed to
      *      be updated.
      *
-     * @return array
+     * @return list<array{principal: string, privilege: string, protected?: bool}>
      */
     public function getACL()
     {

lib/CalDAV/Principal/Collection.php

@@ -22,10 +22,8 @@ class Collection extends DAVACL\PrincipalCollection
 {
     /**
      * Returns a child object based on principal information.
-     *
-     * @return User
      */
-    public function getChildForPrincipal(array $principalInfo)
+    public function getChildForPrincipal(array $principalInfo): User
     {
         return new User($this->principalBackend, $principalInfo);
     }

lib/CalDAV/Principal/User.php

@@ -115,7 +115,7 @@ public function childExists($name)
      *   * 'protected' (optional), indicating that this ACE is not allowed to
      *      be updated.
      *
-     * @return array
+     * @return list<array{principal: string, privilege: string, protected?: bool}>
      */
     public function getACL()
     {

lib/CalDAV/Schedule/Inbox.php

@@ -128,7 +128,7 @@ public function getOwner()
      *   * 'protected' (optional), indicating that this ACE is not allowed to
      *      be updated.
      *
-     * @return array
+     * @return list<array{principal: string, privilege: string, protected?: bool}>
      */
     public function getACL()
     {

lib/CalDAV/Schedule/Outbox.php

@@ -84,7 +84,7 @@ public function getOwner()
      *   * 'protected' (optional), indicating that this ACE is not allowed to
      *      be updated.
      *
-     * @return array
+     * @return list<array{principal: string, privilege: string, protected?: bool}>
      */
     public function getACL()
     {

lib/CalDAV/Subscriptions/Subscription.php

@@ -179,7 +179,7 @@ public function getOwner()
      *   * 'protected' (optional), indicating that this ACE is not allowed to
      *      be updated.
      *
-     * @return array
+     * @return list<array{principal: string, privilege: string, protected?: bool}>
      */
     public function getACL()
     {

lib/CardDAV/AddressBook.php

@@ -192,11 +192,9 @@ public function propPatch(DAV\PropPatch $propPatch)
      *
      * If the array is empty, it means 'all properties' were requested.
      *
-     * @param array $properties
-     *
      * @return array
      */
-    public function getProperties($properties)
+    public function getProperties(array $properties)
     {
         $response = [];
         foreach ($properties as $propertyName) {

lib/CardDAV/AddressBookRoot.php

@@ -19,17 +19,13 @@ class AddressBookRoot extends DAVACL\AbstractPrincipalCollection
 {
     /**
      * Principal Backend.
-     *
-     * @var DAVACL\PrincipalBackend\BackendInterface
      */
-    protected $principalBackend;
+    protected DAVACL\PrincipalBackend\BackendInterface $principalBackend;
 
     /**
      * CardDAV backend.
-     *
-     * @var Backend\BackendInterface
      */
-    protected $carddavBackend;
+    protected Backend\BackendInterface $carddavBackend;
 
     /**
      * Constructor.
@@ -40,10 +36,8 @@ class AddressBookRoot extends DAVACL\AbstractPrincipalCollection
      * principals in the 'principals' collection. If your main principals are
      * actually located in a different path, use the $principalPrefix argument
      * to override this.
-     *
-     * @param string $principalPrefix
      */
-    public function __construct(DAVACL\PrincipalBackend\BackendInterface $principalBackend, Backend\BackendInterface $carddavBackend, $principalPrefix = 'principals')
+    public function __construct(DAVACL\PrincipalBackend\BackendInterface $principalBackend, Backend\BackendInterface $carddavBackend, string $principalPrefix = 'principals')
     {
         $this->carddavBackend = $carddavBackend;
         parent::__construct($principalBackend, $principalPrefix);

lib/CardDAV/Card.php

@@ -181,7 +181,7 @@ public function getOwner()
      *   * 'protected' (optional), indicating that this ACE is not allowed to
      *      be updated.
      *
-     * @return array
+     * @return list<array{principal: string, privilege: string, protected?: bool}>
      */
     public function getACL()
     {