@@ -25,27 +25,27 @@ |
||
25 | 25 | |
26 | 26 | class Plugin extends \Sabre\CalDAV\Plugin { |
27 | 27 | |
28 | - const SYSTEM_CALENDAR_ROOT = 'system-calendars'; |
|
28 | + const SYSTEM_CALENDAR_ROOT = 'system-calendars'; |
|
29 | 29 | |
30 | - /** |
|
31 | - * @inheritdoc |
|
32 | - */ |
|
33 | - function getCalendarHomeForPrincipal($principalUrl):string { |
|
30 | + /** |
|
31 | + * @inheritdoc |
|
32 | + */ |
|
33 | + function getCalendarHomeForPrincipal($principalUrl):string { |
|
34 | 34 | |
35 | - if (strrpos($principalUrl, 'principals/users', -strlen($principalUrl)) !== false) { |
|
36 | - list(, $principalId) = \Sabre\Uri\split($principalUrl); |
|
37 | - return self::CALENDAR_ROOT . '/' . $principalId; |
|
38 | - } |
|
39 | - if (strrpos($principalUrl, 'principals/calendar-resources', -strlen($principalUrl)) !== false) { |
|
40 | - list(, $principalId) = \Sabre\Uri\split($principalUrl); |
|
41 | - return self::SYSTEM_CALENDAR_ROOT . '/calendar-resources/' . $principalId; |
|
42 | - } |
|
43 | - if (strrpos($principalUrl, 'principals/calendar-rooms', -strlen($principalUrl)) !== false) { |
|
44 | - list(, $principalId) = \Sabre\Uri\split($principalUrl); |
|
45 | - return self::SYSTEM_CALENDAR_ROOT . '/calendar-rooms/' . $principalId; |
|
46 | - } |
|
35 | + if (strrpos($principalUrl, 'principals/users', -strlen($principalUrl)) !== false) { |
|
36 | + list(, $principalId) = \Sabre\Uri\split($principalUrl); |
|
37 | + return self::CALENDAR_ROOT . '/' . $principalId; |
|
38 | + } |
|
39 | + if (strrpos($principalUrl, 'principals/calendar-resources', -strlen($principalUrl)) !== false) { |
|
40 | + list(, $principalId) = \Sabre\Uri\split($principalUrl); |
|
41 | + return self::SYSTEM_CALENDAR_ROOT . '/calendar-resources/' . $principalId; |
|
42 | + } |
|
43 | + if (strrpos($principalUrl, 'principals/calendar-rooms', -strlen($principalUrl)) !== false) { |
|
44 | + list(, $principalId) = \Sabre\Uri\split($principalUrl); |
|
45 | + return self::SYSTEM_CALENDAR_ROOT . '/calendar-rooms/' . $principalId; |
|
46 | + } |
|
47 | 47 | |
48 | - throw new \LogicException('This is not supposed to happen'); |
|
49 | - } |
|
48 | + throw new \LogicException('This is not supposed to happen'); |
|
49 | + } |
|
50 | 50 | |
51 | 51 | } |
@@ -34,15 +34,15 @@ |
||
34 | 34 | |
35 | 35 | if (strrpos($principalUrl, 'principals/users', -strlen($principalUrl)) !== false) { |
36 | 36 | list(, $principalId) = \Sabre\Uri\split($principalUrl); |
37 | - return self::CALENDAR_ROOT . '/' . $principalId; |
|
37 | + return self::CALENDAR_ROOT.'/'.$principalId; |
|
38 | 38 | } |
39 | 39 | if (strrpos($principalUrl, 'principals/calendar-resources', -strlen($principalUrl)) !== false) { |
40 | 40 | list(, $principalId) = \Sabre\Uri\split($principalUrl); |
41 | - return self::SYSTEM_CALENDAR_ROOT . '/calendar-resources/' . $principalId; |
|
41 | + return self::SYSTEM_CALENDAR_ROOT.'/calendar-resources/'.$principalId; |
|
42 | 42 | } |
43 | 43 | if (strrpos($principalUrl, 'principals/calendar-rooms', -strlen($principalUrl)) !== false) { |
44 | 44 | list(, $principalId) = \Sabre\Uri\split($principalUrl); |
45 | - return self::SYSTEM_CALENDAR_ROOT . '/calendar-rooms/' . $principalId; |
|
45 | + return self::SYSTEM_CALENDAR_ROOT.'/calendar-rooms/'.$principalId; |
|
46 | 46 | } |
47 | 47 | |
48 | 48 | throw new \LogicException('This is not supposed to happen'); |
@@ -32,56 +32,56 @@ |
||
32 | 32 | */ |
33 | 33 | class Version1005Date20180530124431 extends SimpleMigrationStep { |
34 | 34 | |
35 | - /** |
|
36 | - * @param IOutput $output |
|
37 | - * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
38 | - * @param array $options |
|
39 | - * @return null|ISchemaWrapper |
|
40 | - * @since 13.0.0 |
|
41 | - */ |
|
42 | - public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options) { |
|
43 | - /** @var ISchemaWrapper $schema */ |
|
44 | - $schema = $schemaClosure(); |
|
35 | + /** |
|
36 | + * @param IOutput $output |
|
37 | + * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
38 | + * @param array $options |
|
39 | + * @return null|ISchemaWrapper |
|
40 | + * @since 13.0.0 |
|
41 | + */ |
|
42 | + public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options) { |
|
43 | + /** @var ISchemaWrapper $schema */ |
|
44 | + $schema = $schemaClosure(); |
|
45 | 45 | |
46 | - $types = ['resources', 'rooms']; |
|
47 | - foreach($types as $type) { |
|
48 | - if (!$schema->hasTable('calendar_' . $type . '_cache')) { |
|
49 | - $table = $schema->createTable('calendar_' . $type . '_cache'); |
|
46 | + $types = ['resources', 'rooms']; |
|
47 | + foreach($types as $type) { |
|
48 | + if (!$schema->hasTable('calendar_' . $type . '_cache')) { |
|
49 | + $table = $schema->createTable('calendar_' . $type . '_cache'); |
|
50 | 50 | |
51 | - $table->addColumn('id', Type::BIGINT, [ |
|
52 | - 'autoincrement' => true, |
|
53 | - 'notnull' => true, |
|
54 | - 'length' => 11, |
|
55 | - 'unsigned' => true, |
|
56 | - ]); |
|
57 | - $table->addColumn('backend_id', Type::STRING, [ |
|
58 | - 'notnull' => false, |
|
59 | - 'length' => 64, |
|
60 | - ]); |
|
61 | - $table->addColumn('resource_id', Type::STRING, [ |
|
62 | - 'notnull' => false, |
|
63 | - 'length' => 64, |
|
64 | - ]); |
|
65 | - $table->addColumn('email', Type::STRING, [ |
|
66 | - 'notnull' => false, |
|
67 | - 'length' => 255, |
|
68 | - ]); |
|
69 | - $table->addColumn('displayname', Type::STRING, [ |
|
70 | - 'notnull' => false, |
|
71 | - 'length' => 255, |
|
72 | - ]); |
|
73 | - $table->addColumn('group_restrictions', Type::STRING, [ |
|
74 | - 'notnull' => false, |
|
75 | - 'length' => 4000, |
|
76 | - ]); |
|
51 | + $table->addColumn('id', Type::BIGINT, [ |
|
52 | + 'autoincrement' => true, |
|
53 | + 'notnull' => true, |
|
54 | + 'length' => 11, |
|
55 | + 'unsigned' => true, |
|
56 | + ]); |
|
57 | + $table->addColumn('backend_id', Type::STRING, [ |
|
58 | + 'notnull' => false, |
|
59 | + 'length' => 64, |
|
60 | + ]); |
|
61 | + $table->addColumn('resource_id', Type::STRING, [ |
|
62 | + 'notnull' => false, |
|
63 | + 'length' => 64, |
|
64 | + ]); |
|
65 | + $table->addColumn('email', Type::STRING, [ |
|
66 | + 'notnull' => false, |
|
67 | + 'length' => 255, |
|
68 | + ]); |
|
69 | + $table->addColumn('displayname', Type::STRING, [ |
|
70 | + 'notnull' => false, |
|
71 | + 'length' => 255, |
|
72 | + ]); |
|
73 | + $table->addColumn('group_restrictions', Type::STRING, [ |
|
74 | + 'notnull' => false, |
|
75 | + 'length' => 4000, |
|
76 | + ]); |
|
77 | 77 | |
78 | - $table->setPrimaryKey(['id'], 'calendar_' . $type . '_cache_id_idx'); |
|
79 | - $table->addIndex(['backend_id', 'resource_id'], 'calendar_' . $type . '_cache_backendresource_idx'); |
|
80 | - $table->addIndex(['email'], 'calendar_' . $type . '_cache_email_idx'); |
|
81 | - $table->addIndex(['displayname'], 'calendar_' . $type . '_cache_displayname_idx'); |
|
82 | - } |
|
83 | - } |
|
78 | + $table->setPrimaryKey(['id'], 'calendar_' . $type . '_cache_id_idx'); |
|
79 | + $table->addIndex(['backend_id', 'resource_id'], 'calendar_' . $type . '_cache_backendresource_idx'); |
|
80 | + $table->addIndex(['email'], 'calendar_' . $type . '_cache_email_idx'); |
|
81 | + $table->addIndex(['displayname'], 'calendar_' . $type . '_cache_displayname_idx'); |
|
82 | + } |
|
83 | + } |
|
84 | 84 | |
85 | - return $schema; |
|
86 | - } |
|
85 | + return $schema; |
|
86 | + } |
|
87 | 87 | } |
@@ -44,9 +44,9 @@ discard block |
||
44 | 44 | $schema = $schemaClosure(); |
45 | 45 | |
46 | 46 | $types = ['resources', 'rooms']; |
47 | - foreach($types as $type) { |
|
48 | - if (!$schema->hasTable('calendar_' . $type . '_cache')) { |
|
49 | - $table = $schema->createTable('calendar_' . $type . '_cache'); |
|
47 | + foreach ($types as $type) { |
|
48 | + if (!$schema->hasTable('calendar_'.$type.'_cache')) { |
|
49 | + $table = $schema->createTable('calendar_'.$type.'_cache'); |
|
50 | 50 | |
51 | 51 | $table->addColumn('id', Type::BIGINT, [ |
52 | 52 | 'autoincrement' => true, |
@@ -75,10 +75,10 @@ discard block |
||
75 | 75 | 'length' => 4000, |
76 | 76 | ]); |
77 | 77 | |
78 | - $table->setPrimaryKey(['id'], 'calendar_' . $type . '_cache_id_idx'); |
|
79 | - $table->addIndex(['backend_id', 'resource_id'], 'calendar_' . $type . '_cache_backendresource_idx'); |
|
80 | - $table->addIndex(['email'], 'calendar_' . $type . '_cache_email_idx'); |
|
81 | - $table->addIndex(['displayname'], 'calendar_' . $type . '_cache_displayname_idx'); |
|
78 | + $table->setPrimaryKey(['id'], 'calendar_'.$type.'_cache_id_idx'); |
|
79 | + $table->addIndex(['backend_id', 'resource_id'], 'calendar_'.$type.'_cache_backendresource_idx'); |
|
80 | + $table->addIndex(['email'], 'calendar_'.$type.'_cache_email_idx'); |
|
81 | + $table->addIndex(['displayname'], 'calendar_'.$type.'_cache_displayname_idx'); |
|
82 | 82 | } |
83 | 83 | } |
84 | 84 |
@@ -32,36 +32,36 @@ |
||
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 | - */ |
|
41 | - public function getAllResources():array; |
|
35 | + /** |
|
36 | + * get a list of all resources in this backend |
|
37 | + * |
|
38 | + * @throws BackendTemporarilyUnavailableException |
|
39 | + * @return IResource[] |
|
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 | - */ |
|
49 | - public function listAllResources():array; |
|
43 | + /** |
|
44 | + * get a list of all resource identifiers in this backend |
|
45 | + * |
|
46 | + * @throws BackendTemporarilyUnavailableException |
|
47 | + * @return string[] |
|
48 | + */ |
|
49 | + public function listAllResources():array; |
|
50 | 50 | |
51 | - /** |
|
52 | - * get a resource by it's id |
|
53 | - * |
|
54 | - * @param string $id |
|
55 | - * @throws BackendTemporarilyUnavailableException |
|
56 | - * @return IResource|null |
|
57 | - */ |
|
58 | - public function getResource($id); |
|
51 | + /** |
|
52 | + * get a resource by it's id |
|
53 | + * |
|
54 | + * @param string $id |
|
55 | + * @throws BackendTemporarilyUnavailableException |
|
56 | + * @return IResource|null |
|
57 | + */ |
|
58 | + public function getResource($id); |
|
59 | 59 | |
60 | - /** |
|
61 | - * Get unique identifier of the backend |
|
62 | - * |
|
63 | - * @return string |
|
64 | - * @since 14.0.0 |
|
65 | - */ |
|
66 | - public function getBackendIdentifier():string; |
|
60 | + /** |
|
61 | + * Get unique identifier of the backend |
|
62 | + * |
|
63 | + * @return string |
|
64 | + * @since 14.0.0 |
|
65 | + */ |
|
66 | + public function getBackendIdentifier():string; |
|
67 | 67 | } |
@@ -25,40 +25,40 @@ |
||
25 | 25 | |
26 | 26 | interface IManager { |
27 | 27 | |
28 | - /** |
|
29 | - * Registers a resource backend |
|
30 | - * |
|
31 | - * @param IBackend $backend |
|
32 | - * @return void |
|
33 | - * @since 14.0.0 |
|
34 | - */ |
|
35 | - public function registerBackend(IBackend $backend); |
|
28 | + /** |
|
29 | + * Registers a resource backend |
|
30 | + * |
|
31 | + * @param IBackend $backend |
|
32 | + * @return void |
|
33 | + * @since 14.0.0 |
|
34 | + */ |
|
35 | + public function registerBackend(IBackend $backend); |
|
36 | 36 | |
37 | - /** |
|
38 | - * Unregisters a resource backend |
|
39 | - * |
|
40 | - * @param IBackend $backend |
|
41 | - * @return void |
|
42 | - * @since 14.0.0 |
|
43 | - */ |
|
44 | - public function unregisterBackend(IBackend $backend); |
|
37 | + /** |
|
38 | + * Unregisters a resource backend |
|
39 | + * |
|
40 | + * @param IBackend $backend |
|
41 | + * @return void |
|
42 | + * @since 14.0.0 |
|
43 | + */ |
|
44 | + public function unregisterBackend(IBackend $backend); |
|
45 | 45 | |
46 | - /** |
|
47 | - * @return IBackend[] |
|
48 | - * @since 14.0.0 |
|
49 | - */ |
|
50 | - public function getBackends():array; |
|
46 | + /** |
|
47 | + * @return IBackend[] |
|
48 | + * @since 14.0.0 |
|
49 | + */ |
|
50 | + public function getBackends():array; |
|
51 | 51 | |
52 | - /** |
|
53 | - * @param string $backendId |
|
54 | - * @return IBackend |
|
55 | - */ |
|
56 | - public function getBackend($backendId):IBackend; |
|
52 | + /** |
|
53 | + * @param string $backendId |
|
54 | + * @return IBackend |
|
55 | + */ |
|
56 | + public function getBackend($backendId):IBackend; |
|
57 | 57 | |
58 | - /** |
|
59 | - * removes all registered backend instances |
|
60 | - * @return void |
|
61 | - * @since 14.0.0 |
|
62 | - */ |
|
63 | - public function clear(); |
|
58 | + /** |
|
59 | + * removes all registered backend instances |
|
60 | + * @return void |
|
61 | + * @since 14.0.0 |
|
62 | + */ |
|
63 | + public function clear(); |
|
64 | 64 | } |
@@ -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,36 +32,36 @@ |
||
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 | - */ |
|
41 | - public function getAllRooms():array; |
|
35 | + /** |
|
36 | + * get a list of all rooms in this backend |
|
37 | + * |
|
38 | + * @throws BackendTemporarilyUnavailableException |
|
39 | + * @return IRoom[] |
|
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 | - */ |
|
49 | - public function listAllRooms():array; |
|
43 | + /** |
|
44 | + * get a list of all room identifiers in this backend |
|
45 | + * |
|
46 | + * @throws BackendTemporarilyUnavailableException |
|
47 | + * @return string[] |
|
48 | + */ |
|
49 | + public function listAllRooms():array; |
|
50 | 50 | |
51 | - /** |
|
52 | - * get a room by it's id |
|
53 | - * |
|
54 | - * @param string $id |
|
55 | - * @throws BackendTemporarilyUnavailableException |
|
56 | - * @return IRoom|null |
|
57 | - */ |
|
58 | - public function getRoom($id); |
|
51 | + /** |
|
52 | + * get a room by it's id |
|
53 | + * |
|
54 | + * @param string $id |
|
55 | + * @throws BackendTemporarilyUnavailableException |
|
56 | + * @return IRoom|null |
|
57 | + */ |
|
58 | + public function getRoom($id); |
|
59 | 59 | |
60 | - /** |
|
61 | - * Get unique identifier of the backend |
|
62 | - * |
|
63 | - * @return string |
|
64 | - * @since 14.0.0 |
|
65 | - */ |
|
66 | - public function getBackendIdentifier():string; |
|
60 | + /** |
|
61 | + * Get unique identifier of the backend |
|
62 | + * |
|
63 | + * @return string |
|
64 | + * @since 14.0.0 |
|
65 | + */ |
|
66 | + public function getBackendIdentifier():string; |
|
67 | 67 | } |
@@ -31,50 +31,50 @@ |
||
31 | 31 | */ |
32 | 32 | interface IRoom { |
33 | 33 | |
34 | - /** |
|
35 | - * get the room 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 room 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 room |
|
46 | - * |
|
47 | - * @return string |
|
48 | - * @since 14.0.0 |
|
49 | - */ |
|
50 | - public function getDisplayName():string; |
|
44 | + /** |
|
45 | + * get the display name for a room |
|
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 room |
|
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 room |
|
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 room |
|
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 room |
|
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 | } |
@@ -25,40 +25,40 @@ |
||
25 | 25 | |
26 | 26 | interface IManager { |
27 | 27 | |
28 | - /** |
|
29 | - * Registers a room backend |
|
30 | - * |
|
31 | - * @param IBackend $backend |
|
32 | - * @return void |
|
33 | - * @since 14.0.0 |
|
34 | - */ |
|
35 | - public function registerBackend(IBackend $backend); |
|
28 | + /** |
|
29 | + * Registers a room backend |
|
30 | + * |
|
31 | + * @param IBackend $backend |
|
32 | + * @return void |
|
33 | + * @since 14.0.0 |
|
34 | + */ |
|
35 | + public function registerBackend(IBackend $backend); |
|
36 | 36 | |
37 | - /** |
|
38 | - * Unregisters a room backend |
|
39 | - * |
|
40 | - * @param IBackend $backend |
|
41 | - * @return void |
|
42 | - * @since 14.0.0 |
|
43 | - */ |
|
44 | - public function unregisterBackend(IBackend $backend); |
|
37 | + /** |
|
38 | + * Unregisters a room backend |
|
39 | + * |
|
40 | + * @param IBackend $backend |
|
41 | + * @return void |
|
42 | + * @since 14.0.0 |
|
43 | + */ |
|
44 | + public function unregisterBackend(IBackend $backend); |
|
45 | 45 | |
46 | - /** |
|
47 | - * @return IBackend[] |
|
48 | - * @since 14.0.0 |
|
49 | - */ |
|
50 | - public function getBackends():array; |
|
46 | + /** |
|
47 | + * @return IBackend[] |
|
48 | + * @since 14.0.0 |
|
49 | + */ |
|
50 | + public function getBackends():array; |
|
51 | 51 | |
52 | - /** |
|
53 | - * @param string $backendId |
|
54 | - * @return IBackend |
|
55 | - */ |
|
56 | - public function getBackend($backendId):IBackend; |
|
52 | + /** |
|
53 | + * @param string $backendId |
|
54 | + * @return IBackend |
|
55 | + */ |
|
56 | + public function getBackend($backendId):IBackend; |
|
57 | 57 | |
58 | - /** |
|
59 | - * removes all registered backend instances |
|
60 | - * @return void |
|
61 | - * @since 14.0.0 |
|
62 | - */ |
|
63 | - public function clear(); |
|
58 | + /** |
|
59 | + * removes all registered backend instances |
|
60 | + * @return void |
|
61 | + * @since 14.0.0 |
|
62 | + */ |
|
63 | + public function clear(); |
|
64 | 64 | } |
@@ -58,510 +58,510 @@ |
||
58 | 58 | */ |
59 | 59 | interface IServerContainer extends IContainer { |
60 | 60 | |
61 | - /** |
|
62 | - * The calendar manager will act as a broker between consumers for calendar information and |
|
63 | - * providers which actual deliver the calendar information. |
|
64 | - * |
|
65 | - * @return \OCP\Calendar\IManager |
|
66 | - * @since 13.0.0 |
|
67 | - */ |
|
68 | - public function getCalendarManager(); |
|
69 | - |
|
70 | - /** |
|
71 | - * The calendar resource backend manager will act as a broker between consumers |
|
72 | - * for calendar resource information an providers which actual deliver the room information. |
|
73 | - * |
|
74 | - * @return \OCP\Calendar\Resource\IBackend |
|
75 | - * @since 14.0.0 |
|
76 | - */ |
|
77 | - public function getCalendarResourceBackendManager(); |
|
78 | - |
|
79 | - /** |
|
80 | - * The calendar room backend manager will act as a broker between consumers |
|
81 | - * for calendar room information an providers which actual deliver the room information. |
|
82 | - * |
|
83 | - * @return \OCP\Calendar\Room\IBackend |
|
84 | - * @since 14.0.0 |
|
85 | - */ |
|
86 | - public function getCalendarRoomBackendManager(); |
|
87 | - |
|
88 | - /** |
|
89 | - * The contacts manager will act as a broker between consumers for contacts information and |
|
90 | - * providers which actual deliver the contact information. |
|
91 | - * |
|
92 | - * @return \OCP\Contacts\IManager |
|
93 | - * @since 6.0.0 |
|
94 | - */ |
|
95 | - public function getContactsManager(); |
|
96 | - |
|
97 | - /** |
|
98 | - * The current request object holding all information about the request currently being processed |
|
99 | - * is returned from this method. |
|
100 | - * In case the current execution was not initiated by a web request null is returned |
|
101 | - * |
|
102 | - * @return \OCP\IRequest |
|
103 | - * @since 6.0.0 |
|
104 | - */ |
|
105 | - public function getRequest(); |
|
106 | - |
|
107 | - /** |
|
108 | - * Returns the preview manager which can create preview images for a given file |
|
109 | - * |
|
110 | - * @return \OCP\IPreview |
|
111 | - * @since 6.0.0 |
|
112 | - */ |
|
113 | - public function getPreviewManager(); |
|
114 | - |
|
115 | - /** |
|
116 | - * Returns the tag manager which can get and set tags for different object types |
|
117 | - * |
|
118 | - * @see \OCP\ITagManager::load() |
|
119 | - * @return \OCP\ITagManager |
|
120 | - * @since 6.0.0 |
|
121 | - */ |
|
122 | - public function getTagManager(); |
|
123 | - |
|
124 | - /** |
|
125 | - * Returns the root folder of ownCloud's data directory |
|
126 | - * |
|
127 | - * @return \OCP\Files\IRootFolder |
|
128 | - * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder |
|
129 | - */ |
|
130 | - public function getRootFolder(); |
|
131 | - |
|
132 | - /** |
|
133 | - * Returns a view to ownCloud's files folder |
|
134 | - * |
|
135 | - * @param string $userId user ID |
|
136 | - * @return \OCP\Files\Folder |
|
137 | - * @since 6.0.0 - parameter $userId was added in 8.0.0 |
|
138 | - * @see getUserFolder in \OCP\Files\IRootFolder |
|
139 | - */ |
|
140 | - public function getUserFolder($userId = null); |
|
141 | - |
|
142 | - /** |
|
143 | - * Returns an app-specific view in ownClouds data directory |
|
144 | - * |
|
145 | - * @return \OCP\Files\Folder |
|
146 | - * @since 6.0.0 |
|
147 | - * @deprecated 9.2.0 use IAppData |
|
148 | - */ |
|
149 | - public function getAppFolder(); |
|
150 | - |
|
151 | - /** |
|
152 | - * Returns a user manager |
|
153 | - * |
|
154 | - * @return \OCP\IUserManager |
|
155 | - * @since 8.0.0 |
|
156 | - */ |
|
157 | - public function getUserManager(); |
|
158 | - |
|
159 | - /** |
|
160 | - * Returns a group manager |
|
161 | - * |
|
162 | - * @return \OCP\IGroupManager |
|
163 | - * @since 8.0.0 |
|
164 | - */ |
|
165 | - public function getGroupManager(); |
|
166 | - |
|
167 | - /** |
|
168 | - * Returns the user session |
|
169 | - * |
|
170 | - * @return \OCP\IUserSession |
|
171 | - * @since 6.0.0 |
|
172 | - */ |
|
173 | - public function getUserSession(); |
|
174 | - |
|
175 | - /** |
|
176 | - * Returns the navigation manager |
|
177 | - * |
|
178 | - * @return \OCP\INavigationManager |
|
179 | - * @since 6.0.0 |
|
180 | - */ |
|
181 | - public function getNavigationManager(); |
|
182 | - |
|
183 | - /** |
|
184 | - * Returns the config manager |
|
185 | - * |
|
186 | - * @return \OCP\IConfig |
|
187 | - * @since 6.0.0 |
|
188 | - */ |
|
189 | - public function getConfig(); |
|
190 | - |
|
191 | - /** |
|
192 | - * Returns a Crypto instance |
|
193 | - * |
|
194 | - * @return \OCP\Security\ICrypto |
|
195 | - * @since 8.0.0 |
|
196 | - */ |
|
197 | - public function getCrypto(); |
|
198 | - |
|
199 | - /** |
|
200 | - * Returns a Hasher instance |
|
201 | - * |
|
202 | - * @return \OCP\Security\IHasher |
|
203 | - * @since 8.0.0 |
|
204 | - */ |
|
205 | - public function getHasher(); |
|
206 | - |
|
207 | - /** |
|
208 | - * Returns a SecureRandom instance |
|
209 | - * |
|
210 | - * @return \OCP\Security\ISecureRandom |
|
211 | - * @since 8.1.0 |
|
212 | - */ |
|
213 | - public function getSecureRandom(); |
|
214 | - |
|
215 | - /** |
|
216 | - * Returns a CredentialsManager instance |
|
217 | - * |
|
218 | - * @return \OCP\Security\ICredentialsManager |
|
219 | - * @since 9.0.0 |
|
220 | - */ |
|
221 | - public function getCredentialsManager(); |
|
222 | - |
|
223 | - /** |
|
224 | - * Returns the app config manager |
|
225 | - * |
|
226 | - * @return \OCP\IAppConfig |
|
227 | - * @since 7.0.0 |
|
228 | - */ |
|
229 | - public function getAppConfig(); |
|
230 | - |
|
231 | - /** |
|
232 | - * @return \OCP\L10N\IFactory |
|
233 | - * @since 8.2.0 |
|
234 | - */ |
|
235 | - public function getL10NFactory(); |
|
236 | - |
|
237 | - /** |
|
238 | - * get an L10N instance |
|
239 | - * @param string $app appid |
|
240 | - * @param string $lang |
|
241 | - * @return \OCP\IL10N |
|
242 | - * @since 6.0.0 - parameter $lang was added in 8.0.0 |
|
243 | - */ |
|
244 | - public function getL10N($app, $lang = null); |
|
245 | - |
|
246 | - /** |
|
247 | - * @return \OC\Encryption\Manager |
|
248 | - * @since 8.1.0 |
|
249 | - */ |
|
250 | - public function getEncryptionManager(); |
|
251 | - |
|
252 | - /** |
|
253 | - * @return \OC\Encryption\File |
|
254 | - * @since 8.1.0 |
|
255 | - */ |
|
256 | - public function getEncryptionFilesHelper(); |
|
257 | - |
|
258 | - /** |
|
259 | - * @return \OCP\Encryption\Keys\IStorage |
|
260 | - * @since 8.1.0 |
|
261 | - */ |
|
262 | - public function getEncryptionKeyStorage(); |
|
263 | - |
|
264 | - /** |
|
265 | - * Returns the URL generator |
|
266 | - * |
|
267 | - * @return \OCP\IURLGenerator |
|
268 | - * @since 6.0.0 |
|
269 | - */ |
|
270 | - public function getURLGenerator(); |
|
271 | - |
|
272 | - /** |
|
273 | - * Returns an ICache instance |
|
274 | - * |
|
275 | - * @return \OCP\ICache |
|
276 | - * @since 6.0.0 |
|
277 | - */ |
|
278 | - public function getCache(); |
|
279 | - |
|
280 | - /** |
|
281 | - * Returns an \OCP\CacheFactory instance |
|
282 | - * |
|
283 | - * @return \OCP\ICacheFactory |
|
284 | - * @since 7.0.0 |
|
285 | - */ |
|
286 | - public function getMemCacheFactory(); |
|
287 | - |
|
288 | - /** |
|
289 | - * Returns the current session |
|
290 | - * |
|
291 | - * @return \OCP\ISession |
|
292 | - * @since 6.0.0 |
|
293 | - */ |
|
294 | - public function getSession(); |
|
295 | - |
|
296 | - /** |
|
297 | - * Returns the activity manager |
|
298 | - * |
|
299 | - * @return \OCP\Activity\IManager |
|
300 | - * @since 6.0.0 |
|
301 | - */ |
|
302 | - public function getActivityManager(); |
|
303 | - |
|
304 | - /** |
|
305 | - * Returns the current session |
|
306 | - * |
|
307 | - * @return \OCP\IDBConnection |
|
308 | - * @since 6.0.0 |
|
309 | - */ |
|
310 | - public function getDatabaseConnection(); |
|
311 | - |
|
312 | - /** |
|
313 | - * Returns an avatar manager, used for avatar functionality |
|
314 | - * |
|
315 | - * @return \OCP\IAvatarManager |
|
316 | - * @since 6.0.0 |
|
317 | - */ |
|
318 | - public function getAvatarManager(); |
|
319 | - |
|
320 | - /** |
|
321 | - * Returns an job list for controlling background jobs |
|
322 | - * |
|
323 | - * @return \OCP\BackgroundJob\IJobList |
|
324 | - * @since 7.0.0 |
|
325 | - */ |
|
326 | - public function getJobList(); |
|
327 | - |
|
328 | - /** |
|
329 | - * Returns a logger instance |
|
330 | - * |
|
331 | - * @return \OCP\ILogger |
|
332 | - * @since 8.0.0 |
|
333 | - */ |
|
334 | - public function getLogger(); |
|
335 | - |
|
336 | - /** |
|
337 | - * returns a log factory instance |
|
338 | - * |
|
339 | - * @return ILogFactory |
|
340 | - * @since 14.0.0 |
|
341 | - */ |
|
342 | - public function getLogFactory(); |
|
343 | - |
|
344 | - /** |
|
345 | - * Returns a router for generating and matching urls |
|
346 | - * |
|
347 | - * @return \OCP\Route\IRouter |
|
348 | - * @since 7.0.0 |
|
349 | - */ |
|
350 | - public function getRouter(); |
|
351 | - |
|
352 | - /** |
|
353 | - * Returns a search instance |
|
354 | - * |
|
355 | - * @return \OCP\ISearch |
|
356 | - * @since 7.0.0 |
|
357 | - */ |
|
358 | - public function getSearch(); |
|
359 | - |
|
360 | - /** |
|
361 | - * Get the certificate manager for the user |
|
362 | - * |
|
363 | - * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager |
|
364 | - * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in |
|
365 | - * @since 8.0.0 |
|
366 | - */ |
|
367 | - public function getCertificateManager($userId = null); |
|
368 | - |
|
369 | - /** |
|
370 | - * Create a new event source |
|
371 | - * |
|
372 | - * @return \OCP\IEventSource |
|
373 | - * @since 8.0.0 |
|
374 | - */ |
|
375 | - public function createEventSource(); |
|
376 | - |
|
377 | - /** |
|
378 | - * Returns an instance of the HTTP client service |
|
379 | - * |
|
380 | - * @return \OCP\Http\Client\IClientService |
|
381 | - * @since 8.1.0 |
|
382 | - */ |
|
383 | - public function getHTTPClientService(); |
|
384 | - |
|
385 | - /** |
|
386 | - * Get the active event logger |
|
387 | - * |
|
388 | - * @return \OCP\Diagnostics\IEventLogger |
|
389 | - * @since 8.0.0 |
|
390 | - */ |
|
391 | - public function getEventLogger(); |
|
392 | - |
|
393 | - /** |
|
394 | - * Get the active query logger |
|
395 | - * |
|
396 | - * The returned logger only logs data when debug mode is enabled |
|
397 | - * |
|
398 | - * @return \OCP\Diagnostics\IQueryLogger |
|
399 | - * @since 8.0.0 |
|
400 | - */ |
|
401 | - public function getQueryLogger(); |
|
402 | - |
|
403 | - /** |
|
404 | - * Get the manager for temporary files and folders |
|
405 | - * |
|
406 | - * @return \OCP\ITempManager |
|
407 | - * @since 8.0.0 |
|
408 | - */ |
|
409 | - public function getTempManager(); |
|
410 | - |
|
411 | - /** |
|
412 | - * Get the app manager |
|
413 | - * |
|
414 | - * @return \OCP\App\IAppManager |
|
415 | - * @since 8.0.0 |
|
416 | - */ |
|
417 | - public function getAppManager(); |
|
418 | - |
|
419 | - /** |
|
420 | - * Get the webroot |
|
421 | - * |
|
422 | - * @return string |
|
423 | - * @since 8.0.0 |
|
424 | - */ |
|
425 | - public function getWebRoot(); |
|
426 | - |
|
427 | - /** |
|
428 | - * @return \OCP\Files\Config\IMountProviderCollection |
|
429 | - * @since 8.0.0 |
|
430 | - */ |
|
431 | - public function getMountProviderCollection(); |
|
432 | - |
|
433 | - /** |
|
434 | - * Get the IniWrapper |
|
435 | - * |
|
436 | - * @return \bantu\IniGetWrapper\IniGetWrapper |
|
437 | - * @since 8.0.0 |
|
438 | - */ |
|
439 | - public function getIniWrapper(); |
|
440 | - /** |
|
441 | - * @return \OCP\Command\IBus |
|
442 | - * @since 8.1.0 |
|
443 | - */ |
|
444 | - public function getCommandBus(); |
|
445 | - |
|
446 | - /** |
|
447 | - * Creates a new mailer |
|
448 | - * |
|
449 | - * @return \OCP\Mail\IMailer |
|
450 | - * @since 8.1.0 |
|
451 | - */ |
|
452 | - public function getMailer(); |
|
453 | - |
|
454 | - /** |
|
455 | - * Get the locking provider |
|
456 | - * |
|
457 | - * @return \OCP\Lock\ILockingProvider |
|
458 | - * @since 8.1.0 |
|
459 | - */ |
|
460 | - public function getLockingProvider(); |
|
461 | - |
|
462 | - /** |
|
463 | - * @return \OCP\Files\Mount\IMountManager |
|
464 | - * @since 8.2.0 |
|
465 | - */ |
|
466 | - public function getMountManager(); |
|
467 | - |
|
468 | - /** |
|
469 | - * Get the MimeTypeDetector |
|
470 | - * |
|
471 | - * @return \OCP\Files\IMimeTypeDetector |
|
472 | - * @since 8.2.0 |
|
473 | - */ |
|
474 | - public function getMimeTypeDetector(); |
|
475 | - |
|
476 | - /** |
|
477 | - * Get the MimeTypeLoader |
|
478 | - * |
|
479 | - * @return \OCP\Files\IMimeTypeLoader |
|
480 | - * @since 8.2.0 |
|
481 | - */ |
|
482 | - public function getMimeTypeLoader(); |
|
483 | - |
|
484 | - /** |
|
485 | - * Get the EventDispatcher |
|
486 | - * |
|
487 | - * @return EventDispatcherInterface |
|
488 | - * @since 8.2.0 |
|
489 | - */ |
|
490 | - public function getEventDispatcher(); |
|
491 | - |
|
492 | - /** |
|
493 | - * Get the Notification Manager |
|
494 | - * |
|
495 | - * @return \OCP\Notification\IManager |
|
496 | - * @since 9.0.0 |
|
497 | - */ |
|
498 | - public function getNotificationManager(); |
|
499 | - |
|
500 | - /** |
|
501 | - * @return \OCP\Comments\ICommentsManager |
|
502 | - * @since 9.0.0 |
|
503 | - */ |
|
504 | - public function getCommentsManager(); |
|
505 | - |
|
506 | - /** |
|
507 | - * Returns the system-tag manager |
|
508 | - * |
|
509 | - * @return \OCP\SystemTag\ISystemTagManager |
|
510 | - * |
|
511 | - * @since 9.0.0 |
|
512 | - */ |
|
513 | - public function getSystemTagManager(); |
|
514 | - |
|
515 | - /** |
|
516 | - * Returns the system-tag object mapper |
|
517 | - * |
|
518 | - * @return \OCP\SystemTag\ISystemTagObjectMapper |
|
519 | - * |
|
520 | - * @since 9.0.0 |
|
521 | - */ |
|
522 | - public function getSystemTagObjectMapper(); |
|
523 | - |
|
524 | - /** |
|
525 | - * Returns the share manager |
|
526 | - * |
|
527 | - * @return \OCP\Share\IManager |
|
528 | - * @since 9.0.0 |
|
529 | - */ |
|
530 | - public function getShareManager(); |
|
531 | - |
|
532 | - /** |
|
533 | - * @return IContentSecurityPolicyManager |
|
534 | - * @since 9.0.0 |
|
535 | - */ |
|
536 | - public function getContentSecurityPolicyManager(); |
|
537 | - |
|
538 | - /** |
|
539 | - * @return \OCP\IDateTimeZone |
|
540 | - * @since 8.0.0 |
|
541 | - */ |
|
542 | - public function getDateTimeZone(); |
|
543 | - |
|
544 | - /** |
|
545 | - * @return \OCP\IDateTimeFormatter |
|
546 | - * @since 8.0.0 |
|
547 | - */ |
|
548 | - public function getDateTimeFormatter(); |
|
549 | - |
|
550 | - /** |
|
551 | - * @return \OCP\Federation\ICloudIdManager |
|
552 | - * @since 12.0.0 |
|
553 | - */ |
|
554 | - public function getCloudIdManager(); |
|
555 | - |
|
556 | - /** |
|
557 | - * @return \OCP\Remote\Api\IApiFactory |
|
558 | - * @since 13.0.0 |
|
559 | - */ |
|
560 | - public function getRemoteApiFactory(); |
|
561 | - |
|
562 | - /** |
|
563 | - * @return \OCP\Remote\IInstanceFactory |
|
564 | - * @since 13.0.0 |
|
565 | - */ |
|
566 | - public function getRemoteInstanceFactory(); |
|
61 | + /** |
|
62 | + * The calendar manager will act as a broker between consumers for calendar information and |
|
63 | + * providers which actual deliver the calendar information. |
|
64 | + * |
|
65 | + * @return \OCP\Calendar\IManager |
|
66 | + * @since 13.0.0 |
|
67 | + */ |
|
68 | + public function getCalendarManager(); |
|
69 | + |
|
70 | + /** |
|
71 | + * The calendar resource backend manager will act as a broker between consumers |
|
72 | + * for calendar resource information an providers which actual deliver the room information. |
|
73 | + * |
|
74 | + * @return \OCP\Calendar\Resource\IBackend |
|
75 | + * @since 14.0.0 |
|
76 | + */ |
|
77 | + public function getCalendarResourceBackendManager(); |
|
78 | + |
|
79 | + /** |
|
80 | + * The calendar room backend manager will act as a broker between consumers |
|
81 | + * for calendar room information an providers which actual deliver the room information. |
|
82 | + * |
|
83 | + * @return \OCP\Calendar\Room\IBackend |
|
84 | + * @since 14.0.0 |
|
85 | + */ |
|
86 | + public function getCalendarRoomBackendManager(); |
|
87 | + |
|
88 | + /** |
|
89 | + * The contacts manager will act as a broker between consumers for contacts information and |
|
90 | + * providers which actual deliver the contact information. |
|
91 | + * |
|
92 | + * @return \OCP\Contacts\IManager |
|
93 | + * @since 6.0.0 |
|
94 | + */ |
|
95 | + public function getContactsManager(); |
|
96 | + |
|
97 | + /** |
|
98 | + * The current request object holding all information about the request currently being processed |
|
99 | + * is returned from this method. |
|
100 | + * In case the current execution was not initiated by a web request null is returned |
|
101 | + * |
|
102 | + * @return \OCP\IRequest |
|
103 | + * @since 6.0.0 |
|
104 | + */ |
|
105 | + public function getRequest(); |
|
106 | + |
|
107 | + /** |
|
108 | + * Returns the preview manager which can create preview images for a given file |
|
109 | + * |
|
110 | + * @return \OCP\IPreview |
|
111 | + * @since 6.0.0 |
|
112 | + */ |
|
113 | + public function getPreviewManager(); |
|
114 | + |
|
115 | + /** |
|
116 | + * Returns the tag manager which can get and set tags for different object types |
|
117 | + * |
|
118 | + * @see \OCP\ITagManager::load() |
|
119 | + * @return \OCP\ITagManager |
|
120 | + * @since 6.0.0 |
|
121 | + */ |
|
122 | + public function getTagManager(); |
|
123 | + |
|
124 | + /** |
|
125 | + * Returns the root folder of ownCloud's data directory |
|
126 | + * |
|
127 | + * @return \OCP\Files\IRootFolder |
|
128 | + * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder |
|
129 | + */ |
|
130 | + public function getRootFolder(); |
|
131 | + |
|
132 | + /** |
|
133 | + * Returns a view to ownCloud's files folder |
|
134 | + * |
|
135 | + * @param string $userId user ID |
|
136 | + * @return \OCP\Files\Folder |
|
137 | + * @since 6.0.0 - parameter $userId was added in 8.0.0 |
|
138 | + * @see getUserFolder in \OCP\Files\IRootFolder |
|
139 | + */ |
|
140 | + public function getUserFolder($userId = null); |
|
141 | + |
|
142 | + /** |
|
143 | + * Returns an app-specific view in ownClouds data directory |
|
144 | + * |
|
145 | + * @return \OCP\Files\Folder |
|
146 | + * @since 6.0.0 |
|
147 | + * @deprecated 9.2.0 use IAppData |
|
148 | + */ |
|
149 | + public function getAppFolder(); |
|
150 | + |
|
151 | + /** |
|
152 | + * Returns a user manager |
|
153 | + * |
|
154 | + * @return \OCP\IUserManager |
|
155 | + * @since 8.0.0 |
|
156 | + */ |
|
157 | + public function getUserManager(); |
|
158 | + |
|
159 | + /** |
|
160 | + * Returns a group manager |
|
161 | + * |
|
162 | + * @return \OCP\IGroupManager |
|
163 | + * @since 8.0.0 |
|
164 | + */ |
|
165 | + public function getGroupManager(); |
|
166 | + |
|
167 | + /** |
|
168 | + * Returns the user session |
|
169 | + * |
|
170 | + * @return \OCP\IUserSession |
|
171 | + * @since 6.0.0 |
|
172 | + */ |
|
173 | + public function getUserSession(); |
|
174 | + |
|
175 | + /** |
|
176 | + * Returns the navigation manager |
|
177 | + * |
|
178 | + * @return \OCP\INavigationManager |
|
179 | + * @since 6.0.0 |
|
180 | + */ |
|
181 | + public function getNavigationManager(); |
|
182 | + |
|
183 | + /** |
|
184 | + * Returns the config manager |
|
185 | + * |
|
186 | + * @return \OCP\IConfig |
|
187 | + * @since 6.0.0 |
|
188 | + */ |
|
189 | + public function getConfig(); |
|
190 | + |
|
191 | + /** |
|
192 | + * Returns a Crypto instance |
|
193 | + * |
|
194 | + * @return \OCP\Security\ICrypto |
|
195 | + * @since 8.0.0 |
|
196 | + */ |
|
197 | + public function getCrypto(); |
|
198 | + |
|
199 | + /** |
|
200 | + * Returns a Hasher instance |
|
201 | + * |
|
202 | + * @return \OCP\Security\IHasher |
|
203 | + * @since 8.0.0 |
|
204 | + */ |
|
205 | + public function getHasher(); |
|
206 | + |
|
207 | + /** |
|
208 | + * Returns a SecureRandom instance |
|
209 | + * |
|
210 | + * @return \OCP\Security\ISecureRandom |
|
211 | + * @since 8.1.0 |
|
212 | + */ |
|
213 | + public function getSecureRandom(); |
|
214 | + |
|
215 | + /** |
|
216 | + * Returns a CredentialsManager instance |
|
217 | + * |
|
218 | + * @return \OCP\Security\ICredentialsManager |
|
219 | + * @since 9.0.0 |
|
220 | + */ |
|
221 | + public function getCredentialsManager(); |
|
222 | + |
|
223 | + /** |
|
224 | + * Returns the app config manager |
|
225 | + * |
|
226 | + * @return \OCP\IAppConfig |
|
227 | + * @since 7.0.0 |
|
228 | + */ |
|
229 | + public function getAppConfig(); |
|
230 | + |
|
231 | + /** |
|
232 | + * @return \OCP\L10N\IFactory |
|
233 | + * @since 8.2.0 |
|
234 | + */ |
|
235 | + public function getL10NFactory(); |
|
236 | + |
|
237 | + /** |
|
238 | + * get an L10N instance |
|
239 | + * @param string $app appid |
|
240 | + * @param string $lang |
|
241 | + * @return \OCP\IL10N |
|
242 | + * @since 6.0.0 - parameter $lang was added in 8.0.0 |
|
243 | + */ |
|
244 | + public function getL10N($app, $lang = null); |
|
245 | + |
|
246 | + /** |
|
247 | + * @return \OC\Encryption\Manager |
|
248 | + * @since 8.1.0 |
|
249 | + */ |
|
250 | + public function getEncryptionManager(); |
|
251 | + |
|
252 | + /** |
|
253 | + * @return \OC\Encryption\File |
|
254 | + * @since 8.1.0 |
|
255 | + */ |
|
256 | + public function getEncryptionFilesHelper(); |
|
257 | + |
|
258 | + /** |
|
259 | + * @return \OCP\Encryption\Keys\IStorage |
|
260 | + * @since 8.1.0 |
|
261 | + */ |
|
262 | + public function getEncryptionKeyStorage(); |
|
263 | + |
|
264 | + /** |
|
265 | + * Returns the URL generator |
|
266 | + * |
|
267 | + * @return \OCP\IURLGenerator |
|
268 | + * @since 6.0.0 |
|
269 | + */ |
|
270 | + public function getURLGenerator(); |
|
271 | + |
|
272 | + /** |
|
273 | + * Returns an ICache instance |
|
274 | + * |
|
275 | + * @return \OCP\ICache |
|
276 | + * @since 6.0.0 |
|
277 | + */ |
|
278 | + public function getCache(); |
|
279 | + |
|
280 | + /** |
|
281 | + * Returns an \OCP\CacheFactory instance |
|
282 | + * |
|
283 | + * @return \OCP\ICacheFactory |
|
284 | + * @since 7.0.0 |
|
285 | + */ |
|
286 | + public function getMemCacheFactory(); |
|
287 | + |
|
288 | + /** |
|
289 | + * Returns the current session |
|
290 | + * |
|
291 | + * @return \OCP\ISession |
|
292 | + * @since 6.0.0 |
|
293 | + */ |
|
294 | + public function getSession(); |
|
295 | + |
|
296 | + /** |
|
297 | + * Returns the activity manager |
|
298 | + * |
|
299 | + * @return \OCP\Activity\IManager |
|
300 | + * @since 6.0.0 |
|
301 | + */ |
|
302 | + public function getActivityManager(); |
|
303 | + |
|
304 | + /** |
|
305 | + * Returns the current session |
|
306 | + * |
|
307 | + * @return \OCP\IDBConnection |
|
308 | + * @since 6.0.0 |
|
309 | + */ |
|
310 | + public function getDatabaseConnection(); |
|
311 | + |
|
312 | + /** |
|
313 | + * Returns an avatar manager, used for avatar functionality |
|
314 | + * |
|
315 | + * @return \OCP\IAvatarManager |
|
316 | + * @since 6.0.0 |
|
317 | + */ |
|
318 | + public function getAvatarManager(); |
|
319 | + |
|
320 | + /** |
|
321 | + * Returns an job list for controlling background jobs |
|
322 | + * |
|
323 | + * @return \OCP\BackgroundJob\IJobList |
|
324 | + * @since 7.0.0 |
|
325 | + */ |
|
326 | + public function getJobList(); |
|
327 | + |
|
328 | + /** |
|
329 | + * Returns a logger instance |
|
330 | + * |
|
331 | + * @return \OCP\ILogger |
|
332 | + * @since 8.0.0 |
|
333 | + */ |
|
334 | + public function getLogger(); |
|
335 | + |
|
336 | + /** |
|
337 | + * returns a log factory instance |
|
338 | + * |
|
339 | + * @return ILogFactory |
|
340 | + * @since 14.0.0 |
|
341 | + */ |
|
342 | + public function getLogFactory(); |
|
343 | + |
|
344 | + /** |
|
345 | + * Returns a router for generating and matching urls |
|
346 | + * |
|
347 | + * @return \OCP\Route\IRouter |
|
348 | + * @since 7.0.0 |
|
349 | + */ |
|
350 | + public function getRouter(); |
|
351 | + |
|
352 | + /** |
|
353 | + * Returns a search instance |
|
354 | + * |
|
355 | + * @return \OCP\ISearch |
|
356 | + * @since 7.0.0 |
|
357 | + */ |
|
358 | + public function getSearch(); |
|
359 | + |
|
360 | + /** |
|
361 | + * Get the certificate manager for the user |
|
362 | + * |
|
363 | + * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager |
|
364 | + * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in |
|
365 | + * @since 8.0.0 |
|
366 | + */ |
|
367 | + public function getCertificateManager($userId = null); |
|
368 | + |
|
369 | + /** |
|
370 | + * Create a new event source |
|
371 | + * |
|
372 | + * @return \OCP\IEventSource |
|
373 | + * @since 8.0.0 |
|
374 | + */ |
|
375 | + public function createEventSource(); |
|
376 | + |
|
377 | + /** |
|
378 | + * Returns an instance of the HTTP client service |
|
379 | + * |
|
380 | + * @return \OCP\Http\Client\IClientService |
|
381 | + * @since 8.1.0 |
|
382 | + */ |
|
383 | + public function getHTTPClientService(); |
|
384 | + |
|
385 | + /** |
|
386 | + * Get the active event logger |
|
387 | + * |
|
388 | + * @return \OCP\Diagnostics\IEventLogger |
|
389 | + * @since 8.0.0 |
|
390 | + */ |
|
391 | + public function getEventLogger(); |
|
392 | + |
|
393 | + /** |
|
394 | + * Get the active query logger |
|
395 | + * |
|
396 | + * The returned logger only logs data when debug mode is enabled |
|
397 | + * |
|
398 | + * @return \OCP\Diagnostics\IQueryLogger |
|
399 | + * @since 8.0.0 |
|
400 | + */ |
|
401 | + public function getQueryLogger(); |
|
402 | + |
|
403 | + /** |
|
404 | + * Get the manager for temporary files and folders |
|
405 | + * |
|
406 | + * @return \OCP\ITempManager |
|
407 | + * @since 8.0.0 |
|
408 | + */ |
|
409 | + public function getTempManager(); |
|
410 | + |
|
411 | + /** |
|
412 | + * Get the app manager |
|
413 | + * |
|
414 | + * @return \OCP\App\IAppManager |
|
415 | + * @since 8.0.0 |
|
416 | + */ |
|
417 | + public function getAppManager(); |
|
418 | + |
|
419 | + /** |
|
420 | + * Get the webroot |
|
421 | + * |
|
422 | + * @return string |
|
423 | + * @since 8.0.0 |
|
424 | + */ |
|
425 | + public function getWebRoot(); |
|
426 | + |
|
427 | + /** |
|
428 | + * @return \OCP\Files\Config\IMountProviderCollection |
|
429 | + * @since 8.0.0 |
|
430 | + */ |
|
431 | + public function getMountProviderCollection(); |
|
432 | + |
|
433 | + /** |
|
434 | + * Get the IniWrapper |
|
435 | + * |
|
436 | + * @return \bantu\IniGetWrapper\IniGetWrapper |
|
437 | + * @since 8.0.0 |
|
438 | + */ |
|
439 | + public function getIniWrapper(); |
|
440 | + /** |
|
441 | + * @return \OCP\Command\IBus |
|
442 | + * @since 8.1.0 |
|
443 | + */ |
|
444 | + public function getCommandBus(); |
|
445 | + |
|
446 | + /** |
|
447 | + * Creates a new mailer |
|
448 | + * |
|
449 | + * @return \OCP\Mail\IMailer |
|
450 | + * @since 8.1.0 |
|
451 | + */ |
|
452 | + public function getMailer(); |
|
453 | + |
|
454 | + /** |
|
455 | + * Get the locking provider |
|
456 | + * |
|
457 | + * @return \OCP\Lock\ILockingProvider |
|
458 | + * @since 8.1.0 |
|
459 | + */ |
|
460 | + public function getLockingProvider(); |
|
461 | + |
|
462 | + /** |
|
463 | + * @return \OCP\Files\Mount\IMountManager |
|
464 | + * @since 8.2.0 |
|
465 | + */ |
|
466 | + public function getMountManager(); |
|
467 | + |
|
468 | + /** |
|
469 | + * Get the MimeTypeDetector |
|
470 | + * |
|
471 | + * @return \OCP\Files\IMimeTypeDetector |
|
472 | + * @since 8.2.0 |
|
473 | + */ |
|
474 | + public function getMimeTypeDetector(); |
|
475 | + |
|
476 | + /** |
|
477 | + * Get the MimeTypeLoader |
|
478 | + * |
|
479 | + * @return \OCP\Files\IMimeTypeLoader |
|
480 | + * @since 8.2.0 |
|
481 | + */ |
|
482 | + public function getMimeTypeLoader(); |
|
483 | + |
|
484 | + /** |
|
485 | + * Get the EventDispatcher |
|
486 | + * |
|
487 | + * @return EventDispatcherInterface |
|
488 | + * @since 8.2.0 |
|
489 | + */ |
|
490 | + public function getEventDispatcher(); |
|
491 | + |
|
492 | + /** |
|
493 | + * Get the Notification Manager |
|
494 | + * |
|
495 | + * @return \OCP\Notification\IManager |
|
496 | + * @since 9.0.0 |
|
497 | + */ |
|
498 | + public function getNotificationManager(); |
|
499 | + |
|
500 | + /** |
|
501 | + * @return \OCP\Comments\ICommentsManager |
|
502 | + * @since 9.0.0 |
|
503 | + */ |
|
504 | + public function getCommentsManager(); |
|
505 | + |
|
506 | + /** |
|
507 | + * Returns the system-tag manager |
|
508 | + * |
|
509 | + * @return \OCP\SystemTag\ISystemTagManager |
|
510 | + * |
|
511 | + * @since 9.0.0 |
|
512 | + */ |
|
513 | + public function getSystemTagManager(); |
|
514 | + |
|
515 | + /** |
|
516 | + * Returns the system-tag object mapper |
|
517 | + * |
|
518 | + * @return \OCP\SystemTag\ISystemTagObjectMapper |
|
519 | + * |
|
520 | + * @since 9.0.0 |
|
521 | + */ |
|
522 | + public function getSystemTagObjectMapper(); |
|
523 | + |
|
524 | + /** |
|
525 | + * Returns the share manager |
|
526 | + * |
|
527 | + * @return \OCP\Share\IManager |
|
528 | + * @since 9.0.0 |
|
529 | + */ |
|
530 | + public function getShareManager(); |
|
531 | + |
|
532 | + /** |
|
533 | + * @return IContentSecurityPolicyManager |
|
534 | + * @since 9.0.0 |
|
535 | + */ |
|
536 | + public function getContentSecurityPolicyManager(); |
|
537 | + |
|
538 | + /** |
|
539 | + * @return \OCP\IDateTimeZone |
|
540 | + * @since 8.0.0 |
|
541 | + */ |
|
542 | + public function getDateTimeZone(); |
|
543 | + |
|
544 | + /** |
|
545 | + * @return \OCP\IDateTimeFormatter |
|
546 | + * @since 8.0.0 |
|
547 | + */ |
|
548 | + public function getDateTimeFormatter(); |
|
549 | + |
|
550 | + /** |
|
551 | + * @return \OCP\Federation\ICloudIdManager |
|
552 | + * @since 12.0.0 |
|
553 | + */ |
|
554 | + public function getCloudIdManager(); |
|
555 | + |
|
556 | + /** |
|
557 | + * @return \OCP\Remote\Api\IApiFactory |
|
558 | + * @since 13.0.0 |
|
559 | + */ |
|
560 | + public function getRemoteApiFactory(); |
|
561 | + |
|
562 | + /** |
|
563 | + * @return \OCP\Remote\IInstanceFactory |
|
564 | + * @since 13.0.0 |
|
565 | + */ |
|
566 | + public function getRemoteInstanceFactory(); |
|
567 | 567 | } |