PHP 클래스 Strava\API\Client

저자: Bas van Dorst
파일 보기 프로젝트 열기: basvandorst/stravaphp

보호된 프로퍼티들

프로퍼티 타입 설명
$service Strava\API\Service\ServiceInterface

공개 메소드들

메소드 설명
__construct ( Strava\API\Service\ServiceInterface $service ) Initiate this class with a subclass of ServiceInterface. There are two service subclasses available: - Service\REST: Service which makes calls to the live Strava API - Service\Stub: Service stub for test purposes (unit tests)
createActivity ( string $name, string $type, string $start_date_local, integer $elapsed_time, string $description = null, float $distance = null ) : array Create an activity
deleteActivity ( integer $id ) : array Delete an activity
getActivity ( integer $id, boolean $include_all_efforts = null ) : array Retrieve an activity
getActivityComments ( integer $id, boolean $markdown = null, integer $page = null, integer $per_page = null ) : array List activity comments
getActivityKudos ( integer $id, integer $page = null, integer $per_page = null ) : array List activity kudoers
getActivityLaps ( integer $id ) : array List activity laps
getActivityPhotos ( integer $id, integer $size = 2048, string $photo_sources = 'true' ) : array List activity photos
getActivityUploadStatus ( integer $id ) : array Check upload status
getActivityZones ( integer $id ) : array List activity zones
getAthlete ( integer $id = null ) : array Retrieve current athlete
getAthleteActivities ( string $before = null, string $after = null, integer $page = null, integer $per_page = null ) : array List athlete activities
getAthleteBothFollowing ( integer $id, integer $page = null, integer $per_page = null ) : array List both following
getAthleteClubs ( ) : array List athlete clubs
getAthleteFollowers ( integer $id = null, integer $page = null, integer $per_page = null ) : array List athlete followers
getAthleteFriends ( integer $id = null, integer $page = null, integer $per_page = null ) : array List athlete friends
getAthleteKom ( integer $id, integer $page = null, integer $per_page = null ) : array List athlete K/QOMs/CRs
getAthleteStarredSegments ( integer $id = null, integer $page = null, integer $per_page = null ) : array List starred segment
getAthleteStats ( integer $id ) : array Retrieve athlete stats
getClub ( integer $id ) : array Retrieve a club
getClubActivities ( integer $id, integer $page = null, integer $per_page = null ) : array List club activities
getClubAnnouncements ( integer $id ) : array List club announcements
getClubGroupEvents ( integer $id ) : array List club group events
getClubMembers ( integer $id, integer $page = null, integer $per_page = null ) : array List club members
getGear ( integer $id ) : array Retrieve gear
getSegment ( integer $id ) : array Retrieve a segment
getSegmentEffort ( integer $id, integer $athlete_id = null, string $start_date_local = null, string $end_date_local = null, integer $page = null, integer $per_page = null ) : array List efforts filtered by athlete and/or a date range
getSegmentExplorer ( string $bounds, string $activity_type = 'riding', integer $min_cat = null, integer $max_cat = null ) : array Segment explorer
getSegmentLeaderboard ( integer $id, string $gender = null, string $age_group = null, string $weight_class = null, boolean $following = null, integer $club_id = null, string $date_range = null, integer $context_entries = null, integer $page = null, integer $per_page = null ) : array Segment leaderboards
getStreamsActivity ( integer $id, string $types, string $resolution = null, string $series_type = 'distance' ) : array Retrieve activity streams
getStreamsEffort ( integer $id, string $types, string $resolution = null, string $series_type = 'distance' ) : array Retrieve effort streams
getStreamsSegment ( integer $id, string $types, string $resolution = null, string $series_type = 'distance' ) : array Retrieve segment streams
joinClub ( integer $id ) : array Join a club
leaveClub ( integer $id ) : array Leave a club
updateActivity ( integer $id, string $name = null, string $type = null, boolean $private = false, boolean $commute = false, boolean $trainer = false, string $gear_id = null, string $description = null ) : array Update an activity
updateAthlete ( string $city, string $state, string $country, string $sex, float $weight ) : array Update current athlete
uploadActivity ( mixed $file, string $activity_type = null, string $name = null, string $description = null, integer $private = null, integer $trainer = null, integer $commute = null, string $data_type = null, string $external_id = null ) : array Upload an activity

