Repository navigation
Expand file tree
/
Copy pathPreFileDownloadEvent.php
More file actions
158 lines (139 loc) · 3.56 KB
/
Copy pathPreFileDownloadEvent.php
File metadata and controls
158 lines (139 loc) · 3.56 KB
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<?php declare(strict_types=1);
/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Composer\Plugin;
use Composer\EventDispatcher\Event;
use Composer\Util\HttpDownloader;
/**
* The pre file download event.
*
* @author Nils Adermann <naderman@naderman.de>
*/
class PreFileDownloadEvent extends Event
{
/**
* @var HttpDownloader
*/
private $httpDownloader;
/**
* @var non-empty-string
*/
private $processedUrl;
/**
* @var string|null
*/
private $customCacheKey;
/**
* @var string
*/
private $type;
/**
* @var mixed
*/
private $context;
/**
* @var mixed[]
*/
private $transportOptions = [];
/**
* Constructor.
*
* @param string $name The event name
* @param mixed $context
* @param non-empty-string $processedUrl
*/
public function __construct(string $name, HttpDownloader $httpDownloader, string $processedUrl, string $type, $context = null)
{
parent::__construct($name);
$this->httpDownloader = $httpDownloader;
$this->processedUrl = $processedUrl;
$this->type = $type;
$this->context = $context;
}
public function getHttpDownloader(): HttpDownloader
{
return $this->httpDownloader;
}
/**
* Retrieves the processed URL that will be downloaded.
*
* @return non-empty-string
*/
public function getProcessedUrl(): string
{
return $this->processedUrl;
}
/**
* Sets the processed URL that will be downloaded.
*
* @param non-empty-string $processedUrl New processed URL
*/
public function setProcessedUrl(string $processedUrl): void
{
$this->processedUrl = $processedUrl;
}
/**
* Retrieves a custom package cache key for this download.
*/
public function getCustomCacheKey(): ?string
{
return $this->customCacheKey;
}
/**
* Sets a custom package cache key for this download.
*
* @param string|null $customCacheKey New cache key
*/
public function setCustomCacheKey(?string $customCacheKey): void
{
$this->customCacheKey = $customCacheKey;
}
/**
* Returns the type of this download (package, metadata).
*/
public function getType(): string
{
return $this->type;
}
/**
* Returns the context of this download, if any.
*
* If this download is of type package, the package object is returned.
* If the type is metadata, an array{repository: RepositoryInterface} is returned.
*
* @return mixed
*/
public function getContext()
{
return $this->context;
}
/**
* Returns transport options for the download.
*
* Only available for events with type metadata, for packages set the transport options on the package itself.
*
* @return mixed[]
*/
public function getTransportOptions(): array
{
return $this->transportOptions;
}
/**
* Sets transport options for the download.
*
* Only available for events with type metadata, for packages set the transport options on the package itself.
*
* @param mixed[] $options
*/
public function setTransportOptions(array $options): void
{
$this->transportOptions = $options;
}
}