PHP 클래스 yii\httpclient\Request

부터: 2.0
저자: Paul Klimov ([email protected])
상속: extends Message
파일 보기 프로젝트 열기: yiisoft/yii2-httpclient 1 사용 예제들

공개 메소드들

메소드 설명
addContent ( string $name, string $content, array $options = [] ) Adds a content part for multi-part content request.
addData ( $data )
addFile ( string $name, string $fileName, array $options = [] ) Adds a file for upload as multi-part content.
addFileContent ( string $name, string $content, array $options = [] ) Adds a string as a file upload.
addOptions ( array $options ) Adds more options to already defined ones.
afterSend ( Response $response ) This method is invoked right after this request is sent.
beforeSend ( ) This method is invoked right before this request is sent.
composeHeaderLines ( )
getFullUrl ( ) : string Returns full target URL, including [[Client::baseUrl]] as a string.
getMethod ( ) : string
getOptions ( ) : array
getUrl ( ) : string | array Returns target URL.
prepare ( ) Prepares this request instance for sending.
send ( ) : Response Sends this request.
setData ( $data )
setMethod ( string $method )
setOptions ( array $options ) Following options are supported: - timeout: int, the maximum number of seconds to allow request to be executed.
setUrl ( string | array $url ) Sets target URL.
toString ( )

비공개 메소드들

메소드 설명
composeCookieHeader ( ) : string
composeFormInputs ( array $data, string $baseKey = '' ) : array Composes given data as form inputs submitted values, taking in account nested arrays.
createFullUrl ( array | string $url ) : string Normalizes given URL value, filling it with actual string URL value.
getFormatter ( ) : yii\httpclient\FormatterInterface
prepareMultiPartContent ( array $content ) Prepares multi-part content.

메소드 상세

addContent() 공개 메소드

Adds a content part for multi-part content request.
public addContent ( string $name, string $content, array $options = [] )
$name string part (form input) name.
$content string content.
$options array content part options, valid options are: - contentType - string, part content type - fileName - string, name of the uploading file - mimeType - string, part content type in case of file uploading

addData() 공개 메소드

public addData ( $data )

addFile() 공개 메소드

Adds a file for upload as multi-part content.
또한 보기: addContent()
public addFile ( string $name, string $fileName, array $options = [] )
$name string part (form input) name
$fileName string full name of the source file.
$options array content part options, valid options are: - fileName - string, base name of the uploading file, if not set it base name of the source file will be used. - mimeType - string, file mime type, if not set it will be determine automatically from source file.

addFileContent() 공개 메소드

Adds a string as a file upload.
또한 보기: addContent()
public addFileContent ( string $name, string $content, array $options = [] )
$name string part (form input) name
$content string file content.
$options array content part options, valid options are: - fileName - string, base name of the uploading file. - mimeType - string, file mime type, if not set it 'application/octet-stream' will be used.

addOptions() 공개 메소드

Please refer to Request::setOptions on how to specify options.
public addOptions ( array $options )
$options array additional options

afterSend() 공개 메소드

The method will invoke [[Client::afterSend()]] and trigger the [[EVENT_AFTER_SEND]] event.
부터: 2.0.1
public afterSend ( Response $response )
$response Response received response instance.

beforeSend() 공개 메소드

The method will invoke [[Client::beforeSend()]] and trigger the [[EVENT_BEFORE_SEND]] event.
부터: 2.0.1
public beforeSend ( )

composeHeaderLines() 공개 메소드

public composeHeaderLines ( )

getFullUrl() 공개 메소드

Returns full target URL, including [[Client::baseUrl]] as a string.
public getFullUrl ( ) : string
리턴 string full target URL.

getMethod() 공개 메소드

public getMethod ( ) : string
리턴 string request method

getOptions() 공개 메소드

public getOptions ( ) : array
리턴 array request options.

getUrl() 공개 메소드

Returns target URL.
public getUrl ( ) : string | array
리턴 string | array target URL or URL parameters

prepare() 공개 메소드

This method should be invoked by transport before sending a request. Do not call this method unless you know what you are doing.
public prepare ( )

send() 공개 메소드

Sends this request.
public send ( ) : Response
리턴 Response response instance.

setData() 공개 메소드

public setData ( $data )

setMethod() 공개 메소드

public setMethod ( string $method )
$method string request method

setOptions() 공개 메소드

- proxy: string, URI specifying address of proxy server. (e.g. tcp://proxy.example.com:5100). - userAgent: string, the contents of the "User-Agent: " header to be used in a HTTP request. - followLocation: bool, whether to follow any "Location: " header that the server sends as part of the HTTP header. - maxRedirects: int, the max number of redirects to follow. - protocolVersion: float|string, HTTP protocol version. - sslVerifyPeer: bool, whether verification of the peer's certificate should be performed. - sslCafile: string, location of Certificate Authority file on local filesystem which should be used with the 'sslVerifyPeer' option to authenticate the identity of the remote peer. - sslCapath: string, a directory that holds multiple CA certificates. You may set options using keys, which are specific to particular transport, like [CURLOPT_VERBOSE => true] in case there is a necessity for it.
public setOptions ( array $options )
$options array request options.

setUrl() 공개 메소드

Sets target URL.
public setUrl ( string | array $url )
$url string | array use a string to represent a URL (e.g. `http://some-domain.com`, `item/list`), or an array to represent a URL with query parameters (e.g. `['item/list', 'param1' => 'value1']`).

toString() 공개 메소드

public toString ( )