@@ -61,7 +61,7 @@ |
||
61 | 61 | */ |
62 | 62 | public function addEntityCollection($name, \Closure $entityExistsFunction) { |
63 | 63 | if (isset($this->collections[$name])) { |
64 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
64 | + throw new \OutOfBoundsException('Duplicate entity name "'.$name.'"'); |
|
65 | 65 | } |
66 | 66 | |
67 | 67 | $this->collections[$name] = $entityExistsFunction; |
@@ -32,49 +32,49 @@ |
||
32 | 32 | * @since 9.1.0 |
33 | 33 | */ |
34 | 34 | class CommentsEntityEvent extends Event { |
35 | - /** |
|
36 | - * @deprecated 22.0.0 |
|
37 | - */ |
|
38 | - public const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity'; |
|
35 | + /** |
|
36 | + * @deprecated 22.0.0 |
|
37 | + */ |
|
38 | + public const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity'; |
|
39 | 39 | |
40 | - /** @var string */ |
|
41 | - protected $event; |
|
42 | - /** @var \Closure[] */ |
|
43 | - protected $collections; |
|
40 | + /** @var string */ |
|
41 | + protected $event; |
|
42 | + /** @var \Closure[] */ |
|
43 | + protected $collections; |
|
44 | 44 | |
45 | - /** |
|
46 | - * DispatcherEvent constructor. |
|
47 | - * |
|
48 | - * @param string $event |
|
49 | - * @since 9.1.0 |
|
50 | - */ |
|
51 | - public function __construct($event) { |
|
52 | - $this->event = $event; |
|
53 | - $this->collections = []; |
|
54 | - } |
|
45 | + /** |
|
46 | + * DispatcherEvent constructor. |
|
47 | + * |
|
48 | + * @param string $event |
|
49 | + * @since 9.1.0 |
|
50 | + */ |
|
51 | + public function __construct($event) { |
|
52 | + $this->event = $event; |
|
53 | + $this->collections = []; |
|
54 | + } |
|
55 | 55 | |
56 | - /** |
|
57 | - * @param string $name |
|
58 | - * @param \Closure $entityExistsFunction The closure should take one |
|
59 | - * argument, which is the id of the entity, that comments |
|
60 | - * should be handled for. The return should then be bool, |
|
61 | - * depending on whether comments are allowed (true) or not. |
|
62 | - * @throws \OutOfBoundsException when the entity name is already taken |
|
63 | - * @since 9.1.0 |
|
64 | - */ |
|
65 | - public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
66 | - if (isset($this->collections[$name])) { |
|
67 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
68 | - } |
|
56 | + /** |
|
57 | + * @param string $name |
|
58 | + * @param \Closure $entityExistsFunction The closure should take one |
|
59 | + * argument, which is the id of the entity, that comments |
|
60 | + * should be handled for. The return should then be bool, |
|
61 | + * depending on whether comments are allowed (true) or not. |
|
62 | + * @throws \OutOfBoundsException when the entity name is already taken |
|
63 | + * @since 9.1.0 |
|
64 | + */ |
|
65 | + public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
66 | + if (isset($this->collections[$name])) { |
|
67 | + throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
68 | + } |
|
69 | 69 | |
70 | - $this->collections[$name] = $entityExistsFunction; |
|
71 | - } |
|
70 | + $this->collections[$name] = $entityExistsFunction; |
|
71 | + } |
|
72 | 72 | |
73 | - /** |
|
74 | - * @return \Closure[] |
|
75 | - * @since 9.1.0 |
|
76 | - */ |
|
77 | - public function getEntityCollections() { |
|
78 | - return $this->collections; |
|
79 | - } |
|
73 | + /** |
|
74 | + * @return \Closure[] |
|
75 | + * @since 9.1.0 |
|
76 | + */ |
|
77 | + public function getEntityCollections() { |
|
78 | + return $this->collections; |
|
79 | + } |
|
80 | 80 | } |
@@ -30,33 +30,33 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IEvent { |
33 | - /** |
|
34 | - * @return string |
|
35 | - * @since 8.0.0 |
|
36 | - */ |
|
37 | - public function getId(); |
|
33 | + /** |
|
34 | + * @return string |
|
35 | + * @since 8.0.0 |
|
36 | + */ |
|
37 | + public function getId(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return string |
|
41 | - * @since 8.0.0 |
|
42 | - */ |
|
43 | - public function getDescription(); |
|
39 | + /** |
|
40 | + * @return string |
|
41 | + * @since 8.0.0 |
|
42 | + */ |
|
43 | + public function getDescription(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return float |
|
47 | - * @since 8.0.0 |
|
48 | - */ |
|
49 | - public function getStart(); |
|
45 | + /** |
|
46 | + * @return float |
|
47 | + * @since 8.0.0 |
|
48 | + */ |
|
49 | + public function getStart(); |
|
50 | 50 | |
51 | - /** |
|
52 | - * @return float |
|
53 | - * @since 8.0.0 |
|
54 | - */ |
|
55 | - public function getEnd(); |
|
51 | + /** |
|
52 | + * @return float |
|
53 | + * @since 8.0.0 |
|
54 | + */ |
|
55 | + public function getEnd(); |
|
56 | 56 | |
57 | - /** |
|
58 | - * @return float |
|
59 | - * @since 8.0.0 |
|
60 | - */ |
|
61 | - public function getDuration(); |
|
57 | + /** |
|
58 | + * @return float |
|
59 | + * @since 8.0.0 |
|
60 | + */ |
|
61 | + public function getDuration(); |
|
62 | 62 | } |
@@ -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,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 | } |
@@ -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 | } |
@@ -31,13 +31,13 @@ |
||
31 | 31 | * @since 5.0.0 |
32 | 32 | */ |
33 | 33 | interface Share_Backend_File_Dependent extends Share_Backend { |
34 | - /** |
|
35 | - * Get the file path of the item |
|
36 | - * @param string $itemSource |
|
37 | - * @param string $uidOwner User that is the owner of shared item |
|
38 | - * @return string|false |
|
39 | - * @since 5.0.0 |
|
40 | - */ |
|
41 | - public function getFilePath($itemSource, $uidOwner); |
|
34 | + /** |
|
35 | + * Get the file path of the item |
|
36 | + * @param string $itemSource |
|
37 | + * @param string $uidOwner User that is the owner of shared item |
|
38 | + * @return string|false |
|
39 | + * @since 5.0.0 |
|
40 | + */ |
|
41 | + public function getFilePath($itemSource, $uidOwner); |
|
42 | 42 | |
43 | 43 | } |
@@ -31,13 +31,13 @@ |
||
31 | 31 | * @since 8.0.0 |
32 | 32 | */ |
33 | 33 | interface IMountProvider { |
34 | - /** |
|
35 | - * Get all mountpoints applicable for the user |
|
36 | - * |
|
37 | - * @param \OCP\IUser $user |
|
38 | - * @param \OCP\Files\Storage\IStorageFactory $loader |
|
39 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
40 | - * @since 8.0.0 |
|
41 | - */ |
|
42 | - public function getMountsForUser(IUser $user, IStorageFactory $loader); |
|
34 | + /** |
|
35 | + * Get all mountpoints applicable for the user |
|
36 | + * |
|
37 | + * @param \OCP\IUser $user |
|
38 | + * @param \OCP\Files\Storage\IStorageFactory $loader |
|
39 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
40 | + * @since 8.0.0 |
|
41 | + */ |
|
42 | + public function getMountsForUser(IUser $user, IStorageFactory $loader); |
|
43 | 43 | } |
@@ -31,13 +31,13 @@ |
||
31 | 31 | * @since 9.1.0 |
32 | 32 | */ |
33 | 33 | interface IHomeMountProvider { |
34 | - /** |
|
35 | - * Get all mountpoints applicable for the user |
|
36 | - * |
|
37 | - * @param \OCP\IUser $user |
|
38 | - * @param \OCP\Files\Storage\IStorageFactory $loader |
|
39 | - * @return \OCP\Files\Mount\IMountPoint|null |
|
40 | - * @since 9.1.0 |
|
41 | - */ |
|
42 | - public function getHomeMountForUser(IUser $user, IStorageFactory $loader); |
|
34 | + /** |
|
35 | + * Get all mountpoints applicable for the user |
|
36 | + * |
|
37 | + * @param \OCP\IUser $user |
|
38 | + * @param \OCP\Files\Storage\IStorageFactory $loader |
|
39 | + * @return \OCP\Files\Mount\IMountPoint|null |
|
40 | + * @since 9.1.0 |
|
41 | + */ |
|
42 | + public function getHomeMountForUser(IUser $user, IStorageFactory $loader); |
|
43 | 43 | } |