eventespresso / event-espresso-core

core/helpers/EEH_Autoloader.helper.php

Spacing +22 added lines, -22 removed lines

@@ -53,7 +53,7 @@ 
         if (self::$_autoloaders === null) {
             self::$_autoloaders = array();
             $this->_register_custom_autoloaders();
-            spl_autoload_register(array( $this, 'espresso_autoloader' ));
+            spl_autoload_register(array($this, 'espresso_autoloader'));
         }
     }
 
@@ -66,7 +66,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EEH_Autoloader) {
+        if ( ! self::$_instance instanceof EEH_Autoloader) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -85,8 +85,8 @@ 
      */
     public static function espresso_autoloader($class_name)
     {
-        if (isset(self::$_autoloaders[ $class_name ])) {
-            require_once(self::$_autoloaders[ $class_name ]);
+        if (isset(self::$_autoloaders[$class_name])) {
+            require_once(self::$_autoloaders[$class_name]);
         }
     }
 
@@ -103,7 +103,7 @@ 
      */
     public static function register_autoloader($class_paths, $read_check = true, $debug = false)
     {
-        $class_paths = is_array($class_paths) ? $class_paths : array( $class_paths );
+        $class_paths = is_array($class_paths) ? $class_paths : array($class_paths);
         foreach ($class_paths as $class => $path) {
             // skip all files that are not PHP
             if (substr($path, strlen($path) - 3) !== 'php') {
@@ -122,10 +122,10 @@ 
             if ($read_check && ! is_readable($path)) {
                 throw new EE_Error(sprintf(esc_html__('The file for the %s class could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s', 'event_espresso'), $class, $path));
             }
-            if (! isset(self::$_autoloaders[ $class ])) {
-                self::$_autoloaders[ $class ] = str_replace(array( '/', '\\' ), '/', $path);
-                if (EE_DEBUG && ( EEH_Autoloader::$debug === 'paths' || EEH_Autoloader::$debug === 'all' || $debug )) {
-                    EEH_Debug_Tools::printr(self::$_autoloaders[ $class ], $class, __FILE__, __LINE__);
+            if ( ! isset(self::$_autoloaders[$class])) {
+                self::$_autoloaders[$class] = str_replace(array('/', '\\'), '/', $path);
+                if (EE_DEBUG && (EEH_Autoloader::$debug === 'paths' || EEH_Autoloader::$debug === 'all' || $debug)) {
+                    EEH_Debug_Tools::printr(self::$_autoloaders[$class], $class, __FILE__, __LINE__);
                 }
             }
         }
@@ -157,13 +157,13 @@ 
     {
         EEH_Autoloader::$debug = '';
         \EEH_Autoloader::register_helpers_autoloaders();
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces');
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE.'interfaces');
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE);
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_INTERFACES, true);
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_MODELS, true);
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CLASSES);
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_FORM_SECTIONS, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'messages');
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'messages');
         if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
             EEH_Debug_Tools::instance()->show_times();
         }
@@ -205,7 +205,7 @@ 
      */
     public static function register_line_item_display_autoloaders()
     {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_display', true);
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'line_item_display', true);
     }
 
 
@@ -218,7 +218,7 @@ 
      */
     public static function register_line_item_filter_autoloaders()
     {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_filters', true);
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'line_item_filters', true);
     }
 
 
@@ -231,7 +231,7 @@ 
      */
     public static function register_template_part_autoloaders()
     {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'template_parts', true);
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'template_parts', true);
     }
 
 
@@ -241,7 +241,7 @@ 
      */
     public static function register_business_classes()
     {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'business');
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE.'business');
     }
 
 
@@ -264,11 +264,11 @@ 
             EEH_Debug_Tools::instance()->start_timer(basename($folder));
         }
         // make sure last char is a /
-        $folder .= $folder[ strlen($folder) - 1 ] !== '/' ? '/' : '';
+        $folder .= $folder[strlen($folder) - 1] !== '/' ? '/' : '';
         $class_to_filepath_map = array();
-        $exclude = array( 'index' );
+        $exclude = array('index');
         // get all the files in that folder that end in php
-        $filepaths = glob($folder . '*');
+        $filepaths = glob($folder.'*');
 
         if (empty($filepaths)) {
             return;
@@ -277,8 +277,8 @@ 
         foreach ($filepaths as $filepath) {
             if (substr($filepath, -4, 4) === '.php') {
                 $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($filepath);
-                if (! in_array($class_name, $exclude)) {
-                    $class_to_filepath_map [ $class_name ] = $filepath;
+                if ( ! in_array($class_name, $exclude)) {
+                    $class_to_filepath_map [$class_name] = $filepath;
                 }
             } elseif ($recursive) {
                 EEH_Autoloader::register_autoloaders_for_each_file_in_folder($filepath, $recursive, $debug);
@@ -303,8 +303,8 @@ 
      */
     public static function add_alias($class_name, $alias)
     {
-        if (isset(self::$_autoloaders[ $class_name ])) {
-            self::$_autoloaders[ $alias ] = self::$_autoloaders[ $class_name ];
+        if (isset(self::$_autoloaders[$class_name])) {
+            self::$_autoloaders[$alias] = self::$_autoloaders[$class_name];
         }
     }
 }

Indentation +292 added lines, -292 removed lines

@@ -13,296 +13,296 @@
  */
 class EEH_Autoloader extends EEH_Base
 {
-    /**
-     *    instance of the EE_System object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-    /**
-    *   $_autoloaders
-    *   @var array $_autoloaders
-    *   @access     private
-    */
-    private static $_autoloaders;
-
-    /**
-     * set to "paths" to display autoloader class => path mappings
-     * set to "times" to display autoloader loading times
-     * set to "all" to display both
-     *
-     * @var string $debug
-     * @access    private
-     */
-    public static $debug = false;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    private
-     * @return \EEH_Autoloader
-     * @throws Exception
-     */
-    private function __construct()
-    {
-        if (self::$_autoloaders === null) {
-            self::$_autoloaders = array();
-            $this->_register_custom_autoloaders();
-            spl_autoload_register(array( $this, 'espresso_autoloader' ));
-        }
-    }
-
-
-
-    /**
-     * @access public
-     * @return EEH_Autoloader
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EEH_Autoloader) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *    espresso_autoloader
-     *
-     * @access    public
-     * @param   $class_name
-     * @internal  param $className
-     * @internal  param string $class_name - simple class name ie: session
-     * @return  void
-     */
-    public static function espresso_autoloader($class_name)
-    {
-        if (isset(self::$_autoloaders[ $class_name ])) {
-            require_once(self::$_autoloaders[ $class_name ]);
-        }
-    }
-
-
-
-    /**
-     *    register_autoloader
-     *
-     * @access    public
-     * @param array | string $class_paths - array of key => value pairings between class names and paths
-     * @param bool           $read_check  true if we need to check whether the file is readable or not.
-     * @param bool           $debug **deprecated**
-     * @throws \EE_Error
-     */
-    public static function register_autoloader($class_paths, $read_check = true, $debug = false)
-    {
-        $class_paths = is_array($class_paths) ? $class_paths : array( $class_paths );
-        foreach ($class_paths as $class => $path) {
-            // skip all files that are not PHP
-            if (substr($path, strlen($path) - 3) !== 'php') {
-                continue;
-            }
-            // don't give up! you gotta...
-            // get some class
-            if (empty($class)) {
-                throw new EE_Error(sprintf(esc_html__('No Class name was specified while registering an autoloader for the following path: %s.', 'event_espresso'), $path));
-            }
-            // one day you will find the path young grasshopper
-            if (empty($path)) {
-                throw new EE_Error(sprintf(esc_html__('No path was specified while registering an autoloader for the %s class.', 'event_espresso'), $class));
-            }
-            // is file readable ?
-            if ($read_check && ! is_readable($path)) {
-                throw new EE_Error(sprintf(esc_html__('The file for the %s class could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s', 'event_espresso'), $class, $path));
-            }
-            if (! isset(self::$_autoloaders[ $class ])) {
-                self::$_autoloaders[ $class ] = str_replace(array( '/', '\\' ), '/', $path);
-                if (EE_DEBUG && ( EEH_Autoloader::$debug === 'paths' || EEH_Autoloader::$debug === 'all' || $debug )) {
-                    EEH_Debug_Tools::printr(self::$_autoloaders[ $class ], $class, __FILE__, __LINE__);
-                }
-            }
-        }
-    }
-
-
-
-
-    /**
-     *  get_autoloaders
-     *
-     *  @access public
-     *  @return array
-     */
-    public static function get_autoloaders()
-    {
-        return self::$_autoloaders;
-    }
-
-
-    /**
-     *  register core, model and class 'autoloaders'
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     */
-    private function _register_custom_autoloaders()
-    {
-        EEH_Autoloader::$debug = '';
-        \EEH_Autoloader::register_helpers_autoloaders();
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces');
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_INTERFACES, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_MODELS, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CLASSES);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_FORM_SECTIONS, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'messages');
-        if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
-            EEH_Debug_Tools::instance()->show_times();
-        }
-    }
-
-
-
-    /**
-     *    register core, model and class 'autoloaders'
-     *
-     * @access public
-     */
-    public static function register_helpers_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
-    }
-
-
-
-
-    /**
-     *  register core, model and class 'autoloaders'
-     *
-     *  @access public
-     *  @return void
-     */
-    public static function register_form_sections_autoloaders()
-    {
-        // EEH_Autoloader::register_autoloaders_for_each_file_in_folder( EE_FORM_SECTIONS, true );
-    }
-
-
-    /**
-     *  register core, model and class 'autoloaders'
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_line_item_display_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_display', true);
-    }
-
-
-    /**
-     *  register core, model and class 'autoloaders'
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_line_item_filter_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_filters', true);
-    }
-
-
-    /**
-     *  register template part 'autoloaders'
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_template_part_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'template_parts', true);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_business_classes()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'business');
-    }
-
-
-
-    /**
-     * Assumes all the files in this folder have the normal naming scheme (namely that their classname
-     * is the file's name, plus ".whatever.php".) and adds each of them to the autoloader list.
-     * If that's not the case, you'll need to improve this function or just use EEH_File::get_classname_from_filepath_with_standard_filename() directly.
-     * Yes this has to scan the directory for files, but it only does it once -- not on EACH
-     * time the autoloader is used
-     *
-     * @param string $folder name, with or without trailing /, doesn't matter
-     * @param bool   $recursive
-     * @param bool   $debug  **deprecated**
-     * @throws \EE_Error
-     */
-    public static function register_autoloaders_for_each_file_in_folder($folder, $recursive = false, $debug = false)
-    {
-        if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all' || $debug) {
-            EEH_Debug_Tools::instance()->start_timer(basename($folder));
-        }
-        // make sure last char is a /
-        $folder .= $folder[ strlen($folder) - 1 ] !== '/' ? '/' : '';
-        $class_to_filepath_map = array();
-        $exclude = array( 'index' );
-        // get all the files in that folder that end in php
-        $filepaths = glob($folder . '*');
-
-        if (empty($filepaths)) {
-            return;
-        }
-
-        foreach ($filepaths as $filepath) {
-            if (substr($filepath, -4, 4) === '.php') {
-                $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($filepath);
-                if (! in_array($class_name, $exclude)) {
-                    $class_to_filepath_map [ $class_name ] = $filepath;
-                }
-            } elseif ($recursive) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($filepath, $recursive, $debug);
-            }
-        }
-        // we remove the necessity to do a is_readable() check via the $read_check flag because glob by nature will not return non_readable files/directories.
-        self::register_autoloader($class_to_filepath_map, false, $debug);
-        if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
-            EEH_Debug_Tools::instance()->stop_timer(basename($folder));
-        }
-    }
-
-
-
-    /**
-     * add_alias
-     * register additional autoloader based on variation of the classname for an existing autoloader
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: EE_Session
-     * @param string $alias - variation on class name ie: EE_session, session, etc
-     */
-    public static function add_alias($class_name, $alias)
-    {
-        if (isset(self::$_autoloaders[ $class_name ])) {
-            self::$_autoloaders[ $alias ] = self::$_autoloaders[ $class_name ];
-        }
-    }
+	/**
+	 *    instance of the EE_System object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+	/**
+	 *   $_autoloaders
+	 *   @var array $_autoloaders
+	 *   @access     private
+	 */
+	private static $_autoloaders;
+
+	/**
+	 * set to "paths" to display autoloader class => path mappings
+	 * set to "times" to display autoloader loading times
+	 * set to "all" to display both
+	 *
+	 * @var string $debug
+	 * @access    private
+	 */
+	public static $debug = false;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    private
+	 * @return \EEH_Autoloader
+	 * @throws Exception
+	 */
+	private function __construct()
+	{
+		if (self::$_autoloaders === null) {
+			self::$_autoloaders = array();
+			$this->_register_custom_autoloaders();
+			spl_autoload_register(array( $this, 'espresso_autoloader' ));
+		}
+	}
+
+
+
+	/**
+	 * @access public
+	 * @return EEH_Autoloader
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EEH_Autoloader) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *    espresso_autoloader
+	 *
+	 * @access    public
+	 * @param   $class_name
+	 * @internal  param $className
+	 * @internal  param string $class_name - simple class name ie: session
+	 * @return  void
+	 */
+	public static function espresso_autoloader($class_name)
+	{
+		if (isset(self::$_autoloaders[ $class_name ])) {
+			require_once(self::$_autoloaders[ $class_name ]);
+		}
+	}
+
+
+
+	/**
+	 *    register_autoloader
+	 *
+	 * @access    public
+	 * @param array | string $class_paths - array of key => value pairings between class names and paths
+	 * @param bool           $read_check  true if we need to check whether the file is readable or not.
+	 * @param bool           $debug **deprecated**
+	 * @throws \EE_Error
+	 */
+	public static function register_autoloader($class_paths, $read_check = true, $debug = false)
+	{
+		$class_paths = is_array($class_paths) ? $class_paths : array( $class_paths );
+		foreach ($class_paths as $class => $path) {
+			// skip all files that are not PHP
+			if (substr($path, strlen($path) - 3) !== 'php') {
+				continue;
+			}
+			// don't give up! you gotta...
+			// get some class
+			if (empty($class)) {
+				throw new EE_Error(sprintf(esc_html__('No Class name was specified while registering an autoloader for the following path: %s.', 'event_espresso'), $path));
+			}
+			// one day you will find the path young grasshopper
+			if (empty($path)) {
+				throw new EE_Error(sprintf(esc_html__('No path was specified while registering an autoloader for the %s class.', 'event_espresso'), $class));
+			}
+			// is file readable ?
+			if ($read_check && ! is_readable($path)) {
+				throw new EE_Error(sprintf(esc_html__('The file for the %s class could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s', 'event_espresso'), $class, $path));
+			}
+			if (! isset(self::$_autoloaders[ $class ])) {
+				self::$_autoloaders[ $class ] = str_replace(array( '/', '\\' ), '/', $path);
+				if (EE_DEBUG && ( EEH_Autoloader::$debug === 'paths' || EEH_Autoloader::$debug === 'all' || $debug )) {
+					EEH_Debug_Tools::printr(self::$_autoloaders[ $class ], $class, __FILE__, __LINE__);
+				}
+			}
+		}
+	}
+
+
+
+
+	/**
+	 *  get_autoloaders
+	 *
+	 *  @access public
+	 *  @return array
+	 */
+	public static function get_autoloaders()
+	{
+		return self::$_autoloaders;
+	}
+
+
+	/**
+	 *  register core, model and class 'autoloaders'
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _register_custom_autoloaders()
+	{
+		EEH_Autoloader::$debug = '';
+		\EEH_Autoloader::register_helpers_autoloaders();
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces');
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_INTERFACES, true);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_MODELS, true);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CLASSES);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_FORM_SECTIONS, true);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'messages');
+		if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
+			EEH_Debug_Tools::instance()->show_times();
+		}
+	}
+
+
+
+	/**
+	 *    register core, model and class 'autoloaders'
+	 *
+	 * @access public
+	 */
+	public static function register_helpers_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
+	}
+
+
+
+
+	/**
+	 *  register core, model and class 'autoloaders'
+	 *
+	 *  @access public
+	 *  @return void
+	 */
+	public static function register_form_sections_autoloaders()
+	{
+		// EEH_Autoloader::register_autoloaders_for_each_file_in_folder( EE_FORM_SECTIONS, true );
+	}
+
+
+	/**
+	 *  register core, model and class 'autoloaders'
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_line_item_display_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_display', true);
+	}
+
+
+	/**
+	 *  register core, model and class 'autoloaders'
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_line_item_filter_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_filters', true);
+	}
+
+
+	/**
+	 *  register template part 'autoloaders'
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_template_part_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'template_parts', true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_business_classes()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'business');
+	}
+
+
+
+	/**
+	 * Assumes all the files in this folder have the normal naming scheme (namely that their classname
+	 * is the file's name, plus ".whatever.php".) and adds each of them to the autoloader list.
+	 * If that's not the case, you'll need to improve this function or just use EEH_File::get_classname_from_filepath_with_standard_filename() directly.
+	 * Yes this has to scan the directory for files, but it only does it once -- not on EACH
+	 * time the autoloader is used
+	 *
+	 * @param string $folder name, with or without trailing /, doesn't matter
+	 * @param bool   $recursive
+	 * @param bool   $debug  **deprecated**
+	 * @throws \EE_Error
+	 */
+	public static function register_autoloaders_for_each_file_in_folder($folder, $recursive = false, $debug = false)
+	{
+		if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all' || $debug) {
+			EEH_Debug_Tools::instance()->start_timer(basename($folder));
+		}
+		// make sure last char is a /
+		$folder .= $folder[ strlen($folder) - 1 ] !== '/' ? '/' : '';
+		$class_to_filepath_map = array();
+		$exclude = array( 'index' );
+		// get all the files in that folder that end in php
+		$filepaths = glob($folder . '*');
+
+		if (empty($filepaths)) {
+			return;
+		}
+
+		foreach ($filepaths as $filepath) {
+			if (substr($filepath, -4, 4) === '.php') {
+				$class_name = EEH_File::get_classname_from_filepath_with_standard_filename($filepath);
+				if (! in_array($class_name, $exclude)) {
+					$class_to_filepath_map [ $class_name ] = $filepath;
+				}
+			} elseif ($recursive) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($filepath, $recursive, $debug);
+			}
+		}
+		// we remove the necessity to do a is_readable() check via the $read_check flag because glob by nature will not return non_readable files/directories.
+		self::register_autoloader($class_to_filepath_map, false, $debug);
+		if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
+			EEH_Debug_Tools::instance()->stop_timer(basename($folder));
+		}
+	}
+
+
+
+	/**
+	 * add_alias
+	 * register additional autoloader based on variation of the classname for an existing autoloader
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: EE_Session
+	 * @param string $alias - variation on class name ie: EE_session, session, etc
+	 */
+	public static function add_alias($class_name, $alias)
+	{
+		if (isset(self::$_autoloaders[ $class_name ])) {
+			self::$_autoloaders[ $alias ] = self::$_autoloaders[ $class_name ];
+		}
+	}
 }

