https://github.com/tomrf/htmx-message
PHP PSR-7 proxy classes with convenience methods for htmx (htmx.org) requests and responses
https://github.com/tomrf/htmx-message
htmx http-message php php-htmx psr-7 responseinterface serverrequestinterface
Last synced: 9 days ago
JSON representation
PHP PSR-7 proxy classes with convenience methods for htmx (htmx.org) requests and responses
- Host: GitHub
- URL: https://github.com/tomrf/htmx-message
- Owner: tomrf
- License: mit
- Created: 2022-07-09T23:07:14.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-10T13:24:10.000Z (over 2 years ago)
- Last Synced: 2025-08-02T17:37:33.092Z (6 months ago)
- Topics: htmx, http-message, php, php-htmx, psr-7, responseinterface, serverrequestinterface
- Language: PHP
- Homepage:
- Size: 366 KB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# htmx-message - PHP PSR-7 proxy classes with convenience methods for htmx requests and responses
[](https://packagist.org/packages/tomrf/htmx-message) [](https://packagist.org/packages/tomrf/htmx-message) [](https://packagist.org/packages/tomrf/htmx-message)
PSR-7 `ServerRequestInterface` and `ResponseInterface` proxy classes for [`htmx`](https://htmx.org)
with convenience methods for all special htmx headers (`HX-*`) in request and
response objects.
`HtmxResponse` is a proxy for PSR-7 response objects implementing `\Psr\Http\Message\ResponseInterface`.
`HtmxServerRequest` is a proxy for PSR-7 server request objects implementing `\Psr\Http\Message\ServerRequestInterface`.
You can safely wrap any `ResponseInterface` or `ServerRequestInterface` object, also those not originating from [`htmx`](htmx.org), without affecting your application.
`HtmxResponse` and `HtmxServerRequest` objects retains immutability in the same fashion as one would expect from a PSR-7 `MessageInterface`, returning a new object wrapping a new `ResponseInterface` instance whenever the `HtmxResponse` is changed.
Conforms to [`htmx`](https://htmx.org) version 1.9.x (latest) as per 2023-08-01.
📔 [Go to documentation](#documentation)
## Installation
Installation via composer:
```bash
composer require tomrf/htmx-message
```
## Usage
```php
$request = new HtmxRequest($request); // PSR-7 `ServerRequestInterface`
if ($request->isHxRequest() && $request->isHxBoosted()) {
$layout = 'ajax.layout';
}
[...]
$response = new HtmxResponse($response); // PSR-7 `ResponseInterface`
$response = $response->withHxTrigger('aSimpleTrigger')
->withAddedHxTrigger('triggerWithParams', ['arg' => true, 'arg2' => 7])
->withTriggerAfterSwap('afterSwap', time())
->withHxPush($newUrl);
// Emit $response as normal
[...]
```
## Testing
```bash
composer test
```
## License
This project is released under the MIT License (MIT).
See [LICENSE](LICENSE) for more information.
## Documentation
- [Tomrf\HtmxMessage\HtmxResponse](#-tomrfhtmxmessagehtmxresponseclass)
- [getHxPush](#gethxpush)
- [getHxRedirect](#gethxredirect)
- [getHxRetarget](#gethxretarget)
- [getHxTrigger](#gethxtrigger)
- [getHxTriggerAfterSettle](#gethxtriggeraftersettle)
- [getHxTriggerAfterSwap](#gethxtriggerafterswap)
- [hasHxPush](#hashxpush)
- [hasHxRedirect](#hashxredirect)
- [hasHxRefresh](#hashxrefresh)
- [hasHxRetarget](#hashxretarget)
- [hasHxTrigger](#hashxtrigger)
- [hasHxTriggerAfterSettle](#hashxtriggeraftersettle)
- [hasHxTriggerAfterSwap](#hashxtriggerafterswap)
- [withAddedHxTrigger](#withaddedhxtrigger)
- [withAddedHxTriggerAfterSettle](#withaddedhxtriggeraftersettle)
- [withAddedHxTriggerAfterSwap](#withaddedhxtriggerafterswap)
- [withHxPush](#withhxpush)
- [withHxRedirect](#withhxredirect)
- [withHxRefresh](#withhxrefresh)
- [withHxRetarget](#withhxretarget)
- [withHxTrigger](#withhxtrigger)
- [withHxTriggerAfterSettle](#withhxtriggeraftersettle)
- [withHxTriggerAfterSwap](#withhxtriggerafterswap)
- [withoutHxPush](#withouthxpush)
- [withoutHxRedirect](#withouthxredirect)
- [withoutHxRefresh](#withouthxrefresh)
- [withoutHxRetarget](#withouthxretarget)
- [withoutHxTrigger](#withouthxtrigger)
- [withoutHxTriggerAfterSettle](#withouthxtriggeraftersettle)
- [withoutHxTriggerAfterSwap](#withouthxtriggerafterswap)
- [Tomrf\HtmxMessage\HtmxServerRequest](#-tomrfhtmxmessagehtmxserverrequestclass)
- [getHxCurrentUrl](#gethxcurrenturl)
- [getHxPrompt](#gethxprompt)
- [getHxTarget](#gethxtarget)
- [getHxTrigger](#gethxtrigger)
- [getHxTriggerName](#gethxtriggername)
- [hasHxPrompt](#hashxprompt)
- [hasHxTarget](#hashxtarget)
- [hasHxTrigger](#hashxtrigger)
- [hasHxTriggerName](#hashxtriggername)
- [isHxBoosted](#ishxboosted)
- [isHxHistoryRestoreRequest](#ishxhistoryrestorerequest)
- [isHxRequest](#ishxrequest)
- [__construct](#__construct)
***
### 📂 Tomrf\HtmxMessage\HtmxResponse::class
HtmxResponse is a proxy for PSR-7 response objects implementing
\Psr\Http\Message\ResponseInterface.
You can safely wrap any ResponseInterface object, also those not
responding to a htmx request, without affecting your application.
HtmxResponse objects retains immutability in the same fashion as
one would expect from a PSR-7 MessageInterface, returning a new object
wrapping a new ResponseInterface instance whenever the HtmxResponse
is changed.
Example:
$response = new HtmxResponse($response);
$response = $response->withHxTrigger('myTrigger')
->withRedirect('/user/redirected')
->withHxPush(false);
// ...
#### getHxPush()
```php
public function getHxPush(): string
```
#### getHxRedirect()
```php
public function getHxRedirect(): string
```
#### getHxRetarget()
```php
public function getHxRetarget(): string
```
#### getHxTrigger()
```php
public function getHxTrigger(): array
@return array
```
#### getHxTriggerAfterSettle()
```php
public function getHxTriggerAfterSettle(): array
@return array
```
#### getHxTriggerAfterSwap()
```php
public function getHxTriggerAfterSwap(): array
@return array
```
#### hasHxPush()
```php
public function hasHxPush(): bool
```
#### hasHxRedirect()
```php
public function hasHxRedirect(): bool
```
#### hasHxRefresh()
```php
public function hasHxRefresh(): bool
```
#### hasHxRetarget()
```php
public function hasHxRetarget(): bool
```
#### hasHxTrigger()
```php
public function hasHxTrigger(): bool
```
#### hasHxTriggerAfterSettle()
```php
public function hasHxTriggerAfterSettle(): bool
```
#### hasHxTriggerAfterSwap()
```php
public function hasHxTriggerAfterSwap(): bool
```
#### withAddedHxTrigger()
```php
public function withAddedHxTrigger(
string $trigger,
mixed $argument = null
): static
```
#### withAddedHxTriggerAfterSettle()
```php
public function withAddedHxTriggerAfterSettle(
string $trigger,
mixed $argument = null
): static
```
#### withAddedHxTriggerAfterSwap()
```php
public function withAddedHxTriggerAfterSwap(
string $trigger,
mixed $argument = null
): static
```
#### withHxPush()
```php
public function withHxPush(
string|bool $url
): static
```
#### withHxRedirect()
```php
public function withHxRedirect(
string $url
): static
```
#### withHxRefresh()
```php
public function withHxRefresh(): static
```
#### withHxRetarget()
```php
public function withHxRetarget(
string $selector
): static
```
#### withHxTrigger()
```php
public function withHxTrigger(
string $trigger,
mixed $argument = null
): static
```
#### withHxTriggerAfterSettle()
```php
public function withHxTriggerAfterSettle(
string $trigger,
mixed $argument = null
): static
```
#### withHxTriggerAfterSwap()
```php
public function withHxTriggerAfterSwap(
string $trigger,
mixed $argument = null
): static
```
#### withoutHxPush()
```php
public function withoutHxPush(): static
```
#### withoutHxRedirect()
```php
public function withoutHxRedirect(): static
```
#### withoutHxRefresh()
```php
public function withoutHxRefresh(): static
```
#### withoutHxRetarget()
```php
public function withoutHxRetarget(): static
```
#### withoutHxTrigger()
```php
public function withoutHxTrigger(): static
```
#### withoutHxTriggerAfterSettle()
```php
public function withoutHxTriggerAfterSettle(): static
```
#### withoutHxTriggerAfterSwap()
```php
public function withoutHxTriggerAfterSwap(): static
```
***
### 📂 Tomrf\HtmxMessage\HtmxServerRequest::class
HtmxServerRequest is a proxy for PSR-7 server request objects implementing
\Psr\Http\Message\ServerRequestInterface.
You can safely wrap any ServerRequestInterface object, also those not
originating from htmx, without affecting your application.
Check if the request originated from htmx using the isHxRequest() method.
HtmxServerRequest objects retains immutability in the same fashion as
one would expect from a PSR-7 MessageInterface, returning a new object
wrapping a new ServerRequestInterface instance whenever the HtmxServerRequest
is changed.
Example:
$request = new HtmxServerRequest($request);
if ($request->isHxRequest() && $request->isHxBoosted()) {
// htmx request from boosted client, respond accordingly
}
$userPrompt = $request->getHxPrompt();
// ...
#### getHxCurrentUrl()
```php
public function getHxCurrentUrl(): string
```
#### getHxPrompt()
```php
public function getHxPrompt(): string
```
#### getHxTarget()
```php
public function getHxTarget(): string
```
#### getHxTrigger()
```php
public function getHxTrigger(): string
```
#### getHxTriggerName()
```php
public function getHxTriggerName(): string
```
#### hasHxPrompt()
```php
public function hasHxPrompt(): bool
```
#### hasHxTarget()
```php
public function hasHxTarget(): bool
```
#### hasHxTrigger()
```php
public function hasHxTrigger(): bool
```
#### hasHxTriggerName()
```php
public function hasHxTriggerName(): bool
```
#### isHxBoosted()
```php
public function isHxBoosted(): bool
```
#### isHxHistoryRestoreRequest()
```php
public function isHxHistoryRestoreRequest(): bool
```
#### isHxRequest()
```php
public function isHxRequest(): bool
```
#### __construct()
```php
public function __construct(
Psr\Http\Message\ServerRequestInterface $message
): void
```
***
_Generated 2023-08-18T12:46:49+00:00 using 📚[tomrf/readme-gen](https://packagist.org/packages/tomrf/readme-gen)_