@@ -35,18 +35,18 @@ |
||
35 | 35 | */ |
36 | 36 | class GenericEncryptionException extends HintException { |
37 | 37 | |
38 | - /** |
|
39 | - * @param string $message |
|
40 | - * @param string $hint |
|
41 | - * @param int $code |
|
42 | - * @param \Exception $previous |
|
43 | - * @since 8.1.0 |
|
44 | - */ |
|
45 | - public function __construct($message = '', $hint = '', $code = 0, \Exception $previous = null) { |
|
46 | - if (empty($message)) { |
|
47 | - $message = 'Unspecified encryption exception'; |
|
48 | - } |
|
49 | - parent::__construct($message, $hint, $code, $previous); |
|
50 | - } |
|
38 | + /** |
|
39 | + * @param string $message |
|
40 | + * @param string $hint |
|
41 | + * @param int $code |
|
42 | + * @param \Exception $previous |
|
43 | + * @since 8.1.0 |
|
44 | + */ |
|
45 | + public function __construct($message = '', $hint = '', $code = 0, \Exception $previous = null) { |
|
46 | + if (empty($message)) { |
|
47 | + $message = 'Unspecified encryption exception'; |
|
48 | + } |
|
49 | + parent::__construct($message, $hint, $code, $previous); |
|
50 | + } |
|
51 | 51 | |
52 | 52 | } |
@@ -34,67 +34,67 @@ |
||
34 | 34 | */ |
35 | 35 | interface IManager { |
36 | 36 | |
37 | - /** |
|
38 | - * Check if encryption is available (at least one encryption module needs to be enabled) |
|
39 | - * |
|
40 | - * @return bool true if enabled, false if not |
|
41 | - * @since 8.1.0 |
|
42 | - */ |
|
43 | - public function isEnabled(); |
|
37 | + /** |
|
38 | + * Check if encryption is available (at least one encryption module needs to be enabled) |
|
39 | + * |
|
40 | + * @return bool true if enabled, false if not |
|
41 | + * @since 8.1.0 |
|
42 | + */ |
|
43 | + public function isEnabled(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * Registers an callback function which must return an encryption module instance |
|
47 | - * |
|
48 | - * @param string $id |
|
49 | - * @param string $displayName |
|
50 | - * @param callable $callback |
|
51 | - * @throws ModuleAlreadyExistsException |
|
52 | - * @since 8.1.0 |
|
53 | - */ |
|
54 | - public function registerEncryptionModule($id, $displayName, callable $callback); |
|
45 | + /** |
|
46 | + * Registers an callback function which must return an encryption module instance |
|
47 | + * |
|
48 | + * @param string $id |
|
49 | + * @param string $displayName |
|
50 | + * @param callable $callback |
|
51 | + * @throws ModuleAlreadyExistsException |
|
52 | + * @since 8.1.0 |
|
53 | + */ |
|
54 | + public function registerEncryptionModule($id, $displayName, callable $callback); |
|
55 | 55 | |
56 | - /** |
|
57 | - * Unregisters an encryption module |
|
58 | - * |
|
59 | - * @param string $moduleId |
|
60 | - * @since 8.1.0 |
|
61 | - */ |
|
62 | - public function unregisterEncryptionModule($moduleId); |
|
56 | + /** |
|
57 | + * Unregisters an encryption module |
|
58 | + * |
|
59 | + * @param string $moduleId |
|
60 | + * @since 8.1.0 |
|
61 | + */ |
|
62 | + public function unregisterEncryptionModule($moduleId); |
|
63 | 63 | |
64 | - /** |
|
65 | - * get a list of all encryption modules |
|
66 | - * |
|
67 | - * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
68 | - * @since 8.1.0 |
|
69 | - */ |
|
70 | - public function getEncryptionModules(); |
|
64 | + /** |
|
65 | + * get a list of all encryption modules |
|
66 | + * |
|
67 | + * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
68 | + * @since 8.1.0 |
|
69 | + */ |
|
70 | + public function getEncryptionModules(); |
|
71 | 71 | |
72 | 72 | |
73 | - /** |
|
74 | - * get a specific encryption module |
|
75 | - * |
|
76 | - * @param string $moduleId Empty to get the default module |
|
77 | - * @return IEncryptionModule |
|
78 | - * @throws ModuleDoesNotExistsException |
|
79 | - * @since 8.1.0 |
|
80 | - */ |
|
81 | - public function getEncryptionModule($moduleId = ''); |
|
73 | + /** |
|
74 | + * get a specific encryption module |
|
75 | + * |
|
76 | + * @param string $moduleId Empty to get the default module |
|
77 | + * @return IEncryptionModule |
|
78 | + * @throws ModuleDoesNotExistsException |
|
79 | + * @since 8.1.0 |
|
80 | + */ |
|
81 | + public function getEncryptionModule($moduleId = ''); |
|
82 | 82 | |
83 | - /** |
|
84 | - * get default encryption module Id |
|
85 | - * |
|
86 | - * @return string |
|
87 | - * @since 8.1.0 |
|
88 | - */ |
|
89 | - public function getDefaultEncryptionModuleId(); |
|
83 | + /** |
|
84 | + * get default encryption module Id |
|
85 | + * |
|
86 | + * @return string |
|
87 | + * @since 8.1.0 |
|
88 | + */ |
|
89 | + public function getDefaultEncryptionModuleId(); |
|
90 | 90 | |
91 | - /** |
|
92 | - * set default encryption module Id |
|
93 | - * |
|
94 | - * @param string $moduleId |
|
95 | - * @return string |
|
96 | - * @since 8.1.0 |
|
97 | - */ |
|
98 | - public function setDefaultEncryptionModule($moduleId); |
|
91 | + /** |
|
92 | + * set default encryption module Id |
|
93 | + * |
|
94 | + * @param string $moduleId |
|
95 | + * @return string |
|
96 | + * @since 8.1.0 |
|
97 | + */ |
|
98 | + public function setDefaultEncryptionModule($moduleId); |
|
99 | 99 | |
100 | 100 | } |
@@ -45,96 +45,96 @@ |
||
45 | 45 | * @since 8.0.0 |
46 | 46 | */ |
47 | 47 | interface IGroupManager { |
48 | - /** |
|
49 | - * Checks whether a given backend is used |
|
50 | - * |
|
51 | - * @param string $backendClass Full classname including complete namespace |
|
52 | - * @return bool |
|
53 | - * @since 8.1.0 |
|
54 | - */ |
|
55 | - public function isBackendUsed($backendClass); |
|
48 | + /** |
|
49 | + * Checks whether a given backend is used |
|
50 | + * |
|
51 | + * @param string $backendClass Full classname including complete namespace |
|
52 | + * @return bool |
|
53 | + * @since 8.1.0 |
|
54 | + */ |
|
55 | + public function isBackendUsed($backendClass); |
|
56 | 56 | |
57 | - /** |
|
58 | - * @param \OCP\GroupInterface $backend |
|
59 | - * @since 8.0.0 |
|
60 | - */ |
|
61 | - public function addBackend($backend); |
|
57 | + /** |
|
58 | + * @param \OCP\GroupInterface $backend |
|
59 | + * @since 8.0.0 |
|
60 | + */ |
|
61 | + public function addBackend($backend); |
|
62 | 62 | |
63 | - /** |
|
64 | - * @since 8.0.0 |
|
65 | - */ |
|
66 | - public function clearBackends(); |
|
63 | + /** |
|
64 | + * @since 8.0.0 |
|
65 | + */ |
|
66 | + public function clearBackends(); |
|
67 | 67 | |
68 | - /** |
|
69 | - * @param string $gid |
|
70 | - * @return \OCP\IGroup |
|
71 | - * @since 8.0.0 |
|
72 | - */ |
|
73 | - public function get($gid); |
|
68 | + /** |
|
69 | + * @param string $gid |
|
70 | + * @return \OCP\IGroup |
|
71 | + * @since 8.0.0 |
|
72 | + */ |
|
73 | + public function get($gid); |
|
74 | 74 | |
75 | - /** |
|
76 | - * @param string $gid |
|
77 | - * @return bool |
|
78 | - * @since 8.0.0 |
|
79 | - */ |
|
80 | - public function groupExists($gid); |
|
75 | + /** |
|
76 | + * @param string $gid |
|
77 | + * @return bool |
|
78 | + * @since 8.0.0 |
|
79 | + */ |
|
80 | + public function groupExists($gid); |
|
81 | 81 | |
82 | - /** |
|
83 | - * @param string $gid |
|
84 | - * @return \OCP\IGroup |
|
85 | - * @since 8.0.0 |
|
86 | - */ |
|
87 | - public function createGroup($gid); |
|
82 | + /** |
|
83 | + * @param string $gid |
|
84 | + * @return \OCP\IGroup |
|
85 | + * @since 8.0.0 |
|
86 | + */ |
|
87 | + public function createGroup($gid); |
|
88 | 88 | |
89 | - /** |
|
90 | - * @param string $search |
|
91 | - * @param int $limit |
|
92 | - * @param int $offset |
|
93 | - * @return \OCP\IGroup[] |
|
94 | - * @since 8.0.0 |
|
95 | - */ |
|
96 | - public function search($search, $limit = null, $offset = null); |
|
89 | + /** |
|
90 | + * @param string $search |
|
91 | + * @param int $limit |
|
92 | + * @param int $offset |
|
93 | + * @return \OCP\IGroup[] |
|
94 | + * @since 8.0.0 |
|
95 | + */ |
|
96 | + public function search($search, $limit = null, $offset = null); |
|
97 | 97 | |
98 | - /** |
|
99 | - * @param \OCP\IUser|null $user |
|
100 | - * @return \OCP\IGroup[] |
|
101 | - * @since 8.0.0 |
|
102 | - */ |
|
103 | - public function getUserGroups($user); |
|
98 | + /** |
|
99 | + * @param \OCP\IUser|null $user |
|
100 | + * @return \OCP\IGroup[] |
|
101 | + * @since 8.0.0 |
|
102 | + */ |
|
103 | + public function getUserGroups($user); |
|
104 | 104 | |
105 | - /** |
|
106 | - * @param \OCP\IUser $user |
|
107 | - * @return array with group names |
|
108 | - * @since 8.0.0 |
|
109 | - */ |
|
110 | - public function getUserGroupIds($user); |
|
105 | + /** |
|
106 | + * @param \OCP\IUser $user |
|
107 | + * @return array with group names |
|
108 | + * @since 8.0.0 |
|
109 | + */ |
|
110 | + public function getUserGroupIds($user); |
|
111 | 111 | |
112 | - /** |
|
113 | - * get a list of all display names in a group |
|
114 | - * |
|
115 | - * @param string $gid |
|
116 | - * @param string $search |
|
117 | - * @param int $limit |
|
118 | - * @param int $offset |
|
119 | - * @return array an array of display names (value) and user ids (key) |
|
120 | - * @since 8.0.0 |
|
121 | - */ |
|
122 | - public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0); |
|
112 | + /** |
|
113 | + * get a list of all display names in a group |
|
114 | + * |
|
115 | + * @param string $gid |
|
116 | + * @param string $search |
|
117 | + * @param int $limit |
|
118 | + * @param int $offset |
|
119 | + * @return array an array of display names (value) and user ids (key) |
|
120 | + * @since 8.0.0 |
|
121 | + */ |
|
122 | + public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0); |
|
123 | 123 | |
124 | - /** |
|
125 | - * Checks if a userId is in the admin group |
|
126 | - * @param string $userId |
|
127 | - * @return bool if admin |
|
128 | - * @since 8.0.0 |
|
129 | - */ |
|
130 | - public function isAdmin($userId); |
|
124 | + /** |
|
125 | + * Checks if a userId is in the admin group |
|
126 | + * @param string $userId |
|
127 | + * @return bool if admin |
|
128 | + * @since 8.0.0 |
|
129 | + */ |
|
130 | + public function isAdmin($userId); |
|
131 | 131 | |
132 | - /** |
|
133 | - * Checks if a userId is in a group |
|
134 | - * @param string $userId |
|
135 | - * @param string $group |
|
136 | - * @return bool if in group |
|
137 | - * @since 8.0.0 |
|
138 | - */ |
|
139 | - public function isInGroup($userId, $group); |
|
132 | + /** |
|
133 | + * Checks if a userId is in a group |
|
134 | + * @param string $userId |
|
135 | + * @param string $group |
|
136 | + * @return bool if in group |
|
137 | + * @since 8.0.0 |
|
138 | + */ |
|
139 | + public function isInGroup($userId, $group); |
|
140 | 140 | } |
@@ -35,46 +35,46 @@ |
||
35 | 35 | */ |
36 | 36 | interface IAvatar { |
37 | 37 | |
38 | - /** |
|
39 | - * get the users avatar |
|
40 | - * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image |
|
41 | - * @return boolean|\OCP\IImage containing the avatar or false if there's no image |
|
42 | - * @since 6.0.0 - size of -1 was added in 9.0.0 |
|
43 | - */ |
|
44 | - public function get($size = 64); |
|
38 | + /** |
|
39 | + * get the users avatar |
|
40 | + * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image |
|
41 | + * @return boolean|\OCP\IImage containing the avatar or false if there's no image |
|
42 | + * @since 6.0.0 - size of -1 was added in 9.0.0 |
|
43 | + */ |
|
44 | + public function get($size = 64); |
|
45 | 45 | |
46 | - /** |
|
47 | - * Check if an avatar exists for the user |
|
48 | - * |
|
49 | - * @return bool |
|
50 | - * @since 8.1.0 |
|
51 | - */ |
|
52 | - public function exists(); |
|
46 | + /** |
|
47 | + * Check if an avatar exists for the user |
|
48 | + * |
|
49 | + * @return bool |
|
50 | + * @since 8.1.0 |
|
51 | + */ |
|
52 | + public function exists(); |
|
53 | 53 | |
54 | - /** |
|
55 | - * sets the users avatar |
|
56 | - * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar |
|
57 | - * @throws \Exception if the provided file is not a jpg or png image |
|
58 | - * @throws \Exception if the provided image is not valid |
|
59 | - * @throws \OC\NotSquareException if the image is not square |
|
60 | - * @return void |
|
61 | - * @since 6.0.0 |
|
62 | - */ |
|
63 | - public function set($data); |
|
54 | + /** |
|
55 | + * sets the users avatar |
|
56 | + * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar |
|
57 | + * @throws \Exception if the provided file is not a jpg or png image |
|
58 | + * @throws \Exception if the provided image is not valid |
|
59 | + * @throws \OC\NotSquareException if the image is not square |
|
60 | + * @return void |
|
61 | + * @since 6.0.0 |
|
62 | + */ |
|
63 | + public function set($data); |
|
64 | 64 | |
65 | - /** |
|
66 | - * remove the users avatar |
|
67 | - * @return void |
|
68 | - * @since 6.0.0 |
|
69 | - */ |
|
70 | - public function remove(); |
|
65 | + /** |
|
66 | + * remove the users avatar |
|
67 | + * @return void |
|
68 | + * @since 6.0.0 |
|
69 | + */ |
|
70 | + public function remove(); |
|
71 | 71 | |
72 | - /** |
|
73 | - * Get the file of the avatar |
|
74 | - * @param int $size -1 can be used to not scale the image |
|
75 | - * @return File |
|
76 | - * @throws NotFoundException |
|
77 | - * @since 9.0.0 |
|
78 | - */ |
|
79 | - public function getFile($size); |
|
72 | + /** |
|
73 | + * Get the file of the avatar |
|
74 | + * @param int $size -1 can be used to not scale the image |
|
75 | + * @return File |
|
76 | + * @throws NotFoundException |
|
77 | + * @since 9.0.0 |
|
78 | + */ |
|
79 | + public function getFile($size); |
|
80 | 80 | } |
@@ -34,138 +34,138 @@ |
||
34 | 34 | // This means that they should be used by apps instead of the internal ownCloud classes |
35 | 35 | namespace OCP\Contacts { |
36 | 36 | |
37 | - /** |
|
38 | - * This class provides access to the contacts app. Use this class exclusively if you want to access contacts. |
|
39 | - * |
|
40 | - * Contacts in general will be expressed as an array of key-value-pairs. |
|
41 | - * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1 |
|
42 | - * |
|
43 | - * Proposed workflow for working with contacts: |
|
44 | - * - search for the contacts |
|
45 | - * - manipulate the results array |
|
46 | - * - createOrUpdate will save the given contacts overwriting the existing data |
|
47 | - * |
|
48 | - * For updating it is mandatory to keep the id. |
|
49 | - * Without an id a new contact will be created. |
|
50 | - * |
|
51 | - * @since 6.0.0 |
|
52 | - */ |
|
53 | - interface IManager { |
|
37 | + /** |
|
38 | + * This class provides access to the contacts app. Use this class exclusively if you want to access contacts. |
|
39 | + * |
|
40 | + * Contacts in general will be expressed as an array of key-value-pairs. |
|
41 | + * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1 |
|
42 | + * |
|
43 | + * Proposed workflow for working with contacts: |
|
44 | + * - search for the contacts |
|
45 | + * - manipulate the results array |
|
46 | + * - createOrUpdate will save the given contacts overwriting the existing data |
|
47 | + * |
|
48 | + * For updating it is mandatory to keep the id. |
|
49 | + * Without an id a new contact will be created. |
|
50 | + * |
|
51 | + * @since 6.0.0 |
|
52 | + */ |
|
53 | + interface IManager { |
|
54 | 54 | |
55 | - /** |
|
56 | - * This function is used to search and find contacts within the users address books. |
|
57 | - * In case $pattern is empty all contacts will be returned. |
|
58 | - * |
|
59 | - * Example: |
|
60 | - * Following function shows how to search for contacts for the name and the email address. |
|
61 | - * |
|
62 | - * public static function getMatchingRecipient($term) { |
|
63 | - * $cm = \OC::$server->getContactsManager(); |
|
64 | - * // The API is not active -> nothing to do |
|
65 | - * if (!$cm->isEnabled()) { |
|
66 | - * return array(); |
|
67 | - * } |
|
68 | - * |
|
69 | - * $result = $cm->search($term, array('FN', 'EMAIL')); |
|
70 | - * $receivers = array(); |
|
71 | - * foreach ($result as $r) { |
|
72 | - * $id = $r['id']; |
|
73 | - * $fn = $r['FN']; |
|
74 | - * $email = $r['EMAIL']; |
|
75 | - * if (!is_array($email)) { |
|
76 | - * $email = array($email); |
|
77 | - * } |
|
78 | - * |
|
79 | - * // loop through all email addresses of this contact |
|
80 | - * foreach ($email as $e) { |
|
81 | - * $displayName = $fn . " <$e>"; |
|
82 | - * $receivers[] = array( |
|
83 | - * 'id' => $id, |
|
84 | - * 'label' => $displayName, |
|
85 | - * 'value' => $displayName); |
|
86 | - * } |
|
87 | - * } |
|
88 | - * |
|
89 | - * return $receivers; |
|
90 | - * } |
|
91 | - * |
|
92 | - * |
|
93 | - * @param string $pattern which should match within the $searchProperties |
|
94 | - * @param array $searchProperties defines the properties within the query pattern should match |
|
95 | - * @param array $options - for future use. One should always have options! |
|
96 | - * @return array an array of contacts which are arrays of key-value-pairs |
|
97 | - * @since 6.0.0 |
|
98 | - */ |
|
99 | - function search($pattern, $searchProperties = array(), $options = array()); |
|
55 | + /** |
|
56 | + * This function is used to search and find contacts within the users address books. |
|
57 | + * In case $pattern is empty all contacts will be returned. |
|
58 | + * |
|
59 | + * Example: |
|
60 | + * Following function shows how to search for contacts for the name and the email address. |
|
61 | + * |
|
62 | + * public static function getMatchingRecipient($term) { |
|
63 | + * $cm = \OC::$server->getContactsManager(); |
|
64 | + * // The API is not active -> nothing to do |
|
65 | + * if (!$cm->isEnabled()) { |
|
66 | + * return array(); |
|
67 | + * } |
|
68 | + * |
|
69 | + * $result = $cm->search($term, array('FN', 'EMAIL')); |
|
70 | + * $receivers = array(); |
|
71 | + * foreach ($result as $r) { |
|
72 | + * $id = $r['id']; |
|
73 | + * $fn = $r['FN']; |
|
74 | + * $email = $r['EMAIL']; |
|
75 | + * if (!is_array($email)) { |
|
76 | + * $email = array($email); |
|
77 | + * } |
|
78 | + * |
|
79 | + * // loop through all email addresses of this contact |
|
80 | + * foreach ($email as $e) { |
|
81 | + * $displayName = $fn . " <$e>"; |
|
82 | + * $receivers[] = array( |
|
83 | + * 'id' => $id, |
|
84 | + * 'label' => $displayName, |
|
85 | + * 'value' => $displayName); |
|
86 | + * } |
|
87 | + * } |
|
88 | + * |
|
89 | + * return $receivers; |
|
90 | + * } |
|
91 | + * |
|
92 | + * |
|
93 | + * @param string $pattern which should match within the $searchProperties |
|
94 | + * @param array $searchProperties defines the properties within the query pattern should match |
|
95 | + * @param array $options - for future use. One should always have options! |
|
96 | + * @return array an array of contacts which are arrays of key-value-pairs |
|
97 | + * @since 6.0.0 |
|
98 | + */ |
|
99 | + function search($pattern, $searchProperties = array(), $options = array()); |
|
100 | 100 | |
101 | - /** |
|
102 | - * This function can be used to delete the contact identified by the given id |
|
103 | - * |
|
104 | - * @param object $id the unique identifier to a contact |
|
105 | - * @param string $address_book_key identifier of the address book in which the contact shall be deleted |
|
106 | - * @return bool successful or not |
|
107 | - * @since 6.0.0 |
|
108 | - */ |
|
109 | - function delete($id, $address_book_key); |
|
101 | + /** |
|
102 | + * This function can be used to delete the contact identified by the given id |
|
103 | + * |
|
104 | + * @param object $id the unique identifier to a contact |
|
105 | + * @param string $address_book_key identifier of the address book in which the contact shall be deleted |
|
106 | + * @return bool successful or not |
|
107 | + * @since 6.0.0 |
|
108 | + */ |
|
109 | + function delete($id, $address_book_key); |
|
110 | 110 | |
111 | - /** |
|
112 | - * This function is used to create a new contact if 'id' is not given or not present. |
|
113 | - * Otherwise the contact will be updated by replacing the entire data set. |
|
114 | - * |
|
115 | - * @param array $properties this array if key-value-pairs defines a contact |
|
116 | - * @param string $address_book_key identifier of the address book in which the contact shall be created or updated |
|
117 | - * @return array an array representing the contact just created or updated |
|
118 | - * @since 6.0.0 |
|
119 | - */ |
|
120 | - function createOrUpdate($properties, $address_book_key); |
|
111 | + /** |
|
112 | + * This function is used to create a new contact if 'id' is not given or not present. |
|
113 | + * Otherwise the contact will be updated by replacing the entire data set. |
|
114 | + * |
|
115 | + * @param array $properties this array if key-value-pairs defines a contact |
|
116 | + * @param string $address_book_key identifier of the address book in which the contact shall be created or updated |
|
117 | + * @return array an array representing the contact just created or updated |
|
118 | + * @since 6.0.0 |
|
119 | + */ |
|
120 | + function createOrUpdate($properties, $address_book_key); |
|
121 | 121 | |
122 | - /** |
|
123 | - * Check if contacts are available (e.g. contacts app enabled) |
|
124 | - * |
|
125 | - * @return bool true if enabled, false if not |
|
126 | - * @since 6.0.0 |
|
127 | - */ |
|
128 | - function isEnabled(); |
|
122 | + /** |
|
123 | + * Check if contacts are available (e.g. contacts app enabled) |
|
124 | + * |
|
125 | + * @return bool true if enabled, false if not |
|
126 | + * @since 6.0.0 |
|
127 | + */ |
|
128 | + function isEnabled(); |
|
129 | 129 | |
130 | - /** |
|
131 | - * Registers an address book |
|
132 | - * |
|
133 | - * @param \OCP\IAddressBook $address_book |
|
134 | - * @return void |
|
135 | - * @since 6.0.0 |
|
136 | - */ |
|
137 | - function registerAddressBook(\OCP\IAddressBook $address_book); |
|
130 | + /** |
|
131 | + * Registers an address book |
|
132 | + * |
|
133 | + * @param \OCP\IAddressBook $address_book |
|
134 | + * @return void |
|
135 | + * @since 6.0.0 |
|
136 | + */ |
|
137 | + function registerAddressBook(\OCP\IAddressBook $address_book); |
|
138 | 138 | |
139 | - /** |
|
140 | - * Unregisters an address book |
|
141 | - * |
|
142 | - * @param \OCP\IAddressBook $address_book |
|
143 | - * @return void |
|
144 | - * @since 6.0.0 |
|
145 | - */ |
|
146 | - function unregisterAddressBook(\OCP\IAddressBook $address_book); |
|
139 | + /** |
|
140 | + * Unregisters an address book |
|
141 | + * |
|
142 | + * @param \OCP\IAddressBook $address_book |
|
143 | + * @return void |
|
144 | + * @since 6.0.0 |
|
145 | + */ |
|
146 | + function unregisterAddressBook(\OCP\IAddressBook $address_book); |
|
147 | 147 | |
148 | - /** |
|
149 | - * In order to improve lazy loading a closure can be registered which will be called in case |
|
150 | - * address books are actually requested |
|
151 | - * |
|
152 | - * @param \Closure $callable |
|
153 | - * @return void |
|
154 | - * @since 6.0.0 |
|
155 | - */ |
|
156 | - function register(\Closure $callable); |
|
148 | + /** |
|
149 | + * In order to improve lazy loading a closure can be registered which will be called in case |
|
150 | + * address books are actually requested |
|
151 | + * |
|
152 | + * @param \Closure $callable |
|
153 | + * @return void |
|
154 | + * @since 6.0.0 |
|
155 | + */ |
|
156 | + function register(\Closure $callable); |
|
157 | 157 | |
158 | - /** |
|
159 | - * @return array |
|
160 | - * @since 6.0.0 |
|
161 | - */ |
|
162 | - function getAddressBooks(); |
|
158 | + /** |
|
159 | + * @return array |
|
160 | + * @since 6.0.0 |
|
161 | + */ |
|
162 | + function getAddressBooks(); |
|
163 | 163 | |
164 | - /** |
|
165 | - * removes all registered address book instances |
|
166 | - * @return void |
|
167 | - * @since 6.0.0 |
|
168 | - */ |
|
169 | - function clear(); |
|
170 | - } |
|
164 | + /** |
|
165 | + * removes all registered address book instances |
|
166 | + * @return void |
|
167 | + * @since 6.0.0 |
|
168 | + */ |
|
169 | + function clear(); |
|
170 | + } |
|
171 | 171 | } |
@@ -33,46 +33,46 @@ |
||
33 | 33 | */ |
34 | 34 | interface ISearch { |
35 | 35 | |
36 | - /** |
|
37 | - * Search all providers for $query |
|
38 | - * @param string $query |
|
39 | - * @param string[] $inApps optionally limit results to the given apps |
|
40 | - * @return array An array of OCP\Search\Result's |
|
41 | - * @deprecated 8.0.0 use searchPaged() with page and size |
|
42 | - * @since 7.0.0 - parameter $inApps was added in 8.0.0 |
|
43 | - */ |
|
44 | - public function search($query, array $inApps = array()); |
|
36 | + /** |
|
37 | + * Search all providers for $query |
|
38 | + * @param string $query |
|
39 | + * @param string[] $inApps optionally limit results to the given apps |
|
40 | + * @return array An array of OCP\Search\Result's |
|
41 | + * @deprecated 8.0.0 use searchPaged() with page and size |
|
42 | + * @since 7.0.0 - parameter $inApps was added in 8.0.0 |
|
43 | + */ |
|
44 | + public function search($query, array $inApps = array()); |
|
45 | 45 | |
46 | - /** |
|
47 | - * Search all providers for $query |
|
48 | - * @param string $query |
|
49 | - * @param string[] $inApps optionally limit results to the given apps |
|
50 | - * @param int $page pages start at page 1 |
|
51 | - * @param int $size |
|
52 | - * @return array An array of OCP\Search\Result's |
|
53 | - * @since 8.0.0 |
|
54 | - */ |
|
55 | - public function searchPaged($query, array $inApps = array(), $page = 1, $size = 30); |
|
46 | + /** |
|
47 | + * Search all providers for $query |
|
48 | + * @param string $query |
|
49 | + * @param string[] $inApps optionally limit results to the given apps |
|
50 | + * @param int $page pages start at page 1 |
|
51 | + * @param int $size |
|
52 | + * @return array An array of OCP\Search\Result's |
|
53 | + * @since 8.0.0 |
|
54 | + */ |
|
55 | + public function searchPaged($query, array $inApps = array(), $page = 1, $size = 30); |
|
56 | 56 | |
57 | - /** |
|
58 | - * Register a new search provider to search with |
|
59 | - * @param string $class class name of a OCP\Search\Provider |
|
60 | - * @param array $options optional |
|
61 | - * @since 7.0.0 |
|
62 | - */ |
|
63 | - public function registerProvider($class, array $options = array()); |
|
57 | + /** |
|
58 | + * Register a new search provider to search with |
|
59 | + * @param string $class class name of a OCP\Search\Provider |
|
60 | + * @param array $options optional |
|
61 | + * @since 7.0.0 |
|
62 | + */ |
|
63 | + public function registerProvider($class, array $options = array()); |
|
64 | 64 | |
65 | - /** |
|
66 | - * Remove one existing search provider |
|
67 | - * @param string $provider class name of a OCP\Search\Provider |
|
68 | - * @since 7.0.0 |
|
69 | - */ |
|
70 | - public function removeProvider($provider); |
|
65 | + /** |
|
66 | + * Remove one existing search provider |
|
67 | + * @param string $provider class name of a OCP\Search\Provider |
|
68 | + * @since 7.0.0 |
|
69 | + */ |
|
70 | + public function removeProvider($provider); |
|
71 | 71 | |
72 | - /** |
|
73 | - * Remove all registered search providers |
|
74 | - * @since 7.0.0 |
|
75 | - */ |
|
76 | - public function clearProviders(); |
|
72 | + /** |
|
73 | + * Remove all registered search providers |
|
74 | + * @since 7.0.0 |
|
75 | + */ |
|
76 | + public function clearProviders(); |
|
77 | 77 | |
78 | 78 | } |
@@ -38,57 +38,57 @@ |
||
38 | 38 | * @since 6.0.0 |
39 | 39 | */ |
40 | 40 | interface IURLGenerator { |
41 | - /** |
|
42 | - * Returns the URL for a route |
|
43 | - * @param string $routeName the name of the route |
|
44 | - * @param array $arguments an array with arguments which will be filled into the url |
|
45 | - * @return string the url |
|
46 | - * @since 6.0.0 |
|
47 | - */ |
|
48 | - public function linkToRoute($routeName, $arguments = array()); |
|
41 | + /** |
|
42 | + * Returns the URL for a route |
|
43 | + * @param string $routeName the name of the route |
|
44 | + * @param array $arguments an array with arguments which will be filled into the url |
|
45 | + * @return string the url |
|
46 | + * @since 6.0.0 |
|
47 | + */ |
|
48 | + public function linkToRoute($routeName, $arguments = array()); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Returns the absolute URL for a route |
|
52 | - * @param string $routeName the name of the route |
|
53 | - * @param array $arguments an array with arguments which will be filled into the url |
|
54 | - * @return string the absolute url |
|
55 | - * @since 8.0.0 |
|
56 | - */ |
|
57 | - public function linkToRouteAbsolute($routeName, $arguments = array()); |
|
50 | + /** |
|
51 | + * Returns the absolute URL for a route |
|
52 | + * @param string $routeName the name of the route |
|
53 | + * @param array $arguments an array with arguments which will be filled into the url |
|
54 | + * @return string the absolute url |
|
55 | + * @since 8.0.0 |
|
56 | + */ |
|
57 | + public function linkToRouteAbsolute($routeName, $arguments = array()); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Returns an URL for an image or file |
|
61 | - * @param string $appName the name of the app |
|
62 | - * @param string $file the name of the file |
|
63 | - * @param array $args array with param=>value, will be appended to the returned url |
|
64 | - * The value of $args will be urlencoded |
|
65 | - * @return string the url |
|
66 | - * @since 6.0.0 |
|
67 | - */ |
|
68 | - public function linkTo($appName, $file, $args = array()); |
|
59 | + /** |
|
60 | + * Returns an URL for an image or file |
|
61 | + * @param string $appName the name of the app |
|
62 | + * @param string $file the name of the file |
|
63 | + * @param array $args array with param=>value, will be appended to the returned url |
|
64 | + * The value of $args will be urlencoded |
|
65 | + * @return string the url |
|
66 | + * @since 6.0.0 |
|
67 | + */ |
|
68 | + public function linkTo($appName, $file, $args = array()); |
|
69 | 69 | |
70 | - /** |
|
71 | - * Returns the link to an image, like linkTo but only with prepending img/ |
|
72 | - * @param string $appName the name of the app |
|
73 | - * @param string $file the name of the file |
|
74 | - * @return string the url |
|
75 | - * @since 6.0.0 |
|
76 | - */ |
|
77 | - public function imagePath($appName, $file); |
|
70 | + /** |
|
71 | + * Returns the link to an image, like linkTo but only with prepending img/ |
|
72 | + * @param string $appName the name of the app |
|
73 | + * @param string $file the name of the file |
|
74 | + * @return string the url |
|
75 | + * @since 6.0.0 |
|
76 | + */ |
|
77 | + public function imagePath($appName, $file); |
|
78 | 78 | |
79 | 79 | |
80 | - /** |
|
81 | - * Makes an URL absolute |
|
82 | - * @param string $url the url in the ownCloud host |
|
83 | - * @return string the absolute version of the url |
|
84 | - * @since 6.0.0 |
|
85 | - */ |
|
86 | - public function getAbsoluteURL($url); |
|
80 | + /** |
|
81 | + * Makes an URL absolute |
|
82 | + * @param string $url the url in the ownCloud host |
|
83 | + * @return string the absolute version of the url |
|
84 | + * @since 6.0.0 |
|
85 | + */ |
|
86 | + public function getAbsoluteURL($url); |
|
87 | 87 | |
88 | - /** |
|
89 | - * @param string $key |
|
90 | - * @return string url to the online documentation |
|
91 | - * @since 8.0.0 |
|
92 | - */ |
|
93 | - public function linkToDocs($key); |
|
88 | + /** |
|
89 | + * @param string $key |
|
90 | + * @return string url to the online documentation |
|
91 | + * @since 8.0.0 |
|
92 | + */ |
|
93 | + public function linkToDocs($key); |
|
94 | 94 | } |
@@ -40,136 +40,136 @@ |
||
40 | 40 | */ |
41 | 41 | class Defaults { |
42 | 42 | |
43 | - /** |
|
44 | - * \OC_Defaults instance to retrieve the defaults |
|
45 | - * @return string |
|
46 | - * @since 6.0.0 |
|
47 | - */ |
|
48 | - private $defaults; |
|
49 | - |
|
50 | - /** |
|
51 | - * creates a \OC_Defaults instance which is used in all methods to retrieve the |
|
52 | - * actual defaults |
|
53 | - * @since 6.0.0 |
|
54 | - */ |
|
55 | - function __construct() { |
|
56 | - $this->defaults = \OC::$server->getThemingDefaults(); |
|
57 | - } |
|
58 | - |
|
59 | - /** |
|
60 | - * get base URL for the organisation behind your ownCloud instance |
|
61 | - * @return string |
|
62 | - * @since 6.0.0 |
|
63 | - */ |
|
64 | - public function getBaseUrl() { |
|
65 | - return $this->defaults->getBaseUrl(); |
|
66 | - } |
|
67 | - |
|
68 | - /** |
|
69 | - * link to the desktop sync client |
|
70 | - * @return string |
|
71 | - * @since 6.0.0 |
|
72 | - */ |
|
73 | - public function getSyncClientUrl() { |
|
74 | - return $this->defaults->getSyncClientUrl(); |
|
75 | - } |
|
76 | - |
|
77 | - /** |
|
78 | - * link to the iOS client |
|
79 | - * @return string |
|
80 | - * @since 8.0.0 |
|
81 | - */ |
|
82 | - public function getiOSClientUrl() { |
|
83 | - return $this->defaults->getiOSClientUrl(); |
|
84 | - } |
|
85 | - |
|
86 | - /** |
|
87 | - * link to the Android client |
|
88 | - * @return string |
|
89 | - * @since 8.0.0 |
|
90 | - */ |
|
91 | - public function getAndroidClientUrl() { |
|
92 | - return $this->defaults->getAndroidClientUrl(); |
|
93 | - } |
|
94 | - |
|
95 | - /** |
|
96 | - * base URL to the documentation of your ownCloud instance |
|
97 | - * @return string |
|
98 | - * @since 6.0.0 |
|
99 | - */ |
|
100 | - public function getDocBaseUrl() { |
|
101 | - return $this->defaults->getDocBaseUrl(); |
|
102 | - } |
|
103 | - |
|
104 | - /** |
|
105 | - * name of your ownCloud instance |
|
106 | - * @return string |
|
107 | - * @since 6.0.0 |
|
108 | - */ |
|
109 | - public function getName() { |
|
110 | - return $this->defaults->getName(); |
|
111 | - } |
|
112 | - |
|
113 | - /** |
|
114 | - * name of your ownCloud instance containing HTML styles |
|
115 | - * @return string |
|
116 | - * @since 8.0.0 |
|
117 | - */ |
|
118 | - public function getHTMLName() { |
|
119 | - return $this->defaults->getHTMLName(); |
|
120 | - } |
|
121 | - |
|
122 | - /** |
|
123 | - * Entity behind your onwCloud instance |
|
124 | - * @return string |
|
125 | - * @since 6.0.0 |
|
126 | - */ |
|
127 | - public function getEntity() { |
|
128 | - return $this->defaults->getEntity(); |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * ownCloud slogan |
|
133 | - * @return string |
|
134 | - * @since 6.0.0 |
|
135 | - */ |
|
136 | - public function getSlogan() { |
|
137 | - return $this->defaults->getSlogan(); |
|
138 | - } |
|
139 | - |
|
140 | - /** |
|
141 | - * logo claim |
|
142 | - * @return string |
|
143 | - * @since 6.0.0 |
|
144 | - */ |
|
145 | - public function getLogoClaim() { |
|
146 | - return $this->defaults->getLogoClaim(); |
|
147 | - } |
|
148 | - |
|
149 | - /** |
|
150 | - * footer, short version |
|
151 | - * @return string |
|
152 | - * @since 6.0.0 |
|
153 | - */ |
|
154 | - public function getShortFooter() { |
|
155 | - return $this->defaults->getShortFooter(); |
|
156 | - } |
|
157 | - |
|
158 | - /** |
|
159 | - * footer, long version |
|
160 | - * @return string |
|
161 | - * @since 6.0.0 |
|
162 | - */ |
|
163 | - public function getLongFooter() { |
|
164 | - return $this->defaults->getLongFooter(); |
|
165 | - } |
|
166 | - |
|
167 | - /** |
|
168 | - * Returns the AppId for the App Store for the iOS Client |
|
169 | - * @return string AppId |
|
170 | - * @since 8.0.0 |
|
171 | - */ |
|
172 | - public function getiTunesAppId() { |
|
173 | - return $this->defaults->getiTunesAppId(); |
|
174 | - } |
|
43 | + /** |
|
44 | + * \OC_Defaults instance to retrieve the defaults |
|
45 | + * @return string |
|
46 | + * @since 6.0.0 |
|
47 | + */ |
|
48 | + private $defaults; |
|
49 | + |
|
50 | + /** |
|
51 | + * creates a \OC_Defaults instance which is used in all methods to retrieve the |
|
52 | + * actual defaults |
|
53 | + * @since 6.0.0 |
|
54 | + */ |
|
55 | + function __construct() { |
|
56 | + $this->defaults = \OC::$server->getThemingDefaults(); |
|
57 | + } |
|
58 | + |
|
59 | + /** |
|
60 | + * get base URL for the organisation behind your ownCloud instance |
|
61 | + * @return string |
|
62 | + * @since 6.0.0 |
|
63 | + */ |
|
64 | + public function getBaseUrl() { |
|
65 | + return $this->defaults->getBaseUrl(); |
|
66 | + } |
|
67 | + |
|
68 | + /** |
|
69 | + * link to the desktop sync client |
|
70 | + * @return string |
|
71 | + * @since 6.0.0 |
|
72 | + */ |
|
73 | + public function getSyncClientUrl() { |
|
74 | + return $this->defaults->getSyncClientUrl(); |
|
75 | + } |
|
76 | + |
|
77 | + /** |
|
78 | + * link to the iOS client |
|
79 | + * @return string |
|
80 | + * @since 8.0.0 |
|
81 | + */ |
|
82 | + public function getiOSClientUrl() { |
|
83 | + return $this->defaults->getiOSClientUrl(); |
|
84 | + } |
|
85 | + |
|
86 | + /** |
|
87 | + * link to the Android client |
|
88 | + * @return string |
|
89 | + * @since 8.0.0 |
|
90 | + */ |
|
91 | + public function getAndroidClientUrl() { |
|
92 | + return $this->defaults->getAndroidClientUrl(); |
|
93 | + } |
|
94 | + |
|
95 | + /** |
|
96 | + * base URL to the documentation of your ownCloud instance |
|
97 | + * @return string |
|
98 | + * @since 6.0.0 |
|
99 | + */ |
|
100 | + public function getDocBaseUrl() { |
|
101 | + return $this->defaults->getDocBaseUrl(); |
|
102 | + } |
|
103 | + |
|
104 | + /** |
|
105 | + * name of your ownCloud instance |
|
106 | + * @return string |
|
107 | + * @since 6.0.0 |
|
108 | + */ |
|
109 | + public function getName() { |
|
110 | + return $this->defaults->getName(); |
|
111 | + } |
|
112 | + |
|
113 | + /** |
|
114 | + * name of your ownCloud instance containing HTML styles |
|
115 | + * @return string |
|
116 | + * @since 8.0.0 |
|
117 | + */ |
|
118 | + public function getHTMLName() { |
|
119 | + return $this->defaults->getHTMLName(); |
|
120 | + } |
|
121 | + |
|
122 | + /** |
|
123 | + * Entity behind your onwCloud instance |
|
124 | + * @return string |
|
125 | + * @since 6.0.0 |
|
126 | + */ |
|
127 | + public function getEntity() { |
|
128 | + return $this->defaults->getEntity(); |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * ownCloud slogan |
|
133 | + * @return string |
|
134 | + * @since 6.0.0 |
|
135 | + */ |
|
136 | + public function getSlogan() { |
|
137 | + return $this->defaults->getSlogan(); |
|
138 | + } |
|
139 | + |
|
140 | + /** |
|
141 | + * logo claim |
|
142 | + * @return string |
|
143 | + * @since 6.0.0 |
|
144 | + */ |
|
145 | + public function getLogoClaim() { |
|
146 | + return $this->defaults->getLogoClaim(); |
|
147 | + } |
|
148 | + |
|
149 | + /** |
|
150 | + * footer, short version |
|
151 | + * @return string |
|
152 | + * @since 6.0.0 |
|
153 | + */ |
|
154 | + public function getShortFooter() { |
|
155 | + return $this->defaults->getShortFooter(); |
|
156 | + } |
|
157 | + |
|
158 | + /** |
|
159 | + * footer, long version |
|
160 | + * @return string |
|
161 | + * @since 6.0.0 |
|
162 | + */ |
|
163 | + public function getLongFooter() { |
|
164 | + return $this->defaults->getLongFooter(); |
|
165 | + } |
|
166 | + |
|
167 | + /** |
|
168 | + * Returns the AppId for the App Store for the iOS Client |
|
169 | + * @return string AppId |
|
170 | + * @since 8.0.0 |
|
171 | + */ |
|
172 | + public function getiTunesAppId() { |
|
173 | + return $this->defaults->getiTunesAppId(); |
|
174 | + } |
|
175 | 175 | } |
@@ -29,41 +29,41 @@ |
||
29 | 29 | */ |
30 | 30 | interface ISystemTag { |
31 | 31 | |
32 | - /** |
|
33 | - * Returns the tag id |
|
34 | - * |
|
35 | - * @return string id |
|
36 | - * |
|
37 | - * @since 9.0.0 |
|
38 | - */ |
|
39 | - public function getId(); |
|
32 | + /** |
|
33 | + * Returns the tag id |
|
34 | + * |
|
35 | + * @return string id |
|
36 | + * |
|
37 | + * @since 9.0.0 |
|
38 | + */ |
|
39 | + public function getId(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Returns the tag display name |
|
43 | - * |
|
44 | - * @return string tag display name |
|
45 | - * |
|
46 | - * @since 9.0.0 |
|
47 | - */ |
|
48 | - public function getName(); |
|
41 | + /** |
|
42 | + * Returns the tag display name |
|
43 | + * |
|
44 | + * @return string tag display name |
|
45 | + * |
|
46 | + * @since 9.0.0 |
|
47 | + */ |
|
48 | + public function getName(); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Returns whether the tag is visible for regular users |
|
52 | - * |
|
53 | - * @return bool true if visible, false otherwise |
|
54 | - * |
|
55 | - * @since 9.0.0 |
|
56 | - */ |
|
57 | - public function isUserVisible(); |
|
50 | + /** |
|
51 | + * Returns whether the tag is visible for regular users |
|
52 | + * |
|
53 | + * @return bool true if visible, false otherwise |
|
54 | + * |
|
55 | + * @since 9.0.0 |
|
56 | + */ |
|
57 | + public function isUserVisible(); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Returns whether the tag can be assigned to objects by regular users |
|
61 | - * |
|
62 | - * @return bool true if assignable, false otherwise |
|
63 | - * |
|
64 | - * @since 9.0.0 |
|
65 | - */ |
|
66 | - public function isUserAssignable(); |
|
59 | + /** |
|
60 | + * Returns whether the tag can be assigned to objects by regular users |
|
61 | + * |
|
62 | + * @return bool true if assignable, false otherwise |
|
63 | + * |
|
64 | + * @since 9.0.0 |
|
65 | + */ |
|
66 | + public function isUserAssignable(); |
|
67 | 67 | |
68 | 68 | } |
69 | 69 |