@@ -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 | } |
@@ -33,153 +33,153 @@ |
||
33 | 33 | // This means that they should be used by apps instead of the internal ownCloud classes |
34 | 34 | namespace OCP { |
35 | 35 | |
36 | - /** |
|
37 | - * This class provides access to the contacts app. Use this class exclusively if you want to access contacts. |
|
38 | - * |
|
39 | - * Contacts in general will be expressed as an array of key-value-pairs. |
|
40 | - * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1 |
|
41 | - * |
|
42 | - * Proposed workflow for working with contacts: |
|
43 | - * - search for the contacts |
|
44 | - * - manipulate the results array |
|
45 | - * - createOrUpdate will save the given contacts overwriting the existing data |
|
46 | - * |
|
47 | - * For updating it is mandatory to keep the id. |
|
48 | - * Without an id a new contact will be created. |
|
49 | - * |
|
50 | - * @deprecated 8.1.0 use methods of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
51 | - * @since 5.0.0 |
|
52 | - */ |
|
53 | - class Contacts { |
|
36 | + /** |
|
37 | + * This class provides access to the contacts app. Use this class exclusively if you want to access contacts. |
|
38 | + * |
|
39 | + * Contacts in general will be expressed as an array of key-value-pairs. |
|
40 | + * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1 |
|
41 | + * |
|
42 | + * Proposed workflow for working with contacts: |
|
43 | + * - search for the contacts |
|
44 | + * - manipulate the results array |
|
45 | + * - createOrUpdate will save the given contacts overwriting the existing data |
|
46 | + * |
|
47 | + * For updating it is mandatory to keep the id. |
|
48 | + * Without an id a new contact will be created. |
|
49 | + * |
|
50 | + * @deprecated 8.1.0 use methods of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
51 | + * @since 5.0.0 |
|
52 | + */ |
|
53 | + class Contacts { |
|
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 | - * // The API is not active -> nothing to do |
|
64 | - * if (!\OCP\Contacts::isEnabled()) { |
|
65 | - * return array(); |
|
66 | - * } |
|
67 | - * |
|
68 | - * $result = \OCP\Contacts::search($term, array('FN', 'EMAIL')); |
|
69 | - * $receivers = array(); |
|
70 | - * foreach ($result as $r) { |
|
71 | - * $id = $r['id']; |
|
72 | - * $fn = $r['FN']; |
|
73 | - * $email = $r['EMAIL']; |
|
74 | - * if (!is_array($email)) { |
|
75 | - * $email = array($email); |
|
76 | - * } |
|
77 | - * |
|
78 | - * // loop through all email addresses of this contact |
|
79 | - * foreach ($email as $e) { |
|
80 | - * $displayName = $fn . " <$e>"; |
|
81 | - * $receivers[] = array( |
|
82 | - * 'id' => $id, |
|
83 | - * 'label' => $displayName, |
|
84 | - * 'value' => $displayName); |
|
85 | - * } |
|
86 | - * } |
|
87 | - * |
|
88 | - * return $receivers; |
|
89 | - * } |
|
90 | - * |
|
91 | - * |
|
92 | - * @param string $pattern which should match within the $searchProperties |
|
93 | - * @param array $searchProperties defines the properties within the query pattern should match |
|
94 | - * @param array $options - for future use. One should always have options! |
|
95 | - * @return array an array of contacts which are arrays of key-value-pairs |
|
96 | - * @deprecated 8.1.0 use search() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
97 | - * @since 5.0.0 |
|
98 | - */ |
|
99 | - public static function search($pattern, $searchProperties = array(), $options = array()) { |
|
100 | - $cm = \OC::$server->getContactsManager(); |
|
101 | - return $cm->search($pattern, $searchProperties, $options); |
|
102 | - } |
|
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 | + * // The API is not active -> nothing to do |
|
64 | + * if (!\OCP\Contacts::isEnabled()) { |
|
65 | + * return array(); |
|
66 | + * } |
|
67 | + * |
|
68 | + * $result = \OCP\Contacts::search($term, array('FN', 'EMAIL')); |
|
69 | + * $receivers = array(); |
|
70 | + * foreach ($result as $r) { |
|
71 | + * $id = $r['id']; |
|
72 | + * $fn = $r['FN']; |
|
73 | + * $email = $r['EMAIL']; |
|
74 | + * if (!is_array($email)) { |
|
75 | + * $email = array($email); |
|
76 | + * } |
|
77 | + * |
|
78 | + * // loop through all email addresses of this contact |
|
79 | + * foreach ($email as $e) { |
|
80 | + * $displayName = $fn . " <$e>"; |
|
81 | + * $receivers[] = array( |
|
82 | + * 'id' => $id, |
|
83 | + * 'label' => $displayName, |
|
84 | + * 'value' => $displayName); |
|
85 | + * } |
|
86 | + * } |
|
87 | + * |
|
88 | + * return $receivers; |
|
89 | + * } |
|
90 | + * |
|
91 | + * |
|
92 | + * @param string $pattern which should match within the $searchProperties |
|
93 | + * @param array $searchProperties defines the properties within the query pattern should match |
|
94 | + * @param array $options - for future use. One should always have options! |
|
95 | + * @return array an array of contacts which are arrays of key-value-pairs |
|
96 | + * @deprecated 8.1.0 use search() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
97 | + * @since 5.0.0 |
|
98 | + */ |
|
99 | + public static function search($pattern, $searchProperties = array(), $options = array()) { |
|
100 | + $cm = \OC::$server->getContactsManager(); |
|
101 | + return $cm->search($pattern, $searchProperties, $options); |
|
102 | + } |
|
103 | 103 | |
104 | - /** |
|
105 | - * This function can be used to delete the contact identified by the given id |
|
106 | - * |
|
107 | - * @param object $id the unique identifier to a contact |
|
108 | - * @param string $address_book_key |
|
109 | - * @return bool successful or not |
|
110 | - * @deprecated 8.1.0 use delete() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
111 | - * @since 5.0.0 |
|
112 | - */ |
|
113 | - public static function delete($id, $address_book_key) { |
|
114 | - $cm = \OC::$server->getContactsManager(); |
|
115 | - return $cm->delete($id, $address_book_key); |
|
116 | - } |
|
104 | + /** |
|
105 | + * This function can be used to delete the contact identified by the given id |
|
106 | + * |
|
107 | + * @param object $id the unique identifier to a contact |
|
108 | + * @param string $address_book_key |
|
109 | + * @return bool successful or not |
|
110 | + * @deprecated 8.1.0 use delete() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
111 | + * @since 5.0.0 |
|
112 | + */ |
|
113 | + public static function delete($id, $address_book_key) { |
|
114 | + $cm = \OC::$server->getContactsManager(); |
|
115 | + return $cm->delete($id, $address_book_key); |
|
116 | + } |
|
117 | 117 | |
118 | - /** |
|
119 | - * This function is used to create a new contact if 'id' is not given or not present. |
|
120 | - * Otherwise the contact will be updated by replacing the entire data set. |
|
121 | - * |
|
122 | - * @param array $properties this array if key-value-pairs defines a contact |
|
123 | - * @param string $address_book_key identifier of the address book in which the contact shall be created or updated |
|
124 | - * @return array an array representing the contact just created or updated |
|
125 | - * @deprecated 8.1.0 use createOrUpdate() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
126 | - * @since 5.0.0 |
|
127 | - */ |
|
128 | - public static function createOrUpdate($properties, $address_book_key) { |
|
129 | - $cm = \OC::$server->getContactsManager(); |
|
130 | - return $cm->createOrUpdate($properties, $address_book_key); |
|
131 | - } |
|
118 | + /** |
|
119 | + * This function is used to create a new contact if 'id' is not given or not present. |
|
120 | + * Otherwise the contact will be updated by replacing the entire data set. |
|
121 | + * |
|
122 | + * @param array $properties this array if key-value-pairs defines a contact |
|
123 | + * @param string $address_book_key identifier of the address book in which the contact shall be created or updated |
|
124 | + * @return array an array representing the contact just created or updated |
|
125 | + * @deprecated 8.1.0 use createOrUpdate() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
126 | + * @since 5.0.0 |
|
127 | + */ |
|
128 | + public static function createOrUpdate($properties, $address_book_key) { |
|
129 | + $cm = \OC::$server->getContactsManager(); |
|
130 | + return $cm->createOrUpdate($properties, $address_book_key); |
|
131 | + } |
|
132 | 132 | |
133 | - /** |
|
134 | - * Check if contacts are available (e.g. contacts app enabled) |
|
135 | - * |
|
136 | - * @return bool true if enabled, false if not |
|
137 | - * @deprecated 8.1.0 use isEnabled() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
138 | - * @since 5.0.0 |
|
139 | - */ |
|
140 | - public static function isEnabled() { |
|
141 | - $cm = \OC::$server->getContactsManager(); |
|
142 | - return $cm->isEnabled(); |
|
143 | - } |
|
133 | + /** |
|
134 | + * Check if contacts are available (e.g. contacts app enabled) |
|
135 | + * |
|
136 | + * @return bool true if enabled, false if not |
|
137 | + * @deprecated 8.1.0 use isEnabled() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
138 | + * @since 5.0.0 |
|
139 | + */ |
|
140 | + public static function isEnabled() { |
|
141 | + $cm = \OC::$server->getContactsManager(); |
|
142 | + return $cm->isEnabled(); |
|
143 | + } |
|
144 | 144 | |
145 | - /** |
|
146 | - * @param \OCP\IAddressBook $address_book |
|
147 | - * @deprecated 8.1.0 use registerAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
148 | - * @since 5.0.0 |
|
149 | - */ |
|
150 | - public static function registerAddressBook(\OCP\IAddressBook $address_book) { |
|
151 | - $cm = \OC::$server->getContactsManager(); |
|
152 | - $cm->registerAddressBook($address_book); |
|
153 | - } |
|
145 | + /** |
|
146 | + * @param \OCP\IAddressBook $address_book |
|
147 | + * @deprecated 8.1.0 use registerAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
148 | + * @since 5.0.0 |
|
149 | + */ |
|
150 | + public static function registerAddressBook(\OCP\IAddressBook $address_book) { |
|
151 | + $cm = \OC::$server->getContactsManager(); |
|
152 | + $cm->registerAddressBook($address_book); |
|
153 | + } |
|
154 | 154 | |
155 | - /** |
|
156 | - * @param \OCP\IAddressBook $address_book |
|
157 | - * @deprecated 8.1.0 use unregisterAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
158 | - * @since 5.0.0 |
|
159 | - */ |
|
160 | - public static function unregisterAddressBook(\OCP\IAddressBook $address_book) { |
|
161 | - $cm = \OC::$server->getContactsManager(); |
|
162 | - $cm->unregisterAddressBook($address_book); |
|
163 | - } |
|
155 | + /** |
|
156 | + * @param \OCP\IAddressBook $address_book |
|
157 | + * @deprecated 8.1.0 use unregisterAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
158 | + * @since 5.0.0 |
|
159 | + */ |
|
160 | + public static function unregisterAddressBook(\OCP\IAddressBook $address_book) { |
|
161 | + $cm = \OC::$server->getContactsManager(); |
|
162 | + $cm->unregisterAddressBook($address_book); |
|
163 | + } |
|
164 | 164 | |
165 | - /** |
|
166 | - * @return array |
|
167 | - * @deprecated 8.1.0 use getAddressBooks() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
168 | - * @since 5.0.0 |
|
169 | - */ |
|
170 | - public static function getAddressBooks() { |
|
171 | - $cm = \OC::$server->getContactsManager(); |
|
172 | - return $cm->getAddressBooks(); |
|
173 | - } |
|
165 | + /** |
|
166 | + * @return array |
|
167 | + * @deprecated 8.1.0 use getAddressBooks() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
168 | + * @since 5.0.0 |
|
169 | + */ |
|
170 | + public static function getAddressBooks() { |
|
171 | + $cm = \OC::$server->getContactsManager(); |
|
172 | + return $cm->getAddressBooks(); |
|
173 | + } |
|
174 | 174 | |
175 | - /** |
|
176 | - * removes all registered address book instances |
|
177 | - * @deprecated 8.1.0 use clear() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
178 | - * @since 5.0.0 |
|
179 | - */ |
|
180 | - public static function clear() { |
|
181 | - $cm = \OC::$server->getContactsManager(); |
|
182 | - $cm->clear(); |
|
183 | - } |
|
184 | - } |
|
175 | + /** |
|
176 | + * removes all registered address book instances |
|
177 | + * @deprecated 8.1.0 use clear() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
178 | + * @since 5.0.0 |
|
179 | + */ |
|
180 | + public static function clear() { |
|
181 | + $cm = \OC::$server->getContactsManager(); |
|
182 | + $cm->clear(); |
|
183 | + } |
|
184 | + } |
|
185 | 185 | } |
@@ -29,31 +29,31 @@ |
||
29 | 29 | * @since 8.1.0 |
30 | 30 | */ |
31 | 31 | interface IProvider { |
32 | - /** |
|
33 | - * @return string Regex with the mimetypes that are supported by this provider |
|
34 | - * @since 8.1.0 |
|
35 | - */ |
|
36 | - public function getMimeType(); |
|
32 | + /** |
|
33 | + * @return string Regex with the mimetypes that are supported by this provider |
|
34 | + * @since 8.1.0 |
|
35 | + */ |
|
36 | + public function getMimeType(); |
|
37 | 37 | |
38 | - /** |
|
39 | - * Check if a preview can be generated for $path |
|
40 | - * |
|
41 | - * @param \OCP\Files\FileInfo $file |
|
42 | - * @return bool |
|
43 | - * @since 8.1.0 |
|
44 | - */ |
|
45 | - public function isAvailable(\OCP\Files\FileInfo $file); |
|
38 | + /** |
|
39 | + * Check if a preview can be generated for $path |
|
40 | + * |
|
41 | + * @param \OCP\Files\FileInfo $file |
|
42 | + * @return bool |
|
43 | + * @since 8.1.0 |
|
44 | + */ |
|
45 | + public function isAvailable(\OCP\Files\FileInfo $file); |
|
46 | 46 | |
47 | - /** |
|
48 | - * get thumbnail for file at path $path |
|
49 | - * |
|
50 | - * @param string $path Path of file |
|
51 | - * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image |
|
52 | - * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image |
|
53 | - * @param bool $scalingup Disable/Enable upscaling of previews |
|
54 | - * @param \OC\Files\View $fileview fileview object of user folder |
|
55 | - * @return bool|\OCP\IImage false if no preview was generated |
|
56 | - * @since 8.1.0 |
|
57 | - */ |
|
58 | - public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview); |
|
47 | + /** |
|
48 | + * get thumbnail for file at path $path |
|
49 | + * |
|
50 | + * @param string $path Path of file |
|
51 | + * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image |
|
52 | + * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image |
|
53 | + * @param bool $scalingup Disable/Enable upscaling of previews |
|
54 | + * @param \OC\Files\View $fileview fileview object of user folder |
|
55 | + * @return bool|\OCP\IImage false if no preview was generated |
|
56 | + * @since 8.1.0 |
|
57 | + */ |
|
58 | + public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview); |
|
59 | 59 | } |
@@ -45,102 +45,102 @@ |
||
45 | 45 | * @since 4.5.0 |
46 | 46 | */ |
47 | 47 | class DB { |
48 | - /** |
|
49 | - * Prepare a SQL query |
|
50 | - * @param string $query Query string |
|
51 | - * @param int $limit Limit of the SQL statement |
|
52 | - * @param int $offset Offset of the SQL statement |
|
53 | - * @return \OC_DB_StatementWrapper prepared SQL query |
|
54 | - * |
|
55 | - * SQL query via Doctrine prepare(), needs to be execute()'d! |
|
56 | - * @deprecated 8.1.0 use prepare() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
57 | - * @since 4.5.0 |
|
58 | - */ |
|
59 | - static public function prepare( $query, $limit=null, $offset=null ) { |
|
60 | - return(\OC_DB::prepare($query, $limit, $offset)); |
|
61 | - } |
|
48 | + /** |
|
49 | + * Prepare a SQL query |
|
50 | + * @param string $query Query string |
|
51 | + * @param int $limit Limit of the SQL statement |
|
52 | + * @param int $offset Offset of the SQL statement |
|
53 | + * @return \OC_DB_StatementWrapper prepared SQL query |
|
54 | + * |
|
55 | + * SQL query via Doctrine prepare(), needs to be execute()'d! |
|
56 | + * @deprecated 8.1.0 use prepare() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
57 | + * @since 4.5.0 |
|
58 | + */ |
|
59 | + static public function prepare( $query, $limit=null, $offset=null ) { |
|
60 | + return(\OC_DB::prepare($query, $limit, $offset)); |
|
61 | + } |
|
62 | 62 | |
63 | - /** |
|
64 | - * Insert a row if the matching row does not exists. |
|
65 | - * |
|
66 | - * @param string $table The table name (will replace *PREFIX* with the actual prefix) |
|
67 | - * @param array $input data that should be inserted into the table (column name => value) |
|
68 | - * @param array|null $compare List of values that should be checked for "if not exists" |
|
69 | - * If this is null or an empty array, all keys of $input will be compared |
|
70 | - * @return int number of inserted rows |
|
71 | - * @throws \Doctrine\DBAL\DBALException |
|
72 | - * @deprecated 8.1.0 use insertIfNotExist() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
73 | - * @since 5.0.0 - parameter $compare was added in 8.1.0 |
|
74 | - * |
|
75 | - */ |
|
76 | - public static function insertIfNotExist($table, $input, array $compare = null) { |
|
77 | - return \OC::$server->getDatabaseConnection()->insertIfNotExist($table, $input, $compare); |
|
78 | - } |
|
63 | + /** |
|
64 | + * Insert a row if the matching row does not exists. |
|
65 | + * |
|
66 | + * @param string $table The table name (will replace *PREFIX* with the actual prefix) |
|
67 | + * @param array $input data that should be inserted into the table (column name => value) |
|
68 | + * @param array|null $compare List of values that should be checked for "if not exists" |
|
69 | + * If this is null or an empty array, all keys of $input will be compared |
|
70 | + * @return int number of inserted rows |
|
71 | + * @throws \Doctrine\DBAL\DBALException |
|
72 | + * @deprecated 8.1.0 use insertIfNotExist() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
73 | + * @since 5.0.0 - parameter $compare was added in 8.1.0 |
|
74 | + * |
|
75 | + */ |
|
76 | + public static function insertIfNotExist($table, $input, array $compare = null) { |
|
77 | + return \OC::$server->getDatabaseConnection()->insertIfNotExist($table, $input, $compare); |
|
78 | + } |
|
79 | 79 | |
80 | - /** |
|
81 | - * Gets last value of autoincrement |
|
82 | - * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix |
|
83 | - * @return string |
|
84 | - * |
|
85 | - * \Doctrine\DBAL\Connection lastInsertID() |
|
86 | - * |
|
87 | - * Call this method right after the insert command or other functions may |
|
88 | - * cause trouble! |
|
89 | - * @deprecated 8.1.0 use lastInsertId() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
90 | - * @since 4.5.0 |
|
91 | - */ |
|
92 | - public static function insertid($table=null) { |
|
93 | - return \OC::$server->getDatabaseConnection()->lastInsertId($table); |
|
94 | - } |
|
80 | + /** |
|
81 | + * Gets last value of autoincrement |
|
82 | + * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix |
|
83 | + * @return string |
|
84 | + * |
|
85 | + * \Doctrine\DBAL\Connection lastInsertID() |
|
86 | + * |
|
87 | + * Call this method right after the insert command or other functions may |
|
88 | + * cause trouble! |
|
89 | + * @deprecated 8.1.0 use lastInsertId() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
90 | + * @since 4.5.0 |
|
91 | + */ |
|
92 | + public static function insertid($table=null) { |
|
93 | + return \OC::$server->getDatabaseConnection()->lastInsertId($table); |
|
94 | + } |
|
95 | 95 | |
96 | - /** |
|
97 | - * Start a transaction |
|
98 | - * @deprecated 8.1.0 use beginTransaction() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
99 | - * @since 4.5.0 |
|
100 | - */ |
|
101 | - public static function beginTransaction() { |
|
102 | - \OC::$server->getDatabaseConnection()->beginTransaction(); |
|
103 | - } |
|
96 | + /** |
|
97 | + * Start a transaction |
|
98 | + * @deprecated 8.1.0 use beginTransaction() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
99 | + * @since 4.5.0 |
|
100 | + */ |
|
101 | + public static function beginTransaction() { |
|
102 | + \OC::$server->getDatabaseConnection()->beginTransaction(); |
|
103 | + } |
|
104 | 104 | |
105 | - /** |
|
106 | - * Commit the database changes done during a transaction that is in progress |
|
107 | - * @deprecated 8.1.0 use commit() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
108 | - * @since 4.5.0 |
|
109 | - */ |
|
110 | - public static function commit() { |
|
111 | - \OC::$server->getDatabaseConnection()->commit(); |
|
112 | - } |
|
105 | + /** |
|
106 | + * Commit the database changes done during a transaction that is in progress |
|
107 | + * @deprecated 8.1.0 use commit() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
108 | + * @since 4.5.0 |
|
109 | + */ |
|
110 | + public static function commit() { |
|
111 | + \OC::$server->getDatabaseConnection()->commit(); |
|
112 | + } |
|
113 | 113 | |
114 | - /** |
|
115 | - * Rollback the database changes done during a transaction that is in progress |
|
116 | - * @deprecated 8.1.0 use rollback() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
117 | - * @since 8.0.0 |
|
118 | - */ |
|
119 | - public static function rollback() { |
|
120 | - \OC::$server->getDatabaseConnection()->rollback(); |
|
121 | - } |
|
114 | + /** |
|
115 | + * Rollback the database changes done during a transaction that is in progress |
|
116 | + * @deprecated 8.1.0 use rollback() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
117 | + * @since 8.0.0 |
|
118 | + */ |
|
119 | + public static function rollback() { |
|
120 | + \OC::$server->getDatabaseConnection()->rollback(); |
|
121 | + } |
|
122 | 122 | |
123 | - /** |
|
124 | - * Check if a result is an error, works with Doctrine |
|
125 | - * @param mixed $result |
|
126 | - * @return bool |
|
127 | - * @deprecated 8.1.0 Doctrine returns false on error (and throws an exception) |
|
128 | - * @since 4.5.0 |
|
129 | - */ |
|
130 | - public static function isError($result) { |
|
131 | - // Doctrine returns false on error (and throws an exception) |
|
132 | - return $result === false; |
|
133 | - } |
|
123 | + /** |
|
124 | + * Check if a result is an error, works with Doctrine |
|
125 | + * @param mixed $result |
|
126 | + * @return bool |
|
127 | + * @deprecated 8.1.0 Doctrine returns false on error (and throws an exception) |
|
128 | + * @since 4.5.0 |
|
129 | + */ |
|
130 | + public static function isError($result) { |
|
131 | + // Doctrine returns false on error (and throws an exception) |
|
132 | + return $result === false; |
|
133 | + } |
|
134 | 134 | |
135 | - /** |
|
136 | - * returns the error code and message as a string for logging |
|
137 | - * works with DoctrineException |
|
138 | - * @return string |
|
139 | - * @deprecated 8.1.0 use getError() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
140 | - * @since 6.0.0 |
|
141 | - */ |
|
142 | - public static function getErrorMessage() { |
|
143 | - return \OC::$server->getDatabaseConnection()->getError(); |
|
144 | - } |
|
135 | + /** |
|
136 | + * returns the error code and message as a string for logging |
|
137 | + * works with DoctrineException |
|
138 | + * @return string |
|
139 | + * @deprecated 8.1.0 use getError() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
140 | + * @since 6.0.0 |
|
141 | + */ |
|
142 | + public static function getErrorMessage() { |
|
143 | + return \OC::$server->getDatabaseConnection()->getError(); |
|
144 | + } |
|
145 | 145 | |
146 | 146 | } |
@@ -56,7 +56,7 @@ discard block |
||
56 | 56 | * @deprecated 8.1.0 use prepare() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
57 | 57 | * @since 4.5.0 |
58 | 58 | */ |
59 | - static public function prepare( $query, $limit=null, $offset=null ) { |
|
59 | + static public function prepare($query, $limit = null, $offset = null) { |
|
60 | 60 | return(\OC_DB::prepare($query, $limit, $offset)); |
61 | 61 | } |
62 | 62 | |
@@ -89,7 +89,7 @@ discard block |
||
89 | 89 | * @deprecated 8.1.0 use lastInsertId() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
90 | 90 | * @since 4.5.0 |
91 | 91 | */ |
92 | - public static function insertid($table=null) { |
|
92 | + public static function insertid($table = null) { |
|
93 | 93 | return \OC::$server->getDatabaseConnection()->lastInsertId($table); |
94 | 94 | } |
95 | 95 |
@@ -50,136 +50,136 @@ |
||
50 | 50 | * @since 4.5.0 |
51 | 51 | */ |
52 | 52 | class BackgroundJob { |
53 | - /** |
|
54 | - * get the execution type of background jobs |
|
55 | - * |
|
56 | - * @return string |
|
57 | - * |
|
58 | - * This method returns the type how background jobs are executed. If the user |
|
59 | - * did not select something, the type is ajax. |
|
60 | - * @since 5.0.0 |
|
61 | - */ |
|
62 | - public static function getExecutionType() { |
|
63 | - return \OC::$server->getConfig()->getAppValue('core', 'backgroundjobs_mode', 'ajax'); |
|
64 | - } |
|
53 | + /** |
|
54 | + * get the execution type of background jobs |
|
55 | + * |
|
56 | + * @return string |
|
57 | + * |
|
58 | + * This method returns the type how background jobs are executed. If the user |
|
59 | + * did not select something, the type is ajax. |
|
60 | + * @since 5.0.0 |
|
61 | + */ |
|
62 | + public static function getExecutionType() { |
|
63 | + return \OC::$server->getConfig()->getAppValue('core', 'backgroundjobs_mode', 'ajax'); |
|
64 | + } |
|
65 | 65 | |
66 | - /** |
|
67 | - * sets the background jobs execution type |
|
68 | - * |
|
69 | - * @param string $type execution type |
|
70 | - * @return false|null |
|
71 | - * |
|
72 | - * This method sets the execution type of the background jobs. Possible types |
|
73 | - * are "none", "ajax", "webcron", "cron" |
|
74 | - * @since 5.0.0 |
|
75 | - */ |
|
76 | - public static function setExecutionType($type) { |
|
77 | - if( !in_array( $type, array('none', 'ajax', 'webcron', 'cron'))) { |
|
78 | - return false; |
|
79 | - } |
|
80 | - \OC::$server->getConfig()->setAppValue('core', 'backgroundjobs_mode', $type); |
|
81 | - } |
|
66 | + /** |
|
67 | + * sets the background jobs execution type |
|
68 | + * |
|
69 | + * @param string $type execution type |
|
70 | + * @return false|null |
|
71 | + * |
|
72 | + * This method sets the execution type of the background jobs. Possible types |
|
73 | + * are "none", "ajax", "webcron", "cron" |
|
74 | + * @since 5.0.0 |
|
75 | + */ |
|
76 | + public static function setExecutionType($type) { |
|
77 | + if( !in_array( $type, array('none', 'ajax', 'webcron', 'cron'))) { |
|
78 | + return false; |
|
79 | + } |
|
80 | + \OC::$server->getConfig()->setAppValue('core', 'backgroundjobs_mode', $type); |
|
81 | + } |
|
82 | 82 | |
83 | - /** |
|
84 | - * @param string $job |
|
85 | - * @param mixed $argument |
|
86 | - * @deprecated 8.1.0 Use \OC::$server->getJobList()->add() instead |
|
87 | - * @since 6.0.0 |
|
88 | - */ |
|
89 | - public static function registerJob($job, $argument = null) { |
|
90 | - $jobList = \OC::$server->getJobList(); |
|
91 | - $jobList->add($job, $argument); |
|
92 | - } |
|
83 | + /** |
|
84 | + * @param string $job |
|
85 | + * @param mixed $argument |
|
86 | + * @deprecated 8.1.0 Use \OC::$server->getJobList()->add() instead |
|
87 | + * @since 6.0.0 |
|
88 | + */ |
|
89 | + public static function registerJob($job, $argument = null) { |
|
90 | + $jobList = \OC::$server->getJobList(); |
|
91 | + $jobList->add($job, $argument); |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * @deprecated 6.0.0 |
|
96 | - * creates a regular task |
|
97 | - * @param string $klass class name |
|
98 | - * @param string $method method name |
|
99 | - * @return boolean|null |
|
100 | - * @since 4.5.0 |
|
101 | - */ |
|
102 | - public static function addRegularTask($klass, $method) { |
|
103 | - if (!\OC::needUpgrade()) { |
|
104 | - self::registerJob('OC\BackgroundJob\Legacy\RegularJob', array($klass, $method)); |
|
105 | - return true; |
|
106 | - } |
|
107 | - } |
|
94 | + /** |
|
95 | + * @deprecated 6.0.0 |
|
96 | + * creates a regular task |
|
97 | + * @param string $klass class name |
|
98 | + * @param string $method method name |
|
99 | + * @return boolean|null |
|
100 | + * @since 4.5.0 |
|
101 | + */ |
|
102 | + public static function addRegularTask($klass, $method) { |
|
103 | + if (!\OC::needUpgrade()) { |
|
104 | + self::registerJob('OC\BackgroundJob\Legacy\RegularJob', array($klass, $method)); |
|
105 | + return true; |
|
106 | + } |
|
107 | + } |
|
108 | 108 | |
109 | - /** |
|
110 | - * @deprecated 6.0.0 |
|
111 | - * gets all regular tasks |
|
112 | - * @return array |
|
113 | - * |
|
114 | - * key is string "$klass-$method", value is array( $klass, $method ) |
|
115 | - * @since 4.5.0 |
|
116 | - */ |
|
117 | - static public function allRegularTasks() { |
|
118 | - return []; |
|
119 | - } |
|
109 | + /** |
|
110 | + * @deprecated 6.0.0 |
|
111 | + * gets all regular tasks |
|
112 | + * @return array |
|
113 | + * |
|
114 | + * key is string "$klass-$method", value is array( $klass, $method ) |
|
115 | + * @since 4.5.0 |
|
116 | + */ |
|
117 | + static public function allRegularTasks() { |
|
118 | + return []; |
|
119 | + } |
|
120 | 120 | |
121 | - /** |
|
122 | - * @deprecated 6.0.0 |
|
123 | - * Gets one queued task |
|
124 | - * @param int $id ID of the task |
|
125 | - * @return BackgroundJob\IJob|null |
|
126 | - * @since 4.5.0 |
|
127 | - */ |
|
128 | - public static function findQueuedTask($id) { |
|
129 | - $jobList = \OC::$server->getJobList(); |
|
130 | - return $jobList->getById($id); |
|
131 | - } |
|
121 | + /** |
|
122 | + * @deprecated 6.0.0 |
|
123 | + * Gets one queued task |
|
124 | + * @param int $id ID of the task |
|
125 | + * @return BackgroundJob\IJob|null |
|
126 | + * @since 4.5.0 |
|
127 | + */ |
|
128 | + public static function findQueuedTask($id) { |
|
129 | + $jobList = \OC::$server->getJobList(); |
|
130 | + return $jobList->getById($id); |
|
131 | + } |
|
132 | 132 | |
133 | - /** |
|
134 | - * @deprecated 6.0.0 |
|
135 | - * Gets all queued tasks |
|
136 | - * @return array an array of associative arrays |
|
137 | - * @since 4.5.0 |
|
138 | - */ |
|
139 | - public static function allQueuedTasks() { |
|
140 | - return []; |
|
141 | - } |
|
133 | + /** |
|
134 | + * @deprecated 6.0.0 |
|
135 | + * Gets all queued tasks |
|
136 | + * @return array an array of associative arrays |
|
137 | + * @since 4.5.0 |
|
138 | + */ |
|
139 | + public static function allQueuedTasks() { |
|
140 | + return []; |
|
141 | + } |
|
142 | 142 | |
143 | - /** |
|
144 | - * @deprecated 6.0.0 |
|
145 | - * Gets all queued tasks of a specific app |
|
146 | - * @param string $app app name |
|
147 | - * @return array an array of associative arrays |
|
148 | - * @since 4.5.0 |
|
149 | - */ |
|
150 | - public static function queuedTaskWhereAppIs($app) { |
|
151 | - return []; |
|
152 | - } |
|
143 | + /** |
|
144 | + * @deprecated 6.0.0 |
|
145 | + * Gets all queued tasks of a specific app |
|
146 | + * @param string $app app name |
|
147 | + * @return array an array of associative arrays |
|
148 | + * @since 4.5.0 |
|
149 | + */ |
|
150 | + public static function queuedTaskWhereAppIs($app) { |
|
151 | + return []; |
|
152 | + } |
|
153 | 153 | |
154 | - /** |
|
155 | - * @deprecated 6.0.0 |
|
156 | - * queues a task |
|
157 | - * @param string $app app name |
|
158 | - * @param string $class class name |
|
159 | - * @param string $method method name |
|
160 | - * @param string $parameters all useful data as text |
|
161 | - * @return boolean id of task |
|
162 | - * @since 4.5.0 |
|
163 | - */ |
|
164 | - public static function addQueuedTask($app, $class, $method, $parameters) { |
|
165 | - self::registerJob('OC\BackgroundJob\Legacy\QueuedJob', array('app' => $app, 'klass' => $class, 'method' => $method, 'parameters' => $parameters)); |
|
166 | - return true; |
|
167 | - } |
|
154 | + /** |
|
155 | + * @deprecated 6.0.0 |
|
156 | + * queues a task |
|
157 | + * @param string $app app name |
|
158 | + * @param string $class class name |
|
159 | + * @param string $method method name |
|
160 | + * @param string $parameters all useful data as text |
|
161 | + * @return boolean id of task |
|
162 | + * @since 4.5.0 |
|
163 | + */ |
|
164 | + public static function addQueuedTask($app, $class, $method, $parameters) { |
|
165 | + self::registerJob('OC\BackgroundJob\Legacy\QueuedJob', array('app' => $app, 'klass' => $class, 'method' => $method, 'parameters' => $parameters)); |
|
166 | + return true; |
|
167 | + } |
|
168 | 168 | |
169 | - /** |
|
170 | - * @deprecated 6.0.0 |
|
171 | - * deletes a queued task |
|
172 | - * @param int $id id of task |
|
173 | - * @return boolean|null |
|
174 | - * |
|
175 | - * Deletes a report |
|
176 | - * @since 4.5.0 |
|
177 | - */ |
|
178 | - public static function deleteQueuedTask($id) { |
|
179 | - $jobList = \OC::$server->getJobList(); |
|
180 | - $job = $jobList->getById($id); |
|
181 | - if ($job) { |
|
182 | - $jobList->remove($job); |
|
183 | - } |
|
184 | - } |
|
169 | + /** |
|
170 | + * @deprecated 6.0.0 |
|
171 | + * deletes a queued task |
|
172 | + * @param int $id id of task |
|
173 | + * @return boolean|null |
|
174 | + * |
|
175 | + * Deletes a report |
|
176 | + * @since 4.5.0 |
|
177 | + */ |
|
178 | + public static function deleteQueuedTask($id) { |
|
179 | + $jobList = \OC::$server->getJobList(); |
|
180 | + $job = $jobList->getById($id); |
|
181 | + if ($job) { |
|
182 | + $jobList->remove($job); |
|
183 | + } |
|
184 | + } |
|
185 | 185 | } |
@@ -74,7 +74,7 @@ |
||
74 | 74 | * @since 5.0.0 |
75 | 75 | */ |
76 | 76 | public static function setExecutionType($type) { |
77 | - if( !in_array( $type, array('none', 'ajax', 'webcron', 'cron'))) { |
|
77 | + if (!in_array($type, array('none', 'ajax', 'webcron', 'cron'))) { |
|
78 | 78 | return false; |
79 | 79 | } |
80 | 80 | \OC::$server->getConfig()->setAppValue('core', 'backgroundjobs_mode', $type); |
@@ -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 | } |
@@ -37,7 +37,7 @@ discard block |
||
37 | 37 | * @param int $limit the maximum number of rows |
38 | 38 | * @param int $offset from which row we want to start |
39 | 39 | * @return \OC_DB_StatementWrapper prepared SQL query |
40 | - * @since 7.0.0 |
|
40 | + * @since 7.0.0 |
|
41 | 41 | */ |
42 | 42 | public function prepareQuery($sql, $limit=null, $offset=null); |
43 | 43 | |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | * Used to get the id of the just inserted element |
47 | 47 | * @param string $tableName the name of the table where we inserted the item |
48 | 48 | * @return int the id of the inserted element |
49 | - * @since 7.0.0 |
|
49 | + * @since 7.0.0 |
|
50 | 50 | */ |
51 | 51 | public function getInsertId($tableName); |
52 | 52 |
@@ -39,7 +39,7 @@ |
||
39 | 39 | * @return \OC_DB_StatementWrapper prepared SQL query |
40 | 40 | * @since 7.0.0 |
41 | 41 | */ |
42 | - public function prepareQuery($sql, $limit=null, $offset=null); |
|
42 | + public function prepareQuery($sql, $limit = null, $offset = null); |
|
43 | 43 | |
44 | 44 | |
45 | 45 | /** |
@@ -56,468 +56,468 @@ |
||
56 | 56 | */ |
57 | 57 | interface IServerContainer { |
58 | 58 | |
59 | - /** |
|
60 | - * The contacts manager will act as a broker between consumers for contacts information and |
|
61 | - * providers which actual deliver the contact information. |
|
62 | - * |
|
63 | - * @return \OCP\Contacts\IManager |
|
64 | - * @since 6.0.0 |
|
65 | - */ |
|
66 | - public function getContactsManager(); |
|
67 | - |
|
68 | - /** |
|
69 | - * The current request object holding all information about the request currently being processed |
|
70 | - * is returned from this method. |
|
71 | - * In case the current execution was not initiated by a web request null is returned |
|
72 | - * |
|
73 | - * @return \OCP\IRequest |
|
74 | - * @since 6.0.0 |
|
75 | - */ |
|
76 | - public function getRequest(); |
|
77 | - |
|
78 | - /** |
|
79 | - * Returns the preview manager which can create preview images for a given file |
|
80 | - * |
|
81 | - * @return \OCP\IPreview |
|
82 | - * @since 6.0.0 |
|
83 | - */ |
|
84 | - public function getPreviewManager(); |
|
85 | - |
|
86 | - /** |
|
87 | - * Returns the tag manager which can get and set tags for different object types |
|
88 | - * |
|
89 | - * @see \OCP\ITagManager::load() |
|
90 | - * @return \OCP\ITagManager |
|
91 | - * @since 6.0.0 |
|
92 | - */ |
|
93 | - public function getTagManager(); |
|
94 | - |
|
95 | - /** |
|
96 | - * Returns the root folder of ownCloud's data directory |
|
97 | - * |
|
98 | - * @return \OCP\Files\IRootFolder |
|
99 | - * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder |
|
100 | - */ |
|
101 | - public function getRootFolder(); |
|
102 | - |
|
103 | - /** |
|
104 | - * Returns a view to ownCloud's files folder |
|
105 | - * |
|
106 | - * @param string $userId user ID |
|
107 | - * @return \OCP\Files\Folder |
|
108 | - * @since 6.0.0 - parameter $userId was added in 8.0.0 |
|
109 | - * @see getUserFolder in \OCP\Files\IRootFolder |
|
110 | - */ |
|
111 | - public function getUserFolder($userId = null); |
|
112 | - |
|
113 | - /** |
|
114 | - * Returns an app-specific view in ownClouds data directory |
|
115 | - * |
|
116 | - * @return \OCP\Files\Folder |
|
117 | - * @since 6.0.0 |
|
118 | - */ |
|
119 | - public function getAppFolder(); |
|
120 | - |
|
121 | - /** |
|
122 | - * Returns a user manager |
|
123 | - * |
|
124 | - * @return \OCP\IUserManager |
|
125 | - * @since 8.0.0 |
|
126 | - */ |
|
127 | - public function getUserManager(); |
|
128 | - |
|
129 | - /** |
|
130 | - * Returns a group manager |
|
131 | - * |
|
132 | - * @return \OCP\IGroupManager |
|
133 | - * @since 8.0.0 |
|
134 | - */ |
|
135 | - public function getGroupManager(); |
|
136 | - |
|
137 | - /** |
|
138 | - * Returns the user session |
|
139 | - * |
|
140 | - * @return \OCP\IUserSession |
|
141 | - * @since 6.0.0 |
|
142 | - */ |
|
143 | - public function getUserSession(); |
|
144 | - |
|
145 | - /** |
|
146 | - * Returns the navigation manager |
|
147 | - * |
|
148 | - * @return \OCP\INavigationManager |
|
149 | - * @since 6.0.0 |
|
150 | - */ |
|
151 | - public function getNavigationManager(); |
|
152 | - |
|
153 | - /** |
|
154 | - * Returns the config manager |
|
155 | - * |
|
156 | - * @return \OCP\IConfig |
|
157 | - * @since 6.0.0 |
|
158 | - */ |
|
159 | - public function getConfig(); |
|
160 | - |
|
161 | - /** |
|
162 | - * Returns a Crypto instance |
|
163 | - * |
|
164 | - * @return \OCP\Security\ICrypto |
|
165 | - * @since 8.0.0 |
|
166 | - */ |
|
167 | - public function getCrypto(); |
|
168 | - |
|
169 | - /** |
|
170 | - * Returns a Hasher instance |
|
171 | - * |
|
172 | - * @return \OCP\Security\IHasher |
|
173 | - * @since 8.0.0 |
|
174 | - */ |
|
175 | - public function getHasher(); |
|
176 | - |
|
177 | - /** |
|
178 | - * Returns a SecureRandom instance |
|
179 | - * |
|
180 | - * @return \OCP\Security\ISecureRandom |
|
181 | - * @since 8.1.0 |
|
182 | - */ |
|
183 | - public function getSecureRandom(); |
|
184 | - |
|
185 | - /** |
|
186 | - * Returns a CredentialsManager instance |
|
187 | - * |
|
188 | - * @return \OCP\Security\ICredentialsManager |
|
189 | - * @since 9.0.0 |
|
190 | - */ |
|
191 | - public function getCredentialsManager(); |
|
192 | - |
|
193 | - /** |
|
194 | - * Returns an instance of the db facade |
|
195 | - * @deprecated 8.1.0 use getDatabaseConnection, will be removed in ownCloud 10 |
|
196 | - * @return \OCP\IDb |
|
197 | - * @since 7.0.0 |
|
198 | - */ |
|
199 | - public function getDb(); |
|
200 | - |
|
201 | - /** |
|
202 | - * Returns the app config manager |
|
203 | - * |
|
204 | - * @return \OCP\IAppConfig |
|
205 | - * @since 7.0.0 |
|
206 | - */ |
|
207 | - public function getAppConfig(); |
|
208 | - |
|
209 | - /** |
|
210 | - * @return \OCP\L10N\IFactory |
|
211 | - * @since 8.2.0 |
|
212 | - */ |
|
213 | - public function getL10NFactory(); |
|
214 | - |
|
215 | - /** |
|
216 | - * get an L10N instance |
|
217 | - * @param string $app appid |
|
218 | - * @param string $lang |
|
219 | - * @return \OCP\IL10N |
|
220 | - * @since 6.0.0 - parameter $lang was added in 8.0.0 |
|
221 | - */ |
|
222 | - public function getL10N($app, $lang = null); |
|
223 | - |
|
224 | - /** |
|
225 | - * @return \OC\Encryption\Manager |
|
226 | - * @since 8.1.0 |
|
227 | - */ |
|
228 | - public function getEncryptionManager(); |
|
229 | - |
|
230 | - /** |
|
231 | - * @return \OC\Encryption\File |
|
232 | - * @since 8.1.0 |
|
233 | - */ |
|
234 | - public function getEncryptionFilesHelper(); |
|
235 | - |
|
236 | - /** |
|
237 | - * @return \OCP\Encryption\Keys\IStorage |
|
238 | - * @since 8.1.0 |
|
239 | - */ |
|
240 | - public function getEncryptionKeyStorage(); |
|
241 | - |
|
242 | - /** |
|
243 | - * Returns the URL generator |
|
244 | - * |
|
245 | - * @return \OCP\IURLGenerator |
|
246 | - * @since 6.0.0 |
|
247 | - */ |
|
248 | - public function getURLGenerator(); |
|
249 | - |
|
250 | - /** |
|
251 | - * Returns the Helper |
|
252 | - * |
|
253 | - * @return \OCP\IHelper |
|
254 | - * @since 6.0.0 |
|
255 | - */ |
|
256 | - public function getHelper(); |
|
257 | - |
|
258 | - /** |
|
259 | - * Returns an ICache instance |
|
260 | - * |
|
261 | - * @return \OCP\ICache |
|
262 | - * @since 6.0.0 |
|
263 | - */ |
|
264 | - public function getCache(); |
|
265 | - |
|
266 | - /** |
|
267 | - * Returns an \OCP\CacheFactory instance |
|
268 | - * |
|
269 | - * @return \OCP\ICacheFactory |
|
270 | - * @since 7.0.0 |
|
271 | - */ |
|
272 | - public function getMemCacheFactory(); |
|
273 | - |
|
274 | - /** |
|
275 | - * Returns the current session |
|
276 | - * |
|
277 | - * @return \OCP\ISession |
|
278 | - * @since 6.0.0 |
|
279 | - */ |
|
280 | - public function getSession(); |
|
281 | - |
|
282 | - /** |
|
283 | - * Returns the activity manager |
|
284 | - * |
|
285 | - * @return \OCP\Activity\IManager |
|
286 | - * @since 6.0.0 |
|
287 | - */ |
|
288 | - public function getActivityManager(); |
|
289 | - |
|
290 | - /** |
|
291 | - * Returns the current session |
|
292 | - * |
|
293 | - * @return \OCP\IDBConnection |
|
294 | - * @since 6.0.0 |
|
295 | - */ |
|
296 | - public function getDatabaseConnection(); |
|
297 | - |
|
298 | - /** |
|
299 | - * Returns an avatar manager, used for avatar functionality |
|
300 | - * |
|
301 | - * @return \OCP\IAvatarManager |
|
302 | - * @since 6.0.0 |
|
303 | - */ |
|
304 | - public function getAvatarManager(); |
|
305 | - |
|
306 | - /** |
|
307 | - * Returns an job list for controlling background jobs |
|
308 | - * |
|
309 | - * @return \OCP\BackgroundJob\IJobList |
|
310 | - * @since 7.0.0 |
|
311 | - */ |
|
312 | - public function getJobList(); |
|
313 | - |
|
314 | - /** |
|
315 | - * Returns a logger instance |
|
316 | - * |
|
317 | - * @return \OCP\ILogger |
|
318 | - * @since 8.0.0 |
|
319 | - */ |
|
320 | - public function getLogger(); |
|
321 | - |
|
322 | - /** |
|
323 | - * Returns a router for generating and matching urls |
|
324 | - * |
|
325 | - * @return \OCP\Route\IRouter |
|
326 | - * @since 7.0.0 |
|
327 | - */ |
|
328 | - public function getRouter(); |
|
329 | - |
|
330 | - /** |
|
331 | - * Returns a search instance |
|
332 | - * |
|
333 | - * @return \OCP\ISearch |
|
334 | - * @since 7.0.0 |
|
335 | - */ |
|
336 | - public function getSearch(); |
|
337 | - |
|
338 | - /** |
|
339 | - * Get the certificate manager for the user |
|
340 | - * |
|
341 | - * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager |
|
342 | - * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in |
|
343 | - * @since 8.0.0 |
|
344 | - */ |
|
345 | - public function getCertificateManager($userId = null); |
|
346 | - |
|
347 | - /** |
|
348 | - * Create a new event source |
|
349 | - * |
|
350 | - * @return \OCP\IEventSource |
|
351 | - * @since 8.0.0 |
|
352 | - */ |
|
353 | - public function createEventSource(); |
|
354 | - |
|
355 | - /** |
|
356 | - * Returns an instance of the HTTP helper class |
|
357 | - * @return \OC\HTTPHelper |
|
358 | - * @deprecated 8.1.0 Use \OCP\Http\Client\IClientService |
|
359 | - * @since 8.0.0 |
|
360 | - */ |
|
361 | - public function getHTTPHelper(); |
|
362 | - |
|
363 | - /** |
|
364 | - * Returns an instance of the HTTP client service |
|
365 | - * |
|
366 | - * @return \OCP\Http\Client\IClientService |
|
367 | - * @since 8.1.0 |
|
368 | - */ |
|
369 | - public function getHTTPClientService(); |
|
370 | - |
|
371 | - /** |
|
372 | - * Get the active event logger |
|
373 | - * |
|
374 | - * @return \OCP\Diagnostics\IEventLogger |
|
375 | - * @since 8.0.0 |
|
376 | - */ |
|
377 | - public function getEventLogger(); |
|
378 | - |
|
379 | - /** |
|
380 | - * Get the active query logger |
|
381 | - * |
|
382 | - * The returned logger only logs data when debug mode is enabled |
|
383 | - * |
|
384 | - * @return \OCP\Diagnostics\IQueryLogger |
|
385 | - * @since 8.0.0 |
|
386 | - */ |
|
387 | - public function getQueryLogger(); |
|
388 | - |
|
389 | - /** |
|
390 | - * Get the manager for temporary files and folders |
|
391 | - * |
|
392 | - * @return \OCP\ITempManager |
|
393 | - * @since 8.0.0 |
|
394 | - */ |
|
395 | - public function getTempManager(); |
|
396 | - |
|
397 | - /** |
|
398 | - * Get the app manager |
|
399 | - * |
|
400 | - * @return \OCP\App\IAppManager |
|
401 | - * @since 8.0.0 |
|
402 | - */ |
|
403 | - public function getAppManager(); |
|
404 | - |
|
405 | - /** |
|
406 | - * Get the webroot |
|
407 | - * |
|
408 | - * @return string |
|
409 | - * @since 8.0.0 |
|
410 | - */ |
|
411 | - public function getWebRoot(); |
|
412 | - |
|
413 | - /** |
|
414 | - * @return \OCP\Files\Config\IMountProviderCollection |
|
415 | - * @since 8.0.0 |
|
416 | - */ |
|
417 | - public function getMountProviderCollection(); |
|
418 | - |
|
419 | - /** |
|
420 | - * Get the IniWrapper |
|
421 | - * |
|
422 | - * @return \bantu\IniGetWrapper\IniGetWrapper |
|
423 | - * @since 8.0.0 |
|
424 | - */ |
|
425 | - public function getIniWrapper(); |
|
426 | - /** |
|
427 | - * @return \OCP\Command\IBus |
|
428 | - * @since 8.1.0 |
|
429 | - */ |
|
430 | - public function getCommandBus(); |
|
431 | - |
|
432 | - /** |
|
433 | - * Creates a new mailer |
|
434 | - * |
|
435 | - * @return \OCP\Mail\IMailer |
|
436 | - * @since 8.1.0 |
|
437 | - */ |
|
438 | - public function getMailer(); |
|
439 | - |
|
440 | - /** |
|
441 | - * Get the locking provider |
|
442 | - * |
|
443 | - * @return \OCP\Lock\ILockingProvider |
|
444 | - * @since 8.1.0 |
|
445 | - */ |
|
446 | - public function getLockingProvider(); |
|
447 | - |
|
448 | - /** |
|
449 | - * @return \OCP\Files\Mount\IMountManager |
|
450 | - * @since 8.2.0 |
|
451 | - */ |
|
452 | - public function getMountManager(); |
|
453 | - |
|
454 | - /** |
|
455 | - * Get the MimeTypeDetector |
|
456 | - * |
|
457 | - * @return \OCP\Files\IMimeTypeDetector |
|
458 | - * @since 8.2.0 |
|
459 | - */ |
|
460 | - public function getMimeTypeDetector(); |
|
461 | - |
|
462 | - /** |
|
463 | - * Get the MimeTypeLoader |
|
464 | - * |
|
465 | - * @return \OCP\Files\IMimeTypeLoader |
|
466 | - * @since 8.2.0 |
|
467 | - */ |
|
468 | - public function getMimeTypeLoader(); |
|
469 | - |
|
470 | - /** |
|
471 | - * Get the EventDispatcher |
|
472 | - * |
|
473 | - * @return EventDispatcherInterface |
|
474 | - * @since 8.2.0 |
|
475 | - */ |
|
476 | - public function getEventDispatcher(); |
|
477 | - |
|
478 | - /** |
|
479 | - * Get the Notification Manager |
|
480 | - * |
|
481 | - * @return \OCP\Notification\IManager |
|
482 | - * @since 9.0.0 |
|
483 | - */ |
|
484 | - public function getNotificationManager(); |
|
485 | - |
|
486 | - /** |
|
487 | - * @return \OCP\Comments\ICommentsManager |
|
488 | - * @since 9.0.0 |
|
489 | - */ |
|
490 | - public function getCommentsManager(); |
|
491 | - |
|
492 | - /** |
|
493 | - * Returns the system-tag manager |
|
494 | - * |
|
495 | - * @return \OCP\SystemTag\ISystemTagManager |
|
496 | - * |
|
497 | - * @since 9.0.0 |
|
498 | - */ |
|
499 | - public function getSystemTagManager(); |
|
500 | - |
|
501 | - /** |
|
502 | - * Returns the system-tag object mapper |
|
503 | - * |
|
504 | - * @return \OCP\SystemTag\ISystemTagObjectMapper |
|
505 | - * |
|
506 | - * @since 9.0.0 |
|
507 | - */ |
|
508 | - public function getSystemTagObjectMapper(); |
|
509 | - |
|
510 | - /** |
|
511 | - * Returns the share manager |
|
512 | - * |
|
513 | - * @return \OCP\Share\IManager |
|
514 | - * @since 9.0.0 |
|
515 | - */ |
|
516 | - public function getShareManager(); |
|
517 | - |
|
518 | - /** |
|
519 | - * @return IContentSecurityPolicyManager |
|
520 | - * @since 9.0.0 |
|
521 | - */ |
|
522 | - public function getContentSecurityPolicyManager(); |
|
59 | + /** |
|
60 | + * The contacts manager will act as a broker between consumers for contacts information and |
|
61 | + * providers which actual deliver the contact information. |
|
62 | + * |
|
63 | + * @return \OCP\Contacts\IManager |
|
64 | + * @since 6.0.0 |
|
65 | + */ |
|
66 | + public function getContactsManager(); |
|
67 | + |
|
68 | + /** |
|
69 | + * The current request object holding all information about the request currently being processed |
|
70 | + * is returned from this method. |
|
71 | + * In case the current execution was not initiated by a web request null is returned |
|
72 | + * |
|
73 | + * @return \OCP\IRequest |
|
74 | + * @since 6.0.0 |
|
75 | + */ |
|
76 | + public function getRequest(); |
|
77 | + |
|
78 | + /** |
|
79 | + * Returns the preview manager which can create preview images for a given file |
|
80 | + * |
|
81 | + * @return \OCP\IPreview |
|
82 | + * @since 6.0.0 |
|
83 | + */ |
|
84 | + public function getPreviewManager(); |
|
85 | + |
|
86 | + /** |
|
87 | + * Returns the tag manager which can get and set tags for different object types |
|
88 | + * |
|
89 | + * @see \OCP\ITagManager::load() |
|
90 | + * @return \OCP\ITagManager |
|
91 | + * @since 6.0.0 |
|
92 | + */ |
|
93 | + public function getTagManager(); |
|
94 | + |
|
95 | + /** |
|
96 | + * Returns the root folder of ownCloud's data directory |
|
97 | + * |
|
98 | + * @return \OCP\Files\IRootFolder |
|
99 | + * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder |
|
100 | + */ |
|
101 | + public function getRootFolder(); |
|
102 | + |
|
103 | + /** |
|
104 | + * Returns a view to ownCloud's files folder |
|
105 | + * |
|
106 | + * @param string $userId user ID |
|
107 | + * @return \OCP\Files\Folder |
|
108 | + * @since 6.0.0 - parameter $userId was added in 8.0.0 |
|
109 | + * @see getUserFolder in \OCP\Files\IRootFolder |
|
110 | + */ |
|
111 | + public function getUserFolder($userId = null); |
|
112 | + |
|
113 | + /** |
|
114 | + * Returns an app-specific view in ownClouds data directory |
|
115 | + * |
|
116 | + * @return \OCP\Files\Folder |
|
117 | + * @since 6.0.0 |
|
118 | + */ |
|
119 | + public function getAppFolder(); |
|
120 | + |
|
121 | + /** |
|
122 | + * Returns a user manager |
|
123 | + * |
|
124 | + * @return \OCP\IUserManager |
|
125 | + * @since 8.0.0 |
|
126 | + */ |
|
127 | + public function getUserManager(); |
|
128 | + |
|
129 | + /** |
|
130 | + * Returns a group manager |
|
131 | + * |
|
132 | + * @return \OCP\IGroupManager |
|
133 | + * @since 8.0.0 |
|
134 | + */ |
|
135 | + public function getGroupManager(); |
|
136 | + |
|
137 | + /** |
|
138 | + * Returns the user session |
|
139 | + * |
|
140 | + * @return \OCP\IUserSession |
|
141 | + * @since 6.0.0 |
|
142 | + */ |
|
143 | + public function getUserSession(); |
|
144 | + |
|
145 | + /** |
|
146 | + * Returns the navigation manager |
|
147 | + * |
|
148 | + * @return \OCP\INavigationManager |
|
149 | + * @since 6.0.0 |
|
150 | + */ |
|
151 | + public function getNavigationManager(); |
|
152 | + |
|
153 | + /** |
|
154 | + * Returns the config manager |
|
155 | + * |
|
156 | + * @return \OCP\IConfig |
|
157 | + * @since 6.0.0 |
|
158 | + */ |
|
159 | + public function getConfig(); |
|
160 | + |
|
161 | + /** |
|
162 | + * Returns a Crypto instance |
|
163 | + * |
|
164 | + * @return \OCP\Security\ICrypto |
|
165 | + * @since 8.0.0 |
|
166 | + */ |
|
167 | + public function getCrypto(); |
|
168 | + |
|
169 | + /** |
|
170 | + * Returns a Hasher instance |
|
171 | + * |
|
172 | + * @return \OCP\Security\IHasher |
|
173 | + * @since 8.0.0 |
|
174 | + */ |
|
175 | + public function getHasher(); |
|
176 | + |
|
177 | + /** |
|
178 | + * Returns a SecureRandom instance |
|
179 | + * |
|
180 | + * @return \OCP\Security\ISecureRandom |
|
181 | + * @since 8.1.0 |
|
182 | + */ |
|
183 | + public function getSecureRandom(); |
|
184 | + |
|
185 | + /** |
|
186 | + * Returns a CredentialsManager instance |
|
187 | + * |
|
188 | + * @return \OCP\Security\ICredentialsManager |
|
189 | + * @since 9.0.0 |
|
190 | + */ |
|
191 | + public function getCredentialsManager(); |
|
192 | + |
|
193 | + /** |
|
194 | + * Returns an instance of the db facade |
|
195 | + * @deprecated 8.1.0 use getDatabaseConnection, will be removed in ownCloud 10 |
|
196 | + * @return \OCP\IDb |
|
197 | + * @since 7.0.0 |
|
198 | + */ |
|
199 | + public function getDb(); |
|
200 | + |
|
201 | + /** |
|
202 | + * Returns the app config manager |
|
203 | + * |
|
204 | + * @return \OCP\IAppConfig |
|
205 | + * @since 7.0.0 |
|
206 | + */ |
|
207 | + public function getAppConfig(); |
|
208 | + |
|
209 | + /** |
|
210 | + * @return \OCP\L10N\IFactory |
|
211 | + * @since 8.2.0 |
|
212 | + */ |
|
213 | + public function getL10NFactory(); |
|
214 | + |
|
215 | + /** |
|
216 | + * get an L10N instance |
|
217 | + * @param string $app appid |
|
218 | + * @param string $lang |
|
219 | + * @return \OCP\IL10N |
|
220 | + * @since 6.0.0 - parameter $lang was added in 8.0.0 |
|
221 | + */ |
|
222 | + public function getL10N($app, $lang = null); |
|
223 | + |
|
224 | + /** |
|
225 | + * @return \OC\Encryption\Manager |
|
226 | + * @since 8.1.0 |
|
227 | + */ |
|
228 | + public function getEncryptionManager(); |
|
229 | + |
|
230 | + /** |
|
231 | + * @return \OC\Encryption\File |
|
232 | + * @since 8.1.0 |
|
233 | + */ |
|
234 | + public function getEncryptionFilesHelper(); |
|
235 | + |
|
236 | + /** |
|
237 | + * @return \OCP\Encryption\Keys\IStorage |
|
238 | + * @since 8.1.0 |
|
239 | + */ |
|
240 | + public function getEncryptionKeyStorage(); |
|
241 | + |
|
242 | + /** |
|
243 | + * Returns the URL generator |
|
244 | + * |
|
245 | + * @return \OCP\IURLGenerator |
|
246 | + * @since 6.0.0 |
|
247 | + */ |
|
248 | + public function getURLGenerator(); |
|
249 | + |
|
250 | + /** |
|
251 | + * Returns the Helper |
|
252 | + * |
|
253 | + * @return \OCP\IHelper |
|
254 | + * @since 6.0.0 |
|
255 | + */ |
|
256 | + public function getHelper(); |
|
257 | + |
|
258 | + /** |
|
259 | + * Returns an ICache instance |
|
260 | + * |
|
261 | + * @return \OCP\ICache |
|
262 | + * @since 6.0.0 |
|
263 | + */ |
|
264 | + public function getCache(); |
|
265 | + |
|
266 | + /** |
|
267 | + * Returns an \OCP\CacheFactory instance |
|
268 | + * |
|
269 | + * @return \OCP\ICacheFactory |
|
270 | + * @since 7.0.0 |
|
271 | + */ |
|
272 | + public function getMemCacheFactory(); |
|
273 | + |
|
274 | + /** |
|
275 | + * Returns the current session |
|
276 | + * |
|
277 | + * @return \OCP\ISession |
|
278 | + * @since 6.0.0 |
|
279 | + */ |
|
280 | + public function getSession(); |
|
281 | + |
|
282 | + /** |
|
283 | + * Returns the activity manager |
|
284 | + * |
|
285 | + * @return \OCP\Activity\IManager |
|
286 | + * @since 6.0.0 |
|
287 | + */ |
|
288 | + public function getActivityManager(); |
|
289 | + |
|
290 | + /** |
|
291 | + * Returns the current session |
|
292 | + * |
|
293 | + * @return \OCP\IDBConnection |
|
294 | + * @since 6.0.0 |
|
295 | + */ |
|
296 | + public function getDatabaseConnection(); |
|
297 | + |
|
298 | + /** |
|
299 | + * Returns an avatar manager, used for avatar functionality |
|
300 | + * |
|
301 | + * @return \OCP\IAvatarManager |
|
302 | + * @since 6.0.0 |
|
303 | + */ |
|
304 | + public function getAvatarManager(); |
|
305 | + |
|
306 | + /** |
|
307 | + * Returns an job list for controlling background jobs |
|
308 | + * |
|
309 | + * @return \OCP\BackgroundJob\IJobList |
|
310 | + * @since 7.0.0 |
|
311 | + */ |
|
312 | + public function getJobList(); |
|
313 | + |
|
314 | + /** |
|
315 | + * Returns a logger instance |
|
316 | + * |
|
317 | + * @return \OCP\ILogger |
|
318 | + * @since 8.0.0 |
|
319 | + */ |
|
320 | + public function getLogger(); |
|
321 | + |
|
322 | + /** |
|
323 | + * Returns a router for generating and matching urls |
|
324 | + * |
|
325 | + * @return \OCP\Route\IRouter |
|
326 | + * @since 7.0.0 |
|
327 | + */ |
|
328 | + public function getRouter(); |
|
329 | + |
|
330 | + /** |
|
331 | + * Returns a search instance |
|
332 | + * |
|
333 | + * @return \OCP\ISearch |
|
334 | + * @since 7.0.0 |
|
335 | + */ |
|
336 | + public function getSearch(); |
|
337 | + |
|
338 | + /** |
|
339 | + * Get the certificate manager for the user |
|
340 | + * |
|
341 | + * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager |
|
342 | + * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in |
|
343 | + * @since 8.0.0 |
|
344 | + */ |
|
345 | + public function getCertificateManager($userId = null); |
|
346 | + |
|
347 | + /** |
|
348 | + * Create a new event source |
|
349 | + * |
|
350 | + * @return \OCP\IEventSource |
|
351 | + * @since 8.0.0 |
|
352 | + */ |
|
353 | + public function createEventSource(); |
|
354 | + |
|
355 | + /** |
|
356 | + * Returns an instance of the HTTP helper class |
|
357 | + * @return \OC\HTTPHelper |
|
358 | + * @deprecated 8.1.0 Use \OCP\Http\Client\IClientService |
|
359 | + * @since 8.0.0 |
|
360 | + */ |
|
361 | + public function getHTTPHelper(); |
|
362 | + |
|
363 | + /** |
|
364 | + * Returns an instance of the HTTP client service |
|
365 | + * |
|
366 | + * @return \OCP\Http\Client\IClientService |
|
367 | + * @since 8.1.0 |
|
368 | + */ |
|
369 | + public function getHTTPClientService(); |
|
370 | + |
|
371 | + /** |
|
372 | + * Get the active event logger |
|
373 | + * |
|
374 | + * @return \OCP\Diagnostics\IEventLogger |
|
375 | + * @since 8.0.0 |
|
376 | + */ |
|
377 | + public function getEventLogger(); |
|
378 | + |
|
379 | + /** |
|
380 | + * Get the active query logger |
|
381 | + * |
|
382 | + * The returned logger only logs data when debug mode is enabled |
|
383 | + * |
|
384 | + * @return \OCP\Diagnostics\IQueryLogger |
|
385 | + * @since 8.0.0 |
|
386 | + */ |
|
387 | + public function getQueryLogger(); |
|
388 | + |
|
389 | + /** |
|
390 | + * Get the manager for temporary files and folders |
|
391 | + * |
|
392 | + * @return \OCP\ITempManager |
|
393 | + * @since 8.0.0 |
|
394 | + */ |
|
395 | + public function getTempManager(); |
|
396 | + |
|
397 | + /** |
|
398 | + * Get the app manager |
|
399 | + * |
|
400 | + * @return \OCP\App\IAppManager |
|
401 | + * @since 8.0.0 |
|
402 | + */ |
|
403 | + public function getAppManager(); |
|
404 | + |
|
405 | + /** |
|
406 | + * Get the webroot |
|
407 | + * |
|
408 | + * @return string |
|
409 | + * @since 8.0.0 |
|
410 | + */ |
|
411 | + public function getWebRoot(); |
|
412 | + |
|
413 | + /** |
|
414 | + * @return \OCP\Files\Config\IMountProviderCollection |
|
415 | + * @since 8.0.0 |
|
416 | + */ |
|
417 | + public function getMountProviderCollection(); |
|
418 | + |
|
419 | + /** |
|
420 | + * Get the IniWrapper |
|
421 | + * |
|
422 | + * @return \bantu\IniGetWrapper\IniGetWrapper |
|
423 | + * @since 8.0.0 |
|
424 | + */ |
|
425 | + public function getIniWrapper(); |
|
426 | + /** |
|
427 | + * @return \OCP\Command\IBus |
|
428 | + * @since 8.1.0 |
|
429 | + */ |
|
430 | + public function getCommandBus(); |
|
431 | + |
|
432 | + /** |
|
433 | + * Creates a new mailer |
|
434 | + * |
|
435 | + * @return \OCP\Mail\IMailer |
|
436 | + * @since 8.1.0 |
|
437 | + */ |
|
438 | + public function getMailer(); |
|
439 | + |
|
440 | + /** |
|
441 | + * Get the locking provider |
|
442 | + * |
|
443 | + * @return \OCP\Lock\ILockingProvider |
|
444 | + * @since 8.1.0 |
|
445 | + */ |
|
446 | + public function getLockingProvider(); |
|
447 | + |
|
448 | + /** |
|
449 | + * @return \OCP\Files\Mount\IMountManager |
|
450 | + * @since 8.2.0 |
|
451 | + */ |
|
452 | + public function getMountManager(); |
|
453 | + |
|
454 | + /** |
|
455 | + * Get the MimeTypeDetector |
|
456 | + * |
|
457 | + * @return \OCP\Files\IMimeTypeDetector |
|
458 | + * @since 8.2.0 |
|
459 | + */ |
|
460 | + public function getMimeTypeDetector(); |
|
461 | + |
|
462 | + /** |
|
463 | + * Get the MimeTypeLoader |
|
464 | + * |
|
465 | + * @return \OCP\Files\IMimeTypeLoader |
|
466 | + * @since 8.2.0 |
|
467 | + */ |
|
468 | + public function getMimeTypeLoader(); |
|
469 | + |
|
470 | + /** |
|
471 | + * Get the EventDispatcher |
|
472 | + * |
|
473 | + * @return EventDispatcherInterface |
|
474 | + * @since 8.2.0 |
|
475 | + */ |
|
476 | + public function getEventDispatcher(); |
|
477 | + |
|
478 | + /** |
|
479 | + * Get the Notification Manager |
|
480 | + * |
|
481 | + * @return \OCP\Notification\IManager |
|
482 | + * @since 9.0.0 |
|
483 | + */ |
|
484 | + public function getNotificationManager(); |
|
485 | + |
|
486 | + /** |
|
487 | + * @return \OCP\Comments\ICommentsManager |
|
488 | + * @since 9.0.0 |
|
489 | + */ |
|
490 | + public function getCommentsManager(); |
|
491 | + |
|
492 | + /** |
|
493 | + * Returns the system-tag manager |
|
494 | + * |
|
495 | + * @return \OCP\SystemTag\ISystemTagManager |
|
496 | + * |
|
497 | + * @since 9.0.0 |
|
498 | + */ |
|
499 | + public function getSystemTagManager(); |
|
500 | + |
|
501 | + /** |
|
502 | + * Returns the system-tag object mapper |
|
503 | + * |
|
504 | + * @return \OCP\SystemTag\ISystemTagObjectMapper |
|
505 | + * |
|
506 | + * @since 9.0.0 |
|
507 | + */ |
|
508 | + public function getSystemTagObjectMapper(); |
|
509 | + |
|
510 | + /** |
|
511 | + * Returns the share manager |
|
512 | + * |
|
513 | + * @return \OCP\Share\IManager |
|
514 | + * @since 9.0.0 |
|
515 | + */ |
|
516 | + public function getShareManager(); |
|
517 | + |
|
518 | + /** |
|
519 | + * @return IContentSecurityPolicyManager |
|
520 | + * @since 9.0.0 |
|
521 | + */ |
|
522 | + public function getContentSecurityPolicyManager(); |
|
523 | 523 | } |
@@ -39,127 +39,127 @@ |
||
39 | 39 | * @since 8.0.0 |
40 | 40 | */ |
41 | 41 | interface IExtension { |
42 | - const METHOD_STREAM = 'stream'; |
|
43 | - const METHOD_MAIL = 'email'; |
|
42 | + const METHOD_STREAM = 'stream'; |
|
43 | + const METHOD_MAIL = 'email'; |
|
44 | 44 | |
45 | - const PRIORITY_VERYLOW = 10; |
|
46 | - const PRIORITY_LOW = 20; |
|
47 | - const PRIORITY_MEDIUM = 30; |
|
48 | - const PRIORITY_HIGH = 40; |
|
49 | - const PRIORITY_VERYHIGH = 50; |
|
45 | + const PRIORITY_VERYLOW = 10; |
|
46 | + const PRIORITY_LOW = 20; |
|
47 | + const PRIORITY_MEDIUM = 30; |
|
48 | + const PRIORITY_HIGH = 40; |
|
49 | + const PRIORITY_VERYHIGH = 50; |
|
50 | 50 | |
51 | - /** |
|
52 | - * The extension can return an array of additional notification types. |
|
53 | - * If no additional types are to be added false is to be returned |
|
54 | - * |
|
55 | - * @param string $languageCode |
|
56 | - * @return array|false Array "stringID of the type" => "translated string description for the setting" |
|
57 | - * or Array "stringID of the type" => [ |
|
58 | - * 'desc' => "translated string description for the setting" |
|
59 | - * 'methods' => [self::METHOD_*], |
|
60 | - * ] |
|
61 | - * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods |
|
62 | - */ |
|
63 | - public function getNotificationTypes($languageCode); |
|
51 | + /** |
|
52 | + * The extension can return an array of additional notification types. |
|
53 | + * If no additional types are to be added false is to be returned |
|
54 | + * |
|
55 | + * @param string $languageCode |
|
56 | + * @return array|false Array "stringID of the type" => "translated string description for the setting" |
|
57 | + * or Array "stringID of the type" => [ |
|
58 | + * 'desc' => "translated string description for the setting" |
|
59 | + * 'methods' => [self::METHOD_*], |
|
60 | + * ] |
|
61 | + * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods |
|
62 | + */ |
|
63 | + public function getNotificationTypes($languageCode); |
|
64 | 64 | |
65 | - /** |
|
66 | - * For a given method additional types to be displayed in the settings can be returned. |
|
67 | - * In case no additional types are to be added false is to be returned. |
|
68 | - * |
|
69 | - * @param string $method |
|
70 | - * @return array|false |
|
71 | - * @since 8.0.0 |
|
72 | - */ |
|
73 | - public function getDefaultTypes($method); |
|
65 | + /** |
|
66 | + * For a given method additional types to be displayed in the settings can be returned. |
|
67 | + * In case no additional types are to be added false is to be returned. |
|
68 | + * |
|
69 | + * @param string $method |
|
70 | + * @return array|false |
|
71 | + * @since 8.0.0 |
|
72 | + */ |
|
73 | + public function getDefaultTypes($method); |
|
74 | 74 | |
75 | - /** |
|
76 | - * A string naming the css class for the icon to be used can be returned. |
|
77 | - * If no icon is known for the given type false is to be returned. |
|
78 | - * |
|
79 | - * @param string $type |
|
80 | - * @return string|false |
|
81 | - * @since 8.0.0 |
|
82 | - */ |
|
83 | - public function getTypeIcon($type); |
|
75 | + /** |
|
76 | + * A string naming the css class for the icon to be used can be returned. |
|
77 | + * If no icon is known for the given type false is to be returned. |
|
78 | + * |
|
79 | + * @param string $type |
|
80 | + * @return string|false |
|
81 | + * @since 8.0.0 |
|
82 | + */ |
|
83 | + public function getTypeIcon($type); |
|
84 | 84 | |
85 | - /** |
|
86 | - * The extension can translate a given message to the requested languages. |
|
87 | - * If no translation is available false is to be returned. |
|
88 | - * |
|
89 | - * @param string $app |
|
90 | - * @param string $text |
|
91 | - * @param array $params |
|
92 | - * @param boolean $stripPath |
|
93 | - * @param boolean $highlightParams |
|
94 | - * @param string $languageCode |
|
95 | - * @return string|false |
|
96 | - * @since 8.0.0 |
|
97 | - */ |
|
98 | - public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); |
|
85 | + /** |
|
86 | + * The extension can translate a given message to the requested languages. |
|
87 | + * If no translation is available false is to be returned. |
|
88 | + * |
|
89 | + * @param string $app |
|
90 | + * @param string $text |
|
91 | + * @param array $params |
|
92 | + * @param boolean $stripPath |
|
93 | + * @param boolean $highlightParams |
|
94 | + * @param string $languageCode |
|
95 | + * @return string|false |
|
96 | + * @since 8.0.0 |
|
97 | + */ |
|
98 | + public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); |
|
99 | 99 | |
100 | - /** |
|
101 | - * The extension can define the type of parameters for translation |
|
102 | - * |
|
103 | - * Currently known types are: |
|
104 | - * * file => will strip away the path of the file and add a tooltip with it |
|
105 | - * * username => will add the avatar of the user |
|
106 | - * |
|
107 | - * @param string $app |
|
108 | - * @param string $text |
|
109 | - * @return array|false |
|
110 | - * @since 8.0.0 |
|
111 | - */ |
|
112 | - public function getSpecialParameterList($app, $text); |
|
100 | + /** |
|
101 | + * The extension can define the type of parameters for translation |
|
102 | + * |
|
103 | + * Currently known types are: |
|
104 | + * * file => will strip away the path of the file and add a tooltip with it |
|
105 | + * * username => will add the avatar of the user |
|
106 | + * |
|
107 | + * @param string $app |
|
108 | + * @param string $text |
|
109 | + * @return array|false |
|
110 | + * @since 8.0.0 |
|
111 | + */ |
|
112 | + public function getSpecialParameterList($app, $text); |
|
113 | 113 | |
114 | - /** |
|
115 | - * The extension can define the parameter grouping by returning the index as integer. |
|
116 | - * In case no grouping is required false is to be returned. |
|
117 | - * |
|
118 | - * @param array $activity |
|
119 | - * @return integer|false |
|
120 | - * @since 8.0.0 |
|
121 | - */ |
|
122 | - public function getGroupParameter($activity); |
|
114 | + /** |
|
115 | + * The extension can define the parameter grouping by returning the index as integer. |
|
116 | + * In case no grouping is required false is to be returned. |
|
117 | + * |
|
118 | + * @param array $activity |
|
119 | + * @return integer|false |
|
120 | + * @since 8.0.0 |
|
121 | + */ |
|
122 | + public function getGroupParameter($activity); |
|
123 | 123 | |
124 | - /** |
|
125 | - * The extension can define additional navigation entries. The array returned has to contain two keys 'top' |
|
126 | - * and 'apps' which hold arrays with the relevant entries. |
|
127 | - * If no further entries are to be added false is no be returned. |
|
128 | - * |
|
129 | - * @return array|false |
|
130 | - * @since 8.0.0 |
|
131 | - */ |
|
132 | - public function getNavigation(); |
|
124 | + /** |
|
125 | + * The extension can define additional navigation entries. The array returned has to contain two keys 'top' |
|
126 | + * and 'apps' which hold arrays with the relevant entries. |
|
127 | + * If no further entries are to be added false is no be returned. |
|
128 | + * |
|
129 | + * @return array|false |
|
130 | + * @since 8.0.0 |
|
131 | + */ |
|
132 | + public function getNavigation(); |
|
133 | 133 | |
134 | - /** |
|
135 | - * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not. |
|
136 | - * |
|
137 | - * @param string $filterValue |
|
138 | - * @return boolean |
|
139 | - * @since 8.0.0 |
|
140 | - */ |
|
141 | - public function isFilterValid($filterValue); |
|
134 | + /** |
|
135 | + * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not. |
|
136 | + * |
|
137 | + * @param string $filterValue |
|
138 | + * @return boolean |
|
139 | + * @since 8.0.0 |
|
140 | + */ |
|
141 | + public function isFilterValid($filterValue); |
|
142 | 142 | |
143 | - /** |
|
144 | - * The extension can filter the types based on the filter if required. |
|
145 | - * In case no filter is to be applied false is to be returned unchanged. |
|
146 | - * |
|
147 | - * @param array $types |
|
148 | - * @param string $filter |
|
149 | - * @return array|false |
|
150 | - * @since 8.0.0 |
|
151 | - */ |
|
152 | - public function filterNotificationTypes($types, $filter); |
|
143 | + /** |
|
144 | + * The extension can filter the types based on the filter if required. |
|
145 | + * In case no filter is to be applied false is to be returned unchanged. |
|
146 | + * |
|
147 | + * @param array $types |
|
148 | + * @param string $filter |
|
149 | + * @return array|false |
|
150 | + * @since 8.0.0 |
|
151 | + */ |
|
152 | + public function filterNotificationTypes($types, $filter); |
|
153 | 153 | |
154 | - /** |
|
155 | - * For a given filter the extension can specify the sql query conditions including parameters for that query. |
|
156 | - * In case the extension does not know the filter false is to be returned. |
|
157 | - * The query condition and the parameters are to be returned as array with two elements. |
|
158 | - * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%')); |
|
159 | - * |
|
160 | - * @param string $filter |
|
161 | - * @return array|false |
|
162 | - * @since 8.0.0 |
|
163 | - */ |
|
164 | - public function getQueryForFilter($filter); |
|
154 | + /** |
|
155 | + * For a given filter the extension can specify the sql query conditions including parameters for that query. |
|
156 | + * In case the extension does not know the filter false is to be returned. |
|
157 | + * The query condition and the parameters are to be returned as array with two elements. |
|
158 | + * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%')); |
|
159 | + * |
|
160 | + * @param string $filter |
|
161 | + * @return array|false |
|
162 | + * @since 8.0.0 |
|
163 | + */ |
|
164 | + public function getQueryForFilter($filter); |
|
165 | 165 | } |
@@ -42,11 +42,11 @@ |
||
42 | 42 | const METHOD_STREAM = 'stream'; |
43 | 43 | const METHOD_MAIL = 'email'; |
44 | 44 | |
45 | - const PRIORITY_VERYLOW = 10; |
|
46 | - const PRIORITY_LOW = 20; |
|
47 | - const PRIORITY_MEDIUM = 30; |
|
48 | - const PRIORITY_HIGH = 40; |
|
49 | - const PRIORITY_VERYHIGH = 50; |
|
45 | + const PRIORITY_VERYLOW = 10; |
|
46 | + const PRIORITY_LOW = 20; |
|
47 | + const PRIORITY_MEDIUM = 30; |
|
48 | + const PRIORITY_HIGH = 40; |
|
49 | + const PRIORITY_VERYHIGH = 50; |
|
50 | 50 | |
51 | 51 | /** |
52 | 52 | * The extension can return an array of additional notification types. |