eyecatchup / SEOstats

SEOstats/Common/AutoLoader.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
     /**
      * Try to load a class
      *
-     * @param string $class The class name to load
+     * @param string $className The class name to load
      *
      * @return boolean If the loading was successful
      */

SEOstats/Helper/Json.php

Doc Comments -1 removed lines

@@ -17,7 +17,6 @@
     * Decodes a JSON string into appropriate variable.
     *
     * @param    string  $str    JSON-formatted string
-    * @param    boolean $accos  When true, returned objects will be converted into associative arrays.
     * @return   mixed   number, boolean, string, array, or object corresponding to given JSON input string.
     *                   Note that decode() always returns strings in ASCII or UTF-8 format!
     */

SEOstats/Services/Google.php

Doc Comments -1 removed lines

@@ -122,7 +122,6 @@
      * Returns array, containing detailed results for any Google search.
      *
      * @param     string    $query  String, containing the search query.
-     * @param     string    $tld    String, containing the desired Google top level domain.
      * @return    array             Returns array, containing the keys 'URL', 'Title' and 'Description'.
      */
     public static function getSerps($query, $maxResults=100, $domain=false)

SEOstats/Services/Google/Search.php

Doc Comments +18 added lines, -1 removed lines

@@ -23,7 +23,6 @@ 
      * Returns array, containing detailed results for any Google search.
      *
      * @param     string    $query  String, containing the search query.
-     * @param     string    $tld    String, containing the desired Google top level domain.
      * @return    array             Returns array, containing the keys 'URL', 'Title' and 'Description'.
      */
     public static function getSerps($query, $maxResults=100, $domain=false)
@@ -55,6 +54,11 @@ 
         return $result->toArray();
     }
 
+    /**
+     * @param integer $start
+     * @param string $query
+     * @param Helper\ArrayHandle $result
+     */
     protected static function makeRequest ($start, $query, $result, $domainRexExp)
     {
         $ref = static::getReference($start, $query);
@@ -90,6 +94,9 @@ 
             : sprintf('search?q=%s&hl=en&prmd=imvns&start=%s0&sa=N', $query, $start);
     }
 
+    /**
+     * @param boolean $domain
+     */
     protected static function getDomainFilter ($domain)
     {
         return $domain
@@ -104,6 +111,9 @@ 
             : sprintf('search?q=%s&filter=0&start=%s0', $query, $start);
     }
 
+    /**
+     * @param string $response
+     */
     protected static function guardNoCaptcha ($response)
     {
         if (preg_match("#answer[=|/]86640#i", $response)) {
@@ -146,11 +156,18 @@ 
             : $match;
     }
 
+    /**
+     * @param string $url
+     */
     protected static function isAGoogleWebmasterLink($url)
     {
         return preg_match('#^https?://www.google.com/(?:intl/.+/)?webmasters#', $url);
     }
 
+    /**
+     * @param string $path
+     * @param string $ref
+     */
     protected static function gCurl($path, $ref, $useCookie = Config\DefaultSettings::ALLOW_GOOGLE_COOKIES)
     {
         $url = sprintf('https://www.google.%s/', Config\DefaultSettings::GOOGLE_TLD);

Unused Use Statements -1 removed lines

@@ -11,7 +11,6 @@
  * @updated    2013/12/17
  */
 
-use SEOstats\Common\SEOstatsException as E;
 use SEOstats\SEOstats as SEOstats;
 use SEOstats\Config as Config;
 use SEOstats\Helper as Helper;

SEOstats/Services/Mozscape.php

Doc Comments +6 added lines

@@ -102,6 +102,9 @@ 
                 : Helper\Json::decode($ret, true);
     }
 
+    /**
+     * @param integer $expires
+     */
     private static function _getUrlSafeSignature($expires)
     {
         $data = Config\ApiKeys::MOZSCAPE_ACCESS_ID . "\n{$expires}";
@@ -110,6 +113,9 @@ 
         return base64_encode($sig);
     }
 
+    /**
+     * @param string $data
+     */
     private static function _hmacsha1($data, $key)
     {
         // Use PHP's built in functionality if available

SEOstats/Services/SemRush.php

Doc Comments +21 added lines

@@ -120,6 +120,9 @@ 
         }
     }
 
