1. class
  2. PCIT
  3. \
  4. GitHub
  5. \
  6. Service
  7. \
  8. Activity
  9. \
  10. StarringClient

StarringClient

class StarringClient

Traits

CICommon

Properties

protected $curl from CICommon
protected $api_url from CICommon

Methods

__construct(Curl $curl, string $api_url)

CICommon constructor.

from CICommon
mixed
list(string $repo_full_name)

List Stargazers.

mixed
listRepositoriesBeingStarred(string $username = null, string $sort = 'created', string $direction = 'desc')

List repositories being starred.

bool
checkStarringRepository(string $repo_full_name)

Check if you are starring a repository.

void
star(string $repo_full_name)

Star a repository.

void
unstar(string $repo_full_name)

Unstar a repository.

Details

in CICommon at line 18
__construct(Curl $curl, string $api_url)

CICommon constructor.

Parameters

Curl $curl
string $api_url

at line 20
mixed list(string $repo_full_name)

List Stargazers.

Parameters

string $repo_full_name

Return Value

mixed

Exceptions

Exception

at line 35
mixed listRepositoriesBeingStarred(string $username = null, string $sort = 'created', string $direction = 'desc')

List repositories being starred.

Parameters

string $username
string $sort
string $direction

Return Value

mixed

Exceptions

Exception

at line 58
bool checkStarringRepository(string $repo_full_name)

Check if you are starring a repository.

204 404

Parameters

string $repo_full_name

Return Value

bool

Exceptions

Exception

at line 82
void star(string $repo_full_name)

Star a repository.

204

Parameters

string $repo_full_name

Return Value

void

Exceptions

Exception

at line 94
void unstar(string $repo_full_name)

Unstar a repository.

204

Parameters

string $repo_full_name

Return Value

void

Exceptions

Exception