pewe / laravel-rajaongkir
A wrapper for Raja Ongkir API
Requires
- php: >=5.3.0
- guzzlehttp/guzzle: ^6.3
This package is auto-updated.
Last update: 2024-12-16 07:02:44 UTC
README
A wrapper for Raja Ongkir API built for laravel and lumen (only available for Starter Account) Basic and Pro Accounts available soon
Installations
composer require pewe/laravel-rajaongkir
Configuration
Edit your .env
file. Place your key, you can get your key in Raja Ongkir page
RAJAONGKIR_API_KEY=12345667
For Lumen
Edit your boostrap/app.php
Enable Facades
$app->withFacades();
Enable class_alias (Optional)
class_alias('Pewe\RajaOngkir\Facades\Province', 'Province'); class_alias('Pewe\RajaOngkir\Facades\City', 'City'); class_alias('Pewe\RajaOngkir\Facades\Cost', 'Cost');
Register RajaOngkirServiceProvider (Optional)
$app->register(Pewe\RajaOngkir\Providers\RajaOngkirServiceProvider::class);
Copy config file rajaongkir.php (vendor/pewe/laravel-rajaongkir/src/config/rajaongkir.php
) to your folder config. Or if You're already install package laravelista/lumen-vendor-publish.
You must register RajaOngkirServiceProvider before, then use this command:
php artisan vendor:publish --tag=laravel-rajaongkir-config
Configure your config
$app->configure('rajaongkir');
Usage
Import
<?php namespace App\Http\Controllers; use App\Http\Controllers\Controller; /*...*/ use City; //if using class_alias //use Pewe\RajaOngkir\Facades\City; //if not using class_alias class ExampleController extends Controller { /*...*/ public function getCities(){ dd(City::all()); } }
City
Get All City
City::all();
Get City by Id
City::find($id);
Province
Get All Province
Province::all();
Get Province by Id
Province::find($id);
Available Couriers & Cost
Get Available Couriers
Cost::couriers($destination,$weight,$origin);
Get Cost
Cost::calculate($destination,$courier,$weight,$origin,$service);
If your key submit is invalid InvalidTokenException
will thrown.
And if Bad Request from their server, RajaOngkirRequestException
will thrown.
Problem
-
Call undefined function
Pewe\RajaOngkir\Providers\config_path()
To resolve this:
Create a file called
helpers.php
in theapp/
directory. Paste the code inside it.<?php if ( ! function_exists('config_path')) { /** * Get the configuration path. * * @param string $path * @return string */ function config_path($path = '') { return app()->basePath() . '/config' . ($path ? '/' . $path : $path); } }
Go to
composer.json
and add files to autoload so that it looks like this:... "autoload": { "psr-4": { "App\\": "app/" }, "files": [ "app/helpers.php" ] }, ...
Run
composer dump-autoload
to load the newly created helpers file. Or just following this gist.
Contribute
Show your ❤️ and support by giving a 🌟 or fork. Any suggestions, issues and pull request are welcome 🍻!