@@ -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 | } |
@@ -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 | } |
@@ -30,13 +30,13 @@ |
||
30 | 30 | */ |
31 | 31 | class SabrePluginException extends Exception { |
32 | 32 | |
33 | - /** |
|
34 | - * Returns the HTTP statuscode for this exception |
|
35 | - * |
|
36 | - * @return int |
|
37 | - * @since 8.2.0 |
|
38 | - */ |
|
39 | - public function getHTTPCode() { |
|
40 | - return $this->code; |
|
41 | - } |
|
33 | + /** |
|
34 | + * Returns the HTTP statuscode for this exception |
|
35 | + * |
|
36 | + * @return int |
|
37 | + * @since 8.2.0 |
|
38 | + */ |
|
39 | + public function getHTTPCode() { |
|
40 | + return $this->code; |
|
41 | + } |
|
42 | 42 | } |
@@ -32,56 +32,56 @@ |
||
32 | 32 | * @since 7.0.0 |
33 | 33 | */ |
34 | 34 | interface IJob { |
35 | - /** |
|
36 | - * Run the background job with the registered argument |
|
37 | - * |
|
38 | - * @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job |
|
39 | - * @param ILogger $logger |
|
40 | - * @since 7.0.0 |
|
41 | - */ |
|
42 | - public function execute($jobList, ILogger $logger = null); |
|
35 | + /** |
|
36 | + * Run the background job with the registered argument |
|
37 | + * |
|
38 | + * @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job |
|
39 | + * @param ILogger $logger |
|
40 | + * @since 7.0.0 |
|
41 | + */ |
|
42 | + public function execute($jobList, ILogger $logger = null); |
|
43 | 43 | |
44 | - /** |
|
45 | - * @param int $id |
|
46 | - * @since 7.0.0 |
|
47 | - */ |
|
48 | - public function setId($id); |
|
44 | + /** |
|
45 | + * @param int $id |
|
46 | + * @since 7.0.0 |
|
47 | + */ |
|
48 | + public function setId($id); |
|
49 | 49 | |
50 | - /** |
|
51 | - * @param int $lastRun |
|
52 | - * @since 7.0.0 |
|
53 | - */ |
|
54 | - public function setLastRun($lastRun); |
|
50 | + /** |
|
51 | + * @param int $lastRun |
|
52 | + * @since 7.0.0 |
|
53 | + */ |
|
54 | + public function setLastRun($lastRun); |
|
55 | 55 | |
56 | - /** |
|
57 | - * @param mixed $argument |
|
58 | - * @since 7.0.0 |
|
59 | - */ |
|
60 | - public function setArgument($argument); |
|
56 | + /** |
|
57 | + * @param mixed $argument |
|
58 | + * @since 7.0.0 |
|
59 | + */ |
|
60 | + public function setArgument($argument); |
|
61 | 61 | |
62 | - /** |
|
63 | - * Get the id of the background job |
|
64 | - * This id is determined by the job list when a job is added to the list |
|
65 | - * |
|
66 | - * @return int |
|
67 | - * @since 7.0.0 |
|
68 | - */ |
|
69 | - public function getId(); |
|
62 | + /** |
|
63 | + * Get the id of the background job |
|
64 | + * This id is determined by the job list when a job is added to the list |
|
65 | + * |
|
66 | + * @return int |
|
67 | + * @since 7.0.0 |
|
68 | + */ |
|
69 | + public function getId(); |
|
70 | 70 | |
71 | - /** |
|
72 | - * Get the last time this job was run as unix timestamp |
|
73 | - * |
|
74 | - * @return int |
|
75 | - * @since 7.0.0 |
|
76 | - */ |
|
77 | - public function getLastRun(); |
|
71 | + /** |
|
72 | + * Get the last time this job was run as unix timestamp |
|
73 | + * |
|
74 | + * @return int |
|
75 | + * @since 7.0.0 |
|
76 | + */ |
|
77 | + public function getLastRun(); |
|
78 | 78 | |
79 | - /** |
|
80 | - * Get the argument associated with the background job |
|
81 | - * This is the argument that will be passed to the background job |
|
82 | - * |
|
83 | - * @return mixed |
|
84 | - * @since 7.0.0 |
|
85 | - */ |
|
86 | - public function getArgument(); |
|
79 | + /** |
|
80 | + * Get the argument associated with the background job |
|
81 | + * This is the argument that will be passed to the background job |
|
82 | + * |
|
83 | + * @return mixed |
|
84 | + * @since 7.0.0 |
|
85 | + */ |
|
86 | + public function getArgument(); |
|
87 | 87 | } |
@@ -30,25 +30,25 @@ |
||
30 | 30 | */ |
31 | 31 | interface ISettings { |
32 | 32 | |
33 | - /** |
|
34 | - * @return TemplateResponse returns the instance with all parameters set, ready to be rendered |
|
35 | - * @since 9.1 |
|
36 | - */ |
|
37 | - public function getForm(); |
|
33 | + /** |
|
34 | + * @return TemplateResponse returns the instance with all parameters set, ready to be rendered |
|
35 | + * @since 9.1 |
|
36 | + */ |
|
37 | + public function getForm(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return string the section ID, e.g. 'sharing' |
|
41 | - * @since 9.1 |
|
42 | - */ |
|
43 | - public function getSection(); |
|
39 | + /** |
|
40 | + * @return string the section ID, e.g. 'sharing' |
|
41 | + * @since 9.1 |
|
42 | + */ |
|
43 | + public function getSection(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return int whether the form should be rather on the top or bottom of |
|
47 | - * the admin section. The forms are arranged in ascending order of the |
|
48 | - * priority values. It is required to return a value between 0 and 100. |
|
49 | - * |
|
50 | - * E.g.: 70 |
|
51 | - * @since 9.1 |
|
52 | - */ |
|
53 | - public function getPriority(); |
|
45 | + /** |
|
46 | + * @return int whether the form should be rather on the top or bottom of |
|
47 | + * the admin section. The forms are arranged in ascending order of the |
|
48 | + * priority values. It is required to return a value between 0 and 100. |
|
49 | + * |
|
50 | + * E.g.: 70 |
|
51 | + * @since 9.1 |
|
52 | + */ |
|
53 | + public function getPriority(); |
|
54 | 54 | } |
@@ -28,31 +28,31 @@ |
||
28 | 28 | * @since 9.1 |
29 | 29 | */ |
30 | 30 | interface ISection { |
31 | - /** |
|
32 | - * returns the ID of the section. It is supposed to be a lower case string, |
|
33 | - * e.g. 'ldap' |
|
34 | - * |
|
35 | - * @returns string |
|
36 | - * @since 9.1 |
|
37 | - */ |
|
38 | - public function getID(); |
|
31 | + /** |
|
32 | + * returns the ID of the section. It is supposed to be a lower case string, |
|
33 | + * e.g. 'ldap' |
|
34 | + * |
|
35 | + * @returns string |
|
36 | + * @since 9.1 |
|
37 | + */ |
|
38 | + public function getID(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * returns the translated name as it should be displayed, e.g. 'LDAP / AD |
|
42 | - * integration'. Use the L10N service to translate it. |
|
43 | - * |
|
44 | - * @return string |
|
45 | - * @since 9.1 |
|
46 | - */ |
|
47 | - public function getName(); |
|
40 | + /** |
|
41 | + * returns the translated name as it should be displayed, e.g. 'LDAP / AD |
|
42 | + * integration'. Use the L10N service to translate it. |
|
43 | + * |
|
44 | + * @return string |
|
45 | + * @since 9.1 |
|
46 | + */ |
|
47 | + public function getName(); |
|
48 | 48 | |
49 | - /** |
|
50 | - * @return int whether the form should be rather on the top or bottom of |
|
51 | - * the settings navigation. The sections are arranged in ascending order of |
|
52 | - * the priority values. It is required to return a value between 0 and 99. |
|
53 | - * |
|
54 | - * E.g.: 70 |
|
55 | - * @since 9.1 |
|
56 | - */ |
|
57 | - public function getPriority(); |
|
49 | + /** |
|
50 | + * @return int whether the form should be rather on the top or bottom of |
|
51 | + * the settings navigation. The sections are arranged in ascending order of |
|
52 | + * the priority values. It is required to return a value between 0 and 99. |
|
53 | + * |
|
54 | + * E.g.: 70 |
|
55 | + * @since 9.1 |
|
56 | + */ |
|
57 | + public function getPriority(); |
|
58 | 58 | } |
@@ -27,72 +27,72 @@ |
||
27 | 27 | * @since 9.1 |
28 | 28 | */ |
29 | 29 | interface IManager { |
30 | - /** |
|
31 | - * @since 9.1.0 |
|
32 | - */ |
|
33 | - const KEY_ADMIN_SETTINGS = 'admin'; |
|
30 | + /** |
|
31 | + * @since 9.1.0 |
|
32 | + */ |
|
33 | + const KEY_ADMIN_SETTINGS = 'admin'; |
|
34 | 34 | |
35 | - /** |
|
36 | - * @since 9.1.0 |
|
37 | - */ |
|
38 | - const KEY_ADMIN_SECTION = 'admin-section'; |
|
35 | + /** |
|
36 | + * @since 9.1.0 |
|
37 | + */ |
|
38 | + const KEY_ADMIN_SECTION = 'admin-section'; |
|
39 | 39 | |
40 | - /** |
|
41 | - * sets up settings according to data specified by an apps info.xml, within |
|
42 | - * the <settings> element. |
|
43 | - * |
|
44 | - * @param array $settings an associative array, allowed keys are as specified |
|
45 | - * by the KEY_ constant of this interface. The value |
|
46 | - * must always be a class name, implement either |
|
47 | - * IAdmin or ISection. I.e. only one section and admin |
|
48 | - * setting can be configured per app. |
|
49 | - * @since 9.1.0 |
|
50 | - */ |
|
51 | - public function setupSettings(array $settings); |
|
40 | + /** |
|
41 | + * sets up settings according to data specified by an apps info.xml, within |
|
42 | + * the <settings> element. |
|
43 | + * |
|
44 | + * @param array $settings an associative array, allowed keys are as specified |
|
45 | + * by the KEY_ constant of this interface. The value |
|
46 | + * must always be a class name, implement either |
|
47 | + * IAdmin or ISection. I.e. only one section and admin |
|
48 | + * setting can be configured per app. |
|
49 | + * @since 9.1.0 |
|
50 | + */ |
|
51 | + public function setupSettings(array $settings); |
|
52 | 52 | |
53 | - /** |
|
54 | - * attempts to remove an apps section and/or settings entry. A listener is |
|
55 | - * added centrally making sure that this method is called ones an app was |
|
56 | - * disabled. |
|
57 | - * |
|
58 | - * What this does not help with is when applications change their settings |
|
59 | - * or section classes during their life time. New entries will be added, |
|
60 | - * but inactive ones will still reside in the database. |
|
61 | - * |
|
62 | - * @param string $appId |
|
63 | - * @since 9.1.0 |
|
64 | - */ |
|
65 | - public function onAppDisabled($appId); |
|
53 | + /** |
|
54 | + * attempts to remove an apps section and/or settings entry. A listener is |
|
55 | + * added centrally making sure that this method is called ones an app was |
|
56 | + * disabled. |
|
57 | + * |
|
58 | + * What this does not help with is when applications change their settings |
|
59 | + * or section classes during their life time. New entries will be added, |
|
60 | + * but inactive ones will still reside in the database. |
|
61 | + * |
|
62 | + * @param string $appId |
|
63 | + * @since 9.1.0 |
|
64 | + */ |
|
65 | + public function onAppDisabled($appId); |
|
66 | 66 | |
67 | - /** |
|
68 | - * The method should check all registered classes whether they are still |
|
69 | - * instantiable and remove them, if not. This method is called by a |
|
70 | - * background job once, after one or more apps were updated. |
|
71 | - * |
|
72 | - * An app`s info.xml can change during an update and make it unknown whether |
|
73 | - * a registered class name was changed or not. An old one would just stay |
|
74 | - * registered. Another case is if an admin takes a radical approach and |
|
75 | - * simply removes an app from the app folder. These unregular checks will |
|
76 | - * take care of such situations. |
|
77 | - * |
|
78 | - * @since 9.1.0 |
|
79 | - */ |
|
80 | - public function checkForOrphanedClassNames(); |
|
67 | + /** |
|
68 | + * The method should check all registered classes whether they are still |
|
69 | + * instantiable and remove them, if not. This method is called by a |
|
70 | + * background job once, after one or more apps were updated. |
|
71 | + * |
|
72 | + * An app`s info.xml can change during an update and make it unknown whether |
|
73 | + * a registered class name was changed or not. An old one would just stay |
|
74 | + * registered. Another case is if an admin takes a radical approach and |
|
75 | + * simply removes an app from the app folder. These unregular checks will |
|
76 | + * take care of such situations. |
|
77 | + * |
|
78 | + * @since 9.1.0 |
|
79 | + */ |
|
80 | + public function checkForOrphanedClassNames(); |
|
81 | 81 | |
82 | - /** |
|
83 | - * returns a list of the admin sections |
|
84 | - * |
|
85 | - * @return array array of ISection[] where key is the priority |
|
86 | - * @since 9.1.0 |
|
87 | - */ |
|
88 | - public function getAdminSections(); |
|
82 | + /** |
|
83 | + * returns a list of the admin sections |
|
84 | + * |
|
85 | + * @return array array of ISection[] where key is the priority |
|
86 | + * @since 9.1.0 |
|
87 | + */ |
|
88 | + public function getAdminSections(); |
|
89 | 89 | |
90 | - /** |
|
91 | - * returns a list of the admin settings |
|
92 | - * |
|
93 | - * @param string $section the section id for which to load the settings |
|
94 | - * @return array array of IAdmin[] where key is the priority |
|
95 | - * @since 9.1.0 |
|
96 | - */ |
|
97 | - public function getAdminSettings($section); |
|
90 | + /** |
|
91 | + * returns a list of the admin settings |
|
92 | + * |
|
93 | + * @param string $section the section id for which to load the settings |
|
94 | + * @return array array of IAdmin[] where key is the priority |
|
95 | + * @since 9.1.0 |
|
96 | + */ |
|
97 | + public function getAdminSettings($section); |
|
98 | 98 | } |