Skip to content

Commit 6ce989f

Browse files
committed
Use fully qualified names in doc blocks
1 parent b2b1c99 commit 6ce989f

File tree

6 files changed

+122
-100
lines changed

6 files changed

+122
-100
lines changed

src/Driver/BlueimpUploadDriver.php

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,22 @@ public function __construct($config, Identifier $identifier)
4747
/**
4848
* {@inheritDoc}
4949
*/
50-
public function handle(Request $request, StorageConfig $storageConfig, Closure $fileUploaded = null): Response
50+
public function handle(Request $request, StorageConfig $config, Closure $fileUploaded = null): Response
5151
{
5252
if ($this->isRequestMethodIn($request, [Request::METHOD_HEAD, Request::METHOD_OPTIONS])) {
5353
return $this->info();
5454
}
5555

5656
if ($this->isRequestMethodIn($request, [Request::METHOD_GET])) {
57-
return $this->download($request, $storageConfig);
57+
return $this->download($request, $config);
5858
}
5959

6060
if ($this->isRequestMethodIn($request, [Request::METHOD_POST, Request::METHOD_PUT, Request::METHOD_PATCH])) {
61-
return $this->save($request, $storageConfig, $fileUploaded);
61+
return $this->save($request, $config, $fileUploaded);
6262
}
6363

6464
if ($this->isRequestMethodIn($request, [Request::METHOD_DELETE])) {
65-
return $this->delete($request, $storageConfig);
65+
return $this->delete($request, $config);
6666
}
6767

6868
throw new MethodNotAllowedHttpException([
@@ -90,7 +90,13 @@ public function info(): Response
9090
]);
9191
}
9292

