@@ -31,41 +31,41 @@ |
||
| 31 | 31 | * @since 8.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface ITempManager { |
| 34 | - /** |
|
| 35 | - * Create a temporary file and return the path |
|
| 36 | - * |
|
| 37 | - * @param string $postFix |
|
| 38 | - * @return string |
|
| 39 | - * @since 8.0.0 |
|
| 40 | - */ |
|
| 41 | - public function getTemporaryFile($postFix = ''); |
|
| 34 | + /** |
|
| 35 | + * Create a temporary file and return the path |
|
| 36 | + * |
|
| 37 | + * @param string $postFix |
|
| 38 | + * @return string |
|
| 39 | + * @since 8.0.0 |
|
| 40 | + */ |
|
| 41 | + public function getTemporaryFile($postFix = ''); |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Create a temporary folder and return the path |
|
| 45 | - * |
|
| 46 | - * @param string $postFix |
|
| 47 | - * @return string |
|
| 48 | - * @since 8.0.0 |
|
| 49 | - */ |
|
| 50 | - public function getTemporaryFolder($postFix = ''); |
|
| 43 | + /** |
|
| 44 | + * Create a temporary folder and return the path |
|
| 45 | + * |
|
| 46 | + * @param string $postFix |
|
| 47 | + * @return string |
|
| 48 | + * @since 8.0.0 |
|
| 49 | + */ |
|
| 50 | + public function getTemporaryFolder($postFix = ''); |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * Remove the temporary files and folders generated during this request |
|
| 54 | - * @since 8.0.0 |
|
| 55 | - */ |
|
| 56 | - public function clean(); |
|
| 52 | + /** |
|
| 53 | + * Remove the temporary files and folders generated during this request |
|
| 54 | + * @since 8.0.0 |
|
| 55 | + */ |
|
| 56 | + public function clean(); |
|
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Remove old temporary files and folders that were failed to be cleaned |
|
| 60 | - * @since 8.0.0 |
|
| 61 | - */ |
|
| 62 | - public function cleanOld(); |
|
| 58 | + /** |
|
| 59 | + * Remove old temporary files and folders that were failed to be cleaned |
|
| 60 | + * @since 8.0.0 |
|
| 61 | + */ |
|
| 62 | + public function cleanOld(); |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * Get the temporary base directory |
|
| 66 | - * |
|
| 67 | - * @return string |
|
| 68 | - * @since 8.2.0 |
|
| 69 | - */ |
|
| 70 | - public function getTempBaseDir(); |
|
| 64 | + /** |
|
| 65 | + * Get the temporary base directory |
|
| 66 | + * |
|
| 67 | + * @return string |
|
| 68 | + * @since 8.2.0 |
|
| 69 | + */ |
|
| 70 | + public function getTempBaseDir(); |
|
| 71 | 71 | } |
@@ -31,18 +31,18 @@ |
||
| 31 | 31 | * @since 9.1 |
| 32 | 32 | */ |
| 33 | 33 | interface IManager { |
| 34 | - /** |
|
| 35 | - * @param IStorage $storage |
|
| 36 | - * @param string $path |
|
| 37 | - * @since 9.1 |
|
| 38 | - */ |
|
| 39 | - public function setFileInfo(IStorage $storage, $path); |
|
| 34 | + /** |
|
| 35 | + * @param IStorage $storage |
|
| 36 | + * @param string $path |
|
| 37 | + * @since 9.1 |
|
| 38 | + */ |
|
| 39 | + public function setFileInfo(IStorage $storage, $path); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @param string $class |
|
| 43 | - * @param bool $returnFirstMatchingOperationOnly |
|
| 44 | - * @return array |
|
| 45 | - * @since 9.1 |
|
| 46 | - */ |
|
| 47 | - public function getMatchingOperations($class, $returnFirstMatchingOperationOnly = true); |
|
| 41 | + /** |
|
| 42 | + * @param string $class |
|
| 43 | + * @param bool $returnFirstMatchingOperationOnly |
|
| 44 | + * @return array |
|
| 45 | + * @since 9.1 |
|
| 46 | + */ |
|
| 47 | + public function getMatchingOperations($class, $returnFirstMatchingOperationOnly = true); |
|
| 48 | 48 | } |
@@ -28,12 +28,12 @@ |
||
| 28 | 28 | * @since 9.1 |
| 29 | 29 | */ |
| 30 | 30 | interface IOperation { |
| 31 | - /** |
|
| 32 | - * @param string $name |
|
| 33 | - * @param array[] $checks |
|
| 34 | - * @param string $operation |
|
| 35 | - * @throws \UnexpectedValueException |
|
| 36 | - * @since 9.1 |
|
| 37 | - */ |
|
| 38 | - public function validateOperation($name, array $checks, $operation); |
|
| 31 | + /** |
|
| 32 | + * @param string $name |
|
| 33 | + * @param array[] $checks |
|
| 34 | + * @param string $operation |
|
| 35 | + * @throws \UnexpectedValueException |
|
| 36 | + * @since 9.1 |
|
| 37 | + */ |
|
| 38 | + public function validateOperation($name, array $checks, $operation); |
|
| 39 | 39 | } |
@@ -31,26 +31,26 @@ |
||
| 31 | 31 | * @since 9.1 |
| 32 | 32 | */ |
| 33 | 33 | interface ICheck { |
| 34 | - /** |
|
| 35 | - * @param IStorage $storage |
|
| 36 | - * @param string $path |
|
| 37 | - * @since 9.1 |
|
| 38 | - */ |
|
| 39 | - public function setFileInfo(IStorage $storage, $path); |
|
| 34 | + /** |
|
| 35 | + * @param IStorage $storage |
|
| 36 | + * @param string $path |
|
| 37 | + * @since 9.1 |
|
| 38 | + */ |
|
| 39 | + public function setFileInfo(IStorage $storage, $path); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @param string $operator |
|
| 43 | - * @param string $value |
|
| 44 | - * @return bool |
|
| 45 | - * @since 9.1 |
|
| 46 | - */ |
|
| 47 | - public function executeCheck($operator, $value); |
|
| 41 | + /** |
|
| 42 | + * @param string $operator |
|
| 43 | + * @param string $value |
|
| 44 | + * @return bool |
|
| 45 | + * @since 9.1 |
|
| 46 | + */ |
|
| 47 | + public function executeCheck($operator, $value); |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @param string $operator |
|
| 51 | - * @param string $value |
|
| 52 | - * @throws \UnexpectedValueException |
|
| 53 | - * @since 9.1 |
|
| 54 | - */ |
|
| 55 | - public function validateCheck($operator, $value); |
|
| 49 | + /** |
|
| 50 | + * @param string $operator |
|
| 51 | + * @param string $value |
|
| 52 | + * @throws \UnexpectedValueException |
|
| 53 | + * @since 9.1 |
|
| 54 | + */ |
|
| 55 | + public function validateCheck($operator, $value); |
|
| 56 | 56 | } |
@@ -36,92 +36,92 @@ |
||
| 36 | 36 | */ |
| 37 | 37 | interface IRouter { |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * Get the files to load the routes from |
|
| 41 | - * |
|
| 42 | - * @return string[] |
|
| 43 | - * @since 7.0.0 |
|
| 44 | - * @deprecated 9.0.0 |
|
| 45 | - */ |
|
| 46 | - public function getRoutingFiles(); |
|
| 39 | + /** |
|
| 40 | + * Get the files to load the routes from |
|
| 41 | + * |
|
| 42 | + * @return string[] |
|
| 43 | + * @since 7.0.0 |
|
| 44 | + * @deprecated 9.0.0 |
|
| 45 | + */ |
|
| 46 | + public function getRoutingFiles(); |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * @return string |
|
| 50 | - * @since 7.0.0 |
|
| 51 | - * @deprecated 9.0.0 |
|
| 52 | - */ |
|
| 53 | - public function getCacheKey(); |
|
| 48 | + /** |
|
| 49 | + * @return string |
|
| 50 | + * @since 7.0.0 |
|
| 51 | + * @deprecated 9.0.0 |
|
| 52 | + */ |
|
| 53 | + public function getCacheKey(); |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Loads the routes |
|
| 57 | - * |
|
| 58 | - * @param null|string $app |
|
| 59 | - * @since 7.0.0 |
|
| 60 | - * @deprecated 9.0.0 |
|
| 61 | - */ |
|
| 62 | - public function loadRoutes($app = null); |
|
| 55 | + /** |
|
| 56 | + * Loads the routes |
|
| 57 | + * |
|
| 58 | + * @param null|string $app |
|
| 59 | + * @since 7.0.0 |
|
| 60 | + * @deprecated 9.0.0 |
|
| 61 | + */ |
|
| 62 | + public function loadRoutes($app = null); |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * Sets the collection to use for adding routes |
|
| 66 | - * |
|
| 67 | - * @param string $name Name of the collection to use. |
|
| 68 | - * @return void |
|
| 69 | - * @since 7.0.0 |
|
| 70 | - * @deprecated 9.0.0 |
|
| 71 | - */ |
|
| 72 | - public function useCollection($name); |
|
| 64 | + /** |
|
| 65 | + * Sets the collection to use for adding routes |
|
| 66 | + * |
|
| 67 | + * @param string $name Name of the collection to use. |
|
| 68 | + * @return void |
|
| 69 | + * @since 7.0.0 |
|
| 70 | + * @deprecated 9.0.0 |
|
| 71 | + */ |
|
| 72 | + public function useCollection($name); |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * returns the current collection name in use for adding routes |
|
| 76 | - * |
|
| 77 | - * @return string the collection name |
|
| 78 | - * @since 8.0.0 |
|
| 79 | - * @deprecated 9.0.0 |
|
| 80 | - */ |
|
| 81 | - public function getCurrentCollection(); |
|
| 74 | + /** |
|
| 75 | + * returns the current collection name in use for adding routes |
|
| 76 | + * |
|
| 77 | + * @return string the collection name |
|
| 78 | + * @since 8.0.0 |
|
| 79 | + * @deprecated 9.0.0 |
|
| 80 | + */ |
|
| 81 | + public function getCurrentCollection(); |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Create a \OCP\Route\IRoute. |
|
| 85 | - * |
|
| 86 | - * @param string $name Name of the route to create. |
|
| 87 | - * @param string $pattern The pattern to match |
|
| 88 | - * @param array $defaults An array of default parameter values |
|
| 89 | - * @param array $requirements An array of requirements for parameters (regexes) |
|
| 90 | - * @return \OCP\Route\IRoute |
|
| 91 | - * @since 7.0.0 |
|
| 92 | - * @deprecated 9.0.0 |
|
| 93 | - */ |
|
| 94 | - public function create($name, $pattern, array $defaults = array(), array $requirements = array()); |
|
| 83 | + /** |
|
| 84 | + * Create a \OCP\Route\IRoute. |
|
| 85 | + * |
|
| 86 | + * @param string $name Name of the route to create. |
|
| 87 | + * @param string $pattern The pattern to match |
|
| 88 | + * @param array $defaults An array of default parameter values |
|
| 89 | + * @param array $requirements An array of requirements for parameters (regexes) |
|
| 90 | + * @return \OCP\Route\IRoute |
|
| 91 | + * @since 7.0.0 |
|
| 92 | + * @deprecated 9.0.0 |
|
| 93 | + */ |
|
| 94 | + public function create($name, $pattern, array $defaults = array(), array $requirements = array()); |
|
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * Find the route matching $url. |
|
| 98 | - * |
|
| 99 | - * @param string $url The url to find |
|
| 100 | - * @throws \Exception |
|
| 101 | - * @return void |
|
| 102 | - * @since 7.0.0 |
|
| 103 | - * @deprecated 9.0.0 |
|
| 104 | - */ |
|
| 105 | - public function match($url); |
|
| 96 | + /** |
|
| 97 | + * Find the route matching $url. |
|
| 98 | + * |
|
| 99 | + * @param string $url The url to find |
|
| 100 | + * @throws \Exception |
|
| 101 | + * @return void |
|
| 102 | + * @since 7.0.0 |
|
| 103 | + * @deprecated 9.0.0 |
|
| 104 | + */ |
|
| 105 | + public function match($url); |
|
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * Get the url generator |
|
| 109 | - * |
|
| 110 | - * @since 7.0.0 |
|
| 111 | - * @deprecated 9.0.0 |
|
| 112 | - */ |
|
| 113 | - public function getGenerator(); |
|
| 107 | + /** |
|
| 108 | + * Get the url generator |
|
| 109 | + * |
|
| 110 | + * @since 7.0.0 |
|
| 111 | + * @deprecated 9.0.0 |
|
| 112 | + */ |
|
| 113 | + public function getGenerator(); |
|
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Generate url based on $name and $parameters |
|
| 117 | - * |
|
| 118 | - * @param string $name Name of the route to use. |
|
| 119 | - * @param array $parameters Parameters for the route |
|
| 120 | - * @param bool $absolute |
|
| 121 | - * @return string |
|
| 122 | - * @since 7.0.0 |
|
| 123 | - * @deprecated 9.0.0 |
|
| 124 | - */ |
|
| 125 | - public function generate($name, $parameters = array(), $absolute = false); |
|
| 115 | + /** |
|
| 116 | + * Generate url based on $name and $parameters |
|
| 117 | + * |
|
| 118 | + * @param string $name Name of the route to use. |
|
| 119 | + * @param array $parameters Parameters for the route |
|
| 120 | + * @param bool $absolute |
|
| 121 | + * @return string |
|
| 122 | + * @since 7.0.0 |
|
| 123 | + * @deprecated 9.0.0 |
|
| 124 | + */ |
|
| 125 | + public function generate($name, $parameters = array(), $absolute = false); |
|
| 126 | 126 | |
| 127 | 127 | } |
@@ -31,88 +31,88 @@ |
||
| 31 | 31 | * @since 7.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface IRoute { |
| 34 | - /** |
|
| 35 | - * Specify PATCH as the method to use with this route |
|
| 36 | - * @return \OCP\Route\IRoute |
|
| 37 | - * @since 7.0.0 |
|
| 38 | - */ |
|
| 39 | - public function patch(); |
|
| 34 | + /** |
|
| 35 | + * Specify PATCH as the method to use with this route |
|
| 36 | + * @return \OCP\Route\IRoute |
|
| 37 | + * @since 7.0.0 |
|
| 38 | + */ |
|
| 39 | + public function patch(); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Specify the method when this route is to be used |
|
| 43 | - * |
|
| 44 | - * @param string $method HTTP method (uppercase) |
|
| 45 | - * @return \OCP\Route\IRoute |
|
| 46 | - * @since 7.0.0 |
|
| 47 | - */ |
|
| 48 | - public function method($method); |
|
| 41 | + /** |
|
| 42 | + * Specify the method when this route is to be used |
|
| 43 | + * |
|
| 44 | + * @param string $method HTTP method (uppercase) |
|
| 45 | + * @return \OCP\Route\IRoute |
|
| 46 | + * @since 7.0.0 |
|
| 47 | + */ |
|
| 48 | + public function method($method); |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * The action to execute when this route matches, includes a file like |
|
| 52 | - * it is called directly |
|
| 53 | - * |
|
| 54 | - * @param string $file |
|
| 55 | - * @return void |
|
| 56 | - * @since 7.0.0 |
|
| 57 | - */ |
|
| 58 | - public function actionInclude($file); |
|
| 50 | + /** |
|
| 51 | + * The action to execute when this route matches, includes a file like |
|
| 52 | + * it is called directly |
|
| 53 | + * |
|
| 54 | + * @param string $file |
|
| 55 | + * @return void |
|
| 56 | + * @since 7.0.0 |
|
| 57 | + */ |
|
| 58 | + public function actionInclude($file); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Specify GET as the method to use with this route |
|
| 62 | - * @return \OCP\Route\IRoute |
|
| 63 | - * @since 7.0.0 |
|
| 64 | - */ |
|
| 65 | - public function get(); |
|
| 60 | + /** |
|
| 61 | + * Specify GET as the method to use with this route |
|
| 62 | + * @return \OCP\Route\IRoute |
|
| 63 | + * @since 7.0.0 |
|
| 64 | + */ |
|
| 65 | + public function get(); |
|
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Specify POST as the method to use with this route |
|
| 69 | - * @return \OCP\Route\IRoute |
|
| 70 | - * @since 7.0.0 |
|
| 71 | - */ |
|
| 72 | - public function post(); |
|
| 67 | + /** |
|
| 68 | + * Specify POST as the method to use with this route |
|
| 69 | + * @return \OCP\Route\IRoute |
|
| 70 | + * @since 7.0.0 |
|
| 71 | + */ |
|
| 72 | + public function post(); |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Specify DELETE as the method to use with this route |
|
| 76 | - * @return \OCP\Route\IRoute |
|
| 77 | - * @since 7.0.0 |
|
| 78 | - */ |
|
| 79 | - public function delete(); |
|
| 74 | + /** |
|
| 75 | + * Specify DELETE as the method to use with this route |
|
| 76 | + * @return \OCP\Route\IRoute |
|
| 77 | + * @since 7.0.0 |
|
| 78 | + */ |
|
| 79 | + public function delete(); |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * The action to execute when this route matches |
|
| 83 | - * |
|
| 84 | - * @param string|callable $class the class or a callable |
|
| 85 | - * @param string $function the function to use with the class |
|
| 86 | - * @return \OCP\Route\IRoute |
|
| 87 | - * |
|
| 88 | - * This function is called with $class set to a callable or |
|
| 89 | - * to the class with $function |
|
| 90 | - * @since 7.0.0 |
|
| 91 | - */ |
|
| 92 | - public function action($class, $function = null); |
|
| 81 | + /** |
|
| 82 | + * The action to execute when this route matches |
|
| 83 | + * |
|
| 84 | + * @param string|callable $class the class or a callable |
|
| 85 | + * @param string $function the function to use with the class |
|
| 86 | + * @return \OCP\Route\IRoute |
|
| 87 | + * |
|
| 88 | + * This function is called with $class set to a callable or |
|
| 89 | + * to the class with $function |
|
| 90 | + * @since 7.0.0 |
|
| 91 | + */ |
|
| 92 | + public function action($class, $function = null); |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Defaults to use for this route |
|
| 96 | - * |
|
| 97 | - * @param array $defaults The defaults |
|
| 98 | - * @return \OCP\Route\IRoute |
|
| 99 | - * @since 7.0.0 |
|
| 100 | - */ |
|
| 101 | - public function defaults($defaults); |
|
| 94 | + /** |
|
| 95 | + * Defaults to use for this route |
|
| 96 | + * |
|
| 97 | + * @param array $defaults The defaults |
|
| 98 | + * @return \OCP\Route\IRoute |
|
| 99 | + * @since 7.0.0 |
|
| 100 | + */ |
|
| 101 | + public function defaults($defaults); |
|
| 102 | 102 | |
| 103 | - /** |
|
| 104 | - * Requirements for this route |
|
| 105 | - * |
|
| 106 | - * @param array $requirements The requirements |
|
| 107 | - * @return \OCP\Route\IRoute |
|
| 108 | - * @since 7.0.0 |
|
| 109 | - */ |
|
| 110 | - public function requirements($requirements); |
|
| 103 | + /** |
|
| 104 | + * Requirements for this route |
|
| 105 | + * |
|
| 106 | + * @param array $requirements The requirements |
|
| 107 | + * @return \OCP\Route\IRoute |
|
| 108 | + * @since 7.0.0 |
|
| 109 | + */ |
|
| 110 | + public function requirements($requirements); |
|
| 111 | 111 | |
| 112 | - /** |
|
| 113 | - * Specify PUT as the method to use with this route |
|
| 114 | - * @return \OCP\Route\IRoute |
|
| 115 | - * @since 7.0.0 |
|
| 116 | - */ |
|
| 117 | - public function put(); |
|
| 112 | + /** |
|
| 113 | + * Specify PUT as the method to use with this route |
|
| 114 | + * @return \OCP\Route\IRoute |
|
| 115 | + * @since 7.0.0 |
|
| 116 | + */ |
|
| 117 | + public function put(); |
|
| 118 | 118 | } |
@@ -39,22 +39,22 @@ |
||
| 39 | 39 | * @since 6.0.0 |
| 40 | 40 | */ |
| 41 | 41 | interface INavigationManager { |
| 42 | - /** |
|
| 43 | - * Creates a new navigation entry |
|
| 44 | - * |
|
| 45 | - * @param array|\Closure $entry Array containing: id, name, order, icon and href key |
|
| 46 | - * The use of a closure is preferred, because it will avoid |
|
| 47 | - * loading the routing of your app, unless required. |
|
| 48 | - * @return void |
|
| 49 | - * @since 6.0.0 |
|
| 50 | - */ |
|
| 51 | - public function add($entry); |
|
| 42 | + /** |
|
| 43 | + * Creates a new navigation entry |
|
| 44 | + * |
|
| 45 | + * @param array|\Closure $entry Array containing: id, name, order, icon and href key |
|
| 46 | + * The use of a closure is preferred, because it will avoid |
|
| 47 | + * loading the routing of your app, unless required. |
|
| 48 | + * @return void |
|
| 49 | + * @since 6.0.0 |
|
| 50 | + */ |
|
| 51 | + public function add($entry); |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Sets the current navigation entry of the currently running app |
|
| 55 | - * @param string $appId id of the app entry to activate (from added $entry) |
|
| 56 | - * @return void |
|
| 57 | - * @since 6.0.0 |
|
| 58 | - */ |
|
| 59 | - public function setActiveEntry($appId); |
|
| 53 | + /** |
|
| 54 | + * Sets the current navigation entry of the currently running app |
|
| 55 | + * @param string $appId id of the app entry to activate (from added $entry) |
|
| 56 | + * @return void |
|
| 57 | + * @since 6.0.0 |
|
| 58 | + */ |
|
| 59 | + public function setActiveEntry($appId); |
|
| 60 | 60 | } |
@@ -33,20 +33,20 @@ |
||
| 33 | 33 | * @since 8.0.0 |
| 34 | 34 | */ |
| 35 | 35 | interface IEventSource { |
| 36 | - /** |
|
| 37 | - * send a message to the client |
|
| 38 | - * |
|
| 39 | - * @param string $type |
|
| 40 | - * @param mixed $data |
|
| 41 | - * |
|
| 42 | - * if only one parameter is given, a typeless message will be send with that parameter as data |
|
| 43 | - * @since 8.0.0 |
|
| 44 | - */ |
|
| 45 | - public function send($type, $data = null); |
|
| 36 | + /** |
|
| 37 | + * send a message to the client |
|
| 38 | + * |
|
| 39 | + * @param string $type |
|
| 40 | + * @param mixed $data |
|
| 41 | + * |
|
| 42 | + * if only one parameter is given, a typeless message will be send with that parameter as data |
|
| 43 | + * @since 8.0.0 |
|
| 44 | + */ |
|
| 45 | + public function send($type, $data = null); |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * close the connection of the event source |
|
| 49 | - * @since 8.0.0 |
|
| 50 | - */ |
|
| 51 | - public function close(); |
|
| 47 | + /** |
|
| 48 | + * close the connection of the event source |
|
| 49 | + * @since 8.0.0 |
|
| 50 | + */ |
|
| 51 | + public function close(); |
|
| 52 | 52 | } |
@@ -34,170 +34,170 @@ |
||
| 34 | 34 | */ |
| 35 | 35 | interface IUser { |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * get the user id |
|
| 39 | - * |
|
| 40 | - * @return string |
|
| 41 | - * @since 8.0.0 |
|
| 42 | - */ |
|
| 43 | - public function getUID(); |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * get the display name for the user, if no specific display name is set it will fallback to the user id |
|
| 47 | - * |
|
| 48 | - * @return string |
|
| 49 | - * @since 8.0.0 |
|
| 50 | - */ |
|
| 51 | - public function getDisplayName(); |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * set the display name for the user |
|
| 55 | - * |
|
| 56 | - * @param string $displayName |
|
| 57 | - * @return bool |
|
| 58 | - * @since 8.0.0 |
|
| 59 | - */ |
|
| 60 | - public function setDisplayName($displayName); |
|
| 61 | - |
|
| 62 | - /** |
|
| 63 | - * returns the timestamp of the user's last login or 0 if the user did never |
|
| 64 | - * login |
|
| 65 | - * |
|
| 66 | - * @return int |
|
| 67 | - * @since 8.0.0 |
|
| 68 | - */ |
|
| 69 | - public function getLastLogin(); |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * updates the timestamp of the most recent login of this user |
|
| 73 | - * @since 8.0.0 |
|
| 74 | - */ |
|
| 75 | - public function updateLastLoginTimestamp(); |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * Delete the user |
|
| 79 | - * |
|
| 80 | - * @return bool |
|
| 81 | - * @since 8.0.0 |
|
| 82 | - */ |
|
| 83 | - public function delete(); |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Set the password of the user |
|
| 87 | - * |
|
| 88 | - * @param string $password |
|
| 89 | - * @param string $recoveryPassword for the encryption app to reset encryption keys |
|
| 90 | - * @return bool |
|
| 91 | - * @since 8.0.0 |
|
| 92 | - */ |
|
| 93 | - public function setPassword($password, $recoveryPassword = null); |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * get the users home folder to mount |
|
| 97 | - * |
|
| 98 | - * @return string |
|
| 99 | - * @since 8.0.0 |
|
| 100 | - */ |
|
| 101 | - public function getHome(); |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * Get the name of the backend class the user is connected with |
|
| 105 | - * |
|
| 106 | - * @return string |
|
| 107 | - * @since 8.0.0 |
|
| 108 | - */ |
|
| 109 | - public function getBackendClassName(); |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * check if the backend allows the user to change his avatar on Personal page |
|
| 113 | - * |
|
| 114 | - * @return bool |
|
| 115 | - * @since 8.0.0 |
|
| 116 | - */ |
|
| 117 | - public function canChangeAvatar(); |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * check if the backend supports changing passwords |
|
| 121 | - * |
|
| 122 | - * @return bool |
|
| 123 | - * @since 8.0.0 |
|
| 124 | - */ |
|
| 125 | - public function canChangePassword(); |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * check if the backend supports changing display names |
|
| 129 | - * |
|
| 130 | - * @return bool |
|
| 131 | - * @since 8.0.0 |
|
| 132 | - */ |
|
| 133 | - public function canChangeDisplayName(); |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * check if the user is enabled |
|
| 137 | - * |
|
| 138 | - * @return bool |
|
| 139 | - * @since 8.0.0 |
|
| 140 | - */ |
|
| 141 | - public function isEnabled(); |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * set the enabled status for the user |
|
| 145 | - * |
|
| 146 | - * @param bool $enabled |
|
| 147 | - * @since 8.0.0 |
|
| 148 | - */ |
|
| 149 | - public function setEnabled($enabled); |
|
| 150 | - |
|
| 151 | - /** |
|
| 152 | - * get the users email address |
|
| 153 | - * |
|
| 154 | - * @return string|null |
|
| 155 | - * @since 9.0.0 |
|
| 156 | - */ |
|
| 157 | - public function getEMailAddress(); |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * get the avatar image if it exists |
|
| 161 | - * |
|
| 162 | - * @param int $size |
|
| 163 | - * @return IImage|null |
|
| 164 | - * @since 9.0.0 |
|
| 165 | - */ |
|
| 166 | - public function getAvatarImage($size); |
|
| 167 | - |
|
| 168 | - /** |
|
| 169 | - * get the federation cloud id |
|
| 170 | - * |
|
| 171 | - * @return string |
|
| 172 | - * @since 9.0.0 |
|
| 173 | - */ |
|
| 174 | - public function getCloudId(); |
|
| 175 | - |
|
| 176 | - /** |
|
| 177 | - * set the email address of the user |
|
| 178 | - * |
|
| 179 | - * @param string|null $mailAddress |
|
| 180 | - * @return void |
|
| 181 | - * @since 9.0.0 |
|
| 182 | - */ |
|
| 183 | - public function setEMailAddress($mailAddress); |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * get the users' quota in human readable form. If a specific quota is not |
|
| 187 | - * set for the user, the default value is returned. If a default setting |
|
| 188 | - * was not set otherwise, it is return as 'none', i.e. quota is not limited. |
|
| 189 | - * |
|
| 190 | - * @return string |
|
| 191 | - * @since 9.0.0 |
|
| 192 | - */ |
|
| 193 | - public function getQuota(); |
|
| 194 | - |
|
| 195 | - /** |
|
| 196 | - * set the users' quota |
|
| 197 | - * |
|
| 198 | - * @param string $quota |
|
| 199 | - * @return void |
|
| 200 | - * @since 9.0.0 |
|
| 201 | - */ |
|
| 202 | - public function setQuota($quota); |
|
| 37 | + /** |
|
| 38 | + * get the user id |
|
| 39 | + * |
|
| 40 | + * @return string |
|
| 41 | + * @since 8.0.0 |
|
| 42 | + */ |
|
| 43 | + public function getUID(); |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * get the display name for the user, if no specific display name is set it will fallback to the user id |
|
| 47 | + * |
|
| 48 | + * @return string |
|
| 49 | + * @since 8.0.0 |
|
| 50 | + */ |
|
| 51 | + public function getDisplayName(); |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * set the display name for the user |
|
| 55 | + * |
|
| 56 | + * @param string $displayName |
|
| 57 | + * @return bool |
|
| 58 | + * @since 8.0.0 |
|
| 59 | + */ |
|
| 60 | + public function setDisplayName($displayName); |
|
| 61 | + |
|
| 62 | + /** |
|
| 63 | + * returns the timestamp of the user's last login or 0 if the user did never |
|
| 64 | + * login |
|
| 65 | + * |
|
| 66 | + * @return int |
|
| 67 | + * @since 8.0.0 |
|
| 68 | + */ |
|
| 69 | + public function getLastLogin(); |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * updates the timestamp of the most recent login of this user |
|
| 73 | + * @since 8.0.0 |
|
| 74 | + */ |
|
| 75 | + public function updateLastLoginTimestamp(); |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * Delete the user |
|
| 79 | + * |
|
| 80 | + * @return bool |
|
| 81 | + * @since 8.0.0 |
|
| 82 | + */ |
|
| 83 | + public function delete(); |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Set the password of the user |
|
| 87 | + * |
|
| 88 | + * @param string $password |
|
| 89 | + * @param string $recoveryPassword for the encryption app to reset encryption keys |
|
| 90 | + * @return bool |
|
| 91 | + * @since 8.0.0 |
|
| 92 | + */ |
|
| 93 | + public function setPassword($password, $recoveryPassword = null); |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * get the users home folder to mount |
|
| 97 | + * |
|
| 98 | + * @return string |
|
| 99 | + * @since 8.0.0 |
|
| 100 | + */ |
|
| 101 | + public function getHome(); |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * Get the name of the backend class the user is connected with |
|
| 105 | + * |
|
| 106 | + * @return string |
|
| 107 | + * @since 8.0.0 |
|
| 108 | + */ |
|
| 109 | + public function getBackendClassName(); |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * check if the backend allows the user to change his avatar on Personal page |
|
| 113 | + * |
|
| 114 | + * @return bool |
|
| 115 | + * @since 8.0.0 |
|
| 116 | + */ |
|
| 117 | + public function canChangeAvatar(); |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * check if the backend supports changing passwords |
|
| 121 | + * |
|
| 122 | + * @return bool |
|
| 123 | + * @since 8.0.0 |
|
| 124 | + */ |
|
| 125 | + public function canChangePassword(); |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * check if the backend supports changing display names |
|
| 129 | + * |
|
| 130 | + * @return bool |
|
| 131 | + * @since 8.0.0 |
|
| 132 | + */ |
|
| 133 | + public function canChangeDisplayName(); |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * check if the user is enabled |
|
| 137 | + * |
|
| 138 | + * @return bool |
|
| 139 | + * @since 8.0.0 |
|
| 140 | + */ |
|
| 141 | + public function isEnabled(); |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * set the enabled status for the user |
|
| 145 | + * |
|
| 146 | + * @param bool $enabled |
|
| 147 | + * @since 8.0.0 |
|
| 148 | + */ |
|
| 149 | + public function setEnabled($enabled); |
|
| 150 | + |
|
| 151 | + /** |
|
| 152 | + * get the users email address |
|
| 153 | + * |
|
| 154 | + * @return string|null |
|
| 155 | + * @since 9.0.0 |
|
| 156 | + */ |
|
| 157 | + public function getEMailAddress(); |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * get the avatar image if it exists |
|
| 161 | + * |
|
| 162 | + * @param int $size |
|
| 163 | + * @return IImage|null |
|
| 164 | + * @since 9.0.0 |
|
| 165 | + */ |
|
| 166 | + public function getAvatarImage($size); |
|
| 167 | + |
|
| 168 | + /** |
|
| 169 | + * get the federation cloud id |
|
| 170 | + * |
|
| 171 | + * @return string |
|
| 172 | + * @since 9.0.0 |
|
| 173 | + */ |
|
| 174 | + public function getCloudId(); |
|
| 175 | + |
|
| 176 | + /** |
|
| 177 | + * set the email address of the user |
|
| 178 | + * |
|
| 179 | + * @param string|null $mailAddress |
|
| 180 | + * @return void |
|
| 181 | + * @since 9.0.0 |
|
| 182 | + */ |
|
| 183 | + public function setEMailAddress($mailAddress); |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * get the users' quota in human readable form. If a specific quota is not |
|
| 187 | + * set for the user, the default value is returned. If a default setting |
|
| 188 | + * was not set otherwise, it is return as 'none', i.e. quota is not limited. |
|
| 189 | + * |
|
| 190 | + * @return string |
|
| 191 | + * @since 9.0.0 |
|
| 192 | + */ |
|
| 193 | + public function getQuota(); |
|
| 194 | + |
|
| 195 | + /** |
|
| 196 | + * set the users' quota |
|
| 197 | + * |
|
| 198 | + * @param string $quota |
|
| 199 | + * @return void |
|
| 200 | + * @since 9.0.0 |
|
| 201 | + */ |
|
| 202 | + public function setQuota($quota); |
|
| 203 | 203 | } |