PHP 클래스 Iamstuartwilson\StravaApi

저자: Stuart Wilson ([email protected])
파일 보기 프로젝트 열기: iamstuartwilson/strava 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$lastRequest
$lastRequestData
$lastRequestInfo

보호된 프로퍼티들

프로퍼티 타입 설명
$apiUrl
$authUrl
$clientId
$clientSecret
$responseHeaders array [ 'Cache-Control' => 'max-age=0, private, must-revalidate', 'X-RateLimit-Limit' => '600,30000', 'X-RateLimit-Usage' => '4,25', 'Content-Length' => '2031', ... ] Access with the getResponseHeader() or getResponseHeaders() methods.

공개 메소드들

메소드 설명
__construct ( integer $clientId = 1, string $clientSecret = '' ) Sets up the class with the $clientId and $clientSecret
authenticationUrl ( string $redirect, string $approvalPrompt = 'auto', string $scope = null, string $state = null ) : string Creates authentication URL for your app
deauthorize ( ) : string Deauthorises application
delete ( string $request, array $parameters = [] ) : string Sends DELETE request to specified API endpoint
get ( string $request, array $parameters = [] ) : string Sends GET request to specified API endpoint
getResponseHeader ( string $header ) : string
getResponseHeaders ( ) : array Returns the complete list of response headers.
post ( string $request, array $parameters = [] ) : string Sends POST request to specified API endpoint
put ( string $request, array $parameters = [] ) : string Sends PUT request to specified API endpoint
setAccessToken ( string $token ) : string Sets the access token used to authenticate API requests
tokenExchange ( string $code ) : string Authenticates token returned from API

보호된 메소드들

메소드 설명
generateParameters ( array $parameters ) : array Adds access token to paramters sent to API
parseGet ( string $url, array $query ) : string Appends query array onto URL
parseHeader ( resource $curl, string $headerLine ) : integer Parses the header lines into the $responseHeaders attribute
parseResponse ( string $response ) : object Parses JSON as PHP object
request ( string $url, array $parameters = [], boolean | string $request = false ) : mixed Makes HTTP Request to the API

메소드 상세

__construct() 공개 메소드

Sets up the class with the $clientId and $clientSecret
public __construct ( integer $clientId = 1, string $clientSecret = '' )
$clientId integer
$clientSecret string

authenticationUrl() 공개 메소드

Creates authentication URL for your app
public authenticationUrl ( string $redirect, string $approvalPrompt = 'auto', string $scope = null, string $state = null ) : string
$redirect string
$approvalPrompt string
$scope string
$state string
리턴 string

deauthorize() 공개 메소드

Deauthorises application
public deauthorize ( ) : string
리턴 string

delete() 공개 메소드

Sends DELETE request to specified API endpoint
public delete ( string $request, array $parameters = [] ) : string
$request string
$parameters array
리턴 string

generateParameters() 보호된 메소드

Adds access token to paramters sent to API
protected generateParameters ( array $parameters ) : array
$parameters array
리턴 array

get() 공개 메소드

Sends GET request to specified API endpoint
public get ( string $request, array $parameters = [] ) : string
$request string
$parameters array
리턴 string

getResponseHeader() 공개 메소드

public getResponseHeader ( string $header ) : string
$header string
리턴 string

getResponseHeaders() 공개 메소드

Returns the complete list of response headers.
public getResponseHeaders ( ) : array
리턴 array

parseGet() 보호된 메소드

Appends query array onto URL
protected parseGet ( string $url, array $query ) : string
$url string
$query array
리턴 string

parseHeader() 보호된 메소드

Skips the first header line (HTTP response status) and the last header line (empty).
protected parseHeader ( resource $curl, string $headerLine ) : integer
$curl resource
$headerLine string
리턴 integer length of the currently parsed header line in bytes

parseResponse() 보호된 메소드

Parses JSON as PHP object
protected parseResponse ( string $response ) : object
$response string
리턴 object

post() 공개 메소드

Sends POST request to specified API endpoint
public post ( string $request, array $parameters = [] ) : string
$request string
$parameters array
리턴 string

put() 공개 메소드

Sends PUT request to specified API endpoint
public put ( string $request, array $parameters = [] ) : string
$request string
$parameters array
리턴 string

request() 보호된 메소드

Makes HTTP Request to the API
protected request ( string $url, array $parameters = [], boolean | string $request = false ) : mixed
$url string
$parameters array
$request boolean | string the request method, default is POST
리턴 mixed

setAccessToken() 공개 메소드

Sets the access token used to authenticate API requests
public setAccessToken ( string $token ) : string
$token string
리턴 string

tokenExchange() 공개 메소드

Authenticates token returned from API
public tokenExchange ( string $code ) : string
$code string
리턴 string

프로퍼티 상세

$apiUrl 보호되어 있는 프로퍼티

protected $apiUrl

$authUrl 보호되어 있는 프로퍼티

protected $authUrl

$clientId 보호되어 있는 프로퍼티

protected $clientId

$clientSecret 보호되어 있는 프로퍼티

protected $clientSecret

$lastRequest 공개적으로 프로퍼티

public $lastRequest

$lastRequestData 공개적으로 프로퍼티

public $lastRequestData

$lastRequestInfo 공개적으로 프로퍼티

public $lastRequestInfo

$responseHeaders 보호되어 있는 프로퍼티

[ 'Cache-Control' => 'max-age=0, private, must-revalidate', 'X-RateLimit-Limit' => '600,30000', 'X-RateLimit-Usage' => '4,25', 'Content-Length' => '2031', ... ] Access with the getResponseHeader() or getResponseHeaders() methods.
protected array $responseHeaders
리턴 array