93-
public function download(Request $request, StorageConfig $config)
93+
/**
94+
* @param \Illuminate\Http\Request $request
95+
* @param \LaraCrafts\ChunkUploader\StorageConfig $config
96+
*
97+
* @return \Symfony\Component\HttpFoundation\Response
98+
*/
99+
public function download(Request $request, StorageConfig $config): Response
94100
{
95101
$download = $request->query('download', false);
96102
if ($download !== false) {
@@ -120,13 +126,13 @@ public function download(Request $request, StorageConfig $config)
120126
}
121127

122128
/**
123-
* @param Request $request
124-
* @param StorageConfig $storageConfig
129+
* @param \Illuminate\Http\Request $request
130+
* @param \LaraCrafts\ChunkUploader\StorageConfig $config
125131
* @param \Closure|null $fileUploaded
126132
*
127133
* @return \Symfony\Component\HttpFoundation\Response
128134
*/
129-
public function save(Request $request, StorageConfig $storageConfig, Closure $fileUploaded = null): Response
135+
public function save(Request $request, StorageConfig $config, Closure $fileUploaded = null): Response
130136
{
131137
$file = $request->file($this->fileParam);
132138

@@ -144,37 +150,37 @@ public function save(Request $request, StorageConfig $storageConfig, Closure $fi
144150

145151
$uuid = $this->identifier->generateUploadedFileIdentifierName($file);
146152

147-
$chunks = $this->storeChunk($storageConfig, $range, $file, $uuid);
153+
$chunks = $this->storeChunk($config, $range, $file, $uuid);
148154

149155
if (!$range->isLast()) {
150156
return new PercentageJsonResponse($range->getPercentage());
151157
}
152158

153159
$targetFilename = $file->hashName();
154160

155-
$path = $this->mergeChunks($storageConfig, $chunks, $targetFilename);
161+
$path = $this->mergeChunks($config, $chunks, $targetFilename);
156162

157-
if ($storageConfig->sweep()) {
158-
$this->deleteChunkDirectory($storageConfig, $uuid);
163+
if ($config->sweep()) {
164+
$this->deleteChunkDirectory($config, $uuid);
159165
}
160166

161-
$this->triggerFileUploadedEvent($storageConfig->getDisk(), $path, $fileUploaded);
167+
$this->triggerFileUploadedEvent($config->getDisk(), $path, $fileUploaded);
162168

163169
return new PercentageJsonResponse(100);
164170
}
165171

166172
/**
167-
* @param Request $request
168-
* @param StorageConfig $storageConfig
173+
* @param \Illuminate\Http\Request $request
174+
* @param \LaraCrafts\ChunkUploader\StorageConfig $config
169175
*
170-
* @return Response
176+
* @return \Symfony\Component\HttpFoundation\Response
171177
*/
172-
public function delete(Request $request, StorageConfig $storageConfig)
178+
public function delete(Request $request, StorageConfig $config): Response
173179
{
174180
$filename = $request->post($this->fileParam);
175181

176-
$path = $storageConfig->getMergedDirectory() . '/' . $filename;
177-
Storage::disk($storageConfig->getDisk())->delete($path);
182+
$path = $config->getMergedDirectory() . '/' . $filename;
183+
Storage::disk($config->getDisk())->delete($path);
178184

179185
return new Response();
180186
}

src/Driver/DropzoneUploadDriver.php

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ public function __construct($config)
3636
/**
3737
* {@inheritDoc}
3838
*/
39-
public function handle(Request $request, StorageConfig $storageConfig, Closure $fileUploaded = null): Response
39+
public function handle(Request $request, StorageConfig $config, Closure $fileUploaded = null): Response
4040
{
4141
if ($this->isRequestMethodIn($request, [Request::METHOD_POST])) {
42-
return $this->save($request, $storageConfig, $fileUploaded);
42+
return $this->save($request, $config, $fileUploaded);
4343
}
4444

4545
throw new MethodNotAllowedHttpException([
@@ -49,32 +49,32 @@ public function handle(Request $request, StorageConfig $storageConfig, Closure $
4949

5050
/**
5151
* @param \Illuminate\Http\Request $request
52-
* @param StorageConfig $storageConfig
52+
* @param \LaraCrafts\ChunkUploader\StorageConfig $config
5353
* @param \Closure|null $fileUploaded
5454
*
5555
* @return \Symfony\Component\HttpFoundation\Response
5656
*/
57-
public function save(Request $request, StorageConfig $storageConfig, Closure $fileUploaded = null): Response
57+
public function save(Request $request, StorageConfig $config, Closure $fileUploaded = null): Response
5858
{
5959
$file = $request->file($this->fileParam);
6060

6161
$this->validateUploadedFile($file);
6262

6363
if ($this->isMonolithRequest($request)) {
64-
return $this->saveMonolith($file, $storageConfig, $fileUploaded);
64+
return $this->saveMonolith($file, $config, $fileUploaded);
6565
}
6666

6767
$this->validateChunkRequest($request);
6868

69-
return $this->saveChunk($file, $request, $storageConfig, $fileUploaded);
69+
return $this->saveChunk($file, $request, $config, $fileUploaded);
7070
}
7171

7272
/**
73-
* @param Request $request
73+
* @param \Illuminate\Http\Request $request
7474
*
7575
* @return bool
7676
*/
77-
private function isMonolithRequest(Request $request)
77+
private function isMonolithRequest(Request $request): bool
7878
{
7979
return $request->post('dzuuid') === null
8080
&& $request->post('dzchunkindex') === null
@@ -85,9 +85,9 @@ private function isMonolithRequest(Request $request)
8585
}
8686

8787
/**
88-
* @param Request $request
88+
* @param \Illuminate\Http\Request $request
8989
*/
90-
private function validateChunkRequest(Request $request)
90+
private function validateChunkRequest(Request $request): void
9191
{
9292
$request->validate([
9393
'dzuuid' => 'required',
@@ -100,32 +100,32 @@ private function validateChunkRequest(Request $request)
100100
}
101101

102102
/**
103-
* @param UploadedFile $uploadedFile
104-
* @param StorageConfig $storageConfig
103+
* @param \Illuminate\Http\UploadedFile $file
104+
* @param \LaraCrafts\ChunkUploader\StorageConfig $config
105105
* @param \Closure|null $fileUploaded
106106
*
107-
* @return Response
107+
* @return \Symfony\Component\HttpFoundation\Response
108108
*/
109-
private function saveMonolith(UploadedFile $uploadedFile, StorageConfig $storageConfig, Closure $fileUploaded = null): Response
109+
private function saveMonolith(UploadedFile $file, StorageConfig $config, Closure $fileUploaded = null): Response
110110
{
111-
$path = $uploadedFile->store($storageConfig->getMergedDirectory(), [
112-
'disk' => $storageConfig->getDisk(),
111+
$path = $file->store($config->getMergedDirectory(), [
112+
'disk' => $config->getDisk(),
113113
]);
114114

115-
$this->triggerFileUploadedEvent($storageConfig->getDisk(), $path, $fileUploaded);
115+
$this->triggerFileUploadedEvent($config->getDisk(), $path, $fileUploaded);
116116

117117
return new PercentageJsonResponse(100);
118118
}
119119

120120
/**
121-
* @param UploadedFile $uploadedFile
122-
* @param Request $request
123-
* @param StorageConfig $storageConfig
121+
* @param \Illuminate\Http\UploadedFile $file
122+
* @param \Illuminate\Http\Request $request
123+
* @param \LaraCrafts\ChunkUploader\StorageConfig $config
124124
* @param \Closure|null $fileUploaded
125125
*
126-
* @return Response
126+
* @return \Symfony\Component\HttpFoundation\Response
127127
*/
128-
private function saveChunk(UploadedFile $uploadedFile, Request $request, StorageConfig $storageConfig, Closure $fileUploaded = null): Response
128+
private function saveChunk(UploadedFile $file, Request $request, StorageConfig $config, Closure $fileUploaded = null): Response
129129
{
130130
try {
131131
$range = new ZeroBasedRequestBodyRange(
@@ -141,21 +141,21 @@ private function saveChunk(UploadedFile $uploadedFile, Request $request, Storage
141141

142142
$uuid = $request->post('dzuuid');
143143

144-
$chunks = $this->storeChunk($storageConfig, $range, $uploadedFile, $uuid);
144+
$chunks = $this->storeChunk($config, $range, $file, $uuid);
145145

146146
if (!$range->isFinished($chunks)) {
147147
return new PercentageJsonResponse($range->getPercentage($chunks));
148148
}
149149

150-
$targetFilename = $uploadedFile->hashName();
150+
$targetFilename = $file->hashName();
151151

152-
$path = $this->mergeChunks($storageConfig, $chunks, $targetFilename);
152+
$path = $this->mergeChunks($config, $chunks, $targetFilename);
153153

154-
if ($storageConfig->sweep()) {
155-
$this->deleteChunkDirectory($storageConfig, $uuid);
154+
if ($config->sweep()) {
155+
$this->deleteChunkDirectory($config, $uuid);
156156
}
157157

158-
$this->triggerFileUploadedEvent($storageConfig->getDisk(), $path, $fileUploaded);
158+
$this->triggerFileUploadedEvent($config->getDisk(), $path, $fileUploaded);
159159

160160
return new PercentageJsonResponse(100);
161161
}

src/Driver/MonolithUploadDriver.php

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ public function __construct($config)
3030
/**
3131
* {@inheritDoc}
3232
*/
33-
public function handle(Request $request, StorageConfig $storageConfig, Closure $fileUploaded = null): Response
33+
public function handle(Request $request, StorageConfig $config, Closure $fileUploaded = null): Response
3434
{
3535
if ($request->isMethod(Request::METHOD_POST)) {
36-
return $this->save($request, $storageConfig, $fileUploaded);
36+
return $this->save($request, $config, $fileUploaded);
3737
}
3838

3939
if ($request->isMethod(Request::METHOD_GET)) {
40-
return $this->download($request, $storageConfig);
40+
return $this->download($request, $config);
4141
}
4242

4343
if ($request->isMethod(Request::METHOD_DELETE)) {
44-
return $this->delete($request, $storageConfig);
44+
return $this->delete($request, $config);
4545
}
4646

4747
throw new MethodNotAllowedHttpException([
@@ -52,52 +52,52 @@ public function handle(Request $request, StorageConfig $storageConfig, Closure $
5252
}
5353

5454
/**
55-
* @param Request $request
56-
* @param StorageConfig $storageConfig
55+
* @param \Illuminate\Http\Request $request
56+
* @param \LaraCrafts\ChunkUploader\StorageConfig $config
5757
* @param \Closure|null $fileUploaded
5858
*
5959
* @return \Symfony\Component\HttpFoundation\Response
6060
*/
61-
public function save(Request $request, StorageConfig $storageConfig, Closure $fileUploaded = null): Response
61+
public function save(Request $request, StorageConfig $config, Closure $fileUploaded = null): Response
6262
{
6363
$file = $request->file($this->fileParam);
6464

6565
$this->validateUploadedFile($file);
6666

67-
$path = $file->store($storageConfig->getMergedDirectory(), [
68-
'disk' => $storageConfig->getDisk(),
67+
$path = $file->store($config->getMergedDirectory(), [
68+
'disk' => $config->getDisk(),
6969
]);
7070

71-
$this->triggerFileUploadedEvent($storageConfig->getDisk(), $path, $fileUploaded);
71+
$this->triggerFileUploadedEvent($config->getDisk(), $path, $fileUploaded);
7272

7373
return new PercentageJsonResponse(100);
7474
}
7575

7676
/**
77-
* @param Request $request
78-
* @param StorageConfig $storageConfig
77+
* @param \Illuminate\Http\Request $request
78+
* @param \LaraCrafts\ChunkUploader\StorageConfig $config
7979
*
8080
* @return \Symfony\Component\HttpFoundation\Response
8181
*/
82-
public function download(Request $request, StorageConfig $storageConfig): Response
82+
public function download(Request $request, StorageConfig $config): Response
8383
{
8484
$filename = $request->query($this->fileParam, $request->route($this->fileParam));
8585

86-
return $this->fileResponse($filename, $storageConfig);
86+
return $this->fileResponse($filename, $config);
8787
}
8888

8989
/**
90-
* @param Request $request
91-
* @param StorageConfig $storageConfig
90+
* @param \Illuminate\Http\Request $request
91+
* @param \LaraCrafts\ChunkUploader\StorageConfig $config
9292
*
9393
* @return \Symfony\Component\HttpFoundation\Response
9494
*/
95-
public function delete(Request $request, StorageConfig $storageConfig)
95+
public function delete(Request $request, StorageConfig $config): Response
9696
{
9797
$filename = $request->post($this->fileParam, $request->route($this->fileParam));
9898

99-
$path = $storageConfig->getMergedDirectory() . '/' . $filename;
100-
Storage::disk($storageConfig->getDisk())->delete($path);
99+
$path = $config->getMergedDirectory() . '/' . $filename;
100+
Storage::disk($config->getDisk())->delete($path);
101101

102102
return new Response();
103103
}

0 commit comments

Comments
 (0)