User factories to create routes and responses

1 files changed, 36 insertions, 0 deletions

diff --git a/app/Contracts/RouteFactoryInterface.php b/app/Contracts/RouteFactoryInterface.php
new file mode 100644
index 0000000000..c066c61d3f
--- /dev/null
+++ b/app/Contracts/RouteFactoryInterface.php
@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * webtrees: online genealogy
+ * Copyright (C) 2022 webtrees development team
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace Fisharebest\Webtrees\Contracts;
+
+/**
+ * Make a URL for a route.
+ */
+interface RouteFactoryInterface
+{
+    /**
+     * Generate a URL for a named route.
+     *
+     * @param string                                    $route_name
+     * @param array<bool|int|string|array<string>|null> $parameters
+     *
+     * @return string
+     */
+    public function route(string $route_name, array $parameters = []): string;
+}