class Fixture

Constants

protected FIXTURE_EXTENSION

The fixture extension.

Properties

protected null|array<string, mixed> $merge

Data merged into the mocked response body.

protected null|Closure(array<string, mixed>): array<string, mixed> $through

The response body transformer.

protected ArrayRepository $context

The fixture context.

protected Filesystem $files

The filesystem used by the fixture.

Methods

__construct(string $name = '', Filesystem|null $files = null, ArrayRepository|null $context = null)

Create a fixture.

merge(array $merge = [])

Merge data into the mocked response body.

through(Closure $through)

Transform the mocked response body.

getMockResponse()

Load the mock response from the fixture.

store(RecordedResponse $recordedResponse)

Store a recorded response as the fixture.

string
getFixturePath()

Get the absolute fixture path.

string
defineName()

Define the fixture name.

swapSensitiveHeaders(RecordedResponse $recordedResponse)

Redact sensitive headers.

swapSensitiveJson(RecordedResponse $recordedResponse)

Redact sensitive JSON values.

swapSensitiveBodyWithRegex(RecordedResponse $recordedResponse)

Redact sensitive response body patterns.

array
defineSensitiveHeaders()

Define sensitive response headers.

array
defineSensitiveJsonParameters()

Define sensitive JSON attributes.

array
defineSensitiveRegexPatterns()

Define sensitive response body patterns.

beforeSave(RecordedResponse $recordedResponse)

Prepare a recorded response before storage.

mixed
getContext(string|null $key = null)

Get fixture context or a single context value.

setContext(string $key, mixed $value)

Set a fixture context value.

withContext(array $context)

Merge fixture context values.

manager()

Resolve the Saloon manager.

Details

at line 51
__construct(string $name = '', Filesystem|null $files = null, ArrayRepository|null $context = null)

Create a fixture.

Parameters

string $name
Filesystem|null $files
ArrayRepository|null $context

at line 66
Fixture merge(array $merge = [])

Merge data into the mocked response body.

Parameters

array $merge

Return Value

Fixture

at line 79
Fixture through(Closure $through)

Transform the mocked response body.

Parameters

Closure $through

Return Value

Fixture

at line 89
MockResponse|null getMockResponse()

Load the mock response from the fixture.

Return Value

MockResponse|null

at line 135
Fixture store(RecordedResponse $recordedResponse)

Store a recorded response as the fixture.

Parameters

RecordedResponse $recordedResponse

Return Value

Fixture

at line 153
string getFixturePath()

Get the absolute fixture path.

Return Value

string

at line 181
protected string defineName()

Define the fixture name.

Return Value

string

at line 189
protected RecordedResponse swapSensitiveHeaders(RecordedResponse $recordedResponse)

Redact sensitive headers.

Parameters

RecordedResponse $recordedResponse

Return Value

RecordedResponse

at line 210
protected RecordedResponse swapSensitiveJson(RecordedResponse $recordedResponse)

Redact sensitive JSON values.

Parameters

RecordedResponse $recordedResponse

Return Value

RecordedResponse

at line 239
protected RecordedResponse swapSensitiveBodyWithRegex(RecordedResponse $recordedResponse)

Redact sensitive response body patterns.

Parameters

RecordedResponse $recordedResponse

Return Value

RecordedResponse

at line 258
protected array defineSensitiveHeaders()

Define sensitive response headers.

Return Value

array

at line 268
protected array defineSensitiveJsonParameters()

Define sensitive JSON attributes.

Return Value

array

at line 278
protected array defineSensitiveRegexPatterns()

Define sensitive response body patterns.

Return Value

array

at line 286
protected RecordedResponse beforeSave(RecordedResponse $recordedResponse)

Prepare a recorded response before storage.

Parameters

RecordedResponse $recordedResponse

Return Value

RecordedResponse

at line 296
mixed getContext(string|null $key = null)

Get fixture context or a single context value.

Parameters

string|null $key

Return Value

mixed

at line 306
Fixture setContext(string $key, mixed $value)

Set a fixture context value.

Parameters

string $key
mixed $value

Return Value

Fixture

at line 319
Fixture withContext(array $context)

Merge fixture context values.

Parameters

array $context

Return Value

Fixture

at line 329
protected SaloonManager manager()

Resolve the Saloon manager.

Return Value

SaloonManager