MetadataLiveEvent.php 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2023 Maxence Lange <maxence@artificial-owl.com>
  5. *
  6. * @author Maxence Lange <maxence@artificial-owl.com>
  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\FilesMetadata\Event;
  25. use OCP\FilesMetadata\AMetadataEvent;
  26. /**
  27. * MetadataLiveEvent is an event initiated when a file is created or updated.
  28. * The app contains the Node related to the created/updated file, and a FilesMetadata that already
  29. * contains the currently known metadata.
  30. *
  31. * Setting new metadata, or modifying already existing metadata with different value, will trigger
  32. * the save of the metadata in the database.
  33. *
  34. * @see AMetadataEvent::getMetadata()
  35. * @see AMetadataEvent::getNode()
  36. * @see MetadataLiveEvent::requestBackgroundJob()
  37. * @since 28.0.0
  38. */
  39. class MetadataLiveEvent extends AMetadataEvent {
  40. private bool $runAsBackgroundJob = false;
  41. /**
  42. * For heavy process, call this method if your app prefers to update metadata on a
  43. * background/cron job, instead of the live process.
  44. * A similar MetadataBackgroundEvent will be broadcast on next cron tick.
  45. *
  46. * @return void
  47. * @since 28.0.0
  48. */
  49. public function requestBackgroundJob(): void {
  50. $this->runAsBackgroundJob = true;
  51. }
  52. /**
  53. * return true if any app that catch this event requested a re-run as background job
  54. *
  55. * @return bool
  56. * @since 28.0.0
  57. */
  58. public function isRunAsBackgroundJobRequested(): bool {
  59. return $this->runAsBackgroundJob;
  60. }
  61. }