PHP Interface Strava\API\Service\ServiceInterface

Just to make sure we can trust the method signatures of all the service classes.
Author: Bas van Dorst
ファイルを表示 Open project: basvandorst/stravaphp Interface Usage Examples

Public Methods

Method Description
createActivity ( string $name, string $type, string $start_date_local, integer $elapsed_time, string $description = null, double $distance = null )
deleteActivity ( integer $id )
getActivity ( integer $id, boolean $include_all_efforts = null )
getActivityComments ( integer $id, boolean $markdown = null, integer $page = null, integer $per_page = null )
getActivityKudos ( integer $id, integer $page = null, integer $per_page = null )
getActivityLaps ( integer $id )
getActivityPhotos ( integer $id, $size = 2048, $photo_sources = 'true' )
getActivityUploadStatus ( integer $id )
getActivityZones ( integer $id )
getAthlete ( integer $id = null )
getAthleteActivities ( string $before = null, string $after = null, integer $page = null, integer $per_page = null )
getAthleteBothFollowing ( integer $id, integer $page = null, integer $per_page = null )
getAthleteClubs ( )
getAthleteFollowers ( integer $id = null, integer $page = null, integer $per_page = null )
getAthleteFriends ( integer $id = null, integer $page = null, integer $per_page = null )
getAthleteKom ( integer $id, integer $page = null, integer $per_page = null )
getAthleteStarredSegments ( integer $id = null, integer $page = null, integer $per_page = null )
getAthleteStats ( integer $id ) : array Retrieve athlete stats
getClub ( integer $id )
getClubActivities ( integer $id, integer $page = null, integer $per_page = null )
getClubAnnouncements ( integer $id )
getClubGroupEvents ( integer $id )
getClubMembers ( integer $id, integer $page = null, integer $per_page = null )
getGear ( integer $id )
getSegment ( integer $id )
getSegmentEffort ( integer $id, integer $athlete_id = null, string $start_date_local = null, string $end_date_local = null, integer $page = null, integer $per_page = null )
getSegmentExplorer ( string $bounds, $activity_type = 'riding', integer $min_cat = null, integer $max_cat = null )
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, $context_entries = null, integer $page = null, integer $per_page = null )
getStreamsActivity ( integer $id, string $types, $resolution = null, $series_type = 'distance' )
getStreamsEffort ( integer $id, string $types, $resolution = null, $series_type = 'distance' )
getStreamsSegment ( integer $id, string $types, $resolution = null, $series_type = 'distance' )
joinClub ( integer $id )
leaveClub ( integer $id )
updateActivity ( integer $id, string $name = null, string $type = null, $private = false, $commute = false, $trainer = false, string $gear_id = null, string $description = null )
updateAthlete ( string $city, string $state, string $country, string $sex, double $weight )
uploadActivity ( $file, string $activity_type = null, string $name = null, string $description = null, integer $private = null, integer $trainer = null, string $data_type = null, string $external_id = null )

Method Details

createActivity() public method

public createActivity ( string $name, string $type, string $start_date_local, integer $elapsed_time, string $description = null, double $distance = null )
$name string
$type string
$start_date_local string
$elapsed_time integer
$description string
$distance double

deleteActivity() public method

public deleteActivity ( integer $id )
$id integer

getActivity() public method

public getActivity ( integer $id, boolean $include_all_efforts = null )
$id integer
$include_all_efforts boolean

getActivityComments() public method

public getActivityComments ( integer $id, boolean $markdown = null, integer $page = null, integer $per_page = null )
$id integer
$markdown boolean
$page integer
$per_page integer

getActivityKudos() public method

public getActivityKudos ( integer $id, integer $page = null, integer $per_page = null )
$id integer
$page integer
$per_page integer

getActivityLaps() public method

public getActivityLaps ( integer $id )
$id integer

getActivityPhotos() public method

public getActivityPhotos ( integer $id, $size = 2048, $photo_sources = 'true' )
$id integer

getActivityUploadStatus() public method

