1. Go to this page and download the library: Download webfox/laravel-xero-oauth2 library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
webfox / laravel-xero-oauth2 example snippets
namespace App\Http\Controllers;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use Webfox\Xero\OauthCredentialManager;
class XeroController extends Controller
{
public function index(Request $request, OauthCredentialManager $xeroCredentials)
{
try {
// Check if we've got any stored credentials
if ($xeroCredentials->exists()) {
/*
* We have stored credentials so we can resolve the AccountingApi,
* If we were sure we already had some stored credentials then we could just resolve this through the controller
* But since we use this route for the initial authentication we cannot be sure!
*/
$xero = resolve(\XeroAPI\XeroPHP\Api\AccountingApi::class);
$organisationName = $xero->getOrganisations($xeroCredentials->getTenantId())->getOrganisations()[0]->getName();
$user = $xeroCredentials->getUser();
$username = "{$user['given_name']} {$user['family_name']} ({$user['username']})";
}
} catch (\throwable $e) {
// This can happen if the credentials have been revoked or there is an error with the organisation (e.g. it's expired)
$error = $e->getMessage();
}
return view('xero', [
'connected' => $xeroCredentials->exists(),
'error' => $error ?? null,
'organisationName' => $organisationName ?? null,
'username' => $username ?? null
]);
}
}
/*
* We name this route xero.auth.success as by default the config looks for a route with this name to redirect back to
* after authentication has succeeded. The name of this route can be changed in the config file.
*/
Route::get('/manage/xero', [\App\Http\Controllers\XeroController::class, 'index'])->name('xero.auth.success');
return Application::configure(basePath: dirname(__DIR__))
->withRouting(
web: __DIR__ . '/../routes/web.php',
commands: __DIR__ . '/../routes/console.php',
health: '/up',
)
->withMiddleware(function (Middleware $middleware) {
//
})
->withExceptions(function (Exceptions $exceptions) {
// Handle when the user clicks cancel on the Xero authorization screen
$exceptions->render(function (OAuthException $e, Request $request) {
return redirect('/my/xero/connect/page')->with('errorMessage', $e->getMessage());
});
})->create();
public function register()
{
$this->reportable(function (OAuthException $e) {
// Handle when the user clicks cancel on the Xero authorization screen
return redirect('/my/xero/connect/page')->with('errorMessage', $e->getMessage());
});
}
$this->app->bind(OauthCredentialManager::class, function(Application $app) {
return new UserStorageProvider(
\Auth::user(), // Storage Mechanism
$app->make('session.store'), // Used for storing/retrieving oauth 2 "state" for redirects
$app->make(\Webfox\Xero\Oauth2Provider::class) // Used for getting redirect url and refreshing token
);
});
namespace App\Http\Controllers;
use Webfox\Xero\Webhook;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use XeroApi\XeroPHP\Models\Accounting\Contact;
use XeroApi\XeroPHP\Models\Accounting\Invoice;
class XeroWebhookController extends Controller
{
public function __invoke(Request $request, Webhook $webhook)
{
// The following lines are if ($event->getEventType() === 'CREATE' && $event->getEventCategory() === 'INVOICE') {
$this->invoiceCreated($request, $event->getResource());
} elseif ($event->getEventType() === 'CREATE' && $event->getEventCategory() === 'CONTACT') {
$this->contactCreated($request, $event->getResource());
} elseif ($event->getEventType() === 'UPDATE' && $event->getEventCategory() === 'INVOICE') {
$this->invoiceUpdated($request, $event->getResource());
} elseif ($event->getEventType() === 'UPDATE' && $event->getEventCategory() === 'CONTACT') {
$this->contactUpdated($request, $event->getResource());
}
}
return response('', Response::HTTP_OK);
}
protected function invoiceCreated(Request $request, Invoice $invoice)
{
}
protected function contactCreated(Request $request, Contact $contact)
{
}
protected function invoiceUpdated(Request $request, Invoice $invoice)
{
}
protected function contactUpdated(Request $request, Contact $contact)
{
}
}