Heads up! To view this whole video, sign in with your Courses account or enroll in your free 7-day trial. Sign In Enroll

Using the GitHub API with PHP

Preview

Start a free Courses trial
to watch this video

Sign up for Treehouse

POST Request to Watch Repository

9:46 with Alena Holligan

To change the watch status of a repository, we'll need to PUT and DELETE our changes. Using our wrapper library, these interactions are going to work the same as the GET requests we've made so far. The only thing that changes is the method called.

isset() function: If notices are turned on and a variable is not set, you will get a notice if you try to access that variable. By using the isset function, we can check if that variable is set without causing a notice to be thrown. For more information, check out the Error Handling course.

GitHub API Documentation for Watching Repositories. Watching a Repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed. See Repository Starring for simple repository bookmarks.

HTTP Basics: Sending Data with a POST Request

Related Discussions

Have questions about this video? Start a discussion with the community and Treehouse staff.

Sign up

    Related Discussions

    Have questions about this video? Start a discussion with the community and Treehouse staff.

    Sign up

    We want to check the watch status of the authenticated user for 0:00
    each of the repositories. 0:04
    We could loop through each of the repositories and 0:06
    make an individual API request each time, but accessing external 0:08
    data sources can be time consuming, and greatly slow down our application. 0:13
    Instead, let's make a single call, and pull all the user subscriptions as one. 0:18
    Then we can check the repositories against these subscriptions. 0:24
    After getting the repositories, but still within our if statement, 0:29
    we're going to create a new response by getting the user subscription. 0:33
    /User/subscription. 0:44
    When not passing the user information to the API call, 0:52
    the API returns the authenticated user, or error, if no user is authenticated. 0:55
    We can now create our subscription collection by decoding our response. 1:01
    Next, we can loop through each of our items and 1:15
    compare them to our subscription. 1:17
    We need both the key and the item. 1:28
    We'll start by setting our subscribed variable equal to false. 1:35
    Then we'll loop through each of our subscriptions, and 1:44
    test them against our item. 1:47
    If item full_name is equal to sub full_name. 2:00
    Then we're going to set subscribed equal true. 2:14
    Then we can add the subscription status to our item. 2:26
    This is where we use the key. 2:35
    Finally, we want to return the same list after updating our watch status. 2:45
    There are many different ways to handle this. 2:51
    So check the notes associated with this video for additional suggestions. 2:53
    For right now, we'll simply pass the query string again. 2:57
    To our args, we'll add query. 3:02
    We add on our q variable, Filter_input{INPUT_GET. 3:09
    To display the watch status and links, we'll need to update the template. 3:28
    Go into templates, search.html. 3:32
    After the opening h3 tag, 3:37
    we'll add include ('subscription.html'). 3:42
    I've already created this template. 3:51
    We just need to add it here. 3:54
    Let's take a look in the browser and see what we have so far. 3:57
    We can see the watch status of each repo, and we have a link. 4:07
    But that link doesn't work yet, so let's fix that. 4:14
    Back in WorkSpaces, add a new file in your inc folder. 4:18
    We'll name this watch.php. 4:26
    All the interactions with the API, up to this point, have been getting information. 4:34
    To change the subscription, we'll need to put and delete our changes. 4:39
    With our wrapper library, these interactions 4:44
    are going to work the same way as get, except the method name changes. 4:47
    If If (isset($_GET['subcribe'])). 4:52
    $Response = $api->put(. 5:09
    Then we're going to pass '/repos/'. 5:16
    The $_GET['subcribe']. 5:27
    And '/subcription/'. 5:34
    We're also going to pass an array argument. 5:39
    We'll set 'subcribe'. 5:46
    => True. 5:52
    Our unsubscribe will be similar, so let's copy this whole section. 6:00
    We'll change subscribe to unsubscribe. 6:07
    And subscribed equals false. 6:16
    We also need to change our put to a delete. 6:19
    Now we can check our response, and 6:25
    alert the user if the status has been updated or not. 6:26
    If response. 6:40
    Then we can check for the (substr ($response->getCode(). 6:44
    If the first number of our response equals two, that means if we get 6:57
    any sort of 200 response, that means we've been successful. 7:02
    'Watch Status Updated'. 7:26
    Else, if we get any other response, 7:33
    we were unable to update the status. 7:37
    Our alert type will be danger. 7:45
    And our alert title will be 'Unable 7:57
    to Update Watch Status'. 8:03
    We'll need to pass this alert variable to our template as well. 8:13
    So, back in search.php. 8:17
    We're going to add alert. 8:28
    To our args array. 8:40
    We also need to include our watch file as a require at the top of this file. 8:43
    Let's try this out in the browser. 9:00
    If, is set response. 9:23
    Great, we were able to watch the eclipse Milo repository. 9:38
    Let's add this feature to our project repo as well. 9:42

    You need to sign up for Treehouse in order to download course files.

    Sign up

      You need to sign up for Treehouse in order to set up Workspace

      Sign up