Abstract class for Api classes
+| author | +Thibault Duplessis <thibault.duplessis at gmail dot com> | +
|---|---|
| author | +Joseph Bielawski | +
__construct(Github\Client $client)+ +
\Client
+delete($path, array $parameters, $requestOptions)+ +
get($path, array $parameters, $requestOptions)+ +
patch($path, array $parameters, $requestOptions)+ +
post($path, array $parameters, $requestOptions)+ +
put($path, array $parameters, $requestOptions)+ +
$client : \Client+ +
Api interface
+| author | +Joseph Bielawski | +
|---|
Getting information on specific commits, +the diffs they introduce, the files they've changed.
+| link | +http://developer.github.com/v3/repos/commits/ | +
|---|---|
| author | +Thibault Duplessis <thibault.duplessis at gmail dot com> | +
| author | +Joseph Bielawski | +
getBranchCommits(string $username, string $repo, string $branch) : array+ +
| link | +http://developer.github.com/v3/repos/commits/ | +
|---|
stringthe username
stringthe repo
stringthe branch
arraylist of users foundgetCommit(string $username, string $repo, string $sha) : array+ +
| link | +http://developer.github.com/v3/repos/commits/#get-a-single-commit | +
|---|
stringthe username
stringthe repo
stringthe commit sha
arraydata from commitgetFileCommits(string $username, string $repo, string $branch, string $path) : array+ +
| link | +http://developer.github.com/v3/repos/commits/ | +
|---|
stringthe username
stringthe repo
stringthe branch
stringthe path
arraylist of users foundgetBranchSha(string $username, string $repoName, string $branchName) : null | string+ +
| link | +http://developer.github.com/v3/git/refs/#get-a-reference | +
|---|
string
+string
+string
+nullstring
+create()
getGist()
getList()
getListByUser()
getPublicList()
getStarredList()
remove()
update()
Creating, editing, deleting and listing gists
+| link | +http://developer.github.com/v3/gists/ | +
|---|---|
| author | +Edoardo Rivello <edoardo.rivello at gmail dot com> | +
| license | +MIT License | +
create(array $files, bool $public, string $description) : array+ +
| link | +http://developer.github.com/v3/gists/ | +
|---|
arrayfiles that make up this gist
bool1 for public, 0 for private
stringoptional gist description
arrayreturns gist datagetGist(string $id) : array+ +
| link | +http://developer.github.com/v3/gists/ | +
|---|
stringthe gist id
arraydata from gistgetList() : array+ +
getListByUser(string $username) : array+ +
| link | +http://developer.github.com/v3/gists/ | +
|---|
stringthe username
arraylist of gist foundgetPublicList() : array+ +
getStarredList() : array+ +
remove(int $id) : \Response+ +
| link | +http://developer.github.com/v3/gists/ | +
|---|
intthe gist id
\Responseupdate(string $id, array $files, string $description) : array+ +
| link | +http://developer.github.com/v3/gists/ | +
|---|
stringthe gist id
arrayfiles that make up this gist
stringoptional gist description
arrayinformations about the gistaddComment()
addLabel()
close()
getComment()
getComments()
getLabel()
getLabels()
getList()
open()
reOpen()
removeLabel()
search()
searchLabel()
show()
update()
Listing issues, searching, editing and closing your projects issues.
+| link | +http://develop.github.com/p/issues.html | +
|---|---|
| author | +Thibault Duplessis <thibault.duplessis at gmail dot com> | +
| license | +MIT License | +
addComment(string $username, string $repo, string $number, string $body) : array+ +
| link | +http://developer.github.com/v3/issues/comments/ | +
|---|
stringthe username
stringthe repo
stringthe issue number
stringthe comment body
arraythe created commentaddLabel(string $username, string $repo, string $labelName, string $labelColor) : array+ +
| link | +http://developer.github.com/v3/issues/labels/ | +
|---|
stringthe username
stringthe repo
stringthe label name
stringthe label color
arraylist of issue labelsclose(string $username, string $repo, string $number) : array+ +
| link | +http://developer.github.com/v3/issues/ | +
|---|
stringthe username
stringthe repo
stringthe issue number
arrayinformation about the issuegetComment(string $username, string $repo, string $id) : array+ +
| link | +http://developer.github.com/v3/issues/comments/ | +
|---|
stringthe username
stringthe repo
stringthe comment id
arraylist of issue commentsgetComments(string $username, string $repo, string $number) : array+ +
| link | +http://developer.github.com/v3/issues/comments/ | +
|---|
stringthe username
stringthe repo
stringthe issue number
arraylist of issue commentsgetLabel(string $username, string $repo, string $name) : array+ +
| link | +http://developer.github.com/v3/issues/labels/ | +
|---|
stringthe username
stringthe repo
stringthe label name
arraylist of project labelsgetLabels(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/issues/labels/ | +
|---|
stringthe username
stringthe repo
arraylist of project labelsgetList(string $username, string $repo, string $state, array $parameters) : array+ +
| link | +http://developer.github.com/v3/issues/ | +
|---|
stringthe username
stringthe repo
stringthe issue state, can be open or closed
arraythe additional parameters like milestone, assignee, lables, sort, direction
arraylist of issues foundopen(string $username, string $repo, string $title, string $body) : array+ +
The issue is assigned to the authenticated user. Requires authentication.
+| link | +http://developer.github.com/v3/issues/ | +
|---|
stringthe username
stringthe repo
stringthe new issue title
stringthe new issue body
arrayinformation about the issuereOpen(string $username, string $repo, string $number) : array+ +
| link | +http://developer.github.com/v3/issues/ | +
|---|
stringthe username
stringthe repo
stringthe issue number
arrayinformations about the issueremoveLabel(string $username, string $repo, string $labelName) : array+ +
| link | +http://developer.github.com/v3/issues/labels/ | +
|---|
stringthe username
stringthe repo
stringthe label name
arraylist of issue labelssearch(string $username, string $repo, string $state, string $keyword) : array+ +
| link | +http://developer.github.com/v3/search/#search-issues | +
|---|
stringthe username
stringthe repo
stringthe issue state, can be open or closed
stringthe keyword to filter issues by
arraylist of issues foundsearchLabel(string $username, string $repo, string $label) : array+ +
stringthe username
stringthe repo
stringthe label to filter issues by
arraylist of issues foundshow(string $username, string $repo, string $number) : array+ +
| link | +http://developer.github.com/v3/issues/ | +
|---|
stringthe username
stringthe repo
stringthe issue number
arrayinformation about the issueupdate(string $username, string $repo, string $number, array $data) : array+ +
| link | +http://developer.github.com/v3/issues/ | +
|---|
stringthe username
stringthe repo
stringthe issue number
arraykey=>value user attributes to update. key can be title or body
+arrayinformation about the issueMarkdown Rendering API
+| link | +http://developer.github.com/v3/markdown/ | +
|---|---|
| author | +Joseph Bielawski | +
render(string $text, string $mode, string $context) : string+ +
string
+string
+string
+stringrenderRaw(string $file) : string+ +
string
+stringgetRawData()
listBlobs()
showBlob()
showTree()
Getting full versions of specific files and trees in your Git repositories.
+| link | +http://develop.github.com/p/object.html | +
|---|---|
| author | +Thibault Duplessis <thibault.duplessis at gmail dot com> | +
| license | +MIT License | +
getRawData(string $username, string $repo, string $objectSHA) : string+ +
stringthe username
stringthe repo
stringthe object sha can be either a blob SHA1, a tree SHA1 or a commit SHA1
stringraw text content of the blob, tree or commit objectlistBlobs(string $username, string $repo, string $treeSHA) : array+ +
stringthe username
stringthe repo
stringthe tree sha
arraydata blobs of treeshowBlob(string $username, string $repo, string $treeSHA, string $path) : array+ +
stringthe username
stringthe repo
stringthe tree sha
stringthe path
arraydata blob of tree and pathshowTree(string $username, string $repo, string $treeSHA, $recursive) : array+ +
stringthe username
stringthe repo
stringthe tree sha
arrayroot tree of the projectaddTeam()
getAllRepos()
getPublicMember()
getPublicMembers()
getPublicRepos()
getTeam()
getTeams()
show()
ADMIN
PULL
PUSH
Searching organizations, getting organization information +and managing authenticated organization account information.
+| link | +http://develop.github.com/p/orgs.html | +
|---|---|
| author | +Antoine Berranger <antoine at ihqs dot net> | +
| license | +MIT License | +
addTeam(string $organization, string $team, string $permission, array $repositories) : array+ +
| link | +http://developer.github.com/v3/orgs/teams/#create-team | +
|---|
stringthe organization name
stringname of the new team
stringits permission [PULL|PUSH|ADMIN]
+array(optional) its repositories names
+\InvalidArgumentException |
++ |
|---|
arraythe teamsgetAllRepos(string $name, string $type) : array+ +
| link | +http://developer.github.com/v3/repos/#list-organization-repositories | +
|---|
stringthe user name
stringthe type of repositories
arraythe repositoriesgetPublicMember(string $name, string $user) : array+ +
| link | +http://developer.github.com/v3/orgs/members/#get-member | +
|---|
stringthe organization name
stringthe user
arraythe membersgetPublicMembers(string $name) : array+ +
| link | +http://developer.github.com/v3/orgs/members/#list-members | +
|---|
stringthe organization name
arraythe membersgetPublicRepos(string $name) : array+ +
| link | +http://developer.github.com/v3/repos/#list-organization-repositories | +
|---|
stringthe organization name
arraythe repositoriesgetTeam(string $name, string $id) : array+ +
| link | +http://developer.github.com/v3/orgs/teams/#get-team | +
|---|
stringthe organization name
stringid of team
arraythe teamgetTeams(string $name) : array+ +
| link | +http://developer.github.com/v3/orgs/teams/#list-teams | +
|---|
stringthe organization name
arraythe teamsshow(string $name) : array+ +
stringthe organization to show
arrayinformations about the organizationADMIN+ +
PULL+ +
PUSH+ +
API for accessing Pull Requests from your Git/Github repositories.
+| link | +http://develop.github.com/p/pulls.html | +
|---|---|
| author | +Nicolas Pastorino <nicolas.pastorino at gmail dot com> | +
| license | +MIT License | +
create(string $username, string $repo, string $base, string $head, string $title, string $body, string $issueNumber) : array+ +
| link | +http://developer.github.com/v3/pulls/ | +
|---|
stringthe username
stringthe repo
stringA String of the branch or commit SHA that you want your changes to be pulled to.
stringA String of the branch or commit SHA of your changes. Typically this will be a branch. If the branch is in a fork of the original repository, specify the username first: "my-user:some-branch".
+stringThe String title of the Pull Request. Used in pair with $body.
+stringThe String body of the Pull Request. Used in pair with $title.
+stringThe issue number. Used when title and body is not set.
arrayarray of pull requests for the projectlistPullRequests(string $username, string $repo, string $state) : array+ +
| link | +http://developer.github.com/v3/pulls/ | +
|---|
stringthe username
stringthe repo
stringthe state of the fetched pull requests. The API seems to automatically default to 'open'
+arrayarray of pull requests for the projectshow(string $username, string $repo, string $id) : array+ +
| link | +http://developer.github.com/v3/pulls/ | +
|---|
stringthe username
stringthe repo
stringthe ID of the pull request for which details are retrieved
arrayarray of pull requests for the projectaddDeployKey()
addRepoCollaborator()
addRepoHook()
create()
deleteRepoDownload()
deleteRepoHook()
fork()
getDeployKeys()
getPushableRepos()
getRepoBranches()
getRepoCollaborator()
getRepoCollaborators()
getRepoContents()
getRepoContributors()
getRepoDownloads()
getRepoHook()
getRepoHooks()
getRepoLanguages()
getRepoNetwork()
getRepoTags()
getRepoTeams()
getRepoWatchers()
getUserRepos()
removeDeployKey()
removeRepoCollaborator()
search()
setPrivate()
setPublic()
setRepoInfo()
show()
testRepoHook()
unwatch()
updateRepoHook()
watch()
Searching repositories, getting repository information +and managing repository information for authenticated users.
+| link | +http://develop.github.com/p/repos.html | +
|---|---|
| author | +Thibault Duplessis <thibault.duplessis at gmail dot com> | +
| license | +MIT License | +
addDeployKey(string $username, string $repo, string $title, string $key) : array+ +
| link | +http://developer.github.com/v3/repos/keys/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
stringthe title of the key
stringthe public key data
arraythe list of deploy keysaddRepoCollaborator(string $username, string $repo, string $user) : array+ +
| link | +http://developer.github.com/v3/repos/collaborators/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
stringthe user who should be added as a collaborator
arraylist of the repo collaboratorsaddRepoHook(string $username, string $repo, string $name, array $config, array $events, boolean $active) : array+ +
| link | +http://developer.github.com/v3/repos/hooks/#edit-a-hook | +
|---|
stringthe username
stringthe repo
stringthe name of the service that is being called. @see https://api.github.com/hooks for the possible names.
+arrayan array containing key/value pairs to provide settings for this hook
+arrayDetermines what events the hook is triggered for. Default: ["push"].
+booleanDetermines whether the hook is actually triggered on pushes.
arrayinformation about the issuecreate(string $name, string $description, string $homepage, bool $public) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringname of the repository
stringrepo description
stringhomepage url
bool1 for public, 0 for private
arrayreturns repo datadeleteRepoDownload(string $username, string $repo, integer $id) : array+ +
| link | +http://developer.github.com/v3/repos/downloads/#delete-a-download | +
|---|
stringthe user who owns the repo
stringthe name of the repo
integerthe id of the download file
arraydeleteRepoHook(string $username, string $repo, integer $id) : array+ +
| link | +http://developer.github.com/v3/repos/hooks/#delete-a-hook | +
|---|
stringthe user who owns the repo
stringthe name of the repo
integerthe id of the hook
arrayfork(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/forks/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arrayinformations about the newly forked repogetDeployKeys(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/keys/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arraythe list of deploy keysgetPushableRepos() : array+ +
arraylist of repositoriesgetRepoBranches(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringthe username
stringthe name of the repo
arraylist of the repo branchesgetRepoCollaborator(string $username, string $repo, string $user) : array+ +
| link | +http://developer.github.com/v3/repos/collaborators/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
stringthe user which we seek
arraylist of the repo collaboratorsgetRepoCollaborators(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/collaborators/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arraylist of the repo collaboratorsgetRepoContents(string $username, string $repo, string $path) : array+ +
| link | +http://developer.github.com/v3/repos/contents/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
stringpath to file or directory
arrayinformation for file | information for each item in directorygetRepoContributors(string $username, string $repo, boolean $includingAnonymous) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
booleanby default, the list only shows GitHub users. You can include non-users too by setting this to true
+arraylist of the repo contributorsgetRepoDownloads(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arraygetRepoHook(string $username, string $repo, integer $id) : array+ +
| link | +http://developer.github.com/v3/repos/hooks/#get-single-hook | +
|---|
stringthe user who owns the repo
stringthe name of the repo
integerthe id of the hook
arraygetRepoHooks(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/hooks/#list | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arraygetRepoLanguages(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arraylist of the languagesgetRepoNetwork(string $username, string $repo) : array+ +
stringthe user who owns the repo
stringthe name of the repo
arraylist of the repo forksgetRepoTags(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arraylist of the repo tagsgetRepoTeams(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arraylist of the languagesgetRepoWatchers(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/watching/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arraylist of the repo watchersgetUserRepos(string $username) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringthe username
arraylist of the user reposremoveDeployKey(string $username, string $repo, string $id) : array+ +
| link | +http://developer.github.com/v3/repos/keys/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
stringthe the id of the key to remove
arraythe list of deploy keysremoveRepoCollaborator(string $repo, string $username, string $user) : array+ +
| link | +http://developer.github.com/v3/repos/collaborators/ | +
|---|
stringthe name of the repo
stringthe user who owns the repo
stringthe user who should be removed as a collaborator
arraylist of the repo collaboratorssearch(string $keyword, string $language, integer $startPage) : array+ +
| link | +http://developer.github.com/v3/search/#search-repositories | +
|---|
stringthe search query
stringtakes the same values as the language drop down on http://github.com/search
+integerthe page number
arraylist of founded repositoriessetPrivate(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arrayinformations about the reposetPublic(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arrayinformations about the reposetRepoInfo(string $username, string $repo, array $values) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arraythe key => value pairs to post
+arrayinformations about the reposhow(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arrayinformations about the repotestRepoHook(string $username, string $repo, integer $id) : array+ +
| link | +http://developer.github.com/v3/repos/hooks/#test-a-hook | +
|---|
stringthe user who owns the repo
stringthe name of the repo
integerthe id of the hook
arrayunwatch(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/watching/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arrayinformations about the repoupdateRepoHook(string $username, string $repo, string $id, array $data) : array+ +
| link | +http://developer.github.com/v3/repos/hooks/#edit-a-hook | +
|---|
stringthe username
stringthe repo
stringthe hook id
arraykey=>value user attributes to update.
+arrayinformation about the issuewatch(string $username, string $repo) : array+ +
| link | +http://developer.github.com/v3/repos/watching/ | +
|---|
stringthe user who owns the repo
stringthe name of the repo
arrayinformations about the repoaddEmail()
addKey()
follow()
getEmails()
getFollowers()
getFollowing()
getKeys()
getWatchedRepos()
removeEmail()
removeKey()
search()
show()
unFollow()
update()
Searching users, getting user information +and managing authenticated user account information.
+| link | +http://develop.github.com/p/users.html | +
|---|---|
| author | +Thibault Duplessis <thibault.duplessis at gmail dot com> | +
| license | +MIT License | +
addEmail($email) : array+ +
arraylist of authenticated user emailsaddKey($title, $key) : array+ +
arraylist of public keys of the userfollow(string $username) : array+ +
http://developer.github.com/v3/users/followers/
+stringthe username to follow
arraylist of followed usersgetEmails() : array+ +
arraylist of authenticated user emailsgetFollowers(string $username) : array+ +
stringthe username
arraylist of following usersgetFollowing(string $username) : array+ +
stringthe username
arraylist of followed usersgetKeys() : array+ +
arraylist of public keys of the usergetWatchedRepos(string $username) : array+ +
stringthe username
arraylist of watched reposremoveEmail($email) : array+ +
arraylist of authenticated user emailsremoveKey($id) : array+ +
arraylist of public keys of the usersearch(string $keyword) : array+ +
| link | +http://developer.github.com/v3/search/#search-users | +
|---|
stringthe keyword to search
arraylist of users foundshow(string $username) : array+ +
stringthe username to show
arrayinformations about the userunFollow(string $username) : array+ +
http://developer.github.com/v3/users/followers/
+stringthe username to unfollow
arraylist of followed usersupdate(array $data) : array+ +
http://developer.github.com/v3/users/
+arraykey=>value user attributes to update. key can be name, email, blog, company or location
+arrayinformations about the user__construct()
authenticate()
clearHeaders()
deAuthenticate()
delete()
get()
getApi()
getCommitApi()
getGistApi()
getHttpClient()
getIssueApi()
getMarkdownApi()
getObjectApi()
getOrganizationApi()
getPullRequestApi()
getRateLimit()
getRepoApi()
getUserApi()
patch()
post()
put()
setApi()
setHeaders()
setHttpClient()
$apis
$httpClient
$headers
AUTH_HTTP_PASSWORD
AUTH_HTTP_TOKEN
AUTH_URL_TOKEN
Simple yet very cool PHP Github client
+| author | +Thibault Duplessis <thibault.duplessis at gmail dot com> | +
|---|---|
| author | +Joseph Bielawski <stloyd@gmail.com> +Website: http://github.com/KnpLabs/php-github-api | +
__construct(Github\HttpClient\HttpClientInterface $httpClient)+ +
\HttpClientInterfacecustom http client
authenticate(string $login, string $secret, null | string $method)+ +
stringGitHub username
stringGitHub private token or Github password if $method == AUTH_HTTP_PASSWORD
+nullstringOne of the AUTH_* class constants
+clearHeaders()+ +
deAuthenticate()+ +
delete(string $path, array $parameters, array $requestOptions) : array+ +
stringthe GitHub path
arrayDELETE parameters
arrayreconfigure the request
arraydata returnedget(string $path, array $parameters, array $requestOptions) : array+ +
stringthe GitHub path
arrayGET parameters
arrayreconfigure the request
arraydata returnedgetApi(string $name) : \ApiInterface+ +
stringthe API name
\ApiInterfacethe API instancegetCommitApi() : \Api\Commit+ +
\Api\Committhe commit APIgetGistApi() : \Api\Gist+ +
\Api\Gistthe gist APIgetHttpClient() : \HttpClientInterface+ +
\HttpClientInterfacea request instancegetIssueApi() : \Api\Issue+ +
\Api\Issuethe issue APIgetMarkdownApi() : \Api\Markdown+ +
\Api\Markdownthe markdown APIgetObjectApi() : \Api\Object+ +
\Api\Objectthe object APIgetOrganizationApi() : \Api\Organization+ +
\Api\Organizationthe object APIgetPullRequestApi() : \Api\PullRequest+ +
\Api\PullRequestthe pull request APIgetRateLimit() : mixed+ +
mixedgetRepoApi() : \Api\Repo+ +
\Api\Repothe repo APIgetUserApi() : \Api\User+ +
\Api\Userthe user APIpatch(string $path, array $parameters, array $requestOptions) : array+ +
stringthe GitHub path
arrayPatch parameters
arrayreconfigure the request
arraydata returnedpost(string $path, array $parameters, array $requestOptions) : array+ +
stringthe GitHub path
arrayPOST parameters
arrayreconfigure the request
arraydata returnedput(string $path, array $requestOptions) : array+ +
stringthe GitHub path
arrayreconfigure the request
arraydata returnedsetApi(string $name, Github\Api\ApiInterface $instance) : \Client+ +
stringthe API name
\ClientsetHeaders(array $headers)+ +
array
+setHttpClient(Github\HttpClient\HttpClientInterface $httpClient)+ +
\HttpClientInterfaceThe httpClient instance
$apis : array+ +
$httpClient : \HttpClientInterface+ +
$headers : array+ +
AUTH_HTTP_PASSWORD+ +
AUTH_HTTP_TOKEN+ +
AUTH_URL_TOKEN+ +
ApiLimitExceedException
+| author | +Joseph Bielawski | +
|---|
__construct($limit)+ +
__toString()+ +
| inherited_from | +Exception::__toString() | +
|---|
getCode()+ +
| inherited_from | +Exception::getCode() | +
|---|
getFile()+ +
| inherited_from | +Exception::getFile() | +
|---|
getLine()+ +
| inherited_from | +Exception::getLine() | +
|---|
getMessage()+ +
| inherited_from | +Exception::getMessage() | +
|---|
getPrevious()+ +
| inherited_from | +Exception::getPrevious() | +
|---|
getTrace()+ +
| inherited_from | +Exception::getTrace() | +
|---|
getTraceAsString()+ +
| inherited_from | +Exception::getTraceAsString() | +
|---|
InvalidArgumentException
+| author | +Joseph Bielawski | +
|---|
__construct()+ +
| inherited_from | +Exception::__construct() | +
|---|
__toString()+ +
| inherited_from | +Exception::__toString() | +
|---|
getCode()+ +
| inherited_from | +Exception::getCode() | +
|---|
getFile()+ +
| inherited_from | +Exception::getFile() | +
|---|
getLine()+ +
| inherited_from | +Exception::getLine() | +
|---|
getMessage()+ +
| inherited_from | +Exception::getMessage() | +
|---|
getPrevious()+ +
| inherited_from | +Exception::getPrevious() | +
|---|
getTrace()+ +
| inherited_from | +Exception::getTrace() | +
|---|
getTraceAsString()+ +
| inherited_from | +Exception::getTraceAsString() | +
|---|
__construct()
delete()
get()
patch()
post()
put()
request()
setHeaders()
setOption()
checkApiLimit()
decodeResponse()
doRequest()
$remainingCalls
$browser
$headers
$history
$options
Performs requests on GitHub API. API documentation should be self-explanatory.
+| author | +Thibault Duplessis <thibault.duplessis at gmail dot com> | +
|---|---|
| author | +Joseph Bielawski | +
__construct(array $options, Buzz\Browser $browser)+ +
arrayHttp client options
null\BrowserBuzz client
delete($path, array $parameters, array $options)+ +
get($path, array $parameters, array $options)+ +
patch($path, array $parameters, array $options)+ +
post($path, array $parameters, array $options)+ +
put($path, array $options)+ +
request(string $path, array $parameters, string $httpMethod, array $options) : array+ +
stringRequest API path
arrayParameters
stringHTTP method to use
arrayRequest options
arrayDatasetHeaders(array $headers)+ +
setOption($name, $value)+ +
checkApiLimit(Buzz\Message\MessageInterface $response)+ +
decodeResponse($response)+ +
doRequest(string $url, array $parameters, string $httpMethod, array $options) : array+ +
stringRequest url
arrayParameters
stringHTTP method to use
arrayRequest options
arrayHTTP response$remainingCalls : integer+ +
$browser : \Browser+ +
$headers : array+ +
$history : array+ +
Performs requests on GitHub API. API documentation should be self-explanatory.
+| author | +Thibault Duplessis <thibault.duplessis at gmail dot com> | +
|---|---|
| author | +Joseph Bielawski | +
delete(string $path, array $parameters, array $options) : array+ +
stringRequest path
arrayDELETE Parameters
arrayReconfigure the request for this call only
arrayDataget(string $path, array $parameters, array $options) : array+ +
stringRequest path
arrayGET Parameters
arrayReconfigure the request for this call only
arrayDatapatch(string $path, array $parameters, array $options) : array+ +
stringRequest path
arrayPATCH Parameters
arrayReconfigure the request for this call only
arrayDatapost(string $path, array $parameters, array $options) : array+ +
stringRequest path
arrayPOST Parameters
arrayReconfigure the request for this call only
arrayDataput(string $path, array $options) : array+ +
stringRequest path
arrayReconfigure the request for this call only
arrayDatasetHeaders(array $headers)+ +
array
+setOption(string $name, mixed $value) : \HttpClientInterface+ +
stringThe option name
mixedThe value
\HttpClientInterfaceThe current object instance__construct(string $method, array $options)+ +
string
+array
+\InvalidArgumentException |
++ |
|---|
postSend(Buzz\Message\RequestInterface $request, Buzz\Message\MessageInterface $response)+ +
preSend(Buzz\Message\RequestInterface $request)+ +
$method : string+ +
| Type | +Line | +Description | +
|---|---|---|
| error | +25 | +No short description for method __construct() | +
| error | +25 | +The type hint of the argument is incorrect for the type definition of the @param tag with argument $client in __construct() | +
| error | +33 | +Argument $path is missing from the Docblock of get() | +
| error | +33 | +Argument $parameters is missing from the Docblock of get() | +
| error | +33 | +Argument $requestOptions is missing from the Docblock of get() | +
| error | +41 | +Argument $path is missing from the Docblock of post() | +
| error | +41 | +Argument $parameters is missing from the Docblock of post() | +
| error | +41 | +Argument $requestOptions is missing from the Docblock of post() | +
| error | +49 | +Argument $path is missing from the Docblock of patch() | +
| error | +49 | +Argument $parameters is missing from the Docblock of patch() | +
| error | +49 | +Argument $requestOptions is missing from the Docblock of patch() | +
| error | +57 | +Argument $path is missing from the Docblock of put() | +
| error | +57 | +Argument $parameters is missing from the Docblock of put() | +
| error | +57 | +Argument $requestOptions is missing from the Docblock of put() | +
| error | +65 | +Argument $path is missing from the Docblock of delete() | +
| error | +65 | +Argument $parameters is missing from the Docblock of delete() | +
| error | +65 | +Argument $requestOptions is missing from the Docblock of delete() | +
| Type | +Line | +Description | +
|---|---|---|
| error | +20 | +No short description for method render() | +
| error | +42 | +No short description for method renderRaw() | +
| Type | +Line | +Description | +
|---|---|---|
| error | +24 | +Name of argument $recursive does not match with the DocBlock's name $resursive in showTree() | +
| notice | +24 | +Parameter $resursive could not be found in showTree() | +
| notice | +43 | +Parameter $path could not be found in listBlobs() | +
| Type | +Line | +Description | +
|---|---|---|
| error | +234 | +Name of argument $repo does not match with the DocBlock's name $username in removeRepoCollaborator() | +
| error | +234 | +Name of argument $username does not match with the DocBlock's name $repo in removeRepoCollaborator() | +
| Type | +Line | +Description | +
|---|---|---|
| error | +128 | +Argument $title is missing from the Docblock of addKey() | +
| error | +128 | +Argument $key is missing from the Docblock of addKey() | +
| error | +138 | +Argument $id is missing from the Docblock of removeKey() | +
| error | +158 | +Argument $email is missing from the Docblock of addEmail() | +
| error | +168 | +Argument $email is missing from the Docblock of removeEmail() | +
| Type | +Line | +Description | +
|---|---|---|
| error | +63 | +The type hint of the argument is incorrect for the type definition of the @param tag with argument $httpClient in __construct() | +
| error | +181 | +The type hint of the argument is incorrect for the type definition of the @param tag with argument $httpClient in setHttpClient() | +
| error | +315 | +No short description for method getRateLimit() | +
| error | +328 | +Name of argument $instance does not match with the DocBlock's name $api in setApi() | +
| error | +328 | +The type hint of the argument is incorrect for the type definition of the @param tag with argument $instance in setApi() | +
| notice | +328 | +Parameter $api could not be found in setApi() | +
| error | +357 | +No short description for method setHeaders() | +
| Type | +Line | +Description | +
|---|---|---|
| error | +12 | +No DocBlock was found for method __construct() | +
| Type | +Line | +Description | +
|---|---|---|
| critical | +23 | +No short description for property $remainingCalls | +
| critical | +47 | +No short description for property $history | +
| critical | +52 | +No short description for property $headers | +
| critical | +57 | +No short description for property $browser | +
| error | +65 | +The type hint of the argument is incorrect for the type definition of the @param tag with argument $browser in __construct() | +
| error | +89 | +Argument $headers is missing from the Docblock of setHeaders() | +
| error | +97 | +Argument $name is missing from the Docblock of setOption() | +
| error | +97 | +Argument $value is missing from the Docblock of setOption() | +
| error | +107 | +Argument $path is missing from the Docblock of get() | +
| error | +107 | +Argument $parameters is missing from the Docblock of get() | +
| error | +107 | +Argument $options is missing from the Docblock of get() | +
| error | +115 | +Argument $path is missing from the Docblock of post() | +
| error | +115 | +Argument $parameters is missing from the Docblock of post() | +
| error | +115 | +Argument $options is missing from the Docblock of post() | +
| error | +123 | +Argument $path is missing from the Docblock of patch() | +
| error | +123 | +Argument $parameters is missing from the Docblock of patch() | +
| error | +123 | +Argument $options is missing from the Docblock of patch() | +
| error | +131 | +Argument $path is missing from the Docblock of delete() | +
| error | +131 | +Argument $parameters is missing from the Docblock of delete() | +
| error | +131 | +Argument $options is missing from the Docblock of delete() | +
| error | +139 | +Argument $path is missing from the Docblock of put() | +
| error | +139 | +Argument $options is missing from the Docblock of put() | +
| error | +197 | +Argument $response is missing from the Docblock of decodeResponse() | +
| error | +211 | +Argument $response is missing from the Docblock of checkApiLimit() | +
| Type | +Line | +Description | +
|---|---|---|
| error | +13 | +No DocBlock was found for \Github\HttpClient\Listener\AuthListener | +
| critical | +18 | +No short description for property $method | +
| critical | +22 | +No short description for property $options | +
| error | +30 | +No short description for method __construct() | +
| error | +43 | +Argument $request is missing from the Docblock of preSend() | +
| error | +72 | +Argument $request is missing from the Docblock of postSend() | +
| error | +72 | +Argument $response is missing from the Docblock of postSend() | +
| t |