blob: 0363d385d364c110f62b0c801d2bce043d1158da (
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Files\Events;
use OCP\EventDispatcher\Event;
use OCP\Files\Folder;
/**
* This event is triggered before a archive is created when a user requested
* downloading a folder or multiple files.
*
* By setting `successful` to false the tar creation can be aborted and the download denied.
*
* @since 25.0.0
*/
class BeforeZipCreatedEvent extends Event {
private string $directory;
private bool $successful = true;
private ?string $errorMessage = null;
private ?Folder $folder = null;
/**
* @param list<string> $files
* @since 25.0.0
* @since 31.0.0 support `OCP\Files\Folder` as `$directory` parameter - passing a string is deprecated now
*/
public function __construct(
string|Folder $directory,
private array $files,
) {
parent::__construct();
if ($directory instanceof Folder) {
$this->directory = $directory->getPath();
$this->folder = $directory;
} else {
$this->directory = $directory;
}
}
/**
* @since 31.0.0
*/
public function getFolder(): ?Folder {
return $this->folder;
}
/**
* @since 25.0.0
*/
public function getDirectory(): string {
return $this->directory;
}
/**
* @since 25.0.0
*/
public function getFiles(): array {
return $this->files;
}
/**
* @since 25.0.0
*/
public function isSuccessful(): bool {
return $this->successful;
}
/**
* Set if the event was successful
*
* @since 25.0.0
*/
public function setSuccessful(bool $successful): void {
$this->successful = $successful;
}
/**
* Get the error message, if any
* @since 25.0.0
*/
public function getErrorMessage(): ?string {
return $this->errorMessage;
}
/**
* @since 25.0.0
*/
public function setErrorMessage(string $errorMessage): void {
$this->errorMessage = $errorMessage;
}
}
|
