@@ -29,44 +29,44 @@ |
||
| 29 | 29 | * @since 8.0.0 |
| 30 | 30 | */ |
| 31 | 31 | interface ICertificateManager { |
| 32 | - /** |
|
| 33 | - * Returns all certificates trusted by the user |
|
| 34 | - * |
|
| 35 | - * @return \OCP\ICertificate[] |
|
| 36 | - * @since 8.0.0 |
|
| 37 | - */ |
|
| 38 | - public function listCertificates(); |
|
| 32 | + /** |
|
| 33 | + * Returns all certificates trusted by the user |
|
| 34 | + * |
|
| 35 | + * @return \OCP\ICertificate[] |
|
| 36 | + * @since 8.0.0 |
|
| 37 | + */ |
|
| 38 | + public function listCertificates(); |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @param string $certificate the certificate data |
|
| 42 | - * @param string $name the filename for the certificate |
|
| 43 | - * @return \OCP\ICertificate |
|
| 44 | - * @throws \Exception If the certificate could not get added |
|
| 45 | - * @since 8.0.0 - since 8.1.0 throws exception instead of returning false |
|
| 46 | - */ |
|
| 47 | - public function addCertificate($certificate, $name); |
|
| 40 | + /** |
|
| 41 | + * @param string $certificate the certificate data |
|
| 42 | + * @param string $name the filename for the certificate |
|
| 43 | + * @return \OCP\ICertificate |
|
| 44 | + * @throws \Exception If the certificate could not get added |
|
| 45 | + * @since 8.0.0 - since 8.1.0 throws exception instead of returning false |
|
| 46 | + */ |
|
| 47 | + public function addCertificate($certificate, $name); |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @param string $name |
|
| 51 | - * @since 8.0.0 |
|
| 52 | - */ |
|
| 53 | - public function removeCertificate($name); |
|
| 49 | + /** |
|
| 50 | + * @param string $name |
|
| 51 | + * @since 8.0.0 |
|
| 52 | + */ |
|
| 53 | + public function removeCertificate($name); |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Get the path to the certificate bundle for this user |
|
| 57 | - * |
|
| 58 | - * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle (since 9.0.0) |
|
| 59 | - * @return string |
|
| 60 | - * @since 8.0.0 |
|
| 61 | - */ |
|
| 62 | - public function getCertificateBundle($uid = ''); |
|
| 55 | + /** |
|
| 56 | + * Get the path to the certificate bundle for this user |
|
| 57 | + * |
|
| 58 | + * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle (since 9.0.0) |
|
| 59 | + * @return string |
|
| 60 | + * @since 8.0.0 |
|
| 61 | + */ |
|
| 62 | + public function getCertificateBundle($uid = ''); |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * Get the full local path to the certificate bundle for this user |
|
| 66 | - * |
|
| 67 | - * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle |
|
| 68 | - * @return string |
|
| 69 | - * @since 9.0.0 |
|
| 70 | - */ |
|
| 71 | - public function getAbsoluteBundlePath($uid = ''); |
|
| 64 | + /** |
|
| 65 | + * Get the full local path to the certificate bundle for this user |
|
| 66 | + * |
|
| 67 | + * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle |
|
| 68 | + * @return string |
|
| 69 | + * @since 9.0.0 |
|
| 70 | + */ |
|
| 71 | + public function getAbsoluteBundlePath($uid = ''); |
|
| 72 | 72 | } |
@@ -33,14 +33,14 @@ |
||
| 33 | 33 | |
| 34 | 34 | interface IAvatarManager { |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * return a user specific instance of \OCP\IAvatar |
|
| 38 | - * @see \OCP\IAvatar |
|
| 39 | - * @param string $user the ownCloud user id |
|
| 40 | - * @return \OCP\IAvatar |
|
| 41 | - * @throws \Exception In case the username is potentially dangerous |
|
| 42 | - * @throws \OCP\Files\NotFoundException In case there is no user folder yet |
|
| 43 | - * @since 6.0.0 |
|
| 44 | - */ |
|
| 45 | - public function getAvatar($user); |
|
| 36 | + /** |
|
| 37 | + * return a user specific instance of \OCP\IAvatar |
|
| 38 | + * @see \OCP\IAvatar |
|
| 39 | + * @param string $user the ownCloud user id |
|
| 40 | + * @return \OCP\IAvatar |
|
| 41 | + * @throws \Exception In case the username is potentially dangerous |
|
| 42 | + * @throws \OCP\Files\NotFoundException In case there is no user folder yet |
|
| 43 | + * @since 6.0.0 |
|
| 44 | + */ |
|
| 45 | + public function getAvatar($user); |
|
| 46 | 46 | } |
@@ -29,158 +29,158 @@ |
||
| 29 | 29 | * @since 8.1.0 |
| 30 | 30 | */ |
| 31 | 31 | interface IImage { |
| 32 | - /** |
|
| 33 | - * Determine whether the object contains an image resource. |
|
| 34 | - * |
|
| 35 | - * @return bool |
|
| 36 | - * @since 8.1.0 |
|
| 37 | - */ |
|
| 38 | - public function valid(); |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Returns the MIME type of the image or an empty string if no image is loaded. |
|
| 42 | - * |
|
| 43 | - * @return string |
|
| 44 | - * @since 8.1.0 |
|
| 45 | - */ |
|
| 46 | - public function mimeType(); |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * Returns the width of the image or -1 if no image is loaded. |
|
| 50 | - * |
|
| 51 | - * @return int |
|
| 52 | - * @since 8.1.0 |
|
| 53 | - */ |
|
| 54 | - public function width(); |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * Returns the height of the image or -1 if no image is loaded. |
|
| 58 | - * |
|
| 59 | - * @return int |
|
| 60 | - * @since 8.1.0 |
|
| 61 | - */ |
|
| 62 | - public function height(); |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * Returns the width when the image orientation is top-left. |
|
| 66 | - * |
|
| 67 | - * @return int |
|
| 68 | - * @since 8.1.0 |
|
| 69 | - */ |
|
| 70 | - public function widthTopLeft(); |
|
| 71 | - |
|
| 72 | - /** |
|
| 73 | - * Returns the height when the image orientation is top-left. |
|
| 74 | - * |
|
| 75 | - * @return int |
|
| 76 | - * @since 8.1.0 |
|
| 77 | - */ |
|
| 78 | - public function heightTopLeft(); |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * Outputs the image. |
|
| 82 | - * |
|
| 83 | - * @param string $mimeType |
|
| 84 | - * @return bool |
|
| 85 | - * @since 8.1.0 |
|
| 86 | - */ |
|
| 87 | - public function show($mimeType = null); |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * Saves the image. |
|
| 91 | - * |
|
| 92 | - * @param string $filePath |
|
| 93 | - * @param string $mimeType |
|
| 94 | - * @return bool |
|
| 95 | - * @since 8.1.0 |
|
| 96 | - */ |
|
| 97 | - public function save($filePath = null, $mimeType = null); |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * @return resource Returns the image resource in any. |
|
| 101 | - * @since 8.1.0 |
|
| 102 | - */ |
|
| 103 | - public function resource(); |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * @return string Returns the raw image data. |
|
| 107 | - * @since 8.1.0 |
|
| 108 | - */ |
|
| 109 | - public function data(); |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * (I'm open for suggestions on better method name ;) |
|
| 113 | - * Get the orientation based on EXIF data. |
|
| 114 | - * |
|
| 115 | - * @return int The orientation or -1 if no EXIF data is available. |
|
| 116 | - * @since 8.1.0 |
|
| 117 | - */ |
|
| 118 | - public function getOrientation(); |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * (I'm open for suggestions on better method name ;) |
|
| 122 | - * Fixes orientation based on EXIF data. |
|
| 123 | - * |
|
| 124 | - * @return bool |
|
| 125 | - * @since 8.1.0 |
|
| 126 | - */ |
|
| 127 | - public function fixOrientation(); |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * Resizes the image preserving ratio. |
|
| 131 | - * |
|
| 132 | - * @param integer $maxSize The maximum size of either the width or height. |
|
| 133 | - * @return bool |
|
| 134 | - * @since 8.1.0 |
|
| 135 | - */ |
|
| 136 | - public function resize($maxSize); |
|
| 137 | - |
|
| 138 | - /** |
|
| 139 | - * @param int $width |
|
| 140 | - * @param int $height |
|
| 141 | - * @return bool |
|
| 142 | - * @since 8.1.0 |
|
| 143 | - */ |
|
| 144 | - public function preciseResize($width, $height); |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * Crops the image to the middle square. If the image is already square it just returns. |
|
| 148 | - * |
|
| 149 | - * @param int $size maximum size for the result (optional) |
|
| 150 | - * @return bool for success or failure |
|
| 151 | - * @since 8.1.0 |
|
| 152 | - */ |
|
| 153 | - public function centerCrop($size = 0); |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * Crops the image from point $x$y with dimension $wx$h. |
|
| 157 | - * |
|
| 158 | - * @param int $x Horizontal position |
|
| 159 | - * @param int $y Vertical position |
|
| 160 | - * @param int $w Width |
|
| 161 | - * @param int $h Height |
|
| 162 | - * @return bool for success or failure |
|
| 163 | - * @since 8.1.0 |
|
| 164 | - */ |
|
| 165 | - public function crop($x, $y, $w, $h); |
|
| 166 | - |
|
| 167 | - /** |
|
| 168 | - * Resizes the image to fit within a boundary while preserving ratio. |
|
| 169 | - * |
|
| 170 | - * @param integer $maxWidth |
|
| 171 | - * @param integer $maxHeight |
|
| 172 | - * @return bool |
|
| 173 | - * @since 8.1.0 |
|
| 174 | - */ |
|
| 175 | - public function fitIn($maxWidth, $maxHeight); |
|
| 176 | - |
|
| 177 | - /** |
|
| 178 | - * Shrinks the image to fit within a boundary while preserving ratio. |
|
| 179 | - * |
|
| 180 | - * @param integer $maxWidth |
|
| 181 | - * @param integer $maxHeight |
|
| 182 | - * @return bool |
|
| 183 | - * @since 8.1.0 |
|
| 184 | - */ |
|
| 185 | - public function scaleDownToFit($maxWidth, $maxHeight); |
|
| 32 | + /** |
|
| 33 | + * Determine whether the object contains an image resource. |
|
| 34 | + * |
|
| 35 | + * @return bool |
|
| 36 | + * @since 8.1.0 |
|
| 37 | + */ |
|
| 38 | + public function valid(); |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Returns the MIME type of the image or an empty string if no image is loaded. |
|
| 42 | + * |
|
| 43 | + * @return string |
|
| 44 | + * @since 8.1.0 |
|
| 45 | + */ |
|
| 46 | + public function mimeType(); |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * Returns the width of the image or -1 if no image is loaded. |
|
| 50 | + * |
|
| 51 | + * @return int |
|
| 52 | + * @since 8.1.0 |
|
| 53 | + */ |
|
| 54 | + public function width(); |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * Returns the height of the image or -1 if no image is loaded. |
|
| 58 | + * |
|
| 59 | + * @return int |
|
| 60 | + * @since 8.1.0 |
|
| 61 | + */ |
|
| 62 | + public function height(); |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * Returns the width when the image orientation is top-left. |
|
| 66 | + * |
|
| 67 | + * @return int |
|
| 68 | + * @since 8.1.0 |
|
| 69 | + */ |
|
| 70 | + public function widthTopLeft(); |
|
| 71 | + |
|
| 72 | + /** |
|
| 73 | + * Returns the height when the image orientation is top-left. |
|
| 74 | + * |
|
| 75 | + * @return int |
|
| 76 | + * @since 8.1.0 |
|
| 77 | + */ |
|
| 78 | + public function heightTopLeft(); |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * Outputs the image. |
|
| 82 | + * |
|
| 83 | + * @param string $mimeType |
|
| 84 | + * @return bool |
|
| 85 | + * @since 8.1.0 |
|
| 86 | + */ |
|
| 87 | + public function show($mimeType = null); |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * Saves the image. |
|
| 91 | + * |
|
| 92 | + * @param string $filePath |
|
| 93 | + * @param string $mimeType |
|
| 94 | + * @return bool |
|
| 95 | + * @since 8.1.0 |
|
| 96 | + */ |
|
| 97 | + public function save($filePath = null, $mimeType = null); |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * @return resource Returns the image resource in any. |
|
| 101 | + * @since 8.1.0 |
|
| 102 | + */ |
|
| 103 | + public function resource(); |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * @return string Returns the raw image data. |
|
| 107 | + * @since 8.1.0 |
|
| 108 | + */ |
|
| 109 | + public function data(); |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * (I'm open for suggestions on better method name ;) |
|
| 113 | + * Get the orientation based on EXIF data. |
|
| 114 | + * |
|
| 115 | + * @return int The orientation or -1 if no EXIF data is available. |
|
| 116 | + * @since 8.1.0 |
|
| 117 | + */ |
|
| 118 | + public function getOrientation(); |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * (I'm open for suggestions on better method name ;) |
|
| 122 | + * Fixes orientation based on EXIF data. |
|
| 123 | + * |
|
| 124 | + * @return bool |
|
| 125 | + * @since 8.1.0 |
|
| 126 | + */ |
|
| 127 | + public function fixOrientation(); |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * Resizes the image preserving ratio. |
|
| 131 | + * |
|
| 132 | + * @param integer $maxSize The maximum size of either the width or height. |
|
| 133 | + * @return bool |
|
| 134 | + * @since 8.1.0 |
|
| 135 | + */ |
|
| 136 | + public function resize($maxSize); |
|
| 137 | + |
|
| 138 | + /** |
|
| 139 | + * @param int $width |
|
| 140 | + * @param int $height |
|
| 141 | + * @return bool |
|
| 142 | + * @since 8.1.0 |
|
| 143 | + */ |
|
| 144 | + public function preciseResize($width, $height); |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * Crops the image to the middle square. If the image is already square it just returns. |
|
| 148 | + * |
|
| 149 | + * @param int $size maximum size for the result (optional) |
|
| 150 | + * @return bool for success or failure |
|
| 151 | + * @since 8.1.0 |
|
| 152 | + */ |
|
| 153 | + public function centerCrop($size = 0); |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * Crops the image from point $x$y with dimension $wx$h. |
|
| 157 | + * |
|
| 158 | + * @param int $x Horizontal position |
|
| 159 | + * @param int $y Vertical position |
|
| 160 | + * @param int $w Width |
|
| 161 | + * @param int $h Height |
|
| 162 | + * @return bool for success or failure |
|
| 163 | + * @since 8.1.0 |
|
| 164 | + */ |
|
| 165 | + public function crop($x, $y, $w, $h); |
|
| 166 | + |
|
| 167 | + /** |
|
| 168 | + * Resizes the image to fit within a boundary while preserving ratio. |
|
| 169 | + * |
|
| 170 | + * @param integer $maxWidth |
|
| 171 | + * @param integer $maxHeight |
|
| 172 | + * @return bool |
|
| 173 | + * @since 8.1.0 |
|
| 174 | + */ |
|
| 175 | + public function fitIn($maxWidth, $maxHeight); |
|
| 176 | + |
|
| 177 | + /** |
|
| 178 | + * Shrinks the image to fit within a boundary while preserving ratio. |
|
| 179 | + * |
|
| 180 | + * @param integer $maxWidth |
|
| 181 | + * @param integer $maxHeight |
|
| 182 | + * @return bool |
|
| 183 | + * @since 8.1.0 |
|
| 184 | + */ |
|
| 185 | + public function scaleDownToFit($maxWidth, $maxHeight); |
|
| 186 | 186 | } |
@@ -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 | } |
@@ -37,55 +37,55 @@ |
||
| 37 | 37 | * @since 8.1.0 |
| 38 | 38 | */ |
| 39 | 39 | interface IMemcache extends ICache { |
| 40 | - /** |
|
| 41 | - * Set a value in the cache if it's not already stored |
|
| 42 | - * |
|
| 43 | - * @param string $key |
|
| 44 | - * @param mixed $value |
|
| 45 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 46 | - * @return bool |
|
| 47 | - * @since 8.1.0 |
|
| 48 | - */ |
|
| 49 | - public function add($key, $value, $ttl = 0); |
|
| 40 | + /** |
|
| 41 | + * Set a value in the cache if it's not already stored |
|
| 42 | + * |
|
| 43 | + * @param string $key |
|
| 44 | + * @param mixed $value |
|
| 45 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 46 | + * @return bool |
|
| 47 | + * @since 8.1.0 |
|
| 48 | + */ |
|
| 49 | + public function add($key, $value, $ttl = 0); |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Increase a stored number |
|
| 53 | - * |
|
| 54 | - * @param string $key |
|
| 55 | - * @param int $step |
|
| 56 | - * @return int | bool |
|
| 57 | - * @since 8.1.0 |
|
| 58 | - */ |
|
| 59 | - public function inc($key, $step = 1); |
|
| 51 | + /** |
|
| 52 | + * Increase a stored number |
|
| 53 | + * |
|
| 54 | + * @param string $key |
|
| 55 | + * @param int $step |
|
| 56 | + * @return int | bool |
|
| 57 | + * @since 8.1.0 |
|
| 58 | + */ |
|
| 59 | + public function inc($key, $step = 1); |
|
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Decrease a stored number |
|
| 63 | - * |
|
| 64 | - * @param string $key |
|
| 65 | - * @param int $step |
|
| 66 | - * @return int | bool |
|
| 67 | - * @since 8.1.0 |
|
| 68 | - */ |
|
| 69 | - public function dec($key, $step = 1); |
|
| 61 | + /** |
|
| 62 | + * Decrease a stored number |
|
| 63 | + * |
|
| 64 | + * @param string $key |
|
| 65 | + * @param int $step |
|
| 66 | + * @return int | bool |
|
| 67 | + * @since 8.1.0 |
|
| 68 | + */ |
|
| 69 | + public function dec($key, $step = 1); |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Compare and set |
|
| 73 | - * |
|
| 74 | - * @param string $key |
|
| 75 | - * @param mixed $old |
|
| 76 | - * @param mixed $new |
|
| 77 | - * @return bool |
|
| 78 | - * @since 8.1.0 |
|
| 79 | - */ |
|
| 80 | - public function cas($key, $old, $new); |
|
| 71 | + /** |
|
| 72 | + * Compare and set |
|
| 73 | + * |
|
| 74 | + * @param string $key |
|
| 75 | + * @param mixed $old |
|
| 76 | + * @param mixed $new |
|
| 77 | + * @return bool |
|
| 78 | + * @since 8.1.0 |
|
| 79 | + */ |
|
| 80 | + public function cas($key, $old, $new); |
|
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Compare and delete |
|
| 84 | - * |
|
| 85 | - * @param string $key |
|
| 86 | - * @param mixed $old |
|
| 87 | - * @return bool |
|
| 88 | - * @since 8.1.0 |
|
| 89 | - */ |
|
| 90 | - public function cad($key, $old); |
|
| 82 | + /** |
|
| 83 | + * Compare and delete |
|
| 84 | + * |
|
| 85 | + * @param string $key |
|
| 86 | + * @param mixed $old |
|
| 87 | + * @return bool |
|
| 88 | + * @since 8.1.0 |
|
| 89 | + */ |
|
| 90 | + public function cad($key, $old); |
|
| 91 | 91 | } |
@@ -50,44 +50,44 @@ |
||
| 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 | } |
@@ -32,13 +32,13 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | interface IFile { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * get list of users with access to the file |
|
| 37 | - * |
|
| 38 | - * @param string $path to the file |
|
| 39 | - * @return array |
|
| 40 | - * @since 8.1.0 |
|
| 41 | - */ |
|
| 42 | - public function getAccessList($path); |
|
| 35 | + /** |
|
| 36 | + * get list of users with access to the file |
|
| 37 | + * |
|
| 38 | + * @param string $path to the file |
|
| 39 | + * @return array |
|
| 40 | + * @since 8.1.0 |
|
| 41 | + */ |
|
| 42 | + public function getAccessList($path); |
|
| 43 | 43 | |
| 44 | 44 | } |
@@ -34,67 +34,67 @@ |
||
| 34 | 34 | */ |
| 35 | 35 | interface IManager { |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * Check if encryption is available (at least one encryption module needs to be enabled) |
|
| 39 | - * |
|
| 40 | - * @return bool true if enabled, false if not |
|
| 41 | - * @since 8.1.0 |
|
| 42 | - */ |
|
| 43 | - public function isEnabled(); |
|
| 37 | + /** |
|
| 38 | + * Check if encryption is available (at least one encryption module needs to be enabled) |
|
| 39 | + * |
|
| 40 | + * @return bool true if enabled, false if not |
|
| 41 | + * @since 8.1.0 |
|
| 42 | + */ |
|
| 43 | + public function isEnabled(); |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Registers an callback function which must return an encryption module instance |
|
| 47 | - * |
|
| 48 | - * @param string $id |
|
| 49 | - * @param string $displayName |
|
| 50 | - * @param callable $callback |
|
| 51 | - * @throws ModuleAlreadyExistsException |
|
| 52 | - * @since 8.1.0 |
|
| 53 | - */ |
|
| 54 | - public function registerEncryptionModule($id, $displayName, callable $callback); |
|
| 45 | + /** |
|
| 46 | + * Registers an callback function which must return an encryption module instance |
|
| 47 | + * |
|
| 48 | + * @param string $id |
|
| 49 | + * @param string $displayName |
|
| 50 | + * @param callable $callback |
|
| 51 | + * @throws ModuleAlreadyExistsException |
|
| 52 | + * @since 8.1.0 |
|
| 53 | + */ |
|
| 54 | + public function registerEncryptionModule($id, $displayName, callable $callback); |
|
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * Unregisters an encryption module |
|
| 58 | - * |
|
| 59 | - * @param string $moduleId |
|
| 60 | - * @since 8.1.0 |
|
| 61 | - */ |
|
| 62 | - public function unregisterEncryptionModule($moduleId); |
|
| 56 | + /** |
|
| 57 | + * Unregisters an encryption module |
|
| 58 | + * |
|
| 59 | + * @param string $moduleId |
|
| 60 | + * @since 8.1.0 |
|
| 61 | + */ |
|
| 62 | + public function unregisterEncryptionModule($moduleId); |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * get a list of all encryption modules |
|
| 66 | - * |
|
| 67 | - * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
| 68 | - * @since 8.1.0 |
|
| 69 | - */ |
|
| 70 | - public function getEncryptionModules(); |
|
| 64 | + /** |
|
| 65 | + * get a list of all encryption modules |
|
| 66 | + * |
|
| 67 | + * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
| 68 | + * @since 8.1.0 |
|
| 69 | + */ |
|
| 70 | + public function getEncryptionModules(); |
|
| 71 | 71 | |
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * get a specific encryption module |
|
| 75 | - * |
|
| 76 | - * @param string $moduleId Empty to get the default module |
|
| 77 | - * @return IEncryptionModule |
|
| 78 | - * @throws ModuleDoesNotExistsException |
|
| 79 | - * @since 8.1.0 |
|
| 80 | - */ |
|
| 81 | - public function getEncryptionModule($moduleId = ''); |
|
| 73 | + /** |
|
| 74 | + * get a specific encryption module |
|
| 75 | + * |
|
| 76 | + * @param string $moduleId Empty to get the default module |
|
| 77 | + * @return IEncryptionModule |
|
| 78 | + * @throws ModuleDoesNotExistsException |
|
| 79 | + * @since 8.1.0 |
|
| 80 | + */ |
|
| 81 | + public function getEncryptionModule($moduleId = ''); |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * get default encryption module Id |
|
| 85 | - * |
|
| 86 | - * @return string |
|
| 87 | - * @since 8.1.0 |
|
| 88 | - */ |
|
| 89 | - public function getDefaultEncryptionModuleId(); |
|
| 83 | + /** |
|
| 84 | + * get default encryption module Id |
|
| 85 | + * |
|
| 86 | + * @return string |
|
| 87 | + * @since 8.1.0 |
|
| 88 | + */ |
|
| 89 | + public function getDefaultEncryptionModuleId(); |
|
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * set default encryption module Id |
|
| 93 | - * |
|
| 94 | - * @param string $moduleId |
|
| 95 | - * @return string |
|
| 96 | - * @since 8.1.0 |
|
| 97 | - */ |
|
| 98 | - public function setDefaultEncryptionModule($moduleId); |
|
| 91 | + /** |
|
| 92 | + * set default encryption module Id |
|
| 93 | + * |
|
| 94 | + * @param string $moduleId |
|
| 95 | + * @return string |
|
| 96 | + * @since 8.1.0 |
|
| 97 | + */ |
|
| 98 | + public function setDefaultEncryptionModule($moduleId); |
|
| 99 | 99 | |
| 100 | 100 | } |
@@ -33,151 +33,151 @@ |
||
| 33 | 33 | */ |
| 34 | 34 | interface IStorage { |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * get user specific key |
|
| 38 | - * |
|
| 39 | - * @param string $uid ID if the user for whom we want the key |
|
| 40 | - * @param string $keyId id of the key |
|
| 41 | - * @param string $encryptionModuleId |
|
| 42 | - * |
|
| 43 | - * @return mixed key |
|
| 44 | - * @since 8.1.0 |
|
| 45 | - */ |
|
| 46 | - public function getUserKey($uid, $keyId, $encryptionModuleId); |
|
| 36 | + /** |
|
| 37 | + * get user specific key |
|
| 38 | + * |
|
| 39 | + * @param string $uid ID if the user for whom we want the key |
|
| 40 | + * @param string $keyId id of the key |
|
| 41 | + * @param string $encryptionModuleId |
|
| 42 | + * |
|
| 43 | + * @return mixed key |
|
| 44 | + * @since 8.1.0 |
|
| 45 | + */ |
|
| 46 | + public function getUserKey($uid, $keyId, $encryptionModuleId); |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * get file specific key |
|
| 50 | - * |
|
| 51 | - * @param string $path path to file |
|
| 52 | - * @param string $keyId id of the key |
|
| 53 | - * @param string $encryptionModuleId |
|
| 54 | - * |
|
| 55 | - * @return mixed key |
|
| 56 | - * @since 8.1.0 |
|
| 57 | - */ |
|
| 58 | - public function getFileKey($path, $keyId, $encryptionModuleId); |
|
| 48 | + /** |
|
| 49 | + * get file specific key |
|
| 50 | + * |
|
| 51 | + * @param string $path path to file |
|
| 52 | + * @param string $keyId id of the key |
|
| 53 | + * @param string $encryptionModuleId |
|
| 54 | + * |
|
| 55 | + * @return mixed key |
|
| 56 | + * @since 8.1.0 |
|
| 57 | + */ |
|
| 58 | + public function getFileKey($path, $keyId, $encryptionModuleId); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * get system-wide encryption keys not related to a specific user, |
|
| 62 | - * e.g something like a key for public link shares |
|
| 63 | - * |
|
| 64 | - * @param string $keyId id of the key |
|
| 65 | - * @param string $encryptionModuleId |
|
| 66 | - * |
|
| 67 | - * @return mixed key |
|
| 68 | - * @since 8.1.0 |
|
| 69 | - */ |
|
| 70 | - public function getSystemUserKey($keyId, $encryptionModuleId); |
|
| 60 | + /** |
|
| 61 | + * get system-wide encryption keys not related to a specific user, |
|
| 62 | + * e.g something like a key for public link shares |
|
| 63 | + * |
|
| 64 | + * @param string $keyId id of the key |
|
| 65 | + * @param string $encryptionModuleId |
|
| 66 | + * |
|
| 67 | + * @return mixed key |
|
| 68 | + * @since 8.1.0 |
|
| 69 | + */ |
|
| 70 | + public function getSystemUserKey($keyId, $encryptionModuleId); |
|
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * set user specific key |
|
| 74 | - * |
|
| 75 | - * @param string $uid ID if the user for whom we want the key |
|
| 76 | - * @param string $keyId id of the key |
|
| 77 | - * @param mixed $key |
|
| 78 | - * @param string $encryptionModuleId |
|
| 79 | - * @since 8.1.0 |
|
| 80 | - */ |
|
| 81 | - public function setUserKey($uid, $keyId, $key, $encryptionModuleId); |
|
| 72 | + /** |
|
| 73 | + * set user specific key |
|
| 74 | + * |
|
| 75 | + * @param string $uid ID if the user for whom we want the key |
|
| 76 | + * @param string $keyId id of the key |
|
| 77 | + * @param mixed $key |
|
| 78 | + * @param string $encryptionModuleId |
|
| 79 | + * @since 8.1.0 |
|
| 80 | + */ |
|
| 81 | + public function setUserKey($uid, $keyId, $key, $encryptionModuleId); |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * set file specific key |
|
| 85 | - * |
|
| 86 | - * @param string $path path to file |
|
| 87 | - * @param string $keyId id of the key |
|
| 88 | - * @param mixed $key |
|
| 89 | - * @param string $encryptionModuleId |
|
| 90 | - * @since 8.1.0 |
|
| 91 | - */ |
|
| 92 | - public function setFileKey($path, $keyId, $key, $encryptionModuleId); |
|
| 83 | + /** |
|
| 84 | + * set file specific key |
|
| 85 | + * |
|
| 86 | + * @param string $path path to file |
|
| 87 | + * @param string $keyId id of the key |
|
| 88 | + * @param mixed $key |
|
| 89 | + * @param string $encryptionModuleId |
|
| 90 | + * @since 8.1.0 |
|
| 91 | + */ |
|
| 92 | + public function setFileKey($path, $keyId, $key, $encryptionModuleId); |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * set system-wide encryption keys not related to a specific user, |
|
| 96 | - * e.g something like a key for public link shares |
|
| 97 | - * |
|
| 98 | - * @param string $keyId id of the key |
|
| 99 | - * @param mixed $key |
|
| 100 | - * @param string $encryptionModuleId |
|
| 101 | - * |
|
| 102 | - * @return mixed key |
|
| 103 | - * @since 8.1.0 |
|
| 104 | - */ |
|
| 105 | - public function setSystemUserKey($keyId, $key, $encryptionModuleId); |
|
| 94 | + /** |
|
| 95 | + * set system-wide encryption keys not related to a specific user, |
|
| 96 | + * e.g something like a key for public link shares |
|
| 97 | + * |
|
| 98 | + * @param string $keyId id of the key |
|
| 99 | + * @param mixed $key |
|
| 100 | + * @param string $encryptionModuleId |
|
| 101 | + * |
|
| 102 | + * @return mixed key |
|
| 103 | + * @since 8.1.0 |
|
| 104 | + */ |
|
| 105 | + public function setSystemUserKey($keyId, $key, $encryptionModuleId); |
|
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * delete user specific key |
|
| 109 | - * |
|
| 110 | - * @param string $uid ID if the user for whom we want to delete the key |
|
| 111 | - * @param string $keyId id of the key |
|
| 112 | - * @param string $encryptionModuleId |
|
| 113 | - * |
|
| 114 | - * @return boolean False when the key could not be deleted |
|
| 115 | - * @since 8.1.0 |
|
| 116 | - */ |
|
| 117 | - public function deleteUserKey($uid, $keyId, $encryptionModuleId); |
|
| 107 | + /** |
|
| 108 | + * delete user specific key |
|
| 109 | + * |
|
| 110 | + * @param string $uid ID if the user for whom we want to delete the key |
|
| 111 | + * @param string $keyId id of the key |
|
| 112 | + * @param string $encryptionModuleId |
|
| 113 | + * |
|
| 114 | + * @return boolean False when the key could not be deleted |
|
| 115 | + * @since 8.1.0 |
|
| 116 | + */ |
|
| 117 | + public function deleteUserKey($uid, $keyId, $encryptionModuleId); |
|
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * delete file specific key |
|
| 121 | - * |
|
| 122 | - * @param string $path path to file |
|
| 123 | - * @param string $keyId id of the key |
|
| 124 | - * @param string $encryptionModuleId |
|
| 125 | - * |
|
| 126 | - * @return boolean False when the key could not be deleted |
|
| 127 | - * @since 8.1.0 |
|
| 128 | - */ |
|
| 129 | - public function deleteFileKey($path, $keyId, $encryptionModuleId); |
|
| 119 | + /** |
|
| 120 | + * delete file specific key |
|
| 121 | + * |
|
| 122 | + * @param string $path path to file |
|
| 123 | + * @param string $keyId id of the key |
|
| 124 | + * @param string $encryptionModuleId |
|
| 125 | + * |
|
| 126 | + * @return boolean False when the key could not be deleted |
|
| 127 | + * @since 8.1.0 |
|
| 128 | + */ |
|
| 129 | + public function deleteFileKey($path, $keyId, $encryptionModuleId); |
|
| 130 | 130 | |
| 131 | - /** |
|
| 132 | - * delete all file keys for a given file |
|
| 133 | - * |
|
| 134 | - * @param string $path to the file |
|
| 135 | - * |
|
| 136 | - * @return boolean False when the keys could not be deleted |
|
| 137 | - * @since 8.1.0 |
|
| 138 | - */ |
|
| 139 | - public function deleteAllFileKeys($path); |
|
| 131 | + /** |
|
| 132 | + * delete all file keys for a given file |
|
| 133 | + * |
|
| 134 | + * @param string $path to the file |
|
| 135 | + * |
|
| 136 | + * @return boolean False when the keys could not be deleted |
|
| 137 | + * @since 8.1.0 |
|
| 138 | + */ |
|
| 139 | + public function deleteAllFileKeys($path); |
|
| 140 | 140 | |
| 141 | - /** |
|
| 142 | - * delete system-wide encryption keys not related to a specific user, |
|
| 143 | - * e.g something like a key for public link shares |
|
| 144 | - * |
|
| 145 | - * @param string $keyId id of the key |
|
| 146 | - * @param string $encryptionModuleId |
|
| 147 | - * |
|
| 148 | - * @return boolean False when the key could not be deleted |
|
| 149 | - * @since 8.1.0 |
|
| 150 | - */ |
|
| 151 | - public function deleteSystemUserKey($keyId, $encryptionModuleId); |
|
| 141 | + /** |
|
| 142 | + * delete system-wide encryption keys not related to a specific user, |
|
| 143 | + * e.g something like a key for public link shares |
|
| 144 | + * |
|
| 145 | + * @param string $keyId id of the key |
|
| 146 | + * @param string $encryptionModuleId |
|
| 147 | + * |
|
| 148 | + * @return boolean False when the key could not be deleted |
|
| 149 | + * @since 8.1.0 |
|
| 150 | + */ |
|
| 151 | + public function deleteSystemUserKey($keyId, $encryptionModuleId); |
|
| 152 | 152 | |
| 153 | - /** |
|
| 154 | - * copy keys if a file was renamed |
|
| 155 | - * |
|
| 156 | - * @param string $source |
|
| 157 | - * @param string $target |
|
| 158 | - * @return boolean |
|
| 159 | - * @since 8.1.0 |
|
| 160 | - */ |
|
| 161 | - public function renameKeys($source, $target); |
|
| 153 | + /** |
|
| 154 | + * copy keys if a file was renamed |
|
| 155 | + * |
|
| 156 | + * @param string $source |
|
| 157 | + * @param string $target |
|
| 158 | + * @return boolean |
|
| 159 | + * @since 8.1.0 |
|
| 160 | + */ |
|
| 161 | + public function renameKeys($source, $target); |
|
| 162 | 162 | |
| 163 | - /** |
|
| 164 | - * move keys if a file was renamed |
|
| 165 | - * |
|
| 166 | - * @param string $source |
|
| 167 | - * @param string $target |
|
| 168 | - * @return boolean |
|
| 169 | - * @since 8.1.0 |
|
| 170 | - */ |
|
| 171 | - public function copyKeys($source, $target); |
|
| 163 | + /** |
|
| 164 | + * move keys if a file was renamed |
|
| 165 | + * |
|
| 166 | + * @param string $source |
|
| 167 | + * @param string $target |
|
| 168 | + * @return boolean |
|
| 169 | + * @since 8.1.0 |
|
| 170 | + */ |
|
| 171 | + public function copyKeys($source, $target); |
|
| 172 | 172 | |
| 173 | - /** |
|
| 174 | - * backup keys of a given encryption module |
|
| 175 | - * |
|
| 176 | - * @param string $encryptionModuleId |
|
| 177 | - * @param string $purpose |
|
| 178 | - * @param string $uid |
|
| 179 | - * @return bool |
|
| 180 | - * @since 12.0.0 |
|
| 181 | - */ |
|
| 182 | - public function backupUserKeys($encryptionModuleId, $purpose, $uid); |
|
| 173 | + /** |
|
| 174 | + * backup keys of a given encryption module |
|
| 175 | + * |
|
| 176 | + * @param string $encryptionModuleId |
|
| 177 | + * @param string $purpose |
|
| 178 | + * @param string $uid |
|
| 179 | + * @return bool |
|
| 180 | + * @since 12.0.0 |
|
| 181 | + */ |
|
| 182 | + public function backupUserKeys($encryptionModuleId, $purpose, $uid); |
|
| 183 | 183 | } |