@@ -28,56 +28,56 @@ |
||
28 | 28 | * @since 9.0.0 |
29 | 29 | */ |
30 | 30 | interface IWatcher { |
31 | - const CHECK_NEVER = 0; // never check the underlying filesystem for updates |
|
32 | - const CHECK_ONCE = 1; // check the underlying filesystem for updates once every request for each file |
|
33 | - const CHECK_ALWAYS = 2; // always check the underlying filesystem for updates |
|
31 | + const CHECK_NEVER = 0; // never check the underlying filesystem for updates |
|
32 | + const CHECK_ONCE = 1; // check the underlying filesystem for updates once every request for each file |
|
33 | + const CHECK_ALWAYS = 2; // always check the underlying filesystem for updates |
|
34 | 34 | |
35 | - /** |
|
36 | - * @param int $policy either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
37 | - * @since 9.0.0 |
|
38 | - */ |
|
39 | - public function setPolicy($policy); |
|
35 | + /** |
|
36 | + * @param int $policy either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
37 | + * @since 9.0.0 |
|
38 | + */ |
|
39 | + public function setPolicy($policy); |
|
40 | 40 | |
41 | - /** |
|
42 | - * @return int either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
43 | - * @since 9.0.0 |
|
44 | - */ |
|
45 | - public function getPolicy(); |
|
41 | + /** |
|
42 | + * @return int either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
43 | + * @since 9.0.0 |
|
44 | + */ |
|
45 | + public function getPolicy(); |
|
46 | 46 | |
47 | - /** |
|
48 | - * check $path for updates and update if needed |
|
49 | - * |
|
50 | - * @param string $path |
|
51 | - * @param ICacheEntry|null $cachedEntry |
|
52 | - * @return boolean true if path was updated |
|
53 | - * @since 9.0.0 |
|
54 | - */ |
|
55 | - public function checkUpdate($path, $cachedEntry = null); |
|
47 | + /** |
|
48 | + * check $path for updates and update if needed |
|
49 | + * |
|
50 | + * @param string $path |
|
51 | + * @param ICacheEntry|null $cachedEntry |
|
52 | + * @return boolean true if path was updated |
|
53 | + * @since 9.0.0 |
|
54 | + */ |
|
55 | + public function checkUpdate($path, $cachedEntry = null); |
|
56 | 56 | |
57 | - /** |
|
58 | - * Update the cache for changes to $path |
|
59 | - * |
|
60 | - * @param string $path |
|
61 | - * @param ICacheEntry $cachedData |
|
62 | - * @since 9.0.0 |
|
63 | - */ |
|
64 | - public function update($path, $cachedData); |
|
57 | + /** |
|
58 | + * Update the cache for changes to $path |
|
59 | + * |
|
60 | + * @param string $path |
|
61 | + * @param ICacheEntry $cachedData |
|
62 | + * @since 9.0.0 |
|
63 | + */ |
|
64 | + public function update($path, $cachedData); |
|
65 | 65 | |
66 | - /** |
|
67 | - * Check if the cache for $path needs to be updated |
|
68 | - * |
|
69 | - * @param string $path |
|
70 | - * @param ICacheEntry $cachedData |
|
71 | - * @return bool |
|
72 | - * @since 9.0.0 |
|
73 | - */ |
|
74 | - public function needsUpdate($path, $cachedData); |
|
66 | + /** |
|
67 | + * Check if the cache for $path needs to be updated |
|
68 | + * |
|
69 | + * @param string $path |
|
70 | + * @param ICacheEntry $cachedData |
|
71 | + * @return bool |
|
72 | + * @since 9.0.0 |
|
73 | + */ |
|
74 | + public function needsUpdate($path, $cachedData); |
|
75 | 75 | |
76 | - /** |
|
77 | - * remove deleted files in $path from the cache |
|
78 | - * |
|
79 | - * @param string $path |
|
80 | - * @since 9.0.0 |
|
81 | - */ |
|
82 | - public function cleanFolder($path); |
|
76 | + /** |
|
77 | + * remove deleted files in $path from the cache |
|
78 | + * |
|
79 | + * @param string $path |
|
80 | + * @since 9.0.0 |
|
81 | + */ |
|
82 | + public function cleanFolder($path); |
|
83 | 83 | } |
@@ -28,29 +28,29 @@ |
||
28 | 28 | * @since 9.0.0 |
29 | 29 | */ |
30 | 30 | interface IPropagator { |
31 | - /** |
|
32 | - * Mark the beginning of a propagation batch |
|
33 | - * |
|
34 | - * Note that not all cache setups support propagation in which case this will be a noop |
|
35 | - * |
|
36 | - * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent |
|
37 | - * before the batch is committed. |
|
38 | - * |
|
39 | - * @since 9.1.0 |
|
40 | - */ |
|
41 | - public function beginBatch(); |
|
31 | + /** |
|
32 | + * Mark the beginning of a propagation batch |
|
33 | + * |
|
34 | + * Note that not all cache setups support propagation in which case this will be a noop |
|
35 | + * |
|
36 | + * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent |
|
37 | + * before the batch is committed. |
|
38 | + * |
|
39 | + * @since 9.1.0 |
|
40 | + */ |
|
41 | + public function beginBatch(); |
|
42 | 42 | |
43 | - /** |
|
44 | - * Commit the active propagation batch |
|
45 | - * |
|
46 | - * @since 9.1.0 |
|
47 | - */ |
|
48 | - public function commitBatch(); |
|
43 | + /** |
|
44 | + * Commit the active propagation batch |
|
45 | + * |
|
46 | + * @since 9.1.0 |
|
47 | + */ |
|
48 | + public function commitBatch(); |
|
49 | 49 | |
50 | - /** |
|
51 | - * @param string $internalPath |
|
52 | - * @param int $time |
|
53 | - * @since 9.0.0 |
|
54 | - */ |
|
55 | - public function propagateChange($internalPath, $time); |
|
50 | + /** |
|
51 | + * @param string $internalPath |
|
52 | + * @param int $time |
|
53 | + * @since 9.0.0 |
|
54 | + */ |
|
55 | + public function propagateChange($internalPath, $time); |
|
56 | 56 | } |
@@ -28,57 +28,57 @@ |
||
28 | 28 | * @since 9.0.0 |
29 | 29 | */ |
30 | 30 | interface IScanner { |
31 | - const SCAN_RECURSIVE_INCOMPLETE = 2; // only recursive into not fully scanned folders |
|
32 | - const SCAN_RECURSIVE = true; |
|
33 | - const SCAN_SHALLOW = false; |
|
31 | + const SCAN_RECURSIVE_INCOMPLETE = 2; // only recursive into not fully scanned folders |
|
32 | + const SCAN_RECURSIVE = true; |
|
33 | + const SCAN_SHALLOW = false; |
|
34 | 34 | |
35 | - const REUSE_NONE = 0; |
|
36 | - const REUSE_ETAG = 1; |
|
37 | - const REUSE_SIZE = 2; |
|
35 | + const REUSE_NONE = 0; |
|
36 | + const REUSE_ETAG = 1; |
|
37 | + const REUSE_SIZE = 2; |
|
38 | 38 | |
39 | - /** |
|
40 | - * scan a single file and store it in the cache |
|
41 | - * |
|
42 | - * @param string $file |
|
43 | - * @param int $reuseExisting |
|
44 | - * @param int $parentId |
|
45 | - * @param array | null $cacheData existing data in the cache for the file to be scanned |
|
46 | - * @param bool $lock set to false to disable getting an additional read lock during scanning |
|
47 | - * @return array an array of metadata of the scanned file |
|
48 | - * @throws \OC\ServerNotAvailableException |
|
49 | - * @throws \OCP\Lock\LockedException |
|
50 | - * @since 9.0.0 |
|
51 | - */ |
|
52 | - public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true); |
|
39 | + /** |
|
40 | + * scan a single file and store it in the cache |
|
41 | + * |
|
42 | + * @param string $file |
|
43 | + * @param int $reuseExisting |
|
44 | + * @param int $parentId |
|
45 | + * @param array | null $cacheData existing data in the cache for the file to be scanned |
|
46 | + * @param bool $lock set to false to disable getting an additional read lock during scanning |
|
47 | + * @return array an array of metadata of the scanned file |
|
48 | + * @throws \OC\ServerNotAvailableException |
|
49 | + * @throws \OCP\Lock\LockedException |
|
50 | + * @since 9.0.0 |
|
51 | + */ |
|
52 | + public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true); |
|
53 | 53 | |
54 | - /** |
|
55 | - * scan a folder and all its children |
|
56 | - * |
|
57 | - * @param string $path |
|
58 | - * @param bool $recursive |
|
59 | - * @param int $reuse |
|
60 | - * @param bool $lock set to false to disable getting an additional read lock during scanning |
|
61 | - * @return array an array of the meta data of the scanned file or folder |
|
62 | - * @since 9.0.0 |
|
63 | - */ |
|
64 | - public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true); |
|
54 | + /** |
|
55 | + * scan a folder and all its children |
|
56 | + * |
|
57 | + * @param string $path |
|
58 | + * @param bool $recursive |
|
59 | + * @param int $reuse |
|
60 | + * @param bool $lock set to false to disable getting an additional read lock during scanning |
|
61 | + * @return array an array of the meta data of the scanned file or folder |
|
62 | + * @since 9.0.0 |
|
63 | + */ |
|
64 | + public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true); |
|
65 | 65 | |
66 | - /** |
|
67 | - * check if the file should be ignored when scanning |
|
68 | - * NOTE: files with a '.part' extension are ignored as well! |
|
69 | - * prevents unfinished put requests to be scanned |
|
70 | - * |
|
71 | - * @param string $file |
|
72 | - * @return boolean |
|
73 | - * @since 9.0.0 |
|
74 | - */ |
|
75 | - public static function isPartialFile($file); |
|
66 | + /** |
|
67 | + * check if the file should be ignored when scanning |
|
68 | + * NOTE: files with a '.part' extension are ignored as well! |
|
69 | + * prevents unfinished put requests to be scanned |
|
70 | + * |
|
71 | + * @param string $file |
|
72 | + * @return boolean |
|
73 | + * @since 9.0.0 |
|
74 | + */ |
|
75 | + public static function isPartialFile($file); |
|
76 | 76 | |
77 | - /** |
|
78 | - * walk over any folders that are not fully scanned yet and scan them |
|
79 | - * |
|
80 | - * @since 9.0.0 |
|
81 | - */ |
|
82 | - public function backgroundScan(); |
|
77 | + /** |
|
78 | + * walk over any folders that are not fully scanned yet and scan them |
|
79 | + * |
|
80 | + * @since 9.0.0 |
|
81 | + */ |
|
82 | + public function backgroundScan(); |
|
83 | 83 | } |
84 | 84 |
@@ -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 | } |