eventespresso / event-espresso-core

core/helpers/EEH_Template_Validator.helper.php

Indentation +148 added lines, -148 removed lines

@@ -29,152 +29,152 @@
 
 
 
-    /**
-     * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful in throwing intelligent errors
-     * @param string $class_name eg EE_Answer, EE_Transaction, etc.
-     * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
-     * @return void
-     * @throws EE_Error (indirectly)
-     */
-    public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ('allow_null' == $allow_null && is_null($variable_to_test)) {
-            return;
-        }
-        self::verify_is_array($variable_to_test, $name_of_variable);
-        foreach ($variable_to_test as $key => $array_element) {
-            self::verify_instanceof($array_element, $key, $class_name);
-        }
-    }
-
-
-
-
-
-    /**
-     * throws an EE_Error if $variable_to_test is null
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful for throwing intelligent errors
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_isnt_null($variable_to_test, $name_of_variable)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
-            $error[] = esc_html__('Variable named %s is null.', 'event_espresso');
-            $error[] = esc_html__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
-        }
-    }
-
-    /**
-     * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
-     * @param boolean $expression_to_test
-     * @param string $expression_string_representation a string representation of your expression
-     * for example, if your expression were $var1==23, then this should be '$var1==23'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_true($expression_to_test, $expression_string_representation)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!$expression_to_test) {
-            $error[] = esc_html__('Template error.', 'event_espresso');
-            $error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
-        }
-    }
-
-
-
-
-
-    /**
-     * For verifying that a variable is indeed an object of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful when throwing errors
-     * @param string $class_name eg, EE_Answer,
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
-            return;
-        }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
-            $msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
-            $msg[] = esc_html__("It should be of type %s", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
-        }
-    }
-
-
-
-
-
-    /**
-     * For verifying that a variable is indeed an array, else throw an EE_Error
-     * @param type $variable_to_test
-     * @param type $variable_name
-     * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
-        if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
-            return;
-        }
-        if (!is_array($variable_to_test)) {
-            $error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
-            $error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
-        }
-    }
-
-
-
-
-
-
-
-    /**
-     * for verifying that a variable is one of the string optiosn supplied
-     * @param mixed $variable_to_test
-     * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
-     * @param array $string_options an array of acceptable values
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!in_array($variable_to_test, $string_options)) {
-            $msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
-            $msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
-        }
-    }
+	/**
+	 * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful in throwing intelligent errors
+	 * @param string $class_name eg EE_Answer, EE_Transaction, etc.
+	 * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
+	 * @return void
+	 * @throws EE_Error (indirectly)
+	 */
+	public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ('allow_null' == $allow_null && is_null($variable_to_test)) {
+			return;
+		}
+		self::verify_is_array($variable_to_test, $name_of_variable);
+		foreach ($variable_to_test as $key => $array_element) {
+			self::verify_instanceof($array_element, $key, $class_name);
+		}
+	}
+
+
+
+
+
+	/**
+	 * throws an EE_Error if $variable_to_test is null
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful for throwing intelligent errors
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_isnt_null($variable_to_test, $name_of_variable)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
+			$error[] = esc_html__('Variable named %s is null.', 'event_espresso');
+			$error[] = esc_html__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
+		}
+	}
+
+	/**
+	 * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
+	 * @param boolean $expression_to_test
+	 * @param string $expression_string_representation a string representation of your expression
+	 * for example, if your expression were $var1==23, then this should be '$var1==23'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_true($expression_to_test, $expression_string_representation)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!$expression_to_test) {
+			$error[] = esc_html__('Template error.', 'event_espresso');
+			$error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
+		}
+	}
+
+
+
+
+
+	/**
+	 * For verifying that a variable is indeed an object of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful when throwing errors
+	 * @param string $class_name eg, EE_Answer,
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
+			return;
+		}
+		if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
+			$msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
+			$msg[] = esc_html__("It should be of type %s", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
+		}
+	}
+
+
+
+
+
+	/**
+	 * For verifying that a variable is indeed an array, else throw an EE_Error
+	 * @param type $variable_to_test
+	 * @param type $variable_name
+	 * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
+		if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
+			return;
+		}
+		if (!is_array($variable_to_test)) {
+			$error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
+			$error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
+		}
+	}
+
+
+
+
+
+
+
+	/**
+	 * for verifying that a variable is one of the string optiosn supplied
+	 * @param mixed $variable_to_test
+	 * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
+	 * @param array $string_options an array of acceptable values
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!in_array($variable_to_test, $string_options)) {
+			$msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
+			$msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
+		}
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -40,10 +40,10 @@ 
      */
     public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ('allow_null' == $allow_null && is_null($variable_to_test)) {
             return;
         }
@@ -66,7 +66,7 @@ 
      */
     public static function verify_isnt_null($variable_to_test, $name_of_variable)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
         if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
