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()
     {

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/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'];

classes/external/php/persist-admin-notices-dismissal/persist-admin-notices-dismissal.php

Indentation +122 added lines, -122 removed lines

@@ -29,131 +29,131 @@
  * Exit if called directly.
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	die;
+    die;
 }
 
 if ( ! class_exists( 'PAnD' ) ) {
 
-	/**
-	 * Class PAnD
-	 */
-	class PAnD {
-
-		/**
-		 * Init hooks.
-		 */
-		public static function init() {
-			add_action( 'admin_enqueue_scripts', array( __CLASS__, 'load_script' ) );
-			add_action( 'wp_ajax_dismiss_admin_notice', array( __CLASS__, 'dismiss_admin_notice' ) );
-		}
-
-		/**
-		 * Enqueue javascript and variables.
-		 */
-		public static function load_script() {
-
-			if ( is_customize_preview() ) {
-				return;
-			}
-
-			wp_enqueue_script(
-				'dismissible-notices',
-				plugins_url( 'dismiss-notice.js', __FILE__ ),
-				array( 'jquery', 'common' ),
-				false,
-				true
-			);
-
-			wp_localize_script(
-				'dismissible-notices',
-				'dismissible_notice',
-				array(
-					'nonce' => wp_create_nonce( 'dismissible-notice' ),
-				)
-			);
-		}
-
-		/**
-		 * Handles Ajax request to persist notices dismissal.
-		 * Uses check_ajax_referer to verify nonce.
-		 */
-		public static function dismiss_admin_notice() {
-			$option_name        = sanitize_text_field( $_POST['option_name'] );
-			$dismissible_length = sanitize_text_field( $_POST['dismissible_length'] );
-
-			if ( 'forever' != $dismissible_length ) {
-				// If $dismissible_length is not an integer default to 1
-				$dismissible_length = ( 0 == absint( $dismissible_length ) ) ? 1 : $dismissible_length;
-				$dismissible_length = strtotime( absint( $dismissible_length ) . ' days' );
-			}
-
-			check_ajax_referer( 'dismissible-notice', 'nonce' );
-			self::set_admin_notice_cache( $option_name, $dismissible_length );
-			wp_die();
-		}
-
-		/**
-		 * Is admin notice active?
-		 *
-		 * @param string $arg data-dismissible content of notice.
-		 *
-		 * @return bool
-		 */
-		public static function is_admin_notice_active( $arg ) {
-			$array       = explode( '-', $arg );
-			$length      = array_pop( $array );
-			$option_name = implode( '-', $array );
-			$db_record   = self::get_admin_notice_cache( $option_name );
-			if ( 'forever' == $db_record ) {
-				return false;
-			} elseif ( absint( $db_record ) >= time() ) {
-				return false;
-			} else {
-				return true;
-			}
-		}
-
-		/**
-		 * Returns admin notice cached timeout.
-		 *
-		 * @access public
-		 *
-		 * @param string|bool $id admin notice name or false.
-		 *
-		 * @return array|bool The timeout. False if expired.
-		 */
-		public static function get_admin_notice_cache( $id = false ) {
-			if ( ! $id ) {
-				return false;
-			}
-			$cache_key = 'pand-' . md5( $id );
-			$timeout   = get_site_option( $cache_key );
-			$timeout   = 'forever' === $timeout ? time() + 60 : $timeout;
-
-			if ( empty( $timeout ) || time() > $timeout ) {
-				return false;
-			}
-
-			return $timeout;
-		}
-
-		/**
-		 * Sets admin notice timeout in site option.
-		 *
-		 * @access public
-		 *
-		 * @param string      $id       Data Identifier.
-		 * @param string|bool $timeout  Timeout for admin notice.
-		 *
-		 * @return bool
-		 */
-		public static function set_admin_notice_cache( $id, $timeout ) {
-			$cache_key = 'pand-' . md5( $id );
-			update_site_option( $cache_key, $timeout );
-
-			return true;
-		}
-
-	}
+    /**
+     * Class PAnD
+     */
+    class PAnD {
+
+        /**
+         * Init hooks.
+         */
+        public static function init() {
+            add_action( 'admin_enqueue_scripts', array( __CLASS__, 'load_script' ) );
+            add_action( 'wp_ajax_dismiss_admin_notice', array( __CLASS__, 'dismiss_admin_notice' ) );
+        }
+
+        /**
+         * Enqueue javascript and variables.
+         */
+        public static function load_script() {
+
+            if ( is_customize_preview() ) {
+                return;
+            }
+
+            wp_enqueue_script(
+                'dismissible-notices',
+                plugins_url( 'dismiss-notice.js', __FILE__ ),
+                array( 'jquery', 'common' ),
+                false,
+                true
+            );
+
+            wp_localize_script(
+                'dismissible-notices',
+                'dismissible_notice',
+                array(
+                    'nonce' => wp_create_nonce( 'dismissible-notice' ),
+                )
+            );
+        }
+
+        /**
+         * Handles Ajax request to persist notices dismissal.
+         * Uses check_ajax_referer to verify nonce.
+         */
+        public static function dismiss_admin_notice() {
+            $option_name        = sanitize_text_field( $_POST['option_name'] );
+            $dismissible_length = sanitize_text_field( $_POST['dismissible_length'] );
+
+            if ( 'forever' != $dismissible_length ) {
+                // If $dismissible_length is not an integer default to 1
+                $dismissible_length = ( 0 == absint( $dismissible_length ) ) ? 1 : $dismissible_length;
+                $dismissible_length = strtotime( absint( $dismissible_length ) . ' days' );
+            }
+
+            check_ajax_referer( 'dismissible-notice', 'nonce' );
+            self::set_admin_notice_cache( $option_name, $dismissible_length );
+            wp_die();
+        }
+
+        /**
+         * Is admin notice active?
+         *
+         * @param string $arg data-dismissible content of notice.
+         *
+         * @return bool
+         */
+        public static function is_admin_notice_active( $arg ) {
+            $array       = explode( '-', $arg );
+            $length      = array_pop( $array );
+            $option_name = implode( '-', $array );
+            $db_record   = self::get_admin_notice_cache( $option_name );
+            if ( 'forever' == $db_record ) {
+                return false;
+            } elseif ( absint( $db_record ) >= time() ) {
+                return false;
+            } else {
+                return true;
+            }
+        }
+
+        /**
+         * Returns admin notice cached timeout.
+         *
+         * @access public
+         *
+         * @param string|bool $id admin notice name or false.
+         *
+         * @return array|bool The timeout. False if expired.
+         */
+        public static function get_admin_notice_cache( $id = false ) {
+            if ( ! $id ) {
+                return false;
+            }
+            $cache_key = 'pand-' . md5( $id );
+            $timeout   = get_site_option( $cache_key );
+            $timeout   = 'forever' === $timeout ? time() + 60 : $timeout;
+
+            if ( empty( $timeout ) || time() > $timeout ) {
+                return false;
+            }
+
+            return $timeout;
+        }
+
+        /**
+         * Sets admin notice timeout in site option.
+         *
+         * @access public
+         *
+         * @param string      $id       Data Identifier.
+         * @param string|bool $timeout  Timeout for admin notice.
+         *
+         * @return bool
+         */
+        public static function set_admin_notice_cache( $id, $timeout ) {
+            $cache_key = 'pand-' . md5( $id );
+            update_site_option( $cache_key, $timeout );
+
+            return true;
+        }
+
+    }
 
 }

