eventespresso / event-espresso-core

core/helpers/EEH_File.helper.php

Indentation +662 added lines, -662 removed lines

@@ -24,666 +24,666 @@
 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 = __('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 />' .  __('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(__('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(
-                                __('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(
-                __('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(
-                    __('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(
-                __('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(
-                __('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 DS
-        $folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
-        $parent_folder = EEH_File::get_parent_folder($folder);
-        // add DS 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(__('"%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(__('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(__('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 DS, ignoring a DS 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, DS, -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(__('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(__('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 to whatever is set for DS
-     * @param string $file_path
-     * @return string
-     */
-    public static function standardise_directory_separators($file_path)
-    {
-        return str_replace(array( '\\', '/' ), DS, $file_path);
-    }
-
-
-
-    /**
-     * end_with_directory_separator
-     *  ensures that file path ends with DS
-     * @param string $file_path
-     * @return string
-     */
-    public static function end_with_directory_separator($file_path)
-    {
-        return rtrim($file_path, '/\\') . DS;
-    }
-
-
-
-    /**
-     * 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 . '*');
-            $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(__('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(__('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(__('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 . DS, $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 = __('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 />' .  __('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(__('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(
+								__('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(
+				__('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(
+					__('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(
+				__('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(
+				__('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 DS
+		$folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
+		$parent_folder = EEH_File::get_parent_folder($folder);
+		// add DS 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(__('"%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(__('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(__('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 DS, ignoring a DS 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, DS, -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(__('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(__('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 to whatever is set for DS
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function standardise_directory_separators($file_path)
+	{
+		return str_replace(array( '\\', '/' ), DS, $file_path);
+	}
+
+
+
+	/**
+	 * end_with_directory_separator
+	 *  ensures that file path ends with DS
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function end_with_directory_separator($file_path)
+	{
+		return rtrim($file_path, '/\\') . DS;
+	}
+
+
+
+	/**
+	 * 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 . '*');
+			$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(__('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(__('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(__('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 . DS, $wp_filesystem->wp_content_dir(), $local_filepath);
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -44,17 +44,17 @@ 
             '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');
+        )) {
+            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());
@@ -63,7 +63,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
             /**
@@ -79,14 +79,14 @@ 
             if (false && ! did_action('wp_loaded')) {
                 $msg = __('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 />' .  __('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 />'.__('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();
@@ -94,13 +94,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(__('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(
                                 __('WP Filesystem Error: $1%s', 'event_espresso'),
@@ -119,8 +119,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>';
         }
     }
 
@@ -143,8 +143,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(
                 __('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'),
@@ -161,7 +161,7 @@ 
                 );
             }
             if (defined('WP_DEBUG') && WP_DEBUG) {
-                throw new EE_Error($msg . '||' . $msg);
+                throw new EE_Error($msg.'||'.$msg);
             }
             return false;
         }
@@ -187,7 +187,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(
                 __('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'),
@@ -226,15 +226,15 @@ 
         // add DS 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(__('"%s" could not be created.', 'event_espresso'), $folder);
                         $msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
@@ -244,7 +244,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;
@@ -264,7 +264,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(__('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);
@@ -291,11 +291,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(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
                     $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
@@ -304,7 +304,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;
@@ -363,9 +363,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(__('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);
@@ -376,7 +376,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(__('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');
@@ -486,8 +486,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;
             }
         }
@@ -504,8 +504,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;
             }
         }
@@ -539,7 +539,7 @@ 
      */
     public static function standardise_directory_separators($file_path)
     {
-        return str_replace(array( '\\', '/' ), DS, $file_path);
+        return str_replace(array('\\', '/'), DS, $file_path);
     }
 
 
@@ -552,7 +552,7 @@ 
      */
     public static function end_with_directory_separator($file_path)
     {
-        return rtrim($file_path, '/\\') . DS;
+        return rtrim($file_path, '/\\').DS;
     }
 
 
@@ -587,17 +587,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 . '*');
+            $files_in_folder = glob($folder_path.'*');
             $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;
                         }
                     }
                 }
@@ -619,7 +619,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(__('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);
@@ -631,7 +631,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(__('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);
@@ -643,7 +643,7 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
         // write the file
-        if (! $wp_filesystem->copy(
+        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
@@ -684,6 +684,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 . DS, $wp_filesystem->wp_content_dir(), $local_filepath);
+        return str_replace(WP_CONTENT_DIR.DS, $wp_filesystem->wp_content_dir(), $local_filepath);
     }
 }

core/services/options/JsonWpOptionManager.php

Indentation +32 added lines, -32 removed lines

@@ -16,39 +16,39 @@
  */
 class JsonWpOptionManager
 {
-    /**
-     * Updates the object with what's in the DB (specifically, the wp_options table). If nothing is in the DB, leaves
-     * the object alone and returns false.
-     * @since $VID:$
-     * @param JsonWpOptionSerializableInterface $obj
-     * @return bool
-     */
-    public function populateFromDb(JsonWpOptionSerializableInterface $obj)
-    {
-        $option = get_option($obj->getWpOptionName());
-        if ($option) {
-            $json = json_decode($option);
-            if (is_array($json) || $json instanceof stdClass) {
-                return $obj->fromJsonSerializedData($json);
-            }
-        }
-        return false;
-    }
+	/**
+	 * Updates the object with what's in the DB (specifically, the wp_options table). If nothing is in the DB, leaves
+	 * the object alone and returns false.
+	 * @since $VID:$
+	 * @param JsonWpOptionSerializableInterface $obj
+	 * @return bool
+	 */
+	public function populateFromDb(JsonWpOptionSerializableInterface $obj)
+	{
+		$option = get_option($obj->getWpOptionName());
+		if ($option) {
+			$json = json_decode($option);
+			if (is_array($json) || $json instanceof stdClass) {
+				return $obj->fromJsonSerializedData($json);
+			}
+		}
+		return false;
+	}
 
-    /**
-     * Saves the object's data to the wp_options table for later use.
-     * @since $VID:$
-     * @param JsonWpOptionSerializableInterface $obj
-     * @return bool
-     */
-    public function saveToDb(JsonWpOptionSerializableInterface $obj)
-    {
-        return update_option(
-            $obj->getWpOptionName(),
-            wp_json_encode($obj->toJsonSerializableData()),
-            false
-        );
-    }
+	/**
+	 * Saves the object's data to the wp_options table for later use.
+	 * @since $VID:$
+	 * @param JsonWpOptionSerializableInterface $obj
+	 * @return bool
+	 */
+	public function saveToDb(JsonWpOptionSerializableInterface $obj)
+	{
+		return update_option(
+			$obj->getWpOptionName(),
+			wp_json_encode($obj->toJsonSerializableData()),
+			false
+		);
+	}
 }
 // End of file JsonWpOptionManager.php
 // Location: EventEspresso\core\services\options/JsonWpOptionManager.php

core/services/request/files/FileSubmission.php

Indentation +158 added lines, -158 removed lines

@@ -19,164 +19,164 @@
  */
 class FileSubmission implements FileSubmissionInterface
 {
-    /**
-     * @var string original name on the client machine
-     */
-    protected $name;
-
-    /**
-     * @var string mime type
-     */
-    protected $type;
-
-    /**
-     * @var string file extension
-     */
-    protected $extension;
-
-    /**
-     * @var int in bytes
-     */
-    protected $size;
-
-    /**
-     * @var string local filepath to the temporary file
-     */
-    protected $tmp_file;
-
-    /**
-     * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values
-     * although those aren't expected.
-     */
-    protected $error_code;
-
-    /**
-     * FileSubmission constructor.
-     * @param $name
-     * @param $tmp_file
-     * @param $size
-     * @param null $error_code
-     * @throws InvalidArgumentException
-     */
-    public function __construct($name, $tmp_file, $size, $error_code = null)
-    {
-        $this->name = basename($name);
-        $scheme = parse_url($tmp_file, PHP_URL_SCHEME);
-        if (in_array($scheme, ['http', 'https'])) {
-            // Wait a minute- just local filepaths please, no URL schemes allowed!
-            throw new InvalidArgumentException(
-                sprintf(
-                    // @codingStandardsIgnoreStart
-                    esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'),
-                    // @codingStandardsIgnoreEnd
-                    $scheme,
-                    $tmp_file
-                )
-            );
-        }
-        $this->tmp_file = (string) $tmp_file;
-        $this->size = (int) $size;
-        $this->error_code = (int) $error_code;
-    }
-
-    /**
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
-
-    /**
-     * Gets the file's mime type
-     * @return string
-     */
-    public function getType()
-    {
-        if (!$this->type) {
-            $this->type = $this->determineType();
-        }
-        return $this->type;
-    }
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    protected function determineType()
-    {
-        if (!$this->getTmpFile()) {
-            return '';
-        }
-        $finfo = new finfo(FILEINFO_MIME_TYPE);
-        return $finfo->file($this->getTmpFile());
-    }
-
-    /**
-     * Gets the file's extension.
-     * @since $VID:$
-     * @return string
-     */
-    public function getExtension()
-    {
-        if (!$this->extension) {
-            $this->extension = $this->determineExtension();
-        }
-        return $this->extension;
-    }
-
-    /**
-     * Determine's the file's extension given the temporary file.
-     * @since $VID:$
-     * @return string
-     */
-    protected function determineExtension()
-    {
-        $position_of_period = strrpos($this->getName(), '.');
-        if ($position_of_period === false) {
-            return '';
-        }
-        return mb_substr(
-            $this->getName(),
-            $position_of_period + 1
-        );
-    }
-
-    /**
-     * Gets the size of the file
-     * @return int
-     */
-    public function getSize()
-    {
-        return $this->size;
-    }
-
-    /**
-     * Gets the path to the temporary file which was uploaded.
-     * @return string
-     */
-    public function getTmpFile()
-    {
-        return $this->tmp_file;
-    }
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->getName();
-    }
-
-    /**
-     * Gets the error code PHP reported for the file upload.
-     * @return string
-     */
-    public function getErrorCode()
-    {
-        return $this->error_code;
-    }
+	/**
+	 * @var string original name on the client machine
+	 */
+	protected $name;
+
+	/**
+	 * @var string mime type
+	 */
+	protected $type;
+
+	/**
+	 * @var string file extension
+	 */
+	protected $extension;
+
+	/**
+	 * @var int in bytes
+	 */
+	protected $size;
+
+	/**
+	 * @var string local filepath to the temporary file
+	 */
+	protected $tmp_file;
+
+	/**
+	 * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values
+	 * although those aren't expected.
+	 */
+	protected $error_code;
+
+	/**
+	 * FileSubmission constructor.
+	 * @param $name
+	 * @param $tmp_file
+	 * @param $size
+	 * @param null $error_code
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($name, $tmp_file, $size, $error_code = null)
+	{
+		$this->name = basename($name);
+		$scheme = parse_url($tmp_file, PHP_URL_SCHEME);
+		if (in_array($scheme, ['http', 'https'])) {
+			// Wait a minute- just local filepaths please, no URL schemes allowed!
+			throw new InvalidArgumentException(
+				sprintf(
+					// @codingStandardsIgnoreStart
+					esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'),
+					// @codingStandardsIgnoreEnd
+					$scheme,
+					$tmp_file
+				)
+			);
+		}
+		$this->tmp_file = (string) $tmp_file;
+		$this->size = (int) $size;
+		$this->error_code = (int) $error_code;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
+
+	/**
+	 * Gets the file's mime type
+	 * @return string
+	 */
+	public function getType()
+	{
+		if (!$this->type) {
+			$this->type = $this->determineType();
+		}
+		return $this->type;
+	}
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	protected function determineType()
+	{
+		if (!$this->getTmpFile()) {
+			return '';
+		}
+		$finfo = new finfo(FILEINFO_MIME_TYPE);
+		return $finfo->file($this->getTmpFile());
+	}
+
+	/**
+	 * Gets the file's extension.
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function getExtension()
+	{
+		if (!$this->extension) {
+			$this->extension = $this->determineExtension();
+		}
+		return $this->extension;
+	}
+
+	/**
+	 * Determine's the file's extension given the temporary file.
+	 * @since $VID:$
+	 * @return string
+	 */
+	protected function determineExtension()
+	{
+		$position_of_period = strrpos($this->getName(), '.');
+		if ($position_of_period === false) {
+			return '';
+		}
+		return mb_substr(
+			$this->getName(),
+			$position_of_period + 1
+		);
+	}
+
+	/**
+	 * Gets the size of the file
+	 * @return int
+	 */
+	public function getSize()
+	{
+		return $this->size;
+	}
+
+	/**
+	 * Gets the path to the temporary file which was uploaded.
+	 * @return string
+	 */
+	public function getTmpFile()
+	{
+		return $this->tmp_file;
+	}
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->getName();
+	}
+
+	/**
+	 * Gets the error code PHP reported for the file upload.
+	 * @return string
+	 */
+	public function getErrorCode()
+	{
+		return $this->error_code;
+	}
 }
 // End of file FileSubmission.php
 // Location: EventEspresso\core\services\request\files/FileSubmission.php

Spacing +3 added lines, -3 removed lines

@@ -93,7 +93,7 @@ 
      */
     public function getType()
     {
-        if (!$this->type) {
+        if ( ! $this->type) {
             $this->type = $this->determineType();
         }
         return $this->type;
@@ -105,7 +105,7 @@ 
      */
     protected function determineType()
     {
-        if (!$this->getTmpFile()) {
+        if ( ! $this->getTmpFile()) {
             return '';
         }
         $finfo = new finfo(FILEINFO_MIME_TYPE);
@@ -119,7 +119,7 @@ 
      */
     public function getExtension()
     {
-        if (!$this->extension) {
+        if ( ! $this->extension) {
             $this->extension = $this->determineExtension();
         }
         return $this->extension;

core/services/json/JsonSerializableAndUnserializable.php

Indentation +14 added lines, -14 removed lines

@@ -15,21 +15,21 @@
  */
 interface JsonSerializableAndUnserializable
 {
-    /**
-     * Creates a simple PHP array or stdClass from this object's properties, which can be easily serialized using
-     * wp_json_serialize().
-     * @since $VID:$
-     * @return mixed
-     */
-    public function toJsonSerializableData();
+	/**
+	 * Creates a simple PHP array or stdClass from this object's properties, which can be easily serialized using
+	 * wp_json_serialize().
+	 * @since $VID:$
+	 * @return mixed
+	 */
+	public function toJsonSerializableData();
 
-    /**
-     * Initializes this object from data
-     * @since $VID:$
-     * @param mixed $data
-     * @return boolean success
-     */
-    public function fromJsonSerializedData($data);
+	/**
+	 * Initializes this object from data
+	 * @since $VID:$
+	 * @param mixed $data
+	 * @return boolean success
+	 */
+	public function fromJsonSerializedData($data);
 }
 // End of file JsonSerializableAndUnserializable.php
 // Location: EventEspresso\core\services\json/JsonSerializableAndUnserializable.php

core/services/locators/FqcnLocator.php

Doc Comments +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
      * given a valid namespace, will find all files that match the provided mask
      *
      * @access public
-     * @param string|array $namespaces
+     * @param string $namespaces
      * @return array
      * @throws InvalidClassException
      * @throws InvalidDataTypeException

Indentation +152 added lines, -152 removed lines

@@ -18,156 +18,156 @@
 class FqcnLocator extends Locator
 {
 
-    /**
-     * @var array $FQCNs
-     */
-    protected $FQCNs = array();
-
-    /**
-     * @var array $namespaces
-     */
-    protected $namespaces = array();
-
-
-    /**
-     * @access protected
-     * @param string $namespace
-     * @param string $namespace_base_dir
-     * @throws InvalidDataTypeException
-     */
-    protected function setNamespace($namespace, $namespace_base_dir)
-    {
-        if (! is_string($namespace)) {
-            throw new InvalidDataTypeException('$namespace', $namespace, 'string');
-        }
-        if (! is_string($namespace_base_dir)) {
-            throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
-        }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getFQCNs()
-    {
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->FQCNs);
-    }
-
-
-    /**
-     * given a valid namespace, will find all files that match the provided mask
-     *
-     * @access public
-     * @param string|array $namespaces
-     * @return array
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     */
-    public function locate($namespaces)
-    {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
-            throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
-        }
-        foreach ((array) $namespaces as $namespace) {
-            foreach ($this->findFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * given a partial namespace, will find all files in that folder
-     * ** PLZ NOTE **
-     * This assumes that all files within the specified folder should be loaded
-     *
-     * @access protected
-     * @param string $partial_namespace
-     * @return array
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     */
-    protected function findFQCNsByNamespace($partial_namespace)
-    {
-        $iterator = new FilesystemIterator(
-            $this->getDirectoryFromPartialNamespace($partial_namespace)
-        );
-        $iterator->setFlags(FilesystemIterator::CURRENT_AS_FILEINFO);
-        $iterator->setFlags(FilesystemIterator::UNIX_PATHS);
-        if (iterator_count($iterator) === 0) {
-            return array();
-        }
-        foreach ($iterator as $file) {
-            if ($file->isFile() && $file->getExtension() === 'php') {
-                $file = $file->getPath() . DS . $file->getBasename('.php');
-                foreach ($this->namespaces as $namespace => $base_dir) {
-                    $namespace .= Psr4Autoloader::NS;
-                    if (strpos($file, $base_dir) === 0) {
-                        $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
-                            array($base_dir, DS),
-                            array($namespace, Psr4Autoloader::NS),
-                            $file
-                        );
-                    }
-                }
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * getDirectoryFromPartialNamespace
-     *
-     * @access protected
-     * @param  string $partial_namespace almost fully qualified class name ?
-     * @return string
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    protected function getDirectoryFromPartialNamespace($partial_namespace)
-    {
-        if (empty($partial_namespace)) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        // load our PSR-4 Autoloader so we can get the list of registered namespaces from it
-        $psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
-        // breakup the incoming namespace into segments so we can loop thru them
-        $namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
-        // we're only interested in the Vendor and secondary base, so pull those from the array
-        $vendor_base = array_slice($namespace_segments, 0, 2);
-        $namespace = $prefix = null;
-        while (! empty($vendor_base)) {
-            $namespace = implode(Psr4Autoloader::NS, $vendor_base);
-            // check if there's a base directory registered for that namespace
-            $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
-            if (! empty($prefix) && ! empty($prefix[0])) {
-                // found one!
-                break;
-            }
-            // remove base and try vendor only portion of namespace
-            array_pop($vendor_base);
-        }
-        // nope? then the incoming namespace is invalid
-        if (empty($prefix) || empty($prefix[0])) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        $this->setNamespace($namespace, $prefix[0]);
-        // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, array_diff($namespace_segments, $vendor_base)) . DS;
-    }
+	/**
+	 * @var array $FQCNs
+	 */
+	protected $FQCNs = array();
+
+	/**
+	 * @var array $namespaces
+	 */
+	protected $namespaces = array();
+
+
+	/**
+	 * @access protected
+	 * @param string $namespace
+	 * @param string $namespace_base_dir
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setNamespace($namespace, $namespace_base_dir)
+	{
+		if (! is_string($namespace)) {
+			throw new InvalidDataTypeException('$namespace', $namespace, 'string');
+		}
+		if (! is_string($namespace_base_dir)) {
+			throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
+		}
+		$this->namespaces[ $namespace ] = $namespace_base_dir;
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getFQCNs()
+	{
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->FQCNs);
+	}
+
+
+	/**
+	 * given a valid namespace, will find all files that match the provided mask
+	 *
+	 * @access public
+	 * @param string|array $namespaces
+	 * @return array
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 */
+	public function locate($namespaces)
+	{
+		if (! (is_string($namespaces) || is_array($namespaces))) {
+			throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
+		}
+		foreach ((array) $namespaces as $namespace) {
+			foreach ($this->findFQCNsByNamespace($namespace) as $key => $file) {
+				$this->FQCNs[ $key ] = $file;
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * given a partial namespace, will find all files in that folder
+	 * ** PLZ NOTE **
+	 * This assumes that all files within the specified folder should be loaded
+	 *
+	 * @access protected
+	 * @param string $partial_namespace
+	 * @return array
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function findFQCNsByNamespace($partial_namespace)
+	{
+		$iterator = new FilesystemIterator(
+			$this->getDirectoryFromPartialNamespace($partial_namespace)
+		);
+		$iterator->setFlags(FilesystemIterator::CURRENT_AS_FILEINFO);
+		$iterator->setFlags(FilesystemIterator::UNIX_PATHS);
+		if (iterator_count($iterator) === 0) {
+			return array();
+		}
+		foreach ($iterator as $file) {
+			if ($file->isFile() && $file->getExtension() === 'php') {
+				$file = $file->getPath() . DS . $file->getBasename('.php');
+				foreach ($this->namespaces as $namespace => $base_dir) {
+					$namespace .= Psr4Autoloader::NS;
+					if (strpos($file, $base_dir) === 0) {
+						$this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+							array($base_dir, DS),
+							array($namespace, Psr4Autoloader::NS),
+							$file
+						);
+					}
+				}
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * getDirectoryFromPartialNamespace
+	 *
+	 * @access protected
+	 * @param  string $partial_namespace almost fully qualified class name ?
+	 * @return string
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	protected function getDirectoryFromPartialNamespace($partial_namespace)
+	{
+		if (empty($partial_namespace)) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		// load our PSR-4 Autoloader so we can get the list of registered namespaces from it
+		$psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
+		// breakup the incoming namespace into segments so we can loop thru them
+		$namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
+		// we're only interested in the Vendor and secondary base, so pull those from the array
+		$vendor_base = array_slice($namespace_segments, 0, 2);
+		$namespace = $prefix = null;
+		while (! empty($vendor_base)) {
+			$namespace = implode(Psr4Autoloader::NS, $vendor_base);
+			// check if there's a base directory registered for that namespace
+			$prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+			if (! empty($prefix) && ! empty($prefix[0])) {
+				// found one!
+				break;
+			}
+			// remove base and try vendor only portion of namespace
+			array_pop($vendor_base);
+		}
+		// nope? then the incoming namespace is invalid
+		if (empty($prefix) || empty($prefix[0])) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		$this->setNamespace($namespace, $prefix[0]);
+		// but if it's good, add that base directory to the rest of the path, and return it
+		return $prefix[0] . implode(DS, array_diff($namespace_segments, $vendor_base)) . DS;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -37,13 +37,13 @@ 
      */
     protected function setNamespace($namespace, $namespace_base_dir)
     {
-        if (! is_string($namespace)) {
+        if ( ! is_string($namespace)) {
             throw new InvalidDataTypeException('$namespace', $namespace, 'string');
         }
-        if (! is_string($namespace_base_dir)) {
+        if ( ! is_string($namespace_base_dir)) {
             throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
         }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
+        $this->namespaces[$namespace] = $namespace_base_dir;
     }
 
 
@@ -78,12 +78,12 @@ 
      */
     public function locate($namespaces)
     {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
+        if ( ! (is_string($namespaces) || is_array($namespaces))) {
             throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
         }
         foreach ((array) $namespaces as $namespace) {
             foreach ($this->findFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
+                $this->FQCNs[$key] = $file;
             }
         }
         return $this->FQCNs;
@@ -113,11 +113,11 @@ 
         }
         foreach ($iterator as $file) {
             if ($file->isFile() && $file->getExtension() === 'php') {
-                $file = $file->getPath() . DS . $file->getBasename('.php');
+                $file = $file->getPath().DS.$file->getBasename('.php');
                 foreach ($this->namespaces as $namespace => $base_dir) {
                     $namespace .= Psr4Autoloader::NS;
                     if (strpos($file, $base_dir) === 0) {
-                        $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+                        $this->FQCNs[] = Psr4Autoloader::NS.str_replace(
                             array($base_dir, DS),
                             array($namespace, Psr4Autoloader::NS),
                             $file
@@ -151,11 +151,11 @@ 
         // we're only interested in the Vendor and secondary base, so pull those from the array
         $vendor_base = array_slice($namespace_segments, 0, 2);
         $namespace = $prefix = null;
-        while (! empty($vendor_base)) {
+        while ( ! empty($vendor_base)) {
             $namespace = implode(Psr4Autoloader::NS, $vendor_base);
             // check if there's a base directory registered for that namespace
-            $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
-            if (! empty($prefix) && ! empty($prefix[0])) {
+            $prefix = $psr4_loader->prefixes($namespace.Psr4Autoloader::NS);
+            if ( ! empty($prefix) && ! empty($prefix[0])) {
                 // found one!
                 break;
             }
@@ -168,6 +168,6 @@ 
         }
         $this->setNamespace($namespace, $prefix[0]);
         // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, array_diff($namespace_segments, $vendor_base)) . DS;
+        return $prefix[0].implode(DS, array_diff($namespace_segments, $vendor_base)).DS;
     }
 }

core/libraries/plugin_api/EE_Register_Model_Extensions.lib.php

Indentation +111 added lines, -111 removed lines

@@ -12,121 +12,121 @@
 class EE_Register_Model_Extensions implements EEI_Plugin_API
 {
 
-    protected static $_registry;
-    protected static $_extensions = array();
+	protected static $_registry;
+	protected static $_extensions = array();
 
-    /**
-     * register method for setting up model extensions
-     *
-     * @param string $model_id unique id for the extensions being setup
-     * @param array  $config {
-     * @throws EE_Error
-     * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
-     *        the models naming convention, which is: EEME_{your_plugin_slug}_model_name_extended}.model_ext.php. Where
-     *        your_plugin_slug} is really anything you want (but something having to do with your addon, like
-     *        'Calendar' or '3D_View') and model_name_extended} is the model extended. The class contained in teh file
-     *        should extend EEME_Base_{model_name_extended}.model_ext.php. Where {your_plugin_slug} is really anything
-     *        you want (but something having to do with your addon, like 'Calendar' or '3D_View') and
-     *        {model_name_extended} is the model extended. The class contained in teh file should extend EEME_Base
-     * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
-     *       the model class extension naming convention, which is:
-     *       EEE_{your_plugin_slug}_model_name_extended}.class_ext.php. Where your_plugin_slug} is something like
-     *       'Calendar','MailChimp',etc, and model_name_extended} is the name of the model extended, eg
-     *       'Attendee','Event',etc. The class contained in the file should extend
-     *       EEE_Base_Class._{model_name_extended}.class_ext.php. Where {your_plugin_slug} is something like
-     *       'Calendar','MailChimp',etc, and {model_name_extended} is the name of the model extended, eg
-     *       'Attendee','Event',etc. The class contained in the file should extend EEE_Base_Class.
-     *                                      }
-     *
-     * @return void
-     */
-    public static function register($model_id = null, $config = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($model_id)
-            || ! is_array($config)
-            || (empty($config['model_extension_paths']) && empty($config['class_extension_paths']))
-        ) {
-            throw new EE_Error(
-                __(
-                    'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * register method for setting up model extensions
+	 *
+	 * @param string $model_id unique id for the extensions being setup
+	 * @param array  $config {
+	 * @throws EE_Error
+	 * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
+	 *        the models naming convention, which is: EEME_{your_plugin_slug}_model_name_extended}.model_ext.php. Where
+	 *        your_plugin_slug} is really anything you want (but something having to do with your addon, like
+	 *        'Calendar' or '3D_View') and model_name_extended} is the model extended. The class contained in teh file
+	 *        should extend EEME_Base_{model_name_extended}.model_ext.php. Where {your_plugin_slug} is really anything
+	 *        you want (but something having to do with your addon, like 'Calendar' or '3D_View') and
+	 *        {model_name_extended} is the model extended. The class contained in teh file should extend EEME_Base
+	 * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
+	 *       the model class extension naming convention, which is:
+	 *       EEE_{your_plugin_slug}_model_name_extended}.class_ext.php. Where your_plugin_slug} is something like
+	 *       'Calendar','MailChimp',etc, and model_name_extended} is the name of the model extended, eg
+	 *       'Attendee','Event',etc. The class contained in the file should extend
+	 *       EEE_Base_Class._{model_name_extended}.class_ext.php. Where {your_plugin_slug} is something like
+	 *       'Calendar','MailChimp',etc, and {model_name_extended} is the name of the model extended, eg
+	 *       'Attendee','Event',etc. The class contained in the file should extend EEE_Base_Class.
+	 *                                      }
+	 *
+	 * @return void
+	 */
+	public static function register($model_id = null, $config = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($model_id)
+			|| ! is_array($config)
+			|| (empty($config['model_extension_paths']) && empty($config['class_extension_paths']))
+		) {
+			throw new EE_Error(
+				__(
+					'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $model_id ])) {
-            return;
-        }
-        // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
-                        'event_espresso'
-                    ),
-                    $model_id,
-                    '<br />',
-                    did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
-                    did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
-                ),
-                '4.3'
-            );
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $model_id ])) {
+			return;
+		}
+		// check correct loading
+		if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
+						'event_espresso'
+					),
+					$model_id,
+					'<br />',
+					did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
+					did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
+				),
+				'4.3'
+			);
+		}
 
-        self::$_registry[ $model_id ] = $config;
-        self::$_extensions[ $model_id ] = array();
+		self::$_registry[ $model_id ] = $config;
+		self::$_extensions[ $model_id ] = array();
 
-        if (isset($config['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($config['model_extension_paths']);
-            // remove all files that are not PHP
-            foreach ($class_to_filepath_map as $class => $path) {
-                if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
-                    continue;
-                }
-            }
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $model_id ]['models'][ $classname ] = new $classname;
-            }
-            unset($config['model_extension_paths']);
-        }
-        if (isset($config['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($config['class_extension_paths']);
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $model_id ]['classes'][ $classname ] = new $classname;
-            }
-            unset($config['class_extension_paths']);
-        }
-        foreach ($config as $unknown_key => $unknown_config) {
-            throw new EE_Error(
-                sprintf(__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
-            );
-        }
-    }
+		if (isset($config['model_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($config['model_extension_paths']);
+			// remove all files that are not PHP
+			foreach ($class_to_filepath_map as $class => $path) {
+				if (substr($path, strlen($path) - 3) !== 'php') {
+					unset($class_to_filepath_map[ $class ]);
+					continue;
+				}
+			}
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $model_id ]['models'][ $classname ] = new $classname;
+			}
+			unset($config['model_extension_paths']);
+		}
+		if (isset($config['class_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($config['class_extension_paths']);
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $model_id ]['classes'][ $classname ] = new $classname;
+			}
+			unset($config['class_extension_paths']);
+		}
+		foreach ($config as $unknown_key => $unknown_config) {
+			throw new EE_Error(
+				sprintf(__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
+			);
+		}
+	}
 
 
-    /**
-     * deregister
-     *
-     * @param string $model_id
-     */
-    public static function deregister($model_id = null)
-    {
-        if (isset(self::$_registry[ $model_id ])) {
-            unset(self::$_registry[ $model_id ]);
-            foreach (self::$_extensions[ $model_id ] as $extension_of_type) {
-                foreach ($extension_of_type as $extension) {
-                    $extension->deregister();
-                }
-            }
-        }
-    }
+	/**
+	 * deregister
+	 *
+	 * @param string $model_id
+	 */
+	public static function deregister($model_id = null)
+	{
+		if (isset(self::$_registry[ $model_id ])) {
+			unset(self::$_registry[ $model_id ]);
+			foreach (self::$_extensions[ $model_id ] as $extension_of_type) {
+				foreach ($extension_of_type as $extension) {
+					$extension->deregister();
+				}
+			}
+		}
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -56,11 +56,11 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $model_id ])) {
+        if (isset(self::$_registry[$model_id])) {
             return;
         }
         // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
             EE_Error::doing_it_wrong(
                 __METHOD__,
                 sprintf(
@@ -77,31 +77,31 @@ 
             );
         }
 
-        self::$_registry[ $model_id ] = $config;
-        self::$_extensions[ $model_id ] = array();
+        self::$_registry[$model_id] = $config;
+        self::$_extensions[$model_id] = array();
 
         if (isset($config['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+            require_once(EE_LIBRARIES.'plugin_api/db/EEME_Base.lib.php');
             $class_to_filepath_map = EEH_File::get_contents_of_folders($config['model_extension_paths']);
             // remove all files that are not PHP
             foreach ($class_to_filepath_map as $class => $path) {
                 if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
+                    unset($class_to_filepath_map[$class]);
                     continue;
                 }
             }
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $model_id ]['models'][ $classname ] = new $classname;
+                self::$_extensions[$model_id]['models'][$classname] = new $classname;
             }
             unset($config['model_extension_paths']);
         }
         if (isset($config['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+            require_once(EE_LIBRARIES.'plugin_api/db/EEE_Base_Class.lib.php');
             $class_to_filepath_map = EEH_File::get_contents_of_folders($config['class_extension_paths']);
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $model_id ]['classes'][ $classname ] = new $classname;
+                self::$_extensions[$model_id]['classes'][$classname] = new $classname;
             }
             unset($config['class_extension_paths']);
         }
@@ -120,9 +120,9 @@ 
      */
     public static function deregister($model_id = null)
     {
-        if (isset(self::$_registry[ $model_id ])) {
-            unset(self::$_registry[ $model_id ]);
-            foreach (self::$_extensions[ $model_id ] as $extension_of_type) {
+        if (isset(self::$_registry[$model_id])) {
+            unset(self::$_registry[$model_id]);
+            foreach (self::$_extensions[$model_id] as $extension_of_type) {
                 foreach ($extension_of_type as $extension) {
                     $extension->deregister();
                 }

core/libraries/form_sections/inputs/EE_Select_Ajax_Model_Rest_Input.input.php

Indentation +176 added lines, -176 removed lines

@@ -17,189 +17,189 @@
 class EE_Select_Ajax_Model_Rest_Input extends EE_Form_Input_With_Options_Base
 {
 
-    /**
-     * @var string $_model_name
-     */
-    protected $_model_name;
+	/**
+	 * @var string $_model_name
+	 */
+	protected $_model_name;
 
-    /**
-     * @var string $_display_field_name
-     */
-    protected $_display_field_name;
+	/**
+	 * @var string $_display_field_name
+	 */
+	protected $_display_field_name;
 
-    /**
-     * @var string $_value_field_name
-     */
-    protected $_value_field_name;
+	/**
+	 * @var string $_value_field_name
+	 */
+	protected $_value_field_name;
 
-    /**
-     * @var array $_extra_select_columns
-     */
-    protected $_extra_select_columns = array();
+	/**
+	 * @var array $_extra_select_columns
+	 */
+	protected $_extra_select_columns = array();
 
 
-    /**
-     * @param array $input_settings     {
-     * @type string $model_name         the name of model to be used for searching, both via the REST API and server-side model queries
-     * @type array  $query_params       default query parameters which will apply to both REST API queries and server-side queries. This should be
-     *                                  in the exact format that will be used for server-side model usage (eg use index 0 for where conditions, not
-     *                                  the string "where")
-     * @type string $value_field_name   the name of the model field on this model to
-     *                                  be used for the HTML select's option's values
-     * @type string $display_field_name the name of the model field on this model
-     *                                  to be used for the HTML select's option's display text
-     * @type array  $select2_args       arguments to be passed directly into the select2's JS constructor
-     *                                  }
-     *                                  And the arguments accepted by EE_Form_Input_With_Options_Base
-     * }
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct($input_settings = array())
-    {
-        // needed input settings:
-        // select2_args
-        $this->_model_name = EEH_Array::is_set(
-            $input_settings,
-            'model_name',
-            null
-        );
-        $model = $this->_get_model();
-        $query_params = EEH_Array::is_set(
-            $input_settings,
-            'query_params',
-            array()
-        );
-        // make sure limit and caps are always set
-        $query_params = array_merge(
-            array( 'limit' => 10, 'caps' => EEM_Base::caps_read_admin ),
-            $query_params
-        );
-        $this->_value_field_name = EEH_Array::is_set(
-            $input_settings,
-            'value_field_name',
-            $model->primary_key_name()
-        );
-        $this->_display_field_name = EEH_Array::is_set(
-            $input_settings,
-            'display_field_name',
-            $model->get_a_field_of_type('EE_Text_Field_Base')->get_name()
-        );
-        $this->_extra_select_columns = EEH_Array::is_set(
-            $input_settings,
-            'extra_select_columns',
-            array()
-        );
-        $this->_add_validation_strategy(
-            new EE_Model_Matching_Query_Validation_Strategy(
-                '',
-                $this->_model_name,
-                $query_params,
-                $this->_value_field_name
-            )
-        );
-        // get resource endpoint
-        $rest_controller = LoaderFactory::getLoader()->getNew(
-            'EventEspresso\core\libraries\rest_api\controllers\model\Read'
-        );
-        $rest_controller->setRequestedVersion(EED_Core_Rest_Api::latest_rest_api_version());
-        $default_select2_args = array(
-            'ajax' => array(
-                'url' => $rest_controller->getVersionedLinkTo(
-                    EEH_Inflector::pluralize_and_lower($this->_model_name)
-                ),
-                'dataType' => 'json',
-                'delay' => '250',
-                'data_interface' => 'EE_Select2_REST_API_Interface',
-                'data_interface_args' => array(
-                    'default_query_params' => (object) ModelDataTranslator::prepareQueryParamsForRestApi(
-                        $query_params,
-                        $model
-                    ),
-                    'display_field' => $this->_display_field_name,
-                    'value_field' => $this->_value_field_name,
-                    'nonce' => wp_create_nonce('wp_rest'),
-                    'locale' => str_replace('_', '-', strtolower(get_locale()))
-                ),
-            ),
-            'cache' => true,
-            'width' => 'resolve'
-        );
-        $select2_args = array_replace_recursive(
-            $default_select2_args,
-            (array) EEH_Array::is_set($input_settings, 'select2_args', array())
-        );
-        $this->set_display_strategy(new EE_Select2_Display_Strategy($select2_args));
-        parent::__construct(array(), $input_settings);
-    }
+	/**
+	 * @param array $input_settings     {
+	 * @type string $model_name         the name of model to be used for searching, both via the REST API and server-side model queries
+	 * @type array  $query_params       default query parameters which will apply to both REST API queries and server-side queries. This should be
+	 *                                  in the exact format that will be used for server-side model usage (eg use index 0 for where conditions, not
+	 *                                  the string "where")
+	 * @type string $value_field_name   the name of the model field on this model to
+	 *                                  be used for the HTML select's option's values
+	 * @type string $display_field_name the name of the model field on this model
+	 *                                  to be used for the HTML select's option's display text
+	 * @type array  $select2_args       arguments to be passed directly into the select2's JS constructor
+	 *                                  }
+	 *                                  And the arguments accepted by EE_Form_Input_With_Options_Base
+	 * }
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct($input_settings = array())
+	{
+		// needed input settings:
+		// select2_args
+		$this->_model_name = EEH_Array::is_set(
+			$input_settings,
+			'model_name',
+			null
+		);
+		$model = $this->_get_model();
+		$query_params = EEH_Array::is_set(
+			$input_settings,
+			'query_params',
+			array()
+		);
+		// make sure limit and caps are always set
+		$query_params = array_merge(
+			array( 'limit' => 10, 'caps' => EEM_Base::caps_read_admin ),
+			$query_params
+		);
+		$this->_value_field_name = EEH_Array::is_set(
+			$input_settings,
+			'value_field_name',
+			$model->primary_key_name()
+		);
+		$this->_display_field_name = EEH_Array::is_set(
+			$input_settings,
+			'display_field_name',
+			$model->get_a_field_of_type('EE_Text_Field_Base')->get_name()
+		);
+		$this->_extra_select_columns = EEH_Array::is_set(
+			$input_settings,
+			'extra_select_columns',
+			array()
+		);
+		$this->_add_validation_strategy(
+			new EE_Model_Matching_Query_Validation_Strategy(
+				'',
+				$this->_model_name,
+				$query_params,
+				$this->_value_field_name
+			)
+		);
+		// get resource endpoint
+		$rest_controller = LoaderFactory::getLoader()->getNew(
+			'EventEspresso\core\libraries\rest_api\controllers\model\Read'
+		);
+		$rest_controller->setRequestedVersion(EED_Core_Rest_Api::latest_rest_api_version());
+		$default_select2_args = array(
+			'ajax' => array(
+				'url' => $rest_controller->getVersionedLinkTo(
+					EEH_Inflector::pluralize_and_lower($this->_model_name)
+				),
+				'dataType' => 'json',
+				'delay' => '250',
+				'data_interface' => 'EE_Select2_REST_API_Interface',
+				'data_interface_args' => array(
+					'default_query_params' => (object) ModelDataTranslator::prepareQueryParamsForRestApi(
+						$query_params,
+						$model
+					),
+					'display_field' => $this->_display_field_name,
+					'value_field' => $this->_value_field_name,
+					'nonce' => wp_create_nonce('wp_rest'),
+					'locale' => str_replace('_', '-', strtolower(get_locale()))
+				),
+			),
+			'cache' => true,
+			'width' => 'resolve'
+		);
+		$select2_args = array_replace_recursive(
+			$default_select2_args,
+			(array) EEH_Array::is_set($input_settings, 'select2_args', array())
+		);
+		$this->set_display_strategy(new EE_Select2_Display_Strategy($select2_args));
+		parent::__construct(array(), $input_settings);
+	}
 
 
 
-    /**
-     * Before setting the raw value (usually because we're setting the default,
-     * or we've received a form submission and this might be re-displayed to the user),
-     * sets the options so that the current selections appear on initial display.
-     *
-     * Note: because this input uses EE_Model_Matching_Query_Validation_Strategy
-     * for validation, this input's options only affect DISPLAY and NOT validation,
-     * which is why its ok to just assume the provided $value to be in the list of acceptable values
-     *
-     * @param mixed $value
-     * @return void
-     * @throws \EE_Error
-     */
-    public function _set_raw_value($value)
-    {
-        $values_for_options = (array) $value;
-        $value_field = $this->_get_model()->field_settings_for($this->_value_field_name);
-        $display_field = $this->_get_model()->field_settings_for($this->_display_field_name);
-        $this->_extra_select_columns[] = $value_field->get_qualified_column() . ' AS ' . $this->_value_field_name;
-        $this->_extra_select_columns[] = $display_field->get_qualified_column() . ' AS ' . $this->_display_field_name;
-        $display_values = $this->_get_model()->get_all_wpdb_results(
-            array(
-                array(
-                    $this->_value_field_name => array( 'IN', $values_for_options )
-                )
-            ),
-            ARRAY_A,
-            implode(',', $this->_extra_select_columns)
-        );
-        $select_options = array();
-        if (is_array($select_options)) {
-            foreach ($display_values as $db_rows) {
-                $db_rows = (array) $db_rows;
-                $select_options[ $db_rows[ $this->_value_field_name ] ] = apply_filters(
-                    'FHEE__EE_Select_Ajax_Model_Rest_Input___set_raw_value__select_option_value',
-                    $db_rows[ $this->_display_field_name ],
-                    $db_rows
-                );
-            }
-        }
-        $this->set_select_options($select_options);
-        parent::_set_raw_value($value);
-    }
+	/**
+	 * Before setting the raw value (usually because we're setting the default,
+	 * or we've received a form submission and this might be re-displayed to the user),
+	 * sets the options so that the current selections appear on initial display.
+	 *
+	 * Note: because this input uses EE_Model_Matching_Query_Validation_Strategy
+	 * for validation, this input's options only affect DISPLAY and NOT validation,
+	 * which is why its ok to just assume the provided $value to be in the list of acceptable values
+	 *
+	 * @param mixed $value
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function _set_raw_value($value)
+	{
+		$values_for_options = (array) $value;
+		$value_field = $this->_get_model()->field_settings_for($this->_value_field_name);
+		$display_field = $this->_get_model()->field_settings_for($this->_display_field_name);
+		$this->_extra_select_columns[] = $value_field->get_qualified_column() . ' AS ' . $this->_value_field_name;
+		$this->_extra_select_columns[] = $display_field->get_qualified_column() . ' AS ' . $this->_display_field_name;
+		$display_values = $this->_get_model()->get_all_wpdb_results(
+			array(
+				array(
+					$this->_value_field_name => array( 'IN', $values_for_options )
+				)
+			),
+			ARRAY_A,
+			implode(',', $this->_extra_select_columns)
+		);
+		$select_options = array();
+		if (is_array($select_options)) {
+			foreach ($display_values as $db_rows) {
+				$db_rows = (array) $db_rows;
+				$select_options[ $db_rows[ $this->_value_field_name ] ] = apply_filters(
+					'FHEE__EE_Select_Ajax_Model_Rest_Input___set_raw_value__select_option_value',
+					$db_rows[ $this->_display_field_name ],
+					$db_rows
+				);
+			}
+		}
+		$this->set_select_options($select_options);
+		parent::_set_raw_value($value);
+	}
 
-    /**
-     * Returns the model, or throws an exception if the model name provided in constructor doesn't exist
-     * @return EEM_Base
-     * @throws EE_Error
-     */
-    protected function _get_model()
-    {
-        if (! EE_Registry::instance()->is_model_name($this->_model_name)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '%1$s is not a proper model name. Please provide a model name in the "model_name" form input argument',
-                        'event_espresso'
-                    ),
-                    $this->_model_name
-                )
-            );
-        } else {
-            return EE_Registry::instance()->load_model($this->_model_name);
-        }
-    }
+	/**
+	 * Returns the model, or throws an exception if the model name provided in constructor doesn't exist
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 */
+	protected function _get_model()
+	{
+		if (! EE_Registry::instance()->is_model_name($this->_model_name)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'%1$s is not a proper model name. Please provide a model name in the "model_name" form input argument',
+						'event_espresso'
+					),
+					$this->_model_name
+				)
+			);
+		} else {
+			return EE_Registry::instance()->load_model($this->_model_name);
+		}
+	}
 }

core/libraries/form_sections/strategies/display/EE_Select_Display_Strategy.strategy.php

Indentation +65 added lines, -65 removed lines

@@ -14,78 +14,78 @@
 class EE_Select_Display_Strategy extends EE_Display_Strategy_Base
 {
 
-    /**
-     *
-     * @throws EE_Error
-     * @return string of html to display the field
-     */
-    public function display()
-    {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
-            throw new EE_Error(sprintf(__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
-        }
+	/**
+	 *
+	 * @throws EE_Error
+	 * @return string of html to display the field
+	 */
+	public function display()
+	{
+		if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(sprintf(__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
+		}
 
-        $html = EEH_HTML::nl(0, 'select');
-        $html .= '<select';
-        $html .= $this->_attributes_string(
-            $this->_standard_attributes_array()
-        );
-        $html .= '>';
+		$html = EEH_HTML::nl(0, 'select');
+		$html .= '<select';
+		$html .= $this->_attributes_string(
+			$this->_standard_attributes_array()
+		);
+		$html .= '>';
 
-        if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
-            EEH_HTML::indent(1, 'optgroup');
-            foreach ($this->_input->options() as $opt_group_label => $opt_group) {
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
-                }
-                EEH_HTML::indent(1, 'option');
-                $html .= $this->_display_options($opt_group);
-                EEH_HTML::indent(-1, 'option');
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
-                }
-            }
-            EEH_HTML::indent(-1, 'optgroup');
-        } else {
-            $html.=$this->_display_options($this->_input->options());
-        }
+		if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
+			EEH_HTML::indent(1, 'optgroup');
+			foreach ($this->_input->options() as $opt_group_label => $opt_group) {
+				if (! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+				}
+				EEH_HTML::indent(1, 'option');
+				$html .= $this->_display_options($opt_group);
+				EEH_HTML::indent(-1, 'option');
+				if (! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
+				}
+			}
+			EEH_HTML::indent(-1, 'optgroup');
+		} else {
+			$html.=$this->_display_options($this->_input->options());
+		}
 
-        $html.= EEH_HTML::nl(0, 'select') . '</select>';
-        return $html;
-    }
+		$html.= EEH_HTML::nl(0, 'select') . '</select>';
+		return $html;
+	}
 
 
 
-    /**
-     * Displays a flat list of options as option tags
-     * @param array $options
-     * @return string
-     */
-    protected function _display_options($options)
-    {
-        $html = '';
-        EEH_HTML::indent(1, 'option');
-        foreach ($options as $value => $display_text) {
-            // even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
-            // PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
-            $unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
-            $selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
-            $html.= EEH_HTML::nl(0, 'option') . '<option value="' . esc_attr($unnormalized_value) . '"' . $selected . '>' . $display_text . '</option>';
-        }
-        EEH_HTML::indent(-1, 'option');
-        return $html;
-    }
+	/**
+	 * Displays a flat list of options as option tags
+	 * @param array $options
+	 * @return string
+	 */
+	protected function _display_options($options)
+	{
+		$html = '';
+		EEH_HTML::indent(1, 'option');
+		foreach ($options as $value => $display_text) {
+			// even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
+			// PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
+			$unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
+			$selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
+			$html.= EEH_HTML::nl(0, 'option') . '<option value="' . esc_attr($unnormalized_value) . '"' . $selected . '>' . $display_text . '</option>';
+		}
+		EEH_HTML::indent(-1, 'option');
+		return $html;
+	}
 
 
 
-    /**
-     * Checks if that value is the one selected
-     *
-     * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
-     * @return string
-     */
-    protected function _check_if_option_selected($option_value)
-    {
-        return $option_value === $this->_input->raw_value();
-    }
+	/**
+	 * Checks if that value is the one selected
+	 *
+	 * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
+	 * @return string
+	 */
+	protected function _check_if_option_selected($option_value)
+	{
+		return $option_value === $this->_input->raw_value();
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -21,7 +21,7 @@ 
      */
     public function display()
     {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+        if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) {
             throw new EE_Error(sprintf(__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
         }
 
@@ -35,22 +35,22 @@ 
         if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
             EEH_HTML::indent(1, 'optgroup');
             foreach ($this->_input->options() as $opt_group_label => $opt_group) {
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+                if ( ! empty($opt_group_label)) {
+                    $html .= EEH_HTML::nl(0, 'optgroup').'<optgroup label="'.esc_attr($opt_group_label).'">';
                 }
                 EEH_HTML::indent(1, 'option');
                 $html .= $this->_display_options($opt_group);
                 EEH_HTML::indent(-1, 'option');
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
+                if ( ! empty($opt_group_label)) {
+                    $html .= EEH_HTML::nl(0, 'optgroup').'</optgroup>';
                 }
             }
             EEH_HTML::indent(-1, 'optgroup');
         } else {
-            $html.=$this->_display_options($this->_input->options());
+            $html .= $this->_display_options($this->_input->options());
         }
 
-        $html.= EEH_HTML::nl(0, 'select') . '</select>';
+        $html .= EEH_HTML::nl(0, 'select').'</select>';
         return $html;
     }
 
@@ -70,7 +70,7 @@ 
             // PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
             $unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
             $selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
-            $html.= EEH_HTML::nl(0, 'option') . '<option value="' . esc_attr($unnormalized_value) . '"' . $selected . '>' . $display_text . '</option>';
+            $html .= EEH_HTML::nl(0, 'option').'<option value="'.esc_attr($unnormalized_value).'"'.$selected.'>'.$display_text.'</option>';
         }
         EEH_HTML::indent(-1, 'option');
         return $html;

core/libraries/form_sections/strategies/display/EE_Select2_Display_Strategy.strategy.php

Indentation +70 added lines, -70 removed lines

@@ -15,80 +15,80 @@
 class EE_Select2_Display_Strategy extends EE_Select_Display_Strategy
 {
 
-    /**
-     * Arguments that will be passed into the select2 javascript constructor
-     * @var array
-     */
-    protected $_select2_js_args = array();
+	/**
+	 * Arguments that will be passed into the select2 javascript constructor
+	 * @var array
+	 */
+	protected $_select2_js_args = array();
 
-    /**
-     *
-     * @param array $select2_js_args pass in the EXACT array of JS arguments you want
-     * to pass into the select2 js/html input. See https://select2.github.io
-     */
-    public function __construct($select2_js_args = array())
-    {
-        $this->_select2_js_args = $select2_js_args;
-        parent::__construct();
-    }
+	/**
+	 *
+	 * @param array $select2_js_args pass in the EXACT array of JS arguments you want
+	 * to pass into the select2 js/html input. See https://select2.github.io
+	 */
+	public function __construct($select2_js_args = array())
+	{
+		$this->_select2_js_args = $select2_js_args;
+		parent::__construct();
+	}
 
-    /**
-     * enqueues the select2 initializing js (which depends on the select2 js) and
-     * the select2 css
-     */
-    public function enqueue_js()
-    {
-        // need to first deregister the select2 script in case some other plugin **cough cough Toolset Types cough**
-        // is carelessly registering an older version of Select2 on admin pages that don't even belong to them
-        wp_deregister_script('select2');
-        wp_deregister_style('select2');
-        wp_register_script('select2', EE_GLOBAL_ASSETS_URL . 'scripts/select2.min.js', array(), '4.0.2', true);
-        wp_register_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all');
-        wp_enqueue_script('form_section_select2_init', EE_GLOBAL_ASSETS_URL . 'scripts/form_section_select2_init.js', array( 'select2' ), '1.0.0', true);
-        wp_enqueue_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all');
-    }
+	/**
+	 * enqueues the select2 initializing js (which depends on the select2 js) and
+	 * the select2 css
+	 */
+	public function enqueue_js()
+	{
+		// need to first deregister the select2 script in case some other plugin **cough cough Toolset Types cough**
+		// is carelessly registering an older version of Select2 on admin pages that don't even belong to them
+		wp_deregister_script('select2');
+		wp_deregister_style('select2');
+		wp_register_script('select2', EE_GLOBAL_ASSETS_URL . 'scripts/select2.min.js', array(), '4.0.2', true);
+		wp_register_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all');
+		wp_enqueue_script('form_section_select2_init', EE_GLOBAL_ASSETS_URL . 'scripts/form_section_select2_init.js', array( 'select2' ), '1.0.0', true);
+		wp_enqueue_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all');
+	}
 
-    /**
-     * Gets the javascript args which will be localized and passed into the select2 js/html input
-     * @return array
-     */
-    public function get_js_args()
-    {
-        return $this->_select2_js_args;
-    }
+	/**
+	 * Gets the javascript args which will be localized and passed into the select2 js/html input
+	 * @return array
+	 */
+	public function get_js_args()
+	{
+		return $this->_select2_js_args;
+	}
 
-    /**
-     * Sets the exact js args which will be passed into the select2 js/html input
-     * @param array $js_args
-     */
-    public function set_js_args($js_args)
-    {
-        $this->_select2_js_args = $js_args;
-    }
+	/**
+	 * Sets the exact js args which will be passed into the select2 js/html input
+	 * @param array $js_args
+	 */
+	public function set_js_args($js_args)
+	{
+		$this->_select2_js_args = $js_args;
+	}
 
-    /**
-     * Adds select2 data for localization
-     * @param array $other_js_data
-     * @return array
-     */
-    public function get_other_js_data($other_js_data = array())
-    {
-        $other_js_data = parent::get_other_js_data($other_js_data);
-        if (! isset($other_js_data['select2s'])) {
-            $other_js_data['select2s'] = array();
-        }
-        $other_js_data['select2s'][ $this->_input->html_id() ] = $this->get_js_args();
-        return $other_js_data;
-    }
+	/**
+	 * Adds select2 data for localization
+	 * @param array $other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($other_js_data = array())
+	{
+		$other_js_data = parent::get_other_js_data($other_js_data);
+		if (! isset($other_js_data['select2s'])) {
+			$other_js_data['select2s'] = array();
+		}
+		$other_js_data['select2s'][ $this->_input->html_id() ] = $this->get_js_args();
+		return $other_js_data;
+	}
 
-    /**
-     * Overrides standard attributes array to add the CSS class "ee-select2"
-     * @return array
-     */
-    protected function _standard_attributes_array()
-    {
-        $standard_attributes = parent::_standard_attributes_array();
-        $standard_attributes['class'] .= ' ee-select2';
-        return $standard_attributes;
-    }
+	/**
+	 * Overrides standard attributes array to add the CSS class "ee-select2"
+	 * @return array
+	 */
+	protected function _standard_attributes_array()
+	{
+		$standard_attributes = parent::_standard_attributes_array();
+		$standard_attributes['class'] .= ' ee-select2';
+		return $standard_attributes;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -42,10 +42,10 @@ 
         // is carelessly registering an older version of Select2 on admin pages that don't even belong to them
         wp_deregister_script('select2');
         wp_deregister_style('select2');
-        wp_register_script('select2', EE_GLOBAL_ASSETS_URL . 'scripts/select2.min.js', array(), '4.0.2', true);
-        wp_register_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all');
-        wp_enqueue_script('form_section_select2_init', EE_GLOBAL_ASSETS_URL . 'scripts/form_section_select2_init.js', array( 'select2' ), '1.0.0', true);
-        wp_enqueue_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all');
+        wp_register_script('select2', EE_GLOBAL_ASSETS_URL.'scripts/select2.min.js', array(), '4.0.2', true);
+        wp_register_style('select2', EE_GLOBAL_ASSETS_URL.'css/select2.min.css', array(), '4.0.2', 'all');
+        wp_enqueue_script('form_section_select2_init', EE_GLOBAL_ASSETS_URL.'scripts/form_section_select2_init.js', array('select2'), '1.0.0', true);
+        wp_enqueue_style('select2', EE_GLOBAL_ASSETS_URL.'css/select2.min.css', array(), '4.0.2', 'all');
     }
 
     /**
@@ -74,10 +74,10 @@ 
     public function get_other_js_data($other_js_data = array())
     {
         $other_js_data = parent::get_other_js_data($other_js_data);
-        if (! isset($other_js_data['select2s'])) {
+        if ( ! isset($other_js_data['select2s'])) {
             $other_js_data['select2s'] = array();
         }
-        $other_js_data['select2s'][ $this->_input->html_id() ] = $this->get_js_args();
+        $other_js_data['select2s'][$this->_input->html_id()] = $this->get_js_args();
         return $other_js_data;
     }