IProviderV2.php 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019 Robin Appelman <robin@icewind.nl>
  5. *
  6. * @author Robin Appelman <robin@icewind.nl>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\Preview;
  25. use OCP\Files\File;
  26. use OCP\Files\FileInfo;
  27. use OCP\IImage;
  28. /**
  29. * @since 17.0.0
  30. */
  31. interface IProviderV2 {
  32. /**
  33. * @return string Regex with the mimetypes that are supported by this provider
  34. * @since 17.0.0
  35. */
  36. public function getMimeType(): string;
  37. /**
  38. * Check if a preview can be generated for $path
  39. *
  40. * @param FileInfo $file
  41. * @return bool
  42. * @since 17.0.0
  43. */
  44. public function isAvailable(FileInfo $file): bool;
  45. /**
  46. * get thumbnail for file at path $path
  47. *
  48. * @param File $file
  49. * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
  50. * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
  51. * @return null|\OCP\IImage null if no preview was generated
  52. * @since 17.0.0
  53. */
  54. public function getThumbnail(File $file, int $maxX, int $maxY): ?IImage;
  55. }