PHP Class GitHubClientBase, github-php-client

Mostra file Open project: tan-tan-kanarek/github-php-client

Protected Properties

Property Type Description
$authType
$debug
$lastData
$lastExpectedHttpCode
$lastMethod
$lastPage
$lastReturnIsArray
$lastReturnType
$lastUrl
$oauthKey
$page
$pageData
$pageSize
$password
$rateLimit
$rateLimitRemaining
$rateLimitReset
$timeout
$uploadUrl
$url
$username

Public Methods

Method Description
getFile ( $user, $repo, $branch, $file )
getFirstPage ( )
getLastPage ( )
getNextPage ( )
getPage ( )
getPreviousPage ( )
getRateLimit ( )
getRateLimitRemaining ( )
getRateLimitReset ( )
hasNextPage ( )
parseResponse ( $url, $response, $returnType, $expectedHttpCode, $isArray = false )
request ( $url, $method, $data, $expectedHttpCode, $returnType, $isArray = false )
setAuthType ( $type )
setCredentials ( $username, $password )
setDebug ( $debug )
setOauthKey ( $key )
setOauthToken ( $token )
setPage ( $page = 1 )
setPageSize ( $pageSize )
setTimeout ( $timeout )
upload ( $url, $data, $expectedHttpCode, $returnType, $contentType, $filePath )

Protected Methods

Method Description
doRequest ( string $url, string $method, array $data, $contentType = null, $filePath = null ) : array do a github request and return array
requestLast ( array $data )
resetPage ( )

Method Details

doRequest() protected method

do a github request and return array
protected doRequest ( string $url, string $method, array $data, $contentType = null, $filePath = null ) : array
$url string
$method string GET POST PUT DELETE etc...
$data array
return array

getFile() public method

public getFile ( $user, $repo, $branch, $file )

getFirstPage() public method

public getFirstPage ( )

getLastPage() public method

public getLastPage ( )

getNextPage() public method

public getNextPage ( )

getPage() public method

public getPage ( )

getPreviousPage() public method

public getPreviousPage ( )

getRateLimit() public method

public getRateLimit ( )

getRateLimitRemaining() public method

getRateLimitReset() public method

public getRateLimitReset ( )

hasNextPage() public method

public hasNextPage ( )

parseResponse() public method

public parseResponse ( $url, $response, $returnType, $expectedHttpCode, $isArray = false )

request() public method

public request ( $url, $method, $data, $expectedHttpCode, $returnType, $isArray = false )

requestLast() protected method

protected requestLast ( array $data )
$data array

resetPage() protected method

protected resetPage ( )

setAuthType() public method

public setAuthType ( $type )

setCredentials() public method

public setCredentials ( $username, $password )

setDebug() public method

public setDebug ( $debug )

setOauthKey() public method

public setOauthKey ( $key )

setOauthToken() public method

public setOauthToken ( $token )

setPage() public method

public setPage ( $page = 1 )

setPageSize() public method

public setPageSize ( $pageSize )

setTimeout() public method

public setTimeout ( $timeout )

upload() public method

public upload ( $url, $data, $expectedHttpCode, $returnType, $contentType, $filePath )

Property Details

$authType protected_oe property

protected $authType

$debug protected_oe property

protected $debug

$lastData protected_oe property

protected $lastData

$lastExpectedHttpCode protected_oe property

protected $lastExpectedHttpCode

$lastMethod protected_oe property

protected $lastMethod

$lastPage protected_oe property

protected $lastPage

$lastReturnIsArray protected_oe property

protected $lastReturnIsArray

$lastReturnType protected_oe property

protected $lastReturnType

$lastUrl protected_oe property

protected $lastUrl

$oauthKey protected_oe property

protected $oauthKey

$page protected_oe property

protected $page

$pageData protected_oe property

protected $pageData

$pageSize protected_oe property

protected $pageSize

$password protected_oe property

protected $password

$rateLimit protected_oe property

protected $rateLimit

$rateLimitRemaining protected_oe property

protected $rateLimitRemaining

$rateLimitReset protected_oe property

protected $rateLimitReset

$timeout protected_oe property

protected $timeout

$uploadUrl protected_oe property

protected $uploadUrl

$url protected_oe property

protected $url

$username protected_oe property

protected $username