madewithlove / htaccess-api-client
API client for the best htaccess tester in the world.
Fund package maintenance!
madewithlove
Installs: 18 937
Dependents: 1
Suggesters: 0
Security: 0
Stars: 9
Watchers: 11
Forks: 1
Open Issues: 2
Type:package
Requires
- php: ^8.0
- psr/http-client: ^1.0
- psr/http-factory: ^1.0
Requires (Dev)
- http-interop/http-factory-guzzle: ^1.0
- infection/infection: ^0.25
- php-http/guzzle7-adapter: ^1.0
- phpstan/phpstan: ^1.0.0
- phpunit/phpunit: ^9.1
README
This is an API client to interact with the Htaccess tester.
Installation
composer require madewithlove/htaccess-api-client
Usage
The package can be used with every PSR-compatible http client. In this example, we're going to be using guzzle's PSR adapter.
use Http\Factory\Guzzle\ServerRequestFactory; use Http\Adapter\Guzzle6\Client; use Madewithlove\HtaccessClient $client = new HtaccessClient( new Client(), new ServerRequestFactory() ); $response = $client->test( 'http://localhost', 'RewriteRule .* /foo [R]' ); $response->getOutputUrl(); // "http://localhost/foo" $response->getLines(); /* array(1) { [0]=> object(Madewithlove\ResultLine)#30 (5) { ["line":"Madewithlove\ResultLine":private]=> string(23) "RewriteRule .* /foo [R]" ["message":"Madewithlove\ResultLine":private]=> string(98) "The new url is http://localhost/foo Test are stopped, a redirect will be made with status code 302" ["isMet":"Madewithlove\ResultLine":private]=> bool(true) ["isValid":"Madewithlove\ResultLine":private]=> bool(true) ["wasReached":"Madewithlove\ResultLine":private]=> bool(true) } } */
Server variables
Htaccess Tester supports passing server variables to be evaluated by the rewrite rules. We currently support the following variables.
Server variables can be passed to the test()
and share()
methods.
$serverVariables = ServerVariables::default()->with( 'SERVER_NAME', 'example.com' ); $response = $client->test( 'http://localhost', 'RewriteCond %{SERVER_NAME} example.com RewriteRule .* /foo [R]', $serverVariables ); $response = $client->share( 'http://localhost', 'RewriteCond %{SERVER_NAME} example.com RewriteRule .* /foo [R]', $serverVariables );