Skip to content

Latest commit

 

History

History
134 lines (95 loc) · 2.84 KB

Request.md

File metadata and controls

134 lines (95 loc) · 2.84 KB

Request

Table of Contents

Constants

  • ACCOUNT_URL
  • API_URL

Methods

__construct

Request::__construct($options)

Constructor
Set options.

Arguments

  • $options array|object - Optional. Options to set.

account

Request::account($method, $uri, $parameters, $headers)

Make a request to the "account" endpoint.

Arguments

  • $method string - The HTTP method to use.
  • $uri string - The URI to request.
  • $parameters string|array - Optional. Query string parameters or HTTP body, depending on $method.
  • $headers array - Optional. HTTP headers.

Return values

  • array Response data.
    • array|object body The response body. Type is controlled by the return_assoc option.
    • array headers Response headers.
    • int status HTTP status code.
    • string url The requested URL.

api

Request::api($method, $uri, $parameters, $headers)

Make a request to the "api" endpoint.

Arguments

  • $method string - The HTTP method to use.
  • $uri string - The URI to request.
  • $parameters string|array - Optional. Query string parameters or HTTP body, depending on $method.
  • $headers array - Optional. HTTP headers.

Return values

  • array Response data.
    • array|object body The response body. Type is controlled by the return_assoc option.
    • array headers Response headers.
    • int status HTTP status code.
    • string url The requested URL.

getLastResponse

Request::getLastResponse()

Get the latest full response from the Spotify API.

Return values

  • array Response data.
    • array|object body The response body. Type is controlled by the return_assoc option.
    • array headers Response headers.
    • int status HTTP status code.
    • string url The requested URL.

send

Request::send($method, $url, $parameters, $headers)

Make a request to Spotify.
You'll probably want to use one of the convenience methods instead.

Arguments

  • $method string - The HTTP method to use.
  • $url string - The URL to request.
  • $parameters string|array|object - Optional. Query string parameters or HTTP body, depending on $method.
  • $headers array - Optional. HTTP headers.

Return values

  • array Response data.
    • array|object body The response body. Type is controlled by the return_assoc option.
    • array headers Response headers.
    • int status HTTP status code.
    • string url The requested URL.

setOptions

Request::setOptions($options)

Set options

Arguments

  • $options array|object - Options to set.

Return values

  • self