classes/autoptimizeConfig.php

Doc Comments +6 added lines

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

classes/autoptimizeImages.php

Doc Comments +10 added lines, -1 removed lines

@@ -370,6 +370,9 @@ 
         }
     }
 
+    /**
+     * @return string
+     */
     private function get_imgopt_base_url()
     {
         static $imgopt_base_url = null;
@@ -718,6 +721,9 @@ 
         return $out;
     }
 
+    /**
+     * @param string $tag
+     */
     public function add_lazyload( $tag, $placeholder = '' ) {
         // adds actual lazyload-attributes to an image node.
         if ( str_ireplace( $this->get_lazyload_exclusions(), '', $tag ) === $tag ) {
@@ -897,6 +903,9 @@ 
         return $out;
     }
 
+    /**
+     * @return string
+     */
     public function process_bgimage( $in ) {
         if ( strpos( $in, 'background-image:' ) !== false && apply_filters( 'autoptimize_filter_imgopt_lazyload_backgroundimages', true ) ) {
             $out = preg_replace_callback(
@@ -1239,7 +1248,7 @@ 
     /**
      * Determines and returns the service launch status.
      *
-     * @return bool
+     * @return null|boolean
      */
     public function launch_ok()
     {

classes/autoptimizeMain.php

Doc Comments +1 added lines, -1 removed lines

@@ -296,7 +296,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 static function should_buffer( $doing_tests = false )
     {