core/helpers/EEH_Template_Validator.helper.php

Spacing +13 added lines, -13 removed lines

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

Indentation +148 added lines, -148 removed lines

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

core/helpers/EEH_File.helper.php

Spacing +46 added lines, -46 removed lines

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

Indentation +666 added lines, -666 removed lines

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

core/exceptions/InvalidStatusException.php

Indentation +22 added lines, -22 removed lines

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

core/exceptions/InvalidDataTypeException.php

Spacing +2 added lines, -2 removed lines

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

Indentation +40 added lines, -40 removed lines

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

core/EE_Capabilities.core.php

Spacing +45 added lines, -45 removed lines

@@ -80,7 +80,7 @@ 
     public static function instance()
     {
         // check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
+        if ( ! self::$_instance instanceof EE_Capabilities) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -110,7 +110,7 @@ 
      */
     public function init_caps($reset = false)
     {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             return false;
         }
         $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
@@ -155,7 +155,7 @@ 
             $this->_get_default_meta_caps_array()
         );
         // add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+        if ( ! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
             add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
         }
     }
@@ -314,11 +314,11 @@ 
         if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
             // loop through our _meta_caps array
             foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
+                if ( ! $meta_map instanceof EE_Meta_Capability_Map) {
                     continue;
                 }
                 // don't load models if there is no object ID in the args
