Update documentation of IHistorySavingObjectTypeProvider::checkPermissions()
authorMatthias Schmidt <gravatronics@live.com>
Tue, 10 May 2016 20:16:09 +0000 (22:16 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Tue, 10 May 2016 20:16:09 +0000 (22:16 +0200)
wcfsetup/install/files/lib/system/edit/IHistorySavingObjectTypeProvider.class.php

index 3c0290c73b5bd8e89809574997ca94cb567f6703..e1cde9914535b7e0bb97323c0cd4b0a18dd2d601 100644 (file)
@@ -1,6 +1,7 @@
 <?php
 namespace wcf\system\edit;
 use wcf\data\object\type\IObjectTypeProvider;
+use wcf\system\exception\PermissionDeniedException;
 
 /**
  * Represents an object which edit history can be saved.
@@ -14,13 +15,12 @@ use wcf\data\object\type\IObjectTypeProvider;
  */
 interface IHistorySavingObjectTypeProvider extends IObjectTypeProvider {
        /**
-        * Checks the permissions to review the edit history
-        * and to revert to an older version of the given
-        * IHistorySavingObject.
-        * You must throw a \wcf\system\exception\PermissionDeniedException
-        * to deny access!
+        * Checks the permissions to review the edit history and to revert to an
+        * older version of the given IHistorySavingObject.
         * 
-        * @param       \wcf\system\edit\IHistorySavingObject   $object
+        * @param       IHistorySavingObject    $object
+        * @throws      PermissionDeniedException       if access is denied
+        * @throws      \InvalidArgumentException       if given object has not be provided by this provider and thus cannot be checked by this method
         */
        public function checkPermissions(IHistorySavingObject $object);