@@ -28,108 +28,108 @@ |
||
28 | 28 | * @since 9.0.0 |
29 | 29 | */ |
30 | 30 | interface ICacheEntry { |
31 | - const DIRECTORY_MIMETYPE = 'httpd/unix-directory'; |
|
31 | + const DIRECTORY_MIMETYPE = 'httpd/unix-directory'; |
|
32 | 32 | |
33 | - /** |
|
34 | - * Get the numeric id of a file |
|
35 | - * |
|
36 | - * @return int |
|
37 | - * @since 9.0.0 |
|
38 | - */ |
|
39 | - public function getId(); |
|
33 | + /** |
|
34 | + * Get the numeric id of a file |
|
35 | + * |
|
36 | + * @return int |
|
37 | + * @since 9.0.0 |
|
38 | + */ |
|
39 | + public function getId(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Get the numeric id for the storage |
|
43 | - * |
|
44 | - * @return int |
|
45 | - * @since 9.0.0 |
|
46 | - */ |
|
47 | - public function getStorageId(); |
|
41 | + /** |
|
42 | + * Get the numeric id for the storage |
|
43 | + * |
|
44 | + * @return int |
|
45 | + * @since 9.0.0 |
|
46 | + */ |
|
47 | + public function getStorageId(); |
|
48 | 48 | |
49 | - /** |
|
50 | - * Get the path of the file relative to the storage root |
|
51 | - * |
|
52 | - * @return string |
|
53 | - * @since 9.0.0 |
|
54 | - */ |
|
55 | - public function getPath(); |
|
49 | + /** |
|
50 | + * Get the path of the file relative to the storage root |
|
51 | + * |
|
52 | + * @return string |
|
53 | + * @since 9.0.0 |
|
54 | + */ |
|
55 | + public function getPath(); |
|
56 | 56 | |
57 | - /** |
|
58 | - * Get the file name |
|
59 | - * |
|
60 | - * @return string |
|
61 | - * @since 9.0.0 |
|
62 | - */ |
|
63 | - public function getName(); |
|
57 | + /** |
|
58 | + * Get the file name |
|
59 | + * |
|
60 | + * @return string |
|
61 | + * @since 9.0.0 |
|
62 | + */ |
|
63 | + public function getName(); |
|
64 | 64 | |
65 | - /** |
|
66 | - * Get the full mimetype |
|
67 | - * |
|
68 | - * @return string |
|
69 | - * @since 9.0.0 |
|
70 | - */ |
|
71 | - public function getMimeType(); |
|
65 | + /** |
|
66 | + * Get the full mimetype |
|
67 | + * |
|
68 | + * @return string |
|
69 | + * @since 9.0.0 |
|
70 | + */ |
|
71 | + public function getMimeType(); |
|
72 | 72 | |
73 | - /** |
|
74 | - * Get the first part of the mimetype |
|
75 | - * |
|
76 | - * @return string |
|
77 | - * @since 9.0.0 |
|
78 | - */ |
|
79 | - public function getMimePart(); |
|
73 | + /** |
|
74 | + * Get the first part of the mimetype |
|
75 | + * |
|
76 | + * @return string |
|
77 | + * @since 9.0.0 |
|
78 | + */ |
|
79 | + public function getMimePart(); |
|
80 | 80 | |
81 | - /** |
|
82 | - * Get the file size in bytes |
|
83 | - * |
|
84 | - * @return int |
|
85 | - * @since 9.0.0 |
|
86 | - */ |
|
87 | - public function getSize(); |
|
81 | + /** |
|
82 | + * Get the file size in bytes |
|
83 | + * |
|
84 | + * @return int |
|
85 | + * @since 9.0.0 |
|
86 | + */ |
|
87 | + public function getSize(); |
|
88 | 88 | |
89 | - /** |
|
90 | - * Get the last modified date as unix timestamp |
|
91 | - * |
|
92 | - * @return int |
|
93 | - * @since 9.0.0 |
|
94 | - */ |
|
95 | - public function getMTime(); |
|
89 | + /** |
|
90 | + * Get the last modified date as unix timestamp |
|
91 | + * |
|
92 | + * @return int |
|
93 | + * @since 9.0.0 |
|
94 | + */ |
|
95 | + public function getMTime(); |
|
96 | 96 | |
97 | - /** |
|
98 | - * Get the last modified date on the storage as unix timestamp |
|
99 | - * |
|
100 | - * Note that when a file is updated we also update the mtime of all parent folders to make it visible to the user which folder has had updates most recently |
|
101 | - * This can differ from the mtime on the underlying storage which usually only changes when a direct child is added, removed or renamed |
|
102 | - * |
|
103 | - * @return int |
|
104 | - * @since 9.0.0 |
|
105 | - */ |
|
106 | - public function getStorageMTime(); |
|
97 | + /** |
|
98 | + * Get the last modified date on the storage as unix timestamp |
|
99 | + * |
|
100 | + * Note that when a file is updated we also update the mtime of all parent folders to make it visible to the user which folder has had updates most recently |
|
101 | + * This can differ from the mtime on the underlying storage which usually only changes when a direct child is added, removed or renamed |
|
102 | + * |
|
103 | + * @return int |
|
104 | + * @since 9.0.0 |
|
105 | + */ |
|
106 | + public function getStorageMTime(); |
|
107 | 107 | |
108 | - /** |
|
109 | - * Get the etag for the file |
|
110 | - * |
|
111 | - * An etag is used for change detection of files and folders, an etag of a file changes whenever the content of the file changes |
|
112 | - * Etag for folders change whenever a file in the folder has changed |
|
113 | - * |
|
114 | - * @return string |
|
115 | - * @since 9.0.0 |
|
116 | - */ |
|
117 | - public function getEtag(); |
|
108 | + /** |
|
109 | + * Get the etag for the file |
|
110 | + * |
|
111 | + * An etag is used for change detection of files and folders, an etag of a file changes whenever the content of the file changes |
|
112 | + * Etag for folders change whenever a file in the folder has changed |
|
113 | + * |
|
114 | + * @return string |
|
115 | + * @since 9.0.0 |
|
116 | + */ |
|
117 | + public function getEtag(); |
|
118 | 118 | |
119 | - /** |
|
120 | - * Get the permissions for the file stored as bitwise combination of \OCP\PERMISSION_READ, \OCP\PERMISSION_CREATE |
|
121 | - * \OCP\PERMISSION_UPDATE, \OCP\PERMISSION_DELETE and \OCP\PERMISSION_SHARE |
|
122 | - * |
|
123 | - * @return int |
|
124 | - * @since 9.0.0 |
|
125 | - */ |
|
126 | - public function getPermissions(); |
|
119 | + /** |
|
120 | + * Get the permissions for the file stored as bitwise combination of \OCP\PERMISSION_READ, \OCP\PERMISSION_CREATE |
|
121 | + * \OCP\PERMISSION_UPDATE, \OCP\PERMISSION_DELETE and \OCP\PERMISSION_SHARE |
|
122 | + * |
|
123 | + * @return int |
|
124 | + * @since 9.0.0 |
|
125 | + */ |
|
126 | + public function getPermissions(); |
|
127 | 127 | |
128 | - /** |
|
129 | - * Check if the file is encrypted |
|
130 | - * |
|
131 | - * @return bool |
|
132 | - * @since 9.0.0 |
|
133 | - */ |
|
134 | - public function isEncrypted(); |
|
128 | + /** |
|
129 | + * Check if the file is encrypted |
|
130 | + * |
|
131 | + * @return bool |
|
132 | + * @since 9.0.0 |
|
133 | + */ |
|
134 | + public function isEncrypted(); |
|
135 | 135 | } |
@@ -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 |
@@ -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 | } |
@@ -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 |