RouteList: parameter $oneWay is bool (BC break)

Author: dg

.phpstorm.meta.php

@@ -333,14 +333,14 @@ Global filters give you the ability to adjust the behavior of the route in absol
 If a parameter has a custom filter defined and a global filter exists at the same time, custom `FILTER_IN` is executed before the global and vice versa global `FILTER_OUT` is executed before the custom. Thus, inside the global filter are the values of the parameters `controller` resp. `action` written in PascalCase resp. camelCase style.
 
 
-ONE_WAY flag
+OneWay flag
 ------------
 
-One-way routes are used to preserve the functionality of old URLs that the application no longer generates but still accepts. We flag them with `ONE_WAY`:
+One-way routes are used to preserve the functionality of old URLs that the application no longer generates but still accepts. We flag them with `oneWay`:
 
 ```php
 // old URL /product-info?id=123
-$router->addRoute('product-info', [...], $router::ONE_WAY);
+$router->addRoute('product-info', [...], oneWay: true);
 // new URL /product/123
 $router->addRoute('product/<id>', [...]);
 ```
@@ -450,7 +450,7 @@ SEO and Canonization
 
 The framework increases SEO (search engine optimization) by preventing duplication of content at different URLs. If multiple addresses link to a same destination, eg `/index` and `/index.html`, the framework determines the first one as primary (canonical) and redirects the others to it using HTTP code 301. Thanks to this, search engines will not index pages twice and do not break their page rank. .
 
-This process is called canonization. The canonical URL is the one generated by the router, i.e. by the first matching route in the [collection ](#route-collection) without the ONE_WAY flag. Therefore, in the collection, we list **primary routes first**.
+This process is called canonization. The canonical URL is the one generated by the router, i.e. by the first matching route in the [collection ](#route-collection) without the OneWay flag. Therefore, in the collection, we list **primary routes first**.
 
 Canonization is performed by the controller, more in the chapter [canonization ](controllers#Canonization).
 

readme.md

@@ -188,7 +188,7 @@ public function warmupCache(): void
 	/**
 	 * Adds a router.
 	 */
-	public function add(Router $router, int $oneWay = 0): static
+	public function add(Router $router, bool $oneWay = false): static
 	{
 		$this->list[] = [$router, $oneWay];
 		$this->ranks = null;
@@ -199,7 +199,7 @@ public function add(Router $router, int $oneWay = 0): static
 	/**
 	 * Prepends a router.
 	 */
-	public function prepend(Router $router, int $oneWay = 0): void
+	public function prepend(Router $router, bool $oneWay = false): void
 	{
 		array_splice($this->list, 0, 0, [[$router, $oneWay]]);
 		$this->ranks = null;
@@ -221,7 +221,7 @@ protected function modify(int $index, ?Router $router): void
 	}
 
 
-	public function addRoute(string $mask, array $metadata = [], int $oneWay = 0): static
+	public function addRoute(string $mask, array $metadata = [], bool $oneWay = false): static
 	{
 		$this->add(new Route($mask, $metadata), $oneWay);
 		return $this;
@@ -269,11 +269,11 @@ public function getRouters(): array
 
 
 	/**
-	 * @return int[]
+	 * @return bool[][]
 	 */
 	public function getFlags(): array
 	{
-		return array_column($this->list, 1);
+		return array_map(fn($info) => ['oneWay' => (bool) $info[1]], $this->list);
 	}
 
 

src/Routing/RouteList.php

@@ -17,8 +17,8 @@
  */
 interface Router
 {
-	/** for back compatibility */
-	public const ONE_WAY = 0b0001;
+	/** @deprecated */
+	public const ONE_WAY = true;
 
 	/**
 	 * Maps HTTP request to an array.

src/Routing/Router.php

@@ -9,8 +9,8 @@ require __DIR__ . '/../bootstrap.php';
 
 
 $list = new RouteList;
-$list->addRoute('foo', ['route' => 'foo'], RouteList::ONE_WAY);
-$list->addRoute('bar', ['route' => 'bar'], RouteList::ONE_WAY);
+$list->addRoute('foo', ['route' => 'foo'], oneWay: true);
+$list->addRoute('bar', ['route' => 'bar'], oneWay: true);
 $list->addRoute('hello', ['route' => 'hello']);
 
 

tests/RouteList/addRoute.phpt

@@ -14,7 +14,7 @@ $list = new RouteList;
 $list->add(new Route('bar', ['presenter' => 'bar']));
 $list->add(new Route('<foo>', ['presenter' => 'foo']));
 $list->add(new Route('<presenter>/<action>', ['presenter' => 'xxx']));
-$list->add(new Route('oneway'), $list::ONE_WAY);
+$list->add(new Route('oneway'), oneWay: true);
 
 [$r1, $r2, $r3, $r4] = $list->getRouters();
 

tests/RouteList/cache.phpt

@@ -11,11 +11,11 @@ require __DIR__ . '/../bootstrap.php';
 
 
 $list = new RouteList;
-$list->add(new Route('foo', ['route' => 'foo']), RouteList::ONE_WAY);
-$list->addRoute('bar', ['route' => 'bar'], RouteList::ONE_WAY);
+$list->add(new Route('foo', ['route' => 'foo']), oneWay: true);
+$list->addRoute('bar', ['route' => 'bar'], oneWay: true);
 $list->add(new Route('hello', ['route' => 'hello']));
 
-Assert::same([RouteList::ONE_WAY, RouteList::ONE_WAY, 0], $list->getFlags());
+Assert::same([['oneWay' => true], ['oneWay' => true], ['oneWay' => false]], $list->getFlags());
 
 testRouteIn($list, '/foo', ['route' => 'foo', 'test' => 'testvalue']);
 testRouteIn($list, '/bar', ['route' => 'bar', 'test' => 'testvalue']);