From 40a5c15616cd5e3464d10fc2eb2c55b6eaae6bf6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marcos=20Garci=CC=81a=20de=20La=20Fuente?=
<marcosgdf@gmail.com>
Date: Wed, 25 Feb 2015 16:45:14 +0100
Subject: [PATCH] Improved getBrowserInfo documentation
---
htdocs/core/lib/functions.lib.php | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/htdocs/core/lib/functions.lib.php b/htdocs/core/lib/functions.lib.php
index 52c965fb005..7b09e1bcf1f 100644
--- a/htdocs/core/lib/functions.lib.php
+++ b/htdocs/core/lib/functions.lib.php
@@ -125,8 +125,18 @@ function getEntity($element=false, $shared=false)
/**
* Return information about user browser
*
+ * Returns array with the following format:
+ * array(
+ * 'browsername' => Browser name (firefox|chrome|iceweasel|epiphany|safari|opera|ie|unknown)
+ * 'browserversion' => Browser version. Empty if unknown
+ * 'browseros' => Set with mobile OS (android|blackberry|ios|palm|symbian|webos|maemo|windows|unknown)
+ * 'layout' => (tablet|phone|classic)
+ * 'phone' => empty if not mobile, (android|blackberry|ios|palm|unknown) if mobile
+ * 'tablet' => true/false
+ * )
+ *
* @param string $user_agent Content of $_SERVER["HTTP_USER_AGENT"] variable
- * @return array Array of information ('browsername'=>,'browseros'=>,'browserversion'=>,'layout'=>(classic|phone|tablet))
+ * @return array Check function documentation
*/
function getBrowserInfo($user_agent)
{
--
GitLab