Download the PHP package weblabormx/world without Composer
On this page you can find all versions of the php package weblabormx/world. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download weblabormx/world
More information about weblabormx/world
Files in weblabormx/world
Package world
Short Description Weblabor World API Wrapper Library for PHP
License
Informations about the package world
Weblabor World
This is a PHP library to work with the World API.
Requirements
- PHP 8.1 and later.
Packagist
Install via packagist using:
Don't forget to include the bindings:
Initialize credentials
You can choose to work with the library using the World
static class like this:
Or by instantiating a client object:
The static way is recommended.
Divisions
The API works by getting the different levels of divisions of the world. Yoy may normally know them as countries, states and cities, but other nations call them different and have more than 3 levels.
So, the world is divided in different ways depending each different sovereign nation.
We normally call, the sovereign nations, the upmost level of division, countries. The children of the countries, states. And the children of those states, cities. This is the way the API is used, by traversing the different levels of divisions. A division has children()
and parent()
unless it's the upmost or downmost level of division.
Properties
All calls from the division endpoints, returns a WeblaborMx\World\Entities\Division
object or array.
You can check the properties by inspecting the class constructor:
Endpoints
Check all endpoints in the documentation.
Obtaining all countries
You probably want to start fetching divisions by their upmost level.
Get country by code
You can search a country by its ISO-3166 code.
Getting a specific division
To get a specific division, you pass its previously obtained ID.
Obtaining all children
Obtaining parent
Working with Laravel
To maintain the library lightweight, no dependency was added. However, you can find a Division casting class, that although it doesn't implements the contract from Laravel, it should work as any other cast.
With the cast you can save any ID obtained in a model, and automatically obtain a Division
when accesing the property again.
Registering client
You probably want to initialize the client through a service provider like AppServiceProvider
.
Then setup the services.php
configuration.
And the credentials in .env
.