@@ -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 | } |
@@ -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 | } |
@@ -36,12 +36,12 @@ |
||
36 | 36 | */ |
37 | 37 | interface ICapability { |
38 | 38 | |
39 | - /** |
|
40 | - * Function an app uses to return the capabilities |
|
41 | - * |
|
42 | - * @return array Array containing the apps capabilities |
|
43 | - * @since 8.2.0 |
|
44 | - */ |
|
45 | - public function getCapabilities(); |
|
39 | + /** |
|
40 | + * Function an app uses to return the capabilities |
|
41 | + * |
|
42 | + * @return array Array containing the apps capabilities |
|
43 | + * @since 8.2.0 |
|
44 | + */ |
|
45 | + public function getCapabilities(); |
|
46 | 46 | } |
47 | 47 |
@@ -28,22 +28,22 @@ |
||
28 | 28 | */ |
29 | 29 | interface IRepairStep { |
30 | 30 | |
31 | - /** |
|
32 | - * Returns the step's name |
|
33 | - * |
|
34 | - * @return string |
|
35 | - * @since 9.1.0 |
|
36 | - */ |
|
37 | - public function getName(); |
|
31 | + /** |
|
32 | + * Returns the step's name |
|
33 | + * |
|
34 | + * @return string |
|
35 | + * @since 9.1.0 |
|
36 | + */ |
|
37 | + public function getName(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * Run repair step. |
|
41 | - * Must throw exception on error. |
|
42 | - * |
|
43 | - * @param IOutput $output |
|
44 | - * @throws \Exception in case of failure |
|
45 | - * @since 9.1.0 |
|
46 | - */ |
|
47 | - public function run(IOutput $output); |
|
39 | + /** |
|
40 | + * Run repair step. |
|
41 | + * Must throw exception on error. |
|
42 | + * |
|
43 | + * @param IOutput $output |
|
44 | + * @throws \Exception in case of failure |
|
45 | + * @since 9.1.0 |
|
46 | + */ |
|
47 | + public function run(IOutput $output); |
|
48 | 48 | |
49 | 49 | } |
@@ -30,35 +30,35 @@ |
||
30 | 30 | */ |
31 | 31 | interface IOutput { |
32 | 32 | |
33 | - /** |
|
34 | - * @param string $message |
|
35 | - * @since 9.1.0 |
|
36 | - */ |
|
37 | - public function info($message); |
|
33 | + /** |
|
34 | + * @param string $message |
|
35 | + * @since 9.1.0 |
|
36 | + */ |
|
37 | + public function info($message); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @param string $message |
|
41 | - * @since 9.1.0 |
|
42 | - */ |
|
43 | - public function warning($message); |
|
39 | + /** |
|
40 | + * @param string $message |
|
41 | + * @since 9.1.0 |
|
42 | + */ |
|
43 | + public function warning($message); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @param int $max |
|
47 | - * @since 9.1.0 |
|
48 | - */ |
|
49 | - public function startProgress($max = 0); |
|
45 | + /** |
|
46 | + * @param int $max |
|
47 | + * @since 9.1.0 |
|
48 | + */ |
|
49 | + public function startProgress($max = 0); |
|
50 | 50 | |
51 | - /** |
|
52 | - * @param int $step |
|
53 | - * @param string $description |
|
54 | - * @since 9.1.0 |
|
55 | - */ |
|
56 | - public function advance($step = 1, $description = ''); |
|
51 | + /** |
|
52 | + * @param int $step |
|
53 | + * @param string $description |
|
54 | + * @since 9.1.0 |
|
55 | + */ |
|
56 | + public function advance($step = 1, $description = ''); |
|
57 | 57 | |
58 | - /** |
|
59 | - * @param int $max |
|
60 | - * @since 9.1.0 |
|
61 | - */ |
|
62 | - public function finishProgress(); |
|
58 | + /** |
|
59 | + * @param int $max |
|
60 | + * @since 9.1.0 |
|
61 | + */ |
|
62 | + public function finishProgress(); |
|
63 | 63 | |
64 | 64 | } |
@@ -30,9 +30,9 @@ |
||
30 | 30 | * @since 8.1.0 |
31 | 31 | */ |
32 | 32 | interface ICommand { |
33 | - /** |
|
34 | - * Run the command |
|
35 | - * @since 8.1.0 |
|
36 | - */ |
|
37 | - public function handle(); |
|
33 | + /** |
|
34 | + * Run the command |
|
35 | + * @since 8.1.0 |
|
36 | + */ |
|
37 | + public function handle(); |
|
38 | 38 | } |
@@ -30,19 +30,19 @@ |
||
30 | 30 | * @since 8.1.0 |
31 | 31 | */ |
32 | 32 | interface IBus { |
33 | - /** |
|
34 | - * Schedule a command to be fired |
|
35 | - * |
|
36 | - * @param \OCP\Command\ICommand | callable $command |
|
37 | - * @since 8.1.0 |
|
38 | - */ |
|
39 | - public function push($command); |
|
33 | + /** |
|
34 | + * Schedule a command to be fired |
|
35 | + * |
|
36 | + * @param \OCP\Command\ICommand | callable $command |
|
37 | + * @since 8.1.0 |
|
38 | + */ |
|
39 | + public function push($command); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Require all commands using a trait to be run synchronous |
|
43 | - * |
|
44 | - * @param string $trait |
|
45 | - * @since 8.1.0 |
|
46 | - */ |
|
47 | - public function requireSync($trait); |
|
41 | + /** |
|
42 | + * Require all commands using a trait to be run synchronous |
|
43 | + * |
|
44 | + * @param string $trait |
|
45 | + * @since 8.1.0 |
|
46 | + */ |
|
47 | + public function requireSync($trait); |
|
48 | 48 | } |