메소드 상세

__construct() 공개 메소드

Initiate this class with a subclass of ServiceInterface. There are two service subclasses available: - Service\REST: Service which makes calls to the live Strava API - Service\Stub: Service stub for test purposes (unit tests)
public __construct ( Strava\API\Service\ServiceInterface $service )
$service Strava\API\Service\ServiceInterface

createActivity() 공개 메소드

Create an activity
public createActivity ( string $name, string $type, string $start_date_local, integer $elapsed_time, string $description = null, float $distance = null ) : array
$name string
$type string
$start_date_local string
$elapsed_time integer
$description string
$distance float
리턴 array

deleteActivity() 공개 메소드

Delete an activity
public deleteActivity ( integer $id ) : array
$id integer
리턴 array

getActivity() 공개 메소드

Retrieve an activity
public getActivity ( integer $id, boolean $include_all_efforts = null ) : array
$id integer
$include_all_efforts boolean
리턴 array

getActivityComments() 공개 메소드

List activity comments
public getActivityComments ( integer $id, boolean $markdown = null, integer $page = null, integer $per_page = null ) : array
$id integer
$markdown boolean
$page integer
$per_page integer
리턴 array

getActivityKudos() 공개 메소드

List activity kudoers
public getActivityKudos ( integer $id, integer $page = null, integer $per_page = null ) : array
$id integer
$page integer
$per_page integer
리턴 array

getActivityLaps() 공개 메소드

List activity laps
public getActivityLaps ( integer $id ) : array
$id integer
리턴 array

getActivityPhotos() 공개 메소드

List activity photos
public getActivityPhotos ( integer $id, integer $size = 2048, string $photo_sources = 'true' ) : array
$id integer
$size integer In pixels.
$photo_sources string Must be "true".
리턴 array

getActivityUploadStatus() 공개 메소드

Check upload status
public getActivityUploadStatus ( integer $id ) : array
$id integer
리턴 array

getActivityZones() 공개 메소드

List activity zones
public getActivityZones ( integer $id ) : array
$id integer
리턴 array

getAthlete() 공개 메소드

Retrieve current athlete
public getAthlete ( integer $id = null ) : array
$id integer
리턴 array

getAthleteActivities() 공개 메소드

List athlete activities
public getAthleteActivities ( string $before = null, string $after = null, integer $page = null, integer $per_page = null ) : array
$before string
$after string
$page integer
$per_page integer
리턴 array

getAthleteBothFollowing() 공개 메소드

List both following
public getAthleteBothFollowing ( integer $id, integer $page = null, integer $per_page = null ) : array
$id integer
$page integer
$per_page integer
리턴 array

getAthleteClubs() 공개 메소드

List athlete clubs
public getAthleteClubs ( ) : array
리턴 array

getAthleteFollowers() 공개 메소드

List athlete followers
public getAthleteFollowers ( integer $id = null, integer $page = null, integer $per_page = null ) : array
$id integer
$page integer
$per_page integer
리턴 array

getAthleteFriends() 공개 메소드

List athlete friends
public getAthleteFriends ( integer $id = null, integer $page = null, integer $per_page = null ) : array
$id integer
$page integer
$per_page integer
리턴 array

getAthleteKom() 공개 메소드

List athlete K/QOMs/CRs
public getAthleteKom ( integer $id, integer $page = null, integer $per_page = null ) : array
$id integer
$page integer
$per_page integer
리턴 array

getAthleteStarredSegments() 공개 메소드

List starred segment
public getAthleteStarredSegments ( integer $id = null, integer $page = null, integer $per_page = null ) : array
$id integer
$page integer
$per_page integer
리턴 array

getAthleteStats() 공개 메소드

Only available for the authenticated athlete.
public getAthleteStats ( integer $id ) : array
$id integer
리턴 array

getClub() 공개 메소드

Retrieve a club
public getClub ( integer $id ) : array
$id integer
리턴 array

getClubActivities() 공개 메소드

