Browse Source

siputils: docs for uri_param_any(param)

Daniel-Constantin Mierla 5 years ago
parent
commit
65119d916f
1 changed files with 28 additions and 0 deletions
  1. 28 0
      src/modules/siputils/doc/siputils_admin.xml

+ 28 - 0
src/modules/siputils/doc/siputils_admin.xml

@@ -446,6 +446,34 @@ if (uri_param("param1","value1")) {
 	...
 };
 ...
+</programlisting>
+		</example>
+	</section>
+	<section>
+		<title id="siputils.f.uri_param_any">
+		<function moreinfo="none">uri_param_any(param)</function>
+		</title>
+		<para>
+		Find if Request URI has a given parameter with or without value.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para><emphasis>param</emphasis> - parameter name to look for.
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from REQUEST_ROUTE.
+		</para>
+		<example>
+		<title><function>uri_param_any</function> usage</title>
+		<programlisting format="linespecific">
+...
+if (uri_param_any("param1")) {
+	...
+}
+...
 </programlisting>
 		</example>
 	</section>