jalendport / craft-fetch
Utilise the Guzzle HTTP client from within your Craft templates.
Fund package maintenance!
jalendport
Installs: 24 875
Dependents: 1
Suggesters: 0
Security: 0
Stars: 23
Watchers: 2
Forks: 13
Open Issues: 7
Type:craft-plugin
Requires
- craftcms/cms: ^4.0.0
This package is auto-updated.
Last update: 2024-11-09 01:20:48 UTC
README
Fetch plugin for Craft CMS 3.x
Utilise the Guzzle HTTP client from within your Craft templates.
Requirements
This plugin requires Craft CMS 3.0.0 or later.
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project
-
Then tell Composer to load the plugin:
composer require jalendport/craft-fetch
-
In the Control Panel, go to Settings → Plugins and click the “Install” button for Fetch.
Using Fetch
This plugin is built to work with the standard Guzzle request options
Parameters
Example Usage
Request
{% set client = { base_uri : 'https://gtmetrix.com', timeout : 10 } %} {% set options = { auth : ['username', 'password'], form_params : { url : 'https://www.google.co.uk' } } %} {% set request = fetch(client, 'POST', 'api/0.1/test', options) %}
Response (successful)
{ "statusCode":200, "reason":"OK", "body": { "credits_left":30, "test_id":"JDHFbrt7", "poll_state_url":"https:\/\/gtmetrix.com\/api\/0.1\/test\/JDHFbrt7" } }
You can fetch the string response by adding an additional parameter of false
like so:
{% set request = fetch(client, 'POST', 'api/0.1/test', options, false) %}
Response (error)
{ "error":true, "reason":"Client error: `POST https:\/\/gtmetrix.com\/api\/0.1\/test` resulted in a `401 Authorization Required` response:\n{\u0022error\u0022:\u0022Invalid e-mail and\/or API key\u0022}\n\n" }
Fetch Roadmap
Some things to do, and ideas for potential features:
Brought to you by Luke Youell