@@ -30,51 +30,51 @@ |
||
30 | 30 | * @since 8.1.0 |
31 | 31 | */ |
32 | 32 | interface ILockingProvider { |
33 | - /** |
|
34 | - * @since 8.1.0 |
|
35 | - */ |
|
36 | - const LOCK_SHARED = 1; |
|
37 | - /** |
|
38 | - * @since 8.1.0 |
|
39 | - */ |
|
40 | - const LOCK_EXCLUSIVE = 2; |
|
33 | + /** |
|
34 | + * @since 8.1.0 |
|
35 | + */ |
|
36 | + const LOCK_SHARED = 1; |
|
37 | + /** |
|
38 | + * @since 8.1.0 |
|
39 | + */ |
|
40 | + const LOCK_EXCLUSIVE = 2; |
|
41 | 41 | |
42 | - /** |
|
43 | - * @param string $path |
|
44 | - * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
45 | - * @return bool |
|
46 | - * @since 8.1.0 |
|
47 | - */ |
|
48 | - public function isLocked($path, $type); |
|
42 | + /** |
|
43 | + * @param string $path |
|
44 | + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
45 | + * @return bool |
|
46 | + * @since 8.1.0 |
|
47 | + */ |
|
48 | + public function isLocked($path, $type); |
|
49 | 49 | |
50 | - /** |
|
51 | - * @param string $path |
|
52 | - * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
53 | - * @throws \OCP\Lock\LockedException |
|
54 | - * @since 8.1.0 |
|
55 | - */ |
|
56 | - public function acquireLock($path, $type); |
|
50 | + /** |
|
51 | + * @param string $path |
|
52 | + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
53 | + * @throws \OCP\Lock\LockedException |
|
54 | + * @since 8.1.0 |
|
55 | + */ |
|
56 | + public function acquireLock($path, $type); |
|
57 | 57 | |
58 | - /** |
|
59 | - * @param string $path |
|
60 | - * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
61 | - * @since 8.1.0 |
|
62 | - */ |
|
63 | - public function releaseLock($path, $type); |
|
58 | + /** |
|
59 | + * @param string $path |
|
60 | + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
61 | + * @since 8.1.0 |
|
62 | + */ |
|
63 | + public function releaseLock($path, $type); |
|
64 | 64 | |
65 | - /** |
|
66 | - * Change the type of an existing lock |
|
67 | - * |
|
68 | - * @param string $path |
|
69 | - * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
70 | - * @throws \OCP\Lock\LockedException |
|
71 | - * @since 8.1.0 |
|
72 | - */ |
|
73 | - public function changeLock($path, $targetType); |
|
65 | + /** |
|
66 | + * Change the type of an existing lock |
|
67 | + * |
|
68 | + * @param string $path |
|
69 | + * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
70 | + * @throws \OCP\Lock\LockedException |
|
71 | + * @since 8.1.0 |
|
72 | + */ |
|
73 | + public function changeLock($path, $targetType); |
|
74 | 74 | |
75 | - /** |
|
76 | - * release all lock acquired by this instance |
|
77 | - * @since 8.1.0 |
|
78 | - */ |
|
79 | - public function releaseAll(); |
|
75 | + /** |
|
76 | + * release all lock acquired by this instance |
|
77 | + * @since 8.1.0 |
|
78 | + */ |
|
79 | + public function releaseAll(); |
|
80 | 80 | } |
@@ -31,64 +31,64 @@ |
||
31 | 31 | // use OCP namespace for all classes that are considered public. |
32 | 32 | // This means that they should be used by apps instead of the internal ownCloud classes |
33 | 33 | namespace OCP { |
34 | - /** |
|
35 | - * Interface IAddressBook |
|
36 | - * |
|
37 | - * @package OCP |
|
38 | - * @since 5.0.0 |
|
39 | - */ |
|
40 | - interface IAddressBook { |
|
34 | + /** |
|
35 | + * Interface IAddressBook |
|
36 | + * |
|
37 | + * @package OCP |
|
38 | + * @since 5.0.0 |
|
39 | + */ |
|
40 | + interface IAddressBook { |
|
41 | 41 | |
42 | - /** |
|
43 | - * @return string defining the technical unique key |
|
44 | - * @since 5.0.0 |
|
45 | - */ |
|
46 | - public function getKey(); |
|
42 | + /** |
|
43 | + * @return string defining the technical unique key |
|
44 | + * @since 5.0.0 |
|
45 | + */ |
|
46 | + public function getKey(); |
|
47 | 47 | |
48 | - /** |
|
49 | - * In comparison to getKey() this function returns a human readable (maybe translated) name |
|
50 | - * @return mixed |
|
51 | - * @since 5.0.0 |
|
52 | - */ |
|
53 | - public function getDisplayName(); |
|
48 | + /** |
|
49 | + * In comparison to getKey() this function returns a human readable (maybe translated) name |
|
50 | + * @return mixed |
|
51 | + * @since 5.0.0 |
|
52 | + */ |
|
53 | + public function getDisplayName(); |
|
54 | 54 | |
55 | - /** |
|
56 | - * @param string $pattern which should match within the $searchProperties |
|
57 | - * @param array $searchProperties defines the properties within the query pattern should match |
|
58 | - * @param array $options - for future use. One should always have options! |
|
59 | - * @return array an array of contacts which are arrays of key-value-pairs |
|
60 | - * @since 5.0.0 |
|
61 | - */ |
|
62 | - public function search($pattern, $searchProperties, $options); |
|
63 | - // // dummy results |
|
64 | - // return array( |
|
65 | - // array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => '[email protected]', 'GEO' => '37.386013;-122.082932'), |
|
66 | - // array('id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => array('[email protected]', '[email protected]')), |
|
67 | - // ); |
|
55 | + /** |
|
56 | + * @param string $pattern which should match within the $searchProperties |
|
57 | + * @param array $searchProperties defines the properties within the query pattern should match |
|
58 | + * @param array $options - for future use. One should always have options! |
|
59 | + * @return array an array of contacts which are arrays of key-value-pairs |
|
60 | + * @since 5.0.0 |
|
61 | + */ |
|
62 | + public function search($pattern, $searchProperties, $options); |
|
63 | + // // dummy results |
|
64 | + // return array( |
|
65 | + // array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => '[email protected]', 'GEO' => '37.386013;-122.082932'), |
|
66 | + // array('id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => array('[email protected]', '[email protected]')), |
|
67 | + // ); |
|
68 | 68 | |
69 | - /** |
|
70 | - * @param array $properties this array if key-value-pairs defines a contact |
|
71 | - * @return array an array representing the contact just created or updated |
|
72 | - * @since 5.0.0 |
|
73 | - */ |
|
74 | - public function createOrUpdate($properties); |
|
75 | - // // dummy |
|
76 | - // return array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => '[email protected]', |
|
77 | - // 'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif', |
|
78 | - // 'ADR' => ';;123 Main Street;Any Town;CA;91921-1234' |
|
79 | - // ); |
|
69 | + /** |
|
70 | + * @param array $properties this array if key-value-pairs defines a contact |
|
71 | + * @return array an array representing the contact just created or updated |
|
72 | + * @since 5.0.0 |
|
73 | + */ |
|
74 | + public function createOrUpdate($properties); |
|
75 | + // // dummy |
|
76 | + // return array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => '[email protected]', |
|
77 | + // 'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif', |
|
78 | + // 'ADR' => ';;123 Main Street;Any Town;CA;91921-1234' |
|
79 | + // ); |
|
80 | 80 | |
81 | - /** |
|
82 | - * @return mixed |
|
83 | - * @since 5.0.0 |
|
84 | - */ |
|
85 | - public function getPermissions(); |
|
81 | + /** |
|
82 | + * @return mixed |
|
83 | + * @since 5.0.0 |
|
84 | + */ |
|
85 | + public function getPermissions(); |
|
86 | 86 | |
87 | - /** |
|
88 | - * @param object $id the unique identifier to a contact |
|
89 | - * @return bool successful or not |
|
90 | - * @since 5.0.0 |
|
91 | - */ |
|
92 | - public function delete($id); |
|
93 | - } |
|
87 | + /** |
|
88 | + * @param object $id the unique identifier to a contact |
|
89 | + * @return bool successful or not |
|
90 | + * @since 5.0.0 |
|
91 | + */ |
|
92 | + public function delete($id); |
|
93 | + } |
|
94 | 94 | } |
@@ -29,77 +29,77 @@ |
||
29 | 29 | * @since 11.0.0 |
30 | 30 | */ |
31 | 31 | interface ILDAPProvider { |
32 | - /** |
|
33 | - * Translate a user id to LDAP DN. |
|
34 | - * @param string $uid user id |
|
35 | - * @return string |
|
36 | - * @since 11.0.0 |
|
37 | - */ |
|
38 | - public function getUserDN($uid); |
|
32 | + /** |
|
33 | + * Translate a user id to LDAP DN. |
|
34 | + * @param string $uid user id |
|
35 | + * @return string |
|
36 | + * @since 11.0.0 |
|
37 | + */ |
|
38 | + public function getUserDN($uid); |
|
39 | 39 | |
40 | - /** |
|
41 | - * Translate a LDAP DN to an internal user name. |
|
42 | - * @param string $dn LDAP DN |
|
43 | - * @return string with the internal user name |
|
44 | - * @throws \Exception if translation was unsuccessful |
|
45 | - * @since 11.0.0 |
|
46 | - */ |
|
47 | - public function getUserName($dn); |
|
40 | + /** |
|
41 | + * Translate a LDAP DN to an internal user name. |
|
42 | + * @param string $dn LDAP DN |
|
43 | + * @return string with the internal user name |
|
44 | + * @throws \Exception if translation was unsuccessful |
|
45 | + * @since 11.0.0 |
|
46 | + */ |
|
47 | + public function getUserName($dn); |
|
48 | 48 | |
49 | - /** |
|
50 | - * Convert a stored DN so it can be used as base parameter for LDAP queries. |
|
51 | - * @param string $dn the DN |
|
52 | - * @return string |
|
53 | - * @since 11.0.0 |
|
54 | - */ |
|
55 | - public function DNasBaseParameter($dn); |
|
49 | + /** |
|
50 | + * Convert a stored DN so it can be used as base parameter for LDAP queries. |
|
51 | + * @param string $dn the DN |
|
52 | + * @return string |
|
53 | + * @since 11.0.0 |
|
54 | + */ |
|
55 | + public function DNasBaseParameter($dn); |
|
56 | 56 | |
57 | - /** |
|
58 | - * Sanitize a DN received from the LDAP server. |
|
59 | - * @param array $dn the DN in question |
|
60 | - * @return array the sanitized DN |
|
61 | - * @since 11.0.0 |
|
62 | - */ |
|
63 | - public function sanitizeDN($dn); |
|
57 | + /** |
|
58 | + * Sanitize a DN received from the LDAP server. |
|
59 | + * @param array $dn the DN in question |
|
60 | + * @return array the sanitized DN |
|
61 | + * @since 11.0.0 |
|
62 | + */ |
|
63 | + public function sanitizeDN($dn); |
|
64 | 64 | |
65 | - /** |
|
66 | - * Return a new LDAP connection resource for the specified user. |
|
67 | - * @param string $uid user id |
|
68 | - * @return resource of the LDAP connection |
|
69 | - * @since 11.0.0 |
|
70 | - */ |
|
71 | - public function getLDAPConnection($uid); |
|
65 | + /** |
|
66 | + * Return a new LDAP connection resource for the specified user. |
|
67 | + * @param string $uid user id |
|
68 | + * @return resource of the LDAP connection |
|
69 | + * @since 11.0.0 |
|
70 | + */ |
|
71 | + public function getLDAPConnection($uid); |
|
72 | 72 | |
73 | - /** |
|
74 | - * Get the LDAP base for users. |
|
75 | - * @param string $uid user id |
|
76 | - * @return string the base for users |
|
77 | - * @throws \Exception if user id was not found in LDAP |
|
78 | - * @since 11.0.0 |
|
79 | - */ |
|
80 | - public function getLDAPBaseUsers($uid); |
|
73 | + /** |
|
74 | + * Get the LDAP base for users. |
|
75 | + * @param string $uid user id |
|
76 | + * @return string the base for users |
|
77 | + * @throws \Exception if user id was not found in LDAP |
|
78 | + * @since 11.0.0 |
|
79 | + */ |
|
80 | + public function getLDAPBaseUsers($uid); |
|
81 | 81 | |
82 | - /** |
|
83 | - * Get the LDAP base for groups. |
|
84 | - * @param string $uid user id |
|
85 | - * @return string the base for groups |
|
86 | - * @throws \Exception if user id was not found in LDAP |
|
87 | - * @since 11.0.0 |
|
88 | - */ |
|
89 | - public function getLDAPBaseGroups($uid); |
|
82 | + /** |
|
83 | + * Get the LDAP base for groups. |
|
84 | + * @param string $uid user id |
|
85 | + * @return string the base for groups |
|
86 | + * @throws \Exception if user id was not found in LDAP |
|
87 | + * @since 11.0.0 |
|
88 | + */ |
|
89 | + public function getLDAPBaseGroups($uid); |
|
90 | 90 | |
91 | - /** |
|
92 | - * Check whether a LDAP DN exists |
|
93 | - * @param string $dn LDAP DN |
|
94 | - * @return bool whether the DN exists |
|
95 | - * @since 11.0.0 |
|
96 | - */ |
|
97 | - public function dnExists($dn); |
|
91 | + /** |
|
92 | + * Check whether a LDAP DN exists |
|
93 | + * @param string $dn LDAP DN |
|
94 | + * @return bool whether the DN exists |
|
95 | + * @since 11.0.0 |
|
96 | + */ |
|
97 | + public function dnExists($dn); |
|
98 | 98 | |
99 | - /** |
|
100 | - * Clear the cache if a cache is used, otherwise do nothing. |
|
101 | - * @param string $uid user id |
|
102 | - * @since 11.0.0 |
|
103 | - */ |
|
104 | - public function clearCache($uid); |
|
99 | + /** |
|
100 | + * Clear the cache if a cache is used, otherwise do nothing. |
|
101 | + * @param string $uid user id |
|
102 | + * @since 11.0.0 |
|
103 | + */ |
|
104 | + public function clearCache($uid); |
|
105 | 105 | } |
@@ -35,19 +35,19 @@ |
||
35 | 35 | */ |
36 | 36 | interface ILDAPProviderFactory { |
37 | 37 | |
38 | - /** |
|
39 | - * Constructor for the LDAP provider factory |
|
40 | - * |
|
41 | - * @param IServerContainer $serverContainer server container |
|
42 | - * @since 11.0.0 |
|
43 | - */ |
|
44 | - public function __construct(IServerContainer $serverContainer); |
|
38 | + /** |
|
39 | + * Constructor for the LDAP provider factory |
|
40 | + * |
|
41 | + * @param IServerContainer $serverContainer server container |
|
42 | + * @since 11.0.0 |
|
43 | + */ |
|
44 | + public function __construct(IServerContainer $serverContainer); |
|
45 | 45 | |
46 | - /** |
|
47 | - * creates and returns an instance of the ILDAPProvider |
|
48 | - * |
|
49 | - * @return ILDAPProvider |
|
50 | - * @since 11.0.0 |
|
51 | - */ |
|
52 | - public function getLDAPProvider(); |
|
46 | + /** |
|
47 | + * creates and returns an instance of the ILDAPProvider |
|
48 | + * |
|
49 | + * @return ILDAPProvider |
|
50 | + * @since 11.0.0 |
|
51 | + */ |
|
52 | + public function getLDAPProvider(); |
|
53 | 53 | } |
@@ -29,17 +29,17 @@ |
||
29 | 29 | * @since 11.0.0 |
30 | 30 | */ |
31 | 31 | interface IDeletionFlagSupport { |
32 | - /** |
|
33 | - * Flag record for deletion. |
|
34 | - * @param string $uid user id |
|
35 | - * @since 11.0.0 |
|
36 | - */ |
|
37 | - public function flagRecord($uid); |
|
32 | + /** |
|
33 | + * Flag record for deletion. |
|
34 | + * @param string $uid user id |
|
35 | + * @since 11.0.0 |
|
36 | + */ |
|
37 | + public function flagRecord($uid); |
|
38 | 38 | |
39 | - /** |
|
40 | - * Unflag record for deletion. |
|
41 | - * @param string $uid user id |
|
42 | - * @since 11.0.0 |
|
43 | - */ |
|
44 | - public function unflagRecord($uid); |
|
39 | + /** |
|
40 | + * Unflag record for deletion. |
|
41 | + * @param string $uid user id |
|
42 | + * @since 11.0.0 |
|
43 | + */ |
|
44 | + public function unflagRecord($uid); |
|
45 | 45 | } |
@@ -39,46 +39,46 @@ |
||
39 | 39 | */ |
40 | 40 | interface ICache { |
41 | 41 | |
42 | - /** |
|
43 | - * Get a value from the user cache |
|
44 | - * @param string $key |
|
45 | - * @return mixed |
|
46 | - * @since 6.0.0 |
|
47 | - */ |
|
48 | - public function get($key); |
|
42 | + /** |
|
43 | + * Get a value from the user cache |
|
44 | + * @param string $key |
|
45 | + * @return mixed |
|
46 | + * @since 6.0.0 |
|
47 | + */ |
|
48 | + public function get($key); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Set a value in the user cache |
|
52 | - * @param string $key |
|
53 | - * @param mixed $value |
|
54 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
55 | - * @return bool |
|
56 | - * @since 6.0.0 |
|
57 | - */ |
|
58 | - public function set($key, $value, $ttl = 0); |
|
50 | + /** |
|
51 | + * Set a value in the user cache |
|
52 | + * @param string $key |
|
53 | + * @param mixed $value |
|
54 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
55 | + * @return bool |
|
56 | + * @since 6.0.0 |
|
57 | + */ |
|
58 | + public function set($key, $value, $ttl = 0); |
|
59 | 59 | |
60 | - /** |
|
61 | - * Check if a value is set in the user cache |
|
62 | - * @param string $key |
|
63 | - * @return bool |
|
64 | - * @since 6.0.0 |
|
65 | - * @deprecated 9.1.0 Directly read from GET to prevent race conditions |
|
66 | - */ |
|
67 | - public function hasKey($key); |
|
60 | + /** |
|
61 | + * Check if a value is set in the user cache |
|
62 | + * @param string $key |
|
63 | + * @return bool |
|
64 | + * @since 6.0.0 |
|
65 | + * @deprecated 9.1.0 Directly read from GET to prevent race conditions |
|
66 | + */ |
|
67 | + public function hasKey($key); |
|
68 | 68 | |
69 | - /** |
|
70 | - * Remove an item from the user cache |
|
71 | - * @param string $key |
|
72 | - * @return bool |
|
73 | - * @since 6.0.0 |
|
74 | - */ |
|
75 | - public function remove($key); |
|
69 | + /** |
|
70 | + * Remove an item from the user cache |
|
71 | + * @param string $key |
|
72 | + * @return bool |
|
73 | + * @since 6.0.0 |
|
74 | + */ |
|
75 | + public function remove($key); |
|
76 | 76 | |
77 | - /** |
|
78 | - * Clear the user cache of all entries starting with a prefix |
|
79 | - * @param string $prefix (optional) |
|
80 | - * @return bool |
|
81 | - * @since 6.0.0 |
|
82 | - */ |
|
83 | - public function clear($prefix = ''); |
|
77 | + /** |
|
78 | + * Clear the user cache of all entries starting with a prefix |
|
79 | + * @param string $prefix (optional) |
|
80 | + * @return bool |
|
81 | + * @since 6.0.0 |
|
82 | + */ |
|
83 | + public function clear($prefix = ''); |
|
84 | 84 | } |
@@ -27,12 +27,12 @@ |
||
27 | 27 | * @since 8.2.0 |
28 | 28 | */ |
29 | 29 | class AutoloadNotAllowedException extends \DomainException { |
30 | - /** |
|
31 | - * @param string $path |
|
32 | - * @since 8.2.0 |
|
33 | - */ |
|
34 | - public function __construct($path) { |
|
35 | - parent::__construct('Autoload path not allowed: '.$path); |
|
36 | - } |
|
30 | + /** |
|
31 | + * @param string $path |
|
32 | + * @since 8.2.0 |
|
33 | + */ |
|
34 | + public function __construct($path) { |
|
35 | + parent::__construct('Autoload path not allowed: '.$path); |
|
36 | + } |
|
37 | 37 | } |
38 | 38 |
@@ -25,26 +25,26 @@ |
||
25 | 25 | * @since 9.2 |
26 | 26 | */ |
27 | 27 | interface ILockdownManager { |
28 | - /** |
|
29 | - * Enable the lockdown restrictions |
|
30 | - * |
|
31 | - * @since 9.2 |
|
32 | - */ |
|
33 | - public function enable(); |
|
28 | + /** |
|
29 | + * Enable the lockdown restrictions |
|
30 | + * |
|
31 | + * @since 9.2 |
|
32 | + */ |
|
33 | + public function enable(); |
|
34 | 34 | |
35 | - /** |
|
36 | - * Set the active token to get the restrictions from and enable the lockdown |
|
37 | - * |
|
38 | - * @param IToken $token |
|
39 | - * @since 9.2 |
|
40 | - */ |
|
41 | - public function setToken(IToken $token); |
|
35 | + /** |
|
36 | + * Set the active token to get the restrictions from and enable the lockdown |
|
37 | + * |
|
38 | + * @param IToken $token |
|
39 | + * @since 9.2 |
|
40 | + */ |
|
41 | + public function setToken(IToken $token); |
|
42 | 42 | |
43 | - /** |
|
44 | - * Check whether or not filesystem access is allowed |
|
45 | - * |
|
46 | - * @return bool |
|
47 | - * @since 9.2 |
|
48 | - */ |
|
49 | - public function canAccessFilesystem(); |
|
43 | + /** |
|
44 | + * Check whether or not filesystem access is allowed |
|
45 | + * |
|
46 | + * @return bool |
|
47 | + * @since 9.2 |
|
48 | + */ |
|
49 | + public function canAccessFilesystem(); |
|
50 | 50 | } |
@@ -32,60 +32,60 @@ |
||
32 | 32 | */ |
33 | 33 | abstract class Provider { |
34 | 34 | |
35 | - /** |
|
36 | - * @since 8.0.0 |
|
37 | - */ |
|
38 | - const OPTION_APPS = 'apps'; |
|
35 | + /** |
|
36 | + * @since 8.0.0 |
|
37 | + */ |
|
38 | + const OPTION_APPS = 'apps'; |
|
39 | 39 | |
40 | - /** |
|
41 | - * List of options |
|
42 | - * @var array |
|
43 | - * @since 7.0.0 |
|
44 | - */ |
|
45 | - protected $options; |
|
40 | + /** |
|
41 | + * List of options |
|
42 | + * @var array |
|
43 | + * @since 7.0.0 |
|
44 | + */ |
|
45 | + protected $options; |
|
46 | 46 | |
47 | - /** |
|
48 | - * Constructor |
|
49 | - * @param array $options as key => value |
|
50 | - * @since 7.0.0 - default value for $options was added in 8.0.0 |
|
51 | - */ |
|
52 | - public function __construct($options = array()) { |
|
53 | - $this->options = $options; |
|
54 | - } |
|
47 | + /** |
|
48 | + * Constructor |
|
49 | + * @param array $options as key => value |
|
50 | + * @since 7.0.0 - default value for $options was added in 8.0.0 |
|
51 | + */ |
|
52 | + public function __construct($options = array()) { |
|
53 | + $this->options = $options; |
|
54 | + } |
|
55 | 55 | |
56 | - /** |
|
57 | - * get a value from the options array or null |
|
58 | - * @param string $key |
|
59 | - * @return mixed |
|
60 | - * @since 8.0.0 |
|
61 | - */ |
|
62 | - public function getOption($key) { |
|
63 | - if (is_array($this->options) && isset($this->options[$key])) { |
|
64 | - return $this->options[$key]; |
|
65 | - } else { |
|
66 | - return null; |
|
67 | - } |
|
68 | - } |
|
56 | + /** |
|
57 | + * get a value from the options array or null |
|
58 | + * @param string $key |
|
59 | + * @return mixed |
|
60 | + * @since 8.0.0 |
|
61 | + */ |
|
62 | + public function getOption($key) { |
|
63 | + if (is_array($this->options) && isset($this->options[$key])) { |
|
64 | + return $this->options[$key]; |
|
65 | + } else { |
|
66 | + return null; |
|
67 | + } |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * checks if the given apps and the apps this provider has results for intersect |
|
72 | - * returns true if the given array is empty (all apps) |
|
73 | - * or if this provider does not have a list of apps it provides results for (legacy search providers) |
|
74 | - * or if the two above arrays have elements in common (intersect) |
|
75 | - * @param string[] $apps |
|
76 | - * @return bool |
|
77 | - * @since 8.0.0 |
|
78 | - */ |
|
79 | - public function providesResultsFor(array $apps = array()) { |
|
80 | - $forApps = $this->getOption(self::OPTION_APPS); |
|
81 | - return empty($apps) || empty($forApps) || array_intersect($forApps, $apps); |
|
82 | - } |
|
70 | + /** |
|
71 | + * checks if the given apps and the apps this provider has results for intersect |
|
72 | + * returns true if the given array is empty (all apps) |
|
73 | + * or if this provider does not have a list of apps it provides results for (legacy search providers) |
|
74 | + * or if the two above arrays have elements in common (intersect) |
|
75 | + * @param string[] $apps |
|
76 | + * @return bool |
|
77 | + * @since 8.0.0 |
|
78 | + */ |
|
79 | + public function providesResultsFor(array $apps = array()) { |
|
80 | + $forApps = $this->getOption(self::OPTION_APPS); |
|
81 | + return empty($apps) || empty($forApps) || array_intersect($forApps, $apps); |
|
82 | + } |
|
83 | 83 | |
84 | - /** |
|
85 | - * Search for $query |
|
86 | - * @param string $query |
|
87 | - * @return array An array of OCP\Search\Result's |
|
88 | - * @since 7.0.0 |
|
89 | - */ |
|
90 | - abstract public function search($query); |
|
84 | + /** |
|
85 | + * Search for $query |
|
86 | + * @param string $query |
|
87 | + * @return array An array of OCP\Search\Result's |
|
88 | + * @since 7.0.0 |
|
89 | + */ |
|
90 | + abstract public function search($query); |
|
91 | 91 | } |