1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Facades for Yii 2 |
4
|
|
|
* |
5
|
|
|
* Generated on Yii 2.0.12 |
6
|
|
|
* |
7
|
|
|
* @see https://github.com/sergeymakinen/yii2-facades |
8
|
|
|
* @copyright Copyright (c) 2016-2017 Sergey Makinen (https://makinen.ru) |
9
|
|
|
* @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License |
10
|
|
|
*/ |
11
|
|
|
|
12
|
|
|
namespace sergeymakinen\facades; |
13
|
|
|
|
14
|
|
|
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */ |
15
|
|
|
/** |
16
|
|
|
* Yii::$app->get('httpClient') facade. |
17
|
|
|
* |
18
|
|
|
* Methods |
19
|
|
|
* |
20
|
|
|
* @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component. |
21
|
|
|
* @see \yii\base\Component::attachBehavior |
22
|
|
|
* |
23
|
|
|
* @method static void attachBehaviors(array $behaviors) Attaches a list of behaviors to the component. |
24
|
|
|
* @see \yii\base\Component::attachBehaviors |
25
|
|
|
* |
26
|
|
|
* @method static \yii\httpclient\Response[] batchSend(\yii\httpclient\Request[] $requests) Performs multiple HTTP requests in parallel. |
27
|
|
|
* @see \yii\httpclient\Client::batchSend |
28
|
|
|
* |
29
|
|
|
* @method static array behaviors() Returns a list of behaviors that this component should behave as. |
30
|
|
|
* @see \yii\base\Component::behaviors |
31
|
|
|
* |
32
|
|
|
* @method static \yii\httpclient\Request createRequest() |
33
|
|
|
* @see \yii\httpclient\Client::createRequest |
34
|
|
|
* |
35
|
|
|
* @method static string createRequestLogToken(string $method, string $url, array $headers, string $content) Composes the log/profiling message token for the given HTTP request parameters. |
36
|
|
|
* @see \yii\httpclient\Client::createRequestLogToken |
37
|
|
|
* |
38
|
|
|
* @method static \yii\httpclient\Response createResponse(string $content = null, array $headers = []) Creates a response instance. |
39
|
|
|
* @see \yii\httpclient\Client::createResponse |
40
|
|
|
* |
41
|
|
|
* @method static \yii\httpclient\Request delete(string $url, array|string $data = null, array $headers = [], array $options = []) Creates 'DELETE' request. |
42
|
|
|
* @see \yii\httpclient\Client::delete |
43
|
|
|
* |
44
|
|
|
* @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component. |
45
|
|
|
* @see \yii\base\Component::detachBehavior |
46
|
|
|
* |
47
|
|
|
* @method static void detachBehaviors() Detaches all behaviors from the component. |
48
|
|
|
* @see \yii\base\Component::detachBehaviors |
49
|
|
|
* |
50
|
|
|
* @method static void ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component. |
51
|
|
|
* @see \yii\base\Component::ensureBehaviors |
52
|
|
|
* |
53
|
|
|
* @method static \yii\httpclient\Request get(string $url, array|string $data = null, array $headers = [], array $options = []) Creates 'GET' request. |
54
|
|
|
* @see \yii\httpclient\Client::get |
55
|
|
|
* |
56
|
|
|
* @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object. |
57
|
|
|
* @see \yii\base\Component::getBehavior |
58
|
|
|
* |
59
|
|
|
* @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component. |
60
|
|
|
* @see \yii\base\Component::getBehaviors |
61
|
|
|
* |
62
|
|
|
* @method static \yii\httpclient\FormatterInterface getFormatter(string $format) Returns HTTP message formatter instance for the specified format. |
63
|
|
|
* @see \yii\httpclient\Client::getFormatter |
64
|
|
|
* |
65
|
|
|
* @method static \yii\httpclient\ParserInterface getParser(string $format) Returns HTTP message parser instance for the specified format. |
66
|
|
|
* @see \yii\httpclient\Client::getParser |
67
|
|
|
* |
68
|
|
|
* @method static \yii\httpclient\Transport getTransport() |
69
|
|
|
* @see \yii\httpclient\Client::getTransport |
70
|
|
|
* |
71
|
|
|
* @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event. |
72
|
|
|
* @see \yii\base\Component::hasEventHandlers |
73
|
|
|
* |
74
|
|
|
* @method static \yii\httpclient\Request head(string $url, array $headers = [], array $options = []) Creates 'HEAD' request. |
75
|
|
|
* @see \yii\httpclient\Client::head |
76
|
|
|
* |
77
|
|
|
* @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component. |
78
|
|
|
* @see \yii\base\Component::off |
79
|
|
|
* |
80
|
|
|
* @method static void on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event. |
81
|
|
|
* @see \yii\base\Component::on |
82
|
|
|
* |
83
|
|
|
* @method static \yii\httpclient\Request options(string $url, array $options = []) Creates 'OPTIONS' request. |
84
|
|
|
* @see \yii\httpclient\Client::options |
85
|
|
|
* |
86
|
|
|
* @method static \yii\httpclient\Request patch(string $url, array|string $data = null, array $headers = [], array $options = []) Creates 'PATCH' request. |
87
|
|
|
* @see \yii\httpclient\Client::patch |
88
|
|
|
* |
89
|
|
|
* @method static \yii\httpclient\Request post(string $url, array|string $data = null, array $headers = [], array $options = []) Creates 'POST' request. |
90
|
|
|
* @see \yii\httpclient\Client::post |
91
|
|
|
* |
92
|
|
|
* @method static \yii\httpclient\Request put(string $url, array|string $data = null, array $headers = [], array $options = []) Creates 'PUT' request. |
93
|
|
|
* @see \yii\httpclient\Client::put |
94
|
|
|
* |
95
|
|
|
* @method static \yii\httpclient\Response send(\yii\httpclient\Request $request) Performs given request. |
96
|
|
|
* @see \yii\httpclient\Client::send |
97
|
|
|
* |
98
|
|
|
* @method static void setTransport(\yii\httpclient\Transport|array|string $transport) Sets the HTTP message transport. |
99
|
|
|
* @see \yii\httpclient\Client::setTransport |
100
|
|
|
* |
101
|
|
|
* @method static void trigger(string $name, \yii\base\Event $event = null) Triggers an event. |
102
|
|
|
* @see \yii\base\Component::trigger |
103
|
|
|
* |
104
|
|
|
* Property accessors |
105
|
|
|
* |
106
|
|
|
* @method static string getBaseUrl() Returns base request URL. |
107
|
|
|
* @see \yii\httpclient\Client::baseUrl |
108
|
|
|
* |
109
|
|
|
* @method static int getContentLoggingMaxSize() Returns maximum symbols count of the request content, which should be taken to compose a log and profile messages. |
110
|
|
|
* @see \yii\httpclient\Client::contentLoggingMaxSize |
111
|
|
|
* |
112
|
|
|
* @method static array getFormatters() Returns the formatters for converting data into the content of the specified [[format]]. |
113
|
|
|
* @see \yii\httpclient\Client::formatters |
114
|
|
|
* |
115
|
|
|
* @method static array getParsers() Returns the parsers for converting content of the specified [[format]] into the data. |
116
|
|
|
* @see \yii\httpclient\Client::parsers |
117
|
|
|
* |
118
|
|
|
* @method static array getRequestConfig() Returns request object configuration. |
119
|
|
|
* @see \yii\httpclient\Client::requestConfig |
120
|
|
|
* |
121
|
|
|
* @method static array getResponseConfig() Returns response config configuration. |
122
|
|
|
* @see \yii\httpclient\Client::responseConfig |
123
|
|
|
* |
124
|
|
|
* @method static void setBaseUrl(string $value) Sets base request URL. |
125
|
|
|
* @see \yii\httpclient\Client::baseUrl |
126
|
|
|
* |
127
|
|
|
* @method static void setContentLoggingMaxSize(int $value) Sets maximum symbols count of the request content, which should be taken to compose a log and profile messages. |
128
|
|
|
* @see \yii\httpclient\Client::contentLoggingMaxSize |
129
|
|
|
* |
130
|
|
|
* @method static void setFormatters(array $value) Sets the formatters for converting data into the content of the specified [[format]]. |
131
|
|
|
* @see \yii\httpclient\Client::formatters |
132
|
|
|
* |
133
|
|
|
* @method static void setParsers(array $value) Sets the parsers for converting content of the specified [[format]] into the data. |
134
|
|
|
* @see \yii\httpclient\Client::parsers |
135
|
|
|
* |
136
|
|
|
* @method static void setRequestConfig(array $value) Sets request object configuration. |
137
|
|
|
* @see \yii\httpclient\Client::requestConfig |
138
|
|
|
* |
139
|
|
|
* @method static void setResponseConfig(array $value) Sets response config configuration. |
140
|
|
|
* @see \yii\httpclient\Client::responseConfig |
141
|
|
|
*/ |
142
|
|
|
class Http extends Facade |
143
|
|
|
{ |
144
|
|
|
/** |
145
|
|
|
* @inheritDoc |
146
|
|
|
*/ |
147
|
1 |
|
public static function getFacadeComponentId() |
148
|
|
|
{ |
149
|
1 |
|
return 'httpClient'; |
150
|
|
|
} |
151
|
|
|
} |
152
|
|
|
|