👪Plugins

Saloon has plugins which make it easy for you to add logic to your connector or requests in a reusable and elegant way. Plugins are traits that can be added to either a request or a connector and have a special "boot" method which is invoked during the request lifecycle.

Getting Started

It's easy to create your own plugin for Saloon, just create a trait and add it to either your connector or request. In this example, we will create a logging plugin that when added will log the request being sent to Ray.

Our plugin will be called HasLogging . In order for Saloon to execute this plugin, we must create a public method that starts with boot followed by the name of the trait. For example: bootHasLogging. The method is given an instance of PendingRequest.

Definition (Trait)

<?php

trait HasLogging
{
    public function bootHasLogging(PendingRequest $pendingRequest): void
    {
        ray($pendingRequest);
    }
}

You must not use $this inside of the trait, as mutating the original request or connector is discouraged. The PendingRequest is unique to just the request being sent.

Usage (Connector)

<?php

class ForgeConnector extends Connector
{
    use HasLogging;
}

When you send your request, plugins are the first things that are invoked, even before the boot method. This is to allow maximum compatibility with middleware and authenticators. This also means that because it's the first process in the chain, other steps like middleware and the boot method will be able to overwrite anything added by a plugin.

Because we added the trait to our connector, every request will use the HasLogging plugin. If you would like the plugin to be applied to just one request, you can add the plugin to the request only.

Be careful when adding the plugin to both the connector and the request at the same time, they will both be executed separately.

Built-in Plugins

Saloon comes with a few plugins out of the box, you may have already used them.

AcceptsJson

This plugin will add the Accept: application/json header to your pending request. This is useful when dealing with JSON APIs.

AlwaysThrowOnErrors

This plugin will call the $response->throw() method. This method will throw an exception if the response has failed, rather than just returning a failed response.

HasTimeout

This plugin allows you to define a connectTimeout and requestTimeout property on your request or connector.