IProvider.php 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Joas Schilling <coding@schilljs.com>
  6. * @author Morris Jobke <hey@morrisjobke.de>
  7. *
  8. * @license AGPL-3.0
  9. *
  10. * This code is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License, version 3,
  12. * as published by the Free Software Foundation.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License, version 3,
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>
  21. *
  22. */
  23. namespace OCP\Preview;
  24. /**
  25. * Interface IProvider
  26. *
  27. * @package OCP\Preview
  28. * @since 8.1.0
  29. */
  30. interface IProvider {
  31. /**
  32. * @return string Regex with the mimetypes that are supported by this provider
  33. * @since 8.1.0
  34. */
  35. public function getMimeType();
  36. /**
  37. * Check if a preview can be generated for $path
  38. *
  39. * @param \OCP\Files\FileInfo $file
  40. * @return bool
  41. * @since 8.1.0
  42. */
  43. public function isAvailable(\OCP\Files\FileInfo $file);
  44. /**
  45. * get thumbnail for file at path $path
  46. *
  47. * @param string $path Path of file
  48. * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
  49. * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
  50. * @param bool $scalingup Disable/Enable upscaling of previews
  51. * @param \OC\Files\View $fileview fileview object of user folder
  52. * @return bool|\OCP\IImage false if no preview was generated
  53. * @since 8.1.0
  54. */
  55. public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview);
  56. }