Skip to content

feat(http): add accepts helper method #1638

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
brendt merged 5 commits into from
Oct 13, 2025
Merged

feat(http): add accepts helper method #1638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f5fdd7b
wip
NeoIsRecursive Oct 12, 2025
a9c77ac
wip support wildcards
NeoIsRecursive Oct 12, 2025
c168e83
change to do "or" instead of "and"
NeoIsRecursive Oct 12, 2025
1cf2624
fix
NeoIsRecursive Oct 12, 2025
95a793f
fix include support for priority/weight
NeoIsRecursive Oct 12, 2025
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
42 changes: 42 additions & 0 deletions packages/http/src/IsRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@
use Tempest\Validation\SkipValidation;

use function Tempest\get;
use function Tempest\Support\Arr\every;
use function Tempest\Support\Arr\get_by_key;
use function Tempest\Support\Arr\has_key;
use function Tempest\Support\str;

/** @phpstan-require-implements \Tempest\Http\Request */
trait IsRequest
Expand Down Expand Up @@ -136,6 +138,46 @@ public function hasQuery(string $key): bool
return has_key($this->query, $key);
}

public function accepts(ContentType ...$contentTypes): bool
{
$header = $this->headers->get(name: 'accept') ?? '';

/** @var array{mediaType:string,subType:string} */
$mediaTypes = [];

foreach (str($header)->explode(separator: ',') as $acceptedType) {
$acceptedType = str($acceptedType)->trim();

if ($acceptedType->isEmpty()) {
continue;
}

$mediaTypes[] = [
'mediaType' => $acceptedType->before('/')->toString(),
'subType' => $acceptedType->afterFirst('/')->beforeLast(';q')->toString(),
];
}

if (count($mediaTypes) === 0) {
return true;
}

foreach ($contentTypes as $contentType) {
[$mediaType, $subType] = explode('/', $contentType->value);

foreach ($mediaTypes as $acceptedType) {
if (
($acceptedType['mediaType'] === '*' || $acceptedType['mediaType'] === $mediaType)
&& ($acceptedType['subType'] === '*' || $acceptedType['subType'] === $subType)
) {
return true;
}
}
}

return false;
}

public function withMethod(Method $method): self
{
$clone = clone $this;
Expand Down
6 changes: 6 additions & 0 deletions packages/http/src/Request.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,10 @@ public function get(string $key, mixed $default = null): mixed;
public function getSessionValue(string $name): mixed;

public function getCookie(string $name): ?Cookie;

/**
* Determines if the request's "Content-Type" header matches the given content type.
* If multiple content types are provided, the method returns true if any of them matches.
*/
public function accepts(ContentType ...$contentType): bool;
}
119 changes: 119 additions & 0 deletions packages/http/tests/GenericRequestTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

use LogicException;
use PHPUnit\Framework\TestCase;
use Tempest\Http\ContentType;
use Tempest\Http\GenericRequest;
use Tempest\Http\Header;
use Tempest\Http\Method;
Expand Down Expand Up @@ -61,4 +62,122 @@ public function test_throws_on_unset(): void
$this->expectException(LogicException::class);
unset($headers['x']);
}

public function test_accepts_with_accept_header(): void
{
$request = new GenericRequest(
method: Method::GET,
uri: '/',
headers: [
'Accept' => 'application/json',
],
);

$this->assertTrue($request->accepts(ContentType::JSON));
$this->assertFalse($request->accepts(ContentType::HTML));
$this->assertFalse($request->accepts(ContentType::XML));
}

public function test_accepts_with_no_accept_header(): void
{
$request = new GenericRequest(
method: Method::GET,
uri: '/',
);

$this->assertTrue($request->accepts(ContentType::JSON));
$this->assertTrue($request->accepts(ContentType::HTML));
$this->assertTrue($request->accepts(ContentType::XML));
}

public function test_accepts_with_empty_accept_header(): void
{
$request = new GenericRequest(
method: Method::GET,
uri: '/',
headers: [
'Accept' => '',
],
);

$this->assertTrue($request->accepts(ContentType::JSON));
$this->assertTrue($request->accepts(ContentType::HTML));
$this->assertTrue($request->accepts(ContentType::XML));
}

public function test_accepts_with_wildcard(): void
{
$request = new GenericRequest(
method: Method::GET,
uri: '/',
headers: [
'Accept' => '*/*',
],
);

$this->assertTrue($request->accepts(ContentType::JSON));
$this->assertTrue($request->accepts(ContentType::HTML));
$this->assertTrue($request->accepts(ContentType::XML));
}

public function test_accepts_with_multiple_values(): void
{
$request = new GenericRequest(
method: Method::GET,
uri: '/',
headers: [
'Accept' => 'application/json, text/html',
],
);

$this->assertTrue($request->accepts(ContentType::JSON));
$this->assertTrue($request->accepts(ContentType::HTML));
$this->assertFalse($request->accepts(ContentType::XML));
}

public function test_accepts_with_wildcard_subtype(): void
{
$request = new GenericRequest(
method: Method::GET,
uri: '/',
headers: [
'Accept' => 'application/*',
],
);

$this->assertTrue($request->accepts(ContentType::JSON));
$this->assertFalse($request->accepts(ContentType::HTML));
$this->assertTrue($request->accepts(ContentType::XML));
}

public function test_accepts_can_handle_priorities(): void
{
$request = new GenericRequest(
method: Method::GET,
uri: '/',
headers: [
'Accept' => 'text/html, application/xhtml+xml;q=0.8, application/xml;q=0.8, image/webp',
],
);

$this->assertTrue($request->accepts(ContentType::XHTML));
$this->assertTrue($request->accepts(ContentType::XML));
}

public function test_accepts_returns_true_on_first_match(): void
{
$request = new GenericRequest(
method: Method::GET,
uri: '/',
headers: [
'Accept' => 'application/*, image/avif',
],
);

$this->assertTrue($request->accepts(ContentType::HTML, ContentType::JSON));
$this->assertTrue($request->accepts(ContentType::XML, ContentType::JSON));
$this->assertTrue($request->accepts(ContentType::JSON, ContentType::AVIF));
$this->assertTrue($request->accepts(ContentType::AVIF, ContentType::PNG));
$this->assertFalse($request->accepts(ContentType::HTML, ContentType::PNG));
}
}