1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
declare(strict_types=1); |
4
|
|
|
|
5
|
|
|
/* |
6
|
|
|
* This software may be modified and distributed under the terms |
7
|
|
|
* of the MIT license. See the LICENSE file for details. |
8
|
|
|
*/ |
9
|
|
|
|
10
|
|
|
namespace FAPI\PhraseApp; |
11
|
|
|
|
12
|
|
|
use Http\Discovery\Psr17FactoryDiscovery; |
13
|
|
|
use Http\Message\MultipartStream\MultipartStreamBuilder; |
14
|
|
|
use Psr\Http\Message\RequestFactoryInterface; |
15
|
|
|
use Psr\Http\Message\RequestInterface; |
16
|
|
|
|
17
|
|
|
/** |
18
|
|
|
* @author Sascha-Oliver Prolic <[email protected]> |
19
|
|
|
* |
20
|
|
|
* @internal This class should not be used outside of the API Client, it is not part of the BC promise. |
21
|
|
|
*/ |
22
|
|
|
final class RequestBuilder |
23
|
|
|
{ |
24
|
|
|
/** |
25
|
|
|
* @var RequestFactoryInterface |
26
|
|
|
*/ |
27
|
|
|
private $requestFactory; |
28
|
|
|
/** |
29
|
|
|
* @var MultipartStreamBuilder |
30
|
|
|
*/ |
31
|
|
|
private $multipartStreamBuilder; |
32
|
|
|
|
33
|
|
|
/** |
34
|
|
|
* @param RequestFactoryInterface|null $requestFactory |
35
|
|
|
* @param MultipartStreamBuilder|null $multipartStreamBuilder |
36
|
|
|
*/ |
37
|
|
|
public function __construct( |
38
|
|
|
RequestFactoryInterface $requestFactory = null, |
39
|
|
|
MultipartStreamBuilder $multipartStreamBuilder = null |
40
|
|
|
) { |
41
|
|
|
$this->requestFactory = $requestFactory ?: Psr17FactoryDiscovery::findRequestFactory(); |
42
|
|
|
$this->multipartStreamBuilder = $multipartStreamBuilder ?: new MultipartStreamBuilder(); |
43
|
|
|
} |
44
|
|
|
|
45
|
|
|
/** |
46
|
|
|
* Creates a new PSR-7 request. |
47
|
|
|
* |
48
|
|
|
* @param string $method |
49
|
|
|
* @param string $uri |
50
|
|
|
* @param array $headers |
51
|
|
|
* @param array|string|null $body Request body. If body is an array we will send a as multipart stream request. |
52
|
|
|
* If array, each array *item* MUST look like: |
53
|
|
|
* array ( |
54
|
|
|
* 'content' => string|resource|StreamInterface, |
55
|
|
|
* 'name' => string, |
56
|
|
|
* 'filename'=> string (optional) |
57
|
|
|
* 'headers' => array (optinal) ['header-name' => 'header-value'] |
58
|
|
|
* ) |
59
|
|
|
* |
60
|
|
|
* @return RequestInterface |
61
|
|
|
*/ |
62
|
|
|
public function create(string $method, string $uri, array $headers = [], $body = null): RequestInterface |
63
|
|
|
{ |
64
|
|
|
if (!is_array($body)) { |
65
|
|
|
return $this->requestFactory->createRequest($method, $uri, $headers, $body); |
|
|
|
|
66
|
|
|
} |
67
|
|
|
foreach ($body as $item) { |
68
|
|
|
$name = $item['name']; |
69
|
|
|
$content = $item['content']; |
70
|
|
|
unset($item['name'], $item['content']); |
71
|
|
|
$this->multipartStreamBuilder->addResource($name, $content, $item); |
72
|
|
|
} |
73
|
|
|
$multipartStream = $this->multipartStreamBuilder->build(); |
74
|
|
|
$boundary = $this->multipartStreamBuilder->getBoundary(); |
75
|
|
|
$headers['Content-Type'] = 'multipart/form-data; boundary='.$boundary; |
76
|
|
|
$this->multipartStreamBuilder->reset(); |
77
|
|
|
|
78
|
|
|
return $this->requestFactory->createRequest($method, $uri, $headers, $multipartStream); |
|
|
|
|
79
|
|
|
} |
80
|
|
|
} |
81
|
|
|
|
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.
In this case you can add the
@ignore
PhpDoc annotation to the duplicate definition and it will be ignored.