Blitzr PHP client Documentation
Table of Contents
- BlitzrClient
- __construct
- request
- getArtist
- getArtistAliases
- getArtistBands
- getArtistBiography
- getArtistEvents
- getArtistHarmonia
- getArtistMembers
- getArtistRelated
- getArtistReleases
- getArtistSimilar
- getArtistSummary
- getArtistWebsites
- getEvent
- searchEvent
- getHarmoniaArtist
- getHarmoniaRelease
- getHarmoniaLabel
- getHarmoniaSearchBySource
- getLabel
- getLabelArtists
- getLabelBiography
- getLabelHarmonia
- getLabelReleases
- getLabelSimilar
- getLabelWebsites
- getRadioArtist
- getRadioArtistSimilar
- getRadioEvent
- getRadioLabel
- getRadioTag
- getRelease
- getReleaseSources
- search
- searchArtist
- searchLabel
- searchRelease
- searchTrack
- getShopArtist
- getShopLabel
- getShopRelease
- getShopTrack
- getTag
- getTagArtists
- getTagReleases
- getTrack
- getTrackSources
- ClientException
- ConfigurationException
- NetworkException
- ServerException
BlitzrClient
BlitzrClient is the only client you need to access Blitzr API.
Just create an instance of BlitzrClient with your API key and start enjoying Blitzr’s Metadatas.
- Full name: \Blitzr\BlitzrClient
__construct
BlitzrClient constructor.
BlitzrClient::__construct( string $apiKey ): null
Use this constructor to set the API key to the new BlitzrClient and start your dev.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$apiKey |
string | Blitzr API key |
request
Make a request to Blitzr API.
BlitzrClient::request( string $method, array<mixed,mixed> $params = array() ): object|array|null
This method makes a request to Blitzr API on the method given in first parameter. The second parameter is an associative array that represent the query params of the request. The query param ‘key’ is automatically add by this method.
Parameters:
| Parameter | Type | Description |
|———–|——|————-|
| $method | string | Blitzr method to call (https://api.blitzr.com/method) |
| $params | array<mixed,mixed> | Query parameters, this param is an associative array where
the key is the name of the corresponding query param and the value is the value of
the corresponding query param. |
getArtist
Get artist.
BlitzrClient::getArtist( string $slug = null, string $uuid = null, array $extras = array(), integer $extras_limit = null ): object
Get artist by slug or uuid. At least one of the $slug or $uuid parameters is mandatory. You can get extra informations by setting the $extra parameter. You can limit the extrs by the $extras_limit parameter.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
$extras |
array | Artist extras : aliases, websites, biography, last_releases, next_events, relations |
$extras_limit |
integer | Limit for iterable extras : last_releases, next_events (max is 10) |
getArtistAliases
Get all artist’s aliases.
BlitzrClient::getArtistAliases( string $slug = null, string $uuid = null ): array
Get all the aliases of an artist. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
getArtistBands
Get artist’s bands.
BlitzrClient::getArtistBands( string $slug = null, string $uuid = null, integer $start = null, integer $limit = null ): array
Get all the aliases of an artist. At least one of the $slug or $uuid parameters is mandatory. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
getArtistBiography
Get artist’s biography.
BlitzrClient::getArtistBiography( string $slug = null, string $uuid = null, string $lang = null, boolean $html_format = false, string $url_scheme = null ): object
Get artist’s biography by slug or uuid. At least one of the $slug or $uuid parameters is mandatory. You can customize the response by the parameters $html_format and $url_scheme
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
$lang |
string | Language by country code (en|fr|…) |
$html_format |
boolean | Retreive the biography with html markup |
$url_scheme |
string | Customize the url scheme in the biography |
getArtistEvents
Get artist’s events.
BlitzrClient::getArtistEvents( string $slug = null, string $uuid = null, integer $start = null, integer $limit = null ): array
Get the events of an artist. At least one of the $slug or $uuid parameters is mandatory. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
getArtistHarmonia
Get artist’s harmonia.
BlitzrClient::getArtistHarmonia( string $slug = null, string $uuid = null ): object
Get the identifiers of this artist in other databases.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
getArtistMembers
Get group’s members.
BlitzrClient::getArtistMembers( string $slug = null, string $uuid = null, integer $start = null, integer $limit = null ): array
Get the members of a group. At least one of the $slug or $uuid parameters is mandatory. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
getArtistRelated
Get related artists.
BlitzrClient::getArtistRelated( string $slug = null, string $uuid = null, integer $start = null, integer $limit = null ): array
Get related artists to a given artist. At least one of the $slug or $uuid parameters is mandatory. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
getArtistReleases
Get artist’s releases.
BlitzrClient::getArtistReleases( string $slug = null, string $uuid = null, integer $start = null, integer $limit = null, string $type = null, string $format = null, boolean $credited = false ): array
Get related artists to a given artist. At least one of the $slug or $uuid parameters is mandatory. You can paginate by setting $start and $limit parameters. You can filter by release type with the $type parameter. You can filter by release format with the $format parameter.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
$type |
string | Filter by release type (official|unofficial|all) |
$format |
string | Filter by release format (album|single|live|all) |
$credited |
boolean | Releases where artist is credited (not main releases) |
getArtistSimilar
Get artist’s similar artists.
BlitzrClient::getArtistSimilar( string $slug = null, string $uuid = null, array $filters = array(), integer $start = null, integer $limit = null ): array
Get artist similar from a given artist. At least one of the $slug or $uuid parameters is mandatory. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
$filters |
array | Filter results. Available filters : location |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
getArtistSummary
Get an artist summary.
BlitzrClient::getArtistSummary( string $slug = null, string $uuid = null ): object
Get the artist summary. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
getArtistWebsites
Get all artist’s websites.
BlitzrClient::getArtistWebsites( string $slug = null, string $uuid = null ): array
Get all the websites of an artist. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
getEvent
Get an event.
BlitzrClient::getEvent( string $slug = null, string $uuid = null ): object
Get an event by slug or uuid. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the event |
$uuid |
string | Blitzr uuid of the event |
searchEvent
Search Event.
BlitzrClient::searchEvent( string $query = null, array<mixed,string> $filters = array(), integer $start = null, integer $limit = null, $extras = false ): object
Search Event. Use $query parameter to search the Event. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$query |
string | Search query |
$filters |
array<mixed,string> | Filter results. Available filters : artist, country_code, city, venue, date_start, date_end, latitude, longitude, radius |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
$extras |
** |
getHarmoniaArtist
Find an artist in the Harmonia.
BlitzrClient::getHarmoniaArtist( string $service_name = null, string|integer $service_id = null ): object
Find an artist in the Harmonia. Provide a service name and the artist’s id for this service to retreive all the equivalence
Parameters:
| Parameter | Type | Description |
|---|---|---|
$service_name |
string | Name of the reference service |
$service_id |
string|integer | Id of the artist in the reference service |
getHarmoniaRelease
Find a release in the Harmonia.
BlitzrClient::getHarmoniaRelease( string $service_name = null, string|integer $service_id = null ): object
Find an release in the Harmonia. Provide a service name and the release’s id for this service to retreive all the equivalence
Parameters:
| Parameter | Type | Description |
|---|---|---|
$service_name |
string | Name of the reference service |
$service_id |
string|integer | Id of the release in the reference service |
getHarmoniaLabel
Find a label in the Harmonia.
BlitzrClient::getHarmoniaLabel( string $service_name = null, string|integer $service_id = null ): object
Find an label in the Harmonia. Provide a service name and the label’s id for this service to retreive all the equivalence
Parameters:
| Parameter | Type | Description |
|---|---|---|
$service_name |
string | Name of the reference service |
$service_id |
string|integer | Id of the label in the reference service |
getHarmoniaSearchBySource
Find a track in the Harmonia by the music source.
BlitzrClient::getHarmoniaSearchBySource( string $source_name = null, string|integer $source_id = null, array<mixed,string> $source_filters = array(), boolean $strict = false ): array|object
Find an track in the Harmonia by the music source. Provide a source name and the source’s id for this source to retreive track associated in the Harmonia. The track is retreived with the artist and release informations. By default all other sources for this track are also retreived. You can filter by service with $source_filters. The $strict param allow Blitzr to guess what is the best result for you.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$source_name |
string | Name of the reference source |
$source_id |
string|integer | Id of the release in the reference source |
$source_filters |
array<mixed,string> | Source filters : which sources do you want in response ? |
| One or many, separated by comma : youtube, soundcloud, bandcamp, deezer, spotify, rdio | ||
$strict |
boolean | True if you want blitzr to guess the best result for you. |
| False if you want all matched results |
getLabel
Get label.
BlitzrClient::getLabel( string $slug = null, string $uuid = null, array $extras = array(), integer $extras_limit = null ): object
Get label by slug or uuid. At least one of the $slug or $uuid parameters is mandatory. You can get extra informations by setting the $extra parameter. You can limit the extrs by the $extras_limit parameter.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the label |
$uuid |
string | Blitzr uuid of the label |
$extras |
array | Label extras : biography, websites, artists, last_releases, relations |
$extras_limit |
integer | Limit for iterable extras : last_releases, artists (max is 10) |
getLabelArtists
Get label’s artists.
BlitzrClient::getLabelArtists( string $slug = null, string $uuid = null, integer $start = null, integer $limit = null, string $order = null ): array
Get the artists of a label. At least one of the $slug or $uuid parameters is mandatory. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the label |
$uuid |
string | Blitzr uuid of the label |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
$order |
string | Order results by name or date of last release (must be ‘name’ or ‘releaseDate’ |
| default is date) |
getLabelBiography
Get label’s biography.
BlitzrClient::getLabelBiography( string $slug = null, string $uuid = null, boolean $html_format = false, string $url_scheme = null ): object
Get label’s biography by slug or uuid. At least one of the $slug or $uuid parameters is mandatory. You can customize the response by the parameters $html_format and $url_scheme
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the label |
$uuid |
string | Blitzr uuid of the label |
$html_format |
boolean | Retreive the biography with html markup |
$url_scheme |
string | Customize the url scheme in the biography |
getLabelHarmonia
Get label’s harmonia.
BlitzrClient::getLabelHarmonia( string $slug = null, string $uuid = null ): object
Get the identifiers of this label in other databases.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the label |
$uuid |
string | Blitzr uuid of the label |
getLabelReleases
Get label’s releases.
BlitzrClient::getLabelReleases( string $slug = null, string $uuid = null, string $format = null, integer $start = null, integer $limit = null ): array
Get the releases of a label. At least one of the $slug or $uuid parameters is mandatory. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the label |
$uuid |
string | Blitzr uuid of the label |
$format |
string | Format of album (album|single|live|all) |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
getLabelSimilar
Get label’s similar.
BlitzrClient::getLabelSimilar( string $slug = null, string $uuid = null, array $filters = array(), integer $start = null, integer $limit = null ): array
Get the similar labels of a given label. At least one of the $slug or $uuid parameters is mandatory. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the label |
$uuid |
string | Blitzr uuid of the label |
$filters |
array | Filter results. Available filters : location |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
getLabelWebsites
Get all label’s websites.
BlitzrClient::getLabelWebsites( string $slug = null, string $uuid = null ): array
Get all the websites of a label. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the label |
$uuid |
string | Blitzr uuid of the label |
getRadioArtist
Get an Artist’s radio.
BlitzrClient::getRadioArtist( string $slug = null, string $uuid = null, integer $limit = null ): array
Get a list of tracks from his last or famous releases. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
$limit |
integer | Limit the number of results, for pagination |
getRadioArtistSimilar
Get an Artist’s similar radio.
BlitzrClient::getRadioArtistSimilar( string $slug = null, string $uuid = null, integer $limit = null ): array
Get a list of tracks from the last or famous releases of the given artist similar. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
$limit |
integer | Limit the number of results, for pagination |
getRadioEvent
Get an Event’s radio.
BlitzrClient::getRadioEvent( string $slug = null, string $uuid = null, integer $limit = null ): array
Get a list of tracks from the last or famous releases of the event’s artists. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the event |
$uuid |
string | Blitzr uuid of the event |
$limit |
integer | Limit the number of results, for pagination |
getRadioLabel
Get an Label’s radio.
BlitzrClient::getRadioLabel( string $slug = null, string $uuid = null, integer $limit = null ): array
Get a list of tracks from the last or famous releases of the label’s artists. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the label |
$uuid |
string | Blitzr uuid of the label |
$limit |
integer | Limit the number of results, for pagination |
getRadioTag
Get an Tag’s radio.
BlitzrClient::getRadioTag( string $slug = null, integer $limit = null ): array
Get a list of tracks from the last or famous releases of the tag’s artists. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the tag |
$limit |
integer | Limit the number of results, for pagination |
getRelease
Get a release.
BlitzrClient::getRelease( string $slug = null, string $uuid = null ): object
Get a release by slug or uuid. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the release |
$uuid |
string | Blitzr uuid of the release |
getReleaseSources
Get all release’s sources.
BlitzrClient::getReleaseSources( string $slug = null, string $uuid = null ): array
Get all release’s sources. At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the release |
$uuid |
string | Blitzr uuid of the release |
search
Search in multiple types.
BlitzrClient::search( string $query = null, array<mixed,string> $type = array(), boolean $autocomplete = false, integer $start = null, integer $limit = null, $extras = false ): object
Search in multiple types. Use $query parameter to search the entity. The $autocomplete parameter allow you to find entity with predictive algorithm. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$query |
string | Search query |
$type |
array<mixed,string> | Set requested types. Available types : artist, label, release, track |
$autocomplete |
boolean | Enable predictive search |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
$extras |
** |
searchArtist
Search Artist.
BlitzrClient::searchArtist( string $query = null, array<mixed,string> $filters = array(), boolean $autocomplete = false, integer $start = null, integer $limit = null, $extras = false ): object
Search artist. Use $query parameter to search the artist. The $autocomplete parameter allow you to find artist with predictive algorithm. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$query |
string | Search query |
$filters |
array<mixed,string> | Filter results. Available filters : location, tag, type |
$autocomplete |
boolean | Enable predictive search |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
$extras |
** |
searchLabel
Search Label.
BlitzrClient::searchLabel( string $query = null, array<mixed,string> $filters = array(), boolean $autocomplete = false, integer $start = null, integer $limit = null, $extras = false ): object
Search label. Use $query parameter to search the label. The $autocomplete parameter allow you to find label with predictive algorithm. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$query |
string | Search query |
$filters |
array<mixed,string> | Filter results. Available filters : location, tag |
$autocomplete |
boolean | Enable predictive search |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
$extras |
** |
searchRelease
Search Release.
BlitzrClient::searchRelease( string $query = null, array<mixed,string> $filters = array(), boolean $autocomplete = false, integer $start = null, integer $limit = null, $extras = false ): object
Search release. Use $query parameter to search the release. The $autocomplete parameter allow you to find release with predictive algorithm. You can paginate by setting $start and $limit parameters. You can also enable some filters by the param $filters
Parameters:
| Parameter | Type | Description |
|---|---|---|
$query |
string | Search query |
$filters |
array<mixed,string> | Filter results. Available filters : artist, artist.uuid, tag, format_summary, year, location, label, label.uuid |
$autocomplete |
boolean | Enable predictive search |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
$extras |
** |
searchTrack
Search Track.
BlitzrClient::searchTrack( string $query = null, array<mixed,string> $filters = array(), integer $start = null, integer $limit = null, $extras = false ): object
Search track. Use $query parameter to search the track. The $autocomplete parameter allow you to find track with predictive algorithm. You can paginate by setting $start and $limit parameters. You can also enable some filters by the param $filters
Parameters:
| Parameter | Type | Description |
|---|---|---|
$query |
string | Search query |
$filters |
array<mixed,string> | Filter results. Available filters : artist, release, format_summary, year, location |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
$extras |
** |
getShopArtist
Get all shop items for an artist.
BlitzrClient::getShopArtist( string $product_type = null, string $slug = null, string $uuid = null ): array
Get all shop items for an artist. You must set the $product_type parameter. (cd|lp|mp3|merch) At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$product_type |
string | Type of shop product |
$slug |
string | Blitzr slug of the artist |
$uuid |
string | Blitzr uuid of the artist |
getShopLabel
Get all shop items for a label.
BlitzrClient::getShopLabel( string $product_type = null, string $slug = null, string $uuid = null ): array
Get all shop items for a label. You must set the $product_type parameter. (cd|lp|merch) At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$product_type |
string | Type of shop product |
$slug |
string | Blitzr slug of the label |
$uuid |
string | Blitzr uuid of the label |
getShopRelease
Get all shop items for a release.
BlitzrClient::getShopRelease( string $product_type = null, string $slug = null, string $uuid = null ): array
Get all shop items for a release. You must set the $product_type parameter. (cd|lp|mp3) At least one of the $slug or $uuid parameters is mandatory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$product_type |
string | Type of shop product |
$slug |
string | Blitzr slug of the release |
$uuid |
string | Blitzr uuid of the release |
getShopTrack
Get all shop items for a track.
BlitzrClient::getShopTrack( string $uuid = null ): array
Get all shop items for a track.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$uuid |
string | Blitzr uuid of the track |
getTag
Get a tag.
BlitzrClient::getTag( string $slug = null ): object
Get a tag by slug
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the tag |
getTagArtists
Get tags’s artists.
BlitzrClient::getTagArtists( string $slug = null, integer $start = null, integer $limit = null ): array
Get the artists of a tag. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the tag |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
getTagReleases
Get tags’s releases.
BlitzrClient::getTagReleases( string $slug = null, integer $start = null, integer $limit = null ): array
Get the releases of a tag. You can paginate by setting $start and $limit parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$slug |
string | Blitzr slug of the tag |
$start |
integer | Start from this parameter value, for pagination |
$limit |
integer | Limit the number of results, for pagination |
getTrack
Get a track.
BlitzrClient::getTrack( string $uuid = null ): object
Get a track by uuid
Parameters:
| Parameter | Type | Description |
|---|---|---|
$uuid |
string | Blitzr uuid of the track |
getTrackSources
Get all sources for a track.
BlitzrClient::getTrackSources( string $uuid = null ): array
Get all sources for a track.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$uuid |
string | Blitzr uuid of the track |
ClientException
ClientException, this exception is fired when the client did not provide all mandatory params.
- Full name: \Blitzr\Exception\ClientException
- Parent class:
__construct
ClientException constructor.
ClientException::__construct( string $message, integer $code, object $previous = null ): null
Use this constructor to set the error message and code, eventually give a parent exception.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$message |
string | Error message |
$code |
integer | Error code |
$previous |
object | Previous Exception |
__toString
ClientException toString.
ClientException::__toString( ): string
Return readable exception string
ConfigurationException
ConfigurationException, signal a configuration issue.
- Full name: \Blitzr\Exception\ConfigurationException
- Parent class:
__construct
ConfigurationException constructor.
ConfigurationException::__construct( string $message, integer $code, object $previous = null ): null
Use this constructor to set the error message and code, eventually give a parent exception.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$message |
string | Error message |
$code |
integer | Error code |
$previous |
object | Previous Exception |
__toString
ConfigurationException toString.
ConfigurationException::__toString( ): string
Return readable exception string
NetworkException
NetworkException, base exception.
- Full name: \Blitzr\Exception\NetworkException
- Parent class:
__construct
NetworkException constructor.
NetworkException::__construct( string $message, integer $code, object $previous = null ): null
Use this constructor to set the error message and code, eventually give a parent exception.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$message |
string | Error message |
$code |
integer | Error code |
$previous |
object | Previous Exception |
__toString
NetworkException toString.
NetworkException::__toString( ): string
Return readable exception string
ServerException
ServerException, base exception.
- Full name: \Blitzr\Exception\ServerException
- Parent class:
__construct
ServerException constructor.
ServerException::__construct( string $message, integer $code, object $previous = null ): null
Use this constructor to set the error message and code, eventually give a parent exception.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$message |
string | Error message |
$code |
integer | Error code |
$previous |
object | Previous Exception |
__toString
ServerException toString.
ServerException::__toString( ): string
Return readable exception string
This document was automatically generated from source code comments on 2016-09-30 using phpDocumentor and cvuorinen/phpdoc-markdown-public