blob: cbba6a5d6d917cf45d46b3d754b651b51353ab58 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\FilesMetadata\Event;
use OCP\FilesMetadata\AMetadataEvent;
/**
* MetadataLiveEvent is an event initiated when a file is created or updated.
* The app contains the Node related to the created/updated file, and a FilesMetadata that already
* contains the currently known metadata.
*
* Setting new metadata, or modifying already existing metadata with different value, will trigger
* the save of the metadata in the database.
*
* @see AMetadataEvent::getMetadata()
* @see AMetadataEvent::getNode()
* @see MetadataLiveEvent::requestBackgroundJob()
* @since 28.0.0
*/
class MetadataLiveEvent extends AMetadataEvent {
private bool $runAsBackgroundJob = false;
/**
* For heavy process, call this method if your app prefers to update metadata on a
* background/cron job, instead of the live process.
* A similar MetadataBackgroundEvent will be broadcast on next cron tick.
*
* @return void
* @since 28.0.0
*/
public function requestBackgroundJob(): void {
$this->runAsBackgroundJob = true;
}
/**
* return true if any app that catch this event requested a re-run as background job
*
* @return bool
* @since 28.0.0
*/
public function isRunAsBackgroundJobRequested(): bool {
return $this->runAsBackgroundJob;
}
}
|
