Skip to content
This repository has been archived by the owner on Jan 29, 2020. It is now read-only.

Commit

Permalink
#311 - Update NormalizeUploadedFiles to handle multi-dimension recurs…
Browse files Browse the repository at this point in the history 
…ively
  • Loading branch information
Adam Benson committed Jul 9, 2018
1 parent 87928a5 commit 86da1ef
Show file tree
Hide file tree
Showing 2 changed files with 205 additions and 14 deletions.
61 changes: 47 additions & 14 deletions src/functions/normalize_uploaded_files.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,45 @@
*/
function normalizeUploadedFiles(array $files)
{
/**
* @param array $tmpNameTree
* @param array $sizeTree
* @param array $errorTree
* @param array|null $nameTree
* @param array|null $typeTree
* @return UploadedFile[]
*/
$recursiveNormalize = function (
array $tmpNameTree,
array $sizeTree,
array $errorTree,
array $nameTree = null,
array $typeTree = null
) use (&$recursiveNormalize) {
$normalized = [];
foreach ($tmpNameTree as $key => $value) {
if (is_array($value)) {
// Traverse
$normalized[$key] = $recursiveNormalize(
$tmpNameTree[$key],
$sizeTree[$key],
$errorTree[$key],
$nameTree[$key] ?? null,
$typeTree[$key] ?? null
);
continue;
}
$normalized[$key] = createUploadedFile([
'tmp_name' => $tmpNameTree[$key],
'size' => $sizeTree[$key],
'error' => $errorTree[$key],
'name' => $nameTree[$key] ?? null,
'type' => $typeTree[$key] ?? null
]);
}
return $normalized;
};

/**
* Normalize an array of file specifications.
*
Expand All @@ -38,7 +77,7 @@ function normalizeUploadedFiles(array $files)
* @param array $files
* @return UploadedFile[]
*/
$normalizeUploadedFileSpecification = function (array $files = []) {
$normalizeUploadedFileSpecification = function (array $files = []) use (&$recursiveNormalize) {
if (! isset($files['tmp_name']) || ! is_array($files['tmp_name'])
|| ! isset($files['size']) || ! is_array($files['size'])
|| ! isset($files['error']) || ! is_array($files['error'])
Expand All @@ -51,19 +90,13 @@ function normalizeUploadedFiles(array $files)
));
}


$normalized = [];
foreach (array_keys($files['tmp_name']) as $key) {
$spec = [
'tmp_name' => $files['tmp_name'][$key],
'size' => $files['size'][$key],
'error' => $files['error'][$key],
'name' => isset($files['name'][$key]) ? $files['name'][$key] : null,
'type' => isset($files['type'][$key]) ? $files['type'][$key] : null,
];
$normalized[$key] = createUploadedFile($spec);
}
return $normalized;
return $recursiveNormalize(
$files['tmp_name'],
$files['size'],
$files['error'],
$files['name'] ?? null,
$files['type'] ?? null
);
};

$normalized = [];
Expand Down
158 changes: 158 additions & 0 deletions test/functions/NormalizeUploadedFilesTest.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
<?php
/**
* @see https://github.com/zendframework/zend-diactoros for the canonical source repository
* @copyright Copyright (c) 2015-2017 Zend Technologies USA Inc. (http://www.zend.com)
* @license https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
*/

namespace ZendTest\Diactoros;

use PHPUnit\Framework\TestCase;
use Psr\Http\Message\UploadedFileInterface;
use function Zend\Diactoros\normalizeUploadedFiles;

class NormalizeUploadedFilesTest extends TestCase
{
public function testFlatFile()
{
$files = [
'avatar' => [
'tmp_name' => 'phpUxcOty',
'name' => 'my-avatar.png',
'size' => 90996,
'type' => 'image/png',
'error' => 0,
],
];

$normalised = normalizeUploadedFiles($files);

$this->assertCount(1, $normalised);
$this->assertInstanceOf(UploadedFileInterface::class, $normalised['avatar']);
$this->assertEquals('my-avatar.png', $normalised['avatar']->getClientFilename());
}

public function testNestedFile()
{
$files = [
'my-form' => [
'details' => [
'avatar' => [
'tmp_name' => 'phpUxcOty',
'name' => 'my-avatar.png',
'size' => 90996,
'type' => 'image/png',
'error' => 0,
],
],
],
];

$normalised = normalizeUploadedFiles($files);

$this->assertCount(1, $normalised);
$this->assertEquals('my-avatar.png', $normalised['my-form']['details']['avatar']->getClientFilename());
}

public function testNumericIndexedFiles()
{
$files = [
'my-form' => [
'details' => [
'avatars' => [
'tmp_name' => [
0 => 'abc123',
1 => 'duck123',
2 => 'goose123',
],
'name' => [
0 => 'file1.txt',
1 => 'file2.txt',
2 => 'file3.txt',
],
'size' => [
0 => 100,
1 => 240,
2 => 750,
],
'type' => [
0 => 'plain/txt',
1 => 'image/jpg',
2 => 'image/png',
],
'error' => [
0 => 0,
1 => 0,
2 => 0,
],
],
],
],
];

$normalised = normalizeUploadedFiles($files);

$this->assertCount(3, $normalised['my-form']['details']['avatars']);
$this->assertEquals('file1.txt', $normalised['my-form']['details']['avatars'][0]->getClientFilename());
$this->assertEquals('file2.txt', $normalised['my-form']['details']['avatars'][1]->getClientFilename());
$this->assertEquals('file3.txt', $normalised['my-form']['details']['avatars'][2]->getClientFilename());
}

/**
* This case covers upfront numeric index which moves the tmp_name/size/etc fields further up the array tree
*/
public function testNumericFirstIndexedFiles()
{
$files = [
'slide-shows' => [
'tmp_name' => [
// Note: Nesting *under* tmp_name/etc
0 => [
'slides' => [
0 => '/tmp/phpYzdqkD',
1 => '/tmp/phpYzdfgh',
],
],
],
'error' => [
0 => [
'slides' => [
0 => 0,
1 => 0,
],
],
],
'name' => [
0 => [
'slides' => [
0 => 'foo.txt',
1 => 'bar.txt',
],
],
],
'size' => [
0 => [
'slides' => [
0 => 123,
1 => 200,
],
],
],
'type' => [
0 => [
'slides' => [
0 => 'text/plain',
1 => 'text/plain',
],
],
],
],
];

$normalised = normalizeUploadedFiles($files);

$this->assertCount(2, $normalised['slide-shows'][0]['slides']);
$this->assertEquals('foo.txt', $normalised['slide-shows'][0]['slides'][0]->getClientFilename());
$this->assertEquals('bar.txt', $normalised['slide-shows'][0]['slides'][1]->getClientFilename());
}
}

0 comments on commit 86da1ef

Please sign in to comment.