SearchHandler
extends Handler
in package
Table of Contents
Properties
- $baseUrl : string
- $client : Client
- $lastPagination : array<string|int, mixed>|null
Methods
- __construct() : mixed
- artist() : Collection
- Search for artists and return models
- artistAsync() : PromiseInterface
- Search for artists asynchronously
- artistRaw() : array<string|int, mixed>
- Get raw API response for artists (for backward compatibility)
- artistRawAsync() : PromiseInterface
- Get raw API response for artists asynchronously
- canMakeRequest() : bool
- Check if we can make a Discogs request (not rate limited)
- getPagination() : array<string|int, mixed>|null
- Get pagination information from the last search
- getRateLimitStatus() : array<string|int, mixed>
- Get rate limit status information
- label() : Collection
- Search for labels and return models
- labelAsync() : PromiseInterface
- Search for labels asynchronously
- labelRawAsync() : PromiseInterface
- Get raw API response for labels asynchronously
- master() : Collection
- Search for master releases and return models
- masterAsync() : PromiseInterface
- Search for master releases asynchronously
- masterRawAsync() : PromiseInterface
- Get raw API response for masters asynchronously
- release() : Collection
- Search for releases and return models
- releaseAsync() : PromiseInterface
- Search for releases asynchronously
- releaseRaw() : array<string|int, mixed>
- Get raw API response for releases (for backward compatibility)
- releaseRawAsync() : PromiseInterface
- Get raw API response for releases asynchronously
- searchWithPagination() : array<string|int, mixed>
- Search with full pagination info
- searchWithPaginationAsync() : PromiseInterface
- Search with full pagination info asynchronously
- fetchEndpoint() : array<string|int, mixed>|null
- fetchEndpointAsync() : PromiseInterface
Properties
$baseUrl read-only
protected
string
$baseUrl
$client read-only
protected
Client
$client
$lastPagination
private
array<string|int, mixed>|null
$lastPagination
= null
Methods
__construct()
public
__construct(Client $client, string $baseUrl) : mixed
Parameters
- $client : Client
- $baseUrl : string
artist()
Search for artists and return models
public
artist(ArtistFilter $filter) : Collection
Parameters
- $filter : ArtistFilter
Return values
CollectionartistAsync()
Search for artists asynchronously
public
artistAsync(mixed $filter) : PromiseInterface
Parameters
- $filter : mixed
Return values
PromiseInterfaceartistRaw()
Get raw API response for artists (for backward compatibility)
public
artistRaw(mixed $filter) : array<string|int, mixed>
Parameters
- $filter : mixed
Return values
array<string|int, mixed>artistRawAsync()
Get raw API response for artists asynchronously
public
artistRawAsync(mixed $filter) : PromiseInterface
Parameters
- $filter : mixed
Return values
PromiseInterfacecanMakeRequest()
Check if we can make a Discogs request (not rate limited)
public
canMakeRequest() : bool
Return values
boolgetPagination()
Get pagination information from the last search
public
getPagination() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetRateLimitStatus()
Get rate limit status information
public
getRateLimitStatus() : array<string|int, mixed>
Return values
array<string|int, mixed>label()
Search for labels and return models
public
label(mixed $filter) : Collection
Parameters
- $filter : mixed
Return values
CollectionlabelAsync()
Search for labels asynchronously
public
labelAsync(mixed $filter) : PromiseInterface
Parameters
- $filter : mixed
Return values
PromiseInterfacelabelRawAsync()
Get raw API response for labels asynchronously
public
labelRawAsync(mixed $filter) : PromiseInterface
Parameters
- $filter : mixed
Return values
PromiseInterfacemaster()
Search for master releases and return models
public
master(mixed $filter) : Collection
Parameters
- $filter : mixed
Return values
CollectionmasterAsync()
Search for master releases asynchronously
public
masterAsync(mixed $filter) : PromiseInterface
Parameters
- $filter : mixed
Return values
PromiseInterfacemasterRawAsync()
Get raw API response for masters asynchronously
public
masterRawAsync(mixed $filter) : PromiseInterface
Parameters
- $filter : mixed
Return values
PromiseInterfacerelease()
Search for releases and return models
public
release(mixed $filter) : Collection
Parameters
- $filter : mixed
Return values
CollectionreleaseAsync()
Search for releases asynchronously
public
releaseAsync(mixed $filter) : PromiseInterface
Parameters
- $filter : mixed
Return values
PromiseInterfacereleaseRaw()
Get raw API response for releases (for backward compatibility)
public
releaseRaw(mixed $filter) : array<string|int, mixed>
Parameters
- $filter : mixed
Return values
array<string|int, mixed>releaseRawAsync()
Get raw API response for releases asynchronously
public
releaseRawAsync(mixed $filter) : PromiseInterface
Parameters
- $filter : mixed
Return values
PromiseInterfacesearchWithPagination()
Search with full pagination info
public
searchWithPagination(string $type, mixed $filter) : array<string|int, mixed>
Parameters
- $type : string
- $filter : mixed
Return values
array<string|int, mixed>searchWithPaginationAsync()
Search with full pagination info asynchronously
public
searchWithPaginationAsync(string $type, mixed $filter) : PromiseInterface
Parameters
- $type : string
- $filter : mixed
Return values
PromiseInterfacefetchEndpoint()
protected
fetchEndpoint(string $endpoint[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
- $endpoint : string
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>|nullfetchEndpointAsync()
protected
fetchEndpointAsync(string $endpoint[, array<string|int, mixed> $params = [] ]) : PromiseInterface
Parameters
- $endpoint : string
- $params : array<string|int, mixed> = []