@@ -30,33 +30,33 @@ |
||
30 | 30 | */ |
31 | 31 | interface ICloudFederationFactory { |
32 | 32 | |
33 | - /** |
|
34 | - * get a CloudFederationShare Object to prepare a share you want to send |
|
35 | - * |
|
36 | - * @param string $shareWith |
|
37 | - * @param string $name resource name (e.g. document.odt) |
|
38 | - * @param string $description share description (optional) |
|
39 | - * @param string $providerId resource UID on the provider side |
|
40 | - * @param string $owner provider specific UID of the user who owns the resource |
|
41 | - * @param string $ownerDisplayName display name of the user who shared the item |
|
42 | - * @param string $sharedBy provider specific UID of the user who shared the resource |
|
43 | - * @param string $sharedByDisplayName display name of the user who shared the resource |
|
44 | - * @param string $sharedSecret used to authenticate requests across servers |
|
45 | - * @param string $shareType ('group' or 'user' share) |
|
46 | - * @param $resourceType ('file', 'calendar',...) |
|
47 | - * @return ICloudFederationShare |
|
48 | - * |
|
49 | - * @since 14.0.0 |
|
50 | - */ |
|
51 | - public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType); |
|
33 | + /** |
|
34 | + * get a CloudFederationShare Object to prepare a share you want to send |
|
35 | + * |
|
36 | + * @param string $shareWith |
|
37 | + * @param string $name resource name (e.g. document.odt) |
|
38 | + * @param string $description share description (optional) |
|
39 | + * @param string $providerId resource UID on the provider side |
|
40 | + * @param string $owner provider specific UID of the user who owns the resource |
|
41 | + * @param string $ownerDisplayName display name of the user who shared the item |
|
42 | + * @param string $sharedBy provider specific UID of the user who shared the resource |
|
43 | + * @param string $sharedByDisplayName display name of the user who shared the resource |
|
44 | + * @param string $sharedSecret used to authenticate requests across servers |
|
45 | + * @param string $shareType ('group' or 'user' share) |
|
46 | + * @param $resourceType ('file', 'calendar',...) |
|
47 | + * @return ICloudFederationShare |
|
48 | + * |
|
49 | + * @since 14.0.0 |
|
50 | + */ |
|
51 | + public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType); |
|
52 | 52 | |
53 | - /** |
|
54 | - * get a Cloud FederationNotification object to prepare a notification you |
|
55 | - * want to send |
|
56 | - * |
|
57 | - * @return ICloudFederationNotification |
|
58 | - * |
|
59 | - * @since 14.0.0 |
|
60 | - */ |
|
61 | - public function getCloudFederationNotification(); |
|
53 | + /** |
|
54 | + * get a Cloud FederationNotification object to prepare a notification you |
|
55 | + * want to send |
|
56 | + * |
|
57 | + * @return ICloudFederationNotification |
|
58 | + * |
|
59 | + * @since 14.0.0 |
|
60 | + */ |
|
61 | + public function getCloudFederationNotification(); |
|
62 | 62 | } |
@@ -32,17 +32,17 @@ |
||
32 | 32 | */ |
33 | 33 | class AuthenticationFailedException extends HintException { |
34 | 34 | |
35 | - /** |
|
36 | - * BadRequestException constructor. |
|
37 | - * |
|
38 | - * @since 14.0.0 |
|
39 | - * |
|
40 | - */ |
|
41 | - public function __construct() { |
|
42 | - $l = \OC::$server->getL10N('federation'); |
|
43 | - $message = 'Authentication failed, wrong token or provider ID given'; |
|
44 | - $hint = $l->t('Authentication failed, wrong token or provider ID given'); |
|
45 | - parent::__construct($message, $hint); |
|
46 | - } |
|
35 | + /** |
|
36 | + * BadRequestException constructor. |
|
37 | + * |
|
38 | + * @since 14.0.0 |
|
39 | + * |
|
40 | + */ |
|
41 | + public function __construct() { |
|
42 | + $l = \OC::$server->getL10N('federation'); |
|
43 | + $message = 'Authentication failed, wrong token or provider ID given'; |
|
44 | + $hint = $l->t('Authentication failed, wrong token or provider ID given'); |
|
45 | + parent::__construct($message, $hint); |
|
46 | + } |
|
47 | 47 | |
48 | 48 | } |
@@ -42,10 +42,10 @@ |
||
42 | 42 | */ |
43 | 43 | class StrictInlineContentSecurityPolicy extends ContentSecurityPolicy { |
44 | 44 | |
45 | - /** |
|
46 | - * @since 14.0.0 |
|
47 | - */ |
|
48 | - public function __construct() { |
|
49 | - $this->inlineStyleAllowed = false; |
|
50 | - } |
|
45 | + /** |
|
46 | + * @since 14.0.0 |
|
47 | + */ |
|
48 | + public function __construct() { |
|
49 | + $this->inlineStyleAllowed = false; |
|
50 | + } |
|
51 | 51 | } |
@@ -30,19 +30,19 @@ |
||
30 | 30 | |
31 | 31 | class AddCleanupUpdaterBackupsJob implements IRepairStep { |
32 | 32 | |
33 | - /** @var IJobList */ |
|
34 | - protected $jobList; |
|
33 | + /** @var IJobList */ |
|
34 | + protected $jobList; |
|
35 | 35 | |
36 | - public function __construct(IJobList $jobList) { |
|
37 | - $this->jobList = $jobList; |
|
38 | - } |
|
36 | + public function __construct(IJobList $jobList) { |
|
37 | + $this->jobList = $jobList; |
|
38 | + } |
|
39 | 39 | |
40 | - public function getName() { |
|
41 | - return 'Queue a one-time job to cleanup old backups of the updater'; |
|
42 | - } |
|
40 | + public function getName() { |
|
41 | + return 'Queue a one-time job to cleanup old backups of the updater'; |
|
42 | + } |
|
43 | 43 | |
44 | - public function run(IOutput $output) { |
|
45 | - $this->jobList->add(BackgroundCleanupUpdaterBackupsJob::class); |
|
46 | - } |
|
44 | + public function run(IOutput $output) { |
|
45 | + $this->jobList->add(BackgroundCleanupUpdaterBackupsJob::class); |
|
46 | + } |
|
47 | 47 | } |
48 | 48 |
@@ -31,50 +31,50 @@ |
||
31 | 31 | */ |
32 | 32 | interface IResource { |
33 | 33 | |
34 | - /** |
|
35 | - * get the resource id |
|
36 | - * |
|
37 | - * This id has to be unique within the backend |
|
38 | - * |
|
39 | - * @return string |
|
40 | - * @since 14.0.0 |
|
41 | - */ |
|
42 | - public function getId():string; |
|
34 | + /** |
|
35 | + * get the resource id |
|
36 | + * |
|
37 | + * This id has to be unique within the backend |
|
38 | + * |
|
39 | + * @return string |
|
40 | + * @since 14.0.0 |
|
41 | + */ |
|
42 | + public function getId():string; |
|
43 | 43 | |
44 | - /** |
|
45 | - * get the display name for a resource |
|
46 | - * |
|
47 | - * @return string |
|
48 | - * @since 14.0.0 |
|
49 | - */ |
|
50 | - public function getDisplayName():string; |
|
44 | + /** |
|
45 | + * get the display name for a resource |
|
46 | + * |
|
47 | + * @return string |
|
48 | + * @since 14.0.0 |
|
49 | + */ |
|
50 | + public function getDisplayName():string; |
|
51 | 51 | |
52 | - /** |
|
53 | - * Get a list of groupIds that are allowed to access this resource |
|
54 | - * |
|
55 | - * If an empty array is returned, no group restrictions are |
|
56 | - * applied. |
|
57 | - * |
|
58 | - * @return string[] |
|
59 | - * @since 14.0.0 |
|
60 | - */ |
|
61 | - public function getGroupRestrictions():array; |
|
52 | + /** |
|
53 | + * Get a list of groupIds that are allowed to access this resource |
|
54 | + * |
|
55 | + * If an empty array is returned, no group restrictions are |
|
56 | + * applied. |
|
57 | + * |
|
58 | + * @return string[] |
|
59 | + * @since 14.0.0 |
|
60 | + */ |
|
61 | + public function getGroupRestrictions():array; |
|
62 | 62 | |
63 | - /** |
|
64 | - * get email-address for resource |
|
65 | - * |
|
66 | - * The email address has to be globally unique |
|
67 | - * |
|
68 | - * @return string |
|
69 | - * @since 14.0.0 |
|
70 | - */ |
|
71 | - public function getEMail():string; |
|
63 | + /** |
|
64 | + * get email-address for resource |
|
65 | + * |
|
66 | + * The email address has to be globally unique |
|
67 | + * |
|
68 | + * @return string |
|
69 | + * @since 14.0.0 |
|
70 | + */ |
|
71 | + public function getEMail():string; |
|
72 | 72 | |
73 | - /** |
|
74 | - * Get corresponding backend object |
|
75 | - * |
|
76 | - * @return IBackend |
|
77 | - * @since 14.0.0 |
|
78 | - */ |
|
79 | - public function getBackend():IBackend; |
|
73 | + /** |
|
74 | + * Get corresponding backend object |
|
75 | + * |
|
76 | + * @return IBackend |
|
77 | + * @since 14.0.0 |
|
78 | + */ |
|
79 | + public function getBackend():IBackend; |
|
80 | 80 | } |
@@ -32,39 +32,39 @@ |
||
32 | 32 | */ |
33 | 33 | interface IBackend { |
34 | 34 | |
35 | - /** |
|
36 | - * get a list of all resources in this backend |
|
37 | - * |
|
38 | - * @throws BackendTemporarilyUnavailableException |
|
39 | - * @return IResource[] |
|
40 | - * @since 14.0.0 |
|
41 | - */ |
|
42 | - public function getAllResources():array; |
|
35 | + /** |
|
36 | + * get a list of all resources in this backend |
|
37 | + * |
|
38 | + * @throws BackendTemporarilyUnavailableException |
|
39 | + * @return IResource[] |
|
40 | + * @since 14.0.0 |
|
41 | + */ |
|
42 | + public function getAllResources():array; |
|
43 | 43 | |
44 | - /** |
|
45 | - * get a list of all resource identifiers in this backend |
|
46 | - * |
|
47 | - * @throws BackendTemporarilyUnavailableException |
|
48 | - * @return string[] |
|
49 | - * @since 14.0.0 |
|
50 | - */ |
|
51 | - public function listAllResources():array; |
|
44 | + /** |
|
45 | + * get a list of all resource identifiers in this backend |
|
46 | + * |
|
47 | + * @throws BackendTemporarilyUnavailableException |
|
48 | + * @return string[] |
|
49 | + * @since 14.0.0 |
|
50 | + */ |
|
51 | + public function listAllResources():array; |
|
52 | 52 | |
53 | - /** |
|
54 | - * get a resource by it's id |
|
55 | - * |
|
56 | - * @param string $id |
|
57 | - * @throws BackendTemporarilyUnavailableException |
|
58 | - * @return IResource|null |
|
59 | - * @since 14.0.0 |
|
60 | - */ |
|
61 | - public function getResource($id); |
|
53 | + /** |
|
54 | + * get a resource by it's id |
|
55 | + * |
|
56 | + * @param string $id |
|
57 | + * @throws BackendTemporarilyUnavailableException |
|
58 | + * @return IResource|null |
|
59 | + * @since 14.0.0 |
|
60 | + */ |
|
61 | + public function getResource($id); |
|
62 | 62 | |
63 | - /** |
|
64 | - * Get unique identifier of the backend |
|
65 | - * |
|
66 | - * @return string |
|
67 | - * @since 14.0.0 |
|
68 | - */ |
|
69 | - public function getBackendIdentifier():string; |
|
63 | + /** |
|
64 | + * Get unique identifier of the backend |
|
65 | + * |
|
66 | + * @return string |
|
67 | + * @since 14.0.0 |
|
68 | + */ |
|
69 | + public function getBackendIdentifier():string; |
|
70 | 70 | } |
@@ -32,39 +32,39 @@ |
||
32 | 32 | */ |
33 | 33 | interface IBackend { |
34 | 34 | |
35 | - /** |
|
36 | - * get a list of all rooms in this backend |
|
37 | - * |
|
38 | - * @throws BackendTemporarilyUnavailableException |
|
39 | - * @return IRoom[] |
|
40 | - * @since 14.0.0 |
|
41 | - */ |
|
42 | - public function getAllRooms():array; |
|
35 | + /** |
|
36 | + * get a list of all rooms in this backend |
|
37 | + * |
|
38 | + * @throws BackendTemporarilyUnavailableException |
|
39 | + * @return IRoom[] |
|
40 | + * @since 14.0.0 |
|
41 | + */ |
|
42 | + public function getAllRooms():array; |
|
43 | 43 | |
44 | - /** |
|
45 | - * get a list of all room identifiers in this backend |
|
46 | - * |
|
47 | - * @throws BackendTemporarilyUnavailableException |
|
48 | - * @return string[] |
|
49 | - * @since 14.0.0 |
|
50 | - */ |
|
51 | - public function listAllRooms():array; |
|
44 | + /** |
|
45 | + * get a list of all room identifiers in this backend |
|
46 | + * |
|
47 | + * @throws BackendTemporarilyUnavailableException |
|
48 | + * @return string[] |
|
49 | + * @since 14.0.0 |
|
50 | + */ |
|
51 | + public function listAllRooms():array; |
|
52 | 52 | |
53 | - /** |
|
54 | - * get a room by it's id |
|
55 | - * |
|
56 | - * @param string $id |
|
57 | - * @throws BackendTemporarilyUnavailableException |
|
58 | - * @return IRoom|null |
|
59 | - * @since 14.0.0 |
|
60 | - */ |
|
61 | - public function getRoom($id); |
|
53 | + /** |
|
54 | + * get a room by it's id |
|
55 | + * |
|
56 | + * @param string $id |
|
57 | + * @throws BackendTemporarilyUnavailableException |
|
58 | + * @return IRoom|null |
|
59 | + * @since 14.0.0 |
|
60 | + */ |
|
61 | + public function getRoom($id); |
|
62 | 62 | |
63 | - /** |
|
64 | - * Get unique identifier of the backend |
|
65 | - * |
|
66 | - * @return string |
|
67 | - * @since 14.0.0 |
|
68 | - */ |
|
69 | - public function getBackendIdentifier():string; |
|
63 | + /** |
|
64 | + * Get unique identifier of the backend |
|
65 | + * |
|
66 | + * @return string |
|
67 | + * @since 14.0.0 |
|
68 | + */ |
|
69 | + public function getBackendIdentifier():string; |
|
70 | 70 | } |
@@ -39,51 +39,51 @@ |
||
39 | 39 | |
40 | 40 | interface ICloudFederationProvider { |
41 | 41 | |
42 | - /** |
|
43 | - * get the name of the share type, handled by this provider |
|
44 | - * |
|
45 | - * @return string |
|
46 | - * |
|
47 | - * @since 14.0.0 |
|
48 | - */ |
|
49 | - public function getShareType(); |
|
42 | + /** |
|
43 | + * get the name of the share type, handled by this provider |
|
44 | + * |
|
45 | + * @return string |
|
46 | + * |
|
47 | + * @since 14.0.0 |
|
48 | + */ |
|
49 | + public function getShareType(); |
|
50 | 50 | |
51 | - /** |
|
52 | - * share received from another server |
|
53 | - * |
|
54 | - * @param ICloudFederationShare $share |
|
55 | - * @return string provider specific unique ID of the share |
|
56 | - * |
|
57 | - * @throws ProviderCouldNotAddShareException |
|
58 | - * |
|
59 | - * @since 14.0.0 |
|
60 | - */ |
|
61 | - public function shareReceived(ICloudFederationShare $share); |
|
51 | + /** |
|
52 | + * share received from another server |
|
53 | + * |
|
54 | + * @param ICloudFederationShare $share |
|
55 | + * @return string provider specific unique ID of the share |
|
56 | + * |
|
57 | + * @throws ProviderCouldNotAddShareException |
|
58 | + * |
|
59 | + * @since 14.0.0 |
|
60 | + */ |
|
61 | + public function shareReceived(ICloudFederationShare $share); |
|
62 | 62 | |
63 | - /** |
|
64 | - * notification received from another server |
|
65 | - * |
|
66 | - * @param string $notificationType (e.g SHARE_ACCEPTED) |
|
67 | - * @param string $providerId share ID |
|
68 | - * @param array $notification provider specific notification |
|
69 | - * @return array $data send back to sender |
|
70 | - * |
|
71 | - * @throws ShareNotFound |
|
72 | - * @throws ActionNotSupportedException |
|
73 | - * @throws BadRequestException |
|
74 | - * @throws AuthenticationFailedException |
|
75 | - * |
|
76 | - * @since 14.0.0 |
|
77 | - */ |
|
78 | - public function notificationReceived($notificationType, $providerId, array $notification); |
|
63 | + /** |
|
64 | + * notification received from another server |
|
65 | + * |
|
66 | + * @param string $notificationType (e.g SHARE_ACCEPTED) |
|
67 | + * @param string $providerId share ID |
|
68 | + * @param array $notification provider specific notification |
|
69 | + * @return array $data send back to sender |
|
70 | + * |
|
71 | + * @throws ShareNotFound |
|
72 | + * @throws ActionNotSupportedException |
|
73 | + * @throws BadRequestException |
|
74 | + * @throws AuthenticationFailedException |
|
75 | + * |
|
76 | + * @since 14.0.0 |
|
77 | + */ |
|
78 | + public function notificationReceived($notificationType, $providerId, array $notification); |
|
79 | 79 | |
80 | - /** |
|
81 | - * get the supported share types, e.g. "user", "group", etc. |
|
82 | - * |
|
83 | - * @return array |
|
84 | - * |
|
85 | - * @since 14.0.0 |
|
86 | - */ |
|
87 | - public function getSupportedShareTypes(); |
|
80 | + /** |
|
81 | + * get the supported share types, e.g. "user", "group", etc. |
|
82 | + * |
|
83 | + * @return array |
|
84 | + * |
|
85 | + * @since 14.0.0 |
|
86 | + */ |
|
87 | + public function getSupportedShareTypes(); |
|
88 | 88 | |
89 | 89 | } |
@@ -43,77 +43,77 @@ |
||
43 | 43 | * @since 6.0.0 |
44 | 44 | */ |
45 | 45 | interface IL10N { |
46 | - /** |
|
47 | - * Translating |
|
48 | - * @param string $text The text we need a translation for |
|
49 | - * @param array|string $parameters default:array() Parameters for sprintf |
|
50 | - * @return string Translation or the same text |
|
51 | - * |
|
52 | - * Returns the translation. If no translation is found, $text will be |
|
53 | - * returned. |
|
54 | - * @since 6.0.0 |
|
55 | - */ |
|
56 | - public function t(string $text, $parameters = []): string; |
|
46 | + /** |
|
47 | + * Translating |
|
48 | + * @param string $text The text we need a translation for |
|
49 | + * @param array|string $parameters default:array() Parameters for sprintf |
|
50 | + * @return string Translation or the same text |
|
51 | + * |
|
52 | + * Returns the translation. If no translation is found, $text will be |
|
53 | + * returned. |
|
54 | + * @since 6.0.0 |
|
55 | + */ |
|
56 | + public function t(string $text, $parameters = []): string; |
|
57 | 57 | |
58 | - /** |
|
59 | - * Translating |
|
60 | - * @param string $text_singular the string to translate for exactly one object |
|
61 | - * @param string $text_plural the string to translate for n objects |
|
62 | - * @param integer $count Number of objects |
|
63 | - * @param array $parameters default:array() Parameters for sprintf |
|
64 | - * @return string Translation or the same text |
|
65 | - * |
|
66 | - * Returns the translation. If no translation is found, $text will be |
|
67 | - * returned. %n will be replaced with the number of objects. |
|
68 | - * |
|
69 | - * The correct plural is determined by the plural_forms-function |
|
70 | - * provided by the po file. |
|
71 | - * @since 6.0.0 |
|
72 | - * |
|
73 | - */ |
|
74 | - public function n(string $text_singular, string $text_plural, int $count, array $parameters = []): string; |
|
58 | + /** |
|
59 | + * Translating |
|
60 | + * @param string $text_singular the string to translate for exactly one object |
|
61 | + * @param string $text_plural the string to translate for n objects |
|
62 | + * @param integer $count Number of objects |
|
63 | + * @param array $parameters default:array() Parameters for sprintf |
|
64 | + * @return string Translation or the same text |
|
65 | + * |
|
66 | + * Returns the translation. If no translation is found, $text will be |
|
67 | + * returned. %n will be replaced with the number of objects. |
|
68 | + * |
|
69 | + * The correct plural is determined by the plural_forms-function |
|
70 | + * provided by the po file. |
|
71 | + * @since 6.0.0 |
|
72 | + * |
|
73 | + */ |
|
74 | + public function n(string $text_singular, string $text_plural, int $count, array $parameters = []): string; |
|
75 | 75 | |
76 | - /** |
|
77 | - * Localization |
|
78 | - * @param string $type Type of localization |
|
79 | - * @param \DateTime|int|string $data parameters for this localization |
|
80 | - * @param array $options currently supports following options: |
|
81 | - * - 'width': handed into \Punic\Calendar::formatDate as second parameter |
|
82 | - * @return string|int|false |
|
83 | - * |
|
84 | - * Returns the localized data. |
|
85 | - * |
|
86 | - * Implemented types: |
|
87 | - * - date |
|
88 | - * - Creates a date |
|
89 | - * - l10n-field: date |
|
90 | - * - params: timestamp (int/string) |
|
91 | - * - datetime |
|
92 | - * - Creates date and time |
|
93 | - * - l10n-field: datetime |
|
94 | - * - params: timestamp (int/string) |
|
95 | - * - time |
|
96 | - * - Creates a time |
|
97 | - * - l10n-field: time |
|
98 | - * - params: timestamp (int/string) |
|
99 | - * @since 6.0.0 - parameter $options was added in 8.0.0 |
|
100 | - */ |
|
101 | - public function l(string $type, $data, array $options = []); |
|
76 | + /** |
|
77 | + * Localization |
|
78 | + * @param string $type Type of localization |
|
79 | + * @param \DateTime|int|string $data parameters for this localization |
|
80 | + * @param array $options currently supports following options: |
|
81 | + * - 'width': handed into \Punic\Calendar::formatDate as second parameter |
|
82 | + * @return string|int|false |
|
83 | + * |
|
84 | + * Returns the localized data. |
|
85 | + * |
|
86 | + * Implemented types: |
|
87 | + * - date |
|
88 | + * - Creates a date |
|
89 | + * - l10n-field: date |
|
90 | + * - params: timestamp (int/string) |
|
91 | + * - datetime |
|
92 | + * - Creates date and time |
|
93 | + * - l10n-field: datetime |
|
94 | + * - params: timestamp (int/string) |
|
95 | + * - time |
|
96 | + * - Creates a time |
|
97 | + * - l10n-field: time |
|
98 | + * - params: timestamp (int/string) |
|
99 | + * @since 6.0.0 - parameter $options was added in 8.0.0 |
|
100 | + */ |
|
101 | + public function l(string $type, $data, array $options = []); |
|
102 | 102 | |
103 | 103 | |
104 | - /** |
|
105 | - * The code (en, de, ...) of the language that is used for this IL10N object |
|
106 | - * |
|
107 | - * @return string language |
|
108 | - * @since 7.0.0 |
|
109 | - */ |
|
110 | - public function getLanguageCode(): string ; |
|
104 | + /** |
|
105 | + * The code (en, de, ...) of the language that is used for this IL10N object |
|
106 | + * |
|
107 | + * @return string language |
|
108 | + * @since 7.0.0 |
|
109 | + */ |
|
110 | + public function getLanguageCode(): string ; |
|
111 | 111 | |
112 | - /** |
|
113 | - * * The code (en_US, fr_CA, ...) of the locale that is used for this IL10N object |
|
114 | - * |
|
115 | - * @return string locale |
|
116 | - * @since 14.0.0 |
|
117 | - */ |
|
118 | - public function getLocaleCode(): string; |
|
112 | + /** |
|
113 | + * * The code (en_US, fr_CA, ...) of the locale that is used for this IL10N object |
|
114 | + * |
|
115 | + * @return string locale |
|
116 | + * @since 14.0.0 |
|
117 | + */ |
|
118 | + public function getLocaleCode(): string; |
|
119 | 119 | } |