PHP Class Strava\API\Service\REST

Author: Bas van Dorst
Inheritance: implements Strava\API\Service\ServiceInterface
Show file Open project: basvandorst/stravaphp

Protected Properties

Property Type Description
$adapter Pest REST adapter

Public Methods

Method Description
__construct ( string $token, Pest $adapter ) Inititate this REST servcie with the application token and a instance of the REST adapter (Pest)
createActivity ( $name, $type, $start_date_local, $elapsed_time, $description = null, $distance = null )
deleteActivity ( $id )
getActivity ( $id, $include_all_efforts = null )
getActivityComments ( $id, $markdown = null, $page = null, $per_page = null )
getActivityKudos ( $id, $page = null, $per_page = null )
getActivityLaps ( $id )
getActivityPhotos ( $id, $size = 2048, $photo_sources = 'true' )
getActivityUploadStatus ( $id )
getActivityZones ( $id )
getAthlete ( $id = null )
getAthleteActivities ( $before = null, $after = null, $page = null, $per_page = null )
getAthleteBothFollowing ( $id, $page = null, $per_page = null )
getAthleteClubs ( )
getAthleteFollowers ( $id = null, $page = null, $per_page = null )
getAthleteFriends ( $id = null, $page = null, $per_page = null )
getAthleteKom ( $id, $page = null, $per_page = null )
getAthleteStarredSegments ( $id = null, $page = null, $per_page = null )
getAthleteStats ( $id )
getClub ( $id )
getClubActivities ( $id, $page = null, $per_page = null )
getClubAnnouncements ( $id )
getClubGroupEvents ( $id )
getClubMembers ( $id, $page = null, $per_page = null )
getGear ( $id )
getSegment ( $id )
getSegmentEffort ( $id, $athlete_id = null, $start_date_local = null, $end_date_local = null, $page = null, $per_page = null )
getSegmentExplorer ( $bounds, $activity_type = 'riding', $min_cat = null, $max_cat = null )
getSegmentLeaderboard ( $id, $gender = null, $age_group = null, $weight_class = null, $following = null, $club_id = null, $date_range = null, $context_entries = null, $page = null, $per_page = null )
getStreamsActivity ( $id, $types, $resolution = null, $series_type = 'distance' )
getStreamsEffort ( $id, $types, $resolution = null, $series_type = 'distance' )
getStreamsSegment ( $id, $types, $resolution = null, $series_type = 'distance' )
joinClub ( $id )
leaveClub ( $id )
updateActivity ( $id, $name = null, $type = null, $private = false, $commute = false, $trainer = false, $gear_id = null, $description = null )
updateAthlete ( $city, $state, $country, $sex, $weight )
uploadActivity ( $file, $activity_type = null, $name = null, $description = null, $private = null, $trainer = null, $commute = null, $data_type = null, $external_id = null )

Private Methods

Method Description
format ( string $result ) Convert the JSON output to an array
getHeaders ( )

Method Details

__construct() public method

Inititate this REST servcie with the application token and a instance of the REST adapter (Pest)
public __construct ( string $token, Pest $adapter )
$token string
$adapter Pest

createActivity() public method

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

deleteActivity() public method

public deleteActivity ( $id )

getActivity() public method

public getActivity ( $id, $include_all_efforts = null )

getActivityComments() public method

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

getActivityKudos() public method

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

getActivityLaps() public method

public getActivityLaps ( $id )

getActivityPhotos() public method

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

getActivityUploadStatus() public method

public getActivityUploadStatus ( $id )

getActivityZones() public method

public getActivityZones ( $id )

getAthlete() public method

public getAthlete ( $id = null )

getAthleteActivities() public method

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

getAthleteBothFollowing() public method

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

getAthleteClubs() public method

public getAthleteClubs ( )

getAthleteFollowers() public method

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

getAthleteFriends() public method

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

getAthleteKom() public method

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

getAthleteStarredSegments() public method

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

getAthleteStats() public method

public getAthleteStats ( $id )

getClub() public method

public getClub ( $id )

getClubActivities() public method

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

getClubAnnouncements() public method

public getClubAnnouncements ( $id )

getClubGroupEvents() public method

public getClubGroupEvents ( $id )

getClubMembers() public method

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

getGear() public method

public getGear ( $id )

getSegment() public method

public getSegment ( $id )

getSegmentEffort() public method

public getSegmentEffort ( $id, $athlete_id = null, $start_date_local = null, $end_date_local = null, $page = null, $per_page = null )

getSegmentExplorer() public method

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

getSegmentLeaderboard() public method

public getSegmentLeaderboard ( $id, $gender = null, $age_group = null, $weight_class = null, $following = null, $club_id = null, $date_range = null, $context_entries = null, $page = null, $per_page = null )

getStreamsActivity() public method

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

getStreamsEffort() public method

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

getStreamsSegment() public method

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

joinClub() public method

public joinClub ( $id )

leaveClub() public method

public leaveClub ( $id )

updateActivity() public method

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

updateAthlete() public method

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

uploadActivity() public method

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

Property Details

$adapter protected property

REST adapter
protected Pest $adapter
return Pest