2013-01-30 11:38:30 -08:00

111 lines
3.2 KiB
PHP
Executable File

<?php
namespace Github\Api;
/**
* Searching users, getting user information
*
* @link http://developer.github.com/v3/users/
* @author Joseph Bielawski <stloyd@gmail.com>
* @author Thibault Duplessis <thibault.duplessis at gmail dot com>
*/
class User extends AbstractApi
{
/**
* Search users by username:
* @link http://developer.github.com/v3/search/#search-users
*
* @param string $keyword the keyword to search
*
* @return array list of users found
*/
public function find($keyword)
{
return $this->get('legacy/user/search/'.urlencode($keyword));
}
/**
* Get extended information about a user by its username
* @link http://developer.github.com/v3/users/
*
* @param string $username the username to show
* @return array informations about the user
*/
public function show($username)
{
return $this->get('users/'.urlencode($username));
}
/**
* Request the users that a specific user is following
* @link http://developer.github.com/v3/users/followers/
*
* @param string $username the username
* @return array list of followed users
*/
public function following($username)
{
return $this->get('users/'.urlencode($username).'/following');
}
/**
* Request the users following a specific user
* @link http://developer.github.com/v3/users/followers/
*
* @param string $username the username
* @return array list of following users
*/
public function followers($username)
{
return $this->get('users/'.urlencode($username).'/followers');
}
/**
* Request the repository that a specific user is watching
* @link http://developer.github.com/v3/repos/watching/
*
* @param string $username the username
* @return array list of watched repositories
*/
public function watched($username)
{
return $this->get('users/'.urlencode($username).'/watched');
}
/**
* Get the repositories of a user
* @link http://developer.github.com/v3/repos/
*
* @param string $username the username
* @return array list of the user repositories
*/
public function repositories($username)
{
return $this->get('users/'.urlencode($username).'/repos');
}
/**
* Get the public gists for a user
* @link http://developer.github.com/v3/gists/
*
* @param string $username the username
* @return array list of the user gists
*/
public function gists($username)
{
return $this->get('users/'.urlencode($username).'/gists');
}
/**
* Get the public keys for a user
* @link http://developer.github.com/v3/users/keys/#list-public-keys-for-a-user
*
* @param string $username the username
* @return array list of the user public keys
*/
public function keys($username)
{
return $this->get('users/'.urlencode($username).'/keys');
}
}