@@ -31,39 +31,39 @@ |
||
31 | 31 | * @since 14.0.0 |
32 | 32 | */ |
33 | 33 | interface IBackend { |
34 | - /** |
|
35 | - * get a list of all resources in this backend |
|
36 | - * |
|
37 | - * @throws BackendTemporarilyUnavailableException |
|
38 | - * @return IResource[] |
|
39 | - * @since 14.0.0 |
|
40 | - */ |
|
41 | - public function getAllResources():array; |
|
34 | + /** |
|
35 | + * get a list of all resources in this backend |
|
36 | + * |
|
37 | + * @throws BackendTemporarilyUnavailableException |
|
38 | + * @return IResource[] |
|
39 | + * @since 14.0.0 |
|
40 | + */ |
|
41 | + public function getAllResources():array; |
|
42 | 42 | |
43 | - /** |
|
44 | - * get a list of all resource identifiers in this backend |
|
45 | - * |
|
46 | - * @throws BackendTemporarilyUnavailableException |
|
47 | - * @return string[] |
|
48 | - * @since 14.0.0 |
|
49 | - */ |
|
50 | - public function listAllResources():array; |
|
43 | + /** |
|
44 | + * get a list of all resource identifiers in this backend |
|
45 | + * |
|
46 | + * @throws BackendTemporarilyUnavailableException |
|
47 | + * @return string[] |
|
48 | + * @since 14.0.0 |
|
49 | + */ |
|
50 | + public function listAllResources():array; |
|
51 | 51 | |
52 | - /** |
|
53 | - * get a resource by it's id |
|
54 | - * |
|
55 | - * @param string $id |
|
56 | - * @throws BackendTemporarilyUnavailableException |
|
57 | - * @return IResource|null |
|
58 | - * @since 14.0.0 |
|
59 | - */ |
|
60 | - public function getResource($id); |
|
52 | + /** |
|
53 | + * get a resource by it's id |
|
54 | + * |
|
55 | + * @param string $id |
|
56 | + * @throws BackendTemporarilyUnavailableException |
|
57 | + * @return IResource|null |
|
58 | + * @since 14.0.0 |
|
59 | + */ |
|
60 | + public function getResource($id); |
|
61 | 61 | |
62 | - /** |
|
63 | - * Get unique identifier of the backend |
|
64 | - * |
|
65 | - * @return string |
|
66 | - * @since 14.0.0 |
|
67 | - */ |
|
68 | - public function getBackendIdentifier():string; |
|
62 | + /** |
|
63 | + * Get unique identifier of the backend |
|
64 | + * |
|
65 | + * @return string |
|
66 | + * @since 14.0.0 |
|
67 | + */ |
|
68 | + public function getBackendIdentifier():string; |
|
69 | 69 | } |
@@ -32,84 +32,84 @@ |
||
32 | 32 | * @since 17.0.0 |
33 | 33 | */ |
34 | 34 | interface IResourceMetadata { |
35 | - /** |
|
36 | - * Type of resource |
|
37 | - * |
|
38 | - * Allowed values for this key include: |
|
39 | - * - projector |
|
40 | - * - tv |
|
41 | - * - vehicle |
|
42 | - * - other |
|
43 | - * |
|
44 | - * @since 17.0.0 |
|
45 | - */ |
|
46 | - public const RESOURCE_TYPE = '{http://nextcloud.com/ns}resource-type'; |
|
35 | + /** |
|
36 | + * Type of resource |
|
37 | + * |
|
38 | + * Allowed values for this key include: |
|
39 | + * - projector |
|
40 | + * - tv |
|
41 | + * - vehicle |
|
42 | + * - other |
|
43 | + * |
|
44 | + * @since 17.0.0 |
|
45 | + */ |
|
46 | + public const RESOURCE_TYPE = '{http://nextcloud.com/ns}resource-type'; |
|
47 | 47 | |
48 | - /** |
|
49 | - * If resource is of type vehicle, this describes the type of vehicle |
|
50 | - * |
|
51 | - * Allowed values: |
|
52 | - * - bicycle |
|
53 | - * - scooter |
|
54 | - * - motorbike |
|
55 | - * - car |
|
56 | - * - plane |
|
57 | - * - helicopter |
|
58 | - * - other |
|
59 | - * |
|
60 | - * @since 17.0.0 |
|
61 | - */ |
|
62 | - public const VEHICLE_TYPE = '{http://nextcloud.com/ns}resource-vehicle-type'; |
|
48 | + /** |
|
49 | + * If resource is of type vehicle, this describes the type of vehicle |
|
50 | + * |
|
51 | + * Allowed values: |
|
52 | + * - bicycle |
|
53 | + * - scooter |
|
54 | + * - motorbike |
|
55 | + * - car |
|
56 | + * - plane |
|
57 | + * - helicopter |
|
58 | + * - other |
|
59 | + * |
|
60 | + * @since 17.0.0 |
|
61 | + */ |
|
62 | + public const VEHICLE_TYPE = '{http://nextcloud.com/ns}resource-vehicle-type'; |
|
63 | 63 | |
64 | - /** |
|
65 | - * Make of the vehicle |
|
66 | - * |
|
67 | - * @since 17.0.0 |
|
68 | - */ |
|
69 | - public const VEHICLE_MAKE = '{http://nextcloud.com/ns}resource-vehicle-make'; |
|
64 | + /** |
|
65 | + * Make of the vehicle |
|
66 | + * |
|
67 | + * @since 17.0.0 |
|
68 | + */ |
|
69 | + public const VEHICLE_MAKE = '{http://nextcloud.com/ns}resource-vehicle-make'; |
|
70 | 70 | |
71 | - /** |
|
72 | - * Model of the vehicle |
|
73 | - * |
|
74 | - * @since 17.0.0 |
|
75 | - */ |
|
76 | - public const VEHICLE_MODEL = '{http://nextcloud.com/ns}resource-vehicle-model'; |
|
71 | + /** |
|
72 | + * Model of the vehicle |
|
73 | + * |
|
74 | + * @since 17.0.0 |
|
75 | + */ |
|
76 | + public const VEHICLE_MODEL = '{http://nextcloud.com/ns}resource-vehicle-model'; |
|
77 | 77 | |
78 | - /** |
|
79 | - * Whether or not the car is electric |
|
80 | - * |
|
81 | - * use '1' for electric, '0' for non-electric |
|
82 | - * |
|
83 | - * @since 17.0.0 |
|
84 | - */ |
|
85 | - public const VEHICLE_IS_ELECTRIC = '{http://nextcloud.com/ns}resource-vehicle-is-electric'; |
|
78 | + /** |
|
79 | + * Whether or not the car is electric |
|
80 | + * |
|
81 | + * use '1' for electric, '0' for non-electric |
|
82 | + * |
|
83 | + * @since 17.0.0 |
|
84 | + */ |
|
85 | + public const VEHICLE_IS_ELECTRIC = '{http://nextcloud.com/ns}resource-vehicle-is-electric'; |
|
86 | 86 | |
87 | - /** |
|
88 | - * Range of vehicle with a full tank |
|
89 | - * |
|
90 | - * @since 17.0.0 |
|
91 | - */ |
|
92 | - public const VEHICLE_RANGE = '{http://nextcloud.com/ns}resource-vehicle-range'; |
|
87 | + /** |
|
88 | + * Range of vehicle with a full tank |
|
89 | + * |
|
90 | + * @since 17.0.0 |
|
91 | + */ |
|
92 | + public const VEHICLE_RANGE = '{http://nextcloud.com/ns}resource-vehicle-range'; |
|
93 | 93 | |
94 | - /** |
|
95 | - * Seating capacity of the vehicle |
|
96 | - * |
|
97 | - * @since 17.0.0 |
|
98 | - */ |
|
99 | - public const VEHICLE_SEATING_CAPACITY = '{http://nextcloud.com/ns}resource-vehicle-seating-capacity'; |
|
94 | + /** |
|
95 | + * Seating capacity of the vehicle |
|
96 | + * |
|
97 | + * @since 17.0.0 |
|
98 | + */ |
|
99 | + public const VEHICLE_SEATING_CAPACITY = '{http://nextcloud.com/ns}resource-vehicle-seating-capacity'; |
|
100 | 100 | |
101 | - /** |
|
102 | - * Contact information about the person who is responsible to administer / maintain this resource |
|
103 | - * This key stores a textual description of name and possible ways to contact the person |
|
104 | - * |
|
105 | - * @since 17.0.0 |
|
106 | - */ |
|
107 | - public const CONTACT_PERSON = '{http://nextcloud.com/ns}resource-contact-person'; |
|
101 | + /** |
|
102 | + * Contact information about the person who is responsible to administer / maintain this resource |
|
103 | + * This key stores a textual description of name and possible ways to contact the person |
|
104 | + * |
|
105 | + * @since 17.0.0 |
|
106 | + */ |
|
107 | + public const CONTACT_PERSON = '{http://nextcloud.com/ns}resource-contact-person'; |
|
108 | 108 | |
109 | - /** |
|
110 | - * Link to the vcard of the contact person |
|
111 | - * |
|
112 | - * @since 17.0.0 |
|
113 | - */ |
|
114 | - public const CONTACT_PERSON_VCARD = '{http://nextcloud.com/ns}resource-contact-person-vcard'; |
|
109 | + /** |
|
110 | + * Link to the vcard of the contact person |
|
111 | + * |
|
112 | + * @since 17.0.0 |
|
113 | + */ |
|
114 | + public const CONTACT_PERSON_VCARD = '{http://nextcloud.com/ns}resource-contact-person-vcard'; |
|
115 | 115 | } |
@@ -30,33 +30,33 @@ |
||
30 | 30 | * @since 17.0.0 |
31 | 31 | */ |
32 | 32 | interface IMetadataProvider { |
33 | - /** |
|
34 | - * Get a list of all metadata keys available for this room |
|
35 | - * |
|
36 | - * Room backends are allowed to return custom keys, beyond the ones |
|
37 | - * defined in this class. If they do, they should make sure to use their |
|
38 | - * own namespace. |
|
39 | - * |
|
40 | - * @return String[] - A list of available keys |
|
41 | - * @since 17.0.0 |
|
42 | - */ |
|
43 | - public function getAllAvailableMetadataKeys():array; |
|
33 | + /** |
|
34 | + * Get a list of all metadata keys available for this room |
|
35 | + * |
|
36 | + * Room backends are allowed to return custom keys, beyond the ones |
|
37 | + * defined in this class. If they do, they should make sure to use their |
|
38 | + * own namespace. |
|
39 | + * |
|
40 | + * @return String[] - A list of available keys |
|
41 | + * @since 17.0.0 |
|
42 | + */ |
|
43 | + public function getAllAvailableMetadataKeys():array; |
|
44 | 44 | |
45 | - /** |
|
46 | - * Get whether or not a metadata key is set for this room |
|
47 | - * |
|
48 | - * @param string $key - The key to check for |
|
49 | - * @return bool - Whether or not key is available |
|
50 | - * @since 17.0.0 |
|
51 | - */ |
|
52 | - public function hasMetadataForKey(string $key):bool; |
|
45 | + /** |
|
46 | + * Get whether or not a metadata key is set for this room |
|
47 | + * |
|
48 | + * @param string $key - The key to check for |
|
49 | + * @return bool - Whether or not key is available |
|
50 | + * @since 17.0.0 |
|
51 | + */ |
|
52 | + public function hasMetadataForKey(string $key):bool; |
|
53 | 53 | |
54 | - /** |
|
55 | - * Get the value for a metadata key |
|
56 | - * |
|
57 | - * @param string $key - The key to check for |
|
58 | - * @return string|null - The value stored for the key, null if no value stored |
|
59 | - * @since 17.0.0 |
|
60 | - */ |
|
61 | - public function getMetadataForKey(string $key):?string; |
|
54 | + /** |
|
55 | + * Get the value for a metadata key |
|
56 | + * |
|
57 | + * @param string $key - The key to check for |
|
58 | + * @return string|null - The value stored for the key, null if no value stored |
|
59 | + * @since 17.0.0 |
|
60 | + */ |
|
61 | + public function getMetadataForKey(string $key):?string; |
|
62 | 62 | } |
@@ -28,50 +28,50 @@ |
||
28 | 28 | * @since 14.0.0 |
29 | 29 | */ |
30 | 30 | interface IRoom { |
31 | - /** |
|
32 | - * Get a unique ID for the room |
|
33 | - * |
|
34 | - * This id has to be unique within the backend |
|
35 | - * |
|
36 | - * @return string |
|
37 | - * @since 14.0.0 |
|
38 | - */ |
|
39 | - public function getId():string; |
|
31 | + /** |
|
32 | + * Get a unique ID for the room |
|
33 | + * |
|
34 | + * This id has to be unique within the backend |
|
35 | + * |
|
36 | + * @return string |
|
37 | + * @since 14.0.0 |
|
38 | + */ |
|
39 | + public function getId():string; |
|
40 | 40 | |
41 | - /** |
|
42 | - * Get the display name for the room |
|
43 | - * |
|
44 | - * @return string |
|
45 | - * @since 14.0.0 |
|
46 | - */ |
|
47 | - public function getDisplayName():string; |
|
41 | + /** |
|
42 | + * Get the display name for the room |
|
43 | + * |
|
44 | + * @return string |
|
45 | + * @since 14.0.0 |
|
46 | + */ |
|
47 | + public function getDisplayName():string; |
|
48 | 48 | |
49 | - /** |
|
50 | - * Get a list of groupIds that are allowed to access this room |
|
51 | - * |
|
52 | - * If an empty array is returned, no group restrictions are |
|
53 | - * applied. |
|
54 | - * |
|
55 | - * @return string[] |
|
56 | - * @since 14.0.0 |
|
57 | - */ |
|
58 | - public function getGroupRestrictions():array; |
|
49 | + /** |
|
50 | + * Get a list of groupIds that are allowed to access this room |
|
51 | + * |
|
52 | + * If an empty array is returned, no group restrictions are |
|
53 | + * applied. |
|
54 | + * |
|
55 | + * @return string[] |
|
56 | + * @since 14.0.0 |
|
57 | + */ |
|
58 | + public function getGroupRestrictions():array; |
|
59 | 59 | |
60 | - /** |
|
61 | - * Get the email-address for the room |
|
62 | - * |
|
63 | - * The email-address has to be globally unique |
|
64 | - * |
|
65 | - * @return string |
|
66 | - * @since 14.0.0 |
|
67 | - */ |
|
68 | - public function getEMail():string; |
|
60 | + /** |
|
61 | + * Get the email-address for the room |
|
62 | + * |
|
63 | + * The email-address has to be globally unique |
|
64 | + * |
|
65 | + * @return string |
|
66 | + * @since 14.0.0 |
|
67 | + */ |
|
68 | + public function getEMail():string; |
|
69 | 69 | |
70 | - /** |
|
71 | - * Get corresponding backend object |
|
72 | - * |
|
73 | - * @return IBackend |
|
74 | - * @since 14.0.0 |
|
75 | - */ |
|
76 | - public function getBackend():IBackend; |
|
70 | + /** |
|
71 | + * Get corresponding backend object |
|
72 | + * |
|
73 | + * @return IBackend |
|
74 | + * @since 14.0.0 |
|
75 | + */ |
|
76 | + public function getBackend():IBackend; |
|
77 | 77 | } |
@@ -32,61 +32,61 @@ |
||
32 | 32 | * @since 17.0.0 |
33 | 33 | */ |
34 | 34 | interface IRoomMetadata { |
35 | - /** |
|
36 | - * Type of room |
|
37 | - * |
|
38 | - * Allowed values for this key are: |
|
39 | - * - meeting-room |
|
40 | - * - lecture-hall |
|
41 | - * - seminar-room |
|
42 | - * - other |
|
43 | - * |
|
44 | - * @since 17.0.0 |
|
45 | - */ |
|
46 | - public const ROOM_TYPE = '{http://nextcloud.com/ns}room-type'; |
|
35 | + /** |
|
36 | + * Type of room |
|
37 | + * |
|
38 | + * Allowed values for this key are: |
|
39 | + * - meeting-room |
|
40 | + * - lecture-hall |
|
41 | + * - seminar-room |
|
42 | + * - other |
|
43 | + * |
|
44 | + * @since 17.0.0 |
|
45 | + */ |
|
46 | + public const ROOM_TYPE = '{http://nextcloud.com/ns}room-type'; |
|
47 | 47 | |
48 | - /** |
|
49 | - * Seating capacity of the room |
|
50 | - * |
|
51 | - * @since 17.0.0 |
|
52 | - */ |
|
53 | - public const CAPACITY = '{http://nextcloud.com/ns}room-seating-capacity'; |
|
48 | + /** |
|
49 | + * Seating capacity of the room |
|
50 | + * |
|
51 | + * @since 17.0.0 |
|
52 | + */ |
|
53 | + public const CAPACITY = '{http://nextcloud.com/ns}room-seating-capacity'; |
|
54 | 54 | |
55 | - /** |
|
56 | - * The physical address of the building this room is located in |
|
57 | - * |
|
58 | - * @since 17.0.0 |
|
59 | - */ |
|
60 | - public const BUILDING_ADDRESS = '{http://nextcloud.com/ns}room-building-address'; |
|
55 | + /** |
|
56 | + * The physical address of the building this room is located in |
|
57 | + * |
|
58 | + * @since 17.0.0 |
|
59 | + */ |
|
60 | + public const BUILDING_ADDRESS = '{http://nextcloud.com/ns}room-building-address'; |
|
61 | 61 | |
62 | - /** |
|
63 | - * The story of the building this rooms is located in |
|
64 | - * |
|
65 | - * @since 17.0.0 |
|
66 | - */ |
|
67 | - public const BUILDING_STORY = '{http://nextcloud.com/ns}room-building-story'; |
|
62 | + /** |
|
63 | + * The story of the building this rooms is located in |
|
64 | + * |
|
65 | + * @since 17.0.0 |
|
66 | + */ |
|
67 | + public const BUILDING_STORY = '{http://nextcloud.com/ns}room-building-story'; |
|
68 | 68 | |
69 | - /** |
|
70 | - * The room-number |
|
71 | - * |
|
72 | - * @since 17.0.0 |
|
73 | - */ |
|
74 | - public const BUILDING_ROOM_NUMBER = '{http://nextcloud.com/ns}room-building-room-number'; |
|
69 | + /** |
|
70 | + * The room-number |
|
71 | + * |
|
72 | + * @since 17.0.0 |
|
73 | + */ |
|
74 | + public const BUILDING_ROOM_NUMBER = '{http://nextcloud.com/ns}room-building-room-number'; |
|
75 | 75 | |
76 | - /** |
|
77 | - * Features provided by the room. |
|
78 | - * This is a stringified list of features. |
|
79 | - * Example: "PHONE,VIDEO-CONFERENCING" |
|
80 | - * |
|
81 | - * Standard features include: |
|
82 | - * - PHONE: This room is fitted with a phone |
|
83 | - * - VIDEO-CONFERENCING: This room is fitted with a video-conferencing system |
|
84 | - * - TV: This room is fitted with a TV |
|
85 | - * - PROJECTOR: This room is fitted with a projector |
|
86 | - * - WHITEBOARD: This room is fitted with a whiteboard |
|
87 | - * - WHEELCHAIR-ACCESSIBLE: This room is wheelchair-accessible |
|
88 | - * |
|
89 | - * @since 17.0.0 |
|
90 | - */ |
|
91 | - public const FEATURES = '{http://nextcloud.com/ns}room-features'; |
|
76 | + /** |
|
77 | + * Features provided by the room. |
|
78 | + * This is a stringified list of features. |
|
79 | + * Example: "PHONE,VIDEO-CONFERENCING" |
|
80 | + * |
|
81 | + * Standard features include: |
|
82 | + * - PHONE: This room is fitted with a phone |
|
83 | + * - VIDEO-CONFERENCING: This room is fitted with a video-conferencing system |
|
84 | + * - TV: This room is fitted with a TV |
|
85 | + * - PROJECTOR: This room is fitted with a projector |
|
86 | + * - WHITEBOARD: This room is fitted with a whiteboard |
|
87 | + * - WHEELCHAIR-ACCESSIBLE: This room is wheelchair-accessible |
|
88 | + * |
|
89 | + * @since 17.0.0 |
|
90 | + */ |
|
91 | + public const FEATURES = '{http://nextcloud.com/ns}room-features'; |
|
92 | 92 | } |
@@ -31,39 +31,39 @@ |
||
31 | 31 | * @since 14.0.0 |
32 | 32 | */ |
33 | 33 | interface IBackend { |
34 | - /** |
|
35 | - * get a list of all rooms in this backend |
|
36 | - * |
|
37 | - * @throws BackendTemporarilyUnavailableException |
|
38 | - * @return IRoom[] |
|
39 | - * @since 14.0.0 |
|
40 | - */ |
|
41 | - public function getAllRooms():array; |
|
34 | + /** |
|
35 | + * get a list of all rooms in this backend |
|
36 | + * |
|
37 | + * @throws BackendTemporarilyUnavailableException |
|
38 | + * @return IRoom[] |
|
39 | + * @since 14.0.0 |
|
40 | + */ |
|
41 | + public function getAllRooms():array; |
|
42 | 42 | |
43 | - /** |
|
44 | - * get a list of all room identifiers in this backend |
|
45 | - * |
|
46 | - * @throws BackendTemporarilyUnavailableException |
|
47 | - * @return string[] |
|
48 | - * @since 14.0.0 |
|
49 | - */ |
|
50 | - public function listAllRooms():array; |
|
43 | + /** |
|
44 | + * get a list of all room identifiers in this backend |
|
45 | + * |
|
46 | + * @throws BackendTemporarilyUnavailableException |
|
47 | + * @return string[] |
|
48 | + * @since 14.0.0 |
|
49 | + */ |
|
50 | + public function listAllRooms():array; |
|
51 | 51 | |
52 | - /** |
|
53 | - * get a room by it's id |
|
54 | - * |
|
55 | - * @param string $id |
|
56 | - * @throws BackendTemporarilyUnavailableException |
|
57 | - * @return IRoom|null |
|
58 | - * @since 14.0.0 |
|
59 | - */ |
|
60 | - public function getRoom($id); |
|
52 | + /** |
|
53 | + * get a room by it's id |
|
54 | + * |
|
55 | + * @param string $id |
|
56 | + * @throws BackendTemporarilyUnavailableException |
|
57 | + * @return IRoom|null |
|
58 | + * @since 14.0.0 |
|
59 | + */ |
|
60 | + public function getRoom($id); |
|
61 | 61 | |
62 | - /** |
|
63 | - * Get unique identifier of the backend |
|
64 | - * |
|
65 | - * @return string |
|
66 | - * @since 14.0.0 |
|
67 | - */ |
|
68 | - public function getBackendIdentifier():string; |
|
62 | + /** |
|
63 | + * Get unique identifier of the backend |
|
64 | + * |
|
65 | + * @return string |
|
66 | + * @since 14.0.0 |
|
67 | + */ |
|
68 | + public function getBackendIdentifier():string; |
|
69 | 69 | } |
@@ -34,11 +34,11 @@ |
||
34 | 34 | * @since 23.0.0 |
35 | 35 | */ |
36 | 36 | interface ICalendarProvider { |
37 | - /** |
|
38 | - * @param string $principalUri URI of the principal |
|
39 | - * @param string[] $calendarUris optionally specify which calendars to load, or all if this array is empty |
|
40 | - * @return ICalendar[] |
|
41 | - * @since 23.0.0 |
|
42 | - */ |
|
43 | - public function getCalendars(string $principalUri, array $calendarUris = []): array; |
|
37 | + /** |
|
38 | + * @param string $principalUri URI of the principal |
|
39 | + * @param string[] $calendarUris optionally specify which calendars to load, or all if this array is empty |
|
40 | + * @return ICalendar[] |
|
41 | + * @since 23.0.0 |
|
42 | + */ |
|
43 | + public function getCalendars(string $principalUri, array $calendarUris = []): array; |
|
44 | 44 | } |
@@ -31,151 +31,151 @@ |
||
31 | 31 | * @since 8.1.0 |
32 | 32 | */ |
33 | 33 | interface IStorage { |
34 | - /** |
|
35 | - * get user specific key |
|
36 | - * |
|
37 | - * @param string $uid ID if the user for whom we want the key |
|
38 | - * @param string $keyId id of the key |
|
39 | - * @param string $encryptionModuleId |
|
40 | - * |
|
41 | - * @return mixed key |
|
42 | - * @since 8.1.0 |
|
43 | - */ |
|
44 | - public function getUserKey($uid, $keyId, $encryptionModuleId); |
|
34 | + /** |
|
35 | + * get user specific key |
|
36 | + * |
|
37 | + * @param string $uid ID if the user for whom we want the key |
|
38 | + * @param string $keyId id of the key |
|
39 | + * @param string $encryptionModuleId |
|
40 | + * |
|
41 | + * @return mixed key |
|
42 | + * @since 8.1.0 |
|
43 | + */ |
|
44 | + public function getUserKey($uid, $keyId, $encryptionModuleId); |
|
45 | 45 | |
46 | - /** |
|
47 | - * get file specific key |
|
48 | - * |
|
49 | - * @param string $path path to file |
|
50 | - * @param string $keyId id of the key |
|
51 | - * @param string $encryptionModuleId |
|
52 | - * |
|
53 | - * @return mixed key |
|
54 | - * @since 8.1.0 |
|
55 | - */ |
|
56 | - public function getFileKey($path, $keyId, $encryptionModuleId); |
|
46 | + /** |
|
47 | + * get file specific key |
|
48 | + * |
|
49 | + * @param string $path path to file |
|
50 | + * @param string $keyId id of the key |
|
51 | + * @param string $encryptionModuleId |
|
52 | + * |
|
53 | + * @return mixed key |
|
54 | + * @since 8.1.0 |
|
55 | + */ |
|
56 | + public function getFileKey($path, $keyId, $encryptionModuleId); |
|
57 | 57 | |
58 | - /** |
|
59 | - * get system-wide encryption keys not related to a specific user, |
|
60 | - * e.g something like a key for public link shares |
|
61 | - * |
|
62 | - * @param string $keyId id of the key |
|
63 | - * @param string $encryptionModuleId |
|
64 | - * |
|
65 | - * @return mixed key |
|
66 | - * @since 8.1.0 |
|
67 | - */ |
|
68 | - public function getSystemUserKey($keyId, $encryptionModuleId); |
|
58 | + /** |
|
59 | + * get system-wide encryption keys not related to a specific user, |
|
60 | + * e.g something like a key for public link shares |
|
61 | + * |
|
62 | + * @param string $keyId id of the key |
|
63 | + * @param string $encryptionModuleId |
|
64 | + * |
|
65 | + * @return mixed key |
|
66 | + * @since 8.1.0 |
|
67 | + */ |
|
68 | + public function getSystemUserKey($keyId, $encryptionModuleId); |
|
69 | 69 | |
70 | - /** |
|
71 | - * set user specific key |
|
72 | - * |
|
73 | - * @param string $uid ID if the user for whom we want the key |
|
74 | - * @param string $keyId id of the key |
|
75 | - * @param mixed $key |
|
76 | - * @param string $encryptionModuleId |
|
77 | - * @since 8.1.0 |
|
78 | - */ |
|
79 | - public function setUserKey($uid, $keyId, $key, $encryptionModuleId); |
|
70 | + /** |
|
71 | + * set user specific key |
|
72 | + * |
|
73 | + * @param string $uid ID if the user for whom we want the key |
|
74 | + * @param string $keyId id of the key |
|
75 | + * @param mixed $key |
|
76 | + * @param string $encryptionModuleId |
|
77 | + * @since 8.1.0 |
|
78 | + */ |
|
79 | + public function setUserKey($uid, $keyId, $key, $encryptionModuleId); |
|
80 | 80 | |
81 | - /** |
|
82 | - * set file specific key |
|
83 | - * |
|
84 | - * @param string $path path to file |
|
85 | - * @param string $keyId id of the key |
|
86 | - * @param mixed $key |
|
87 | - * @param string $encryptionModuleId |
|
88 | - * @since 8.1.0 |
|
89 | - */ |
|
90 | - public function setFileKey($path, $keyId, $key, $encryptionModuleId); |
|
81 | + /** |
|
82 | + * set file specific key |
|
83 | + * |
|
84 | + * @param string $path path to file |
|
85 | + * @param string $keyId id of the key |
|
86 | + * @param mixed $key |
|
87 | + * @param string $encryptionModuleId |
|
88 | + * @since 8.1.0 |
|
89 | + */ |
|
90 | + public function setFileKey($path, $keyId, $key, $encryptionModuleId); |
|
91 | 91 | |
92 | - /** |
|
93 | - * set system-wide encryption keys not related to a specific user, |
|
94 | - * e.g something like a key for public link shares |
|
95 | - * |
|
96 | - * @param string $keyId id of the key |
|
97 | - * @param mixed $key |
|
98 | - * @param string $encryptionModuleId |
|
99 | - * |
|
100 | - * @return mixed key |
|
101 | - * @since 8.1.0 |
|
102 | - */ |
|
103 | - public function setSystemUserKey($keyId, $key, $encryptionModuleId); |
|
92 | + /** |
|
93 | + * set system-wide encryption keys not related to a specific user, |
|
94 | + * e.g something like a key for public link shares |
|
95 | + * |
|
96 | + * @param string $keyId id of the key |
|
97 | + * @param mixed $key |
|
98 | + * @param string $encryptionModuleId |
|
99 | + * |
|
100 | + * @return mixed key |
|
101 | + * @since 8.1.0 |
|
102 | + */ |
|
103 | + public function setSystemUserKey($keyId, $key, $encryptionModuleId); |
|
104 | 104 | |
105 | - /** |
|
106 | - * delete user specific key |
|
107 | - * |
|
108 | - * @param string $uid ID if the user for whom we want to delete the key |
|
109 | - * @param string $keyId id of the key |
|
110 | - * @param string $encryptionModuleId |
|
111 | - * |
|
112 | - * @return boolean False when the key could not be deleted |
|
113 | - * @since 8.1.0 |
|
114 | - */ |
|
115 | - public function deleteUserKey($uid, $keyId, $encryptionModuleId); |
|
105 | + /** |
|
106 | + * delete user specific key |
|
107 | + * |
|
108 | + * @param string $uid ID if the user for whom we want to delete the key |
|
109 | + * @param string $keyId id of the key |
|
110 | + * @param string $encryptionModuleId |
|
111 | + * |
|
112 | + * @return boolean False when the key could not be deleted |
|
113 | + * @since 8.1.0 |
|
114 | + */ |
|
115 | + public function deleteUserKey($uid, $keyId, $encryptionModuleId); |
|
116 | 116 | |
117 | - /** |
|
118 | - * delete file specific key |
|
119 | - * |
|
120 | - * @param string $path path to file |
|
121 | - * @param string $keyId id of the key |
|
122 | - * @param string $encryptionModuleId |
|
123 | - * |
|
124 | - * @return boolean False when the key could not be deleted |
|
125 | - * @since 8.1.0 |
|
126 | - */ |
|
127 | - public function deleteFileKey($path, $keyId, $encryptionModuleId); |
|
117 | + /** |
|
118 | + * delete file specific key |
|
119 | + * |
|
120 | + * @param string $path path to file |
|
121 | + * @param string $keyId id of the key |
|
122 | + * @param string $encryptionModuleId |
|
123 | + * |
|
124 | + * @return boolean False when the key could not be deleted |
|
125 | + * @since 8.1.0 |
|
126 | + */ |
|
127 | + public function deleteFileKey($path, $keyId, $encryptionModuleId); |
|
128 | 128 | |
129 | - /** |
|
130 | - * delete all file keys for a given file |
|
131 | - * |
|
132 | - * @param string $path to the file |
|
133 | - * |
|
134 | - * @return boolean False when the keys could not be deleted |
|
135 | - * @since 8.1.0 |
|
136 | - */ |
|
137 | - public function deleteAllFileKeys($path); |
|
129 | + /** |
|
130 | + * delete all file keys for a given file |
|
131 | + * |
|
132 | + * @param string $path to the file |
|
133 | + * |
|
134 | + * @return boolean False when the keys could not be deleted |
|
135 | + * @since 8.1.0 |
|
136 | + */ |
|
137 | + public function deleteAllFileKeys($path); |
|
138 | 138 | |
139 | - /** |
|
140 | - * delete system-wide encryption keys not related to a specific user, |
|
141 | - * e.g something like a key for public link shares |
|
142 | - * |
|
143 | - * @param string $keyId id of the key |
|
144 | - * @param string $encryptionModuleId |
|
145 | - * |
|
146 | - * @return boolean False when the key could not be deleted |
|
147 | - * @since 8.1.0 |
|
148 | - */ |
|
149 | - public function deleteSystemUserKey($keyId, $encryptionModuleId); |
|
139 | + /** |
|
140 | + * delete system-wide encryption keys not related to a specific user, |
|
141 | + * e.g something like a key for public link shares |
|
142 | + * |
|
143 | + * @param string $keyId id of the key |
|
144 | + * @param string $encryptionModuleId |
|
145 | + * |
|
146 | + * @return boolean False when the key could not be deleted |
|
147 | + * @since 8.1.0 |
|
148 | + */ |
|
149 | + public function deleteSystemUserKey($keyId, $encryptionModuleId); |
|
150 | 150 | |
151 | - /** |
|
152 | - * copy keys if a file was renamed |
|
153 | - * |
|
154 | - * @param string $source |
|
155 | - * @param string $target |
|
156 | - * @return boolean |
|
157 | - * @since 8.1.0 |
|
158 | - */ |
|
159 | - public function renameKeys($source, $target); |
|
151 | + /** |
|
152 | + * copy keys if a file was renamed |
|
153 | + * |
|
154 | + * @param string $source |
|
155 | + * @param string $target |
|
156 | + * @return boolean |
|
157 | + * @since 8.1.0 |
|
158 | + */ |
|
159 | + public function renameKeys($source, $target); |
|
160 | 160 | |
161 | - /** |
|
162 | - * move keys if a file was renamed |
|
163 | - * |
|
164 | - * @param string $source |
|
165 | - * @param string $target |
|
166 | - * @return boolean |
|
167 | - * @since 8.1.0 |
|
168 | - */ |
|
169 | - public function copyKeys($source, $target); |
|
161 | + /** |
|
162 | + * move keys if a file was renamed |
|
163 | + * |
|
164 | + * @param string $source |
|
165 | + * @param string $target |
|
166 | + * @return boolean |
|
167 | + * @since 8.1.0 |
|
168 | + */ |
|
169 | + public function copyKeys($source, $target); |
|
170 | 170 | |
171 | - /** |
|
172 | - * backup keys of a given encryption module |
|
173 | - * |
|
174 | - * @param string $encryptionModuleId |
|
175 | - * @param string $purpose |
|
176 | - * @param string $uid |
|
177 | - * @return bool |
|
178 | - * @since 12.0.0 |
|
179 | - */ |
|
180 | - public function backupUserKeys($encryptionModuleId, $purpose, $uid); |
|
171 | + /** |
|
172 | + * backup keys of a given encryption module |
|
173 | + * |
|
174 | + * @param string $encryptionModuleId |
|
175 | + * @param string $purpose |
|
176 | + * @param string $uid |
|
177 | + * @return bool |
|
178 | + * @since 12.0.0 |
|
179 | + */ |
|
180 | + public function backupUserKeys($encryptionModuleId, $purpose, $uid); |
|
181 | 181 | } |
@@ -33,66 +33,66 @@ |
||
33 | 33 | * @since 8.1.0 |
34 | 34 | */ |
35 | 35 | interface IManager { |
36 | - /** |
|
37 | - * Check if encryption is available (at least one encryption module needs to be enabled) |
|
38 | - * |
|
39 | - * @return bool true if enabled, false if not |
|
40 | - * @since 8.1.0 |
|
41 | - */ |
|
42 | - public function isEnabled(); |
|
36 | + /** |
|
37 | + * Check if encryption is available (at least one encryption module needs to be enabled) |
|
38 | + * |
|
39 | + * @return bool true if enabled, false if not |
|
40 | + * @since 8.1.0 |
|
41 | + */ |
|
42 | + public function isEnabled(); |
|
43 | 43 | |
44 | - /** |
|
45 | - * Registers an callback function which must return an encryption module instance |
|
46 | - * |
|
47 | - * @param string $id |
|
48 | - * @param string $displayName |
|
49 | - * @param callable $callback |
|
50 | - * @throws ModuleAlreadyExistsException |
|
51 | - * @since 8.1.0 |
|
52 | - */ |
|
53 | - public function registerEncryptionModule($id, $displayName, callable $callback); |
|
44 | + /** |
|
45 | + * Registers an callback function which must return an encryption module instance |
|
46 | + * |
|
47 | + * @param string $id |
|
48 | + * @param string $displayName |
|
49 | + * @param callable $callback |
|
50 | + * @throws ModuleAlreadyExistsException |
|
51 | + * @since 8.1.0 |
|
52 | + */ |
|
53 | + public function registerEncryptionModule($id, $displayName, callable $callback); |
|
54 | 54 | |
55 | - /** |
|
56 | - * Unregisters an encryption module |
|
57 | - * |
|
58 | - * @param string $moduleId |
|
59 | - * @since 8.1.0 |
|
60 | - */ |
|
61 | - public function unregisterEncryptionModule($moduleId); |
|
55 | + /** |
|
56 | + * Unregisters an encryption module |
|
57 | + * |
|
58 | + * @param string $moduleId |
|
59 | + * @since 8.1.0 |
|
60 | + */ |
|
61 | + public function unregisterEncryptionModule($moduleId); |
|
62 | 62 | |
63 | - /** |
|
64 | - * get a list of all encryption modules |
|
65 | - * |
|
66 | - * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
67 | - * @since 8.1.0 |
|
68 | - */ |
|
69 | - public function getEncryptionModules(); |
|
63 | + /** |
|
64 | + * get a list of all encryption modules |
|
65 | + * |
|
66 | + * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
67 | + * @since 8.1.0 |
|
68 | + */ |
|
69 | + public function getEncryptionModules(); |
|
70 | 70 | |
71 | 71 | |
72 | - /** |
|
73 | - * get a specific encryption module |
|
74 | - * |
|
75 | - * @param string $moduleId Empty to get the default module |
|
76 | - * @return IEncryptionModule |
|
77 | - * @throws ModuleDoesNotExistsException |
|
78 | - * @since 8.1.0 |
|
79 | - */ |
|
80 | - public function getEncryptionModule($moduleId = ''); |
|
72 | + /** |
|
73 | + * get a specific encryption module |
|
74 | + * |
|
75 | + * @param string $moduleId Empty to get the default module |
|
76 | + * @return IEncryptionModule |
|
77 | + * @throws ModuleDoesNotExistsException |
|
78 | + * @since 8.1.0 |
|
79 | + */ |
|
80 | + public function getEncryptionModule($moduleId = ''); |
|
81 | 81 | |
82 | - /** |
|
83 | - * get default encryption module Id |
|
84 | - * |
|
85 | - * @return string |
|
86 | - * @since 8.1.0 |
|
87 | - */ |
|
88 | - public function getDefaultEncryptionModuleId(); |
|
82 | + /** |
|
83 | + * get default encryption module Id |
|
84 | + * |
|
85 | + * @return string |
|
86 | + * @since 8.1.0 |
|
87 | + */ |
|
88 | + public function getDefaultEncryptionModuleId(); |
|
89 | 89 | |
90 | - /** |
|
91 | - * set default encryption module Id |
|
92 | - * |
|
93 | - * @param string $moduleId |
|
94 | - * @return string |
|
95 | - * @since 8.1.0 |
|
96 | - */ |
|
97 | - public function setDefaultEncryptionModule($moduleId); |
|
90 | + /** |
|
91 | + * set default encryption module Id |
|
92 | + * |
|
93 | + * @param string $moduleId |
|
94 | + * @return string |
|
95 | + * @since 8.1.0 |
|
96 | + */ |
|
97 | + public function setDefaultEncryptionModule($moduleId); |
|
98 | 98 | } |