02-configuration.md

Configuration

• Default Configuration
• Options
  • unitSystem
  • language
• Methods
  • setClientBuilder
  • setCacheBuilder
  • setLoggerBuilder

Default Configuration

OpenWeatherMap(string $apiKey, array $options => []);

use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;

$api = new OpenWeatherMap('yourapikey', [
    'unitSystem' => 'metric',
    'language' => 'en'
]);

Options

unitSystem

Unit system used when retrieving data. Affects temperature and speed values.

Available options:

• metric
• imperial
• standard

Example:

use ProgrammatorDev\OpenWeatherMap\UnitSystem\UnitSystem;
use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;

$api = new OpenWeatherMap('yourapikey', [
    'unitSystem' => UnitSystem::IMPERIAL
]);

language

Language used when retrieving data. It seems to only affect weather conditions descriptions.

List of all available languages can be found here.

Example:

use ProgrammatorDev\OpenWeatherMap\Language\Language;
use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;

$api = new OpenWeatherMap('yourapikey', [
    'language' => Language::PORTUGUESE
]);

Methods

Important

The PHP API SDK library was used to create the OpenWeatherMap PHP API. To get to know about all the available methods, make sure to check the documentation here.

The following sections have examples of some of the most important methods, particularly related with the configuration of the client, cache and logger.

setClientBuilder

By default, this library makes use of the HTTPlug's Discovery library. This means that it will automatically find and install a well-known PSR-18 client and PSR-17 factory implementation for you (if they were not found on your project):

• PSR-18 compatible implementations
• PSR-17 compatible implementations

If you don't want to rely on the discovery of implementations, you can set the ones you want:

use Nyholm\Psr7\Factory\Psr17Factory;
use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;
use Symfony\Component\HttpClient\Psr18Client;

$api = new OpenWeatherMap('yourapikey');

$client = new Psr18Client();
$requestFactory = $streamFactory = new Psr17Factory();

$api->setClientBuilder(
    new ClientBuilder(
        client: $client, 
        requestFactory: $requestFactory, 
        streamFactory: $streamFactory
    )
);

Check the full documentation here.

setCacheBuilder

This library allows configuring the cache layer of the client for making API requests. It uses a standard PSR-6 implementation and provides methods to fine-tune how HTTP caching behaves:

• PSR-6 compatible implementations

Example:

use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$api = new OpenWeatherMap('yourapikey');

$pool = new FilesystemAdapter();

// set a file-based cache adapter with a 1-hour default cache lifetime
$api->setCacheBuilder(
    new CacheBuilder(
        pool: $pool, 
        ttl: 3600
    )
);

Check the full documentation here.

setLoggerBuilder

This library allows configuring a logger to save data for making API requests. It uses a standard PSR-3 implementation and provides methods to fine-tune how logging behaves:

• PSR-3 compatible implementations

Example:

use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;

$api = new OpenWeatherMap('yourapikey');

$logger = new Logger('api');
$logger->pushHandler(new StreamHandler('/logs/api.log'));

$api->setLoggerBuilder(
    new LoggerBuilder(
        logger: $logger
    )
);

Check the full documentation here.