@@ -41,186 +41,186 @@ |
||
41 | 41 | * @since 6.0.0 |
42 | 42 | */ |
43 | 43 | interface IConfig { |
44 | - /** |
|
45 | - * @since 8.2.0 |
|
46 | - */ |
|
47 | - const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***'; |
|
48 | - |
|
49 | - /** |
|
50 | - * Sets and deletes system wide values |
|
51 | - * |
|
52 | - * @param array $configs Associative array with `key => value` pairs |
|
53 | - * If value is null, the config key will be deleted |
|
54 | - * @since 8.0.0 |
|
55 | - */ |
|
56 | - public function setSystemValues(array $configs); |
|
57 | - |
|
58 | - /** |
|
59 | - * Sets a new system wide value |
|
60 | - * |
|
61 | - * @param string $key the key of the value, under which will be saved |
|
62 | - * @param mixed $value the value that should be stored |
|
63 | - * @since 8.0.0 |
|
64 | - */ |
|
65 | - public function setSystemValue($key, $value); |
|
66 | - |
|
67 | - /** |
|
68 | - * Looks up a system wide defined value |
|
69 | - * |
|
70 | - * @param string $key the key of the value, under which it was saved |
|
71 | - * @param mixed $default the default value to be returned if the value isn't set |
|
72 | - * @return mixed the value or $default |
|
73 | - * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
74 | - */ |
|
75 | - public function getSystemValue($key, $default = ''); |
|
76 | - |
|
77 | - /** |
|
78 | - * Looks up a system wide defined value and filters out sensitive data |
|
79 | - * |
|
80 | - * @param string $key the key of the value, under which it was saved |
|
81 | - * @param mixed $default the default value to be returned if the value isn't set |
|
82 | - * @return mixed the value or $default |
|
83 | - * @since 8.2.0 |
|
84 | - */ |
|
85 | - public function getFilteredSystemValue($key, $default = ''); |
|
86 | - |
|
87 | - /** |
|
88 | - * Delete a system wide defined value |
|
89 | - * |
|
90 | - * @param string $key the key of the value, under which it was saved |
|
91 | - * @since 8.0.0 |
|
92 | - */ |
|
93 | - public function deleteSystemValue($key); |
|
94 | - |
|
95 | - /** |
|
96 | - * Get all keys stored for an app |
|
97 | - * |
|
98 | - * @param string $appName the appName that we stored the value under |
|
99 | - * @return string[] the keys stored for the app |
|
100 | - * @since 8.0.0 |
|
101 | - */ |
|
102 | - public function getAppKeys($appName); |
|
103 | - |
|
104 | - /** |
|
105 | - * Writes a new app wide value |
|
106 | - * |
|
107 | - * @param string $appName the appName that we want to store the value under |
|
108 | - * @param string $key the key of the value, under which will be saved |
|
109 | - * @param string $value the value that should be stored |
|
110 | - * @return void |
|
111 | - * @since 6.0.0 |
|
112 | - */ |
|
113 | - public function setAppValue($appName, $key, $value); |
|
114 | - |
|
115 | - /** |
|
116 | - * Looks up an app wide defined value |
|
117 | - * |
|
118 | - * @param string $appName the appName that we stored the value under |
|
119 | - * @param string $key the key of the value, under which it was saved |
|
120 | - * @param string $default the default value to be returned if the value isn't set |
|
121 | - * @return string the saved value |
|
122 | - * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
123 | - */ |
|
124 | - public function getAppValue($appName, $key, $default = ''); |
|
125 | - |
|
126 | - /** |
|
127 | - * Delete an app wide defined value |
|
128 | - * |
|
129 | - * @param string $appName the appName that we stored the value under |
|
130 | - * @param string $key the key of the value, under which it was saved |
|
131 | - * @since 8.0.0 |
|
132 | - */ |
|
133 | - public function deleteAppValue($appName, $key); |
|
134 | - |
|
135 | - /** |
|
136 | - * Removes all keys in appconfig belonging to the app |
|
137 | - * |
|
138 | - * @param string $appName the appName the configs are stored under |
|
139 | - * @since 8.0.0 |
|
140 | - */ |
|
141 | - public function deleteAppValues($appName); |
|
142 | - |
|
143 | - |
|
144 | - /** |
|
145 | - * Set a user defined value |
|
146 | - * |
|
147 | - * @param string $userId the userId of the user that we want to store the value under |
|
148 | - * @param string $appName the appName that we want to store the value under |
|
149 | - * @param string $key the key under which the value is being stored |
|
150 | - * @param string $value the value that you want to store |
|
151 | - * @param string $preCondition only update if the config value was previously the value passed as $preCondition |
|
152 | - * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met |
|
153 | - * @since 6.0.0 - parameter $precondition was added in 8.0.0 |
|
154 | - */ |
|
155 | - public function setUserValue($userId, $appName, $key, $value, $preCondition = null); |
|
156 | - |
|
157 | - /** |
|
158 | - * Shortcut for getting a user defined value |
|
159 | - * |
|
160 | - * @param string $userId the userId of the user that we want to store the value under |
|
161 | - * @param string $appName the appName that we stored the value under |
|
162 | - * @param string $key the key under which the value is being stored |
|
163 | - * @param mixed $default the default value to be returned if the value isn't set |
|
164 | - * @return string |
|
165 | - * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
166 | - */ |
|
167 | - public function getUserValue($userId, $appName, $key, $default = ''); |
|
168 | - |
|
169 | - /** |
|
170 | - * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. |
|
171 | - * |
|
172 | - * @param string $appName app to get the value for |
|
173 | - * @param string $key the key to get the value for |
|
174 | - * @param array $userIds the user IDs to fetch the values for |
|
175 | - * @return array Mapped values: userId => value |
|
176 | - * @since 8.0.0 |
|
177 | - */ |
|
178 | - public function getUserValueForUsers($appName, $key, $userIds); |
|
179 | - |
|
180 | - /** |
|
181 | - * Get the keys of all stored by an app for the user |
|
182 | - * |
|
183 | - * @param string $userId the userId of the user that we want to store the value under |
|
184 | - * @param string $appName the appName that we stored the value under |
|
185 | - * @return string[] |
|
186 | - * @since 8.0.0 |
|
187 | - */ |
|
188 | - public function getUserKeys($userId, $appName); |
|
189 | - |
|
190 | - /** |
|
191 | - * Delete a user value |
|
192 | - * |
|
193 | - * @param string $userId the userId of the user that we want to store the value under |
|
194 | - * @param string $appName the appName that we stored the value under |
|
195 | - * @param string $key the key under which the value is being stored |
|
196 | - * @since 8.0.0 |
|
197 | - */ |
|
198 | - public function deleteUserValue($userId, $appName, $key); |
|
199 | - |
|
200 | - /** |
|
201 | - * Delete all user values |
|
202 | - * |
|
203 | - * @param string $userId the userId of the user that we want to remove all values from |
|
204 | - * @since 8.0.0 |
|
205 | - */ |
|
206 | - public function deleteAllUserValues($userId); |
|
207 | - |
|
208 | - /** |
|
209 | - * Delete all user related values of one app |
|
210 | - * |
|
211 | - * @param string $appName the appName of the app that we want to remove all values from |
|
212 | - * @since 8.0.0 |
|
213 | - */ |
|
214 | - public function deleteAppFromAllUsers($appName); |
|
215 | - |
|
216 | - /** |
|
217 | - * Determines the users that have the given value set for a specific app-key-pair |
|
218 | - * |
|
219 | - * @param string $appName the app to get the user for |
|
220 | - * @param string $key the key to get the user for |
|
221 | - * @param string $value the value to get the user for |
|
222 | - * @return array of user IDs |
|
223 | - * @since 8.0.0 |
|
224 | - */ |
|
225 | - public function getUsersForUserValue($appName, $key, $value); |
|
44 | + /** |
|
45 | + * @since 8.2.0 |
|
46 | + */ |
|
47 | + const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***'; |
|
48 | + |
|
49 | + /** |
|
50 | + * Sets and deletes system wide values |
|
51 | + * |
|
52 | + * @param array $configs Associative array with `key => value` pairs |
|
53 | + * If value is null, the config key will be deleted |
|
54 | + * @since 8.0.0 |
|
55 | + */ |
|
56 | + public function setSystemValues(array $configs); |
|
57 | + |
|
58 | + /** |
|
59 | + * Sets a new system wide value |
|
60 | + * |
|
61 | + * @param string $key the key of the value, under which will be saved |
|
62 | + * @param mixed $value the value that should be stored |
|
63 | + * @since 8.0.0 |
|
64 | + */ |
|
65 | + public function setSystemValue($key, $value); |
|
66 | + |
|
67 | + /** |
|
68 | + * Looks up a system wide defined value |
|
69 | + * |
|
70 | + * @param string $key the key of the value, under which it was saved |
|
71 | + * @param mixed $default the default value to be returned if the value isn't set |
|
72 | + * @return mixed the value or $default |
|
73 | + * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
74 | + */ |
|
75 | + public function getSystemValue($key, $default = ''); |
|
76 | + |
|
77 | + /** |
|
78 | + * Looks up a system wide defined value and filters out sensitive data |
|
79 | + * |
|
80 | + * @param string $key the key of the value, under which it was saved |
|
81 | + * @param mixed $default the default value to be returned if the value isn't set |
|
82 | + * @return mixed the value or $default |
|
83 | + * @since 8.2.0 |
|
84 | + */ |
|
85 | + public function getFilteredSystemValue($key, $default = ''); |
|
86 | + |
|
87 | + /** |
|
88 | + * Delete a system wide defined value |
|
89 | + * |
|
90 | + * @param string $key the key of the value, under which it was saved |
|
91 | + * @since 8.0.0 |
|
92 | + */ |
|
93 | + public function deleteSystemValue($key); |
|
94 | + |
|
95 | + /** |
|
96 | + * Get all keys stored for an app |
|
97 | + * |
|
98 | + * @param string $appName the appName that we stored the value under |
|
99 | + * @return string[] the keys stored for the app |
|
100 | + * @since 8.0.0 |
|
101 | + */ |
|
102 | + public function getAppKeys($appName); |
|
103 | + |
|
104 | + /** |
|
105 | + * Writes a new app wide value |
|
106 | + * |
|
107 | + * @param string $appName the appName that we want to store the value under |
|
108 | + * @param string $key the key of the value, under which will be saved |
|
109 | + * @param string $value the value that should be stored |
|
110 | + * @return void |
|
111 | + * @since 6.0.0 |
|
112 | + */ |
|
113 | + public function setAppValue($appName, $key, $value); |
|
114 | + |
|
115 | + /** |
|
116 | + * Looks up an app wide defined value |
|
117 | + * |
|
118 | + * @param string $appName the appName that we stored the value under |
|
119 | + * @param string $key the key of the value, under which it was saved |
|
120 | + * @param string $default the default value to be returned if the value isn't set |
|
121 | + * @return string the saved value |
|
122 | + * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
123 | + */ |
|
124 | + public function getAppValue($appName, $key, $default = ''); |
|
125 | + |
|
126 | + /** |
|
127 | + * Delete an app wide defined value |
|
128 | + * |
|
129 | + * @param string $appName the appName that we stored the value under |
|
130 | + * @param string $key the key of the value, under which it was saved |
|
131 | + * @since 8.0.0 |
|
132 | + */ |
|
133 | + public function deleteAppValue($appName, $key); |
|
134 | + |
|
135 | + /** |
|
136 | + * Removes all keys in appconfig belonging to the app |
|
137 | + * |
|
138 | + * @param string $appName the appName the configs are stored under |
|
139 | + * @since 8.0.0 |
|
140 | + */ |
|
141 | + public function deleteAppValues($appName); |
|
142 | + |
|
143 | + |
|
144 | + /** |
|
145 | + * Set a user defined value |
|
146 | + * |
|
147 | + * @param string $userId the userId of the user that we want to store the value under |
|
148 | + * @param string $appName the appName that we want to store the value under |
|
149 | + * @param string $key the key under which the value is being stored |
|
150 | + * @param string $value the value that you want to store |
|
151 | + * @param string $preCondition only update if the config value was previously the value passed as $preCondition |
|
152 | + * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met |
|
153 | + * @since 6.0.0 - parameter $precondition was added in 8.0.0 |
|
154 | + */ |
|
155 | + public function setUserValue($userId, $appName, $key, $value, $preCondition = null); |
|
156 | + |
|
157 | + /** |
|
158 | + * Shortcut for getting a user defined value |
|
159 | + * |
|
160 | + * @param string $userId the userId of the user that we want to store the value under |
|
161 | + * @param string $appName the appName that we stored the value under |
|
162 | + * @param string $key the key under which the value is being stored |
|
163 | + * @param mixed $default the default value to be returned if the value isn't set |
|
164 | + * @return string |
|
165 | + * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
166 | + */ |
|
167 | + public function getUserValue($userId, $appName, $key, $default = ''); |
|
168 | + |
|
169 | + /** |
|
170 | + * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. |
|
171 | + * |
|
172 | + * @param string $appName app to get the value for |
|
173 | + * @param string $key the key to get the value for |
|
174 | + * @param array $userIds the user IDs to fetch the values for |
|
175 | + * @return array Mapped values: userId => value |
|
176 | + * @since 8.0.0 |
|
177 | + */ |
|
178 | + public function getUserValueForUsers($appName, $key, $userIds); |
|
179 | + |
|
180 | + /** |
|
181 | + * Get the keys of all stored by an app for the user |
|
182 | + * |
|
183 | + * @param string $userId the userId of the user that we want to store the value under |
|
184 | + * @param string $appName the appName that we stored the value under |
|
185 | + * @return string[] |
|
186 | + * @since 8.0.0 |
|
187 | + */ |
|
188 | + public function getUserKeys($userId, $appName); |
|
189 | + |
|
190 | + /** |
|
191 | + * Delete a user value |
|
192 | + * |
|
193 | + * @param string $userId the userId of the user that we want to store the value under |
|
194 | + * @param string $appName the appName that we stored the value under |
|
195 | + * @param string $key the key under which the value is being stored |
|
196 | + * @since 8.0.0 |
|
197 | + */ |
|
198 | + public function deleteUserValue($userId, $appName, $key); |
|
199 | + |
|
200 | + /** |
|
201 | + * Delete all user values |
|
202 | + * |
|
203 | + * @param string $userId the userId of the user that we want to remove all values from |
|
204 | + * @since 8.0.0 |
|
205 | + */ |
|
206 | + public function deleteAllUserValues($userId); |
|
207 | + |
|
208 | + /** |
|
209 | + * Delete all user related values of one app |
|
210 | + * |
|
211 | + * @param string $appName the appName of the app that we want to remove all values from |
|
212 | + * @since 8.0.0 |
|
213 | + */ |
|
214 | + public function deleteAppFromAllUsers($appName); |
|
215 | + |
|
216 | + /** |
|
217 | + * Determines the users that have the given value set for a specific app-key-pair |
|
218 | + * |
|
219 | + * @param string $appName the app to get the user for |
|
220 | + * @param string $key the key to get the user for |
|
221 | + * @param string $value the value to get the user for |
|
222 | + * @return array of user IDs |
|
223 | + * @since 8.0.0 |
|
224 | + */ |
|
225 | + public function getUsersForUserValue($appName, $key, $value); |
|
226 | 226 | } |
@@ -44,112 +44,112 @@ |
||
44 | 44 | */ |
45 | 45 | class App { |
46 | 46 | |
47 | - /** |
|
48 | - * Adds an entry to the navigation |
|
49 | - * |
|
50 | - * This function adds a new entry to the navigation visible to users. $data |
|
51 | - * is an associative array. |
|
52 | - * The following keys are required: |
|
53 | - * - id: unique id for this entry ('addressbook_index') |
|
54 | - * - href: link to the page |
|
55 | - * - name: Human readable name ('Addressbook') |
|
56 | - * |
|
57 | - * The following keys are optional: |
|
58 | - * - icon: path to the icon of the app |
|
59 | - * - order: integer, that influences the position of your application in |
|
60 | - * the navigation. Lower values come first. |
|
61 | - * |
|
62 | - * @param array $data containing the data |
|
63 | - * @return boolean |
|
64 | - * |
|
65 | - * @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->add() instead to |
|
66 | - * register a closure, this helps to speed up all requests against ownCloud |
|
67 | - * @since 4.0.0 |
|
68 | - */ |
|
69 | - public static function addNavigationEntry($data) { |
|
70 | - \OC::$server->getNavigationManager()->add($data); |
|
71 | - return true; |
|
72 | - } |
|
47 | + /** |
|
48 | + * Adds an entry to the navigation |
|
49 | + * |
|
50 | + * This function adds a new entry to the navigation visible to users. $data |
|
51 | + * is an associative array. |
|
52 | + * The following keys are required: |
|
53 | + * - id: unique id for this entry ('addressbook_index') |
|
54 | + * - href: link to the page |
|
55 | + * - name: Human readable name ('Addressbook') |
|
56 | + * |
|
57 | + * The following keys are optional: |
|
58 | + * - icon: path to the icon of the app |
|
59 | + * - order: integer, that influences the position of your application in |
|
60 | + * the navigation. Lower values come first. |
|
61 | + * |
|
62 | + * @param array $data containing the data |
|
63 | + * @return boolean |
|
64 | + * |
|
65 | + * @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->add() instead to |
|
66 | + * register a closure, this helps to speed up all requests against ownCloud |
|
67 | + * @since 4.0.0 |
|
68 | + */ |
|
69 | + public static function addNavigationEntry($data) { |
|
70 | + \OC::$server->getNavigationManager()->add($data); |
|
71 | + return true; |
|
72 | + } |
|
73 | 73 | |
74 | - /** |
|
75 | - * Marks a navigation entry as active |
|
76 | - * @param string $id id of the entry |
|
77 | - * @return boolean |
|
78 | - * |
|
79 | - * This function sets a navigation entry as active and removes the 'active' |
|
80 | - * property from all other entries. The templates can use this for |
|
81 | - * highlighting the current position of the user. |
|
82 | - * |
|
83 | - * @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->setActiveEntry() instead |
|
84 | - * @since 4.0.0 |
|
85 | - */ |
|
86 | - public static function setActiveNavigationEntry( $id ) { |
|
87 | - \OC::$server->getNavigationManager()->setActiveEntry($id); |
|
88 | - return true; |
|
89 | - } |
|
74 | + /** |
|
75 | + * Marks a navigation entry as active |
|
76 | + * @param string $id id of the entry |
|
77 | + * @return boolean |
|
78 | + * |
|
79 | + * This function sets a navigation entry as active and removes the 'active' |
|
80 | + * property from all other entries. The templates can use this for |
|
81 | + * highlighting the current position of the user. |
|
82 | + * |
|
83 | + * @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->setActiveEntry() instead |
|
84 | + * @since 4.0.0 |
|
85 | + */ |
|
86 | + public static function setActiveNavigationEntry( $id ) { |
|
87 | + \OC::$server->getNavigationManager()->setActiveEntry($id); |
|
88 | + return true; |
|
89 | + } |
|
90 | 90 | |
91 | - /** |
|
92 | - * Register a Configuration Screen that should appear in the personal settings section. |
|
93 | - * @param string $app appid |
|
94 | - * @param string $page page to be included |
|
95 | - * @return void |
|
96 | - * @since 4.0.0 |
|
97 | - */ |
|
98 | - public static function registerPersonal( $app, $page ) { |
|
99 | - \OC_App::registerPersonal( $app, $page ); |
|
100 | - } |
|
91 | + /** |
|
92 | + * Register a Configuration Screen that should appear in the personal settings section. |
|
93 | + * @param string $app appid |
|
94 | + * @param string $page page to be included |
|
95 | + * @return void |
|
96 | + * @since 4.0.0 |
|
97 | + */ |
|
98 | + public static function registerPersonal( $app, $page ) { |
|
99 | + \OC_App::registerPersonal( $app, $page ); |
|
100 | + } |
|
101 | 101 | |
102 | - /** |
|
103 | - * Register a Configuration Screen that should appear in the Admin section. |
|
104 | - * @param string $app string appid |
|
105 | - * @param string $page string page to be included |
|
106 | - * @return void |
|
107 | - * @since 4.0.0 |
|
108 | - */ |
|
109 | - public static function registerAdmin( $app, $page ) { |
|
110 | - \OC_App::registerAdmin( $app, $page ); |
|
111 | - } |
|
102 | + /** |
|
103 | + * Register a Configuration Screen that should appear in the Admin section. |
|
104 | + * @param string $app string appid |
|
105 | + * @param string $page string page to be included |
|
106 | + * @return void |
|
107 | + * @since 4.0.0 |
|
108 | + */ |
|
109 | + public static function registerAdmin( $app, $page ) { |
|
110 | + \OC_App::registerAdmin( $app, $page ); |
|
111 | + } |
|
112 | 112 | |
113 | - /** |
|
114 | - * Read app metadata from the info.xml file |
|
115 | - * @param string $app id of the app or the path of the info.xml file |
|
116 | - * @param boolean $path (optional) |
|
117 | - * @return array|null |
|
118 | - * @since 4.0.0 |
|
119 | - */ |
|
120 | - public static function getAppInfo( $app, $path=false ) { |
|
121 | - return \OC_App::getAppInfo( $app, $path); |
|
122 | - } |
|
113 | + /** |
|
114 | + * Read app metadata from the info.xml file |
|
115 | + * @param string $app id of the app or the path of the info.xml file |
|
116 | + * @param boolean $path (optional) |
|
117 | + * @return array|null |
|
118 | + * @since 4.0.0 |
|
119 | + */ |
|
120 | + public static function getAppInfo( $app, $path=false ) { |
|
121 | + return \OC_App::getAppInfo( $app, $path); |
|
122 | + } |
|
123 | 123 | |
124 | - /** |
|
125 | - * checks whether or not an app is enabled |
|
126 | - * @param string $app |
|
127 | - * @return boolean |
|
128 | - * |
|
129 | - * This function checks whether or not an app is enabled. |
|
130 | - * @since 4.0.0 |
|
131 | - */ |
|
132 | - public static function isEnabled( $app ) { |
|
133 | - return \OC_App::isEnabled( $app ); |
|
134 | - } |
|
124 | + /** |
|
125 | + * checks whether or not an app is enabled |
|
126 | + * @param string $app |
|
127 | + * @return boolean |
|
128 | + * |
|
129 | + * This function checks whether or not an app is enabled. |
|
130 | + * @since 4.0.0 |
|
131 | + */ |
|
132 | + public static function isEnabled( $app ) { |
|
133 | + return \OC_App::isEnabled( $app ); |
|
134 | + } |
|
135 | 135 | |
136 | - /** |
|
137 | - * Check if the app is enabled, redirects to home if not |
|
138 | - * @param string $app |
|
139 | - * @return void |
|
140 | - * @since 4.0.0 |
|
141 | - * @deprecated 9.0.0 ownCloud core will handle disabled apps and redirects to valid URLs |
|
142 | - */ |
|
143 | - public static function checkAppEnabled( $app ) { |
|
144 | - } |
|
136 | + /** |
|
137 | + * Check if the app is enabled, redirects to home if not |
|
138 | + * @param string $app |
|
139 | + * @return void |
|
140 | + * @since 4.0.0 |
|
141 | + * @deprecated 9.0.0 ownCloud core will handle disabled apps and redirects to valid URLs |
|
142 | + */ |
|
143 | + public static function checkAppEnabled( $app ) { |
|
144 | + } |
|
145 | 145 | |
146 | - /** |
|
147 | - * Get the last version of the app, either from appinfo/version or from appinfo/info.xml |
|
148 | - * @param string $app |
|
149 | - * @return string |
|
150 | - * @since 4.0.0 |
|
151 | - */ |
|
152 | - public static function getAppVersion( $app ) { |
|
153 | - return \OC_App::getAppVersion( $app ); |
|
154 | - } |
|
146 | + /** |
|
147 | + * Get the last version of the app, either from appinfo/version or from appinfo/info.xml |
|
148 | + * @param string $app |
|
149 | + * @return string |
|
150 | + * @since 4.0.0 |
|
151 | + */ |
|
152 | + public static function getAppVersion( $app ) { |
|
153 | + return \OC_App::getAppVersion( $app ); |
|
154 | + } |
|
155 | 155 | } |
@@ -82,7 +82,7 @@ discard block |
||
82 | 82 | * @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->setActiveEntry() instead |
83 | 83 | * @since 4.0.0 |
84 | 84 | */ |
85 | - public static function setActiveNavigationEntry( $id ) { |
|
85 | + public static function setActiveNavigationEntry($id) { |
|
86 | 86 | \OC::$server->getNavigationManager()->setActiveEntry($id); |
87 | 87 | return true; |
88 | 88 | } |
@@ -94,8 +94,8 @@ discard block |
||
94 | 94 | * @return void |
95 | 95 | * @since 4.0.0 |
96 | 96 | */ |
97 | - public static function registerPersonal( $app, $page ) { |
|
98 | - \OC_App::registerPersonal( $app, $page ); |
|
97 | + public static function registerPersonal($app, $page) { |
|
98 | + \OC_App::registerPersonal($app, $page); |
|
99 | 99 | } |
100 | 100 | |
101 | 101 | /** |
@@ -105,8 +105,8 @@ discard block |
||
105 | 105 | * @return void |
106 | 106 | * @since 4.0.0 |
107 | 107 | */ |
108 | - public static function registerAdmin( $app, $page ) { |
|
109 | - \OC_App::registerAdmin( $app, $page ); |
|
108 | + public static function registerAdmin($app, $page) { |
|
109 | + \OC_App::registerAdmin($app, $page); |
|
110 | 110 | } |
111 | 111 | |
112 | 112 | /** |
@@ -116,8 +116,8 @@ discard block |
||
116 | 116 | * @return array|null |
117 | 117 | * @since 4.0.0 |
118 | 118 | */ |
119 | - public static function getAppInfo( $app, $path=false ) { |
|
120 | - return \OC_App::getAppInfo( $app, $path); |
|
119 | + public static function getAppInfo($app, $path = false) { |
|
120 | + return \OC_App::getAppInfo($app, $path); |
|
121 | 121 | } |
122 | 122 | |
123 | 123 | /** |
@@ -128,8 +128,8 @@ discard block |
||
128 | 128 | * This function checks whether or not an app is enabled. |
129 | 129 | * @since 4.0.0 |
130 | 130 | */ |
131 | - public static function isEnabled( $app ) { |
|
132 | - return \OC_App::isEnabled( $app ); |
|
131 | + public static function isEnabled($app) { |
|
132 | + return \OC_App::isEnabled($app); |
|
133 | 133 | } |
134 | 134 | |
135 | 135 | /** |
@@ -139,7 +139,7 @@ discard block |
||
139 | 139 | * @since 4.0.0 |
140 | 140 | * @deprecated 9.0.0 ownCloud core will handle disabled apps and redirects to valid URLs |
141 | 141 | */ |
142 | - public static function checkAppEnabled( $app ) { |
|
142 | + public static function checkAppEnabled($app) { |
|
143 | 143 | } |
144 | 144 | |
145 | 145 | /** |
@@ -148,7 +148,7 @@ discard block |
||
148 | 148 | * @return string |
149 | 149 | * @since 4.0.0 |
150 | 150 | */ |
151 | - public static function getAppVersion( $app ) { |
|
152 | - return \OC_App::getAppVersion( $app ); |
|
151 | + public static function getAppVersion($app) { |
|
152 | + return \OC_App::getAppVersion($app); |
|
153 | 153 | } |
154 | 154 | } |
@@ -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 | } |
@@ -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,26 +33,26 @@ |
||
33 | 33 | */ |
34 | 34 | interface IProviderFactory { |
35 | 35 | |
36 | - /** |
|
37 | - * IProviderFactory constructor. |
|
38 | - * @param IServerContainer $serverContainer |
|
39 | - * @since 9.0.0 |
|
40 | - */ |
|
41 | - public function __construct(IServerContainer $serverContainer); |
|
36 | + /** |
|
37 | + * IProviderFactory constructor. |
|
38 | + * @param IServerContainer $serverContainer |
|
39 | + * @since 9.0.0 |
|
40 | + */ |
|
41 | + public function __construct(IServerContainer $serverContainer); |
|
42 | 42 | |
43 | - /** |
|
44 | - * @param string $id |
|
45 | - * @return IShareProvider |
|
46 | - * @throws ProviderException |
|
47 | - * @since 9.0.0 |
|
48 | - */ |
|
49 | - public function getProvider($id); |
|
43 | + /** |
|
44 | + * @param string $id |
|
45 | + * @return IShareProvider |
|
46 | + * @throws ProviderException |
|
47 | + * @since 9.0.0 |
|
48 | + */ |
|
49 | + public function getProvider($id); |
|
50 | 50 | |
51 | - /** |
|
52 | - * @param int $shareType |
|
53 | - * @return IShareProvider |
|
54 | - * @throws ProviderException |
|
55 | - * @since 9.0.0 |
|
56 | - */ |
|
57 | - public function getProviderForType($shareType); |
|
51 | + /** |
|
52 | + * @param int $shareType |
|
53 | + * @return IShareProvider |
|
54 | + * @throws ProviderException |
|
55 | + * @since 9.0.0 |
|
56 | + */ |
|
57 | + public function getProviderForType($shareType); |
|
58 | 58 | } |
@@ -34,214 +34,214 @@ |
||
34 | 34 | */ |
35 | 35 | interface IManager { |
36 | 36 | |
37 | - /** |
|
38 | - * Create a Share |
|
39 | - * |
|
40 | - * @param IShare $share |
|
41 | - * @return IShare The share object |
|
42 | - * @since 9.0.0 |
|
43 | - */ |
|
44 | - public function createShare(IShare $share); |
|
45 | - |
|
46 | - /** |
|
47 | - * Update a share. |
|
48 | - * The target of the share can't be changed this way: use moveShare |
|
49 | - * The share can't be removed this way (permission 0): use deleteShare |
|
50 | - * |
|
51 | - * @param IShare $share |
|
52 | - * @return IShare The share object |
|
53 | - * @since 9.0.0 |
|
54 | - */ |
|
55 | - public function updateShare(IShare $share); |
|
56 | - |
|
57 | - /** |
|
58 | - * Delete a share |
|
59 | - * |
|
60 | - * @param IShare $share |
|
61 | - * @throws ShareNotFound |
|
62 | - * @since 9.0.0 |
|
63 | - */ |
|
64 | - public function deleteShare(IShare $share); |
|
65 | - |
|
66 | - /** |
|
67 | - * Unshare a file as the recipient. |
|
68 | - * This can be different from a regular delete for example when one of |
|
69 | - * the users in a groups deletes that share. But the provider should |
|
70 | - * handle this. |
|
71 | - * |
|
72 | - * @param IShare $share |
|
73 | - * @param string $recipientId |
|
74 | - * @since 9.0.0 |
|
75 | - */ |
|
76 | - public function deleteFromSelf(IShare $share, $recipientId); |
|
77 | - |
|
78 | - /** |
|
79 | - * Move the share as a recipient of the share. |
|
80 | - * This is updating the share target. So where the recipient has the share mounted. |
|
81 | - * |
|
82 | - * @param IShare $share |
|
83 | - * @param string $recipientId |
|
84 | - * @return IShare |
|
85 | - * @throws \InvalidArgumentException If $share is a link share or the $recipient does not match |
|
86 | - * @since 9.0.0 |
|
87 | - */ |
|
88 | - public function moveShare(IShare $share, $recipientId); |
|
89 | - |
|
90 | - /** |
|
91 | - * Get shares shared by (initiated) by the provided user. |
|
92 | - * |
|
93 | - * @param string $userId |
|
94 | - * @param int $shareType |
|
95 | - * @param \OCP\Files\File|\OCP\Files\Folder $path |
|
96 | - * @param bool $reshares |
|
97 | - * @param int $limit The maximum number of returned results, -1 for all results |
|
98 | - * @param int $offset |
|
99 | - * @return IShare[] |
|
100 | - * @since 9.0.0 |
|
101 | - */ |
|
102 | - public function getSharesBy($userId, $shareType, $path = null, $reshares = false, $limit = 50, $offset = 0); |
|
103 | - |
|
104 | - /** |
|
105 | - * Get shares shared with $user. |
|
106 | - * Filter by $node if provided |
|
107 | - * |
|
108 | - * @param string $userId |
|
109 | - * @param int $shareType |
|
110 | - * @param File|Folder|null $node |
|
111 | - * @param int $limit The maximum number of shares returned, -1 for all |
|
112 | - * @param int $offset |
|
113 | - * @return IShare[] |
|
114 | - * @since 9.0.0 |
|
115 | - */ |
|
116 | - public function getSharedWith($userId, $shareType, $node = null, $limit = 50, $offset = 0); |
|
117 | - |
|
118 | - /** |
|
119 | - * Retrieve a share by the share id. |
|
120 | - * If the recipient is set make sure to retrieve the file for that user. |
|
121 | - * This makes sure that if a user has moved/deleted a group share this |
|
122 | - * is reflected. |
|
123 | - * |
|
124 | - * @param string $id |
|
125 | - * @param IUser|null $recipient |
|
126 | - * @return IShare |
|
127 | - * @throws ShareNotFound |
|
128 | - * @since 9.0.0 |
|
129 | - */ |
|
130 | - public function getShareById($id, $recipient = null); |
|
131 | - |
|
132 | - /** |
|
133 | - * Get the share by token possible with password |
|
134 | - * |
|
135 | - * @param string $token |
|
136 | - * @return IShare |
|
137 | - * @throws ShareNotFound |
|
138 | - * @since 9.0.0 |
|
139 | - */ |
|
140 | - public function getShareByToken($token); |
|
141 | - |
|
142 | - /** |
|
143 | - * Verify the password of a public share |
|
144 | - * |
|
145 | - * @param IShare $share |
|
146 | - * @param string $password |
|
147 | - * @return bool |
|
148 | - * @since 9.0.0 |
|
149 | - */ |
|
150 | - public function checkPassword(IShare $share, $password); |
|
151 | - |
|
152 | - /** |
|
153 | - * Instantiates a new share object. This is to be passed to |
|
154 | - * createShare. |
|
155 | - * |
|
156 | - * @return IShare |
|
157 | - * @since 9.0.0 |
|
158 | - */ |
|
159 | - public function newShare(); |
|
160 | - |
|
161 | - /** |
|
162 | - * Is the share API enabled |
|
163 | - * |
|
164 | - * @return bool |
|
165 | - * @since 9.0.0 |
|
166 | - */ |
|
167 | - public function shareApiEnabled(); |
|
168 | - |
|
169 | - /** |
|
170 | - * Is public link sharing enabled |
|
171 | - * |
|
172 | - * @return bool |
|
173 | - * @since 9.0.0 |
|
174 | - */ |
|
175 | - public function shareApiAllowLinks(); |
|
176 | - |
|
177 | - /** |
|
178 | - * Is password on public link requires |
|
179 | - * |
|
180 | - * @return bool |
|
181 | - * @since 9.0.0 |
|
182 | - */ |
|
183 | - public function shareApiLinkEnforcePassword(); |
|
184 | - |
|
185 | - /** |
|
186 | - * Is default expire date enabled |
|
187 | - * |
|
188 | - * @return bool |
|
189 | - * @since 9.0.0 |
|
190 | - */ |
|
191 | - public function shareApiLinkDefaultExpireDate(); |
|
192 | - |
|
193 | - /** |
|
194 | - * Is default expire date enforced |
|
195 | - *` |
|
196 | - * @return bool |
|
197 | - * @since 9.0.0 |
|
198 | - */ |
|
199 | - public function shareApiLinkDefaultExpireDateEnforced(); |
|
200 | - |
|
201 | - /** |
|
202 | - * Number of default expire days |
|
203 | - * |
|
204 | - * @return int |
|
205 | - * @since 9.0.0 |
|
206 | - */ |
|
207 | - public function shareApiLinkDefaultExpireDays(); |
|
208 | - |
|
209 | - /** |
|
210 | - * Allow public upload on link shares |
|
211 | - * |
|
212 | - * @return bool |
|
213 | - * @since 9.0.0 |
|
214 | - */ |
|
215 | - public function shareApiLinkAllowPublicUpload(); |
|
216 | - |
|
217 | - /** |
|
218 | - * check if user can only share with group members |
|
219 | - * @return bool |
|
220 | - * @since 9.0.0 |
|
221 | - */ |
|
222 | - public function shareWithGroupMembersOnly(); |
|
223 | - |
|
224 | - /** |
|
225 | - * Check if users can share with groups |
|
226 | - * @return bool |
|
227 | - * @since 9.0.1 |
|
228 | - */ |
|
229 | - public function allowGroupSharing(); |
|
230 | - |
|
231 | - /** |
|
232 | - * Check if sharing is disabled for the given user |
|
233 | - * |
|
234 | - * @param string $userId |
|
235 | - * @return bool |
|
236 | - * @since 9.0.0 |
|
237 | - */ |
|
238 | - public function sharingDisabledForUser($userId); |
|
239 | - |
|
240 | - /** |
|
241 | - * Check if outgoing server2server shares are allowed |
|
242 | - * @return bool |
|
243 | - * @since 9.0.0 |
|
244 | - */ |
|
245 | - public function outgoingServer2ServerSharesAllowed(); |
|
37 | + /** |
|
38 | + * Create a Share |
|
39 | + * |
|
40 | + * @param IShare $share |
|
41 | + * @return IShare The share object |
|
42 | + * @since 9.0.0 |
|
43 | + */ |
|
44 | + public function createShare(IShare $share); |
|
45 | + |
|
46 | + /** |
|
47 | + * Update a share. |
|
48 | + * The target of the share can't be changed this way: use moveShare |
|
49 | + * The share can't be removed this way (permission 0): use deleteShare |
|
50 | + * |
|
51 | + * @param IShare $share |
|
52 | + * @return IShare The share object |
|
53 | + * @since 9.0.0 |
|
54 | + */ |
|
55 | + public function updateShare(IShare $share); |
|
56 | + |
|
57 | + /** |
|
58 | + * Delete a share |
|
59 | + * |
|
60 | + * @param IShare $share |
|
61 | + * @throws ShareNotFound |
|
62 | + * @since 9.0.0 |
|
63 | + */ |
|
64 | + public function deleteShare(IShare $share); |
|
65 | + |
|
66 | + /** |
|
67 | + * Unshare a file as the recipient. |
|
68 | + * This can be different from a regular delete for example when one of |
|
69 | + * the users in a groups deletes that share. But the provider should |
|
70 | + * handle this. |
|
71 | + * |
|
72 | + * @param IShare $share |
|
73 | + * @param string $recipientId |
|
74 | + * @since 9.0.0 |
|
75 | + */ |
|
76 | + public function deleteFromSelf(IShare $share, $recipientId); |
|
77 | + |
|
78 | + /** |
|
79 | + * Move the share as a recipient of the share. |
|
80 | + * This is updating the share target. So where the recipient has the share mounted. |
|
81 | + * |
|
82 | + * @param IShare $share |
|
83 | + * @param string $recipientId |
|
84 | + * @return IShare |
|
85 | + * @throws \InvalidArgumentException If $share is a link share or the $recipient does not match |
|
86 | + * @since 9.0.0 |
|
87 | + */ |
|
88 | + public function moveShare(IShare $share, $recipientId); |
|
89 | + |
|
90 | + /** |
|
91 | + * Get shares shared by (initiated) by the provided user. |
|
92 | + * |
|
93 | + * @param string $userId |
|
94 | + * @param int $shareType |
|
95 | + * @param \OCP\Files\File|\OCP\Files\Folder $path |
|
96 | + * @param bool $reshares |
|
97 | + * @param int $limit The maximum number of returned results, -1 for all results |
|
98 | + * @param int $offset |
|
99 | + * @return IShare[] |
|
100 | + * @since 9.0.0 |
|
101 | + */ |
|
102 | + public function getSharesBy($userId, $shareType, $path = null, $reshares = false, $limit = 50, $offset = 0); |
|
103 | + |
|
104 | + /** |
|
105 | + * Get shares shared with $user. |
|
106 | + * Filter by $node if provided |
|
107 | + * |
|
108 | + * @param string $userId |
|
109 | + * @param int $shareType |
|
110 | + * @param File|Folder|null $node |
|
111 | + * @param int $limit The maximum number of shares returned, -1 for all |
|
112 | + * @param int $offset |
|
113 | + * @return IShare[] |
|
114 | + * @since 9.0.0 |
|
115 | + */ |
|
116 | + public function getSharedWith($userId, $shareType, $node = null, $limit = 50, $offset = 0); |
|
117 | + |
|
118 | + /** |
|
119 | + * Retrieve a share by the share id. |
|
120 | + * If the recipient is set make sure to retrieve the file for that user. |
|
121 | + * This makes sure that if a user has moved/deleted a group share this |
|
122 | + * is reflected. |
|
123 | + * |
|
124 | + * @param string $id |
|
125 | + * @param IUser|null $recipient |
|
126 | + * @return IShare |
|
127 | + * @throws ShareNotFound |
|
128 | + * @since 9.0.0 |
|
129 | + */ |
|
130 | + public function getShareById($id, $recipient = null); |
|
131 | + |
|
132 | + /** |
|
133 | + * Get the share by token possible with password |
|
134 | + * |
|
135 | + * @param string $token |
|
136 | + * @return IShare |
|
137 | + * @throws ShareNotFound |
|
138 | + * @since 9.0.0 |
|
139 | + */ |
|
140 | + public function getShareByToken($token); |
|
141 | + |
|
142 | + /** |
|
143 | + * Verify the password of a public share |
|
144 | + * |
|
145 | + * @param IShare $share |
|
146 | + * @param string $password |
|
147 | + * @return bool |
|
148 | + * @since 9.0.0 |
|
149 | + */ |
|
150 | + public function checkPassword(IShare $share, $password); |
|
151 | + |
|
152 | + /** |
|
153 | + * Instantiates a new share object. This is to be passed to |
|
154 | + * createShare. |
|
155 | + * |
|
156 | + * @return IShare |
|
157 | + * @since 9.0.0 |
|
158 | + */ |
|
159 | + public function newShare(); |
|
160 | + |
|
161 | + /** |
|
162 | + * Is the share API enabled |
|
163 | + * |
|
164 | + * @return bool |
|
165 | + * @since 9.0.0 |
|
166 | + */ |
|
167 | + public function shareApiEnabled(); |
|
168 | + |
|
169 | + /** |
|
170 | + * Is public link sharing enabled |
|
171 | + * |
|
172 | + * @return bool |
|
173 | + * @since 9.0.0 |
|
174 | + */ |
|
175 | + public function shareApiAllowLinks(); |
|
176 | + |
|
177 | + /** |
|
178 | + * Is password on public link requires |
|
179 | + * |
|
180 | + * @return bool |
|
181 | + * @since 9.0.0 |
|
182 | + */ |
|
183 | + public function shareApiLinkEnforcePassword(); |
|
184 | + |
|
185 | + /** |
|
186 | + * Is default expire date enabled |
|
187 | + * |
|
188 | + * @return bool |
|
189 | + * @since 9.0.0 |
|
190 | + */ |
|
191 | + public function shareApiLinkDefaultExpireDate(); |
|
192 | + |
|
193 | + /** |
|
194 | + * Is default expire date enforced |
|
195 | + *` |
|
196 | + * @return bool |
|
197 | + * @since 9.0.0 |
|
198 | + */ |
|
199 | + public function shareApiLinkDefaultExpireDateEnforced(); |
|
200 | + |
|
201 | + /** |
|
202 | + * Number of default expire days |
|
203 | + * |
|
204 | + * @return int |
|
205 | + * @since 9.0.0 |
|
206 | + */ |
|
207 | + public function shareApiLinkDefaultExpireDays(); |
|
208 | + |
|
209 | + /** |
|
210 | + * Allow public upload on link shares |
|
211 | + * |
|
212 | + * @return bool |
|
213 | + * @since 9.0.0 |
|
214 | + */ |
|
215 | + public function shareApiLinkAllowPublicUpload(); |
|
216 | + |
|
217 | + /** |
|
218 | + * check if user can only share with group members |
|
219 | + * @return bool |
|
220 | + * @since 9.0.0 |
|
221 | + */ |
|
222 | + public function shareWithGroupMembersOnly(); |
|
223 | + |
|
224 | + /** |
|
225 | + * Check if users can share with groups |
|
226 | + * @return bool |
|
227 | + * @since 9.0.1 |
|
228 | + */ |
|
229 | + public function allowGroupSharing(); |
|
230 | + |
|
231 | + /** |
|
232 | + * Check if sharing is disabled for the given user |
|
233 | + * |
|
234 | + * @param string $userId |
|
235 | + * @return bool |
|
236 | + * @since 9.0.0 |
|
237 | + */ |
|
238 | + public function sharingDisabledForUser($userId); |
|
239 | + |
|
240 | + /** |
|
241 | + * Check if outgoing server2server shares are allowed |
|
242 | + * @return bool |
|
243 | + * @since 9.0.0 |
|
244 | + */ |
|
245 | + public function outgoingServer2ServerSharesAllowed(); |
|
246 | 246 | |
247 | 247 | } |
@@ -35,266 +35,266 @@ |
||
35 | 35 | */ |
36 | 36 | interface IShare { |
37 | 37 | |
38 | - /** |
|
39 | - * Get the internal id of the share. |
|
40 | - * |
|
41 | - * @return string |
|
42 | - * @since 9.0.0 |
|
43 | - */ |
|
44 | - public function getId(); |
|
45 | - |
|
46 | - /** |
|
47 | - * Get the full share id. This is the <providerid>:<internalid>. |
|
48 | - * The full id is unique in the system. |
|
49 | - * |
|
50 | - * @return string |
|
51 | - * @since 9.0.0 |
|
52 | - * @throws \UnexpectedValueException If the fullId could not be constructed |
|
53 | - */ |
|
54 | - public function getFullId(); |
|
55 | - |
|
56 | - /** |
|
57 | - * Set the node of the file/folder that is shared |
|
58 | - * |
|
59 | - * @param Node $node |
|
60 | - * @return \OCP\Share\IShare The modified object |
|
61 | - * @since 9.0.0 |
|
62 | - */ |
|
63 | - public function setNode(Node $node); |
|
64 | - |
|
65 | - /** |
|
66 | - * Get the node of the file/folder that is shared |
|
67 | - * |
|
68 | - * @return File|Folder |
|
69 | - * @since 9.0.0 |
|
70 | - * @throws NotFoundException |
|
71 | - */ |
|
72 | - public function getNode(); |
|
73 | - |
|
74 | - /** |
|
75 | - * Set file id for lazy evaluation of the node |
|
76 | - * @param int $fileId |
|
77 | - * @return \OCP\Share\IShare The modified object |
|
78 | - * @since 9.0.0 |
|
79 | - */ |
|
80 | - public function setNodeId($fileId); |
|
81 | - |
|
82 | - /** |
|
83 | - * Get the fileid of the node of this share |
|
84 | - * @return int |
|
85 | - * @since 9.0.0 |
|
86 | - * @throws NotFoundException |
|
87 | - */ |
|
88 | - public function getNodeId(); |
|
89 | - |
|
90 | - /** |
|
91 | - * Set the type of node (file/folder) |
|
92 | - * |
|
93 | - * @param string $type |
|
94 | - * @return \OCP\Share\IShare The modified object |
|
95 | - * @since 9.0.0 |
|
96 | - */ |
|
97 | - public function setNodeType($type); |
|
98 | - |
|
99 | - /** |
|
100 | - * Get the type of node (file/folder) |
|
101 | - * |
|
102 | - * @return string |
|
103 | - * @since 9.0.0 |
|
104 | - * @throws NotFoundException |
|
105 | - */ |
|
106 | - public function getNodeType(); |
|
107 | - |
|
108 | - /** |
|
109 | - * Set the shareType |
|
110 | - * |
|
111 | - * @param int $shareType |
|
112 | - * @return \OCP\Share\IShare The modified object |
|
113 | - * @since 9.0.0 |
|
114 | - */ |
|
115 | - public function setShareType($shareType); |
|
116 | - |
|
117 | - /** |
|
118 | - * Get the shareType |
|
119 | - * |
|
120 | - * @return int |
|
121 | - * @since 9.0.0 |
|
122 | - */ |
|
123 | - public function getShareType(); |
|
124 | - |
|
125 | - /** |
|
126 | - * Set the receiver of this share. |
|
127 | - * |
|
128 | - * @param string $sharedWith |
|
129 | - * @return \OCP\Share\IShare The modified object |
|
130 | - * @since 9.0.0 |
|
131 | - */ |
|
132 | - public function setSharedWith($sharedWith); |
|
133 | - |
|
134 | - /** |
|
135 | - * Get the receiver of this share. |
|
136 | - * |
|
137 | - * @return string |
|
138 | - * @since 9.0.0 |
|
139 | - */ |
|
140 | - public function getSharedWith(); |
|
141 | - |
|
142 | - /** |
|
143 | - * Set the permissions. |
|
144 | - * See \OCP\Constants::PERMISSION_* |
|
145 | - * |
|
146 | - * @param int $permissions |
|
147 | - * @return \OCP\Share\IShare The modified object |
|
148 | - * @since 9.0.0 |
|
149 | - */ |
|
150 | - public function setPermissions($permissions); |
|
151 | - |
|
152 | - /** |
|
153 | - * Get the share permissions |
|
154 | - * See \OCP\Constants::PERMISSION_* |
|
155 | - * |
|
156 | - * @return int |
|
157 | - * @since 9.0.0 |
|
158 | - */ |
|
159 | - public function getPermissions(); |
|
160 | - |
|
161 | - /** |
|
162 | - * Set the expiration date |
|
163 | - * |
|
164 | - * @param \DateTime $expireDate |
|
165 | - * @return \OCP\Share\IShare The modified object |
|
166 | - * @since 9.0.0 |
|
167 | - */ |
|
168 | - public function setExpirationDate($expireDate); |
|
169 | - |
|
170 | - /** |
|
171 | - * Get the expiration date |
|
172 | - * |
|
173 | - * @return \DateTime |
|
174 | - * @since 9.0.0 |
|
175 | - */ |
|
176 | - public function getExpirationDate(); |
|
177 | - |
|
178 | - /** |
|
179 | - * Set the sharer of the path. |
|
180 | - * |
|
181 | - * @param string $sharedBy |
|
182 | - * @return \OCP\Share\IShare The modified object |
|
183 | - * @since 9.0.0 |
|
184 | - */ |
|
185 | - public function setSharedBy($sharedBy); |
|
186 | - |
|
187 | - /** |
|
188 | - * Get share sharer |
|
189 | - * |
|
190 | - * @return string |
|
191 | - * @since 9.0.0 |
|
192 | - */ |
|
193 | - public function getSharedBy(); |
|
194 | - |
|
195 | - /** |
|
196 | - * Set the original share owner (who owns the path that is shared) |
|
197 | - * |
|
198 | - * @param string $shareOwner |
|
199 | - * @return \OCP\Share\IShare The modified object |
|
200 | - * @since 9.0.0 |
|
201 | - */ |
|
202 | - public function setShareOwner($shareOwner); |
|
203 | - |
|
204 | - /** |
|
205 | - * Get the original share owner (who owns the path that is shared) |
|
206 | - * |
|
207 | - * @return string |
|
208 | - * @since 9.0.0 |
|
209 | - */ |
|
210 | - public function getShareOwner(); |
|
211 | - |
|
212 | - /** |
|
213 | - * Set the password for this share. |
|
214 | - * When the share is passed to the share manager to be created |
|
215 | - * or updated the password will be hashed. |
|
216 | - * |
|
217 | - * @param string $password |
|
218 | - * @return \OCP\Share\IShare The modified object |
|
219 | - * @since 9.0.0 |
|
220 | - */ |
|
221 | - public function setPassword($password); |
|
222 | - |
|
223 | - /** |
|
224 | - * Get the password of this share. |
|
225 | - * If this share is obtained via a shareprovider the password is |
|
226 | - * hashed. |
|
227 | - * |
|
228 | - * @return string |
|
229 | - * @since 9.0.0 |
|
230 | - */ |
|
231 | - public function getPassword(); |
|
232 | - |
|
233 | - /** |
|
234 | - * Set the public link token. |
|
235 | - * |
|
236 | - * @param string $token |
|
237 | - * @return \OCP\Share\IShare The modified object |
|
238 | - * @since 9.0.0 |
|
239 | - */ |
|
240 | - public function setToken($token); |
|
241 | - |
|
242 | - /** |
|
243 | - * Get the public link token. |
|
244 | - * |
|
245 | - * @return string |
|
246 | - * @since 9.0.0 |
|
247 | - */ |
|
248 | - public function getToken(); |
|
249 | - |
|
250 | - /** |
|
251 | - * Set the target path of this share relative to the recipients user folder. |
|
252 | - * |
|
253 | - * @param string $target |
|
254 | - * @return \OCP\Share\IShare The modified object |
|
255 | - * @since 9.0.0 |
|
256 | - */ |
|
257 | - public function setTarget($target); |
|
258 | - |
|
259 | - /** |
|
260 | - * Get the target path of this share relative to the recipients user folder. |
|
261 | - * |
|
262 | - * @return string |
|
263 | - * @since 9.0.0 |
|
264 | - */ |
|
265 | - public function getTarget(); |
|
266 | - |
|
267 | - /** |
|
268 | - * Set the time this share was created |
|
269 | - * |
|
270 | - * @param \DateTime $shareTime |
|
271 | - * @return \OCP\Share\IShare The modified object |
|
272 | - * @since 9.0.0 |
|
273 | - */ |
|
274 | - public function setShareTime(\DateTime $shareTime); |
|
275 | - |
|
276 | - /** |
|
277 | - * Get the timestamp this share was created |
|
278 | - * |
|
279 | - * @return \DateTime |
|
280 | - * @since 9.0.0 |
|
281 | - */ |
|
282 | - public function getShareTime(); |
|
283 | - |
|
284 | - /** |
|
285 | - * Set if the recipient is informed by mail about the share. |
|
286 | - * |
|
287 | - * @param bool $mailSend |
|
288 | - * @return \OCP\Share\IShare The modified object |
|
289 | - * @since 9.0.0 |
|
290 | - */ |
|
291 | - public function setMailSend($mailSend); |
|
292 | - |
|
293 | - /** |
|
294 | - * Get if the recipient informed by mail about the share. |
|
295 | - * |
|
296 | - * @return bool |
|
297 | - * @since 9.0.0 |
|
298 | - */ |
|
299 | - public function getMailSend(); |
|
38 | + /** |
|
39 | + * Get the internal id of the share. |
|
40 | + * |
|
41 | + * @return string |
|
42 | + * @since 9.0.0 |
|
43 | + */ |
|
44 | + public function getId(); |
|
45 | + |
|
46 | + /** |
|
47 | + * Get the full share id. This is the <providerid>:<internalid>. |
|
48 | + * The full id is unique in the system. |
|
49 | + * |
|
50 | + * @return string |
|
51 | + * @since 9.0.0 |
|
52 | + * @throws \UnexpectedValueException If the fullId could not be constructed |
|
53 | + */ |
|
54 | + public function getFullId(); |
|
55 | + |
|
56 | + /** |
|
57 | + * Set the node of the file/folder that is shared |
|
58 | + * |
|
59 | + * @param Node $node |
|
60 | + * @return \OCP\Share\IShare The modified object |
|
61 | + * @since 9.0.0 |
|
62 | + */ |
|
63 | + public function setNode(Node $node); |
|
64 | + |
|
65 | + /** |
|
66 | + * Get the node of the file/folder that is shared |
|
67 | + * |
|
68 | + * @return File|Folder |
|
69 | + * @since 9.0.0 |
|
70 | + * @throws NotFoundException |
|
71 | + */ |
|
72 | + public function getNode(); |
|
73 | + |
|
74 | + /** |
|
75 | + * Set file id for lazy evaluation of the node |
|
76 | + * @param int $fileId |
|
77 | + * @return \OCP\Share\IShare The modified object |
|
78 | + * @since 9.0.0 |
|
79 | + */ |
|
80 | + public function setNodeId($fileId); |
|
81 | + |
|
82 | + /** |
|
83 | + * Get the fileid of the node of this share |
|
84 | + * @return int |
|
85 | + * @since 9.0.0 |
|
86 | + * @throws NotFoundException |
|
87 | + */ |
|
88 | + public function getNodeId(); |
|
89 | + |
|
90 | + /** |
|
91 | + * Set the type of node (file/folder) |
|
92 | + * |
|
93 | + * @param string $type |
|
94 | + * @return \OCP\Share\IShare The modified object |
|
95 | + * @since 9.0.0 |
|
96 | + */ |
|
97 | + public function setNodeType($type); |
|
98 | + |
|
99 | + /** |
|
100 | + * Get the type of node (file/folder) |
|
101 | + * |
|
102 | + * @return string |
|
103 | + * @since 9.0.0 |
|
104 | + * @throws NotFoundException |
|
105 | + */ |
|
106 | + public function getNodeType(); |
|
107 | + |
|
108 | + /** |
|
109 | + * Set the shareType |
|
110 | + * |
|
111 | + * @param int $shareType |
|
112 | + * @return \OCP\Share\IShare The modified object |
|
113 | + * @since 9.0.0 |
|
114 | + */ |
|
115 | + public function setShareType($shareType); |
|
116 | + |
|
117 | + /** |
|
118 | + * Get the shareType |
|
119 | + * |
|
120 | + * @return int |
|
121 | + * @since 9.0.0 |
|
122 | + */ |
|
123 | + public function getShareType(); |
|
124 | + |
|
125 | + /** |
|
126 | + * Set the receiver of this share. |
|
127 | + * |
|
128 | + * @param string $sharedWith |
|
129 | + * @return \OCP\Share\IShare The modified object |
|
130 | + * @since 9.0.0 |
|
131 | + */ |
|
132 | + public function setSharedWith($sharedWith); |
|
133 | + |
|
134 | + /** |
|
135 | + * Get the receiver of this share. |
|
136 | + * |
|
137 | + * @return string |
|
138 | + * @since 9.0.0 |
|
139 | + */ |
|
140 | + public function getSharedWith(); |
|
141 | + |
|
142 | + /** |
|
143 | + * Set the permissions. |
|
144 | + * See \OCP\Constants::PERMISSION_* |
|
145 | + * |
|
146 | + * @param int $permissions |
|
147 | + * @return \OCP\Share\IShare The modified object |
|
148 | + * @since 9.0.0 |
|
149 | + */ |
|
150 | + public function setPermissions($permissions); |
|
151 | + |
|
152 | + /** |
|
153 | + * Get the share permissions |
|
154 | + * See \OCP\Constants::PERMISSION_* |
|
155 | + * |
|
156 | + * @return int |
|
157 | + * @since 9.0.0 |
|
158 | + */ |
|
159 | + public function getPermissions(); |
|
160 | + |
|
161 | + /** |
|
162 | + * Set the expiration date |
|
163 | + * |
|
164 | + * @param \DateTime $expireDate |
|
165 | + * @return \OCP\Share\IShare The modified object |
|
166 | + * @since 9.0.0 |
|
167 | + */ |
|
168 | + public function setExpirationDate($expireDate); |
|
169 | + |
|
170 | + /** |
|
171 | + * Get the expiration date |
|
172 | + * |
|
173 | + * @return \DateTime |
|
174 | + * @since 9.0.0 |
|
175 | + */ |
|
176 | + public function getExpirationDate(); |
|
177 | + |
|
178 | + /** |
|
179 | + * Set the sharer of the path. |
|
180 | + * |
|
181 | + * @param string $sharedBy |
|
182 | + * @return \OCP\Share\IShare The modified object |
|
183 | + * @since 9.0.0 |
|
184 | + */ |
|
185 | + public function setSharedBy($sharedBy); |
|
186 | + |
|
187 | + /** |
|
188 | + * Get share sharer |
|
189 | + * |
|
190 | + * @return string |
|
191 | + * @since 9.0.0 |
|
192 | + */ |
|
193 | + public function getSharedBy(); |
|
194 | + |
|
195 | + /** |
|
196 | + * Set the original share owner (who owns the path that is shared) |
|
197 | + * |
|
198 | + * @param string $shareOwner |
|
199 | + * @return \OCP\Share\IShare The modified object |
|
200 | + * @since 9.0.0 |
|
201 | + */ |
|
202 | + public function setShareOwner($shareOwner); |
|
203 | + |
|
204 | + /** |
|
205 | + * Get the original share owner (who owns the path that is shared) |
|
206 | + * |
|
207 | + * @return string |
|
208 | + * @since 9.0.0 |
|
209 | + */ |
|
210 | + public function getShareOwner(); |
|
211 | + |
|
212 | + /** |
|
213 | + * Set the password for this share. |
|
214 | + * When the share is passed to the share manager to be created |
|
215 | + * or updated the password will be hashed. |
|
216 | + * |
|
217 | + * @param string $password |
|
218 | + * @return \OCP\Share\IShare The modified object |
|
219 | + * @since 9.0.0 |
|
220 | + */ |
|
221 | + public function setPassword($password); |
|
222 | + |
|
223 | + /** |
|
224 | + * Get the password of this share. |
|
225 | + * If this share is obtained via a shareprovider the password is |
|
226 | + * hashed. |
|
227 | + * |
|
228 | + * @return string |
|
229 | + * @since 9.0.0 |
|
230 | + */ |
|
231 | + public function getPassword(); |
|
232 | + |
|
233 | + /** |
|
234 | + * Set the public link token. |
|
235 | + * |
|
236 | + * @param string $token |
|
237 | + * @return \OCP\Share\IShare The modified object |
|
238 | + * @since 9.0.0 |
|
239 | + */ |
|
240 | + public function setToken($token); |
|
241 | + |
|
242 | + /** |
|
243 | + * Get the public link token. |
|
244 | + * |
|
245 | + * @return string |
|
246 | + * @since 9.0.0 |
|
247 | + */ |
|
248 | + public function getToken(); |
|
249 | + |
|
250 | + /** |
|
251 | + * Set the target path of this share relative to the recipients user folder. |
|
252 | + * |
|
253 | + * @param string $target |
|
254 | + * @return \OCP\Share\IShare The modified object |
|
255 | + * @since 9.0.0 |
|
256 | + */ |
|
257 | + public function setTarget($target); |
|
258 | + |
|
259 | + /** |
|
260 | + * Get the target path of this share relative to the recipients user folder. |
|
261 | + * |
|
262 | + * @return string |
|
263 | + * @since 9.0.0 |
|
264 | + */ |
|
265 | + public function getTarget(); |
|
266 | + |
|
267 | + /** |
|
268 | + * Set the time this share was created |
|
269 | + * |
|
270 | + * @param \DateTime $shareTime |
|
271 | + * @return \OCP\Share\IShare The modified object |
|
272 | + * @since 9.0.0 |
|
273 | + */ |
|
274 | + public function setShareTime(\DateTime $shareTime); |
|
275 | + |
|
276 | + /** |
|
277 | + * Get the timestamp this share was created |
|
278 | + * |
|
279 | + * @return \DateTime |
|
280 | + * @since 9.0.0 |
|
281 | + */ |
|
282 | + public function getShareTime(); |
|
283 | + |
|
284 | + /** |
|
285 | + * Set if the recipient is informed by mail about the share. |
|
286 | + * |
|
287 | + * @param bool $mailSend |
|
288 | + * @return \OCP\Share\IShare The modified object |
|
289 | + * @since 9.0.0 |
|
290 | + */ |
|
291 | + public function setMailSend($mailSend); |
|
292 | + |
|
293 | + /** |
|
294 | + * Get if the recipient informed by mail about the share. |
|
295 | + * |
|
296 | + * @return bool |
|
297 | + * @since 9.0.0 |
|
298 | + */ |
|
299 | + public function getMailSend(); |
|
300 | 300 | } |