php-github-api/lib/Github/Api/CurrentUser/Starring.php at d508be8f6ef13365e7b371e5a57718db0c824ecc · KnpLabs/php-github-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<?php

namespace Github\Api\CurrentUser;

use Github\Api\AbstractApi;
use Github\Api\AcceptHeaderTrait;

/**
 * @link   https://developer.github.com/v3/activity/starring/
 *
 * @author Felipe Valtl de Mello <eu@felipe.im>
 */
class Starring extends AbstractApi
{
    use AcceptHeaderTrait;

    /**
     * Configure the body type.
     *
     * @see https://developer.github.com/v3/activity/starring/#list-stargazers
     *
     * @param string $bodyType
     *
     * @return $this
     */
    public function configure($bodyType = null)
    {
        if ('star' === $bodyType) {
            $this->acceptHeaderValue = 'application/vnd.github.star+json';
        }

        return $this;
    }

    /**
     * List repositories starred by the authenticated user.
     *
     * @link https://developer.github.com/v3/activity/starring/
     *
     * @param int $page
     * @param int $perPage
     *
     * @return array
     */
    public function all($page = 1, $perPage = 30)
    {
        return $this->get('/user/starred', [
            'page' => $page,
            'per_page' => $perPage,
        ]);
    }

    /**
     * Check that the authenticated user starres a repository.
     *
     * @link https://developer.github.com/v3/activity/starring/
     *
     * @param string $username   the user who owns the repo
     * @param string $repository the name of the repo
     *
     * @return array
     */
    public function check($username, $repository)
    {
        return $this->get('/user/starred/'.rawurlencode($username).'/'.rawurlencode($repository));
    }

    /**
     * Make the authenticated user star a repository.
     *
     * @link https://developer.github.com/v3/activity/starring/
     *
     * @param string $username   the user who owns the repo
     * @param string $repository the name of the repo
     *
     * @return array
     */
    public function star($username, $repository)
    {
        return $this->put('/user/starred/'.rawurlencode($username).'/'.rawurlencode($repository));
    }

    /**
     * Make the authenticated user unstar a repository.
     *
     * @link https://developer.github.com/v3/activity/starring
     *
     * @param string $username   the user who owns the repo
     * @param string $repository the name of the repo
     *
     * @return array
     */
    public function unstar($username, $repository)
    {
        return $this->delete('/user/starred/'.rawurlencode($username).'/'.rawurlencode($repository));
    }
}