Request_Curl - クラス - FuelPHP ドキュメント

Request_Curl クラス

Request_Curl クラスは主にPHPのcURL拡張モジュールを介してREST要求を処理することを意図していますが、HTTP要求を介して任意のコンテンツを取得するために使用することができます。

インスタンス生成

You can forge an instance of this class through the Request class:

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// note that this only creates the object, it does not execute the request!

set_method($method)

The set_method method allows you to set the HTTP request method.

静的 No

Parameters

Param	Default	Description
`$method`	required	The HTTP method (GET, HEAD, POST, PUT, DELETE) to use for this request.

Returns Request_Curl, for chaining

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// this is going to be an HTTP POST
$curl->set_method('post');

get_method()

get_method メソッドを使用すると、現在のHTTPリクエストメソッドのセットを取得することができます

静的	No
Parameters	None.
返り値	mixed, defined HTTP method in uppercase, or null if none set.
Example	`// create a Request_Curl object $curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl'); // this is going to be an HTTP POST $curl->set_method('post'); // returns 'POST' $method = $curl->get_method();`

set_params($params)

The set_params メソッドを使用すると、HTTPリクエストで渡すパラメータを設定することができます

静的 No

Parameters

Param	Default	Description
`$params`	required	Array of parameters for the request.

Returns Request_Curl, for chaining

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// set some parameters
$curl->set_params(array('userid' => 12, 'data' => $payload));

これらのパラメータが使用されている方法は、生成されたリクエストに応じて異なります。 GET リクエストの場合、クエリ文字列に変換され、POST リクエストの場合、body になります

set_option($option, $value)

The set_option メソッドを使用すると、リクエストに渡される CURL オプションを定義することができます。

静的 No

Parameters

Param	Default	Description
`$option`	required	cURL option to set. Usually, this is one of the cURL constants.
`$value`	required	Value to set this option to.

返り値 Request_Curl, for chaining

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// set a username and password to be used in the request
$curl->set_option(CURLOPT_USERPWD, $username . ':' . $password);

set_options(array $options)

The set_options メソッドを使用すると、リクエストに渡される複数 CURL オプションを定義することができます

静的 No

Parameters

Param	Default	Description
`$options`	required	Array of cURL options and values to set.

Returns Request_Curl, for chaining

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// set some options to be used in the request
$curl->set_options(array(
	CURLOPT_TIMEOUT => 30,
	CURLOPT_FOLLOWLOCATION => true,
	)
);

add_param($param, $value = null)

The add_param メソッドを使用すると、すでに定義されたものに1つ以上のパラメータを追加することができます

静的 No

Parameters

Param	Default	Description
`$param`	required	Name of the parameter to set, or an array of parameters and values.
`$value`	`null`	Value to be defined. Only used when $param is a string value.

Returns Request_Curl, for chaining

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// add some parameters
$curl->add_param(array('userid' => 12, 'data' => $payload));

// or add a single one
$curl->add_param('data', $payload);

set_header($header, $content = null)

The set_header メソッドを使用すると、リクエストの一部として HTTP リクエストヘッダを設定することができます

静的 No

Parameters

Param	Default	Description
`$header`	required	The name of the HTTP header entry.
`$content`	`null`	The header value to be set.

Returns Request_Curl, for chaining

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// pass an authentication token to the backend server
$curl->set_header('auth-token', 'WV4YaeV8QeWVVVOE');

If you need to set a header that is not in the form "Name: Value", pass the value in $header, and do not pass any content.

get_headers()

The get_headers メソッドを使用すると、現在定義されているすべての HTTP リクエストヘッダを取得することができます

静的	No
Parameters	None.
Returns	Array, all headers set.
Example	`// create a Request_Curl object $curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl'); // pass an authentication token to the backend server $curl->set_header('auth-token', 'WV4YaeV8QeWVVVOE'); // returns array('auth-token:WV4YaeV8QeWVVVOE') $headers = $curl->get_headers();`

set_mime_type($mime)

The set_mime_type メソッドを使用すると、HTTP ヘッダを ACCEPT 定義することができます

静的 No

Parameters

Param	Default	Description
`$mime`	required	The mime type of the requested response. This will be used to set the ACCEPT header. `// currently supported types are: 'xml' => 'application/xml', 'json' => 'application/json', 'serialize' => 'application/vnd.php.serialized', 'php' => 'text/plain', 'csv' => 'text/csv',`

Returns Request_Curl, for chaining

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// tell the backend we want json returned
$curl->set_mime_type('json');

This is only a request. You should verify if the service you're calling actually supports and uses the mime type in the HTTP ACCEPT header, and if it supports the type you're requesting.

set_auto_format($auto_format)

The set_auto_format メソッドを使用すると、オンまたはオフ、オートフォーマットを切り替えることができます。

静的 No

Parameters

Param	Default	Description
`$auto_format`	required	True if you want the returned response to be converted into an array, false if you want to access it as it is received.

Returns Request_Curl, for chaining

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// we want an array returned
$curl->set_auto_format(true);

execute(array $additional_params = array())

The execute メソッドを使用すると、定義された cURL の要求を実行します

静的 No

Parameters

Param	Default	Description
`$additional_params`	`array()`	Any additional parameters you want to pass to the request.

Returns Request_Curl, for chaining

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// execute the request
$result = $curl->execute();

set_response($body, $status, $mime = null, $headers = array())

The set_response メソッドを使用すると、要求から受信した応答を設定します

静的 No

Parameters

Param	Default	Description
`$body`	required	The data to be set as the response body.
`$status`	required	The HTTP status of the created response.
`$mime`	`null`	The mime type the data is in. This is used with auto_format to convert the body into an array.
`$headers`	`null`	Any HTTP response headers you want to set.

Returns Response, the created response object.

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// create a custom response
$curl->set_response($body, $this->response_info('http_code', 200), 'json', array('auth-token' => 'WV4YaeV8QeWVVVOE'));

Normally you should not use this method. It is used after the request is executed to prepare the requests response object.

response()

The response method returns the current request response.

静的	No
Parameters	None.
Returns	Response, the created response object.
Example	`// create a Request_Curl object $curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl'); // assume some parameters and options were set, and execute $curl->execute(); // fetch the resulting Response object $result = $curl->response();`

response_info($key = null, $default = null)

The response_info メソッドを使用すると、cURL の応答値、またはすべての応答値を取得することができます。

静的 No

Parameters

Param	Default	Description
`$key`	`null`	Specific response value to retrieve. Don't specify it when you want to retrieve all values.
`$default`	`null`	Value to be returned when the requested value does not exist.

Returns Mixed, depending on the data type of the requested value.

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// assume some parameters and options were set, and execute
$curl->execute();

// get the number of bytes downloaded in the request
$size = $curl->response_info(CURLINFO_SIZE_DOWNLOAD, false);

http_login($username = '', $password = '', $type = 'any')

The http_login メソッドを使用すると、リクエストを実行する際に基本認証を使用することができます。

静的 No

Parameters

Param	Default	Description
`$username`	`''`	Name of the user you want to use to perform the authentication.
`$password`	`''`	That users password.
`$type`	`'any'`	Type of authentication to perform. Supported are: BASIC, DIGEST, GSSNEGOTIATE, NTLM, ANY and ANYSAFE.

Returns Response, the created response object.

Example

// create a Request_Curl object
$curl = Request::forge('http://rest.example.org/api/v1/this/info', 'curl');

// authenticate against an IIS server
$curl->http_login('username', 'mypass', 'NTLM');