Download the PHP package falko189/github without Composer
On this page you can find all versions of the php package falko189/github. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download falko189/github
More information about falko189/github
Files in falko189/github
Package github
Short Description GitHub Is A GitHub Bridge For Laravel 5
License MIT
Informations about the package github
Laravel GitHub
Laravel GitHub was created by, and is maintained by Graham Campbell, and is a PHP GitHub API bridge for Laravel 5. It utilises my Laravel Manager package. Feel free to check out the contribution guidelines.
Installation
Laravel GitHub requires PHP 7.1 or 7.2. This particular version supports Laravel 5.5 - 5.7 only.
To get the latest version, simply require the project using Composer. You will need to install any package that "provides" php-http/client-implementation
. Most users will want:
Once installed, if you are not using automatic package discovery, then you need to register the GrahamCampbell\GitHub\GitHubServiceProvider
service provider in your config/app.php
.
You can also optionally alias our facade:
Configuration
Laravel GitHub requires connection configuration.
To get started, you'll need to publish all vendor assets:
This will create a config/github.php
file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.
There are two config options:
Default Connection Name
This option ('default'
) is where you may specify which of the connections below you wish to use as your default connection for all work. Of course, you may use many connections at once using the manager class. The default value for this setting is 'main'
.
GitHub Connections
This option ('connections'
) is where each of the connections are setup for your application. Example configuration has been included, but you may add as many connections as you would like. Note that the 5 supported authentication methods are: "application"
, "jwt"
, "none"
, "password"
, and "token"
.
Usage
GitHubManager
This is the class of most interest. It is bound to the ioc container as 'github'
and can be accessed using the Facades\GitHub
facade. This class implements the ManagerInterface
by extending AbstractManager
. The interface and abstract class are both part of my Laravel Manager package, so you may want to go and checkout the docs for how to use the manager class over at that repo. Note that the connection class returned will always be an instance of \Github\Client
.
Facades\GitHub
This facade will dynamically pass static method calls to the 'github'
object in the ioc container which by default is the GitHubManager
class.
GitHubServiceProvider
This class contains no public methods of interest. This class should be added to the providers array in config/app.php
. This class will setup ioc bindings.
Real Examples
Here you can see an example of just how simple this package is to use. Out of the box, the default adapter is main
. After you enter your authentication details in the config file, it will just work:
The github manager will behave like it is a \Github\Client
class. If you want to call specific connections, you can do with the connection
method:
With that in mind, note that:
If you prefer to use dependency injection over facades like me, then you can easily inject the manager like so:
For more information on how to use the \Github\Client
class we are calling behind the scenes here, check out the docs at https://github.com/KnpLabs/php-github-api/tree/master/doc, and the manager class at https://github.com/GrahamCampbell/Laravel-Manager#usage.
Further Information
There are other classes in this package that are not documented here. This is because they are not intended for public use and are used internally by this package.
Security
If you discover a security vulnerability within this package, please send an e-mail to Graham Campbell at [email protected]. All security vulnerabilities will be promptly addressed.
License
Laravel GitHub is licensed under The MIT License (MIT).
All versions of github with dependencies
illuminate/contracts Version 5.5.*|5.6.*|5.7.*|5.8.*
illuminate/support Version 5.5.*|5.6.*|5.7.*|5.8.*
graham-campbell/cache-plugin Version ^1.0
graham-campbell/manager Version ^4.1
lcobucci/jwt Version ^3.3
knplabs/github-api Version 2.11.*