PHP Класс Strava\API\Client

Автор: Bas van Dorst
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$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