Saloon Documentation

The Saloon logo is subject to specific licensing conditions.

Permitted Uses

You may use the logo for:

• Marketing materials for technical events (meetups, hackathons, conferences, workshops) related to Laravel.
• Open source projects related to Laravel.
• Technical articles, videos, books, or papers for educational purposes.
• Illustrating a commercial product (to show integration).

Prohibited Uses

You may NOT use the logo without prior written consent for:

• Using the logo in a commercial product for purposes other than illustrating its integration.
• Selling physical products that use the Saloon logo or its variants (e.g., t-shirts).

All rights are reserved, and the owner reserves the right of final explanation for any use case not explicitly stated above.

The MockClient is used to fake HTTP requests during testing, allowing you to define expected responses without making real network calls. You can instantiate a new MockClient or use a global instance.

Responses can be added to the client in several ways:

1. Sequence: Responses added without a specific capture method are played back in the order they were added.
2. Request-based: Map a specific Request class to a response.
3. Connector-based: Map a specific Connector class to a response.
4. URL-based: Map a URL pattern (using URLHelper matching) to a response.

You can register a global MockClient that is available throughout your application's lifecycle. This is useful for integration tests where the client is instantiated deep within the application code.

Important: You must call MockClient::destroyGlobal() after each test to prevent state leakage between tests.

The Saloon brand identity uses the Lato font. The color palette consists of the following hex and RGB values:

Methods for retrieving raw response data:

• body(): Returns the response body as a string.
• stream(): Returns the response body as a Psr\\Http\\Message\\StreamInterface.
• headers(): Returns an ArrayStore containing the response headers.
• header(string $header): Returns a specific header value. If the header has multiple values, it returns an array; otherwise, it returns a string.

Once a FakeResponse is created, you can inspect its contents using the following methods:

• status(): Returns the HTTP status code as an int.
• headers(): Returns the headers as an ArrayStoreContract.
• body(): Returns the response body as a BodyRepository (either JsonBodyRepository or StringBodyRepository).

Use FakeResponse::make() to create a mock HTTP response for testing. You can specify the response body (as an array or string), the HTTP status code, and an array of headers.

If you provide an array as the body, it is treated as a JsonBodyRepository. If you provide a string, it is treated as a StringBodyRepository.

The setRequests() method allows you to define the collection of requests to be processed. It accepts:

• An iterable of Saloon\Http\Request objects or GuzzleHttp\Promise\PromiseInterface instances.
• A callable that receives the Connector and returns an iterable of requests.

Using a callable is useful for lazily generating requests that depend on the connector configuration.

You can retrieve data from the repository using:

• get(string|int $key, mixed $default = null): MultipartValue|array: Returns a single MultipartValue if there is one match for the key, or an array of MultipartValue objects if multiple matches exist. Returns $default if no match is found.
• all(): array: Returns an array of all MultipartValue objects currently in the repository.

When using Saloon fixtures to fake HTTP responses, you can dynamically alter the data returned by the fixture before it is used in your tests. This is useful for making static fixtures more flexible (e.g., changing an ID or a timestamp).

• merge(array $merge): Uses dot-notation to overwrite or add specific keys to the response body.
• through(\Closure $through): Allows you to pass the entire response body through a custom closure for complex transformations.