Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CURLRequest helper methods #1498

Merged
merged 2 commits into from
Nov 29, 2018
Merged

Add CURLRequest helper methods #1498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0be8403
Add CURLRequest helper methods
natanfelles Nov 17, 2018
42605e9
Test json content-type header
natanfelles Nov 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 62 additions & 2 deletions system/HTTP/CURLRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@
* A lightweight HTTP client for sending synchronous HTTP requests
* via cURL.
*
* @todo Add a few helpers for dealing with JSON, forms, files, etc.
*
* @package CodeIgniter\HTTP
*/
class CURLRequest extends Request
Expand Down Expand Up @@ -267,6 +265,68 @@ public function put(string $url, array $options = []): ResponseInterface

//--------------------------------------------------------------------

/**
* Set the HTTP Authentication.
*
* @param string $username
* @param string $password
* @param string $type basic or digest
*
* @return $this
*/
public function setAuth(string $username, string $password, string $type = 'basic')
{
$this->config['auth'] = [
$username,
$password,
$type,
];

return $this;
}

//--------------------------------------------------------------------

/**
* Set form data to be sent.
*
* @param array $params
* @param boolean $multipart Set TRUE if you are sending CURLFiles
*
* @return $this
*/
public function setForm(array $params, bool $multipart = false)
{
if ($multipart)
{
$this->config['multipart'] = $params;
}
else
{
$this->config['form_params'] = $params;
}

return $this;
}

//--------------------------------------------------------------------

/**
* Set JSON data to be sent.
*
* @param mixed $data
*
* @return $this
*/
public function setJSON($data)
{
$this->config['json'] = $data;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're setting json in the request, shouldn't we also set Content-Type: application/json?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like it has already been done:

CodeIgniter4/system/HTTP/CURLRequest.php

Lines 698 to 705 in 3d3cb5e

// JSON
if (isset($config['json']))
{
// Will be set as the body in `applyBody()`
$json = json_encode($config['json']);
$this->setBody($json);
$this->setHeader('Content-Type', 'application/json');
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could update this to use the \Config\Format::getFormatter('application/json').

Allow to use a custom JSON Formatter...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think there is any intent to format the JSON data. If anything, it might be stringify'd. The unit testing should make this clearer.


return $this;
}

//--------------------------------------------------------------------

/**
* Sets the correct settings based on the options array
* passed in.
Expand Down
Loading