Skip to content

Add acceptedLang() to Server class and refactor server.php helper #355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
armanist merged 1 commit into from
Dec 7, 2025
Merged

Add acceptedLang() to Server class and refactor server.php helper #355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 12 additions & 20 deletions src/Environment/Helpers/server.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,27 @@
* @author Arman Ag. <arman.ag@softberg.org>
* @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
* @link http://quantum.softberg.org/
* @since 2.9.7
* @since 2.9.9
*/

use Quantum\Environment\Server;

/**
* Gets Server instance
* @return Server
*/
function server(): Server
{
return Server::getInstance();
}

/**
* Gets user IP
* @return string|null
*/
function get_user_ip(): ?string
{
$server = Server::getInstance();

return $server->get('HTTP_CLIENT_IP')
?? $server->get('HTTP_X_FORWARDED_FOR')
?? $server->get('REMOTE_ADDR');
return Server::getInstance()->ip();
}

if (!function_exists('getallheaders')) {
Expand All @@ -37,19 +42,6 @@ function get_user_ip(): ?string
*/
function getallheaders(): array
{
$server = Server::getInstance();
$data = $server->all();

if (empty($data)) {
return [];
}

return array_reduce(array_keys($data), function ($headers, $key) use ($data) {
if (strpos($key, 'HTTP_') === 0) {
$formattedKey = strtolower(str_replace('_', '-', substr($key, 5)));
$headers[$formattedKey] = $data[$key];
}
return $headers;
}, []);
return Server::getInstance()->getAllHeaders();
}
}
48 changes: 47 additions & 1 deletion src/Environment/Server.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* @author Arman Ag. <arman.ag@softberg.org>
* @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
* @link http://quantum.softberg.org/
* @since 2.9.8
* @since 2.9.9
*/

namespace Quantum\Environment;
Expand Down Expand Up @@ -174,4 +174,50 @@ public function ajax(): bool
{
return strtolower($this->get('HTTP_X_REQUESTED_WITH') ?? '') === 'xmlhttprequest';
}

/**
* @return string|null
*/
public function ip(): ?string
{
return $this->get('HTTP_CLIENT_IP')
?? $this->get('HTTP_X_FORWARDED_FOR')
?? $this->get('REMOTE_ADDR');
}

/**
* @return array
*/
function getAllHeaders(): array
{
$data = $this->all();

if (empty($data)) {
return [];
}

return array_reduce(array_keys($data), function ($headers, $key) use ($data) {
if (strpos($key, 'HTTP_') === 0) {
$formattedKey = strtolower(str_replace('_', '-', substr($key, 5)));
$headers[$formattedKey] = $data[$key];
}
return $headers;
}, []);
}

/**
* @return string|null
*/
public function acceptedLang(): ?string
{
$accept = $this->get('HTTP_ACCEPT_LANGUAGE');

if (!$accept) {
return null;
}

$first = explode(',', $accept)[0];

return strtolower(substr(trim($first), 0, 2));
}
}
67 changes: 67 additions & 0 deletions tests/Unit/Environment/ServerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,4 +136,71 @@ public function testServerAjax()
$this->assertFalse($server->ajax());
}

public function testServerGetUserIpFromRemoteAddr()
{
$server = Server::getInstance();

$server->set('HTTP_CLIENT_IP', '192.168.1.1');
$server->set('HTTP_X_FORWARDED_FOR', null);
$server->set('REMOTE_ADDR', null);
$this->assertEquals('192.168.1.1', $server->ip());

$server->set('HTTP_CLIENT_IP', null);
$server->set('HTTP_X_FORWARDED_FOR', '203.0.113.5');
$server->set('REMOTE_ADDR', null);
$this->assertEquals('203.0.113.5', $server->ip());

$server->set('HTTP_CLIENT_IP', null);
$server->set('HTTP_X_FORWARDED_FOR', null);
$server->set('REMOTE_ADDR', '198.51.100.1');
$this->assertEquals('198.51.100.1', $server->ip());

$server->set('HTTP_CLIENT_IP', null);
$server->set('HTTP_X_FORWARDED_FOR', null);
$server->set('REMOTE_ADDR', null);
$this->assertNull($server->ip());
}

public function testServerGetAllHeadersFromServerClass()
{
$server = Server::getInstance();

$server->set('HTTP_USER_AGENT', 'Mozilla/5.0');
$server->set('HTTP_ACCEPT', 'text/html');
$server->set('HTTP_X_CUSTOM_HEADER', 'CustomValue');
$server->set('SERVER_NAME', 'example.com');

$headers = $server->getAllHeaders();

$this->assertArrayHasKey('user-agent', $headers);
$this->assertArrayHasKey('accept', $headers);
$this->assertArrayHasKey('x-custom-header', $headers);

$this->assertEquals('Mozilla/5.0', $headers['user-agent']);
$this->assertEquals('text/html', $headers['accept']);
$this->assertEquals('CustomValue', $headers['x-custom-header']);

$this->assertArrayNotHasKey('SERVER_NAME', $headers);
}

public function testServerAcceptedLang()
{
$server = Server::getInstance();

$server->set('HTTP_ACCEPT_LANGUAGE', null);
$this->assertNull($server->acceptedLang());

$server->set('HTTP_ACCEPT_LANGUAGE', 'en-US');
$this->assertEquals('en', $server->acceptedLang());

$server->set('HTTP_ACCEPT_LANGUAGE', 'fr-CA,fr;q=0.8,en-US;q=0.6,en;q=0.4');
$this->assertEquals('fr', $server->acceptedLang());

$server->set('HTTP_ACCEPT_LANGUAGE', ' de-DE , en-US ');
$this->assertEquals('de', $server->acceptedLang());

$server->set('HTTP_ACCEPT_LANGUAGE', 'ES-ES');
$this->assertEquals('es', $server->acceptedLang());
}

}