Updating the contract and doc comments

ARCANEDEV · Feb 7, 2017 · 43bf2c3 · 43bf2c3
1 parent 1e4715e
commit 43bf2c3
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 0 deletions.
diff --git a/src/Agent.php b/src/Agent.php
@@ -141,6 +141,13 @@ public function getRules()
             : parent::getRules();
     }
 
+    /**
+     * Get the device name.
+     *
+     * @param  string|null  $userAgent
+     *
+     * @return string
+     */
     public function device($userAgent = null)
     {
         // Get device rules
@@ -155,6 +162,8 @@ public function device($userAgent = null)
     }
 
     /**
+     * Get the browser name.
+     *
      * @param  string|null  $userAgent
      *
      * @return string
@@ -190,6 +199,8 @@ public function robot($userAgent = null)
     }
 
     /**
+     * Get the platform name.
+     *
      * @param  string|null  $userAgent
      *
      * @return string
@@ -206,6 +217,7 @@ public function platform($userAgent = null)
     }
 
     /**
+     * Get the languages.
      *
      * @param  string|null  $acceptLanguage
      *

diff --git a/src/Contracts/Agent.php b/src/Contracts/Agent.php
@@ -46,6 +46,51 @@ public function setHttpHeaders($httpHeaders = null);
      */
     public function version($propertyName, $type = Mobile_Detect::VERSION_TYPE_STRING);
 
+    /**
+     * Get the device name.
+     *
+     * @param  string|null  $userAgent
+     *
+     * @return string
+     */
+    public function device($userAgent = null);
+
+    /**
+     * Get the browser name.
+     *
+     * @param  string|null  $userAgent
+     *
+     * @return string
+     */
+    public function browser($userAgent = null);
+
+    /**
+     * Get the robot name.
+     *
+     * @param  string|null  $userAgent
+     *
+     * @return string
+     */
+    public function robot($userAgent = null);
+
+    /**
+     * Get the platform name.
+     *
+     * @param  string|null  $userAgent
+     *
+     * @return string
+     */
+    public function platform($userAgent = null);
+
+    /**
+     * Get the languages.
+     *
+     * @param  string|null  $acceptLanguage
+     *
+     * @return array
+     */
+    public function languages($acceptLanguage = null);
+
     /**
      * Check if the device is mobile.
      * Returns true if any type of mobile device detected, including special ones