docs: update docs

codeigniter4 · Jun 28, 2023 · 35d7d29 · 35d7d29
1 parent 8c6e883
commit 35d7d29
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/user_guide_src/source/changelogs/v4.4.0.rst b/user_guide_src/source/changelogs/v4.4.0.rst
@@ -95,9 +95,10 @@ Libraries
 - **Validation:** Added ``Validation::getValidated()`` method that gets
   the actual validated data. See :ref:`validation-getting-validated-data` for details.
 - **Images:** The option ``$quality`` can now be used to compress WebP images.
-
 - **Uploaded Files:** Added ``UploadedFiles::getClientPath()`` method that returns
   the value of the `full_path` index of the file if it was uploaded via directory upload.
+- **CURLRequest:** Added a request option ``proxy``. See
+  :ref:`CURLRequest Class <curlrequest-request-options-proxy>`.
 
 Helpers and Functions
 =====================

diff --git a/user_guide_src/source/libraries/curlrequest.rst b/user_guide_src/source/libraries/curlrequest.rst
@@ -296,6 +296,17 @@ has been disabled. Any files that you want to send must be passed as instances o
         ``form_params`` for ``application/x-www-form-urlencoded`` requests, and ``multipart`` for ``multipart/form-data``
         requests.
 
+.. _curlrequest-request-options-proxy:
+
+proxy
+=====
+
+.. versionadded:: 4.4.0
+
+You can set a proxy by passing an associative array as the ``proxy`` option:
+
+.. literalinclude:: curlrequest/035.php
+
 query
 =====
 

diff --git a/user_guide_src/source/libraries/curlrequest/035.php b/user_guide_src/source/libraries/curlrequest/035.php
@@ -0,0 +1,7 @@
+<?php
+
+$client->request(
+    'GET',
+    'http://example.com',
+    ['proxy' => 'http://localhost:3128']
+);