+    /**
+     * @param string $url
+     */
     protected static function getApiData($url)
     {
         $json = static::_getPage($url);
@@ -147,6 +150,12 @@ 
         }
     }
 
+    /**
+     * @param integer $reportType
+     * @param integer $width
+     * @param integer $height
+     * @param string $lang
+     */
     protected static function guardValidArgsForGetDomainGraph($reportType, $width, $height, $lang)
     {
         if ($reportType > 5 || $reportType < 1) {
@@ -166,6 +175,11 @@ 
         }
     }
 
+    /**
+     * @param string|boolean $url
+     * @param string|boolean $db
+     * @param string $reportType
+     */
     protected static function getBackendData($url, $db, $reportType)
     {
         $db      = false !== $db ? $db : Config\DefaultSettings::SEMRUSH_DB;
@@ -200,6 +214,12 @@ 
         return sprintf($widgetUrl, $reportType, $database, $domain);
     }
 
+    /**
+     * @param boolean $url
+     * @param boolean $db
+     * @param string $reportType
+     * @param string $valueKey
+     */
     protected static function getWidgetData($url, $db, $reportType, $valueKey)
     {
         $db      = false !== $db ? $db : Config\DefaultSettings::SEMRUSH_DB;
@@ -217,6 +237,7 @@ 
     /**
      *
      * @throws E
+     * @param string $err
      */
     protected static function exc($err)
     {

SEOstats/Services/Sistrix.php

Doc Comments +13 added lines

@@ -136,6 +136,11 @@ 
         return !in_array($db, self::getDBs()) ? false : $db;
     }
 
+    /**
+     * @param string $url
+     *
+     * @return string
+     */
     protected static function getDomainFromUrl($url)
     {
         $url      = parent::getUrl($url);
@@ -145,6 +150,11 @@ 
         return $domain;
     }
 
+    /**
+     * @param boolean $db
+     *
+     * @return string
+     */
     protected static function getValidDatabase($db)
     {
         $db = ($db == false) ? Config\DefaultSettings::SISTRIX_DB : $db;
@@ -169,6 +179,9 @@ 
         }
     }
 
+    /**
+     * @param string $err
+     */
     private static function exc($err)
     {
         $e = ($err == 'db')

SEOstats/Helper/HttpRequest.php

Doc Comments +3 added lines, -1 removed lines

@@ -69,7 +69,6 @@ 
      * HTTP HEAD request with curl.
      *
      * @access        private
-     * @param         String        $a        The request URL
      * @return        Integer                 Returns the HTTP status code received in
      *                                        response to a GET request of the input URL.
      */
@@ -136,6 +135,9 @@ 
         return (bool)(false !== stat($file));
     }
 
+    /**
+     * @return resource
+     */
     public static function getUserAgent() {
         $ua = sprintf('SEOstats %s https://github.com/eyecatchup/SEOstats', \SEOstats\SEOstats::BUILD_NO);
         if(\SEOstats\Config\DefaultSettings::UA !== '') {

SEOstats/SEOstats.php

Doc Comments +9 added lines, -3 removed lines

@@ -152,6 +152,9 @@ 
         return $url;
     }
 
+    /**
+     * @param boolean $url
+     */
     public function setUrl($url)
     {
         if (false !== Helper\Url::isRfc($url)) {
@@ -165,6 +168,9 @@ 
         return true;
     }
 
+    /**
+     * @return string
+     */
     public static function getHost($url = false)
     {
         return Helper\Url::parseHost(self::getUrl($url));
@@ -176,7 +182,7 @@ 
     }
 
     /**
-     * @return DOMDocument
+     * @return \DOMDocument
      */
     protected static function _getDOMDocument($html) {
         $doc = new \DOMDocument;
@@ -185,7 +191,7 @@ 
     }
 
     /**
-     * @return DOMXPath
+     * @return \DOMXPath
      */
     protected static function _getDOMXPath($doc) {
         $xpath = new \DOMXPath($doc);
@@ -255,7 +261,7 @@ 
     }
 
     /**
-     * @return Useragent string
+     * @return boolean string
      */
     public static function getUserAgent()
     {