-                if (! empty($args[0])) {
+                if ( ! empty($args[0])) {
                     $meta_map->ensure_is_model();
                 }
                 $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
@@ -654,7 +654,7 @@ 
     public function addCaps(array $capabilities_to_add)
     {
         // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
+        if ( ! $this->setupCapabilitiesMap()) {
             return false;
         }
         // and filter the array so others can get in on the fun during resets
@@ -696,7 +696,7 @@ 
     public function removeCaps($caps_map)
     {
         // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
+        if ( ! $this->setupCapabilitiesMap()) {
             return false;
         }
         $update_capabilities_map = false;
@@ -756,7 +756,7 @@ 
         $orig_role = $role;
         $role = $role instanceof WP_Role ? $role : get_role($role);
         // if the role isn't available then we create it.
-        if (! $role instanceof WP_Role) {
+        if ( ! $role instanceof WP_Role) {
             // if a plugin wants to create a specific role name then they should create the role before
             // EE_Capabilities does.  Otherwise this function will create the role name from the slug:
             // - removes any `ee_` namespacing from the start of the slug.
@@ -767,12 +767,12 @@ 
         }
         if ($role instanceof WP_Role) {
             // don't do anything if the capabilities map can not be initialized
-            if (! $this->setupCapabilitiesMap()) {
+            if ( ! $this->setupCapabilitiesMap()) {
                 return false;
             }
-            if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
+            if ( ! $this->capHasBeenAddedToRole($role->name, $cap)) {
                 $role->add_cap($cap, $grant);
-                $this->capabilities_map[ $role->name ][] = $cap;
+                $this->capabilities_map[$role->name][] = $cap;
                 $this->updateCapabilitiesMap($update_capabilities_map);
                 return true;
             }
@@ -796,14 +796,14 @@ 
     public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
     {
         // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
+        if ( ! $this->setupCapabilitiesMap()) {
             return false;
         }
 
         $role = $role instanceof WP_Role ? $role : get_role($role);
         if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
             $role->remove_cap($cap);
-            unset($this->capabilities_map[ $role->name ][ $index ]);
+            unset($this->capabilities_map[$role->name][$index]);
             $this->updateCapabilitiesMap($update_capabilities_map);
             return true;
         }
@@ -820,8 +820,8 @@ 
     private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false)
     {
         if (
-            isset($this->capabilities_map[ $role_name ])
-            && ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false
+            isset($this->capabilities_map[$role_name])
+            && ($index = array_search($cap, $this->capabilities_map[$role_name], true)) !== false
         ) {
             return $get_index ? $index : true;
         }
@@ -848,7 +848,7 @@ 
     public function current_user_can($cap, $context, $id = 0)
     {
         // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__'.$context, $cap, $id);
         $filtered_cap = apply_filters(
             'FHEE__EE_Capabilities__current_user_can__cap',
             $filtered_cap,
@@ -876,7 +876,7 @@ 
     public function user_can($user, $cap, $context, $id = 0)
     {
         // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__'.$context, $cap, $user, $id);
         $filtered_cap = apply_filters(
             'FHEE__EE_Capabilities__user_can__cap',
             $filtered_cap,
@@ -915,7 +915,7 @@ 
             : current_user_can($blog_id, $cap);
         // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
         $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__'.$context,
             $user_can,
             $blog_id,
             $cap,
@@ -944,14 +944,14 @@ 
      */
     public function get_ee_capabilities($role = 'administrator')
     {
-        if (! $this->initialized) {
+        if ( ! $this->initialized) {
             $this->init_caps();
         }
         if (empty($role)) {
             return $this->capabilities_map;
         }
-        return isset($this->capabilities_map[ $role ])
-            ? $this->capabilities_map[ $role ]
+        return isset($this->capabilities_map[$role])
+            ? $this->capabilities_map[$role]
             : array();
     }
 
@@ -982,7 +982,7 @@ 
                         'event_espresso'
                     ),
                     '$reset',
-                    __METHOD__ . '()',
+                    __METHOD__.'()',
                     'EE_Capabilities::init_caps()',
                     'true'
                 ),
@@ -1056,7 +1056,7 @@ 
                         'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
                         'event_espresso'
                     ),
-                    '<br>' . print_r($map_values, true)
+                    '<br>'.print_r($map_values, true)
                 )
             );
         }
@@ -1096,7 +1096,7 @@ 
         // error proof if the name has EEM in it
         $this->_model_name = str_replace('EEM', '', $this->_model_name);
         $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -1182,7 +1182,7 @@ 
 
         // okay it is a meta cap so let's first remove that cap from the $caps array.
         if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
+            unset($caps[$key]);
         }
 
         // cast $user_id to int for later explicit comparisons
@@ -1191,11 +1191,11 @@ 
         /** @var EE_Base_Class $obj */
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         if ($obj instanceof EE_CPT_Base) {
             // if the item author is set and the user is the author...
             if ($obj->wp_user() && $user_id === $obj->wp_user()) {
@@ -1205,12 +1205,12 @@ 
                 }
             } else {
                 // the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
+                if ( ! empty($this->published_cap) && $obj->status() === 'publish') {
                     $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+                } elseif ( ! empty($this->private_cap) && $obj->status() === 'private') {
                     $caps[] = $this->private_cap;
                 }
             }
@@ -1226,8 +1226,8 @@ 
                     EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
                 }
             }
-            if (! $has_cap) {
-                if (! empty($this->others_cap)) {
+            if ( ! $has_cap) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1306,7 +1306,7 @@ 
 
         // okay it is a meta cap so let's first remove that cap from the $caps array.
         if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
+            unset($caps[$key]);
         }
 
         // cast $user_id to int for later explicit comparisons
@@ -1314,12 +1314,12 @@ 
 
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
 
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         if ($obj instanceof EE_CPT_Base) {
             $status_obj = get_post_status_object($obj->status());
             if ($status_obj->public) {
@@ -1327,7 +1327,7 @@ 
             }
             // if the item author is set and the user is not the author...
             if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1352,11 +1352,11 @@ 
                     EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
                 }
             }
-            if (! $has_cap) {
-                if (! empty($this->private_cap)) {
+            if ( ! $has_cap) {
+                if ( ! empty($this->private_cap)) {
                     $caps[] = $this->private_cap;
                 }
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1402,7 +1402,7 @@ 
 
         // okay it is a meta cap so let's first remove that cap from the $caps array.
         if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
+            unset($caps[$key]);
         }
 
         // cast $user_id to int for later explicit comparisons
@@ -1410,11 +1410,11 @@ 
 
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         // if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
+        if ( ! $obj instanceof EE_Message_Template_Group) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         $is_global = $obj->is_global();
         if ($obj->wp_user() && $obj->wp_user() === $user_id) {
             if ($is_global) {
@@ -1465,15 +1465,15 @@ 
         }
         // okay it is a meta cap so let's first remove that cap from the $caps array.
         if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
+            unset($caps[$key]);
         }
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = 'do_not_allow';
             return $caps;
         }
-        $caps[] = $cap . 's';
+        $caps[] = $cap.'s';
         $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
         $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
         if ($is_system) {

Indentation +1373 added lines, -1373 removed lines

@@ -13,984 +13,984 @@ 
  */
 final class EE_Capabilities extends EE_Base
 {
-    /**
-     * the name of the wp option used to store caps previously initialized
-     */
-    const option_name = 'ee_caps_initialized';
-
-    /**
-     * instance of EE_Capabilities object
-     *
-     * @var EE_Capabilities
-     */
-    private static $_instance;
-
-
-    /**
-     * This is a map of caps that correspond to a default WP_Role.
-     * Array is indexed by Role and values are ee capabilities.
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    private $capabilities_map = array();
-
-    /**
-     * This used to hold an array of EE_Meta_Capability_Map objects
-     * that define the granular capabilities mapped to for a user depending on context.
-     *
-     * @var EE_Meta_Capability_Map[]
-     */
-    private $_meta_caps = array();
-
-    /**
-     * The internal $capabilities_map needs to be initialized before it can be used.
-     * This flag tracks whether that has happened or not.
-     * But for this to work, we need three states to indicate:
-     *      initialization has not occurred at all
-     *      initialization has started but is not complete
-     *      initialization is complete
-     * The reason this is needed is because the addCaps() method
-     * normally requires the $capabilities_map to be initialized,
-     * but is also used during the initialization process.
-     * So:
-     *      If initialized === null, init_caps() will be called before any other methods will run.
-     *      If initialized === false, then init_caps() is in the process of running it's logic.
-     *      If initialized === true, then init_caps() has completed the initialization process.
-     *
-     * @var boolean|null $initialized
-     */
-    private $initialized;
-
-    /**
-     * @var boolean $reset
-     */
-    private $reset = false;
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @since 4.5.0
-     *
-     * @return EE_Capabilities
-     */
-    public static function instance()
-    {
-        // check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * private constructor
-     *
-     * @since 4.5.0
-     */
-    private function __construct()
-    {
-    }
-
-
-    /**
-     * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
-     *
-     * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
-     *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
-     *                    ensures that they are up to date.
-     *
-     * @since 4.5.0
-     * @return bool
-     * @throws EE_Error
-     */
-    public function init_caps($reset = false)
-    {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            return false;
-        }
-        $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
-        // if reset, then completely delete the cache option and clear the $capabilities_map property.
-        if ($this->reset) {
-            $this->initialized = null;
-            $this->capabilities_map = array();
-            delete_option(self::option_name);
-        }
-        if ($this->initialized === null) {
-            $this->initialized = false;
-            do_action(
-                'AHEE__EE_Capabilities__init_caps__before_initialization',
-                $this->reset
-            );
-            $this->addCaps($this->_init_caps_map());
-            $this->_set_meta_caps();
-            do_action(
-                'AHEE__EE_Capabilities__init_caps__after_initialization',
-                $this->capabilities_map
-            );
-            $this->initialized = true;
-        }
-        // reset $this->reset so that it's not stuck on true if init_caps() gets called again
-        $this->reset = false;
-        return true;
-    }
-
-
-    /**
-     * This sets the meta caps property.
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     */
-    private function _set_meta_caps()
-    {
-        // get default meta caps and filter the returned array
-        $this->_meta_caps = apply_filters(
-            'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
-            $this->_get_default_meta_caps_array()
-        );
-        // add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
-            add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
-        }
-    }
-
-
-    /**
-     * This builds and returns the default meta_caps array only once.
-     *
-     * @since  4.8.28.rc.012
-     * @return array
-     * @throws EE_Error
-     */
-    private function _get_default_meta_caps_array()
-    {
-        static $default_meta_caps = array();
-        // make sure we're only ever initializing the default _meta_caps array once if it's empty.
-        if (empty($default_meta_caps)) {
-            $default_meta_caps = array(
-                // edits
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_event',
-                    array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_venue',
-                    array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_registration',
-                    array('Registration', '', 'ee_edit_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_checkin',
-                    array('Registration', '', 'ee_edit_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_edit_message',
-                    array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_default_ticket',
-                    array('Ticket', '', 'ee_edit_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question',
-                    array('Question', '', '', 'ee_edit_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question_group',
-                    array('Question_Group', '', '', 'ee_edit_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_payment_method',
-                    array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
-                ),
-                // reads
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_event',
-                    array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_venue',
-                    array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_registration',
-                    array('Registration', '', 'ee_read_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_checkin',
-                    array('Registration', '', 'ee_read_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_read_message',
-                    array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_default_ticket',
-                    array('Ticket', '', 'ee_read_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_payment_method',
-                    array('Payment_Method', '', 'ee_read_others_payment_methods', '')
-                ),
-                // deletes
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_event',
-                    array(
-                        'Event',
-                        'ee_delete_published_events',
-                        'ee_delete_others_events',
-                        'ee_delete_private_events',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_venue',
-                    array(
-                        'Venue',
-                        'ee_delete_published_venues',
-                        'ee_delete_others_venues',
-                        'ee_delete_private_venues',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_registration',
-                    array('Registration', '', 'ee_delete_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_checkin',
-                    array('Registration', '', 'ee_delete_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_delete_message',
-                    array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_default_ticket',
-                    array('Ticket', '', 'ee_delete_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question',
-                    array('Question', '', '', 'delete_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question_group',
-                    array('Question_Group', '', '', 'delete_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_payment_method',
-                    array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
-                ),
-            );
-        }
-        return $default_meta_caps;
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array actual users capabilities
-     * @throws EE_Error
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
-            // loop through our _meta_caps array
-            foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
-                    continue;
-                }
-                // don't load models if there is no object ID in the args
-                if (! empty($args[0])) {
-                    $meta_map->ensure_is_model();
-                }
-                $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
-            }
-        }
-        return $caps;
-    }
-
-
-    /**
-     * This sets up and returns the initial capabilities map for Event Espresso
-     * Note this array is filtered.
-     * It is assumed that all available EE capabilities are assigned to the administrator role.
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    private function _init_caps_map()
-    {
-        return apply_filters(
-            'FHEE__EE_Capabilities__init_caps_map__caps',
-            array(
-                'administrator'           => array(
-                    // basic access
-                    'ee_read_ee',
-                    // gateways
-                    /**
-                     * note that with payment method capabilities, although we've implemented
-                     * capability mapping which will be used for accessing payment methods owned by
-                     * other users.  This is not fully implemented yet in the payment method ui.
-                     * Currently only the "plural" caps are in active use.
-                     * (Specific payment method caps are in use as well).
-                     **/
-                    'ee_manage_gateways',
-                    'ee_read_payment_methods',
-                    'ee_read_others_payment_methods',
-                    'ee_edit_payment_methods',
-                    'ee_edit_others_payment_methods',
-                    'ee_delete_payment_methods',
-                    // events
-                    'ee_publish_events',
-                    'ee_read_private_events',
-                    'ee_read_others_events',
-                    'ee_read_events',
-                    'ee_edit_events',
-                    'ee_edit_published_events',
-                    'ee_edit_others_events',
-                    'ee_edit_private_events',
-                    'ee_delete_published_events',
-                    'ee_delete_private_events',
-                    'ee_delete_events',
-                    'ee_delete_others_events',
-                    // event categories
-                    'ee_manage_event_categories',
-                    'ee_edit_event_category',
-                    'ee_delete_event_category',
-                    'ee_assign_event_category',
-                    // venues
-                    'ee_publish_venues',
-                    'ee_read_venues',
-                    'ee_read_others_venues',
-                    'ee_read_private_venues',
-                    'ee_edit_venues',
-                    'ee_edit_others_venues',
-                    'ee_edit_published_venues',
-                    'ee_edit_private_venues',
-                    'ee_delete_venues',
-                    'ee_delete_others_venues',
-                    'ee_delete_private_venues',
-                    'ee_delete_published_venues',
-                    // venue categories
-                    'ee_manage_venue_categories',
-                    'ee_edit_venue_category',
-                    'ee_delete_venue_category',
-                    'ee_assign_venue_category',
-                    // contacts
-                    'ee_read_contacts',
-                    'ee_edit_contacts',
-                    'ee_delete_contacts',
-                    // registrations
-                    'ee_read_registrations',
-                    'ee_read_others_registrations',
-                    'ee_edit_registrations',
-                    'ee_edit_others_registrations',
-                    'ee_delete_registrations',
-                    'ee_delete_others_registrations',
-                    // checkins
-                    'ee_read_others_checkins',
-                    'ee_read_checkins',
-                    'ee_edit_checkins',
-                    'ee_edit_others_checkins',
-                    'ee_delete_checkins',
-                    'ee_delete_others_checkins',
-                    // transactions && payments
-                    'ee_read_transaction',
-                    'ee_read_transactions',
-                    'ee_edit_payments',
-                    'ee_delete_payments',
-                    // messages
-                    'ee_read_messages',
-                    'ee_read_others_messages',
-                    'ee_read_global_messages',
-                    'ee_edit_global_messages',
-                    'ee_edit_messages',
-                    'ee_edit_others_messages',
-                    'ee_delete_messages',
-                    'ee_delete_others_messages',
-                    'ee_delete_global_messages',
-                    'ee_send_message',
-                    // tickets
-                    'ee_read_default_tickets',
-                    'ee_read_others_default_tickets',
-                    'ee_edit_default_tickets',
-                    'ee_edit_others_default_tickets',
-                    'ee_delete_default_tickets',
-                    'ee_delete_others_default_tickets',
-                    // prices
-                    'ee_edit_default_price',
-                    'ee_edit_default_prices',
-                    'ee_delete_default_price',
-                    'ee_delete_default_prices',
-                    'ee_edit_default_price_type',
-                    'ee_edit_default_price_types',
-                    'ee_delete_default_price_type',
-                    'ee_delete_default_price_types',
-                    'ee_read_default_prices',
-                    'ee_read_default_price_types',
-                    // registration form
-                    'ee_edit_questions',
-                    'ee_edit_system_questions',
-                    'ee_read_questions',
-                    'ee_delete_questions',
-                    'ee_edit_question_groups',
-                    'ee_read_question_groups',
-                    'ee_edit_system_question_groups',
-                    'ee_delete_question_groups',
-                    // event_type taxonomy
-                    'ee_assign_event_type',
-                    'ee_manage_event_types',
-                    'ee_edit_event_type',
-                    'ee_delete_event_type',
-                ),
-                'ee_events_administrator' => array(
-                    // core wp caps
-                    'read',
-                    'read_private_pages',
-                    'read_private_posts',
-                    'edit_users',
-                    'edit_posts',
-                    'edit_pages',
-                    'edit_published_posts',
-                    'edit_published_pages',
-                    'edit_private_pages',
-                    'edit_private_posts',
-                    'edit_others_posts',
-                    'edit_others_pages',
-                    'publish_posts',
-                    'publish_pages',
-                    'delete_posts',
-                    'delete_pages',
-                    'delete_private_pages',
-                    'delete_private_posts',
-                    'delete_published_pages',
-                    'delete_published_posts',
-                    'delete_others_posts',
-                    'delete_others_pages',
-                    'manage_categories',
-                    'manage_links',
-                    'moderate_comments',
-                    'unfiltered_html',
-                    'upload_files',
-                    'export',
-                    'import',
-                    'list_users',
-                    'level_1', // required if user with this role shows up in author dropdowns
-                    // basic ee access
-                    'ee_read_ee',
-                    // events
-                    'ee_publish_events',
-                    'ee_read_private_events',
-                    'ee_read_others_events',
-                    'ee_read_event',
-                    'ee_read_events',
-                    'ee_edit_event',
-                    'ee_edit_events',
-                    'ee_edit_published_events',
-                    'ee_edit_others_events',
-                    'ee_edit_private_events',
-                    'ee_delete_published_events',
-                    'ee_delete_private_events',
-                    'ee_delete_event',
-                    'ee_delete_events',
-                    'ee_delete_others_events',
-                    // event categories
-                    'ee_manage_event_categories',
-                    'ee_edit_event_category',
-                    'ee_delete_event_category',
-                    'ee_assign_event_category',
-                    // venues
-                    'ee_publish_venues',
-                    'ee_read_venue',
-                    'ee_read_venues',
-                    'ee_read_others_venues',
-                    'ee_read_private_venues',
-                    'ee_edit_venue',
-                    'ee_edit_venues',
-                    'ee_edit_others_venues',
-                    'ee_edit_published_venues',
-                    'ee_edit_private_venues',
-                    'ee_delete_venue',
-                    'ee_delete_venues',
-                    'ee_delete_others_venues',
-                    'ee_delete_private_venues',
-                    'ee_delete_published_venues',
-                    // venue categories
-                    'ee_manage_venue_categories',
-                    'ee_edit_venue_category',
-                    'ee_delete_venue_category',
-                    'ee_assign_venue_category',
-                    // contacts
-                    'ee_read_contacts',
-                    'ee_edit_contacts',
-                    'ee_delete_contacts',
-                    // registrations
-                    'ee_read_registrations',
-                    'ee_read_others_registrations',
-                    'ee_edit_registration',
-                    'ee_edit_registrations',
-                    'ee_edit_others_registrations',
-                    'ee_delete_registration',
-                    'ee_delete_registrations',
-                    'ee_delete_others_registrations',
-                    // checkins
-                    'ee_read_others_checkins',
-                    'ee_read_checkins',
-                    'ee_edit_checkins',
-                    'ee_edit_others_checkins',
-                    'ee_delete_checkins',
-                    'ee_delete_others_checkins',
-                    // transactions && payments
-                    'ee_read_transaction',
-                    'ee_read_transactions',
-                    'ee_edit_payments',
-                    'ee_delete_payments',
-                    // messages
-                    'ee_read_messages',
-                    'ee_read_others_messages',
-                    'ee_read_global_messages',
-                    'ee_edit_global_messages',
-                    'ee_edit_messages',
-                    'ee_edit_others_messages',
-                    'ee_delete_messages',
-                    'ee_delete_others_messages',
-                    'ee_delete_global_messages',
-                    'ee_send_message',
-                    // tickets
-                    'ee_read_default_tickets',
-                    'ee_read_others_default_tickets',
-                    'ee_edit_default_tickets',
-                    'ee_edit_others_default_tickets',
-                    'ee_delete_default_tickets',
-                    'ee_delete_others_default_tickets',
-                    // prices
-                    'ee_edit_default_price',
-                    'ee_edit_default_prices',
-                    'ee_delete_default_price',
-                    'ee_delete_default_prices',
-                    'ee_edit_default_price_type',
-                    'ee_edit_default_price_types',
-                    'ee_delete_default_price_type',
-                    'ee_delete_default_price_types',
-                    'ee_read_default_prices',
-                    'ee_read_default_price_types',
-                    // registration form
-                    'ee_edit_questions',
-                    'ee_edit_system_questions',
-                    'ee_read_questions',
-                    'ee_delete_questions',
-                    'ee_edit_question_groups',
-                    'ee_read_question_groups',
-                    'ee_edit_system_question_groups',
-                    'ee_delete_question_groups',
-                    // event_type taxonomy
-                    'ee_assign_event_type',
-                    'ee_manage_event_types',
-                    'ee_edit_event_type',
-                    'ee_delete_event_type',
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    private function setupCapabilitiesMap()
-    {
-        // if the initialization process hasn't even started, then we need to call init_caps()
-        if ($this->initialized === null) {
-            return $this->init_caps();
-        }
-        // unless resetting, get caps from db if we haven't already
-        $this->capabilities_map = $this->reset || ! empty($this->capabilities_map)
-            ? $this->capabilities_map
-            : get_option(self::option_name, array());
-        return true;
-    }
-
-
-    /**
-     * @param bool $update
-     * @return bool
-     */
-    private function updateCapabilitiesMap($update = true)
-    {
-        return $update ? update_option(self::option_name, $this->capabilities_map) : false;
-    }
-
-
-    /**
-     * Adds capabilities to roles.
-     *
-     * @since 4.9.42
-     * @param array $capabilities_to_add array of capabilities to add, indexed by roles.
-     *                                   Note that this should ONLY be called on activation hook
-     *                                   otherwise the caps will be added on every request.
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function addCaps(array $capabilities_to_add)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        // and filter the array so others can get in on the fun during resets
-        $capabilities_to_add = apply_filters(
-            'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-            $capabilities_to_add,
-            $this->reset,
-            $this->capabilities_map
-        );
-        $update_capabilities_map = false;
-        // if not reset, see what caps are new for each role. if they're new, add them.
-        foreach ($capabilities_to_add as $role => $caps_for_role) {
-            if (is_array($caps_for_role)) {
-                foreach ($caps_for_role as $cap) {
-                    if (
-                        ! $this->capHasBeenAddedToRole($role, $cap)
-                        && $this->add_cap_to_role($role, $cap, true, false)
-                    ) {
-                        $update_capabilities_map = true;
-                    }
-                }
-            }
-        }
-        // now let's just save the cap that has been set but only if there's been a change.
-        $updated = $this->updateCapabilitiesMap($update_capabilities_map);
-        $this->flushWpUser($updated);
-        do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated);
-        return $updated;
-    }
-
-
-    /**
-     * Loops through the capabilities map and removes the role caps specified by the incoming array
-     *
-     * @param array $caps_map map of capabilities to be removed (indexed by roles)
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function removeCaps($caps_map)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        $update_capabilities_map = false;
-        foreach ($caps_map as $role => $caps_for_role) {
-            if (is_array($caps_for_role)) {
-                foreach ($caps_for_role as $cap) {
-                    if (
-                        $this->capHasBeenAddedToRole($role, $cap)
-                        && $this->remove_cap_from_role($role, $cap, false)
-                    ) {
-                        $update_capabilities_map = true;
-                    }
-                }
-            }
-        }
-        // maybe resave the caps
-        $updated = $this->updateCapabilitiesMap($update_capabilities_map);
-        $this->flushWpUser($updated);
-        return $updated;
-    }
-
-
-    /**
-     * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from
-     * the roles on that user.
-     *
-     * @param bool $flush Default is to flush the WP_User object.  If false, then this method effectively does nothing.
-     */
-    private function flushWpUser($flush = true)
-    {
-        if ($flush) {
-            $user = wp_get_current_user();
-            if ($user instanceof WP_User) {
-                $user->get_role_caps();
-            }
-        }
-    }
-
-
-    /**
-     * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
-     * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
-     * this is a wrapper for $wp_role->add_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     * @param string|WP_Role $role  A WordPress role the capability is being added to
-     * @param string         $cap   The capability being added to the role
-     * @param bool           $grant Whether to grant access to this cap on this role.
-     * @param bool           $update_capabilities_map
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true)
-    {
-        // capture incoming value for $role because we may need it to create a new WP_Role
-        $orig_role = $role;
-        $role = $role instanceof WP_Role ? $role : get_role($role);
-        // if the role isn't available then we create it.
-        if (! $role instanceof WP_Role) {
-            // if a plugin wants to create a specific role name then they should create the role before
-            // EE_Capabilities does.  Otherwise this function will create the role name from the slug:
-            // - removes any `ee_` namespacing from the start of the slug.
-            // - replaces `_` with ` ` (empty space).
-            // - sentence case on the resulting string.
-            $role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role));
-            $role = add_role($orig_role, $role_label);
-        }
-        if ($role instanceof WP_Role) {
-            // don't do anything if the capabilities map can not be initialized
-            if (! $this->setupCapabilitiesMap()) {
-                return false;
-            }
-            if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
-                $role->add_cap($cap, $grant);
-                $this->capabilities_map[ $role->name ][] = $cap;
-                $this->updateCapabilitiesMap($update_capabilities_map);
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Functions similarly to add_cap_to_role except removes cap from given role.
-     * Wrapper for $wp_role->remove_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     * @param string|WP_Role $role A WordPress role the capability is being removed from.
-     * @param string         $cap  The capability being removed
-     * @param bool           $update_capabilities_map
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-
-        $role = $role instanceof WP_Role ? $role : get_role($role);
-        if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
-            $role->remove_cap($cap);
-            unset($this->capabilities_map[ $role->name ][ $index ]);
-            $this->updateCapabilitiesMap($update_capabilities_map);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * @param string $role_name
-     * @param string $cap
-     * @param bool   $get_index
-     * @return bool|mixed
-     */
-    private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false)
-    {
-        if (
-            isset($this->capabilities_map[ $role_name ])
-            && ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false
-        ) {
-            return $get_index ? $index : true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Wrapper for the native WP current_user_can() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can($cap, $context, $id = 0)
-    {
-        // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
-        $filtered_cap = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can__cap',
-            $filtered_cap,
-            $context,
-            $cap,
-            $id
-        );
-        return ! empty($id)
-            ? current_user_can($filtered_cap, $id)
-            : current_user_can($filtered_cap);
-    }
-
-
-    /**
-     * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
-     *
-     * @param int|WP_User $user    Either the user_id or a WP_User object
-     * @param string      $cap     The capability string being checked
-     * @param string      $context The context where the user_can is being called from (used in filters).
-     * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
-     *                             filters)
-     *
-     * @return bool Whether user can or not.
-     */
-    public function user_can($user, $cap, $context, $id = 0)
-    {
-        // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
-        $filtered_cap = apply_filters(
-            'FHEE__EE_Capabilities__user_can__cap',
-            $filtered_cap,
-            $context,
-            $cap,
-            $user,
-            $id
-        );
-        return ! empty($id)
-            ? user_can($user, $filtered_cap, $id)
-            : user_can($user, $filtered_cap);
-    }
-
-
-    /**
-     * Wrapper for the native WP current_user_can_for_blog() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param int    $blog_id The blog id that is being checked for.
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
-    {
-        $user_can = ! empty($id)
-            ? current_user_can_for_blog($blog_id, $cap, $id)
-            : current_user_can($blog_id, $cap);
-        // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
-            $user_can,
-            $blog_id,
-            $cap,
-            $id
-        );
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
-            $user_can,
-            $context,
-            $blog_id,
-            $cap,
-            $id
-        );
-        return $user_can;
-    }
-
-
-    /**
-     * This helper method just returns an array of registered EE capabilities.
-     *
-     * @since 4.5.0
-     * @param string $role If empty then the entire role/capability map is returned.
-     *                     Otherwise just the capabilities for the given role are returned.
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_ee_capabilities($role = 'administrator')
-    {
-        if (! $this->initialized) {
-            $this->init_caps();
-        }
-        if (empty($role)) {
-            return $this->capabilities_map;
-        }
-        return isset($this->capabilities_map[ $role ])
-            ? $this->capabilities_map[ $role ]
-            : array();
-    }
-
-
-    /**
-     * @deprecated 4.9.42
-     * @param bool  $reset      If you need to reset Event Espresso's capabilities,
-     *                          then please use the init_caps() method with the "$reset" parameter set to "true"
-     * @param array $caps_map   Optional.
-     *                          Can be used to send a custom map of roles and capabilities for setting them up.
-     *                          Note that this should ONLY be called on activation hook or some other one-time
-     *                          task otherwise the caps will be added on every request.
-     * @return void
-     * @throws EE_Error
-     */
-    public function init_role_caps($reset = false, $caps_map = array())
-    {
-        // If this method is called directly and reset is set as 'true',
-        // then display a doing it wrong notice, because we want resets to go through init_caps()
-        // to guarantee that everything is set up correctly.
-        // This prevents the capabilities map getting reset incorrectly by direct calls to this method.
-        if ($reset) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".',
-                        'event_espresso'
-                    ),
-                    '$reset',
-                    __METHOD__ . '()',
-                    'EE_Capabilities::init_caps()',
-                    'true'
-                ),
-                '4.9.42',
-                '5.0.0'
-            );
-        }
-        $this->addCaps($caps_map);
-    }
+	/**
+	 * the name of the wp option used to store caps previously initialized
+	 */
+	const option_name = 'ee_caps_initialized';
+
+	/**
+	 * instance of EE_Capabilities object
+	 *
+	 * @var EE_Capabilities
+	 */
+	private static $_instance;
+
+
+	/**
+	 * This is a map of caps that correspond to a default WP_Role.
+	 * Array is indexed by Role and values are ee capabilities.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	private $capabilities_map = array();
+
+	/**
+	 * This used to hold an array of EE_Meta_Capability_Map objects
+	 * that define the granular capabilities mapped to for a user depending on context.
+	 *
+	 * @var EE_Meta_Capability_Map[]
+	 */
+	private $_meta_caps = array();
+
+	/**
+	 * The internal $capabilities_map needs to be initialized before it can be used.
+	 * This flag tracks whether that has happened or not.
+	 * But for this to work, we need three states to indicate:
+	 *      initialization has not occurred at all
+	 *      initialization has started but is not complete
+	 *      initialization is complete
+	 * The reason this is needed is because the addCaps() method
+	 * normally requires the $capabilities_map to be initialized,
+	 * but is also used during the initialization process.
+	 * So:
+	 *      If initialized === null, init_caps() will be called before any other methods will run.
+	 *      If initialized === false, then init_caps() is in the process of running it's logic.
+	 *      If initialized === true, then init_caps() has completed the initialization process.
+	 *
+	 * @var boolean|null $initialized
+	 */
+	private $initialized;
+
+	/**
+	 * @var boolean $reset
+	 */
+	private $reset = false;
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return EE_Capabilities
+	 */
+	public static function instance()
+	{
+		// check if instantiated, and if not do so.
+		if (! self::$_instance instanceof EE_Capabilities) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * private constructor
+	 *
+	 * @since 4.5.0
+	 */
+	private function __construct()
+	{
+	}
+
+
+	/**
+	 * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
+	 *
+	 * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
+	 *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
+	 *                    ensures that they are up to date.
+	 *
+	 * @since 4.5.0
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function init_caps($reset = false)
+	{
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			return false;
+		}
+		$this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
+		// if reset, then completely delete the cache option and clear the $capabilities_map property.
+		if ($this->reset) {
+			$this->initialized = null;
+			$this->capabilities_map = array();
+			delete_option(self::option_name);
+		}
+		if ($this->initialized === null) {
+			$this->initialized = false;
+			do_action(
+				'AHEE__EE_Capabilities__init_caps__before_initialization',
+				$this->reset
+			);
+			$this->addCaps($this->_init_caps_map());
+			$this->_set_meta_caps();
+			do_action(
+				'AHEE__EE_Capabilities__init_caps__after_initialization',
+				$this->capabilities_map
+			);
+			$this->initialized = true;
+		}
+		// reset $this->reset so that it's not stuck on true if init_caps() gets called again
+		$this->reset = false;
+		return true;
+	}
+
+
+	/**
+	 * This sets the meta caps property.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _set_meta_caps()
+	{
+		// get default meta caps and filter the returned array
+		$this->_meta_caps = apply_filters(
+			'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
+			$this->_get_default_meta_caps_array()
+		);
+		// add filter for map_meta_caps but only if models can query.
+		if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+			add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
+		}
+	}
+
+
+	/**
+	 * This builds and returns the default meta_caps array only once.
+	 *
+	 * @since  4.8.28.rc.012
+	 * @return array
+	 * @throws EE_Error
+	 */
+	private function _get_default_meta_caps_array()
+	{
+		static $default_meta_caps = array();
+		// make sure we're only ever initializing the default _meta_caps array once if it's empty.
+		if (empty($default_meta_caps)) {
+			$default_meta_caps = array(
+				// edits
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_event',
+					array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_venue',
+					array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_registration',
+					array('Registration', '', 'ee_edit_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_checkin',
+					array('Registration', '', 'ee_edit_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_edit_message',
+					array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_default_ticket',
+					array('Ticket', '', 'ee_edit_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question',
+					array('Question', '', '', 'ee_edit_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question_group',
+					array('Question_Group', '', '', 'ee_edit_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_payment_method',
+					array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
+				),
+				// reads
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_event',
+					array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_venue',
+					array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_registration',
+					array('Registration', '', 'ee_read_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_checkin',
+					array('Registration', '', 'ee_read_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_read_message',
+					array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_default_ticket',
+					array('Ticket', '', 'ee_read_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_payment_method',
+					array('Payment_Method', '', 'ee_read_others_payment_methods', '')
+				),
+				// deletes
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_event',
+					array(
+						'Event',
+						'ee_delete_published_events',
+						'ee_delete_others_events',
+						'ee_delete_private_events',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_venue',
+					array(
+						'Venue',
+						'ee_delete_published_venues',
+						'ee_delete_others_venues',
+						'ee_delete_private_venues',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_registration',
+					array('Registration', '', 'ee_delete_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_checkin',
+					array('Registration', '', 'ee_delete_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_delete_message',
+					array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_default_ticket',
+					array('Ticket', '', 'ee_delete_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question',
+					array('Question', '', '', 'delete_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question_group',
+					array('Question_Group', '', '', 'delete_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_payment_method',
+					array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
+				),
+			);
+		}
+		return $default_meta_caps;
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array actual users capabilities
+	 * @throws EE_Error
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
+			// loop through our _meta_caps array
+			foreach ($this->_meta_caps as $meta_map) {
+				if (! $meta_map instanceof EE_Meta_Capability_Map) {
+					continue;
+				}
+				// don't load models if there is no object ID in the args
+				if (! empty($args[0])) {
+					$meta_map->ensure_is_model();
+				}
+				$caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
+			}
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * This sets up and returns the initial capabilities map for Event Espresso
+	 * Note this array is filtered.
+	 * It is assumed that all available EE capabilities are assigned to the administrator role.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	private function _init_caps_map()
+	{
+		return apply_filters(
+			'FHEE__EE_Capabilities__init_caps_map__caps',
+			array(
+				'administrator'           => array(
+					// basic access
+					'ee_read_ee',
+					// gateways
+					/**
+					 * note that with payment method capabilities, although we've implemented
+					 * capability mapping which will be used for accessing payment methods owned by
+					 * other users.  This is not fully implemented yet in the payment method ui.
+					 * Currently only the "plural" caps are in active use.
+					 * (Specific payment method caps are in use as well).
+					 **/
+					'ee_manage_gateways',
+					'ee_read_payment_methods',
+					'ee_read_others_payment_methods',
+					'ee_edit_payment_methods',
+					'ee_edit_others_payment_methods',
+					'ee_delete_payment_methods',
+					// events
+					'ee_publish_events',
+					'ee_read_private_events',
+					'ee_read_others_events',
+					'ee_read_events',
+					'ee_edit_events',
+					'ee_edit_published_events',
+					'ee_edit_others_events',
+					'ee_edit_private_events',
+					'ee_delete_published_events',
+					'ee_delete_private_events',
+					'ee_delete_events',
+					'ee_delete_others_events',
+					// event categories
+					'ee_manage_event_categories',
+					'ee_edit_event_category',
+					'ee_delete_event_category',
+					'ee_assign_event_category',
+					// venues
+					'ee_publish_venues',
+					'ee_read_venues',
+					'ee_read_others_venues',
+					'ee_read_private_venues',
+					'ee_edit_venues',
+					'ee_edit_others_venues',
+					'ee_edit_published_venues',
+					'ee_edit_private_venues',
+					'ee_delete_venues',
+					'ee_delete_others_venues',
+					'ee_delete_private_venues',
+					'ee_delete_published_venues',
+					// venue categories
+					'ee_manage_venue_categories',
+					'ee_edit_venue_category',
+					'ee_delete_venue_category',
+					'ee_assign_venue_category',
+					// contacts
+					'ee_read_contacts',
+					'ee_edit_contacts',
+					'ee_delete_contacts',
+					// registrations
+					'ee_read_registrations',
+					'ee_read_others_registrations',
+					'ee_edit_registrations',
+					'ee_edit_others_registrations',
+					'ee_delete_registrations',
+					'ee_delete_others_registrations',
+					// checkins
+					'ee_read_others_checkins',
+					'ee_read_checkins',
+					'ee_edit_checkins',
+					'ee_edit_others_checkins',
+					'ee_delete_checkins',
+					'ee_delete_others_checkins',
+					// transactions && payments
+					'ee_read_transaction',
+					'ee_read_transactions',
+					'ee_edit_payments',
+					'ee_delete_payments',
+					// messages
+					'ee_read_messages',
+					'ee_read_others_messages',
+					'ee_read_global_messages',
+					'ee_edit_global_messages',
+					'ee_edit_messages',
+					'ee_edit_others_messages',
+					'ee_delete_messages',
+					'ee_delete_others_messages',
+					'ee_delete_global_messages',
+					'ee_send_message',
+					// tickets
+					'ee_read_default_tickets',
+					'ee_read_others_default_tickets',
+					'ee_edit_default_tickets',
+					'ee_edit_others_default_tickets',
+					'ee_delete_default_tickets',
+					'ee_delete_others_default_tickets',
+					// prices
+					'ee_edit_default_price',
+					'ee_edit_default_prices',
+					'ee_delete_default_price',
+					'ee_delete_default_prices',
+					'ee_edit_default_price_type',
+					'ee_edit_default_price_types',
+					'ee_delete_default_price_type',
+					'ee_delete_default_price_types',
+					'ee_read_default_prices',
+					'ee_read_default_price_types',
+					// registration form
+					'ee_edit_questions',
+					'ee_edit_system_questions',
+					'ee_read_questions',
+					'ee_delete_questions',
+					'ee_edit_question_groups',
+					'ee_read_question_groups',
+					'ee_edit_system_question_groups',
+					'ee_delete_question_groups',
+					// event_type taxonomy
+					'ee_assign_event_type',
+					'ee_manage_event_types',
+					'ee_edit_event_type',
+					'ee_delete_event_type',
+				),
+				'ee_events_administrator' => array(
+					// core wp caps
+					'read',
+					'read_private_pages',
+					'read_private_posts',
+					'edit_users',
+					'edit_posts',
+					'edit_pages',
+					'edit_published_posts',
+					'edit_published_pages',
+					'edit_private_pages',
+					'edit_private_posts',
+					'edit_others_posts',
+					'edit_others_pages',
+					'publish_posts',
+					'publish_pages',
+					'delete_posts',
+					'delete_pages',
+					'delete_private_pages',
+					'delete_private_posts',
+					'delete_published_pages',
+					'delete_published_posts',
+					'delete_others_posts',
+					'delete_others_pages',
+					'manage_categories',
+					'manage_links',
+					'moderate_comments',
+					'unfiltered_html',
+					'upload_files',
+					'export',
+					'import',
+					'list_users',
+					'level_1', // required if user with this role shows up in author dropdowns
+					// basic ee access
+					'ee_read_ee',
+					// events
+					'ee_publish_events',
+					'ee_read_private_events',
+					'ee_read_others_events',
+					'ee_read_event',
+					'ee_read_events',
+					'ee_edit_event',
+					'ee_edit_events',
+					'ee_edit_published_events',
+					'ee_edit_others_events',
+					'ee_edit_private_events',
+					'ee_delete_published_events',
+					'ee_delete_private_events',
+					'ee_delete_event',
+					'ee_delete_events',
+					'ee_delete_others_events',
+					// event categories
+					'ee_manage_event_categories',
+					'ee_edit_event_category',
+					'ee_delete_event_category',
+					'ee_assign_event_category',
+					// venues
+					'ee_publish_venues',
+					'ee_read_venue',
+					'ee_read_venues',
+					'ee_read_others_venues',
+					'ee_read_private_venues',
+					'ee_edit_venue',
+					'ee_edit_venues',
+					'ee_edit_others_venues',
+					'ee_edit_published_venues',
+					'ee_edit_private_venues',
+					'ee_delete_venue',
+					'ee_delete_venues',
+					'ee_delete_others_venues',
+					'ee_delete_private_venues',
+					'ee_delete_published_venues',
+					// venue categories
+					'ee_manage_venue_categories',
+					'ee_edit_venue_category',
+					'ee_delete_venue_category',
+					'ee_assign_venue_category',
+					// contacts
+					'ee_read_contacts',
+					'ee_edit_contacts',
+					'ee_delete_contacts',
+					// registrations
+					'ee_read_registrations',
+					'ee_read_others_registrations',
+					'ee_edit_registration',
+					'ee_edit_registrations',
+					'ee_edit_others_registrations',
+					'ee_delete_registration',
+					'ee_delete_registrations',
+					'ee_delete_others_registrations',
+					// checkins
+					'ee_read_others_checkins',
+					'ee_read_checkins',
+					'ee_edit_checkins',
+					'ee_edit_others_checkins',
+					'ee_delete_checkins',
+					'ee_delete_others_checkins',
+					// transactions && payments
+					'ee_read_transaction',
+					'ee_read_transactions',
+					'ee_edit_payments',
+					'ee_delete_payments',
+					// messages
+					'ee_read_messages',
+					'ee_read_others_messages',
+					'ee_read_global_messages',
+					'ee_edit_global_messages',
+					'ee_edit_messages',
+					'ee_edit_others_messages',
+					'ee_delete_messages',
+					'ee_delete_others_messages',
+					'ee_delete_global_messages',
+					'ee_send_message',
+					// tickets
+					'ee_read_default_tickets',
+					'ee_read_others_default_tickets',
+					'ee_edit_default_tickets',
+					'ee_edit_others_default_tickets',
+					'ee_delete_default_tickets',
+					'ee_delete_others_default_tickets',
+					// prices
+					'ee_edit_default_price',
+					'ee_edit_default_prices',
+					'ee_delete_default_price',
+					'ee_delete_default_prices',
+					'ee_edit_default_price_type',
+					'ee_edit_default_price_types',
+					'ee_delete_default_price_type',
+					'ee_delete_default_price_types',
+					'ee_read_default_prices',
+					'ee_read_default_price_types',
+					// registration form
+					'ee_edit_questions',
+					'ee_edit_system_questions',
+					'ee_read_questions',
+					'ee_delete_questions',
+					'ee_edit_question_groups',
+					'ee_read_question_groups',
+					'ee_edit_system_question_groups',
+					'ee_delete_question_groups',
+					// event_type taxonomy
+					'ee_assign_event_type',
+					'ee_manage_event_types',
+					'ee_edit_event_type',
+					'ee_delete_event_type',
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function setupCapabilitiesMap()
+	{
+		// if the initialization process hasn't even started, then we need to call init_caps()
+		if ($this->initialized === null) {
+			return $this->init_caps();
+		}
+		// unless resetting, get caps from db if we haven't already
+		$this->capabilities_map = $this->reset || ! empty($this->capabilities_map)
+			? $this->capabilities_map
+			: get_option(self::option_name, array());
+		return true;
+	}
+
+
+	/**
+	 * @param bool $update
+	 * @return bool
+	 */
+	private function updateCapabilitiesMap($update = true)
+	{
+		return $update ? update_option(self::option_name, $this->capabilities_map) : false;
+	}
+
+
+	/**
+	 * Adds capabilities to roles.
+	 *
+	 * @since 4.9.42
+	 * @param array $capabilities_to_add array of capabilities to add, indexed by roles.
+	 *                                   Note that this should ONLY be called on activation hook
+	 *                                   otherwise the caps will be added on every request.
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function addCaps(array $capabilities_to_add)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		// and filter the array so others can get in on the fun during resets
+		$capabilities_to_add = apply_filters(
+			'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+			$capabilities_to_add,
+			$this->reset,
+			$this->capabilities_map
+		);
+		$update_capabilities_map = false;
+		// if not reset, see what caps are new for each role. if they're new, add them.
+		foreach ($capabilities_to_add as $role => $caps_for_role) {
+			if (is_array($caps_for_role)) {
+				foreach ($caps_for_role as $cap) {
+					if (
+						! $this->capHasBeenAddedToRole($role, $cap)
+						&& $this->add_cap_to_role($role, $cap, true, false)
+					) {
+						$update_capabilities_map = true;
+					}
+				}
+			}
+		}
+		// now let's just save the cap that has been set but only if there's been a change.
+		$updated = $this->updateCapabilitiesMap($update_capabilities_map);
+		$this->flushWpUser($updated);
+		do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated);
+		return $updated;
+	}
+
+
+	/**
+	 * Loops through the capabilities map and removes the role caps specified by the incoming array
+	 *
+	 * @param array $caps_map map of capabilities to be removed (indexed by roles)
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function removeCaps($caps_map)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		$update_capabilities_map = false;
+		foreach ($caps_map as $role => $caps_for_role) {
+			if (is_array($caps_for_role)) {
+				foreach ($caps_for_role as $cap) {
+					if (
+						$this->capHasBeenAddedToRole($role, $cap)
+						&& $this->remove_cap_from_role($role, $cap, false)
+					) {
+						$update_capabilities_map = true;
+					}
+				}
+			}
+		}
+		// maybe resave the caps
+		$updated = $this->updateCapabilitiesMap($update_capabilities_map);
+		$this->flushWpUser($updated);
+		return $updated;
+	}
+
+
+	/**
+	 * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from
+	 * the roles on that user.
+	 *
+	 * @param bool $flush Default is to flush the WP_User object.  If false, then this method effectively does nothing.
+	 */
+	private function flushWpUser($flush = true)
+	{
+		if ($flush) {
+			$user = wp_get_current_user();
+			if ($user instanceof WP_User) {
+				$user->get_role_caps();
+			}
+		}
+	}
+
+
+	/**
+	 * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
+	 * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
+	 * this is a wrapper for $wp_role->add_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 * @param string|WP_Role $role  A WordPress role the capability is being added to
+	 * @param string         $cap   The capability being added to the role
+	 * @param bool           $grant Whether to grant access to this cap on this role.
+	 * @param bool           $update_capabilities_map
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true)
+	{
+		// capture incoming value for $role because we may need it to create a new WP_Role
+		$orig_role = $role;
+		$role = $role instanceof WP_Role ? $role : get_role($role);
+		// if the role isn't available then we create it.
+		if (! $role instanceof WP_Role) {
+			// if a plugin wants to create a specific role name then they should create the role before
+			// EE_Capabilities does.  Otherwise this function will create the role name from the slug:
+			// - removes any `ee_` namespacing from the start of the slug.
+			// - replaces `_` with ` ` (empty space).
+			// - sentence case on the resulting string.
+			$role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role));
+			$role = add_role($orig_role, $role_label);
+		}
+		if ($role instanceof WP_Role) {
+			// don't do anything if the capabilities map can not be initialized
+			if (! $this->setupCapabilitiesMap()) {
+				return false;
+			}
+			if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
+				$role->add_cap($cap, $grant);
+				$this->capabilities_map[ $role->name ][] = $cap;
+				$this->updateCapabilitiesMap($update_capabilities_map);
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Functions similarly to add_cap_to_role except removes cap from given role.
+	 * Wrapper for $wp_role->remove_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 * @param string|WP_Role $role A WordPress role the capability is being removed from.
+	 * @param string         $cap  The capability being removed
+	 * @param bool           $update_capabilities_map
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+
+		$role = $role instanceof WP_Role ? $role : get_role($role);
+		if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
+			$role->remove_cap($cap);
+			unset($this->capabilities_map[ $role->name ][ $index ]);
+			$this->updateCapabilitiesMap($update_capabilities_map);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param string $role_name
+	 * @param string $cap
+	 * @param bool   $get_index
+	 * @return bool|mixed
+	 */
+	private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false)
+	{
+		if (
+			isset($this->capabilities_map[ $role_name ])
+			&& ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false
+		) {
+			return $get_index ? $index : true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Wrapper for the native WP current_user_can() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can($cap, $context, $id = 0)
+	{
+		// apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+		$filtered_cap = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can__cap',
+			$filtered_cap,
+			$context,
+			$cap,
+			$id
+		);
+		return ! empty($id)
+			? current_user_can($filtered_cap, $id)
+			: current_user_can($filtered_cap);
+	}
+
+
+	/**
+	 * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
+	 *
+	 * @param int|WP_User $user    Either the user_id or a WP_User object
+	 * @param string      $cap     The capability string being checked
+	 * @param string      $context The context where the user_can is being called from (used in filters).
+	 * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
+	 *                             filters)
+	 *
+	 * @return bool Whether user can or not.
+	 */
+	public function user_can($user, $cap, $context, $id = 0)
+	{
+		// apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+		$filtered_cap = apply_filters(
+			'FHEE__EE_Capabilities__user_can__cap',
+			$filtered_cap,
+			$context,
+			$cap,
+			$user,
+			$id
+		);
+		return ! empty($id)
+			? user_can($user, $filtered_cap, $id)
+			: user_can($user, $filtered_cap);
+	}
+
+
+	/**
+	 * Wrapper for the native WP current_user_can_for_blog() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param int    $blog_id The blog id that is being checked for.
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
+	{
+		$user_can = ! empty($id)
+			? current_user_can_for_blog($blog_id, $cap, $id)
+			: current_user_can($blog_id, $cap);
+		// apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+			$user_can,
+			$blog_id,
+			$cap,
+			$id
+		);
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
+			$user_can,
+			$context,
+			$blog_id,
+			$cap,
+			$id
+		);
+		return $user_can;
+	}
+
+
+	/**
+	 * This helper method just returns an array of registered EE capabilities.
+	 *
+	 * @since 4.5.0
+	 * @param string $role If empty then the entire role/capability map is returned.
+	 *                     Otherwise just the capabilities for the given role are returned.
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_ee_capabilities($role = 'administrator')
+	{
+		if (! $this->initialized) {
+			$this->init_caps();
+		}
+		if (empty($role)) {
+			return $this->capabilities_map;
+		}
+		return isset($this->capabilities_map[ $role ])
+			? $this->capabilities_map[ $role ]
+			: array();
+	}
+
+
+	/**
+	 * @deprecated 4.9.42
+	 * @param bool  $reset      If you need to reset Event Espresso's capabilities,
+	 *                          then please use the init_caps() method with the "$reset" parameter set to "true"
+	 * @param array $caps_map   Optional.
+	 *                          Can be used to send a custom map of roles and capabilities for setting them up.
+	 *                          Note that this should ONLY be called on activation hook or some other one-time
+	 *                          task otherwise the caps will be added on every request.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function init_role_caps($reset = false, $caps_map = array())
+	{
+		// If this method is called directly and reset is set as 'true',
+		// then display a doing it wrong notice, because we want resets to go through init_caps()
+		// to guarantee that everything is set up correctly.
+		// This prevents the capabilities map getting reset incorrectly by direct calls to this method.
+		if ($reset) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".',
+						'event_espresso'
+					),
+					'$reset',
+					__METHOD__ . '()',
+					'EE_Capabilities::init_caps()',
+					'true'
+				),
+				'4.9.42',
+				'5.0.0'
+			);
+		}
+		$this->addCaps($caps_map);
+	}
 }
 
 
@@ -1006,142 +1006,142 @@ 
  */
 abstract class EE_Meta_Capability_Map
 {
-    public $meta_cap;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $_model;
-
-    protected $_model_name;
-
-    public $published_cap = '';
-
-    public $others_cap = '';
-
-    public $private_cap = '';
-
-
-    /**
-     * constructor.
-     * Receives the setup arguments for the map.
-     *
-     * @since                        4.5.0
-     *
-     * @param string $meta_cap   What meta capability is this mapping.
-     * @param array  $map_values array {
-     *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
-     *                           capabilities that don't get mapped to.
-     *
-     * @type         $map_values [0] string A string representing the model name. Required.  String's
-     *                               should always be used when Menu Maps are registered via the
-     *                               plugin API as models are not allowed to be instantiated when
-     *                               in maintenance mode 2 (migrations).
-     * @type         $map_values [1] string represents the capability used for published. Optional.
-     * @type         $map_values [2] string represents the capability used for "others". Optional.
-     * @type         $map_values [3] string represents the capability used for private. Optional.
-     *                               }
-     * @throws EE_Error
-     */
-    public function __construct($meta_cap, $map_values)
-    {
-        $this->meta_cap = $meta_cap;
-        // verify there are four args in the $map_values array;
-        if (count($map_values) !== 4) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
-                        'event_espresso'
-                    ),
-                    '<br>' . print_r($map_values, true)
-                )
-            );
-        }
-        // set properties
-        $this->_model = null;
-        $this->_model_name = $map_values[0];
-        $this->published_cap = (string) $map_values[1];
-        $this->others_cap = (string) $map_values[2];
-        $this->private_cap = (string) $map_values[3];
-    }
-
-    /**
-     * Makes it so this object stops filtering caps
-     */
-    public function remove_filters()
-    {
-        remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
-    }
-
-
-    /**
-     * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     *
-     * @return void
-     */
-    public function ensure_is_model()
-    {
-        // is it already instantiated?
-        if ($this->_model instanceof EEM_Base) {
-            return;
-        }
-        // ensure model name is string
-        $this->_model_name = (string) $this->_model_name;
-        // error proof if the name has EEM in it
-        $this->_model_name = str_replace('EEM', '', $this->_model_name);
-        $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $this->_model
-                )
-            );
-        }
-    }
-
-
-    /**
-     *
-     * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
-     * @since 4.6.x
-     *
-     * @param $caps
-     * @param $cap
-     * @param $user_id
-     * @param $args
-     *
-     * @return array
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return $this->_map_meta_caps($caps, $cap, $user_id, $args);
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
+	public $meta_cap;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model;
+
+	protected $_model_name;
+
+	public $published_cap = '';
+
+	public $others_cap = '';
+
+	public $private_cap = '';
+
+
+	/**
+	 * constructor.
+	 * Receives the setup arguments for the map.
+	 *
+	 * @since                        4.5.0
+	 *
+	 * @param string $meta_cap   What meta capability is this mapping.
+	 * @param array  $map_values array {
+	 *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
+	 *                           capabilities that don't get mapped to.
+	 *
+	 * @type         $map_values [0] string A string representing the model name. Required.  String's
+	 *                               should always be used when Menu Maps are registered via the
+	 *                               plugin API as models are not allowed to be instantiated when
+	 *                               in maintenance mode 2 (migrations).
+	 * @type         $map_values [1] string represents the capability used for published. Optional.
+	 * @type         $map_values [2] string represents the capability used for "others". Optional.
+	 * @type         $map_values [3] string represents the capability used for private. Optional.
+	 *                               }
+	 * @throws EE_Error
+	 */
+	public function __construct($meta_cap, $map_values)
+	{
+		$this->meta_cap = $meta_cap;
+		// verify there are four args in the $map_values array;
+		if (count($map_values) !== 4) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
+						'event_espresso'
+					),
+					'<br>' . print_r($map_values, true)
+				)
+			);
+		}
+		// set properties
+		$this->_model = null;
+		$this->_model_name = $map_values[0];
+		$this->published_cap = (string) $map_values[1];
+		$this->others_cap = (string) $map_values[2];
+		$this->private_cap = (string) $map_values[3];
+	}
+
+	/**
+	 * Makes it so this object stops filtering caps
+	 */
+	public function remove_filters()
+	{
+		remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
+	}
+
+
+	/**
+	 * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 *
+	 * @return void
+	 */
+	public function ensure_is_model()
+	{
+		// is it already instantiated?
+		if ($this->_model instanceof EEM_Base) {
+			return;
+		}
+		// ensure model name is string
+		$this->_model_name = (string) $this->_model_name;
+		// error proof if the name has EEM in it
+		$this->_model_name = str_replace('EEM', '', $this->_model_name);
+		$this->_model = EE_Registry::instance()->load_model($this->_model_name);
+		if (! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					$this->_model
+				)
+			);
+		}
+	}
+
+
+	/**
+	 *
+	 * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
+	 * @since 4.6.x
+	 *
+	 * @param $caps
+	 * @param $cap
+	 * @param $user_id
+	 * @param $args
+	 *
+	 * @return array
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return $this->_map_meta_caps($caps, $cap, $user_id, $args);
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
 }
 
 
@@ -1156,81 +1156,81 @@ 
  */
 class EE_Meta_Capability_Map_Edit extends EE_Meta_Capability_Map
 {
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        // only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-
-        // cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        /** @var EE_Base_Class $obj */
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        if ($obj instanceof EE_CPT_Base) {
-            // if the item author is set and the user is the author...
-            if ($obj->wp_user() && $user_id === $obj->wp_user()) {
-                // if obj is published...
-                if ($obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                }
-            } else {
-                // the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
-                    $caps[] = $this->private_cap;
-                }
-            }
-        } else {
-            // not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                           && $obj->wp_user()
-                           && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if (! $has_cap) {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		// only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+
+		// cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		/** @var EE_Base_Class $obj */
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		if ($obj instanceof EE_CPT_Base) {
+			// if the item author is set and the user is the author...
+			if ($obj->wp_user() && $user_id === $obj->wp_user()) {
+				// if obj is published...
+				if ($obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				}
+			} else {
+				// the user is trying to edit someone else's obj
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+				if (! empty($this->published_cap) && $obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				} elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+					$caps[] = $this->private_cap;
+				}
+			}
+		} else {
+			// not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+						   && $obj->wp_user()
+						   && $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if (! $has_cap) {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1246,24 +1246,24 @@ 
  */
 class EE_Meta_Capability_Map_Delete extends EE_Meta_Capability_Map_Edit
 {
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return parent::_map_meta_caps($caps, $cap, $user_id, $args);
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return parent::_map_meta_caps($caps, $cap, $user_id, $args);
+	}
 }
 
 
@@ -1278,86 +1278,86 @@ 
  */
 class EE_Meta_Capability_Map_Read extends EE_Meta_Capability_Map
 {
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        // only process if we're checking our mapped cap;
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-
-        // cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-
-        $caps[] = $cap . 's';
-        if ($obj instanceof EE_CPT_Base) {
-            $status_obj = get_post_status_object($obj->status());
-            if ($status_obj->public) {
-                return $caps;
-            }
-            // if the item author is set and the user is not the author...
-            if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-            // yes this means that if users created the private post, they are able to see it regardless of private cap.
-            if (
-                $status_obj->private
-                && ! empty($this->private_cap)
-                && $obj->wp_user() !== $user_id
-            ) {
-                // the user is trying to view a private object for an object they don't own.
-                $caps[] = $this->private_cap;
-            }
-        } else {
-            // not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                           && $obj->wp_user()
-                           && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if (! $has_cap) {
-                if (! empty($this->private_cap)) {
-                    $caps[] = $this->private_cap;
-                }
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		// only process if we're checking our mapped cap;
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+
+		// cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+
+		$caps[] = $cap . 's';
+		if ($obj instanceof EE_CPT_Base) {
+			$status_obj = get_post_status_object($obj->status());
+			if ($status_obj->public) {
+				return $caps;
+			}
+			// if the item author is set and the user is not the author...
+			if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+			// yes this means that if users created the private post, they are able to see it regardless of private cap.
+			if (
+				$status_obj->private
+				&& ! empty($this->private_cap)
+				&& $obj->wp_user() !== $user_id
+			) {
+				// the user is trying to view a private object for an object they don't own.
+				$caps[] = $this->private_cap;
+			}
+		} else {
+			// not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+						   && $obj->wp_user()
+						   && $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if (! $has_cap) {
+				if (! empty($this->private_cap)) {
+					$caps[] = $this->private_cap;
+				}
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1373,56 +1373,56 @@ 
  */
 class EE_Meta_Capability_Map_Messages_Cap extends EE_Meta_Capability_Map
 {
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        // only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-
-        // cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        $is_global = $obj->is_global();
-        if ($obj->wp_user() && $obj->wp_user() === $user_id) {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            }
-        } else {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            } else {
-                $caps[] = $this->others_cap;
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		// only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+
+		// cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Message_Template_Group) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		$is_global = $obj->is_global();
+		if ($obj->wp_user() && $obj->wp_user() === $user_id) {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			}
+		} else {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			} else {
+				$caps[] = $this->others_cap;
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1438,40 +1438,40 @@ 
  */
 class EE_Meta_Capability_Map_Registration_Form_Cap extends EE_Meta_Capability_Map
 {
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        // only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
-        $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
-        if ($is_system) {
-            $caps[] = $this->private_cap;
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		// only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		$is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
+		$is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
+		if ($is_system) {
+			$caps[] = $this->private_cap;
+		}
+		return $caps;
+	}
 }

shortcodes/espresso_checkout/EES_Espresso_Checkout.shortcode.php

Indentation +49 added lines, -50 removed lines

@@ -7,66 +7,65 @@
  * @package     Event Espresso
  * @subpackage  /shortcodes/
  * @author      Brent Christensen
-
  * ------------------------------------------------------------------------
  */
 class EES_Espresso_Checkout extends EES_Shortcode
 {
 
-    /**
-     *  set_hooks - for hooking into EE Core, modules, etc
-     *
-     *  @access     public
-     *  @return     void
-     */
-    public static function set_hooks()
-    {
-    }
+	/**
+	 *  set_hooks - for hooking into EE Core, modules, etc
+	 *
+	 *  @access     public
+	 *  @return     void
+	 */
+	public static function set_hooks()
+	{
+	}
 
-    /**
-     *  set_hooks_admin - for hooking into EE Admin Core, modules, etc
-     *
-     *  @access     public
-     *  @return     void
-     */
-    public static function set_hooks_admin()
-    {
-    }
+	/**
+	 *  set_hooks_admin - for hooking into EE Admin Core, modules, etc
+	 *
+	 *  @access     public
+	 *  @return     void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
 
 
 
-    /**
-     *    run - initial shortcode module setup called during "wp_loaded" hook
-     *    this method is primarily used for loading resources that will be required by the shortcode when it is actually processed
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function run(WP $WP)
-    {
-    }
+	/**
+	 *    run - initial shortcode module setup called during "wp_loaded" hook
+	 *    this method is primarily used for loading resources that will be required by the shortcode when it is actually processed
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function run(WP $WP)
+	{
+	}
 
 
 
-    /**
-     *  process_shortcode - ESPRESSO_CHECKOUT
-     *
-     *  @access     public
-     *  @param      array   $attributes
-     *  @return     string
-     */
-    public function process_shortcode($attributes = array())
-    {
-        \EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Usage is deprecated. Please use \EventEspresso\core\domain\entities\shortcodes\EspressoCheckout::processShortcode() instead.',
-                'event_espresso'
-            ),
-            '4.9.27'
-        );
-        return '';
-    }
+	/**
+	 *  process_shortcode - ESPRESSO_CHECKOUT
+	 *
+	 *  @access     public
+	 *  @param      array   $attributes
+	 *  @return     string
+	 */
+	public function process_shortcode($attributes = array())
+	{
+		\EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Usage is deprecated. Please use \EventEspresso\core\domain\entities\shortcodes\EspressoCheckout::processShortcode() instead.',
+				'event_espresso'
+			),
+			'4.9.27'
+		);
+		return '';
+	}
 }

payment_methods/Paypal_Express/templates/paypal_express_intro.template.php

Indentation +6 added lines, -6 removed lines

@@ -1,10 +1,10 @@
 <?php
 
 printf(
-    esc_html__(
-        'PayPal Express (Express Checkout) is an off-site payment method for accepting payments via PayPal and is available to event organizers in many countries. A PayPal premier or business account is needed to accept payments. Need a PayPal account? Call 1-855-456-1338 or %1$sclick here to sign up for a merchant account%2$s.',
-        'event_espresso'
-    ),
-    '<a href="https://eventespresso.com/go/paypalexpress/" target="_blank">',
-    '</a>'
+	esc_html__(
+		'PayPal Express (Express Checkout) is an off-site payment method for accepting payments via PayPal and is available to event organizers in many countries. A PayPal premier or business account is needed to accept payments. Need a PayPal account? Call 1-855-456-1338 or %1$sclick here to sign up for a merchant account%2$s.',
+		'event_espresso'
+	),
+	'<a href="https://eventespresso.com/go/paypalexpress/" target="_blank">',
+	'</a>'
 );

payment_methods/Paypal_Standard/EEG_Paypal_Standard.gateway.php

Spacing +30 added lines, -30 removed lines

@@ -137,17 +137,17 @@ 
                         $shipping_previously_added = $line_item->total();
                         continue;
                     }
-                    $redirect_args[ 'item_name_' . $item_num ] = substr(
+                    $redirect_args['item_name_'.$item_num] = substr(
                         $gateway_formatter->formatLineItemName($line_item, $payment),
                         0,
                         127
                     );
-                    $redirect_args[ 'amount_' . $item_num ] = $line_item->unit_price();
-                    $redirect_args[ 'quantity_' . $item_num ] = $line_item->quantity();
+                    $redirect_args['amount_'.$item_num] = $line_item->unit_price();
+                    $redirect_args['quantity_'.$item_num] = $line_item->quantity();
                     // if we're not letting PayPal calculate shipping, tell them its 0
-                    if (! $this->_paypal_shipping) {
-                        $redirect_args[ 'shipping_' . $item_num ] = '0';
-                        $redirect_args[ 'shipping2_' . $item_num ] = '0';
+                    if ( ! $this->_paypal_shipping) {
+                        $redirect_args['shipping_'.$item_num] = '0';
+                        $redirect_args['shipping2_'.$item_num] = '0';
                     }
                     $item_num++;
                     $itemized_sum += $line_item->total();
@@ -167,15 +167,15 @@ 
                 // itemized sum is too big
                 $total_discounts_to_cart_total += abs($itemized_sum_diff_from_txn_total);
             } elseif ($itemized_sum_diff_from_txn_total > 0) {
-                $redirect_args[ 'item_name_' . $item_num ] = substr(
+                $redirect_args['item_name_'.$item_num] = substr(
                     esc_html__('Other charges', 'event_espresso'),
                     0,
                     127
                 );
-                $redirect_args[ 'amount_' . $item_num ] = $gateway_formatter->formatCurrency(
+                $redirect_args['amount_'.$item_num] = $gateway_formatter->formatCurrency(
                     $itemized_sum_diff_from_txn_total
                 );
-                $redirect_args[ 'quantity_' . $item_num ] = 1;
+                $redirect_args['quantity_'.$item_num] = 1;
                 $item_num++;
             }
             if ($total_discounts_to_cart_total > 0) {
@@ -184,34 +184,34 @@ 
                 );
             }
             // add our taxes to the order if we're NOT using PayPal's
-            if (! $this->_paypal_taxes) {
+            if ( ! $this->_paypal_taxes) {
                 $redirect_args['tax_cart'] = $total_line_item->get_total_tax();
             }
         } else {
             $payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
             // partial payment that's not for the remaining amount, so we can't send an itemized list
-            $redirect_args[ 'item_name_' . $item_num ] = substr(
+            $redirect_args['item_name_'.$item_num] = substr(
                 $gateway_formatter->formatPartialPaymentLineItemName($payment),
                 0,
                 127
             );
-            $redirect_args[ 'amount_' . $item_num ] = $payment->amount();
-            $redirect_args[ 'shipping_' . $item_num ] = '0';
-            $redirect_args[ 'shipping2_' . $item_num ] = '0';
+            $redirect_args['amount_'.$item_num] = $payment->amount();
+            $redirect_args['shipping_'.$item_num] = '0';
+            $redirect_args['shipping2_'.$item_num] = '0';
             $redirect_args['tax_cart'] = '0';
             $item_num++;
         }
 
         if ($this->_debug_mode) {
-            $redirect_args[ 'item_name_' . $item_num ] = 'DEBUG INFO (this item only added in sandbox mode';
-            $redirect_args[ 'amount_' . $item_num ] = 0;
-            $redirect_args[ 'on0_' . $item_num ] = 'NOTIFY URL';
-            $redirect_args[ 'os0_' . $item_num ] = $notify_url;
-            $redirect_args[ 'on1_' . $item_num ] = 'RETURN URL';
-            $redirect_args[ 'os1_' . $item_num ] = $return_url;
+            $redirect_args['item_name_'.$item_num] = 'DEBUG INFO (this item only added in sandbox mode';
+            $redirect_args['amount_'.$item_num] = 0;
+            $redirect_args['on0_'.$item_num] = 'NOTIFY URL';
+            $redirect_args['os0_'.$item_num] = $notify_url;
+            $redirect_args['on1_'.$item_num] = 'RETURN URL';
+            $redirect_args['os1_'.$item_num] = $return_url;
 //          $redirect_args['option_index_' . $item_num] = 1; // <-- dunno if this is needed ?
-            $redirect_args[ 'shipping_' . $item_num ] = '0';
-            $redirect_args[ 'shipping2_' . $item_num ] = '0';
+            $redirect_args['shipping_'.$item_num] = '0';
+            $redirect_args['shipping2_'.$item_num] = '0';
         }
 
         $redirect_args['business'] = $this->_paypal_id;
@@ -221,12 +221,12 @@ 
         $redirect_args['cmd'] = '_cart';
         $redirect_args['upload'] = 1;
         $redirect_args['currency_code'] = $payment->currency_code();
-        $redirect_args['rm'] = 2;// makes the user return with method=POST
+        $redirect_args['rm'] = 2; // makes the user return with method=POST
         if ($this->_image_url) {
             $redirect_args['image_url'] = $this->_image_url;
         }
         $redirect_args['no_shipping'] = $this->_shipping_details;
-        $redirect_args['bn'] = 'EventEspresso_SP';// EE will blow up if you change this
+        $redirect_args['bn'] = 'EventEspresso_SP'; // EE will blow up if you change this
 
         $redirect_args = apply_filters("FHEE__EEG_Paypal_Standard__set_redirection_info__arguments", $redirect_args, $this);
 
@@ -281,12 +281,12 @@ 
             }
         }
         $payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
-        if (! $payment instanceof EEI_Payment) {
+        if ( ! $payment instanceof EEI_Payment) {
             $payment = $transaction->last_payment();
         }
         // ok, then validate the IPN. Even if we've already processed this payment,
         // let PayPal know we don't want to hear from them anymore!
-        if (! $this->validate_ipn($update_info, $payment)) {
+        if ( ! $this->validate_ipn($update_info, $payment)) {
             return $payment;
         }
         // kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
@@ -426,7 +426,7 @@ 
         foreach ($raw_post_array as $keyval) {
             $keyval = explode('=', $keyval);
             if (count($keyval) === 2) {
-                $update_info[ $keyval[0] ] = urldecode($keyval[1]);
+                $update_info[$keyval[0]] = urldecode($keyval[1]);
             }
         }
         // read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
@@ -447,7 +447,7 @@ 
                 'timeout'           => 60,
                 // make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
                 // plz see: https://github.com/websharks/s2member/issues/610
-                'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
+                'user-agent'        => 'Event Espresso v'.EVENT_ESPRESSO_VERSION.'; '.home_url(),
                 'httpversion'       => '1.1'
             )
         );
@@ -524,7 +524,7 @@ 
         /** @var EE_Transaction $transaction */
         $transaction = $payment->transaction();
         $payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
-        if (! $transaction) {
+        if ( ! $transaction) {
             $this->log(
                 esc_html__(
                     // @codingStandardsIgnoreStart
@@ -599,7 +599,7 @@ 
                 esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
                 1,
                 false,
-                'paypal_shipping_' . $transaction->ID()
+                'paypal_shipping_'.$transaction->ID()
             );
             $grand_total_needs_resaving = true;
         }

Indentation +603 added lines, -603 removed lines

@@ -18,608 +18,608 @@
  */
 class EEG_Paypal_Standard extends EE_Offsite_Gateway
 {
-    /**
-     * Name for the wp option used to save the itemized payment
-     */
-    const itemized_payment_option_name = '_itemized_payment';
-
-    protected $_paypal_id;
-
-    protected $_image_url;
-
-    protected $_shipping_details;
-
-    protected $_paypal_shipping;
-
-    protected $_paypal_taxes;
-
-    protected $_gateway_url;
-
-    protected $_currencies_supported = array(
-        'USD',
-        'GBP',
-        'CAD',
-        'AUD',
-        'BRL',
-        'CHF',
-        'CZK',
-        'DKK',
-        'EUR',
-        'HKD',
-        'HUF',
-        'ILS',
-        'JPY',
-        'MXN',
-        'MYR',
-        'NOK',
-        'NZD',
-        'PHP',
-        'PLN',
-        'SEK',
-        'SGD',
-        'THB',
-        'TRY',
-        'TWD',
-        'RUB'
-    );
-
-
-    /**
-     * EEG_Paypal_Standard constructor.
-     *
-     * @return EEG_Paypal_Standard
-     */
-    public function __construct()
-    {
-        $this->set_uses_separate_IPN_request(true);
-        parent::__construct();
-    }
-
-
-    /**
-     * Also sets the gateway url class variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        $this->_gateway_url = $this->_debug_mode
-            ? 'https://www.sandbox.paypal.com/cgi-bin/webscr'
-            : 'https://www.paypal.com/cgi-bin/webscr';
-    }
-
-
-    /**
-     * @param EEI_Payment $payment      the payment to process
-     * @param array       $billing_info but should be empty for this gateway
-     * @param string      $return_url   URL to send the user to after payment on the payment provider's website
-     * @param string      $notify_url   URL to send the instant payment notification
-     * @param string      $cancel_url   URL to send the user to after a cancelled payment attempt
-     *                                  on the payment provider's website
-     * @return EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        $redirect_args = array();
-        $transaction = $payment->transaction();
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $item_num = 1;
-        /** @type EE_Line_Item $total_line_item */
-        $total_line_item = $transaction->total_line_item();
-
-        $total_discounts_to_cart_total = $transaction->paid();
-        // only itemize the order if we're paying for the rest of the order's amount
-        if (EEH_Money::compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true);
-            // this payment is for the remaining transaction amount,
-            // keep track of exactly how much the itemized order amount equals
-            $itemized_sum = 0;
-            $shipping_previously_added = 0;
-            // so let's show all the line items
-            foreach ($total_line_item->get_items() as $line_item) {
-                if ($line_item instanceof EE_Line_Item) {
-                    // it's some kind of discount
-                    if ($line_item->total() < 0) {
-                        $total_discounts_to_cart_total += abs($line_item->total());
-                        $itemized_sum += $line_item->total();
-                        continue;
-                    }
-                    // dont include shipping again.
-                    if (strpos($line_item->code(), 'paypal_shipping_') === 0) {
-                        $shipping_previously_added = $line_item->total();
-                        continue;
-                    }
-                    $redirect_args[ 'item_name_' . $item_num ] = substr(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    );
-                    $redirect_args[ 'amount_' . $item_num ] = $line_item->unit_price();
-                    $redirect_args[ 'quantity_' . $item_num ] = $line_item->quantity();
-                    // if we're not letting PayPal calculate shipping, tell them its 0
-                    if (! $this->_paypal_shipping) {
-                        $redirect_args[ 'shipping_' . $item_num ] = '0';
-                        $redirect_args[ 'shipping2_' . $item_num ] = '0';
-                    }
-                    $item_num++;
-                    $itemized_sum += $line_item->total();
-                }
-            }
-            $taxes_li = $this->_line_item->get_taxes_subtotal($total_line_item);
-            // ideally itemized sum equals the transaction total. but if not (which is weird)
-            // and the itemized sum is LESS than the transaction total
-            // add another line item
-            // if the itemized sum is MORE than the transaction total,
-            // add the difference it to the discounts
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $taxes_li->total() - $shipping_previously_added,
-                2
-            );
-            if ($itemized_sum_diff_from_txn_total < 0) {
-                // itemized sum is too big
-                $total_discounts_to_cart_total += abs($itemized_sum_diff_from_txn_total);
-            } elseif ($itemized_sum_diff_from_txn_total > 0) {
-                $redirect_args[ 'item_name_' . $item_num ] = substr(
-                    esc_html__('Other charges', 'event_espresso'),
-                    0,
-                    127
-                );
-                $redirect_args[ 'amount_' . $item_num ] = $gateway_formatter->formatCurrency(
-                    $itemized_sum_diff_from_txn_total
-                );
-                $redirect_args[ 'quantity_' . $item_num ] = 1;
-                $item_num++;
-            }
-            if ($total_discounts_to_cart_total > 0) {
-                $redirect_args['discount_amount_cart'] = $gateway_formatter->formatCurrency(
-                    $total_discounts_to_cart_total
-                );
-            }
-            // add our taxes to the order if we're NOT using PayPal's
-            if (! $this->_paypal_taxes) {
-                $redirect_args['tax_cart'] = $total_line_item->get_total_tax();
-            }
-        } else {
-            $payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
-            // partial payment that's not for the remaining amount, so we can't send an itemized list
-            $redirect_args[ 'item_name_' . $item_num ] = substr(
-                $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                0,
-                127
-            );
-            $redirect_args[ 'amount_' . $item_num ] = $payment->amount();
-            $redirect_args[ 'shipping_' . $item_num ] = '0';
-            $redirect_args[ 'shipping2_' . $item_num ] = '0';
-            $redirect_args['tax_cart'] = '0';
-            $item_num++;
-        }
-
-        if ($this->_debug_mode) {
-            $redirect_args[ 'item_name_' . $item_num ] = 'DEBUG INFO (this item only added in sandbox mode';
-            $redirect_args[ 'amount_' . $item_num ] = 0;
-            $redirect_args[ 'on0_' . $item_num ] = 'NOTIFY URL';
-            $redirect_args[ 'os0_' . $item_num ] = $notify_url;
-            $redirect_args[ 'on1_' . $item_num ] = 'RETURN URL';
-            $redirect_args[ 'os1_' . $item_num ] = $return_url;
+	/**
+	 * Name for the wp option used to save the itemized payment
+	 */
+	const itemized_payment_option_name = '_itemized_payment';
+
+	protected $_paypal_id;
+
+	protected $_image_url;
+
+	protected $_shipping_details;
+
+	protected $_paypal_shipping;
+
+	protected $_paypal_taxes;
+
+	protected $_gateway_url;
+
+	protected $_currencies_supported = array(
+		'USD',
+		'GBP',
+		'CAD',
+		'AUD',
+		'BRL',
+		'CHF',
+		'CZK',
+		'DKK',
+		'EUR',
+		'HKD',
+		'HUF',
+		'ILS',
+		'JPY',
+		'MXN',
+		'MYR',
+		'NOK',
+		'NZD',
+		'PHP',
+		'PLN',
+		'SEK',
+		'SGD',
+		'THB',
+		'TRY',
+		'TWD',
+		'RUB'
+	);
+
+
+	/**
+	 * EEG_Paypal_Standard constructor.
+	 *
+	 * @return EEG_Paypal_Standard
+	 */
+	public function __construct()
+	{
+		$this->set_uses_separate_IPN_request(true);
+		parent::__construct();
+	}
+
+
+	/**
+	 * Also sets the gateway url class variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		$this->_gateway_url = $this->_debug_mode
+			? 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+			: 'https://www.paypal.com/cgi-bin/webscr';
+	}
+
+
+	/**
+	 * @param EEI_Payment $payment      the payment to process
+	 * @param array       $billing_info but should be empty for this gateway
+	 * @param string      $return_url   URL to send the user to after payment on the payment provider's website
+	 * @param string      $notify_url   URL to send the instant payment notification
+	 * @param string      $cancel_url   URL to send the user to after a cancelled payment attempt
+	 *                                  on the payment provider's website
+	 * @return EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		$redirect_args = array();
+		$transaction = $payment->transaction();
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$item_num = 1;
+		/** @type EE_Line_Item $total_line_item */
+		$total_line_item = $transaction->total_line_item();
+
+		$total_discounts_to_cart_total = $transaction->paid();
+		// only itemize the order if we're paying for the rest of the order's amount
+		if (EEH_Money::compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true);
+			// this payment is for the remaining transaction amount,
+			// keep track of exactly how much the itemized order amount equals
+			$itemized_sum = 0;
+			$shipping_previously_added = 0;
+			// so let's show all the line items
+			foreach ($total_line_item->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
+					// it's some kind of discount
+					if ($line_item->total() < 0) {
+						$total_discounts_to_cart_total += abs($line_item->total());
+						$itemized_sum += $line_item->total();
+						continue;
+					}
+					// dont include shipping again.
+					if (strpos($line_item->code(), 'paypal_shipping_') === 0) {
+						$shipping_previously_added = $line_item->total();
+						continue;
+					}
+					$redirect_args[ 'item_name_' . $item_num ] = substr(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					);
+					$redirect_args[ 'amount_' . $item_num ] = $line_item->unit_price();
+					$redirect_args[ 'quantity_' . $item_num ] = $line_item->quantity();
+					// if we're not letting PayPal calculate shipping, tell them its 0
+					if (! $this->_paypal_shipping) {
+						$redirect_args[ 'shipping_' . $item_num ] = '0';
+						$redirect_args[ 'shipping2_' . $item_num ] = '0';
+					}
+					$item_num++;
+					$itemized_sum += $line_item->total();
+				}
+			}
+			$taxes_li = $this->_line_item->get_taxes_subtotal($total_line_item);
+			// ideally itemized sum equals the transaction total. but if not (which is weird)
+			// and the itemized sum is LESS than the transaction total
+			// add another line item
+			// if the itemized sum is MORE than the transaction total,
+			// add the difference it to the discounts
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $taxes_li->total() - $shipping_previously_added,
+				2
+			);
+			if ($itemized_sum_diff_from_txn_total < 0) {
+				// itemized sum is too big
+				$total_discounts_to_cart_total += abs($itemized_sum_diff_from_txn_total);
+			} elseif ($itemized_sum_diff_from_txn_total > 0) {
+				$redirect_args[ 'item_name_' . $item_num ] = substr(
+					esc_html__('Other charges', 'event_espresso'),
+					0,
+					127
+				);
+				$redirect_args[ 'amount_' . $item_num ] = $gateway_formatter->formatCurrency(
+					$itemized_sum_diff_from_txn_total
+				);
+				$redirect_args[ 'quantity_' . $item_num ] = 1;
+				$item_num++;
+			}
+			if ($total_discounts_to_cart_total > 0) {
+				$redirect_args['discount_amount_cart'] = $gateway_formatter->formatCurrency(
+					$total_discounts_to_cart_total
+				);
+			}
+			// add our taxes to the order if we're NOT using PayPal's
+			if (! $this->_paypal_taxes) {
+				$redirect_args['tax_cart'] = $total_line_item->get_total_tax();
+			}
+		} else {
+			$payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
+			// partial payment that's not for the remaining amount, so we can't send an itemized list
+			$redirect_args[ 'item_name_' . $item_num ] = substr(
+				$gateway_formatter->formatPartialPaymentLineItemName($payment),
+				0,
+				127
+			);
+			$redirect_args[ 'amount_' . $item_num ] = $payment->amount();
+			$redirect_args[ 'shipping_' . $item_num ] = '0';
+			$redirect_args[ 'shipping2_' . $item_num ] = '0';
+			$redirect_args['tax_cart'] = '0';
+			$item_num++;
+		}
+
+		if ($this->_debug_mode) {
+			$redirect_args[ 'item_name_' . $item_num ] = 'DEBUG INFO (this item only added in sandbox mode';
+			$redirect_args[ 'amount_' . $item_num ] = 0;
+			$redirect_args[ 'on0_' . $item_num ] = 'NOTIFY URL';
+			$redirect_args[ 'os0_' . $item_num ] = $notify_url;
+			$redirect_args[ 'on1_' . $item_num ] = 'RETURN URL';
+			$redirect_args[ 'os1_' . $item_num ] = $return_url;
 //          $redirect_args['option_index_' . $item_num] = 1; // <-- dunno if this is needed ?
-            $redirect_args[ 'shipping_' . $item_num ] = '0';
-            $redirect_args[ 'shipping2_' . $item_num ] = '0';
-        }
-
-        $redirect_args['business'] = $this->_paypal_id;
-        $redirect_args['return'] = $return_url;
-        $redirect_args['cancel_return'] = $cancel_url;
-        $redirect_args['notify_url'] = $notify_url;
-        $redirect_args['cmd'] = '_cart';
-        $redirect_args['upload'] = 1;
-        $redirect_args['currency_code'] = $payment->currency_code();
-        $redirect_args['rm'] = 2;// makes the user return with method=POST
-        if ($this->_image_url) {
-            $redirect_args['image_url'] = $this->_image_url;
-        }
-        $redirect_args['no_shipping'] = $this->_shipping_details;
-        $redirect_args['bn'] = 'EventEspresso_SP';// EE will blow up if you change this
-
-        $redirect_args = apply_filters("FHEE__EEG_Paypal_Standard__set_redirection_info__arguments", $redirect_args, $this);
-
-        $payment->set_redirect_url($this->_gateway_url);
-        $payment->set_redirect_args($redirect_args);
-        // log the results
-        $this->log(
-            array(
-                'message'     => sprintf(
-                    esc_html__('PayPal payment request initiated.', 'event_espresso')
-                ),
-                'transaction' => $transaction->model_field_array(),
-            ),
-            $payment
-        );
-        return $payment;
-    }
-
-
-    /**
-     * Often used for IPNs. But applies the info in $update_info to the payment.
-     * What is $update_info? Often the contents of $_REQUEST, but not necessarily. Whatever
-     * the payment method passes in.
-     *
-     * @param array $update_info like $_POST
-     * @param EEI_Transaction $transaction
-     * @return \EEI_Payment updated
-     * @throws \EE_Error, IpnException
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        // verify there's payment data that's been sent
-        if (empty($update_info['payment_status']) || empty($update_info['txn_id'])) {
-            // log the results
-            $this->log(
-                array(
-                    'message'     => sprintf(
-                        // @codingStandardsIgnoreStart
-                        esc_html__('PayPal IPN response is missing critical payment data. This may indicate a PDT request and require your PayPal account settings to be corrected.', 'event_espresso')
-                        // @codingStandardsIgnoreEnd
-                    ),
-                    'update_info' => $update_info,
-                ),
-                $transaction
-            );
-            // waaaait... is this a PDT request? (see https://developer.paypal.com/docs/classic/products/payment-data-transfer/)
-            // indicated by the "tx" argument? If so, we don't need it. We'll just use the IPN data when it comes
-            if (isset($update_info['tx'])) {
-                return $transaction->last_payment();
-            } else {
-                return null;
-            }
-        }
-        $payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
-        if (! $payment instanceof EEI_Payment) {
-            $payment = $transaction->last_payment();
-        }
-        // ok, then validate the IPN. Even if we've already processed this payment,
-        // let PayPal know we don't want to hear from them anymore!
-        if (! $this->validate_ipn($update_info, $payment)) {
-            return $payment;
-        }
-        // kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
-        // registrations, ticket counts, etc)
-        if (
-            (
-                $update_info['payment_status'] === 'Refunded'
-                || $update_info['payment_status'] === 'Partially_Refunded'
-            )
-            && apply_filters('FHEE__EEG_Paypal_Standard__handle_payment_update__kill_refund_request', true)
-        ) {
-            throw new EventEspresso\core\exceptions\IpnException(
-                sprintf(
-                    esc_html__('Event Espresso does not yet support %1$s IPNs from PayPal', 'event_espresso'),
-                    $update_info['payment_status']
-                ),
-                EventEspresso\core\exceptions\IpnException::UNSUPPORTED,
-                null,
-                $payment,
-                $update_info
-            );
-        }
-        // ok, well let's process this payment then!
-        switch ($update_info['payment_status']) {
-            case 'Completed':
-                $status = $this->_pay_model->approved_status();
-                $gateway_response = esc_html__('The payment is approved.', 'event_espresso');
-                break;
-
-            case 'Pending':
-                $status = $this->_pay_model->pending_status();
-                $gateway_response = esc_html__(
-                    'The payment is in progress. Another message will be sent when payment is approved.',
-                    'event_espresso'
-                );
-                break;
-
-            case 'Denied':
-                $status = $this->_pay_model->declined_status();
-                $gateway_response = esc_html__('The payment has been declined.', 'event_espresso');
-                break;
-
-            case 'Expired':
-            case 'Failed':
-                $status = $this->_pay_model->failed_status();
-                $gateway_response = esc_html__('The payment failed for technical reasons or expired.', 'event_espresso');
-                break;
-
-            case 'Refunded':
-            case 'Partially_Refunded':
-                // even though it's a refund, we consider the payment as approved, it just has a negative value
-                $status = $this->_pay_model->approved_status();
-                $gateway_response = esc_html__(
-                    'The payment has been refunded. Please update registrations accordingly.',
-                    'event_espresso'
-                );
-                break;
-
-            case 'Voided':
-            case 'Reversed':
-            case 'Canceled_Reversal':
-            default:
-                $status = $this->_pay_model->cancelled_status();
-                $gateway_response = esc_html__(
-                    'The payment was cancelled, reversed, or voided. Please update registrations accordingly.',
-                    'event_espresso'
-                );
-                break;
-        }
-
-        // check if we've already processed this payment
-        if ($payment instanceof EEI_Payment) {
-            // payment exists. if this has the exact same status and amount, don't bother updating. just return
-            if ($payment->status() === $status && (float) $payment->amount() === (float) $update_info['mc_gross']) {
-                // DUPLICATED IPN! don't bother updating transaction
-                throw new IpnException(
-                    sprintf(
-                        esc_html__(
-                            'It appears we have received a duplicate IPN from PayPal for payment %d',
-                            'event_espresso'
-                        ),
-                        $payment->ID()
-                    ),
-                    IpnException::DUPLICATE,
-                    null,
-                    $payment,
-                    $update_info
-                );
-            } else {
-                // new payment yippee !!!
-                $payment->set_status($status);
-                $payment->set_amount((float) $update_info['mc_gross']);
-                $payment->set_gateway_response($gateway_response);
-                $payment->set_details($update_info);
-                $payment->set_txn_id_chq_nmbr($update_info['txn_id']);
-                $this->log(
-                    array(
-                        'message'  => esc_html__(
-                            'Updated payment either from IPN or as part of POST from PayPal',
-                            'event_espresso'
-                        ),
-                        'url'      => $this->_process_response_url(),
-                        'payment'  => $payment->model_field_array(),
-                        'IPN_data' => $update_info
-                    ),
-                    $payment
-                );
-            }
-        }
-        do_action('FHEE__EEG_Paypal_Standard__handle_payment_update__payment_processed', $payment, $this);
-        return $payment;
-    }
-
-
-    /**
-     * Validate the IPN notification.
-     *
-     * @param array                  $update_info like $_REQUEST
-     * @param EE_Payment|EEI_Payment $payment
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function validate_ipn($update_info, $payment)
-    {
-        // allow us to skip validating IPNs with PayPal (useful for testing)
-        if (apply_filters('FHEE__EEG_Paypal_Standard__validate_ipn__skip', false)) {
-            return true;
-        }
-        // ...otherwise, we actually don't care what the $update_info is, we need to look
-        // at the request directly because we can't use $update_info because it has issues with quotes
-        // Reading POSTed data directly from $_POST causes serialization issues with array data in the POST.
-        // Instead, read raw POST data from the input stream.
-        // @see https://gist.github.com/xcommerce-gists/3440401
-        $raw_post_data = file_get_contents('php://input');
-        $raw_post_array = explode('&', $raw_post_data);
-        $update_info = array();
-        foreach ($raw_post_array as $keyval) {
-            $keyval = explode('=', $keyval);
-            if (count($keyval) === 2) {
-                $update_info[ $keyval[0] ] = urldecode($keyval[1]);
-            }
-        }
-        // read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
-        $req = 'cmd=_notify-validate';
-        $uses_get_magic_quotes = function_exists('get_magic_quotes_gpc') && get_magic_quotes_gpc() === 1
-            ? true
-            : false;
-        foreach ($update_info as $key => $value) {
-            $value = $uses_get_magic_quotes ? urlencode(stripslashes($value)) : urlencode($value);
-            $req .= "&$key=$value";
-        }
-        // HTTP POST the complete, unaltered IPN back to PayPal
-        $response = wp_remote_post(
-            $this->_gateway_url,
-            array(
-                'body'              => $req,
-                'sslverify'         => false,
-                'timeout'           => 60,
-                // make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
-                // plz see: https://github.com/websharks/s2member/issues/610
-                'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
-                'httpversion'       => '1.1'
-            )
-        );
-        // then check the response
-        if (
-            array_key_exists('body', $response)
-            && ! is_wp_error($response)
-            && strcmp($response['body'], "VERIFIED") === 0
-        ) {
-            return true;
-        }
-        // huh, something's wack... the IPN didn't validate. We must have replied to the IPN incorrectly,
-        // or their API must have changed: http://www.paypalobjects.com/en_US/ebook/PP_OrderManagement_IntegrationGuide/ipn.html
-        if ($response instanceof WP_Error) {
-            $error_msg = sprintf(
-                esc_html__('WP Error. Code: "%1$s", Message: "%2$s", Data: "%3$s"', 'event_espresso'),
-                $response->get_error_code(),
-                $response->get_error_message(),
-                print_r($response->get_error_data(), true)
-            );
-        } elseif (is_array($response) && isset($response['body'])) {
-            $error_msg = $response['body'];
-        } else {
-            $error_msg = print_r($response, true);
-        }
-        $payment->set_gateway_response(
-            sprintf(
-                esc_html__("IPN Validation failed! Paypal responded with '%s'", "event_espresso"),
-                $error_msg
-            )
-        );
-        $payment->set_details(array('REQUEST' => $update_info, 'VALIDATION_RESPONSE' => $response));
-        $payment->set_status(EEM_Payment::status_id_failed);
-        // log the results
-        $this->log(
-            array(
-                'url'     => $this->_process_response_url(),
-                'message' => $payment->gateway_response(),
-                'details' => $payment->details(),
-            ),
-            $payment
-        );
-        return false;
-    }
-
-
-    /**
-     * _process_response_url
-     * @return string
-     */
-    protected function _process_response_url()
-    {
-        if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
-            $url = is_ssl() ? 'https://' : 'http://';
-            $url .= EEH_URL::filter_input_server_url('HTTP_HOST');
-            $url .= EEH_URL::filter_input_server_url();
-        } else {
-            $url = 'unknown';
-        }
-        return $url;
-    }
-
-
-    /**
-     * Updates the transaction and line items based on the payment IPN data from PayPal,
-     * like the taxes or shipping
-     *
-     * @param EEI_Payment $payment
-     * @throws \EE_Error
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        $update_info = $payment->details();
-        /** @var EE_Transaction $transaction */
-        $transaction = $payment->transaction();
-        $payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
-        if (! $transaction) {
-            $this->log(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'Payment with ID %d has no related transaction, and so update_txn_based_on_payment couldn\'t be executed properly',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $payment
-            );
-            return;
-        }
-        if (
-            ! is_array($update_info)
-            || ! isset($update_info['mc_shipping'])
-            || ! isset($update_info['tax'])
-        ) {
-            $this->log(
-                array(
-                    'message' => esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'Could not update transaction based on payment because the payment details have not yet been put on the payment. This normally happens during the IPN or returning from PayPal',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    'url'     => $this->_process_response_url(),
-                    'payment' => $payment->model_field_array()
-                ),
-                $payment
-            );
-            return;
-        }
-        if ($payment->status() !== $this->_pay_model->approved_status()) {
-            $this->log(
-                array(
-                    'message' => esc_html__(
-                        'We shouldn\'t update transactions taxes or shipping data from non-approved payments',
-                        'event_espresso'
-                    ),
-                    'url'     => $this->_process_response_url(),
-                    'payment' => $payment->model_field_array()
-                ),
-                $payment
-            );
-            return;
-        }
-        $grand_total_needs_resaving = false;
-        /** @var EE_Line_Item $transaction_total_line_item */
-        $transaction_total_line_item = $transaction->total_line_item();
-
-        // might paypal have changed the taxes?
-        if ($this->_paypal_taxes && $payment_was_itemized) {
-            // note that we're doing this BEFORE adding shipping;
-            // we actually want PayPal's shipping to remain non-taxable
-            $this->_line_item->set_line_items_taxable($transaction_total_line_item, true, 'paypal_shipping');
-            $this->_line_item->set_total_tax_to(
-                $transaction_total_line_item,
-                (float) $update_info['tax'],
-                esc_html__('Taxes', 'event_espresso'),
-                esc_html__('Calculated by Paypal', 'event_espresso'),
-                'paypal_tax'
-            );
-            $grand_total_needs_resaving = true;
-        }
-
-        $shipping_amount = (float) $update_info['mc_shipping'];
-        // might paypal have added shipping?
-        if ($this->_paypal_shipping && $shipping_amount && $payment_was_itemized) {
-            $this->_line_item->add_unrelated_item(
-                $transaction_total_line_item,
-                sprintf(esc_html__('Shipping for transaction %1$s', 'event_espresso'), $transaction->ID()),
-                $shipping_amount,
-                esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
-                1,
-                false,
-                'paypal_shipping_' . $transaction->ID()
-            );
-            $grand_total_needs_resaving = true;
-        }
-
-        if ($grand_total_needs_resaving) {
-            $transaction_total_line_item->save_this_and_descendants_to_txn($transaction->ID());
-            /** @var EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->update_registration_final_prices($transaction);
-        }
-        $this->log(
-            array(
-                'message'                     => esc_html__('Updated transaction related to payment', 'event_espresso'),
-                'url'                         => $this->_process_response_url(),
-                'transaction (updated)'       => $transaction->model_field_array(),
-                'payment (updated)'           => $payment->model_field_array(),
-                'use_paypal_shipping'         => $this->_paypal_shipping,
-                'use_paypal_tax'              => $this->_paypal_taxes,
-                'grand_total_needed_resaving' => $grand_total_needs_resaving,
-            ),
-            $payment
-        );
-    }
+			$redirect_args[ 'shipping_' . $item_num ] = '0';
+			$redirect_args[ 'shipping2_' . $item_num ] = '0';
+		}
+
+		$redirect_args['business'] = $this->_paypal_id;
+		$redirect_args['return'] = $return_url;
+		$redirect_args['cancel_return'] = $cancel_url;
+		$redirect_args['notify_url'] = $notify_url;
+		$redirect_args['cmd'] = '_cart';
+		$redirect_args['upload'] = 1;
+		$redirect_args['currency_code'] = $payment->currency_code();
+		$redirect_args['rm'] = 2;// makes the user return with method=POST
+		if ($this->_image_url) {
+			$redirect_args['image_url'] = $this->_image_url;
+		}
+		$redirect_args['no_shipping'] = $this->_shipping_details;
+		$redirect_args['bn'] = 'EventEspresso_SP';// EE will blow up if you change this
+
+		$redirect_args = apply_filters("FHEE__EEG_Paypal_Standard__set_redirection_info__arguments", $redirect_args, $this);
+
+		$payment->set_redirect_url($this->_gateway_url);
+		$payment->set_redirect_args($redirect_args);
+		// log the results
+		$this->log(
+			array(
+				'message'     => sprintf(
+					esc_html__('PayPal payment request initiated.', 'event_espresso')
+				),
+				'transaction' => $transaction->model_field_array(),
+			),
+			$payment
+		);
+		return $payment;
+	}
+
+
+	/**
+	 * Often used for IPNs. But applies the info in $update_info to the payment.
+	 * What is $update_info? Often the contents of $_REQUEST, but not necessarily. Whatever
+	 * the payment method passes in.
+	 *
+	 * @param array $update_info like $_POST
+	 * @param EEI_Transaction $transaction
+	 * @return \EEI_Payment updated
+	 * @throws \EE_Error, IpnException
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		// verify there's payment data that's been sent
+		if (empty($update_info['payment_status']) || empty($update_info['txn_id'])) {
+			// log the results
+			$this->log(
+				array(
+					'message'     => sprintf(
+						// @codingStandardsIgnoreStart
+						esc_html__('PayPal IPN response is missing critical payment data. This may indicate a PDT request and require your PayPal account settings to be corrected.', 'event_espresso')
+						// @codingStandardsIgnoreEnd
+					),
+					'update_info' => $update_info,
+				),
+				$transaction
+			);
+			// waaaait... is this a PDT request? (see https://developer.paypal.com/docs/classic/products/payment-data-transfer/)
+			// indicated by the "tx" argument? If so, we don't need it. We'll just use the IPN data when it comes
+			if (isset($update_info['tx'])) {
+				return $transaction->last_payment();
+			} else {
+				return null;
+			}
+		}
+		$payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
+		if (! $payment instanceof EEI_Payment) {
+			$payment = $transaction->last_payment();
+		}
+		// ok, then validate the IPN. Even if we've already processed this payment,
+		// let PayPal know we don't want to hear from them anymore!
+		if (! $this->validate_ipn($update_info, $payment)) {
+			return $payment;
+		}
+		// kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
+		// registrations, ticket counts, etc)
+		if (
+			(
+				$update_info['payment_status'] === 'Refunded'
+				|| $update_info['payment_status'] === 'Partially_Refunded'
+			)
+			&& apply_filters('FHEE__EEG_Paypal_Standard__handle_payment_update__kill_refund_request', true)
+		) {
+			throw new EventEspresso\core\exceptions\IpnException(
+				sprintf(
+					esc_html__('Event Espresso does not yet support %1$s IPNs from PayPal', 'event_espresso'),
+					$update_info['payment_status']
+				),
+				EventEspresso\core\exceptions\IpnException::UNSUPPORTED,
+				null,
+				$payment,
+				$update_info
+			);
+		}
+		// ok, well let's process this payment then!
+		switch ($update_info['payment_status']) {
+			case 'Completed':
+				$status = $this->_pay_model->approved_status();
+				$gateway_response = esc_html__('The payment is approved.', 'event_espresso');
+				break;
+
+			case 'Pending':
+				$status = $this->_pay_model->pending_status();
+				$gateway_response = esc_html__(
+					'The payment is in progress. Another message will be sent when payment is approved.',
+					'event_espresso'
+				);
+				break;
+
+			case 'Denied':
+				$status = $this->_pay_model->declined_status();
+				$gateway_response = esc_html__('The payment has been declined.', 'event_espresso');
+				break;
+
+			case 'Expired':
+			case 'Failed':
+				$status = $this->_pay_model->failed_status();
+				$gateway_response = esc_html__('The payment failed for technical reasons or expired.', 'event_espresso');
+				break;
+
+			case 'Refunded':
+			case 'Partially_Refunded':
+				// even though it's a refund, we consider the payment as approved, it just has a negative value
+				$status = $this->_pay_model->approved_status();
+				$gateway_response = esc_html__(
+					'The payment has been refunded. Please update registrations accordingly.',
+					'event_espresso'
+				);
+				break;
+
+			case 'Voided':
+			case 'Reversed':
+			case 'Canceled_Reversal':
+			default:
+				$status = $this->_pay_model->cancelled_status();
+				$gateway_response = esc_html__(
+					'The payment was cancelled, reversed, or voided. Please update registrations accordingly.',
+					'event_espresso'
+				);
+				break;
+		}
+
+		// check if we've already processed this payment
+		if ($payment instanceof EEI_Payment) {
+			// payment exists. if this has the exact same status and amount, don't bother updating. just return
+			if ($payment->status() === $status && (float) $payment->amount() === (float) $update_info['mc_gross']) {
+				// DUPLICATED IPN! don't bother updating transaction
+				throw new IpnException(
+					sprintf(
+						esc_html__(
+							'It appears we have received a duplicate IPN from PayPal for payment %d',
+							'event_espresso'
+						),
+						$payment->ID()
+					),
+					IpnException::DUPLICATE,
+					null,
+					$payment,
+					$update_info
+				);
+			} else {
+				// new payment yippee !!!
+				$payment->set_status($status);
+				$payment->set_amount((float) $update_info['mc_gross']);
+				$payment->set_gateway_response($gateway_response);
+				$payment->set_details($update_info);
+				$payment->set_txn_id_chq_nmbr($update_info['txn_id']);
+				$this->log(
+					array(
+						'message'  => esc_html__(
+							'Updated payment either from IPN or as part of POST from PayPal',
+							'event_espresso'
+						),
+						'url'      => $this->_process_response_url(),
+						'payment'  => $payment->model_field_array(),
+						'IPN_data' => $update_info
+					),
+					$payment
+				);
+			}
+		}
+		do_action('FHEE__EEG_Paypal_Standard__handle_payment_update__payment_processed', $payment, $this);
+		return $payment;
+	}
+
+
+	/**
+	 * Validate the IPN notification.
+	 *
+	 * @param array                  $update_info like $_REQUEST
+	 * @param EE_Payment|EEI_Payment $payment
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function validate_ipn($update_info, $payment)
+	{
+		// allow us to skip validating IPNs with PayPal (useful for testing)
+		if (apply_filters('FHEE__EEG_Paypal_Standard__validate_ipn__skip', false)) {
+			return true;
+		}
+		// ...otherwise, we actually don't care what the $update_info is, we need to look
+		// at the request directly because we can't use $update_info because it has issues with quotes
+		// Reading POSTed data directly from $_POST causes serialization issues with array data in the POST.
+		// Instead, read raw POST data from the input stream.
+		// @see https://gist.github.com/xcommerce-gists/3440401
+		$raw_post_data = file_get_contents('php://input');
+		$raw_post_array = explode('&', $raw_post_data);
+		$update_info = array();
+		foreach ($raw_post_array as $keyval) {
+			$keyval = explode('=', $keyval);
+			if (count($keyval) === 2) {
+				$update_info[ $keyval[0] ] = urldecode($keyval[1]);
+			}
+		}
+		// read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
+		$req = 'cmd=_notify-validate';
+		$uses_get_magic_quotes = function_exists('get_magic_quotes_gpc') && get_magic_quotes_gpc() === 1
+			? true
+			: false;
+		foreach ($update_info as $key => $value) {
+			$value = $uses_get_magic_quotes ? urlencode(stripslashes($value)) : urlencode($value);
+			$req .= "&$key=$value";
+		}
+		// HTTP POST the complete, unaltered IPN back to PayPal
+		$response = wp_remote_post(
+			$this->_gateway_url,
+			array(
+				'body'              => $req,
+				'sslverify'         => false,
+				'timeout'           => 60,
+				// make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
+				// plz see: https://github.com/websharks/s2member/issues/610
+				'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
+				'httpversion'       => '1.1'
+			)
+		);
+		// then check the response
+		if (
+			array_key_exists('body', $response)
+			&& ! is_wp_error($response)
+			&& strcmp($response['body'], "VERIFIED") === 0
+		) {
+			return true;
+		}
+		// huh, something's wack... the IPN didn't validate. We must have replied to the IPN incorrectly,
+		// or their API must have changed: http://www.paypalobjects.com/en_US/ebook/PP_OrderManagement_IntegrationGuide/ipn.html
+		if ($response instanceof WP_Error) {
+			$error_msg = sprintf(
+				esc_html__('WP Error. Code: "%1$s", Message: "%2$s", Data: "%3$s"', 'event_espresso'),
+				$response->get_error_code(),
+				$response->get_error_message(),
+				print_r($response->get_error_data(), true)
+			);
+		} elseif (is_array($response) && isset($response['body'])) {
+			$error_msg = $response['body'];
+		} else {
+			$error_msg = print_r($response, true);
+		}
+		$payment->set_gateway_response(
+			sprintf(
+				esc_html__("IPN Validation failed! Paypal responded with '%s'", "event_espresso"),
+				$error_msg
+			)
+		);
+		$payment->set_details(array('REQUEST' => $update_info, 'VALIDATION_RESPONSE' => $response));
+		$payment->set_status(EEM_Payment::status_id_failed);
+		// log the results
+		$this->log(
+			array(
+				'url'     => $this->_process_response_url(),
+				'message' => $payment->gateway_response(),
+				'details' => $payment->details(),
+			),
+			$payment
+		);
+		return false;
+	}
+
+
+	/**
+	 * _process_response_url
+	 * @return string
+	 */
+	protected function _process_response_url()
+	{
+		if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
+			$url = is_ssl() ? 'https://' : 'http://';
+			$url .= EEH_URL::filter_input_server_url('HTTP_HOST');
+			$url .= EEH_URL::filter_input_server_url();
+		} else {
+			$url = 'unknown';
+		}
+		return $url;
+	}
+
+
+	/**
+	 * Updates the transaction and line items based on the payment IPN data from PayPal,
+	 * like the taxes or shipping
+	 *
+	 * @param EEI_Payment $payment
+	 * @throws \EE_Error
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		$update_info = $payment->details();
+		/** @var EE_Transaction $transaction */
+		$transaction = $payment->transaction();
+		$payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
+		if (! $transaction) {
+			$this->log(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'Payment with ID %d has no related transaction, and so update_txn_based_on_payment couldn\'t be executed properly',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$payment
+			);
+			return;
+		}
+		if (
+			! is_array($update_info)
+			|| ! isset($update_info['mc_shipping'])
+			|| ! isset($update_info['tax'])
+		) {
+			$this->log(
+				array(
+					'message' => esc_html__(
+						// @codingStandardsIgnoreStart
+						'Could not update transaction based on payment because the payment details have not yet been put on the payment. This normally happens during the IPN or returning from PayPal',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					'url'     => $this->_process_response_url(),
+					'payment' => $payment->model_field_array()
+				),
+				$payment
+			);
+			return;
+		}
+		if ($payment->status() !== $this->_pay_model->approved_status()) {
+			$this->log(
+				array(
+					'message' => esc_html__(
+						'We shouldn\'t update transactions taxes or shipping data from non-approved payments',
+						'event_espresso'
+					),
+					'url'     => $this->_process_response_url(),
+					'payment' => $payment->model_field_array()
+				),
+				$payment
+			);
+			return;
+		}
+		$grand_total_needs_resaving = false;
+		/** @var EE_Line_Item $transaction_total_line_item */
+		$transaction_total_line_item = $transaction->total_line_item();
+
+		// might paypal have changed the taxes?
+		if ($this->_paypal_taxes && $payment_was_itemized) {
+			// note that we're doing this BEFORE adding shipping;
+			// we actually want PayPal's shipping to remain non-taxable
+			$this->_line_item->set_line_items_taxable($transaction_total_line_item, true, 'paypal_shipping');
+			$this->_line_item->set_total_tax_to(
+				$transaction_total_line_item,
+				(float) $update_info['tax'],
+				esc_html__('Taxes', 'event_espresso'),
+				esc_html__('Calculated by Paypal', 'event_espresso'),
+				'paypal_tax'
+			);
+			$grand_total_needs_resaving = true;
+		}
+
+		$shipping_amount = (float) $update_info['mc_shipping'];
+		// might paypal have added shipping?
+		if ($this->_paypal_shipping && $shipping_amount && $payment_was_itemized) {
+			$this->_line_item->add_unrelated_item(
+				$transaction_total_line_item,
+				sprintf(esc_html__('Shipping for transaction %1$s', 'event_espresso'), $transaction->ID()),
+				$shipping_amount,
+				esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
+				1,
+				false,
+				'paypal_shipping_' . $transaction->ID()
+			);
+			$grand_total_needs_resaving = true;
+		}
+
+		if ($grand_total_needs_resaving) {
+			$transaction_total_line_item->save_this_and_descendants_to_txn($transaction->ID());
+			/** @var EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->update_registration_final_prices($transaction);
+		}
+		$this->log(
+			array(
+				'message'                     => esc_html__('Updated transaction related to payment', 'event_espresso'),
+				'url'                         => $this->_process_response_url(),
+				'transaction (updated)'       => $transaction->model_field_array(),
+				'payment (updated)'           => $payment->model_field_array(),
+				'use_paypal_shipping'         => $this->_paypal_shipping,
+				'use_paypal_tax'              => $this->_paypal_taxes,
+				'grand_total_needed_resaving' => $grand_total_needs_resaving,
+			),
+			$payment
+		);
+	}
 }