BeforePreviewFetchedEvent.php 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2022 Julius Härtl <jus@bitgrid.net>
  5. *
  6. * @author Julius Härtl <jus@bitgrid.net>
  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. namespace OCP\Preview;
  24. use OCP\Files\Node;
  25. use OCP\IPreview;
  26. /**
  27. * @since 25.0.1
  28. */
  29. class BeforePreviewFetchedEvent extends \OCP\EventDispatcher\Event {
  30. /**
  31. * @since 25.0.1
  32. */
  33. public function __construct(
  34. private Node $node,
  35. /** @deprecated 28.0.0 null deprecated **/
  36. private ?int $width = null,
  37. /** @deprecated 28.0.0 null deprecated **/
  38. private ?int $height = null,
  39. /** @deprecated 28.0.0 null deprecated **/
  40. private ?bool $crop = null,
  41. /** @deprecated 28.0.0 null deprecated **/
  42. private ?string $mode = null,
  43. ) {
  44. parent::__construct();
  45. }
  46. /**
  47. * @since 25.0.1
  48. */
  49. public function getNode(): Node {
  50. return $this->node;
  51. }
  52. /**
  53. * @since 28.0.0
  54. */
  55. public function getWidth(): ?int {
  56. return $this->width;
  57. }
  58. /**
  59. * @since 28.0.0
  60. */
  61. public function getHeight(): ?int {
  62. return $this->height;
  63. }
  64. /**
  65. * @since 28.0.0
  66. */
  67. public function isCrop(): ?bool {
  68. return $this->crop;
  69. }
  70. /**
  71. * @since 28.0.0
  72. * @return null|IPreview::MODE_FILL|IPreview::MODE_COVER
  73. */
  74. public function getMode(): ?string {
  75. return $this->mode;
  76. }
  77. }