public getActivityUploadStatus ( integer $id )
$id integer

getActivityZones() public method

public getActivityZones ( integer $id )
$id integer

getAthlete() public method

public getAthlete ( integer $id = null )
$id integer

getAthleteActivities() public method

public getAthleteActivities ( string $before = null, string $after = null, integer $page = null, integer $per_page = null )
$before string
$after string
$page integer
$per_page integer

getAthleteBothFollowing() public method

public getAthleteBothFollowing ( integer $id, integer $page = null, integer $per_page = null )
$id integer
$page integer
$per_page integer

getAthleteClubs() public method

public getAthleteClubs ( )

getAthleteFollowers() public method

public getAthleteFollowers ( integer $id = null, integer $page = null, integer $per_page = null )
$id integer
$page integer
$per_page integer

getAthleteFriends() public method

public getAthleteFriends ( integer $id = null, integer $page = null, integer $per_page = null )
$id integer
$page integer
$per_page integer

getAthleteKom() public method

public getAthleteKom ( integer $id, integer $page = null, integer $per_page = null )
$id integer
$page integer
$per_page integer

getAthleteStarredSegments() public method

public getAthleteStarredSegments ( integer $id = null, integer $page = null, integer $per_page = null )
$id integer
$page integer
$per_page integer

getAthleteStats() public method

Only available for the authenticated athlete.
See link: http://strava.github.io/api/v3/athlete/#stats
public getAthleteStats ( integer $id ) : array
$id integer
return array

getClub() public method

public getClub ( integer $id )
$id integer

getClubActivities() public method

public getClubActivities ( integer $id, integer $page = null, integer $per_page = null )
$id integer
$page integer
$per_page integer

getClubAnnouncements() public method

public getClubAnnouncements ( integer $id )
$id integer

getClubGroupEvents() public method

public getClubGroupEvents ( integer $id )
$id integer

getClubMembers() public method

public getClubMembers ( integer $id, integer $page = null, integer $per_page = null )
$id integer
$page integer
$per_page integer

getGear() public method

public getGear ( integer $id )
$id integer

getSegment() public method

public getSegment ( integer $id )
$id integer

getSegmentEffort() public method

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 )
$id integer
$athlete_id integer
$start_date_local string
$end_date_local string
$page integer
$per_page integer

getSegmentExplorer() public method

public getSegmentExplorer ( string $bounds, $activity_type = 'riding', integer $min_cat = null, integer $max_cat = null )
$bounds string
$min_cat integer
$max_cat integer

getSegmentLeaderboard() public method

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, $context_entries = null, integer $page = null, integer $per_page = null )
$id integer
$gender string
$age_group string
$weight_class string
$following boolean
$club_id integer
$date_range string
$page integer
$per_page integer

getStreamsActivity() public method

public getStreamsActivity ( integer $id, string $types, $resolution = null, $series_type = 'distance' )
$id integer
$types string

getStreamsEffort() public method

public getStreamsEffort ( integer $id, string $types, $resolution = null, $series_type = 'distance' )
$id integer
$types string

getStreamsSegment() public method

public getStreamsSegment ( integer $id, string $types, $resolution = null, $series_type = 'distance' )
$id integer
$types string

joinClub() public method

public joinClub ( integer $id )
$id integer

leaveClub() public method

public leaveClub ( integer $id )
$id integer

updateActivity() public method

public updateActivity ( integer $id, string $name = null, string $type = null, $private = false, $commute = false, $trainer = false, string $gear_id = null, string $description = null )
$id integer
$name string
$type string
$gear_id string
$description string

updateAthlete() public method

public updateAthlete ( string $city, string $state, string $country, string $sex, double $weight )
$city string
$state string
$country string
$sex string
$weight double

uploadActivity() public method

public uploadActivity ( $file, string $activity_type = null, string $name = null, string $description = null, integer $private = null, integer $trainer = null, string $data_type = null, string $external_id = null )
$activity_type string
$name string
$description string
$private integer
$trainer integer
$data_type string
$external_id string