futtta / autoptimize

classes/autoptimizeBase.php

Doc Comments +3 added lines, -3 removed lines

@@ -64,7 +64,7 @@ 
      *
      * @param string $url URL to transform.
      *
-     * @return bool|string
+     * @return false|string
      */
     public function getpath( $url )
     {
@@ -610,7 +610,7 @@ 
     /**
      * Logs given `$data` for debugging purposes (when debug logging is on).
      *
-     * @param mixed $data Data to log.
+     * @param string $data Data to log.
      *
      * @return void
      */
@@ -632,7 +632,7 @@ 
      *
      * @param string $filepath Filepath.
      *
-     * @return bool|string to be minified code or false.
+     * @return false|string to be minified code or false.
      */
     protected function prepare_minify_single( $filepath )
     {

Indentation +1 added lines, -1 removed lines

@@ -412,7 +412,7 @@
          * First element is the filepath, second is the md5 hash of contents
          * the filepath had when it was being processed.
          * If we don't have those, we'll bail out early.
-        */
+         */
         $filepath = null;
         $filehash = null;
 

classes/autoptimizeCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -434,7 +434,7 @@
      * size = total filesize (in bytes) of found files
      * timestamp = unix timestamp when the scan was last performed/finished.
      *
-     * @return array
+     * @return integer[]
      */
     protected static function stats_scan()
     {

classes/autoptimizeConfig.php

Doc Comments +6 added lines

@@ -752,6 +752,9 @@ 
         return $preload_onload;
     }
 
+    /**
+     * @param string $key
+     */
     public function get($key)
     {
         if ( ! is_array( $this->config ) ) {
@@ -778,6 +781,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $url
+     */
     private function getFutttaFeeds($url) {
         if ( $this->settings_screen_do_remote_http ) {
             $rss = fetch_feed( $url );

classes/autoptimizeMain.php

Doc Comments +1 added lines, -1 removed lines

@@ -253,7 +253,7 @@
      *
      * @param bool $doing_tests Allows overriding the optimization of only
      *                          deciding once per request (for use in tests).
-     * @return bool
+     * @return boolean|null
      */
     public function should_buffer( $doing_tests = false )
     {

classes/autoptimizeScripts.php

Doc Comments +9 added lines, -1 removed lines

@@ -418,6 +418,10 @@ 
     }
 
     // Checks against the white- and blacklists
+
+    /**
+     * @param string $tag
+     */
     private function ismergeable($tag)
     {
         if ( ! $this->aggregate ) {
@@ -457,6 +461,10 @@ 
     }
 
     // Checks agains the blacklist
+
+    /**
+     * @param string $tag
+     */
     private function ismovable($tag)
     {
         if ( true !== $this->include_inline || apply_filters( 'autoptimize_filter_js_unmovable', true ) ) {
@@ -538,7 +546,7 @@ 
      * @param string $filepath Filepath.
      * @param bool $cache_miss Optional. Force a cache miss. Default false.
      *
-     * @return bool|string Url pointing to the minified js file or false.
+     * @return false|string Url pointing to the minified js file or false.
      */
     public function minify_single( $filepath, $cache_miss = false )
     {

config/default.php

Indentation +42 added lines, -42 removed lines

@@ -2,9 +2,9 @@ 
 
 //Check everything exists before using it
 if(!isset($_SERVER['HTTP_ACCEPT_ENCODING']))
-	$_SERVER['HTTP_ACCEPT_ENCODING'] = '';
+    $_SERVER['HTTP_ACCEPT_ENCODING'] = '';
 if(!isset($_SERVER['HTTP_USER_AGENT']))
-	$_SERVER['HTTP_USER_AGENT'] = '';
+    $_SERVER['HTTP_USER_AGENT'] = '';
 
 // Determine supported compression method
 $gzip = strstr($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip');
@@ -15,30 +15,30 @@ 
 
 // Check for buggy versions of Internet Explorer
 if (!strstr($_SERVER['HTTP_USER_AGENT'], 'Opera') &&
-	preg_match('/^Mozilla\/4\.0 \(compatible; MSIE ([0-9]\.[0-9])/i', $_SERVER['HTTP_USER_AGENT'], $matches))
+    preg_match('/^Mozilla\/4\.0 \(compatible; MSIE ([0-9]\.[0-9])/i', $_SERVER['HTTP_USER_AGENT'], $matches))
 {
-	$version = floatval($matches[1]);
+    $version = floatval($matches[1]);
 
-	if ($version < 6)
-		$encoding = 'none';
+    if ($version < 6)
+        $encoding = 'none';
 
-	if ($version == 6 && !strstr($_SERVER['HTTP_USER_AGENT'], 'EV1'))
-		$encoding = 'none';
+    if ($version == 6 && !strstr($_SERVER['HTTP_USER_AGENT'], 'EV1'))
+        $encoding = 'none';
 }
 
 //Some servers compress the output of PHP - Don't break in those cases
 if(ini_get('output_handler') == 'ob_gzhandler' || ini_get('zlib.output_compression') == 1)
-	$encoding = 'none';
+    $encoding = 'none';
 
 $iscompressed = file_exists(__FILE__.'.'.$encoding);
 if($encoding != 'none' && $iscompressed == false)
 {
-	$flag = ($encoding == 'gzip' ? FORCE_GZIP : FORCE_DEFLATE);
-	$code = file_get_contents(__FILE__.'.none');
-	$contents = gzencode($code,9,$flag);
+    $flag = ($encoding == 'gzip' ? FORCE_GZIP : FORCE_DEFLATE);
+    $code = file_get_contents(__FILE__.'.none');
+    $contents = gzencode($code,9,$flag);
 }else{
-	//Get data
-	$contents = file_get_contents(__FILE__.'.'.$encoding);
+    //Get data
+    $contents = file_get_contents(__FILE__.'.'.$encoding);
 }
 
 // first check if we have to send 304
@@ -52,36 +52,36 @@ 
 $modTimeMatch = (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) === $modTime);
 
 if (($modTimeMatch)||($eTagMatch)) {
-	header('HTTP/1.1 304 Not Modified');
-	header('Connection: close');
+    header('HTTP/1.1 304 Not Modified');
+    header('Connection: close');
 } else {
-	// send all sorts of headers
-	$expireTime=60*60*24*355; // 1y max according to RFC
-	if ($encoding != 'none') {
-		header('Content-Encoding: '.$encoding);
-	}
-	header('Vary: Accept-Encoding');
-	header('Content-Length: '.strlen($contents));
-	header('Content-type: %%CONTENT%%; charset=utf-8');
-	header('Cache-Control: max-age='.$expireTime.', public, must-revalidate');
-	header('Cache-Control: max-age='.$expireTime.', public, immutable');
-	header('Expires: '.gmdate('D, d M Y H:i:s', time() + $expireTime).' GMT');
-	header('ETag: ' . $eTag);
-	header('Last-Modified: '.gmdate('D, d M Y H:i:s', $modTime).' GMT');
+    // send all sorts of headers
+    $expireTime=60*60*24*355; // 1y max according to RFC
+    if ($encoding != 'none') {
+        header('Content-Encoding: '.$encoding);
+    }
+    header('Vary: Accept-Encoding');
+    header('Content-Length: '.strlen($contents));
+    header('Content-type: %%CONTENT%%; charset=utf-8');
+    header('Cache-Control: max-age='.$expireTime.', public, must-revalidate');
+    header('Cache-Control: max-age='.$expireTime.', public, immutable');
+    header('Expires: '.gmdate('D, d M Y H:i:s', time() + $expireTime).' GMT');
+    header('ETag: ' . $eTag);
+    header('Last-Modified: '.gmdate('D, d M Y H:i:s', $modTime).' GMT');
 
-	// send output
-	echo $contents;
+    // send output
+    echo $contents;
 
-	//And write to filesystem cache if not done yet
-	if($encoding != 'none' && $iscompressed == false)
-	{
-		//Write the content we sent
-		file_put_contents(__FILE__.'.'.$encoding,$contents);
+    //And write to filesystem cache if not done yet
+    if($encoding != 'none' && $iscompressed == false)
+    {
+        //Write the content we sent
+        file_put_contents(__FILE__.'.'.$encoding,$contents);
 
-		//And write the new content
-		$flag = ($encoding == 'gzip' ? FORCE_DEFLATE : FORCE_GZIP);
-		$ext = ($encoding == 'gzip' ? 'deflate' : 'gzip');
-		$contents = gzencode($code,9,$flag);
-		file_put_contents(__FILE__.'.'.$ext,$contents);
-	}
+        //And write the new content
+        $flag = ($encoding == 'gzip' ? FORCE_DEFLATE : FORCE_GZIP);
+        $ext = ($encoding == 'gzip' ? 'deflate' : 'gzip');
+        $contents = gzencode($code,9,$flag);
+        file_put_contents(__FILE__.'.'.$ext,$contents);
+    }
 }

classes/autoptimizeStyles.php

Doc Comments +19 added lines, -2 removed lines

@@ -282,7 +282,7 @@ 
      * be inlined into a data: URI. Defaults to 4096, passed through
      * `autoptimize_filter_css_datauri_maxsize` filter.
      *
-     * @return mixed
+     * @return integer|null
      */
     private function get_datauri_maxsize()
     {
@@ -303,6 +303,9 @@ 
         return $max_size;
     }
 
+    /**
+     * @param false|string $url
+     */
     private function check_datauri_exclude_list( $url )
     {
         static $exclude_list = null;
@@ -328,6 +331,9 @@ 
         return $matched;
     }
 
+    /**
+     * @param false|string $path
+     */
     private function build_or_get_datauri_image( $path )
     {
         /**
@@ -746,6 +752,11 @@ 
         return true;
     }
 
+    /**
+     * @param string $code
+     *
+     * @return string
+     */
     public function run_minifier_on( $code )
     {
         if ( ! $this->alreadyminified ) {
@@ -945,6 +956,9 @@ 
         return $code;
     }
 
+    /**
+     * @param string $tag
+     */
     private function ismovable( $tag )
     {
         if ( ! $this->aggregate ) {
@@ -1005,7 +1019,7 @@ 
      * @param string $filepath Filepath.
      * @param bool   $cache_miss Optional. Force a cache miss. Default false.
      *
-     * @return bool|string Url pointing to the minified css file or false.
+     * @return false|string Url pointing to the minified css file or false.
      */
     public function minify_single( $filepath, $cache_miss = false )
     {
@@ -1057,6 +1071,9 @@ 
         $this->options = $options;
     }
 
+    /**
+     * @param string $name
+     */
     public function setOption( $name, $value )
     {
         $this->options[$name] = $value;

classes/autoptimizeUtils.php

Doc Comments +2 added lines, -2 removed lines

@@ -14,7 +14,7 @@ 
      *
      * @param bool|null $override Allows overriding the decision.
      *
-     * @return bool
+     * @return boolean|null
      */
     public static function mbstring_available( $override = null )
     {
@@ -130,7 +130,7 @@ 
      *
      * @param bool $override Allows overriding the decision when needed.
      *
-     * @return bool
+     * @return boolean|null
      */
     public static function siteurl_not_root( $override = null )
     {

tests/test-ao.php

Doc Comments +3 added lines

@@ -128,6 +128,9 @@
         parent::tearDown();
     }
 
+    /**
+     * @return string
+     */
     protected function get_test_markup()
     {
         $siteurl = $this->get_urls()['siteurl'];