Abstract Class yii\httpclient\Transport
| Inheritance | yii\httpclient\Transport » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Subclasses | yii\httpclient\CurlTransport, yii\httpclient\MockTransport, yii\httpclient\StreamTransport |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-httpclient/blob/master/Transport.php |
Transport performs actual HTTP request sending.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| batchSend() | Performs multiple HTTP requests. | yii\httpclient\Transport |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the object. | yii\base\BaseObject |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| send() | Performs given request. | yii\httpclient\Transport |
| trigger() | Triggers an event. | yii\base\Component |
Method Details
Performs multiple HTTP requests.
Particular transport may benefit from this method, allowing sending requests in parallel. This method accepts an array of the yii\httpclient\Request objects and returns an array of the yii\httpclient\Response objects. Keys of the response array correspond the ones from request array.
| public yii\httpclient\Response[] batchSend ( array $requests ) | ||
| $requests | yii\httpclient\Request[] | Requests to perform. |
| return | yii\httpclient\Response[] | Responses list. |
|---|---|---|
| throws | yii\httpclient\Exception | |
Performs given request.
| public abstract yii\httpclient\Response send ( $request ) | ||
| $request | yii\httpclient\Request | Request to be sent. |
| return | yii\httpclient\Response | Response instance. |
|---|---|---|
| throws | yii\httpclient\Exception | on failure. |