From 3e3c0a080d3ca8166eab2cb432d2171931a0ec20 Mon Sep 17 00:00:00 2001
From: Roliga <roliga.here@gmail.com>
Date: Tue, 27 Nov 2018 22:43:37 +0100
Subject: [PATCH] Add page for the detectParameters function

---
 The-detectParameters-function.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 The-detectParameters-function.md

diff --git a/The-detectParameters-function.md b/The-detectParameters-function.md
new file mode 100644
index 0000000..373dd64
--- /dev/null
+++ b/The-detectParameters-function.md
@@ -0,0 +1,19 @@
+The `detectParameters` function takes a URL and attempts to extract a valid set of parameters for the current bridge.
+
+If the passed URL is valid for this bridge the function should return an array of parameter -> value pairs that can be used by this bridge, or an empty array if the bridge requires no parameters. If the URL is not relevant for this bridge the function should return `null`.
+
+**Notice:** Implementing this function is optional. By default **RSS-Bridge** tries to match the supplied URL to the `URI` constant defined in the bridge which may be enough for bridges without any parameters defined.
+
+```PHP
+public function detectParameters($url){
+	$regex = '/^(https?:\/\/)?(www\.)?(.+?)(\/)?$/';
+	if(empty(static::PARAMETERS)
+	&& preg_match($regex, $url, $urlMatches) > 0
+	&& preg_match($regex, static::URI, $bridgeUriMatches) > 0
+	&& $urlMatches[3] === $bridgeUriMatches[3]) {
+		return array();
+	} else {
+		return null;
+	}
+}
+```
\ No newline at end of file