SearchHandler
extends Handler
in package
Table of Contents
Properties
Methods
- __construct() : mixed
- area() : Collection<string|int, Area>
- Search for areas and return models
- artist() : Collection<string|int, Artist>
- Search for artists and return models
- artistRaw() : array<string|int, mixed>
- Get raw API response for artists (for backward compatibility)
- event() : Collection<string|int, Event>
- Search for events and return models
- genre() : Collection<string|int, Genre>
- Search for genres and return models
- getSearchMetadata() : array<string|int, mixed>
- Get search metadata (count, offset, etc.) from last search
- instrument() : Collection<string|int, Instrument>
- Search for instruments and return models
- label() : Collection<string|int, Label>
- Search for labels and return models
- place() : Collection<string|int, Place>
- Search for places and return models
- recording() : Collection<string|int, Recording>
- Search for recordings and return models
- release() : Collection<string|int, Release>
- Search for releases and return models
- releaseRaw() : array<string|int, mixed>
- Get raw API response for releases (for backward compatibility)
- series() : Collection<string|int, Series>
- Search for series and return models
- url() : Collection<string|int, Url>
- Search for URLs and return models
- work() : Collection<string|int, Work>
- Search for works and return models
- fetchEndpoint() : array<string|int, mixed>|null
Properties
$baseUrl read-only
protected
string
$baseUrl
$client read-only
protected
Client
$client
Methods
__construct()
public
__construct(Client $client, string $baseUrl) : mixed
Parameters
- $client : Client
- $baseUrl : string
area()
Search for areas and return models
public
area(AreaFilter $filter) : Collection<string|int, Area>
Parameters
- $filter : AreaFilter
-
Filter criteria
Return values
Collection<string|int, Area> —Collection of Area models
artist()
Search for artists and return models
public
artist(ArtistFilter $filter) : Collection<string|int, Artist>
Parameters
- $filter : ArtistFilter
-
Filter criteria
Return values
Collection<string|int, Artist> —Collection of Artist models
artistRaw()
Get raw API response for artists (for backward compatibility)
public
artistRaw(ArtistFilter $filter) : array<string|int, mixed>
Parameters
- $filter : ArtistFilter
-
Filter criteria
Return values
array<string|int, mixed> —Raw API response
event()
Search for events and return models
public
event(EventFilter $filter) : Collection<string|int, Event>
Parameters
- $filter : EventFilter
-
Filter criteria
Return values
Collection<string|int, Event> —Collection of Event models
genre()
Search for genres and return models
public
genre(GenreFilter $filter) : Collection<string|int, Genre>
Parameters
- $filter : GenreFilter
-
Filter criteria
Return values
Collection<string|int, Genre> —Collection of Genre models
getSearchMetadata()
Get search metadata (count, offset, etc.) from last search
public
getSearchMetadata(string $type, mixed $filter) : array<string|int, mixed>
Parameters
- $type : string
-
Entity type (artist, release, etc.)
- $filter : mixed
-
Filter used for the search
Return values
array<string|int, mixed> —Metadata array
instrument()
Search for instruments and return models
public
instrument(InstrumentFilter $filter) : Collection<string|int, Instrument>
Parameters
- $filter : InstrumentFilter
-
Filter criteria
Return values
Collection<string|int, Instrument> —Collection of Instrument models
label()
Search for labels and return models
public
label(LabelFilter $filter) : Collection<string|int, Label>
Parameters
- $filter : LabelFilter
-
Filter criteria
Return values
Collection<string|int, Label> —Collection of Label models
place()
Search for places and return models
public
place(PlaceFilter $filter) : Collection<string|int, Place>
Parameters
- $filter : PlaceFilter
-
Filter criteria
Return values
Collection<string|int, Place> —Collection of Place models
recording()
Search for recordings and return models
public
recording(RecordingFilter $filter) : Collection<string|int, Recording>
Parameters
- $filter : RecordingFilter
-
Filter criteria
Return values
Collection<string|int, Recording> —Collection of Recording models
release()
Search for releases and return models
public
release(ReleaseFilter $filter) : Collection<string|int, Release>
Parameters
- $filter : ReleaseFilter
-
Filter criteria
Return values
Collection<string|int, Release> —Collection of Release models
releaseRaw()
Get raw API response for releases (for backward compatibility)
public
releaseRaw(ReleaseFilter $filter) : array<string|int, mixed>
Parameters
- $filter : ReleaseFilter
-
Filter criteria
Return values
array<string|int, mixed> —Raw API response
series()
Search for series and return models
public
series(SeriesFilter $filter) : Collection<string|int, Series>
Parameters
- $filter : SeriesFilter
-
Filter criteria
Return values
Collection<string|int, Series> —Collection of Series models
url()
Search for URLs and return models
public
url(UrlFilter $filter) : Collection<string|int, Url>
Parameters
- $filter : UrlFilter
-
Filter criteria
Return values
Collection<string|int, Url> —Collection of Url models
work()
Search for works and return models
public
work(WorkFilter $filter) : Collection<string|int, Work>
Parameters
- $filter : WorkFilter
-
Filter criteria
Return values
Collection<string|int, Work> —Collection of Work models
fetchEndpoint()
protected
fetchEndpoint(string $endpoint[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
- $endpoint : string
- $params : array<string|int, mixed> = []