README

The DELOREAN PHP SDK allows integration with the DeLorean API in any PHP project. It also provides Facades and a Service Provider for enhanced Laravel integration.

📦 Installation

composer require husail/delorean-sdk

🔧 Usage Example

For Non-Laravel PHP Projects:

Basic Usage:

require 'vendor/autoload.php';

use Husail\DeLorean\Client;
use Husail\DeLorean\Authentication;

$client = new Client(
    new Authentication(token: 'your-token')
);

$response = $client->merchant->all();
if ($response->successful()) {
    // Handle the response
}

With Logging:

require 'vendor/autoload.php';

use Monolog\Logger;
use Husail\DeLorean\Client;
use Monolog\Handler\StreamHandler;
use Husail\DeLorean\Authentication;
use Husail\DeLorean\HttpClient\Message\Formatter\SimpleFormatter;

$logger = new Logger('my_logger');
$logger->pushHandler(new StreamHandler(__DIR__ . '/delorean.log'));

$client = new Client(
    new Authentication(token: 'your-token'),
    logger: $logger,
    formatter: new SimpleFormatter(true) // 'true' enables pretty-printed JSON logs
);

$response = $client->merchant->all();
if ($response->successful()) {
    // Handle the response
}

For Laravel:

Publish the configuration:

php artisan vendor:publish --provider="Husail\DeLorean\DeLoreanServiceProvider"

Add environment variables in your .env file:

DELOREAN_TOKEN=your-token

# Optional logging settings:
DELOREAN_LOG_ENABLED=false             # Enable or disable request/response logging
DELOREAN_LOG_FORMATTER_EXPANDED=false  # Pretty-print JSON in logs if enabled

Use the Facade to interact with the API:

use DeLorean;

$response = DeLorean::client()->merchant->all();
if ($response->successful()) {
    // Handle the response
}

Configure Logging

When DELOREAN_LOG_ENABLED is set to true, the SDK logs request and response details via Laravel's default logging channel. By default, logs output compact JSON. If you want the JSON output to be more readable (pretty-printed), set DELOREAN_LOG_FORMATTER_EXPANDED to true.

🤝 Contributing

We welcome contributions! Feel free to submit issues or pull requests to help improve the SDK.

📜 License

Licensed under the MIT License.

husail / delorean-sdk

Maintainers

Details