dragon-code / laravel-http-user-agent
Passing your own User Agent in all Http requests
Requires
- php: ^8.2
- illuminate/config: ^10.0 || ^11.0
- illuminate/http: ^10.0 || ^11.0
- illuminate/support: ^10.0 || ^11.0
- symfony/polyfill-php83: ^1.29
Requires (Dev)
- guzzlehttp/guzzle: ^7.8
- orchestra/testbench: ^8.0 || ^9.0
- pestphp/pest: ^2.34
README
FAQ
- Q: What problem does this package solve?
- A: In cases where it is necessary to explicitly specify the value
User-Agent
in outgoing requests. In other cases it is not necessary.
Installation
composer require dragon-code/laravel-http-user-agent
Basic Usage
It's all. Really 😎
When a package is installed, it will automatically specify the value of the User-Agent
header in the following
format (by default):
%s / %s - %s | %s
For example:
Site Name / 1.0 - https://example.com - john.doe@example.com
where:
Site Name
- value of theAPP_NAME
environment parameter1.0
- specific version of the application. If theversion
parameter is specified in thecomposer.json
file, its value will be taken, otherwise1.0
will be used by default.https://example.com
- value of theAPP_URL
environment parameterjohn.doe@example.com
- value of theMAIL_FROM_ADDRESS
environment parameter
If you want to change this value, add a new parameter APP_USER_AGENT
to the .env
file.
For example:
APP_USER_AGENT = "Cool Site - https://the-best.example.com"
Now, the value of the User-Agent
header in all external Http requests will be specified
as Cool Site - https://the-best.example.com
.
Configuration
If you need direct access to the configuration file, you can publish it to your application by calling the following console command:
php artisan vendor:publish --provider="DragonCode\LaravelHttpUserAgent\ServiceProvider"
As a result of its execution, the file config/http.php
will be created.
You can also disable value assignment through the environment settings:
APP_USER_AGENT_ENABLED = false
License
This package is licensed under the MIT License.