@@ -86,10 +86,10 @@ 
      */
     public static function verify_is_true($expression_to_test, $expression_string_representation)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!$expression_to_test) {
+        if ( ! $expression_to_test) {
             $error[] = esc_html__('Template error.', 'event_espresso');
             $error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
@@ -110,14 +110,14 @@ 
      */
     public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
             return;
         }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
+        if ($variable_to_test == null || ! ($variable_to_test instanceof $class_name)) {
             $msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
             $msg[] = esc_html__("It should be of type %s", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
@@ -138,14 +138,14 @@ 
      */
     public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
+        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty', 'do_not_allow_empty'));
         if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
             return;
         }
-        if (!is_array($variable_to_test)) {
+        if ( ! is_array($variable_to_test)) {
             $error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
             $error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
@@ -168,10 +168,10 @@ 
      */
     public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!in_array($variable_to_test, $string_options)) {
+        if ( ! in_array($variable_to_test, $string_options)) {
             $msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
             $msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));

core/helpers/EEH_File.helper.php

Indentation +666 added lines, -666 removed lines

@@ -25,670 +25,670 @@
 class EEH_File extends EEH_Base implements EEHI_File
 {
 
-    /**
-     * @var string $_credentials_form
-     */
-    private static $_credentials_form;
-
-    protected static $_wp_filesystem_direct;
-
-    /**
-     * @param string|null $filepath the filepath we want to work in. If its in the
-     * wp uploads directory, we'll want to just use the filesystem directly.
-     * If not provided, we have to assume its not in the uploads directory
-     * @throws EE_Error if filesystem credentials are required
-     * @return WP_Filesystem_Base
-     */
-    private static function _get_wp_filesystem($filepath = null)
-    {
-        if (
-            apply_filters(
-                'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct',
-                $filepath && EEH_File::is_in_uploads_folder($filepath),
-                $filepath
-            )
-        ) {
-            if (! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
-                require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
-                $method = 'direct';
-                $wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method);
-                // check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem()
-                if (! defined('FS_CHMOD_DIR')) {
-                    define('FS_CHMOD_DIR', ( fileperms(ABSPATH) & 0777 | 0755 ));
-                }
-                if (! defined('FS_CHMOD_FILE')) {
-                    define('FS_CHMOD_FILE', ( fileperms(ABSPATH . 'index.php') & 0777 | 0644 ));
-                }
-                require_once($wp_filesystem_direct_file);
-                EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array());
-            }
-            return EEH_File::$_wp_filesystem_direct;
-        }
-        global $wp_filesystem;
-        // no filesystem setup ???
-        if (! $wp_filesystem instanceof WP_Filesystem_Base) {
-            // if some eager beaver's just trying to get in there too early...
-            // let them do it, because we are one of those eager beavers! :P
-            /**
-             * more explanations are probably merited. http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base
-             * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process
-             * is setup to mostly happen on 'init', and refactoring to have it happen on
-             * 'wp_loaded' is too much work on a BETA milestone.
-             * So this fix is expected to work if the WP files are owned by the server user,
-             * but probably not if the user needs to enter their FTP credentials to modify files
-             * and there may be troubles if the WP files are owned by a different user
-             * than the server user. But both of these issues should exist in 4.4 and earlier too
-             */
-            if (false && ! did_action('wp_loaded')) {
-                $msg = esc_html__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso');
-                if (WP_DEBUG) {
-                    $msg .= '<br />' .  esc_html__('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
-                }
-                throw new EE_Error($msg);
-            } else {
-                // should be loaded if we are past the wp_loaded hook...
-                if (! function_exists('WP_Filesystem')) {
-                    require_once(ABSPATH . 'wp-admin/includes/file.php');
-                    require_once(ABSPATH . 'wp-admin/includes/template.php');
-                }
-                // turn on output buffering so that we can capture the credentials form
-                ob_start();
-                $credentials = request_filesystem_credentials('');
-                // store credentials form for the time being
-                EEH_File::$_credentials_form = ob_get_clean();
-                // basically check for direct or previously configured access
-                if (! WP_Filesystem($credentials)) {
-                    // if credentials do NOT exist
-                    if ($credentials === false) {
-                        add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
-                        throw new EE_Error(esc_html__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
-                    } elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) {
-                        add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__('WP Filesystem Error: $1%s', 'event_espresso'),
-                                $wp_filesystem->errors->get_error_message()
-                            )
-                        );
-                    }
-                }
-            }
-        }
-        return $wp_filesystem;
-    }
-
-    /**
-     * display_request_filesystem_credentials_form
-     */
-    public static function display_request_filesystem_credentials_form()
-    {
-        if (! empty(EEH_File::$_credentials_form)) {
-            echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
-        }
-    }
-
-
-
-    /**
-     *    verify_filepath_and_permissions
-     *    checks that a file is readable and has sufficient file permissions set to access
-     *
-     * @access public
-     * @param string $full_file_path - full server path to the folder or file
-     * @param string $file_name      - name of file if checking a file
-     * @param string $file_ext       - file extension (ie: "php") if checking a file
-     * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function verify_filepath_and_permissions($full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '')
-    {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-            $file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name;
-            $file_name .= ! empty($file_ext) ? ' file' : ' folder';
-            $msg = sprintf(
-                esc_html__('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'),
-                $file_name,
-                '<br />'
-            );
-            if (EEH_File::exists($full_file_path)) {
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file);
-            } else {
-                // no file permissions means the file was not found
-                $msg .= sprintf(
-                    esc_html__('Please ensure the following path is correct: "%s".', 'event_espresso'),
-                    $full_file_path
-                );
-            }
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                throw new EE_Error($msg . '||' . $msg);
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a file or folder
-     *
-     * @access private
-     * @param string $full_file_path - full server path to the folder or file
-     * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages
-     * @throws EE_Error if filesystem credentials are required
-     * @return string
-     */
-    private static function _permissions_error_for_unreadable_filepath($full_file_path = '', $type_of_file = '')
-    {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        // check file permissions
-        $perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
-        if ($perms) {
-            // file permissions exist, but way be set incorrectly
-            $type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : '';
-            $type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
-            return sprintf(
-                esc_html__('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'),
-                $type_of_file,
-                $perms
-            );
-        } else {
-            // file exists but file permissions could not be read ?!?!
-            return sprintf(
-                esc_html__('Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso'),
-                $full_file_path
-            );
-        }
-    }
-
-
-
-    /**
-     * ensure_folder_exists_and_is_writable
-     * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
-     * Also ensures all the parent folders exist, and if not tries to create them.
-     * Also, if this function creates the folder, adds a .htaccess file and index.html file
-     * @param string $folder
-     * @throws EE_Error if the folder exists and is writeable, but for some reason we
-     * can't write to it
-     * @return bool false if folder isn't writable; true if it exists and is writeable,
-     */
-    public static function ensure_folder_exists_and_is_writable($folder = '')
-    {
-        if (empty($folder)) {
-            return false;
-        }
-        // remove ending /
-        $folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
-        $parent_folder = EEH_File::get_parent_folder($folder);
-        // add / to folder
-        $folder = EEH_File::end_with_directory_separator($folder);
-        $wp_filesystem = EEH_File::_get_wp_filesystem($folder);
-        if (! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
-            // ok so it doesn't exist. Does its parent? Can we write to it?
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
-                return false;
-            }
-            if (! EEH_File::verify_is_writable($parent_folder, 'folder')) {
-                return false;
-            } else {
-                if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
-                    if (defined('WP_DEBUG') && WP_DEBUG) {
-                        $msg = sprintf(esc_html__('"%s" could not be created.', 'event_espresso'), $folder);
-                        $msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
-                        throw new EE_Error($msg);
-                    }
-                    return false;
-                }
-                EEH_File::add_index_file($folder);
-            }
-        } elseif (! EEH_File::verify_is_writable($folder, 'folder')) {
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * verify_is_writable - checks if a file or folder is writable
-     * @param string $full_path      - full server path to file or folder
-     * @param string $file_or_folder - whether checking a file or folder
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function verify_is_writable($full_path = '', $file_or_folder = 'folder')
-    {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
-        $full_path = EEH_File::standardise_directory_separators($full_path);
-        if (! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(esc_html__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * ensure_file_exists_and_is_writable
-     * ensures that a file exists and is writable, will attempt to create file if it does not exist.
-     * Also ensures all the parent folders exist, and if not tries to create them.
-     * @param string $full_file_path
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function ensure_file_exists_and_is_writable($full_file_path = '')
-    {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        $parent_folder = EEH_File::get_parent_folder($full_file_path);
-        if (! EEH_File::exists($full_file_path)) {
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
-                return false;
-            }
-            if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-                if (defined('WP_DEBUG') && WP_DEBUG) {
-                    $msg = sprintf(esc_html__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
-                    $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
-                    throw new EE_Error($msg);
-                }
-                return false;
-            }
-        }
-        if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * Gets the parent folder. If provided with file, gets the folder that contains it.
-     * If provided a folder, gets its parent folder.
-     * @param string $file_or_folder_path
-     * @return string parent folder, ENDING with a directory separator
-     */
-    public static function get_parent_folder($file_or_folder_path)
-    {
-        // find the last /, ignoring a / on the very end
-        // eg if given "/var/something/somewhere/", we want to get "somewhere"'s
-        // parent folder, "/var/something/"
-        $ds = strlen($file_or_folder_path) > 1
-            ? strrpos($file_or_folder_path, '/', -2)
-            : strlen($file_or_folder_path);
-        return substr($file_or_folder_path, 0, $ds + 1);
-    }
-
-    // public static function ensure_folder_exists_recursively( $folder ) {
-    //
-    // }
-
-
-
-    /**
-     * get_file_contents
-     * @param string $full_file_path
-     * @throws EE_Error if filesystem credentials are required
-     * @return string
-     */
-    public static function get_file_contents($full_file_path = '')
-    {
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        if (EEH_File::verify_filepath_and_permissions($full_file_path, EEH_File::get_filename_from_filepath($full_file_path), EEH_File::get_file_extension($full_file_path))) {
-            // load WP_Filesystem and set file permissions
-            $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-            return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
-        }
-        return '';
-    }
-
-
-
-    /**
-     * write_file
-     * @param string $full_file_path
-     * @param string $file_contents - the content to be written to the file
-     * @param string $file_type
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '')
-    {
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        $file_type = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : '';
-        $folder = EEH_File::remove_filename_from_filepath($full_file_path);
-        if (! EEH_File::verify_is_writable($folder, 'folder')) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(esc_html__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        // write the file
-        if (! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(esc_html__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * Wrapper for WP_Filesystem_Base::delete
-     *
-     * @param string $filepath
-     * @param boolean $recursive
-     * @param boolean|string $type 'd' for directory, 'f' for file
-     * @throws EE_Error if filesystem credentials are required
-     * @return boolean
-     */
-    public static function delete($filepath, $recursive = false, $type = false)
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem();
-        return $wp_filesystem->delete($filepath, $recursive, $type) ? true : false;
-    }
-
-
-
-    /**
-     * exists
-     * checks if a file exists using the WP filesystem
-     * @param string $full_file_path
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function exists($full_file_path = '')
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)) ? true : false;
-    }
-
-
-
-    /**
-     * is_readable
-     * checks if a file is_readable using the WP filesystem
-     *
-     * @param string $full_file_path
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function is_readable($full_file_path = '')
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        if ($wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * remove_filename_from_filepath
-     * given a full path to a file including the filename itself, this removes  the filename and returns the path, up to, but NOT including the filename OR slash
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function remove_filename_from_filepath($full_file_path = '')
-    {
-        return pathinfo($full_file_path, PATHINFO_DIRNAME);
-    }
-
-
-    /**
-     * get_filename_from_filepath. Arguably the same as basename()
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function get_filename_from_filepath($full_file_path = '')
-    {
-        return pathinfo($full_file_path, PATHINFO_BASENAME);
-    }
-
-
-    /**
-     * get_file_extension
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function get_file_extension($full_file_path = '')
-    {
-        return pathinfo($full_file_path, PATHINFO_EXTENSION);
-    }
-
-
-
-    /**
-     * add_htaccess_deny_from_all so the webserver cannot access this folder
-     * @param string $folder
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function add_htaccess_deny_from_all($folder = '')
-    {
-        $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . '.htaccess')) {
-            if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-     * Adds an index file to this folder, so folks can't list all the file's contents
-     * @param string $folder
-     * @throws EE_Error if filesystem credentials are required
-     * @return boolean
-     */
-    public static function add_index_file($folder)
-    {
-        $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . 'index.php')) {
-            if (! EEH_File::write_to_file($folder . 'index.php', 'You are not permitted to read from this folder', '.php')) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php),
-     * extract that classname.
-     * @param string $file_path
-     * @return string
-     */
-    public static function get_classname_from_filepath_with_standard_filename($file_path)
-    {
-        // extract file from path
-        $filename = basename($file_path);
-        // now remove the first period and everything after
-        $pos_of_first_period = strpos($filename, '.');
-        return substr($filename, 0, $pos_of_first_period);
-    }
-
-
-
-    /**
-     * standardise_directory_separators
-     *  convert all directory separators in a file path.
-     * @param string $file_path
-     * @return string
-     */
-    public static function standardise_directory_separators($file_path)
-    {
-        return str_replace(array( '\\', '/' ), '/', $file_path);
-    }
-
-
-
-    /**
-     * end_with_directory_separator
-     *  ensures that file path ends with '/'
-     * @param string $file_path
-     * @return string
-     */
-    public static function end_with_directory_separator($file_path)
-    {
-        return rtrim($file_path, '/\\') . '/';
-    }
-
-
-
-    /**
-     * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators
-     * @param $file_path
-     * @return string
-     */
-    public static function standardise_and_end_with_directory_separator($file_path)
-    {
-        return self::end_with_directory_separator(self::standardise_directory_separators($file_path));
-    }
-
-
-
-    /**
-     * takes the folder name (with or without trailing slash) and finds the files it in,
-     * and what the class's name inside of each should be.
-     * @param array $folder_paths
-     * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically;
-     *      if FALSE (Default), returned array will be indexed by the filenames minus extensions.
-     *      Set it TRUE if you know there are files in the directory with the same name but different extensions
-     * @throws EE_Error if filesystem credentials are required
-     * @return array if $index_numerically == TRUE keys are numeric ,
-     *      if $index_numerically == FALSE (Default) keys are what the class names SHOULD be;
-     *       and values are their filepaths
-     */
-    public static function get_contents_of_folders($folder_paths = array(), $index_numerically = false)
-    {
-        $class_to_folder_path = array();
-        foreach ($folder_paths as $folder_path) {
-            $folder_path = self::standardise_and_end_with_directory_separator($folder_path);
-            // load WP_Filesystem and set file permissions
-            $files_in_folder = glob($folder_path . '*.php');
-            $class_to_folder_path = array();
-            if ($files_in_folder) {
-                foreach ($files_in_folder as $file_path) {
-                    // only add files, not folders
-                    if (! is_dir($file_path)) {
-                        if ($index_numerically) {
-                            $class_to_folder_path[] = $file_path;
-                        } else {
-                            $classname = self::get_classname_from_filepath_with_standard_filename($file_path);
-                            $class_to_folder_path[ $classname ] = $file_path;
-                        }
-                    }
-                }
-            }
-        }
-        return $class_to_folder_path;
-    }
-
-
-
-    /**
-     * Copies a file. Mostly a wrapper of WP_Filesystem::copy
-     * @param string $source_file
-     * @param string $destination_file
-     * @param boolean $overwrite
-     * @throws EE_Error if filesystem credentials are required
-     * @return boolean success
-     */
-    public static function copy($source_file, $destination_file, $overwrite = false)
-    {
-        $full_source_path = EEH_File::standardise_directory_separators($source_file);
-        if (! EEH_File::exists($full_source_path)) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(esc_html__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-
-        $full_dest_path = EEH_File::standardise_directory_separators($destination_file);
-        $folder = EEH_File::remove_filename_from_filepath($full_dest_path);
-        EEH_File::ensure_folder_exists_and_is_writable($folder);
-        if (! EEH_File::verify_is_writable($folder, 'folder')) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(esc_html__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
-        // write the file
-        if (
-            ! $wp_filesystem->copy(
-                EEH_File::convert_local_filepath_to_remote_filepath($full_source_path),
-                EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path),
-                $overwrite
-            )
-        ) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(esc_html__('Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso'), $full_source_path);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path, 'f');
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * Reports whether or not the filepath is in the EE uploads folder or not
-     * @param string $filepath
-     * @return boolean
-     */
-    public static function is_in_uploads_folder($filepath)
-    {
-        $uploads = wp_upload_dir();
-        return strpos($filepath, $uploads['basedir']) === 0 ? true : false;
-    }
-
-    /**
-     * Given a "local" filepath (what you probably thought was the only filepath),
-     * converts it into a "remote" filepath (the filepath the currently-in-use
-     * $wp_filesystem needs to use access the folder or file).
-     * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins
-     * @param WP_Filesystem_Base $wp_filesystem we aren't initially sure which one
-     * is in use, so you need to provide it
-     * @param string $local_filepath the filepath to the folder/file locally
-     * @throws EE_Error if filesystem credentials are required
-     * @return string the remote filepath (eg the filepath the filesystem method, eg
-     * ftp or ssh, will use to access the folder
-     */
-    public static function convert_local_filepath_to_remote_filepath($local_filepath)
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
-        return str_replace(WP_CONTENT_DIR . '/', $wp_filesystem->wp_content_dir(), $local_filepath);
-    }
+	/**
+	 * @var string $_credentials_form
+	 */
+	private static $_credentials_form;
+
+	protected static $_wp_filesystem_direct;
+
+	/**
+	 * @param string|null $filepath the filepath we want to work in. If its in the
+	 * wp uploads directory, we'll want to just use the filesystem directly.
+	 * If not provided, we have to assume its not in the uploads directory
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return WP_Filesystem_Base
+	 */
+	private static function _get_wp_filesystem($filepath = null)
+	{
+		if (
+			apply_filters(
+				'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct',
+				$filepath && EEH_File::is_in_uploads_folder($filepath),
+				$filepath
+			)
+		) {
+			if (! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
+				require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
+				$method = 'direct';
+				$wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method);
+				// check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem()
+				if (! defined('FS_CHMOD_DIR')) {
+					define('FS_CHMOD_DIR', ( fileperms(ABSPATH) & 0777 | 0755 ));
+				}
+				if (! defined('FS_CHMOD_FILE')) {
+					define('FS_CHMOD_FILE', ( fileperms(ABSPATH . 'index.php') & 0777 | 0644 ));
+				}
+				require_once($wp_filesystem_direct_file);
+				EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array());
+			}
+			return EEH_File::$_wp_filesystem_direct;
+		}
+		global $wp_filesystem;
+		// no filesystem setup ???
+		if (! $wp_filesystem instanceof WP_Filesystem_Base) {
+			// if some eager beaver's just trying to get in there too early...
+			// let them do it, because we are one of those eager beavers! :P
+			/**
+			 * more explanations are probably merited. http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base
+			 * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process
+			 * is setup to mostly happen on 'init', and refactoring to have it happen on
+			 * 'wp_loaded' is too much work on a BETA milestone.
+			 * So this fix is expected to work if the WP files are owned by the server user,
+			 * but probably not if the user needs to enter their FTP credentials to modify files
+			 * and there may be troubles if the WP files are owned by a different user
+			 * than the server user. But both of these issues should exist in 4.4 and earlier too
+			 */
+			if (false && ! did_action('wp_loaded')) {
+				$msg = esc_html__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso');
+				if (WP_DEBUG) {
+					$msg .= '<br />' .  esc_html__('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
+				}
+				throw new EE_Error($msg);
+			} else {
+				// should be loaded if we are past the wp_loaded hook...
+				if (! function_exists('WP_Filesystem')) {
+					require_once(ABSPATH . 'wp-admin/includes/file.php');
+					require_once(ABSPATH . 'wp-admin/includes/template.php');
+				}
+				// turn on output buffering so that we can capture the credentials form
+				ob_start();
+				$credentials = request_filesystem_credentials('');
+				// store credentials form for the time being
+				EEH_File::$_credentials_form = ob_get_clean();
+				// basically check for direct or previously configured access
+				if (! WP_Filesystem($credentials)) {
+					// if credentials do NOT exist
+					if ($credentials === false) {
+						add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
+						throw new EE_Error(esc_html__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
+					} elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) {
+						add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
+						throw new EE_Error(
+							sprintf(
+								esc_html__('WP Filesystem Error: $1%s', 'event_espresso'),
+								$wp_filesystem->errors->get_error_message()
+							)
+						);
+					}
+				}
+			}
+		}
+		return $wp_filesystem;
+	}
+
+	/**
+	 * display_request_filesystem_credentials_form
+	 */
+	public static function display_request_filesystem_credentials_form()
+	{
+		if (! empty(EEH_File::$_credentials_form)) {
+			echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
+		}
+	}
+
+
+
+	/**
+	 *    verify_filepath_and_permissions
+	 *    checks that a file is readable and has sufficient file permissions set to access
+	 *
+	 * @access public
+	 * @param string $full_file_path - full server path to the folder or file
+	 * @param string $file_name      - name of file if checking a file
+	 * @param string $file_ext       - file extension (ie: "php") if checking a file
+	 * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function verify_filepath_and_permissions($full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '')
+	{
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+			$file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name;
+			$file_name .= ! empty($file_ext) ? ' file' : ' folder';
+			$msg = sprintf(
+				esc_html__('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'),
+				$file_name,
+				'<br />'
+			);
+			if (EEH_File::exists($full_file_path)) {
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file);
+			} else {
+				// no file permissions means the file was not found
+				$msg .= sprintf(
+					esc_html__('Please ensure the following path is correct: "%s".', 'event_espresso'),
+					$full_file_path
+				);
+			}
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				throw new EE_Error($msg . '||' . $msg);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a file or folder
+	 *
+	 * @access private
+	 * @param string $full_file_path - full server path to the folder or file
+	 * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return string
+	 */
+	private static function _permissions_error_for_unreadable_filepath($full_file_path = '', $type_of_file = '')
+	{
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		// check file permissions
+		$perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
+		if ($perms) {
+			// file permissions exist, but way be set incorrectly
+			$type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : '';
+			$type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
+			return sprintf(
+				esc_html__('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'),
+				$type_of_file,
+				$perms
+			);
+		} else {
+			// file exists but file permissions could not be read ?!?!
+			return sprintf(
+				esc_html__('Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso'),
+				$full_file_path
+			);
+		}
+	}
+
+
+
+	/**
+	 * ensure_folder_exists_and_is_writable
+	 * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
+	 * Also ensures all the parent folders exist, and if not tries to create them.
+	 * Also, if this function creates the folder, adds a .htaccess file and index.html file
+	 * @param string $folder
+	 * @throws EE_Error if the folder exists and is writeable, but for some reason we
+	 * can't write to it
+	 * @return bool false if folder isn't writable; true if it exists and is writeable,
+	 */
+	public static function ensure_folder_exists_and_is_writable($folder = '')
+	{
+		if (empty($folder)) {
+			return false;
+		}
+		// remove ending /
+		$folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
+		$parent_folder = EEH_File::get_parent_folder($folder);
+		// add / to folder
+		$folder = EEH_File::end_with_directory_separator($folder);
+		$wp_filesystem = EEH_File::_get_wp_filesystem($folder);
+		if (! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+			// ok so it doesn't exist. Does its parent? Can we write to it?
+			if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+				return false;
+			}
+			if (! EEH_File::verify_is_writable($parent_folder, 'folder')) {
+				return false;
+			} else {
+				if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+					if (defined('WP_DEBUG') && WP_DEBUG) {
+						$msg = sprintf(esc_html__('"%s" could not be created.', 'event_espresso'), $folder);
+						$msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
+						throw new EE_Error($msg);
+					}
+					return false;
+				}
+				EEH_File::add_index_file($folder);
+			}
+		} elseif (! EEH_File::verify_is_writable($folder, 'folder')) {
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * verify_is_writable - checks if a file or folder is writable
+	 * @param string $full_path      - full server path to file or folder
+	 * @param string $file_or_folder - whether checking a file or folder
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function verify_is_writable($full_path = '', $file_or_folder = 'folder')
+	{
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
+		$full_path = EEH_File::standardise_directory_separators($full_path);
+		if (! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(esc_html__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * ensure_file_exists_and_is_writable
+	 * ensures that a file exists and is writable, will attempt to create file if it does not exist.
+	 * Also ensures all the parent folders exist, and if not tries to create them.
+	 * @param string $full_file_path
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function ensure_file_exists_and_is_writable($full_file_path = '')
+	{
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		$parent_folder = EEH_File::get_parent_folder($full_file_path);
+		if (! EEH_File::exists($full_file_path)) {
+			if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+				return false;
+			}
+			if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+				if (defined('WP_DEBUG') && WP_DEBUG) {
+					$msg = sprintf(esc_html__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
+					$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
+					throw new EE_Error($msg);
+				}
+				return false;
+			}
+		}
+		if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * Gets the parent folder. If provided with file, gets the folder that contains it.
+	 * If provided a folder, gets its parent folder.
+	 * @param string $file_or_folder_path
+	 * @return string parent folder, ENDING with a directory separator
+	 */
+	public static function get_parent_folder($file_or_folder_path)
+	{
+		// find the last /, ignoring a / on the very end
+		// eg if given "/var/something/somewhere/", we want to get "somewhere"'s
+		// parent folder, "/var/something/"
+		$ds = strlen($file_or_folder_path) > 1
+			? strrpos($file_or_folder_path, '/', -2)
+			: strlen($file_or_folder_path);
+		return substr($file_or_folder_path, 0, $ds + 1);
+	}
+
+	// public static function ensure_folder_exists_recursively( $folder ) {
+	//
+	// }
+
+
+
+	/**
+	 * get_file_contents
+	 * @param string $full_file_path
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return string
+	 */
+	public static function get_file_contents($full_file_path = '')
+	{
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		if (EEH_File::verify_filepath_and_permissions($full_file_path, EEH_File::get_filename_from_filepath($full_file_path), EEH_File::get_file_extension($full_file_path))) {
+			// load WP_Filesystem and set file permissions
+			$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+			return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * write_file
+	 * @param string $full_file_path
+	 * @param string $file_contents - the content to be written to the file
+	 * @param string $file_type
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '')
+	{
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		$file_type = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : '';
+		$folder = EEH_File::remove_filename_from_filepath($full_file_path);
+		if (! EEH_File::verify_is_writable($folder, 'folder')) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(esc_html__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		// write the file
+		if (! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(esc_html__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * Wrapper for WP_Filesystem_Base::delete
+	 *
+	 * @param string $filepath
+	 * @param boolean $recursive
+	 * @param boolean|string $type 'd' for directory, 'f' for file
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return boolean
+	 */
+	public static function delete($filepath, $recursive = false, $type = false)
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem();
+		return $wp_filesystem->delete($filepath, $recursive, $type) ? true : false;
+	}
+
+
+
+	/**
+	 * exists
+	 * checks if a file exists using the WP filesystem
+	 * @param string $full_file_path
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function exists($full_file_path = '')
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)) ? true : false;
+	}
+
+
+
+	/**
+	 * is_readable
+	 * checks if a file is_readable using the WP filesystem
+	 *
+	 * @param string $full_file_path
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function is_readable($full_file_path = '')
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		if ($wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * remove_filename_from_filepath
+	 * given a full path to a file including the filename itself, this removes  the filename and returns the path, up to, but NOT including the filename OR slash
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function remove_filename_from_filepath($full_file_path = '')
+	{
+		return pathinfo($full_file_path, PATHINFO_DIRNAME);
+	}
+
+
+	/**
+	 * get_filename_from_filepath. Arguably the same as basename()
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function get_filename_from_filepath($full_file_path = '')
+	{
+		return pathinfo($full_file_path, PATHINFO_BASENAME);
+	}
+
+
+	/**
+	 * get_file_extension
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function get_file_extension($full_file_path = '')
+	{
+		return pathinfo($full_file_path, PATHINFO_EXTENSION);
+	}
+
+
+
+	/**
+	 * add_htaccess_deny_from_all so the webserver cannot access this folder
+	 * @param string $folder
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function add_htaccess_deny_from_all($folder = '')
+	{
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
+		if (! EEH_File::exists($folder . '.htaccess')) {
+			if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * Adds an index file to this folder, so folks can't list all the file's contents
+	 * @param string $folder
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return boolean
+	 */
+	public static function add_index_file($folder)
+	{
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
+		if (! EEH_File::exists($folder . 'index.php')) {
+			if (! EEH_File::write_to_file($folder . 'index.php', 'You are not permitted to read from this folder', '.php')) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php),
+	 * extract that classname.
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function get_classname_from_filepath_with_standard_filename($file_path)
+	{
+		// extract file from path
+		$filename = basename($file_path);
+		// now remove the first period and everything after
+		$pos_of_first_period = strpos($filename, '.');
+		return substr($filename, 0, $pos_of_first_period);
+	}
+
+
+
+	/**
+	 * standardise_directory_separators
+	 *  convert all directory separators in a file path.
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function standardise_directory_separators($file_path)
+	{
+		return str_replace(array( '\\', '/' ), '/', $file_path);
+	}
+
+
+
+	/**
+	 * end_with_directory_separator
+	 *  ensures that file path ends with '/'
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function end_with_directory_separator($file_path)
+	{
+		return rtrim($file_path, '/\\') . '/';
+	}
+
+
+
+	/**
+	 * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators
+	 * @param $file_path
+	 * @return string
+	 */
+	public static function standardise_and_end_with_directory_separator($file_path)
+	{
+		return self::end_with_directory_separator(self::standardise_directory_separators($file_path));
+	}
+
+
+
+	/**
+	 * takes the folder name (with or without trailing slash) and finds the files it in,
+	 * and what the class's name inside of each should be.
+	 * @param array $folder_paths
+	 * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically;
+	 *      if FALSE (Default), returned array will be indexed by the filenames minus extensions.
+	 *      Set it TRUE if you know there are files in the directory with the same name but different extensions
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return array if $index_numerically == TRUE keys are numeric ,
+	 *      if $index_numerically == FALSE (Default) keys are what the class names SHOULD be;
+	 *       and values are their filepaths
+	 */
+	public static function get_contents_of_folders($folder_paths = array(), $index_numerically = false)
+	{
+		$class_to_folder_path = array();
+		foreach ($folder_paths as $folder_path) {
+			$folder_path = self::standardise_and_end_with_directory_separator($folder_path);
+			// load WP_Filesystem and set file permissions
+			$files_in_folder = glob($folder_path . '*.php');
+			$class_to_folder_path = array();
+			if ($files_in_folder) {
+				foreach ($files_in_folder as $file_path) {
+					// only add files, not folders
+					if (! is_dir($file_path)) {
+						if ($index_numerically) {
+							$class_to_folder_path[] = $file_path;
+						} else {
+							$classname = self::get_classname_from_filepath_with_standard_filename($file_path);
+							$class_to_folder_path[ $classname ] = $file_path;
+						}
+					}
+				}
+			}
+		}
+		return $class_to_folder_path;
+	}
+
+
+
+	/**
+	 * Copies a file. Mostly a wrapper of WP_Filesystem::copy
+	 * @param string $source_file
+	 * @param string $destination_file
+	 * @param boolean $overwrite
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return boolean success
+	 */
+	public static function copy($source_file, $destination_file, $overwrite = false)
+	{
+		$full_source_path = EEH_File::standardise_directory_separators($source_file);
+		if (! EEH_File::exists($full_source_path)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(esc_html__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+
+		$full_dest_path = EEH_File::standardise_directory_separators($destination_file);
+		$folder = EEH_File::remove_filename_from_filepath($full_dest_path);
+		EEH_File::ensure_folder_exists_and_is_writable($folder);
+		if (! EEH_File::verify_is_writable($folder, 'folder')) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(esc_html__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
+		// write the file
+		if (
+			! $wp_filesystem->copy(
+				EEH_File::convert_local_filepath_to_remote_filepath($full_source_path),
+				EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path),
+				$overwrite
+			)
+		) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(esc_html__('Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso'), $full_source_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path, 'f');
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * Reports whether or not the filepath is in the EE uploads folder or not
+	 * @param string $filepath
+	 * @return boolean
+	 */
+	public static function is_in_uploads_folder($filepath)
+	{
+		$uploads = wp_upload_dir();
+		return strpos($filepath, $uploads['basedir']) === 0 ? true : false;
+	}
+
+	/**
+	 * Given a "local" filepath (what you probably thought was the only filepath),
+	 * converts it into a "remote" filepath (the filepath the currently-in-use
+	 * $wp_filesystem needs to use access the folder or file).
+	 * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins
+	 * @param WP_Filesystem_Base $wp_filesystem we aren't initially sure which one
+	 * is in use, so you need to provide it
+	 * @param string $local_filepath the filepath to the folder/file locally
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return string the remote filepath (eg the filepath the filesystem method, eg
+	 * ftp or ssh, will use to access the folder
+	 */
+	public static function convert_local_filepath_to_remote_filepath($local_filepath)
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
+		return str_replace(WP_CONTENT_DIR . '/', $wp_filesystem->wp_content_dir(), $local_filepath);
+	}
 }

Spacing +46 added lines, -46 removed lines

@@ -48,16 +48,16 @@ 
                 $filepath
             )
         ) {
-            if (! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
-                require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
+            if ( ! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
+                require_once(ABSPATH.'wp-admin/includes/class-wp-filesystem-base.php');
                 $method = 'direct';
-                $wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method);
+                $wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH.'wp-admin/includes/class-wp-filesystem-'.$method.'.php', $method);
                 // check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem()
-                if (! defined('FS_CHMOD_DIR')) {
-                    define('FS_CHMOD_DIR', ( fileperms(ABSPATH) & 0777 | 0755 ));
+                if ( ! defined('FS_CHMOD_DIR')) {
+                    define('FS_CHMOD_DIR', (fileperms(ABSPATH) & 0777 | 0755));
                 }
-                if (! defined('FS_CHMOD_FILE')) {
-                    define('FS_CHMOD_FILE', ( fileperms(ABSPATH . 'index.php') & 0777 | 0644 ));
+                if ( ! defined('FS_CHMOD_FILE')) {
+                    define('FS_CHMOD_FILE', (fileperms(ABSPATH.'index.php') & 0777 | 0644));
                 }
                 require_once($wp_filesystem_direct_file);
                 EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array());
@@ -66,7 +66,7 @@ 
         }
         global $wp_filesystem;
         // no filesystem setup ???
-        if (! $wp_filesystem instanceof WP_Filesystem_Base) {
+        if ( ! $wp_filesystem instanceof WP_Filesystem_Base) {
             // if some eager beaver's just trying to get in there too early...
             // let them do it, because we are one of those eager beavers! :P
             /**
@@ -82,14 +82,14 @@ 
             if (false && ! did_action('wp_loaded')) {
                 $msg = esc_html__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso');
                 if (WP_DEBUG) {
-                    $msg .= '<br />' .  esc_html__('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
+                    $msg .= '<br />'.esc_html__('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
                 }
                 throw new EE_Error($msg);
             } else {
                 // should be loaded if we are past the wp_loaded hook...
-                if (! function_exists('WP_Filesystem')) {
-                    require_once(ABSPATH . 'wp-admin/includes/file.php');
-                    require_once(ABSPATH . 'wp-admin/includes/template.php');
+                if ( ! function_exists('WP_Filesystem')) {
+                    require_once(ABSPATH.'wp-admin/includes/file.php');
+                    require_once(ABSPATH.'wp-admin/includes/template.php');
                 }
                 // turn on output buffering so that we can capture the credentials form
                 ob_start();
@@ -97,13 +97,13 @@ 
                 // store credentials form for the time being
                 EEH_File::$_credentials_form = ob_get_clean();
                 // basically check for direct or previously configured access
-                if (! WP_Filesystem($credentials)) {
+                if ( ! WP_Filesystem($credentials)) {
                     // if credentials do NOT exist
                     if ($credentials === false) {
-                        add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
+                        add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999);
                         throw new EE_Error(esc_html__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
                     } elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) {
-                        add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
+                        add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999);
                         throw new EE_Error(
                             sprintf(
                                 esc_html__('WP Filesystem Error: $1%s', 'event_espresso'),
@@ -122,8 +122,8 @@ 
      */
     public static function display_request_filesystem_credentials_form()
     {
-        if (! empty(EEH_File::$_credentials_form)) {
-            echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
+        if ( ! empty(EEH_File::$_credentials_form)) {
+            echo '<div class="updated espresso-notices-attention"><p>'.EEH_File::$_credentials_form.'</p></div>';
         }
     }
 
@@ -146,8 +146,8 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
         $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-            $file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name;
+        if ( ! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+            $file_name = ! empty($type_of_file) ? $file_name.' '.$type_of_file : $file_name;
             $file_name .= ! empty($file_ext) ? ' file' : ' folder';
             $msg = sprintf(
                 esc_html__('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'),
@@ -164,7 +164,7 @@ 
                 );
             }
             if (defined('WP_DEBUG') && WP_DEBUG) {
-                throw new EE_Error($msg . '||' . $msg);
+                throw new EE_Error($msg.'||'.$msg);
             }
             return false;
         }
@@ -190,7 +190,7 @@ 
         $perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
         if ($perms) {
             // file permissions exist, but way be set incorrectly
-            $type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : '';
+            $type_of_file = ! empty($type_of_file) ? $type_of_file.' ' : '';
             $type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
             return sprintf(
                 esc_html__('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'),
@@ -229,15 +229,15 @@ 
         // add / to folder
         $folder = EEH_File::end_with_directory_separator($folder);
         $wp_filesystem = EEH_File::_get_wp_filesystem($folder);
-        if (! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+        if ( ! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
             // ok so it doesn't exist. Does its parent? Can we write to it?
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+            if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
                 return false;
             }
-            if (! EEH_File::verify_is_writable($parent_folder, 'folder')) {
+            if ( ! EEH_File::verify_is_writable($parent_folder, 'folder')) {
                 return false;
             } else {
-                if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+                if ( ! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
                     if (defined('WP_DEBUG') && WP_DEBUG) {
                         $msg = sprintf(esc_html__('"%s" could not be created.', 'event_espresso'), $folder);
                         $msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
@@ -247,7 +247,7 @@ 
                 }
                 EEH_File::add_index_file($folder);
             }
-        } elseif (! EEH_File::verify_is_writable($folder, 'folder')) {
+        } elseif ( ! EEH_File::verify_is_writable($folder, 'folder')) {
             return false;
         }
         return true;
@@ -267,7 +267,7 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
         $full_path = EEH_File::standardise_directory_separators($full_path);
-        if (! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
+        if ( ! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(esc_html__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
@@ -294,11 +294,11 @@ 
         $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
         $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
         $parent_folder = EEH_File::get_parent_folder($full_file_path);
-        if (! EEH_File::exists($full_file_path)) {
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+        if ( ! EEH_File::exists($full_file_path)) {
+            if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
                 return false;
             }
-            if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+            if ( ! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
                 if (defined('WP_DEBUG') && WP_DEBUG) {
                     $msg = sprintf(esc_html__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
                     $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
@@ -307,7 +307,7 @@ 
                 return false;
             }
         }
-        if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
+        if ( ! EEH_File::verify_is_writable($full_file_path, 'file')) {
             return false;
         }
         return true;
@@ -366,9 +366,9 @@ 
     public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '')
     {
         $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        $file_type = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : '';
+        $file_type = ! empty($file_type) ? rtrim($file_type, ' ').' ' : '';
         $folder = EEH_File::remove_filename_from_filepath($full_file_path);
-        if (! EEH_File::verify_is_writable($folder, 'folder')) {
+        if ( ! EEH_File::verify_is_writable($folder, 'folder')) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(esc_html__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
@@ -379,7 +379,7 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
         // write the file
-        if (! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
+        if ( ! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(esc_html__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
@@ -489,8 +489,8 @@ 
     public static function add_htaccess_deny_from_all($folder = '')
     {
         $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . '.htaccess')) {
-            if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) {
+        if ( ! EEH_File::exists($folder.'.htaccess')) {
+            if ( ! EEH_File::write_to_file($folder.'.htaccess', 'deny from all', '.htaccess')) {
                 return false;
             }
         }
@@ -507,8 +507,8 @@ 
     public static function add_index_file($folder)
     {
         $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . 'index.php')) {
-            if (! EEH_File::write_to_file($folder . 'index.php', 'You are not permitted to read from this folder', '.php')) {
+        if ( ! EEH_File::exists($folder.'index.php')) {
+            if ( ! EEH_File::write_to_file($folder.'index.php', 'You are not permitted to read from this folder', '.php')) {
                 return false;
             }
         }
@@ -542,7 +542,7 @@ 
      */
     public static function standardise_directory_separators($file_path)
     {
-        return str_replace(array( '\\', '/' ), '/', $file_path);
+        return str_replace(array('\\', '/'), '/', $file_path);
     }
 
 
@@ -555,7 +555,7 @@ 
      */
     public static function end_with_directory_separator($file_path)
     {
-        return rtrim($file_path, '/\\') . '/';
+        return rtrim($file_path, '/\\').'/';
     }
 
 
@@ -590,17 +590,17 @@ 
         foreach ($folder_paths as $folder_path) {
             $folder_path = self::standardise_and_end_with_directory_separator($folder_path);
             // load WP_Filesystem and set file permissions
-            $files_in_folder = glob($folder_path . '*.php');
+            $files_in_folder = glob($folder_path.'*.php');
             $class_to_folder_path = array();
             if ($files_in_folder) {
                 foreach ($files_in_folder as $file_path) {
                     // only add files, not folders
-                    if (! is_dir($file_path)) {
+                    if ( ! is_dir($file_path)) {
                         if ($index_numerically) {
                             $class_to_folder_path[] = $file_path;
                         } else {
                             $classname = self::get_classname_from_filepath_with_standard_filename($file_path);
-                            $class_to_folder_path[ $classname ] = $file_path;
+                            $class_to_folder_path[$classname] = $file_path;
                         }
                     }
                 }
@@ -622,7 +622,7 @@ 
     public static function copy($source_file, $destination_file, $overwrite = false)
     {
         $full_source_path = EEH_File::standardise_directory_separators($source_file);
-        if (! EEH_File::exists($full_source_path)) {
+        if ( ! EEH_File::exists($full_source_path)) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(esc_html__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
@@ -634,7 +634,7 @@ 
         $full_dest_path = EEH_File::standardise_directory_separators($destination_file);
         $folder = EEH_File::remove_filename_from_filepath($full_dest_path);
         EEH_File::ensure_folder_exists_and_is_writable($folder);
-        if (! EEH_File::verify_is_writable($folder, 'folder')) {
+        if ( ! EEH_File::verify_is_writable($folder, 'folder')) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(esc_html__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
@@ -689,6 +689,6 @@ 
     public static function convert_local_filepath_to_remote_filepath($local_filepath)
     {
         $wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
-        return str_replace(WP_CONTENT_DIR . '/', $wp_filesystem->wp_content_dir(), $local_filepath);
+        return str_replace(WP_CONTENT_DIR.'/', $wp_filesystem->wp_content_dir(), $local_filepath);
     }
 }

core/Factory.php

Indentation +28 added lines, -28 removed lines

@@ -18,32 +18,32 @@
 class Factory
 {
 
-    /**
-     * @param string $class_name
-     * @param array  $arguments
-     * @return mixed|null
-     * @throws EE_Error
-     */
-    public static function create($class_name, $arguments = array())
-    {
-        if (empty($class_name)) {
-            throw new EE_Error(
-                esc_html__('You must provide a class name in order to instantiate it.', 'event_espresso')
-            );
-        }
-        switch ($class_name) {
-            case 'Request':
-            case 'EE_Request':
-                $object = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
-                break;
-            case 'Iframe':
-                $title = isset($arguments['title']) ? $arguments['title'] : null;
-                $content = isset($arguments['content']) ? $arguments['content'] : null;
-                $object = new Iframe($title, $content);
-                break;
-            default:
-                $object = new $class_name($arguments);
-        }
-        return $object;
-    }
+	/**
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @return mixed|null
+	 * @throws EE_Error
+	 */
+	public static function create($class_name, $arguments = array())
+	{
+		if (empty($class_name)) {
+			throw new EE_Error(
+				esc_html__('You must provide a class name in order to instantiate it.', 'event_espresso')
+			);
+		}
+		switch ($class_name) {
+			case 'Request':
+			case 'EE_Request':
+				$object = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
+				break;
+			case 'Iframe':
+				$title = isset($arguments['title']) ? $arguments['title'] : null;
+				$content = isset($arguments['content']) ? $arguments['content'] : null;
+				$object = new Iframe($title, $content);
+				break;
+			default:
+				$object = new $class_name($arguments);
+		}
+		return $object;
+	}
 }

core/exceptions/InvalidFilePathException.php

Indentation +23 added lines, -23 removed lines

@@ -15,27 +15,27 @@
 class InvalidFilePathException extends InvalidArgumentException
 {
 
-    /**
-     * InvalidClassException constructor.
-     *
-     * @param string     $file_path
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($file_path, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The "%1$s" file is either missing or could not be read due to permissions. Please ensure that the following path is correct and verify that the file permissions are correct:%2$s %3$s',
-                    'event_espresso'
-                ),
-                basename($file_path),
-                '<br />',
-                $file_path
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidClassException constructor.
+	 *
+	 * @param string     $file_path
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($file_path, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The "%1$s" file is either missing or could not be read due to permissions. Please ensure that the following path is correct and verify that the file permissions are correct:%2$s %3$s',
+					'event_espresso'
+				),
+				basename($file_path),
+				'<br />',
+				$file_path
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/exceptions/InvalidStatusException.php

Indentation +22 added lines, -22 removed lines

@@ -7,26 +7,26 @@
 
 class InvalidStatusException extends InvalidArgumentException
 {
-    /**
-     * InvalidStatusException constructor.
-     * @param string $status the invalid status id that was supplied
-     * @param string $domain the name of the domain, model, or class that the status belongs to
-     * @param string $message custom message
-     * @param int $code
-     * @param Exception|null $previous
-     */
-    public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    '"%1$s" is not a valid %2$s status',
-                    'event_espresso'
-                ),
-                $status,
-                $domain
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidStatusException constructor.
+	 * @param string $status the invalid status id that was supplied
+	 * @param string $domain the name of the domain, model, or class that the status belongs to
+	 * @param string $message custom message
+	 * @param int $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'"%1$s" is not a valid %2$s status',
+					'event_espresso'
+				),
+				$status,
+				$domain
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/exceptions/InvalidIdentifierException.php

Indentation +23 added lines, -23 removed lines

@@ -16,28 +16,28 @@
 class InvalidIdentifierException extends InvalidArgumentException
 {
 
-    /**
-     * InvalidIdentifierException constructor.
-     *
-     * @param string     $actual   the identifier that was supplied
-     * @param string     $expected example of an acceptable identifier
-     * @param string     $message
-     * @param int        $code
-     * @param Exception $previous
-     */
-    public function __construct($actual, $expected, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The supplied identifier "%1$s" is invalid. A value like "%2$s" was expected.',
-                    'event_espresso'
-                ),
-                $actual,
-                $expected
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidIdentifierException constructor.
+	 *
+	 * @param string     $actual   the identifier that was supplied
+	 * @param string     $expected example of an acceptable identifier
+	 * @param string     $message
+	 * @param int        $code
+	 * @param Exception $previous
+	 */
+	public function __construct($actual, $expected, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The supplied identifier "%1$s" is invalid. A value like "%2$s" was expected.',
+					'event_espresso'
+				),
+				$actual,
+				$expected
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }
 // Location: core/exceptions/InvalidIdentifierException.php

core/exceptions/InvalidDataTypeException.php

Indentation +40 added lines, -40 removed lines

@@ -16,46 +16,46 @@
 class InvalidDataTypeException extends InvalidArgumentException
 {
 
-    /**
-     * InvalidDataTypeException constructor
-     *
-     * @param string    $var_name  name of the variable that was of the wrong type ie: "$my_var"
-     * @param mixed     $variable  the actual variable that was of the wrong data type, ie: $my_var
-     * @param string    $expected  data type we wanted ie: "integer", "string", "array", etc.
-     *                             or an entire rewrite of: "{something something} was expected."
-     * @param string    $message
-     * @param int       $code
-     * @param Exception $previous
-     */
-    public function __construct($var_name, $variable, $expected, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $expected = strpos(' was expected.', $expected) === false
-                ? $this->addIndefiniteArticle($expected) . ' was expected.'
-                : $expected;
-            $message = sprintf(
-                esc_html__(
-                    'The supplied data for "%1$s" was %2$s, but %3$s',
-                    'event_espresso'
-                ),
-                $var_name,
-                $this->addIndefiniteArticle(gettype($variable)),
-                $expected
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidDataTypeException constructor
+	 *
+	 * @param string    $var_name  name of the variable that was of the wrong type ie: "$my_var"
+	 * @param mixed     $variable  the actual variable that was of the wrong data type, ie: $my_var
+	 * @param string    $expected  data type we wanted ie: "integer", "string", "array", etc.
+	 *                             or an entire rewrite of: "{something something} was expected."
+	 * @param string    $message
+	 * @param int       $code
+	 * @param Exception $previous
+	 */
+	public function __construct($var_name, $variable, $expected, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$expected = strpos(' was expected.', $expected) === false
+				? $this->addIndefiniteArticle($expected) . ' was expected.'
+				: $expected;
+			$message = sprintf(
+				esc_html__(
+					'The supplied data for "%1$s" was %2$s, but %3$s',
+					'event_espresso'
+				),
+				$var_name,
+				$this->addIndefiniteArticle(gettype($variable)),
+				$expected
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 
 
-    /**
-     * @param $string
-     * @return string
-     */
-    protected function addIndefiniteArticle($string)
-    {
-        if (strtolower($string) === 'null') {
-            return $string;
-        }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
-    }
+	/**
+	 * @param $string
+	 * @return string
+	 */
+	protected function addIndefiniteArticle($string)
+	{
+		if (strtolower($string) === 'null') {
+			return $string;
+		}
+		return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -31,7 +31,7 @@ 
     {
         if (empty($message)) {
             $expected = strpos(' was expected.', $expected) === false
-                ? $this->addIndefiniteArticle($expected) . ' was expected.'
+                ? $this->addIndefiniteArticle($expected).' was expected.'
                 : $expected;
             $message = sprintf(
                 esc_html__(
@@ -56,6 +56,6 @@ 
         if (strtolower($string) === 'null') {
             return $string;
         }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ').$string;
     }
 }

core/exceptions/InvalidClassException.php

Indentation +18 added lines, -18 removed lines

@@ -15,22 +15,22 @@
 class InvalidClassException extends DomainException
 {
 
-    /**
-     * InvalidClassException constructor.
-     *
-     * @param string     $class_name
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($class_name, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__('The "%1$s" Class is either missing or invalid.', 'event_espresso'),
-                $class_name
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidClassException constructor.
+	 *
+	 * @param string     $class_name
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($class_name, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__('The "%1$s" Class is either missing or invalid.', 'event_espresso'),
+				$class_name
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/exceptions/InvalidEntityException.php

Indentation +29 added lines, -29 removed lines

@@ -16,33 +16,33 @@
 class InvalidEntityException extends InvalidArgumentException
 {
 
-    /**
-     * InvalidEntityException constructor.
-     *
-     * @param mixed     $actual   the actual object (or thing) we got
-     * @param string    $expected classname of the entity we wanted
-     * @param string    $message
-     * @param int       $code
-     * @param Exception $previous
-     */
-    public function __construct($actual, $expected, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            ob_start();
-            var_dump($actual);
-            $object = ob_get_clean();
-            $message = sprintf(
-                esc_html__(
-                    'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
-                    'event_espresso'
-                ),
-                is_object($actual)
-                    ? get_class($actual)
-                    : gettype($actual),
-                $expected,
-                $object
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidEntityException constructor.
+	 *
+	 * @param mixed     $actual   the actual object (or thing) we got
+	 * @param string    $expected classname of the entity we wanted
+	 * @param string    $message
+	 * @param int       $code
+	 * @param Exception $previous
+	 */
+	public function __construct($actual, $expected, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			ob_start();
+			var_dump($actual);
+			$object = ob_get_clean();
+			$message = sprintf(
+				esc_html__(
+					'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
+					'event_espresso'
+				),
+				is_object($actual)
+					? get_class($actual)
+					: gettype($actual),
+				$expected,
+				$object
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }