Commit.php in Bibliography Module 7.2

File

modules/CiteProc/Github/Api/Commit.php

<?php

/**
 * Getting information on specific commits,
 * the diffs they introduce, the files they've changed.
 *
 * @link      http://develop.github.com/p/commits.html
 * @author    Thibault Duplessis <thibault.duplessis at gmail dot com>
 * @license   MIT License
 */
class Github_Api_Commit extends Github_Api {

  /**
   * List commits by username, repo and branch
   * http://develop.github.com/p/commits.html#listing_commits_on_a_branch
   *
   * @param   string  $username         the username
   * @param   string  $repo             the repo
   * @param   string  $branch           the branch
   * @return  array                     list of users found
   */
  public function getBranchCommits($username, $repo, $branch) {
    $response = $this
      ->get('commits/list/' . urlencode($username) . '/' . urlencode($repo) . '/' . urlencode($branch));
    return $response['commits'];
  }

  /**
   * List commits by username, repo, branch and path
   * http://develop.github.com/p/commits.html#listing_commits_for_a_file
   *
   * @param   string  $username         the username
   * @param   string  $repo             the repo
   * @param   string  $branch           the branch
   * @param   string  $path             the path
   * @return  array                     list of users found
   */
  public function getFileCommits($username, $repo, $branch, $path) {
    $response = $this
      ->get('commits/list/' . urlencode($username) . '/' . urlencode($repo) . '/' . urlencode($branch) . '/' . urlencode($path));
    return $response['commits'];
  }

  /**
   * Show a specific commit
   * http://develop.github.com/p/commits.html#showing_a_specific_commit
   *
   * @param   string  $username         the username
   * @param   string  $repo             the repo
   * @param   string  $sha              the commit sha
   */
  public function getCommit($username, $repo, $sha) {
    $response = $this
      ->get('commits/show/' . urlencode($username) . '/' . urlencode($repo) . '/' . urlencode($sha));
    return $response['commit'];
  }

}

Classes

Name	Description
Github_Api_Commit	Getting information on specific commits, the diffs they introduce, the files they've changed.