List club activities
public getClubActivities ( integer $id, integer $page = null, integer $per_page = null ) : array
$id integer
$page integer
$per_page integer
리턴 array

getClubAnnouncements() 공개 메소드

List club announcements
public getClubAnnouncements ( integer $id ) : array
$id integer
리턴 array

getClubGroupEvents() 공개 메소드

List club group events
public getClubGroupEvents ( integer $id ) : array
$id integer
리턴 array

getClubMembers() 공개 메소드

List club members
public getClubMembers ( integer $id, integer $page = null, integer $per_page = null ) : array
$id integer
$page integer
$per_page integer
리턴 array

getGear() 공개 메소드

Retrieve gear
public getGear ( integer $id ) : array
$id integer
리턴 array

getSegment() 공개 메소드

Retrieve a segment
public getSegment ( integer $id ) : array
$id integer
리턴 array

getSegmentEffort() 공개 메소드

List efforts filtered by athlete and/or a date range
public getSegmentEffort ( integer $id, integer $athlete_id = null, string $start_date_local = null, string $end_date_local = null, integer $page = null, integer $per_page = null ) : array
$id integer
$athlete_id integer
$start_date_local string
$end_date_local string
$page integer
$per_page integer
리턴 array

getSegmentExplorer() 공개 메소드

Segment explorer
public getSegmentExplorer ( string $bounds, string $activity_type = 'riding', integer $min_cat = null, integer $max_cat = null ) : array
$bounds string
$activity_type string
$min_cat integer
$max_cat integer
리턴 array

getSegmentLeaderboard() 공개 메소드

Segment leaderboards
public getSegmentLeaderboard ( integer $id, string $gender = null, string $age_group = null, string $weight_class = null, boolean $following = null, integer $club_id = null, string $date_range = null, integer $context_entries = null, integer $page = null, integer $per_page = null ) : array
$id integer
$gender string
$age_group string
$weight_class string
$following boolean
$club_id integer
$date_range string
$context_entries integer
$page integer
$per_page integer
리턴 array

getStreamsActivity() 공개 메소드

Retrieve activity streams
public getStreamsActivity ( integer $id, string $types, string $resolution = null, string $series_type = 'distance' ) : array
$id integer
$types string
$resolution string
$series_type string
리턴 array

getStreamsEffort() 공개 메소드

Retrieve effort streams
public getStreamsEffort ( integer $id, string $types, string $resolution = null, string $series_type = 'distance' ) : array
$id integer
$types string
$resolution string
$series_type string
리턴 array

getStreamsSegment() 공개 메소드

Retrieve segment streams
public getStreamsSegment ( integer $id, string $types, string $resolution = null, string $series_type = 'distance' ) : array
$id integer
$types string
$resolution string
$series_type string
리턴 array

joinClub() 공개 메소드

Join a club
public joinClub ( integer $id ) : array
$id integer
리턴 array

leaveClub() 공개 메소드

Leave a club
public leaveClub ( integer $id ) : array
$id integer
리턴 array

updateActivity() 공개 메소드

Update an activity
public updateActivity ( integer $id, string $name = null, string $type = null, boolean $private = false, boolean $commute = false, boolean $trainer = false, string $gear_id = null, string $description = null ) : array
$id integer
$name string
$type string
$private boolean
$commute boolean
$trainer boolean
$gear_id string
$description string
리턴 array

updateAthlete() 공개 메소드

Update current athlete
public updateAthlete ( string $city, string $state, string $country, string $sex, float $weight ) : array
$city string
$state string
$country string
$sex string
$weight float
리턴 array

uploadActivity() 공개 메소드

Upload an activity
public uploadActivity ( mixed $file, string $activity_type = null, string $name = null, string $description = null, integer $private = null, integer $trainer = null, integer $commute = null, string $data_type = null, string $external_id = null ) : array
$file mixed
$activity_type string
$name string
$description string
$private integer
$trainer integer
$commute integer
$data_type string
$external_id string
리턴 array

프로퍼티 상세

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

protected ServiceInterface,Strava\API\Service $service
리턴 Strava\API\Service\ServiceInterface