You can install the package via composer:
composer require xgenious/xgapiclientYou can publish and run the migrations with:
php artisan vendor:publish --tag="xgapiclient-migrations"
php artisan migrateYou can publish the config file with:
php artisan vendor:publish --tag="xgapiclient-config"Optionally, you can publish the views using
php artisan vendor:publish --tag="xgapiclient-views"For the new V2 chunked update system, you need to publish the JavaScript assets:
php artisan vendor:publish --tag=xgapiclient-assetsThis publishes UpdateManager.js to assets/vendor/xgapiclient/js/.
Ensure the update storage directory exists:
mkdir -p storage/app/xg-update
chmod 755 storage/app/xg-updateThis is the contents of the published config file (config/xgapiclient.php):
return [
/*
|--------------------------------------------------------------------------
| Base API URL
|--------------------------------------------------------------------------
|
| The license server every product talks to. Fixed - not .env-driven.
|
*/
"base_api_url" => "https://license.xgenious.com",
/*
|--------------------------------------------------------------------------
| Product Token
|--------------------------------------------------------------------------
|
| Unique product code for license server identification.
|
*/
"has_token" => env('XG_PRODUCT_TOKEN', ""),
/*
|--------------------------------------------------------------------------
| V2 Update System Configuration
|--------------------------------------------------------------------------
|
| Internal tuning for the chunked update system (V2) - fixed defaults,
| not .env-driven.
|
*/
"update" => [
"chunk_size" => 10 * 1024 * 1024, // 10MB
"download_timeout" => 300,
"extraction_batch_size" => 100,
"replacement_batch_size" => 50,
"enable_backup" => true,
"smart_vendor_replacement" => true,
"max_retries" => 3,
"status_file" => storage_path('app/xg-update/.update-status.json'),
"temp_directory" => storage_path('app/xg-update'),
],
];Only one variable is needed in your .env file:
XG_PRODUCT_TOKEN=your-unique-product-tokenEverything else (which license server to talk to, chunk size, batch sizes,
retry count, backup, smart-vendor-replacement) is a fixed internal default as
of 6.5.3 - not .env-configurable, so a mistyped or malformed override on the
hosting side can no longer break the update pipeline or misdirect licensing.
$xgapiclient = new XgApiClient\XgApiClient();
echo $xgapiclient->echoPhrase('Hello, XgApiClient!');composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.