eventespresso / event-espresso-core

caffeinated/modules/event_single_caff/EED_Event_Single_Caff.module.php

Spacing +12 added lines, -12 removed lines

@@ -92,14 +92,14 @@ 
     {
         wp_register_style(
             'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
+            EVENT_SINGLE_CAFF_ASSETS_URL.'eed_event_single_sortable.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_style('eed-event-single-sortable');
         wp_register_script(
             'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
+            EVENT_SINGLE_CAFF_ASSETS_URL.'eed_event_single_sortable.js',
             array('jquery-ui-sortable'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -113,9 +113,9 @@ 
      */
     public static function setDefinitions()
     {
-        if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
-            define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
-            define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+        if ( ! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
+            define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__).'templates/');
+            define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
         }
     }
 
@@ -137,10 +137,10 @@ 
         $config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
 
         $event_single_order_array = array();
-        $event_single_order_array[ $config->display_order_tickets ] = 'tickets';
-        $event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
-        $event_single_order_array[ $config->display_order_event ] = 'event';
-        $event_single_order_array[ $config->display_order_venue ] = 'venue';
+        $event_single_order_array[$config->display_order_tickets] = 'tickets';
+        $event_single_order_array[$config->display_order_datetimes] = 'datetimes';
+        $event_single_order_array[$config->display_order_event] = 'event';
+        $event_single_order_array[$config->display_order_venue] = 'venue';
         // get template parts
         $template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
         // convert to array so that we can add more properties
@@ -151,7 +151,7 @@ 
             'single-sortable-li single-sortable-js'
         );
         EEH_Template::display_template(
-            EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
+            EVENT_SINGLE_CAFF_TEMPLATES_PATH.'admin-event-single-settings.template.php',
             $config
         );
     }
@@ -166,7 +166,7 @@ 
      */
     public static function update_template_settings(EE_Template_Config $CFG, $REQ)
     {
-        if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
+        if ( ! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
             $CFG->EED_Event_Single = new EE_Event_Single_Config();
         }
         $display_order_event = $CFG->EED_Event_Single->display_order_event !== null
@@ -215,7 +215,7 @@ 
     {
         $config_saved = false;
         $template_parts = EED_Event_Single_Caff::getRequest()->getRequestParam('elements');
-        if (! empty($template_parts)) {
+        if ( ! empty($template_parts)) {
             $template_parts = explode(',', trim($template_parts, ','));
             foreach ($template_parts as $key => $template_part) {
                 $template_part = "display_order_$template_part";

Indentation +224 added lines, -224 removed lines

@@ -24,228 +24,228 @@
  */
 class EED_Event_Single_Caff extends EED_Event_Single
 {
-    /**
-     * @return EED_Event_Single_Caff
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::setDefinitions();
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__template_settings',
-            array('EED_Event_Single_Caff', 'load_scripts_styles'),
-            10
-        );
-        add_action(
-            'AHEE__template_settings__template__before_settings_form',
-            array('EED_Event_Single_Caff', 'template_settings_form'),
-            10
-        );
-        add_filter(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            array('EED_Event_Single_Caff', 'update_template_settings'),
-            10,
-            2
-        );
-        // AJAX
-        add_action(
-            'wp_ajax_espresso_update_event_single_order',
-            array('EED_Event_Single_Caff', 'update_event_single_order')
-        );
-        add_action(
-            'wp_ajax_nopriv_espresso_update_event_single_order',
-            array('EED_Event_Single_Caff', 'update_event_single_order')
-        );
-    }
-
-
-    public static function load_scripts_styles()
-    {
-        add_action('admin_enqueue_scripts', array('EED_Event_Single_Caff', 'enqueue_scripts_styles'), 10);
-    }
-
-
-    public static function enqueue_scripts_styles()
-    {
-        wp_register_style(
-            'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('eed-event-single-sortable');
-        wp_register_script(
-            'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
-            array('jquery-ui-sortable'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('eed-event-single-sortable');
-    }
-
-
-    /**
-     * Set constants only if they haven't been set yet.
-     */
-    public static function setDefinitions()
-    {
-        if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
-            define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
-            define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        }
-    }
-
-
-    /**
-     *    template_settings_form
-     *
-     * @access    public
-     * @static
-     * @return    void
-     */
-    public static function template_settings_form()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings;
-        $config = isset($config->EED_Event_Single) && $config->EED_Event_Single instanceof EE_Event_Single_Config
-            ? $config->EED_Event_Single : new EE_Event_Single_Config();
-        $config->use_sortable_display_order = isset($config->use_sortable_display_order)
-            ? $config->use_sortable_display_order : false;
-        $config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
-
-        $event_single_order_array = array();
-        $event_single_order_array[ $config->display_order_tickets ] = 'tickets';
-        $event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
-        $event_single_order_array[ $config->display_order_event ] = 'event';
-        $event_single_order_array[ $config->display_order_venue ] = 'venue';
-        // get template parts
-        $template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
-        // convert to array so that we can add more properties
-        $config = get_object_vars($config);
-        $config['event_single_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
-            'event-single-sortable-js',
-            '',
-            'single-sortable-li single-sortable-js'
-        );
-        EEH_Template::display_template(
-            EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
-            $config
-        );
-    }
-
-
-    /**
-     * update_template_settings
-     *
-     * @param EE_Template_Config $CFG
-     * @param array              $REQ
-     * @return EE_Template_Config
-     */
-    public static function update_template_settings(EE_Template_Config $CFG, $REQ)
-    {
-        if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
-            $CFG->EED_Event_Single = new EE_Event_Single_Config();
-        }
-        $display_order_event = $CFG->EED_Event_Single->display_order_event !== null
-            ? $CFG->EED_Event_Single->display_order_event
-            : EED_Event_Single::EVENT_DETAILS_PRIORITY;
-        $display_order_datetimes = $CFG->EED_Event_Single->display_order_datetimes !== null
-            ? $CFG->EED_Event_Single->display_order_datetimes
-            : EED_Event_Single::EVENT_DATETIMES_PRIORITY;
-        $display_order_tickets = $CFG->EED_Event_Single->display_order_tickets !== null
-            ? $CFG->EED_Event_Single->display_order_tickets
-            : EED_Event_Single::EVENT_TICKETS_PRIORITY;
-        $display_order_venue = $CFG->EED_Event_Single->display_order_venue !== null
-            ? $CFG->EED_Event_Single->display_order_venue
-            : EED_Event_Single::EVENT_VENUES_PRIORITY;
-        $CFG->EED_Event_Single = new EE_Event_Single_Config();
-        $CFG->EED_Event_Single->display_status_banner_single = ! empty($REQ['display_status_banner_single'])
-                                                               && $REQ['display_status_banner_single'];
-        $CFG->EED_Event_Single->display_venue = ! empty($REQ['display_venue']) && $REQ['display_venue'];
-        $CFG->EED_Event_Single->use_sortable_display_order = ! empty($REQ['EED_Events_Single_use_sortable_display_order'])
-            ? absint($REQ['EED_Events_Single_use_sortable_display_order'])
-            : 0;
-        $CFG->EED_Event_Single->display_order_event = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_event
-            : EED_Event_Single::EVENT_DETAILS_PRIORITY;
-        $CFG->EED_Event_Single->display_order_datetimes = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_datetimes
-            : EED_Event_Single::EVENT_DATETIMES_PRIORITY;
-        $CFG->EED_Event_Single->display_order_tickets = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_tickets
-            : EED_Event_Single::EVENT_TICKETS_PRIORITY;
-        $CFG->EED_Event_Single->display_order_venue = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_venue
-            : EED_Event_Single::EVENT_VENUES_PRIORITY;
-        do_action('AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ);
-        return $CFG;
-    }
-
-
-    /**
-     * update_event_single_order
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function update_event_single_order()
-    {
-        $config_saved = false;
-        $template_parts = EED_Event_Single_Caff::getRequest()->getRequestParam('elements');
-        if (! empty($template_parts)) {
-            $template_parts = explode(',', trim($template_parts, ','));
-            foreach ($template_parts as $key => $template_part) {
-                $template_part = "display_order_$template_part";
-                $priority = ($key * 10) + EED_Event_Single::EVENT_DETAILS_PRIORITY;
-                EE_Registry::instance()->CFG->template_settings->EED_Event_Single->{$template_part} = $priority;
-                do_action("AHEE__EED_Event_Single__update_event_single_order__$template_part", $priority);
-            }
-            $config_saved = EE_Registry::instance()->CFG->update_espresso_config(false, false);
-        }
-        if ($config_saved) {
-            EE_Error::add_success(esc_html__('Display Order has been successfully updated.', 'event_espresso'));
-        } else {
-            EE_Error::add_error(
-                esc_html__('Display Order was not updated.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        echo wp_json_encode(EE_Error::get_notices(false));
-        exit();
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 * @return EED_Event_Single_Caff
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::setDefinitions();
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__template_settings',
+			array('EED_Event_Single_Caff', 'load_scripts_styles'),
+			10
+		);
+		add_action(
+			'AHEE__template_settings__template__before_settings_form',
+			array('EED_Event_Single_Caff', 'template_settings_form'),
+			10
+		);
+		add_filter(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			array('EED_Event_Single_Caff', 'update_template_settings'),
+			10,
+			2
+		);
+		// AJAX
+		add_action(
+			'wp_ajax_espresso_update_event_single_order',
+			array('EED_Event_Single_Caff', 'update_event_single_order')
+		);
+		add_action(
+			'wp_ajax_nopriv_espresso_update_event_single_order',
+			array('EED_Event_Single_Caff', 'update_event_single_order')
+		);
+	}
+
+
+	public static function load_scripts_styles()
+	{
+		add_action('admin_enqueue_scripts', array('EED_Event_Single_Caff', 'enqueue_scripts_styles'), 10);
+	}
+
+
+	public static function enqueue_scripts_styles()
+	{
+		wp_register_style(
+			'eed-event-single-sortable',
+			EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('eed-event-single-sortable');
+		wp_register_script(
+			'eed-event-single-sortable',
+			EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
+			array('jquery-ui-sortable'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('eed-event-single-sortable');
+	}
+
+
+	/**
+	 * Set constants only if they haven't been set yet.
+	 */
+	public static function setDefinitions()
+	{
+		if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
+			define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
+			define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		}
+	}
+
+
+	/**
+	 *    template_settings_form
+	 *
+	 * @access    public
+	 * @static
+	 * @return    void
+	 */
+	public static function template_settings_form()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings;
+		$config = isset($config->EED_Event_Single) && $config->EED_Event_Single instanceof EE_Event_Single_Config
+			? $config->EED_Event_Single : new EE_Event_Single_Config();
+		$config->use_sortable_display_order = isset($config->use_sortable_display_order)
+			? $config->use_sortable_display_order : false;
+		$config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
+
+		$event_single_order_array = array();
+		$event_single_order_array[ $config->display_order_tickets ] = 'tickets';
+		$event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
+		$event_single_order_array[ $config->display_order_event ] = 'event';
+		$event_single_order_array[ $config->display_order_venue ] = 'venue';
+		// get template parts
+		$template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
+		// convert to array so that we can add more properties
+		$config = get_object_vars($config);
+		$config['event_single_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
+			'event-single-sortable-js',
+			'',
+			'single-sortable-li single-sortable-js'
+		);
+		EEH_Template::display_template(
+			EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
+			$config
+		);
+	}
+
+
+	/**
+	 * update_template_settings
+	 *
+	 * @param EE_Template_Config $CFG
+	 * @param array              $REQ
+	 * @return EE_Template_Config
+	 */
+	public static function update_template_settings(EE_Template_Config $CFG, $REQ)
+	{
+		if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
+			$CFG->EED_Event_Single = new EE_Event_Single_Config();
+		}
+		$display_order_event = $CFG->EED_Event_Single->display_order_event !== null
+			? $CFG->EED_Event_Single->display_order_event
+			: EED_Event_Single::EVENT_DETAILS_PRIORITY;
+		$display_order_datetimes = $CFG->EED_Event_Single->display_order_datetimes !== null
+			? $CFG->EED_Event_Single->display_order_datetimes
+			: EED_Event_Single::EVENT_DATETIMES_PRIORITY;
+		$display_order_tickets = $CFG->EED_Event_Single->display_order_tickets !== null
+			? $CFG->EED_Event_Single->display_order_tickets
+			: EED_Event_Single::EVENT_TICKETS_PRIORITY;
+		$display_order_venue = $CFG->EED_Event_Single->display_order_venue !== null
+			? $CFG->EED_Event_Single->display_order_venue
+			: EED_Event_Single::EVENT_VENUES_PRIORITY;
+		$CFG->EED_Event_Single = new EE_Event_Single_Config();
+		$CFG->EED_Event_Single->display_status_banner_single = ! empty($REQ['display_status_banner_single'])
+															   && $REQ['display_status_banner_single'];
+		$CFG->EED_Event_Single->display_venue = ! empty($REQ['display_venue']) && $REQ['display_venue'];
+		$CFG->EED_Event_Single->use_sortable_display_order = ! empty($REQ['EED_Events_Single_use_sortable_display_order'])
+			? absint($REQ['EED_Events_Single_use_sortable_display_order'])
+			: 0;
+		$CFG->EED_Event_Single->display_order_event = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_event
+			: EED_Event_Single::EVENT_DETAILS_PRIORITY;
+		$CFG->EED_Event_Single->display_order_datetimes = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_datetimes
+			: EED_Event_Single::EVENT_DATETIMES_PRIORITY;
+		$CFG->EED_Event_Single->display_order_tickets = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_tickets
+			: EED_Event_Single::EVENT_TICKETS_PRIORITY;
+		$CFG->EED_Event_Single->display_order_venue = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_venue
+			: EED_Event_Single::EVENT_VENUES_PRIORITY;
+		do_action('AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ);
+		return $CFG;
+	}
+
+
+	/**
+	 * update_event_single_order
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function update_event_single_order()
+	{
+		$config_saved = false;
+		$template_parts = EED_Event_Single_Caff::getRequest()->getRequestParam('elements');
+		if (! empty($template_parts)) {
+			$template_parts = explode(',', trim($template_parts, ','));
+			foreach ($template_parts as $key => $template_part) {
+				$template_part = "display_order_$template_part";
+				$priority = ($key * 10) + EED_Event_Single::EVENT_DETAILS_PRIORITY;
+				EE_Registry::instance()->CFG->template_settings->EED_Event_Single->{$template_part} = $priority;
+				do_action("AHEE__EED_Event_Single__update_event_single_order__$template_part", $priority);
+			}
+			$config_saved = EE_Registry::instance()->CFG->update_espresso_config(false, false);
+		}
+		if ($config_saved) {
+			EE_Error::add_success(esc_html__('Display Order has been successfully updated.', 'event_espresso'));
+		} else {
+			EE_Error::add_error(
+				esc_html__('Display Order was not updated.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		echo wp_json_encode(EE_Error::get_notices(false));
+		exit();
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 }

caffeinated/modules/events_archive_caff/EED_Events_Archive_Caff.module.php

Spacing +5 added lines, -5 removed lines

@@ -79,12 +79,12 @@ 
      */
     public static function setDefinitions()
     {
-        if (! defined('EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH')) {
+        if ( ! defined('EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH')) {
             define(
                 'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH',
-                str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates/'
+                str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates/'
             );
-            define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+            define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
         }
     }
 
@@ -162,7 +162,7 @@ 
             'archive-sortable-li archive-sortable-js'
         );
         EEH_Template::display_template(
-            EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+            EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH.'admin-event-list-settings.template.php',
             $config
         );
     }
@@ -240,7 +240,7 @@ 
         $config = EE_Registry::instance()->CFG;
         $config_saved = false;
         $template_parts = EED_Events_Archive_Caff::getRequest()->getRequestParam('elements');
-        if (! empty($template_parts)) {
+        if ( ! empty($template_parts)) {
             $template_parts = explode(',', trim($template_parts, ','));
             foreach ($template_parts as $key => $template_part) {
                 $template_part = "display_order_$template_part";

Indentation +249 added lines, -249 removed lines

@@ -13,268 +13,268 @@
  */
 class EED_Events_Archive_Caff extends EED_Events_Archive
 {
-    /**
-     * @return EED_Events_Archive_Caff|EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
+	/**
+	 * @return EED_Events_Archive_Caff|EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
 
 
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
 
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::setDefinitions();
-        add_action(
-            'AHEE__template_settings__template__before_settings_form',
-            array('EED_Events_Archive_Caff', 'template_settings_form'),
-            10
-        );
-        add_filter(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            array('EED_Events_Archive_Caff', 'update_template_settings'),
-            10,
-            2
-        );
-        // AJAX
-        add_action(
-            'wp_ajax_espresso_update_event_archive_order',
-            array('EED_Events_Archive_Caff', 'update_event_archive_order')
-        );
-        add_action(
-            'wp_ajax_nopriv_espresso_update_event_archive_order',
-            array('EED_Events_Archive_Caff', 'update_event_archive_order')
-        );
-    }
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::setDefinitions();
+		add_action(
+			'AHEE__template_settings__template__before_settings_form',
+			array('EED_Events_Archive_Caff', 'template_settings_form'),
+			10
+		);
+		add_filter(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			array('EED_Events_Archive_Caff', 'update_template_settings'),
+			10,
+			2
+		);
+		// AJAX
+		add_action(
+			'wp_ajax_espresso_update_event_archive_order',
+			array('EED_Events_Archive_Caff', 'update_event_archive_order')
+		);
+		add_action(
+			'wp_ajax_nopriv_espresso_update_event_archive_order',
+			array('EED_Events_Archive_Caff', 'update_event_archive_order')
+		);
+	}
 
 
-    /**
-     * run - initial module setup
-     *
-     * @param    WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 * run - initial module setup
+	 *
+	 * @param    WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 
 
-    /**
-     * Conditionally set constants if they haven't been defined yet.
-     */
-    public static function setDefinitions()
-    {
-        if (! defined('EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH')) {
-            define(
-                'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH',
-                str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates/'
-            );
-            define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        }
-    }
+	/**
+	 * Conditionally set constants if they haven't been defined yet.
+	 */
+	public static function setDefinitions()
+	{
+		if (! defined('EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH')) {
+			define(
+				'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH',
+				str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates/'
+			);
+			define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		}
+	}
 
 
-    /**
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function template_settings_form()
-    {
-        /** @var EE_Admin_Page_Loader $admin_page_loader */
-        $admin_page_loader = LoaderFactory::getLoader()->getShared('EE_Admin_Page_Loader');
-        // grab general settings admin page and remove the existing hook callback
-        $gen_set_admin = $admin_page_loader->get_admin_page_object('general_settings');
-        if ($gen_set_admin instanceof General_Settings_Admin_Page) {
-            remove_action(
-                'AHEE__template_settings__template__before_settings_form',
-                array($gen_set_admin, 'template_settings_caff_features'),
-                100
-            );
-        }
-        // first just grab the template settings
-        $config = EE_Registry::instance()->CFG->template_settings;
-        // then if the Event Archive config is valid, use that, else create a new one
-        $config = $config instanceof EE_Template_Config
-                  && $config->EED_Events_Archive instanceof EE_Events_Archive_Config
-            ? $config->EED_Events_Archive
-            : new EE_Events_Archive_Config();
-        $config = apply_filters(
-            'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
-            $config
-        );
-        $config->display_status_banner = isset($config->display_status_banner)
-            ? $config->display_status_banner
-            : 0;
-        $config->display_description = isset($config->display_description)
-            ? $config->display_description
-            : 1;
-        $config->display_ticket_selector = isset($config->display_ticket_selector)
-            ? $config->display_ticket_selector
-            : 0;
-        $config->display_datetimes = isset($config->display_datetimes)
-            ? $config->display_datetimes
-            : 1;
-        $config->display_venue = isset($config->display_venue)
-            ? $config->display_venue
-            : 0;
-        $config->display_expired_events = isset($config->display_expired_events)
-            ? $config->display_expired_events
-            : 0;
-        // display order options
-        $config->use_sortable_display_order = isset($config->use_sortable_display_order)
-            ? $config->use_sortable_display_order
-            : false;
-        $config->display_order_tickets = isset($config->display_order_tickets)
-            ? $config->display_order_tickets
-            : 120;
-        $config->display_order_datetimes = isset($config->display_order_datetimes)
-            ? $config->display_order_datetimes
-            : 110;
-        $config->display_order_event = isset($config->display_order_event)
-            ? $config->display_order_event
-            : 100;
-        $config->display_order_venue = isset($config->display_order_venue)
-            ? $config->display_order_venue
-            : 130;
-        // get template parts
-        $template_parts = EED_Events_Archive::instance()->initialize_template_parts($config);
-        // convert to array so that we can add more properties
-        $config = get_object_vars($config);
-        $config['event_archive_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
-            'event-archive-sortable-js',
-            '',
-            'archive-sortable-li archive-sortable-js'
-        );
-        EEH_Template::display_template(
-            EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
-            $config
-        );
-    }
+	/**
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function template_settings_form()
+	{
+		/** @var EE_Admin_Page_Loader $admin_page_loader */
+		$admin_page_loader = LoaderFactory::getLoader()->getShared('EE_Admin_Page_Loader');
+		// grab general settings admin page and remove the existing hook callback
+		$gen_set_admin = $admin_page_loader->get_admin_page_object('general_settings');
+		if ($gen_set_admin instanceof General_Settings_Admin_Page) {
+			remove_action(
+				'AHEE__template_settings__template__before_settings_form',
+				array($gen_set_admin, 'template_settings_caff_features'),
+				100
+			);
+		}
+		// first just grab the template settings
+		$config = EE_Registry::instance()->CFG->template_settings;
+		// then if the Event Archive config is valid, use that, else create a new one
+		$config = $config instanceof EE_Template_Config
+				  && $config->EED_Events_Archive instanceof EE_Events_Archive_Config
+			? $config->EED_Events_Archive
+			: new EE_Events_Archive_Config();
+		$config = apply_filters(
+			'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
+			$config
+		);
+		$config->display_status_banner = isset($config->display_status_banner)
+			? $config->display_status_banner
+			: 0;
+		$config->display_description = isset($config->display_description)
+			? $config->display_description
+			: 1;
+		$config->display_ticket_selector = isset($config->display_ticket_selector)
+			? $config->display_ticket_selector
+			: 0;
+		$config->display_datetimes = isset($config->display_datetimes)
+			? $config->display_datetimes
+			: 1;
+		$config->display_venue = isset($config->display_venue)
+			? $config->display_venue
+			: 0;
+		$config->display_expired_events = isset($config->display_expired_events)
+			? $config->display_expired_events
+			: 0;
+		// display order options
+		$config->use_sortable_display_order = isset($config->use_sortable_display_order)
+			? $config->use_sortable_display_order
+			: false;
+		$config->display_order_tickets = isset($config->display_order_tickets)
+			? $config->display_order_tickets
+			: 120;
+		$config->display_order_datetimes = isset($config->display_order_datetimes)
+			? $config->display_order_datetimes
+			: 110;
+		$config->display_order_event = isset($config->display_order_event)
+			? $config->display_order_event
+			: 100;
+		$config->display_order_venue = isset($config->display_order_venue)
+			? $config->display_order_venue
+			: 130;
+		// get template parts
+		$template_parts = EED_Events_Archive::instance()->initialize_template_parts($config);
+		// convert to array so that we can add more properties
+		$config = get_object_vars($config);
+		$config['event_archive_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
+			'event-archive-sortable-js',
+			'',
+			'archive-sortable-li archive-sortable-js'
+		);
+		EEH_Template::display_template(
+			EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+			$config
+		);
+	}
 
 
-    /**
-     * @param EE_Template_Config $CFG
-     * @param array              $REQ
-     * @return EE_Template_Config
-     */
-    public static function update_template_settings($CFG, $REQ)
-    {
-        // unless we are resetting the config...
-        if (
-            ! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
-            || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
-        ) {
-            /** @var EE_Events_Archive_Config $config */
-            $config = $CFG->EED_Events_Archive instanceof EE_Events_Archive_Config
-                ? $CFG->EED_Events_Archive
-                : new EE_Events_Archive_Config();
+	/**
+	 * @param EE_Template_Config $CFG
+	 * @param array              $REQ
+	 * @return EE_Template_Config
+	 */
+	public static function update_template_settings($CFG, $REQ)
+	{
+		// unless we are resetting the config...
+		if (
+			! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
+			|| absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
+		) {
+			/** @var EE_Events_Archive_Config $config */
+			$config = $CFG->EED_Events_Archive instanceof EE_Events_Archive_Config
+				? $CFG->EED_Events_Archive
+				: new EE_Events_Archive_Config();
 
-            $config->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
-                ? absint($REQ['EED_Events_Archive_display_status_banner'])
-                : 0;
-            $config->display_description = isset($REQ['EED_Events_Archive_display_description'])
-                ? absint($REQ['EED_Events_Archive_display_description'])
-                : 1;
-            $config->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
-                ? absint($REQ['EED_Events_Archive_display_ticket_selector'])
-                : 0;
-            $config->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes'])
-                ? absint($REQ['EED_Events_Archive_display_datetimes'])
-                : 1;
-            $config->display_venue = isset($REQ['EED_Events_Archive_display_venue'])
-                ? absint($REQ['EED_Events_Archive_display_venue'])
-                : 0;
-            $config->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
-                ? absint($REQ['EED_Events_Archive_display_expired_events'])
-                : 0;
-            $config->use_sortable_display_order = isset($REQ['EED_Events_Archive_use_sortable_display_order'])
-                ? absint($REQ['EED_Events_Archive_use_sortable_display_order'])
-                : 0;
-            $config->display_order_event = $config->display_order_event !== null
-                                           && $config->use_sortable_display_order
-                ? $config->display_order_event
-                : EED_Events_Archive::EVENT_DETAILS_PRIORITY;
-            $config->display_order_datetimes = $config->display_order_datetimes !== null
-                                               && $config->use_sortable_display_order
-                ? $config->display_order_datetimes
-                : EED_Events_Archive::EVENT_DATETIMES_PRIORITY;
-            $config->display_order_tickets = $config->display_order_tickets !== null
-                                             && $config->use_sortable_display_order
-                ? $config->display_order_tickets
-                : EED_Events_Archive::EVENT_TICKETS_PRIORITY;
-            $config->display_order_venue = $config->display_order_venue !== null
-                                           && $config->use_sortable_display_order
-                ? $config->display_order_venue
-                : EED_Events_Archive::EVENT_VENUES_PRIORITY;
-        } else {
-            $config = new EE_Events_Archive_Config();
-        }
+			$config->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
+				? absint($REQ['EED_Events_Archive_display_status_banner'])
+				: 0;
+			$config->display_description = isset($REQ['EED_Events_Archive_display_description'])
+				? absint($REQ['EED_Events_Archive_display_description'])
+				: 1;
+			$config->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
+				? absint($REQ['EED_Events_Archive_display_ticket_selector'])
+				: 0;
+			$config->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes'])
+				? absint($REQ['EED_Events_Archive_display_datetimes'])
+				: 1;
+			$config->display_venue = isset($REQ['EED_Events_Archive_display_venue'])
+				? absint($REQ['EED_Events_Archive_display_venue'])
+				: 0;
+			$config->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
+				? absint($REQ['EED_Events_Archive_display_expired_events'])
+				: 0;
+			$config->use_sortable_display_order = isset($REQ['EED_Events_Archive_use_sortable_display_order'])
+				? absint($REQ['EED_Events_Archive_use_sortable_display_order'])
+				: 0;
+			$config->display_order_event = $config->display_order_event !== null
+										   && $config->use_sortable_display_order
+				? $config->display_order_event
+				: EED_Events_Archive::EVENT_DETAILS_PRIORITY;
+			$config->display_order_datetimes = $config->display_order_datetimes !== null
+											   && $config->use_sortable_display_order
+				? $config->display_order_datetimes
+				: EED_Events_Archive::EVENT_DATETIMES_PRIORITY;
+			$config->display_order_tickets = $config->display_order_tickets !== null
+											 && $config->use_sortable_display_order
+				? $config->display_order_tickets
+				: EED_Events_Archive::EVENT_TICKETS_PRIORITY;
+			$config->display_order_venue = $config->display_order_venue !== null
+										   && $config->use_sortable_display_order
+				? $config->display_order_venue
+				: EED_Events_Archive::EVENT_VENUES_PRIORITY;
+		} else {
+			$config = new EE_Events_Archive_Config();
+		}
 
-        $CFG->EED_Events_Archive = $config;
-        do_action('AHEE__EED_Events_Archive__update_template_settings__after_update', $CFG, $REQ);
-        return $CFG;
-    }
+		$CFG->EED_Events_Archive = $config;
+		do_action('AHEE__EED_Events_Archive__update_template_settings__after_update', $CFG, $REQ);
+		return $CFG;
+	}
 
 
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function update_event_archive_order()
-    {
-        /** @var EE_Config $config */
-        $config = EE_Registry::instance()->CFG;
-        $config_saved = false;
-        $template_parts = EED_Events_Archive_Caff::getRequest()->getRequestParam('elements');
-        if (! empty($template_parts)) {
-            $template_parts = explode(',', trim($template_parts, ','));
-            foreach ($template_parts as $key => $template_part) {
-                $template_part = "display_order_$template_part";
-                $priority = ($key * 10) + EED_Events_Archive::EVENT_DETAILS_PRIORITY;
-                if (
-                    $config->template_settings->EED_Events_Archive instanceof EE_Events_Archive_Config
-                    && property_exists(
-                        $config->template_settings->EED_Events_Archive,
-                        $template_part
-                    )
-                ) {
-                    $config->template_settings->EED_Events_Archive->{$template_part} = $priority;
-                }
-                do_action("AHEE__EED_Events_Archive__update_event_archive_order__$template_part", $priority);
-            }
-            $config_saved = $config->update_espresso_config(false, false);
-        }
-        if ($config_saved) {
-            EE_Error::add_success(esc_html__('Display Order has been successfully updated.', 'event_espresso'));
-        } else {
-            EE_Error::add_error(
-                esc_html__('Display Order was not updated.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        echo wp_json_encode(EE_Error::get_notices(false));
-        exit();
-    }
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function update_event_archive_order()
+	{
+		/** @var EE_Config $config */
+		$config = EE_Registry::instance()->CFG;
+		$config_saved = false;
+		$template_parts = EED_Events_Archive_Caff::getRequest()->getRequestParam('elements');
+		if (! empty($template_parts)) {
+			$template_parts = explode(',', trim($template_parts, ','));
+			foreach ($template_parts as $key => $template_part) {
+				$template_part = "display_order_$template_part";
+				$priority = ($key * 10) + EED_Events_Archive::EVENT_DETAILS_PRIORITY;
+				if (
+					$config->template_settings->EED_Events_Archive instanceof EE_Events_Archive_Config
+					&& property_exists(
+						$config->template_settings->EED_Events_Archive,
+						$template_part
+					)
+				) {
+					$config->template_settings->EED_Events_Archive->{$template_part} = $priority;
+				}
+				do_action("AHEE__EED_Events_Archive__update_event_archive_order__$template_part", $priority);
+			}
+			$config_saved = $config->update_espresso_config(false, false);
+		}
+		if ($config_saved) {
+			EE_Error::add_success(esc_html__('Display Order has been successfully updated.', 'event_espresso'));
+		} else {
+			EE_Error::add_error(
+				esc_html__('Display Order was not updated.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		echo wp_json_encode(EE_Error::get_notices(false));
+		exit();
+	}
 }

caffeinated/modules/recaptcha/EED_Recaptcha.module.php

Spacing +7 added lines, -7 removed lines

@@ -133,7 +133,7 @@ 
         }
         define(
             'RECAPTCHA_BASE_PATH',
-            rtrim(str_replace(array('\\', '/'), '/', plugin_dir_path(__FILE__)), '/') . '/'
+            rtrim(str_replace(array('\\', '/'), '/', plugin_dir_path(__FILE__)), '/').'/'
         );
         define('RECAPTCHA_BASE_URL', plugin_dir_url(__FILE__));
     }
@@ -187,14 +187,14 @@ 
     {
         wp_register_script(
             'espresso_recaptcha',
-            RECAPTCHA_BASE_URL . 'scripts/espresso_recaptcha.js',
+            RECAPTCHA_BASE_URL.'scripts/espresso_recaptcha.js',
             array('single_page_checkout'),
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'google_recaptcha',
-            'https://www.google.com/recaptcha/api.js?hl=' . EED_Recaptcha::$config->recaptcha_language,
+            'https://www.google.com/recaptcha/api.js?hl='.EED_Recaptcha::$config->recaptcha_language,
             array('espresso_recaptcha'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -253,7 +253,7 @@ 
         if (EED_Recaptcha::useRecaptcha() && ! EED_Recaptcha::$_not_a_robot) {
             // only display if they have NOT passed the test yet
             EEH_Template::display_template(
-                RECAPTCHA_BASE_PATH . '/templates/recaptcha.template.php',
+                RECAPTCHA_BASE_PATH.'/templates/recaptcha.template.php',
                 array(
                     'recaptcha_publickey' => EED_Recaptcha::$config->recaptcha_publickey,
                     'recaptcha_theme'     => EED_Recaptcha::$config->recaptcha_theme,
@@ -298,7 +298,7 @@ 
         $recaptcha_passed = filter_var($recaptcha_passed, FILTER_VALIDATE_BOOLEAN);
         // verify recaptcha
         EED_Recaptcha::_get_recaptcha_response();
-        if (! $recaptcha_passed && EED_Recaptcha::$_recaptcha_response) {
+        if ( ! $recaptcha_passed && EED_Recaptcha::$_recaptcha_response) {
             $recaptcha_passed = EED_Recaptcha::_process_recaptcha_response();
             EE_Registry::instance()->SSN->set_session_data(array('recaptcha_passed' => $recaptcha_passed));
         }
@@ -375,8 +375,8 @@ 
     private static function _process_recaptcha_response()
     {
         // verify library is loaded
-        if (! class_exists('\ReCaptcha\ReCaptcha')) {
-            require_once RECAPTCHA_BASE_PATH . '/autoload.php';
+        if ( ! class_exists('\ReCaptcha\ReCaptcha')) {
+            require_once RECAPTCHA_BASE_PATH.'/autoload.php';
         }
         // The response from reCAPTCHA
         EED_Recaptcha::_get_recaptcha_response();

Indentation +378 added lines, -378 removed lines

@@ -17,382 +17,382 @@
  */
 class EED_Recaptcha extends EED_Module
 {
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private static $config;
-
-    /**
-     * @type bool $_not_a_robot
-     */
-    private static $_not_a_robot;
-
-    /**
-     * @type string $_recaptcha_response
-     */
-    private static $_recaptcha_response;
-
-
-    /**
-     * @return EED_Module|EED_Recaptcha
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function set_hooks()
-    {
-        EED_Recaptcha::$config = EE_Registry::instance()->CFG->registration;
-        // use_captcha ?
-        if (
-            EED_Recaptcha::useRecaptcha()
-            && EED_Recaptcha::notPaymentOptionsRevisit()
-        ) {
-            EED_Recaptcha::set_definitions();
-            EED_Recaptcha::enqueue_styles_and_scripts();
-            add_action('wp', array('EED_Recaptcha', 'set_late_hooks'), 1, 0);
-            add_action(
-                'AHEE__before_spco_whats_next_buttons',
-                array('EED_Recaptcha', 'display_recaptcha'),
-                10,
-                0
-            );
-            add_filter(
-                'FHEE__EED_Single_Page_Checkout__init___continue_reg',
-                array('EED_Recaptcha', 'not_a_robot')
-            );
-            add_filter(
-                'FHEE__EE_SPCO_Reg_Step__set_completed___completed',
-                array('EED_Recaptcha', 'not_a_robot')
-            );
-            add_filter(
-                'FHEE__EE_SPCO_JSON_Response___toString__JSON_response',
-                array('EED_Recaptcha', 'recaptcha_response')
-            );
-            add_filter(
-                'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-                array('EED_Recaptcha', 'bypass_recaptcha_for_spco_load_payment_method')
-            );
-        }
-    }
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Recaptcha::$config = EE_Registry::instance()->CFG->registration;
-        EED_Recaptcha::set_definitions();
-        // use_captcha ?
-        if (
-            EED_Recaptcha::useRecaptcha()
-            && EED_Recaptcha::notPaymentOptionsRevisit()
-            && EED_Recaptcha::getRequest()->getRequestParam('step', '') !== ''
-        ) {
-            EED_Recaptcha::enqueue_styles_and_scripts();
-            add_filter(
-                'FHEE__EED_Single_Page_Checkout__init___continue_reg',
-                array('EED_Recaptcha', 'not_a_robot')
-            );
-            add_filter(
-                'FHEE__EE_SPCO_Reg_Step__set_completed___completed',
-                array('EED_Recaptcha', 'not_a_robot')
-            );
-            add_filter(
-                'FHEE__EE_SPCO_JSON_Response___toString__JSON_response',
-                array('EED_Recaptcha', 'recaptcha_response')
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        if (is_user_logged_in()) {
-            EED_Recaptcha::$_not_a_robot = true;
-        }
-        define(
-            'RECAPTCHA_BASE_PATH',
-            rtrim(str_replace(array('\\', '/'), '/', plugin_dir_path(__FILE__)), '/') . '/'
-        );
-        define('RECAPTCHA_BASE_URL', plugin_dir_url(__FILE__));
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function set_late_hooks()
-    {
-        add_filter(
-            'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
-            array('EED_Recaptcha', 'not_a_robot')
-        );
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public static function useRecaptcha()
-    {
-        return EED_Recaptcha::$config->use_captcha
-               && EED_Recaptcha::$config->recaptcha_theme !== 'invisible';
-    }
-
-
-    /**
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function notPaymentOptionsRevisit()
-    {
-        $request = EED_Recaptcha::getRequest();
-        return ! (
-            $request->getRequestParam('step', '') === 'payment_options'
-            && $request->getRequestParam('revisit', false, 'bool') === true
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function enqueue_styles_and_scripts()
-    {
-        wp_register_script(
-            'espresso_recaptcha',
-            RECAPTCHA_BASE_URL . 'scripts/espresso_recaptcha.js',
-            array('single_page_checkout'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'google_recaptcha',
-            'https://www.google.com/recaptcha/api.js?hl=' . EED_Recaptcha::$config->recaptcha_language,
-            array('espresso_recaptcha'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        EE_Registry::$i18n_js_strings['no_SPCO_error'] = __(
-            'It appears the Single Page Checkout javascript was not loaded properly! Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['no_recaptcha_error'] = __(
-            'There appears to be a problem with the reCAPTCHA configuration! Please check the admin settings or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['recaptcha_fail'] = __(
-            'Please complete the anti-spam test before proceeding.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * @param WP $WP
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function not_a_robot()
-    {
-        return is_bool(EED_Recaptcha::$_not_a_robot)
-            ? EED_Recaptcha::$_not_a_robot
-            : EED_Recaptcha::recaptcha_passed();
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function display_recaptcha()
-    {
-        // logged in means you have already passed a turing test of sorts
-        if (is_user_logged_in()) {
-            return;
-        }
-        // don't display if not using recaptcha or user is logged in
-        if (EED_Recaptcha::useRecaptcha() && ! EED_Recaptcha::$_not_a_robot) {
-            // only display if they have NOT passed the test yet
-            EEH_Template::display_template(
-                RECAPTCHA_BASE_PATH . '/templates/recaptcha.template.php',
-                array(
-                    'recaptcha_publickey' => EED_Recaptcha::$config->recaptcha_publickey,
-                    'recaptcha_theme'     => EED_Recaptcha::$config->recaptcha_theme,
-                    'recaptcha_type'      => EED_Recaptcha::$config->recaptcha_type,
-                )
-            );
-            wp_enqueue_script('google_recaptcha');
-        }
-    }
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function bypass_recaptcha_for_spco_load_payment_method()
-    {
-        return array(
-            'EESID'  => EE_Registry::instance()->SSN->id(),
-            'step'   => 'payment_options',
-            'action' => 'switch_spco_billing_form',
-        );
-    }
-
-
-    /**
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function recaptcha_passed()
-    {
-        // logged in means you have already passed a turing test of sorts
-        if (is_user_logged_in() || EED_Recaptcha::_bypass_recaptcha()) {
-            return true;
-        }
-        // was test already passed?
-        $recaptcha_passed = EE_Registry::instance()->SSN->get_session_data('recaptcha_passed');
-        $recaptcha_passed = filter_var($recaptcha_passed, FILTER_VALIDATE_BOOLEAN);
-        // verify recaptcha
-        EED_Recaptcha::_get_recaptcha_response();
-        if (! $recaptcha_passed && EED_Recaptcha::$_recaptcha_response) {
-            $recaptcha_passed = EED_Recaptcha::_process_recaptcha_response();
-            EE_Registry::instance()->SSN->set_session_data(array('recaptcha_passed' => $recaptcha_passed));
-        }
-        EED_Recaptcha::$_not_a_robot = $recaptcha_passed;
-        return $recaptcha_passed;
-    }
-
-
-    /**
-     * @param array $recaptcha_response
-     * @return array
-     */
-    public static function recaptcha_response($recaptcha_response = array())
-    {
-        if (EED_Recaptcha::_bypass_recaptcha()) {
-            $recaptcha_response['bypass_recaptcha'] = true;
-            $recaptcha_response['recaptcha_passed'] = true;
-        } else {
-            $recaptcha_response['recaptcha_passed'] = EED_Recaptcha::$_not_a_robot;
-        }
-        return $recaptcha_response;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    private static function _bypass_recaptcha()
-    {
-        // an array of key value pairs that must match exactly with the incoming request,
-        // in order to bypass recaptcha for the current request ONLY
-        $bypass_request_params_array = (array) apply_filters(
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-            array()
-        );
-        // does $bypass_request_params_array have any values ?
-        if (empty($bypass_request_params_array)) {
-            return false;
-        }
-        $request = EED_Recaptcha::getRequest();
-        // initially set bypass to TRUE
-        $bypass_recaptcha = true;
-        foreach ($bypass_request_params_array as $key => $value) {
-            // if $key is not found or value doesn't match exactly, then toggle bypass to FALSE,
-            // otherwise carry over it's value. This way, one missed setting results in no bypass
-            $bypass_recaptcha = $request->getRequestParam($key) === $value
-                ? $bypass_recaptcha
-                : false;
-        }
-        return $bypass_recaptcha;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    private static function _get_recaptcha_response()
-    {
-        EED_Recaptcha::$_recaptcha_response = EED_Recaptcha::getRequest()->getRequestParam(
-            'g-recaptcha-response'
-        );
-    }
-
-
-    /**
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    private static function _process_recaptcha_response()
-    {
-        // verify library is loaded
-        if (! class_exists('\ReCaptcha\ReCaptcha')) {
-            require_once RECAPTCHA_BASE_PATH . '/autoload.php';
-        }
-        // The response from reCAPTCHA
-        EED_Recaptcha::_get_recaptcha_response();
-        $recaptcha_response = EED_Recaptcha::$_recaptcha_response;
-        // Was there a reCAPTCHA response?
-        if ($recaptcha_response) {
-            // if allow_url_fopen is Off, then set a different request method
-            $request_method = ! ini_get('allow_url_fopen') ? new SocketPost() : null;
-            $recaptcha = new ReCaptcha(
-                EED_Recaptcha::$config->recaptcha_privatekey,
-                $request_method
-            );
-            $recaptcha_response = $recaptcha->verify(
-                EED_Recaptcha::$_recaptcha_response,
-                EED_Recaptcha::getRequest()->getServerParam('REMOTE_ADDR')
-            );
-        }
-        return $recaptcha_response instanceof Response && $recaptcha_response->isSuccess();
-    }
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private static $config;
+
+	/**
+	 * @type bool $_not_a_robot
+	 */
+	private static $_not_a_robot;
+
+	/**
+	 * @type string $_recaptcha_response
+	 */
+	private static $_recaptcha_response;
+
+
+	/**
+	 * @return EED_Module|EED_Recaptcha
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function set_hooks()
+	{
+		EED_Recaptcha::$config = EE_Registry::instance()->CFG->registration;
+		// use_captcha ?
+		if (
+			EED_Recaptcha::useRecaptcha()
+			&& EED_Recaptcha::notPaymentOptionsRevisit()
+		) {
+			EED_Recaptcha::set_definitions();
+			EED_Recaptcha::enqueue_styles_and_scripts();
+			add_action('wp', array('EED_Recaptcha', 'set_late_hooks'), 1, 0);
+			add_action(
+				'AHEE__before_spco_whats_next_buttons',
+				array('EED_Recaptcha', 'display_recaptcha'),
+				10,
+				0
+			);
+			add_filter(
+				'FHEE__EED_Single_Page_Checkout__init___continue_reg',
+				array('EED_Recaptcha', 'not_a_robot')
+			);
+			add_filter(
+				'FHEE__EE_SPCO_Reg_Step__set_completed___completed',
+				array('EED_Recaptcha', 'not_a_robot')
+			);
+			add_filter(
+				'FHEE__EE_SPCO_JSON_Response___toString__JSON_response',
+				array('EED_Recaptcha', 'recaptcha_response')
+			);
+			add_filter(
+				'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
+				array('EED_Recaptcha', 'bypass_recaptcha_for_spco_load_payment_method')
+			);
+		}
+	}
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Recaptcha::$config = EE_Registry::instance()->CFG->registration;
+		EED_Recaptcha::set_definitions();
+		// use_captcha ?
+		if (
+			EED_Recaptcha::useRecaptcha()
+			&& EED_Recaptcha::notPaymentOptionsRevisit()
+			&& EED_Recaptcha::getRequest()->getRequestParam('step', '') !== ''
+		) {
+			EED_Recaptcha::enqueue_styles_and_scripts();
+			add_filter(
+				'FHEE__EED_Single_Page_Checkout__init___continue_reg',
+				array('EED_Recaptcha', 'not_a_robot')
+			);
+			add_filter(
+				'FHEE__EE_SPCO_Reg_Step__set_completed___completed',
+				array('EED_Recaptcha', 'not_a_robot')
+			);
+			add_filter(
+				'FHEE__EE_SPCO_JSON_Response___toString__JSON_response',
+				array('EED_Recaptcha', 'recaptcha_response')
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		if (is_user_logged_in()) {
+			EED_Recaptcha::$_not_a_robot = true;
+		}
+		define(
+			'RECAPTCHA_BASE_PATH',
+			rtrim(str_replace(array('\\', '/'), '/', plugin_dir_path(__FILE__)), '/') . '/'
+		);
+		define('RECAPTCHA_BASE_URL', plugin_dir_url(__FILE__));
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function set_late_hooks()
+	{
+		add_filter(
+			'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
+			array('EED_Recaptcha', 'not_a_robot')
+		);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public static function useRecaptcha()
+	{
+		return EED_Recaptcha::$config->use_captcha
+			   && EED_Recaptcha::$config->recaptcha_theme !== 'invisible';
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function notPaymentOptionsRevisit()
+	{
+		$request = EED_Recaptcha::getRequest();
+		return ! (
+			$request->getRequestParam('step', '') === 'payment_options'
+			&& $request->getRequestParam('revisit', false, 'bool') === true
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function enqueue_styles_and_scripts()
+	{
+		wp_register_script(
+			'espresso_recaptcha',
+			RECAPTCHA_BASE_URL . 'scripts/espresso_recaptcha.js',
+			array('single_page_checkout'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'google_recaptcha',
+			'https://www.google.com/recaptcha/api.js?hl=' . EED_Recaptcha::$config->recaptcha_language,
+			array('espresso_recaptcha'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		EE_Registry::$i18n_js_strings['no_SPCO_error'] = __(
+			'It appears the Single Page Checkout javascript was not loaded properly! Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['no_recaptcha_error'] = __(
+			'There appears to be a problem with the reCAPTCHA configuration! Please check the admin settings or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['recaptcha_fail'] = __(
+			'Please complete the anti-spam test before proceeding.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * @param WP $WP
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function not_a_robot()
+	{
+		return is_bool(EED_Recaptcha::$_not_a_robot)
+			? EED_Recaptcha::$_not_a_robot
+			: EED_Recaptcha::recaptcha_passed();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function display_recaptcha()
+	{
+		// logged in means you have already passed a turing test of sorts
+		if (is_user_logged_in()) {
+			return;
+		}
+		// don't display if not using recaptcha or user is logged in
+		if (EED_Recaptcha::useRecaptcha() && ! EED_Recaptcha::$_not_a_robot) {
+			// only display if they have NOT passed the test yet
+			EEH_Template::display_template(
+				RECAPTCHA_BASE_PATH . '/templates/recaptcha.template.php',
+				array(
+					'recaptcha_publickey' => EED_Recaptcha::$config->recaptcha_publickey,
+					'recaptcha_theme'     => EED_Recaptcha::$config->recaptcha_theme,
+					'recaptcha_type'      => EED_Recaptcha::$config->recaptcha_type,
+				)
+			);
+			wp_enqueue_script('google_recaptcha');
+		}
+	}
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function bypass_recaptcha_for_spco_load_payment_method()
+	{
+		return array(
+			'EESID'  => EE_Registry::instance()->SSN->id(),
+			'step'   => 'payment_options',
+			'action' => 'switch_spco_billing_form',
+		);
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function recaptcha_passed()
+	{
+		// logged in means you have already passed a turing test of sorts
+		if (is_user_logged_in() || EED_Recaptcha::_bypass_recaptcha()) {
+			return true;
+		}
+		// was test already passed?
+		$recaptcha_passed = EE_Registry::instance()->SSN->get_session_data('recaptcha_passed');
+		$recaptcha_passed = filter_var($recaptcha_passed, FILTER_VALIDATE_BOOLEAN);
+		// verify recaptcha
+		EED_Recaptcha::_get_recaptcha_response();
+		if (! $recaptcha_passed && EED_Recaptcha::$_recaptcha_response) {
+			$recaptcha_passed = EED_Recaptcha::_process_recaptcha_response();
+			EE_Registry::instance()->SSN->set_session_data(array('recaptcha_passed' => $recaptcha_passed));
+		}
+		EED_Recaptcha::$_not_a_robot = $recaptcha_passed;
+		return $recaptcha_passed;
+	}
+
+
+	/**
+	 * @param array $recaptcha_response
+	 * @return array
+	 */
+	public static function recaptcha_response($recaptcha_response = array())
+	{
+		if (EED_Recaptcha::_bypass_recaptcha()) {
+			$recaptcha_response['bypass_recaptcha'] = true;
+			$recaptcha_response['recaptcha_passed'] = true;
+		} else {
+			$recaptcha_response['recaptcha_passed'] = EED_Recaptcha::$_not_a_robot;
+		}
+		return $recaptcha_response;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	private static function _bypass_recaptcha()
+	{
+		// an array of key value pairs that must match exactly with the incoming request,
+		// in order to bypass recaptcha for the current request ONLY
+		$bypass_request_params_array = (array) apply_filters(
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
+			array()
+		);
+		// does $bypass_request_params_array have any values ?
+		if (empty($bypass_request_params_array)) {
+			return false;
+		}
+		$request = EED_Recaptcha::getRequest();
+		// initially set bypass to TRUE
+		$bypass_recaptcha = true;
+		foreach ($bypass_request_params_array as $key => $value) {
+			// if $key is not found or value doesn't match exactly, then toggle bypass to FALSE,
+			// otherwise carry over it's value. This way, one missed setting results in no bypass
+			$bypass_recaptcha = $request->getRequestParam($key) === $value
+				? $bypass_recaptcha
+				: false;
+		}
+		return $bypass_recaptcha;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	private static function _get_recaptcha_response()
+	{
+		EED_Recaptcha::$_recaptcha_response = EED_Recaptcha::getRequest()->getRequestParam(
+			'g-recaptcha-response'
+		);
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	private static function _process_recaptcha_response()
+	{
+		// verify library is loaded
+		if (! class_exists('\ReCaptcha\ReCaptcha')) {
+			require_once RECAPTCHA_BASE_PATH . '/autoload.php';
+		}
+		// The response from reCAPTCHA
+		EED_Recaptcha::_get_recaptcha_response();
+		$recaptcha_response = EED_Recaptcha::$_recaptcha_response;
+		// Was there a reCAPTCHA response?
+		if ($recaptcha_response) {
+			// if allow_url_fopen is Off, then set a different request method
+			$request_method = ! ini_get('allow_url_fopen') ? new SocketPost() : null;
+			$recaptcha = new ReCaptcha(
+				EED_Recaptcha::$config->recaptcha_privatekey,
+				$request_method
+			);
+			$recaptcha_response = $recaptcha->verify(
+				EED_Recaptcha::$_recaptcha_response,
+				EED_Recaptcha::getRequest()->getServerParam('REMOTE_ADDR')
+			);
+		}
+		return $recaptcha_response instanceof Response && $recaptcha_response->isSuccess();
+	}
 }

modules/gateways/Invoice/lib/invoice_functions.php

Spacing +2 added lines, -2 removed lines

@@ -15,7 +15,7 @@ 
 {
     $files = [];
     // read our template dir and build an array of files
-    $directory_handle = opendir(dirname($class_file) . '/lib/templates/css/');
+    $directory_handle = opendir(dirname($class_file).'/lib/templates/css/');
     //if we managed to open the directory
     if ($directory_handle) {
         /** @var RequestInterface $request */
@@ -34,7 +34,7 @@ 
         while (false !== ($fname = readdir($directory_handle))) {
             // if the file is not this file, and does not start with a '.' or '..',
             // then store it for later display
-            if (! in_array($fname, $skip, true)) {
+            if ( ! in_array($fname, $skip, true)) {
                 $files[] = $fname;
             }
         }

Indentation +33 added lines, -33 removed lines

@@ -13,36 +13,36 @@ 
  */
 function espresso_invoice_template_files($class_file)
 {
-    $files = [];
-    // read our template dir and build an array of files
-    $directory_handle = opendir(dirname($class_file) . '/lib/templates/css/');
-    //if we managed to open the directory
-    if ($directory_handle) {
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $skip = [
-            '.',
-            '..',
-            '.DS_Store',
-            '.svn',
-            'images',
-            'index.php',
-            'print',
-            basename($request->getServerParam('PHP_SELF')),
-        ];
-        // loop through all of the files
-        while (false !== ($fname = readdir($directory_handle))) {
-            // if the file is not this file, and does not start with a '.' or '..',
-            // then store it for later display
-            if (! in_array($fname, $skip, true)) {
-                $files[] = $fname;
-            }
-        }
-        // close the directory
-        closedir($directory_handle);
-    }
+	$files = [];
+	// read our template dir and build an array of files
+	$directory_handle = opendir(dirname($class_file) . '/lib/templates/css/');
+	//if we managed to open the directory
+	if ($directory_handle) {
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$skip = [
+			'.',
+			'..',
+			'.DS_Store',
+			'.svn',
+			'images',
+			'index.php',
+			'print',
+			basename($request->getServerParam('PHP_SELF')),
+		];
+		// loop through all of the files
+		while (false !== ($fname = readdir($directory_handle))) {
+			// if the file is not this file, and does not start with a '.' or '..',
+			// then store it for later display
+			if (! in_array($fname, $skip, true)) {
+				$files[] = $fname;
+			}
+		}
+		// close the directory
+		closedir($directory_handle);
+	}
 
-    return $files;
+	return $files;
 }
 
 
@@ -56,8 +56,8 @@ 
  */
 function espresso_invoice_is_selected($input_item, $selected = '')
 {
-    if ($input_item === $selected) {
-        return 'selected';
-    }
-    return '';
+	if ($input_item === $selected) {
+		return 'selected';
+	}
+	return '';
 }
\ No newline at end of file

core/services/encryption/EncryptionMethodInterface.php

Indentation +42 added lines, -42 removed lines

@@ -12,46 +12,46 @@
  */
 interface EncryptionMethodInterface
 {
-    /**
-     * returns true if the encryption method is cryptographically secure
-     *
-     * @return bool
-     */
-    public function isCryptographicallySecure();
-
-
-    /**
-     * returns true if the method can be used on the current server
-     *
-     * @return bool
-     */
-    public function canUse();
-
-
-    /**
-     * returns a message explaining why the encryption method in question can or can not be used
-     *
-     * @return string
-     */
-    public function canUseNotice();
-
-
-    /**
-     * encrypts data
-     *
-     * @param string $text_to_encrypt           - the text to be encrypted
-     * @param string $encryption_key_identifier - name of the encryption key to use
-     * @return string
-     */
-    public function encrypt($text_to_encrypt, $encryption_key_identifier = '');
-
-
-    /**
-     * decrypts data
-     *
-     * @param string $encrypted_text            - the text to be decrypted
-     * @param string $encryption_key_identifier - name of the encryption key to use
-     * @return string
-     */
-    public function decrypt($encrypted_text, $encryption_key_identifier = '');
+	/**
+	 * returns true if the encryption method is cryptographically secure
+	 *
+	 * @return bool
+	 */
+	public function isCryptographicallySecure();
+
+
+	/**
+	 * returns true if the method can be used on the current server
+	 *
+	 * @return bool
+	 */
+	public function canUse();
+
+
+	/**
+	 * returns a message explaining why the encryption method in question can or can not be used
+	 *
+	 * @return string
+	 */
+	public function canUseNotice();
+
+
+	/**
+	 * encrypts data
+	 *
+	 * @param string $text_to_encrypt           - the text to be encrypted
+	 * @param string $encryption_key_identifier - name of the encryption key to use
+	 * @return string
+	 */
+	public function encrypt($text_to_encrypt, $encryption_key_identifier = '');
+
+
+	/**
+	 * decrypts data
+	 *
+	 * @param string $encrypted_text            - the text to be decrypted
+	 * @param string $encryption_key_identifier - name of the encryption key to use
+	 * @return string
+	 */
+	public function decrypt($encrypted_text, $encryption_key_identifier = '');
 }

core/services/encryption/openssl/OpenSSL.php

Spacing +2 added lines, -2 removed lines

@@ -120,7 +120,7 @@ 
      */
     public function canUseNotice()
     {
-        if (! $this->openssl_installed) {
+        if ( ! $this->openssl_installed) {
             return esc_html__(
                 'The PHP openssl server extension is required to use Openssl encryption. Please contact your hosting provider regarding this issue.',
                 'event_espresso'
@@ -219,7 +219,7 @@ 
      */
     protected function getHashAlgorithm()
     {
-        if (! $this->hash_algorithm) {
+        if ( ! $this->hash_algorithm) {
             // get installed hashing algorithms
             $hash_algorithms = hash_algos();
             // filter array for "sha" algorithms

Indentation +262 added lines, -262 removed lines

@@ -17,266 +17,266 @@
  */
 abstract class OpenSSL implements EncryptionMethodInterface
 {
-    /**
-     * the default OPENSSL digest method to use
-     */
-    const DEFAULT_DIGEST_METHOD = 'sha512';
-
-    /**
-     * separates the encrypted text from the initialization vector
-     */
-    const IV_DELIMITER = ':iv:';
-
-    /**
-     * @var Base64Encoder
-     */
-    protected $base64_encoder;
-
-    /**
-     * @var CipherMethod
-     */
-    protected $cipher_method;
-
-    /**
-     * @var array $digest_methods
-     */
-    private $digest_methods = [];
-
-    /**
-     * @var EncryptionKeyManagerInterface
-     */
-    protected $encryption_key_manager;
-
-    /**
-     * @var boolean
-     */
-    private $openssl_installed;
-
-    /**
-     * @var string
-     */
-    private $min_php_version;
-
-    /**
-     * @var string
-     */
-    private $hash_algorithm;
-
-
-    /**
-     * To use custom a cipher method and/or encryption keys:
-     *  - extend this class
-     *  - configure a new CipherMethod / EncryptionKeyManager in the constructor
-     *  - pass those to this constructor, like so:
-     *
-     *      public function __construct(Base64Encoder $base64_encoder) {
-     *          parent::__construct(
-     *              $base64_encoder,
-     *              new CipherMethod(CIPHER_METHOD, CIPHER_METHOD_OPTION_NAME)
-     *              new EncryptionKeyManager(CUSTOM_KEY_ID, CUSTOM_KEYS_OPTION_NAME)
-     *          );
-     *      }
-     *
-     * @param Base64Encoder                      $base64_encoder
-     * @param CipherMethod                       $cipher_method
-     * @param EncryptionKeyManagerInterface|null $encryption_key_manager
-     * @param string                             $min_php_version
-     */
-    protected function __construct(
-        Base64Encoder $base64_encoder,
-        CipherMethod $cipher_method,
-        EncryptionKeyManagerInterface $encryption_key_manager,
-        $min_php_version
-    ) {
-        $this->base64_encoder         = $base64_encoder;
-        $this->cipher_method          = $cipher_method;
-        $this->encryption_key_manager = $encryption_key_manager;
-        $this->min_php_version        = $min_php_version;
-        $this->openssl_installed      = extension_loaded('openssl');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCryptographicallySecure()
-    {
-        return true;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function canUse()
-    {
-        return $this->openssl_installed && version_compare(PHP_VERSION, $this->min_php_version, '>=');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function canUseNotice()
-    {
-        if (! $this->openssl_installed) {
-            return esc_html__(
-                'The PHP openssl server extension is required to use Openssl encryption. Please contact your hosting provider regarding this issue.',
-                'event_espresso'
-            );
-        }
-        if (version_compare(PHP_VERSION, $this->min_php_version, '<')) {
-            return sprintf(
-                esc_html__(
-                    'PHP version %1$s or greater is required to use Openssl encryption. Please contact your hosting provider regarding this issue.',
-                    'event_espresso'
-                ),
-                $this->min_php_version
-            );
-        }
-        return sprintf(
-            esc_html__('OpenSSL v1 encryption using %1$s is available for use.', 'event_espresso'),
-            OpenSSLv1::CIPHER_METHOD
-        );
-    }
-
-
-    /**
-     * Computes the digest hash value using the specified digest method.
-     * If that digest method fails to produce a valid hash value,
-     * then we'll grab the next digest method and recursively try again until something works.
-     *
-     * @param string $encryption_key
-     * @param string $digest_method
-     * @param bool   $return_raw_data
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function getDigestHashValue(
-        $encryption_key,
-        $digest_method = OpenSSL::DEFAULT_DIGEST_METHOD,
-        $return_raw_data = false
-    ) {
-        $digest_hash_value = openssl_digest($encryption_key, $digest_method, $return_raw_data);
-        if ($digest_hash_value === false) {
-            return $this->getDigestHashValue($this->getDigestMethod());
-        }
-        return $digest_hash_value;
-    }
-
-
-    /**
-     * Returns the NEXT element in the $digest_methods array.
-     * If the $digest_methods array is empty, then we populate it
-     * with the available values returned from openssl_get_md_methods().
-     *
-     * @return string
-     * @throws RuntimeException
-     */
-    private function getDigestMethod()
-    {
-        $digest_method = prev($this->digest_methods);
-        if (empty($this->digest_methods)) {
-            $this->digest_methods = openssl_get_md_methods();
-            $digest_method        = end($this->digest_methods);
-        }
-        if ($digest_method === false) {
-            throw new RuntimeException(
-                esc_html__(
-                    'OpenSSL support appears to be enabled on the server, but no digest methods are available. Please contact the server administrator.',
-                    'event_espresso'
-                )
-            );
-        }
-        return $digest_method;
-    }
-
-
-    /**
-     * @param string $encryption_key
-     * @return int
-     */
-    protected function calculateHashLength($encryption_key)
-    {
-        // get existing key length
-        $prev_key_length = $this->encryption_key_manager->keyLength();
-        // set it to something HUGE
-        $this->encryption_key_manager->setKeyLength(512);
-        // generate a new weak key, which should just be a really long random string
-        $test_text = $this->encryption_key_manager->generateEncryptionKey(false);
-        // generate a hash using our test string and our real $encryption_key
-        $hash = hash_hmac($this->getHashAlgorithm(), $test_text, $encryption_key, true);
-        // reset key length back to original value
-        $this->encryption_key_manager->setKeyLength($prev_key_length);
-        // return the length of the hash
-        return strlen($hash);
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function getHashAlgorithm()
-    {
-        if (! $this->hash_algorithm) {
-            // get installed hashing algorithms
-            $hash_algorithms = hash_algos();
-            // filter array for "sha" algorithms
-            $hash_algorithms = preg_grep('/^sha\d{3}$/i', $hash_algorithms);
-            // if no sha algorithms are installed, then just use md5
-            if (empty($hash_algorithms)) {
-                $this->hash_algorithm = 'md5';
-                return $this->hash_algorithm;
-            }
-            // sort ascending using "natural ordering"
-            sort($hash_algorithms, SORT_NATURAL);
-            // return last item from array, which should be the strongest installed sha hash
-            $this->hash_algorithm = array_pop($hash_algorithms);
-        }
-        return $this->hash_algorithm;
-    }
-
-
-    /**
-     * @param string $encrypted_text
-     * @throws RuntimeException
-     */
-    protected function validateEncryption($encrypted_text)
-    {
-        if ($encrypted_text === false) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__('The following error occurred during OpenSSL encryption: %1$s', 'event_espresso'),
-                    $this->getOpenSslError()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return false|string
-     */
-    private function getOpenSslError()
-    {
-        $error = openssl_error_string();
-        return $error ?: esc_html__('Unknown Error', 'event_espresso');
-    }
-
-
-    /**
-     * @param string $encrypted_text
-     * @throws RuntimeException
-     */
-    protected function validateDecryption($encrypted_text)
-    {
-        if ($encrypted_text === false) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__('OpenSSL decryption failed for the following reason: %1$s', 'event_espresso'),
-                    $this->getOpenSslError()
-                )
-            );
-        }
-    }
+	/**
+	 * the default OPENSSL digest method to use
+	 */
+	const DEFAULT_DIGEST_METHOD = 'sha512';
+
+	/**
+	 * separates the encrypted text from the initialization vector
+	 */
+	const IV_DELIMITER = ':iv:';
+
+	/**
+	 * @var Base64Encoder
+	 */
+	protected $base64_encoder;
+
+	/**
+	 * @var CipherMethod
+	 */
+	protected $cipher_method;
+
+	/**
+	 * @var array $digest_methods
+	 */
+	private $digest_methods = [];
+
+	/**
+	 * @var EncryptionKeyManagerInterface
+	 */
+	protected $encryption_key_manager;
+
+	/**
+	 * @var boolean
+	 */
+	private $openssl_installed;
+
+	/**
+	 * @var string
+	 */
+	private $min_php_version;
+
+	/**
+	 * @var string
+	 */
+	private $hash_algorithm;
+
+
+	/**
+	 * To use custom a cipher method and/or encryption keys:
+	 *  - extend this class
+	 *  - configure a new CipherMethod / EncryptionKeyManager in the constructor
+	 *  - pass those to this constructor, like so:
+	 *
+	 *      public function __construct(Base64Encoder $base64_encoder) {
+	 *          parent::__construct(
+	 *              $base64_encoder,
+	 *              new CipherMethod(CIPHER_METHOD, CIPHER_METHOD_OPTION_NAME)
+	 *              new EncryptionKeyManager(CUSTOM_KEY_ID, CUSTOM_KEYS_OPTION_NAME)
+	 *          );
+	 *      }
+	 *
+	 * @param Base64Encoder                      $base64_encoder
+	 * @param CipherMethod                       $cipher_method
+	 * @param EncryptionKeyManagerInterface|null $encryption_key_manager
+	 * @param string                             $min_php_version
+	 */
+	protected function __construct(
+		Base64Encoder $base64_encoder,
+		CipherMethod $cipher_method,
+		EncryptionKeyManagerInterface $encryption_key_manager,
+		$min_php_version
+	) {
+		$this->base64_encoder         = $base64_encoder;
+		$this->cipher_method          = $cipher_method;
+		$this->encryption_key_manager = $encryption_key_manager;
+		$this->min_php_version        = $min_php_version;
+		$this->openssl_installed      = extension_loaded('openssl');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCryptographicallySecure()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function canUse()
+	{
+		return $this->openssl_installed && version_compare(PHP_VERSION, $this->min_php_version, '>=');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function canUseNotice()
+	{
+		if (! $this->openssl_installed) {
+			return esc_html__(
+				'The PHP openssl server extension is required to use Openssl encryption. Please contact your hosting provider regarding this issue.',
+				'event_espresso'
+			);
+		}
+		if (version_compare(PHP_VERSION, $this->min_php_version, '<')) {
+			return sprintf(
+				esc_html__(
+					'PHP version %1$s or greater is required to use Openssl encryption. Please contact your hosting provider regarding this issue.',
+					'event_espresso'
+				),
+				$this->min_php_version
+			);
+		}
+		return sprintf(
+			esc_html__('OpenSSL v1 encryption using %1$s is available for use.', 'event_espresso'),
+			OpenSSLv1::CIPHER_METHOD
+		);
+	}
+
+
+	/**
+	 * Computes the digest hash value using the specified digest method.
+	 * If that digest method fails to produce a valid hash value,
+	 * then we'll grab the next digest method and recursively try again until something works.
+	 *
+	 * @param string $encryption_key
+	 * @param string $digest_method
+	 * @param bool   $return_raw_data
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function getDigestHashValue(
+		$encryption_key,
+		$digest_method = OpenSSL::DEFAULT_DIGEST_METHOD,
+		$return_raw_data = false
+	) {
+		$digest_hash_value = openssl_digest($encryption_key, $digest_method, $return_raw_data);
+		if ($digest_hash_value === false) {
+			return $this->getDigestHashValue($this->getDigestMethod());
+		}
+		return $digest_hash_value;
+	}
+
+
+	/**
+	 * Returns the NEXT element in the $digest_methods array.
+	 * If the $digest_methods array is empty, then we populate it
+	 * with the available values returned from openssl_get_md_methods().
+	 *
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	private function getDigestMethod()
+	{
+		$digest_method = prev($this->digest_methods);
+		if (empty($this->digest_methods)) {
+			$this->digest_methods = openssl_get_md_methods();
+			$digest_method        = end($this->digest_methods);
+		}
+		if ($digest_method === false) {
+			throw new RuntimeException(
+				esc_html__(
+					'OpenSSL support appears to be enabled on the server, but no digest methods are available. Please contact the server administrator.',
+					'event_espresso'
+				)
+			);
+		}
+		return $digest_method;
+	}
+
+
+	/**
+	 * @param string $encryption_key
+	 * @return int
+	 */
+	protected function calculateHashLength($encryption_key)
+	{
+		// get existing key length
+		$prev_key_length = $this->encryption_key_manager->keyLength();
+		// set it to something HUGE
+		$this->encryption_key_manager->setKeyLength(512);
+		// generate a new weak key, which should just be a really long random string
+		$test_text = $this->encryption_key_manager->generateEncryptionKey(false);
+		// generate a hash using our test string and our real $encryption_key
+		$hash = hash_hmac($this->getHashAlgorithm(), $test_text, $encryption_key, true);
+		// reset key length back to original value
+		$this->encryption_key_manager->setKeyLength($prev_key_length);
+		// return the length of the hash
+		return strlen($hash);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function getHashAlgorithm()
+	{
+		if (! $this->hash_algorithm) {
+			// get installed hashing algorithms
+			$hash_algorithms = hash_algos();
+			// filter array for "sha" algorithms
+			$hash_algorithms = preg_grep('/^sha\d{3}$/i', $hash_algorithms);
+			// if no sha algorithms are installed, then just use md5
+			if (empty($hash_algorithms)) {
+				$this->hash_algorithm = 'md5';
+				return $this->hash_algorithm;
+			}
+			// sort ascending using "natural ordering"
+			sort($hash_algorithms, SORT_NATURAL);
+			// return last item from array, which should be the strongest installed sha hash
+			$this->hash_algorithm = array_pop($hash_algorithms);
+		}
+		return $this->hash_algorithm;
+	}
+
+
+	/**
+	 * @param string $encrypted_text
+	 * @throws RuntimeException
+	 */
+	protected function validateEncryption($encrypted_text)
+	{
+		if ($encrypted_text === false) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__('The following error occurred during OpenSSL encryption: %1$s', 'event_espresso'),
+					$this->getOpenSslError()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return false|string
+	 */
+	private function getOpenSslError()
+	{
+		$error = openssl_error_string();
+		return $error ?: esc_html__('Unknown Error', 'event_espresso');
+	}
+
+
+	/**
+	 * @param string $encrypted_text
+	 * @throws RuntimeException
+	 */
+	protected function validateDecryption($encrypted_text)
+	{
+		if ($encrypted_text === false) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__('OpenSSL decryption failed for the following reason: %1$s', 'event_espresso'),
+					$this->getOpenSslError()
+				)
+			);
+		}
+	}
 }

core/services/encryption/openssl/OpenSSLv1.php

Spacing +1 added lines, -1 removed lines

@@ -122,7 +122,7 @@
         // hash the raw encrypted text
         $hmac = hash_hmac($this->getHashAlgorithm(), $encrypted_text, $key, true);
         // concatenate everything into one big string and encode it again
-        return $this->base64_encoder->encodeString($iv . $hmac . $encrypted_text);
+        return $this->base64_encoder->encodeString($iv.$hmac.$encrypted_text);
     }
 
 

Indentation +142 added lines, -142 removed lines

@@ -17,155 +17,155 @@
  */
 class OpenSSLv1 extends OpenSSL
 {
-    /**
-     * name used for a default encryption key in case no others are set
-     */
-    const DEFAULT_ENCRYPTION_KEY_ID = 'default_openssl_v1_key';
+	/**
+	 * name used for a default encryption key in case no others are set
+	 */
+	const DEFAULT_ENCRYPTION_KEY_ID = 'default_openssl_v1_key';
 
-    /**
-     * name used for saving encryption keys to the wp_options table
-     */
-    const ENCRYPTION_KEYS_OPTION_NAME = 'ee_openssl_v1_encryption_keys';
+	/**
+	 * name used for saving encryption keys to the wp_options table
+	 */
+	const ENCRYPTION_KEYS_OPTION_NAME = 'ee_openssl_v1_encryption_keys';
 
-    /**
-     * the OPENSSL cipher method used
-     */
-    const CIPHER_METHOD = 'aes-128-cbc';
+	/**
+	 * the OPENSSL cipher method used
+	 */
+	const CIPHER_METHOD = 'aes-128-cbc';
 
-    /**
-     * WP "options_name" used to store a verified available cipher method
-     */
-    const CIPHER_METHOD_OPTION_NAME = 'ee_openssl_v1_cipher_method';
+	/**
+	 * WP "options_name" used to store a verified available cipher method
+	 */
+	const CIPHER_METHOD_OPTION_NAME = 'ee_openssl_v1_cipher_method';
 
 
-    /**
-     * To use custom a cipher method and/or encryption keys and/or minimum PHP version:
-     *  - extend this class
-     *  - configure a new CipherMethod / EncryptionKeyManager in the constructor
-     *  - pass those to this constructor, like so:
-     *
-     *      public function __construct(Base64Encoder $base64_encoder) {
-     *          parent::__construct(
-     *              $base64_encoder,
-     *              new CipherMethod(CIPHER_METHOD, CIPHER_METHOD_OPTION_NAME),
-     *              new EncryptionKeyManager(CUSTOM_KEY_ID, CUSTOM_KEYS_OPTION_NAME),
-     *              '7.1.0'
-     *          );
-     *      }
-     *
-     * @param Base64Encoder                      $base64_encoder
-     * @param CipherMethod|null                  $cipher_method
-     * @param EncryptionKeyManagerInterface|null $encryption_key_manager
-     * @param string                             $min_php_version defaults to 5.3.0 (when openssl added)
-     */
-    public function __construct(
-        Base64Encoder $base64_encoder,
-        CipherMethod $cipher_method = null,
-        EncryptionKeyManagerInterface $encryption_key_manager = null,
-        $min_php_version = '5.3.0'
-    ) {
-        parent::__construct(
-            $base64_encoder,
-            $cipher_method instanceof CipherMethod
-                ? $cipher_method
-                : new CipherMethod(
-                    OpenSSLv1::CIPHER_METHOD,
-                    OpenSSLv1::CIPHER_METHOD_OPTION_NAME
-                ),
-            $encryption_key_manager instanceof EncryptionKeyManager
-                ? $encryption_key_manager
-                : new EncryptionKeyManager(
-                    $base64_encoder,
-                    OpenSSLv1::DEFAULT_ENCRYPTION_KEY_ID,
-                    OpenSSLv1::ENCRYPTION_KEYS_OPTION_NAME
-                ),
-            $min_php_version
-        );
-    }
+	/**
+	 * To use custom a cipher method and/or encryption keys and/or minimum PHP version:
+	 *  - extend this class
+	 *  - configure a new CipherMethod / EncryptionKeyManager in the constructor
+	 *  - pass those to this constructor, like so:
+	 *
+	 *      public function __construct(Base64Encoder $base64_encoder) {
+	 *          parent::__construct(
+	 *              $base64_encoder,
+	 *              new CipherMethod(CIPHER_METHOD, CIPHER_METHOD_OPTION_NAME),
+	 *              new EncryptionKeyManager(CUSTOM_KEY_ID, CUSTOM_KEYS_OPTION_NAME),
+	 *              '7.1.0'
+	 *          );
+	 *      }
+	 *
+	 * @param Base64Encoder                      $base64_encoder
+	 * @param CipherMethod|null                  $cipher_method
+	 * @param EncryptionKeyManagerInterface|null $encryption_key_manager
+	 * @param string                             $min_php_version defaults to 5.3.0 (when openssl added)
+	 */
+	public function __construct(
+		Base64Encoder $base64_encoder,
+		CipherMethod $cipher_method = null,
+		EncryptionKeyManagerInterface $encryption_key_manager = null,
+		$min_php_version = '5.3.0'
+	) {
+		parent::__construct(
+			$base64_encoder,
+			$cipher_method instanceof CipherMethod
+				? $cipher_method
+				: new CipherMethod(
+					OpenSSLv1::CIPHER_METHOD,
+					OpenSSLv1::CIPHER_METHOD_OPTION_NAME
+				),
+			$encryption_key_manager instanceof EncryptionKeyManager
+				? $encryption_key_manager
+				: new EncryptionKeyManager(
+					$base64_encoder,
+					OpenSSLv1::DEFAULT_ENCRYPTION_KEY_ID,
+					OpenSSLv1::ENCRYPTION_KEYS_OPTION_NAME
+				),
+			$min_php_version
+		);
+	}
 
 
-    /**
-     * encrypts data
-     *
-     * @param string $text_to_encrypt           - the text to be encrypted
-     * @param string $encryption_key_identifier - cryptographically secure passphrase. will generate if necessary
-     * @return string
-     */
-    public function encrypt($text_to_encrypt, $encryption_key_identifier = '')
-    {
-        $cipher_method  = $this->cipher_method->getCipherMethod();
-        $encryption_key = $this->encryption_key_manager->getEncryptionKey($encryption_key_identifier);
-        // get initialization vector size
-        $iv_length = openssl_cipher_iv_length($cipher_method);
-        // generate initialization vector.
-        // The second parameter ("crypto_strong") is passed by reference,
-        // and is used to determines if the algorithm used was "cryptographically strong"
-        // openssl_random_pseudo_bytes() will toggle it to either true or false
-        $iv = openssl_random_pseudo_bytes($iv_length, $is_strong);
-        if ($iv === false || $is_strong === false) {
-            throw new RuntimeException(
-                esc_html__('Failed to generate OpenSSL initialization vector.', 'event_espresso')
-            );
-        }
-        $key = $this->getDigestHashValue($encryption_key);
-        // encrypt it
-        $encrypted_text = openssl_encrypt(
-            $this->base64_encoder->encodeString($text_to_encrypt), // encode to remove special characters
-            $cipher_method,
-            $key,
-            0,
-            $iv
-        );
-        $this->validateEncryption($encrypted_text);
-        $encrypted_text = trim($encrypted_text);
-        // hash the raw encrypted text
-        $hmac = hash_hmac($this->getHashAlgorithm(), $encrypted_text, $key, true);
-        // concatenate everything into one big string and encode it again
-        return $this->base64_encoder->encodeString($iv . $hmac . $encrypted_text);
-    }
+	/**
+	 * encrypts data
+	 *
+	 * @param string $text_to_encrypt           - the text to be encrypted
+	 * @param string $encryption_key_identifier - cryptographically secure passphrase. will generate if necessary
+	 * @return string
+	 */
+	public function encrypt($text_to_encrypt, $encryption_key_identifier = '')
+	{
+		$cipher_method  = $this->cipher_method->getCipherMethod();
+		$encryption_key = $this->encryption_key_manager->getEncryptionKey($encryption_key_identifier);
+		// get initialization vector size
+		$iv_length = openssl_cipher_iv_length($cipher_method);
+		// generate initialization vector.
+		// The second parameter ("crypto_strong") is passed by reference,
+		// and is used to determines if the algorithm used was "cryptographically strong"
+		// openssl_random_pseudo_bytes() will toggle it to either true or false
+		$iv = openssl_random_pseudo_bytes($iv_length, $is_strong);
+		if ($iv === false || $is_strong === false) {
+			throw new RuntimeException(
+				esc_html__('Failed to generate OpenSSL initialization vector.', 'event_espresso')
+			);
+		}
+		$key = $this->getDigestHashValue($encryption_key);
+		// encrypt it
+		$encrypted_text = openssl_encrypt(
+			$this->base64_encoder->encodeString($text_to_encrypt), // encode to remove special characters
+			$cipher_method,
+			$key,
+			0,
+			$iv
+		);
+		$this->validateEncryption($encrypted_text);
+		$encrypted_text = trim($encrypted_text);
+		// hash the raw encrypted text
+		$hmac = hash_hmac($this->getHashAlgorithm(), $encrypted_text, $key, true);
+		// concatenate everything into one big string and encode it again
+		return $this->base64_encoder->encodeString($iv . $hmac . $encrypted_text);
+	}
 
 
-    /**
-     * decrypts data
-     *
-     * @param string $encrypted_text            - the text to be decrypted
-     * @param string $encryption_key_identifier - cryptographically secure passphrase. will use default if necessary
-     * @return string
-     */
-    public function decrypt($encrypted_text, $encryption_key_identifier = '')
-    {
-        $cipher_method  = $this->cipher_method->getCipherMethod();
-        $encryption_key = $this->encryption_key_manager->getEncryptionKey($encryption_key_identifier);
-        $key            = $this->getDigestHashValue($encryption_key);
-        // decode our concatenated string
-        $encrypted_text = $this->base64_encoder->decodeString($encrypted_text);
-        // get the string lengths used for the hash and iv
-        $hash_length = $this->calculateHashLength($encryption_key);
-        $iv_length   = openssl_cipher_iv_length($cipher_method);
-        // use the above lengths to snip the required values from the decoded string
-        $iv                 = substr($encrypted_text, 0, $iv_length);
-        $hmac               = substr($encrypted_text, $iv_length, $hash_length);
-        $encrypted_text_raw = substr($encrypted_text, $iv_length + $hash_length);
-        // rehash the original raw encrypted text
-        $rehash_mac = hash_hmac($this->getHashAlgorithm(), $encrypted_text_raw, $key, true);
-        // timing attack safe comparison to determine if anything has changed
-        if (hash_equals($hmac, $rehash_mac)) {
-            // looks good, decrypt it, trim it, and return it
-            $decrypted_text = openssl_decrypt(
-                $encrypted_text_raw,
-                $this->cipher_method->getCipherMethod(),
-                $key,
-                0,
-                $iv
-            );
-            $this->validateDecryption($decrypted_text);
-            return trim($this->base64_encoder->decodeString($decrypted_text));
-        }
-        throw new RuntimeException(
-            esc_html__(
-                'Decryption failed because a hash comparison of the original text and the decrypted text was not the same, meaning something in the system or the encrypted data has changed.',
-                'event_espresso'
-            )
-        );
-    }
+	/**
+	 * decrypts data
+	 *
+	 * @param string $encrypted_text            - the text to be decrypted
+	 * @param string $encryption_key_identifier - cryptographically secure passphrase. will use default if necessary
+	 * @return string
+	 */
+	public function decrypt($encrypted_text, $encryption_key_identifier = '')
+	{
+		$cipher_method  = $this->cipher_method->getCipherMethod();
+		$encryption_key = $this->encryption_key_manager->getEncryptionKey($encryption_key_identifier);
+		$key            = $this->getDigestHashValue($encryption_key);
+		// decode our concatenated string
+		$encrypted_text = $this->base64_encoder->decodeString($encrypted_text);
+		// get the string lengths used for the hash and iv
+		$hash_length = $this->calculateHashLength($encryption_key);
+		$iv_length   = openssl_cipher_iv_length($cipher_method);
+		// use the above lengths to snip the required values from the decoded string
+		$iv                 = substr($encrypted_text, 0, $iv_length);
+		$hmac               = substr($encrypted_text, $iv_length, $hash_length);
+		$encrypted_text_raw = substr($encrypted_text, $iv_length + $hash_length);
+		// rehash the original raw encrypted text
+		$rehash_mac = hash_hmac($this->getHashAlgorithm(), $encrypted_text_raw, $key, true);
+		// timing attack safe comparison to determine if anything has changed
+		if (hash_equals($hmac, $rehash_mac)) {
+			// looks good, decrypt it, trim it, and return it
+			$decrypted_text = openssl_decrypt(
+				$encrypted_text_raw,
+				$this->cipher_method->getCipherMethod(),
+				$key,
+				0,
+				$iv
+			);
+			$this->validateDecryption($decrypted_text);
+			return trim($this->base64_encoder->decodeString($decrypted_text));
+		}
+		throw new RuntimeException(
+			esc_html__(
+				'Decryption failed because a hash comparison of the original text and the decrypted text was not the same, meaning something in the system or the encrypted data has changed.',
+				'event_espresso'
+			)
+		);
+	}
 }

core/services/encryption/openssl/CipherMethod.php

Spacing +2 added lines, -2 removed lines

@@ -159,7 +159,7 @@ 
             update_option($this->cipher_method_option_name, $cipher_method_to_test);
         }
         // if we previously removed this cipher method from the list of valid ones, then let's put it back
-        if (! in_array($cipher_method_to_test, $this->cipher_methods, true)) {
+        if ( ! in_array($cipher_method_to_test, $this->cipher_methods, true)) {
             array_unshift($this->cipher_methods, $cipher_method_to_test);
         }
         return $cipher_method_to_test;
@@ -189,7 +189,7 @@ 
         ) {
             return true;
         }
-        if (! $throw_exception) {
+        if ( ! $throw_exception) {
             return false;
         }
         throw new RuntimeException(

Indentation +202 added lines, -202 removed lines

@@ -14,206 +14,206 @@
  */
 class CipherMethod
 {
-    /**
-     * @var string
-     */
-    protected $cipher_method_option_name;
-
-    /**
-     * list of cipher methods that we consider usable,
-     * essentially all of the installed_cipher_methods minus weak_algorithms
-     *
-     * @var array
-     */
-    protected $cipher_methods = [];
-
-    /**
-     * @var string
-     */
-    protected $default_cipher_method;
-
-    /**
-     * list of ALL cipher methods available on the server
-     *
-     * @var array
-     */
-    protected $installed_cipher_methods;
-
-    /**
-     * the OpenSSL cipher method to use. default: AES-128-CBC
-     *
-     * @var string
-     */
-    protected $validated_cipher_method;
-
-    /**
-     * as early as Aug 2016, Openssl declared the following weak: RC2, RC4, DES, 3DES, MD5 based
-     * and ECB mode should be avoided
-     *
-     * @var array
-     */
-    protected $weak_algorithms = ['des', 'ecb', 'md5', 'rc2', 'rc4'];
-
-
-    /**
-     * @param string $default_cipher_method
-     * @param string $cipher_method_option_name
-     */
-    public function __construct($default_cipher_method, $cipher_method_option_name)
-    {
-        $this->default_cipher_method     = $default_cipher_method;
-        $this->cipher_method_option_name = $cipher_method_option_name;
-        $this->installed_cipher_methods  = openssl_get_cipher_methods();
-    }
-
-
-    /**
-     * Returns a cipher method that has been verified to work.
-     * First checks if the cached cipher has been set already and if so, returns that.
-     * Then tests the incoming default and returns that if it's good.
-     * If not, then it retrieves the previously tested and saved cipher method.
-     * But if that doesn't exist, then calls getAvailableCipherMethod()
-     * to see what is available on the server, and returns the results.
-     *
-     * @param string $cipher_method
-     * @param bool   $load_alternate [optional] if TRUE, will load the default cipher method (or any strong algorithm)
-     *                               if the requested cipher method is not installed or invalid.
-     *                               if FALSE, will throw an exception if the requested cipher method is not valid.
-     * @return string
-     * @throws RuntimeException
-     */
-    public function getCipherMethod($cipher_method = null, $load_alternate = true)
-    {
-        if (empty($cipher_method) && $this->validated_cipher_method !== null) {
-            return $this->validated_cipher_method;
-        }
-        // if nothing specific was requested and it's ok to load an alternate, then grab the system default
-        if (empty($cipher_method) && $load_alternate) {
-            $cipher_method = $this->default_cipher_method;
-        }
-        // verify that the cipher method can produce an initialization vector.
-        // but if the requested is invalid and we don't want to load an alternate, then throw an exception
-        $throw_exception = ! $load_alternate;
-        if ($this->validateCipherMethod($cipher_method, $throw_exception) === false) {
-            // nope? ... ok let's see what we can find
-            $cipher_method = $this->getAvailableCipherMethod();
-        }
-        // if nothing has been previously validated, then save the currently requested cipher which appears to be good
-        if ($this->validated_cipher_method === null) {
-            $this->validated_cipher_method = $cipher_method;
-        }
-        return $cipher_method;
-    }
-
-
-    /**
-     * returns true if the selected cipher method either uses Galois/Counter Mode (GCM)
-     * or Counter with CBC-MAC (CCM) authenticated encryption modes
-     * (also need to be using PHP 7.1 or greater to actually use authenticated encryption modes)
-     *
-     * @return bool
-     */
-    public function usesAuthenticatedEncryptionMode()
-    {
-        return PHP_VERSION_ID >= 70100
-               && (
-                   stripos($this->validated_cipher_method, 'gcm') !== false
-                   || stripos($this->validated_cipher_method, 'ccm') !== false
-               );
-    }
-
-
-    /**
-     * @param string $cipher_method
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function getAvailableCipherMethod($cipher_method = null)
-    {
-        // if nothing was supplied, the get what we found in the past to work
-        $cipher_method_to_test = $cipher_method ?: get_option($this->cipher_method_option_name, '');
-        // verify that the incoming cipher method exists and can produce an initialization vector
-        if ($this->validateCipherMethod($cipher_method_to_test) === false) {
-            // what? there's no list?
-            if (empty($this->cipher_methods)) {
-                // generate that list and cache it
-                $this->cipher_methods = $this->getAvailableStrongCipherMethods();
-            }
-            // then grab the first item from the list (we'll add it back later if it is good)
-            $cipher_method_to_test = array_shift($this->cipher_methods);
-            if ($cipher_method_to_test === null) {
-                throw new RuntimeException(
-                    esc_html__(
-                        'OpenSSL support appears to be enabled on the server, but no cipher methods are available. Please contact the server administrator.',
-                        'event_espresso'
-                    )
-                );
-            }
-            // verify that the next cipher method works
-            return $this->getAvailableCipherMethod($cipher_method_to_test);
-        }
-        // if we've gotten this far, then we found an available cipher method that works
-        // so save that for next time, if it's not the same as what's there already
-        if ($cipher_method_to_test !== $cipher_method) {
-            update_option($this->cipher_method_option_name, $cipher_method_to_test);
-        }
-        // if we previously removed this cipher method from the list of valid ones, then let's put it back
-        if (! in_array($cipher_method_to_test, $this->cipher_methods, true)) {
-            array_unshift($this->cipher_methods, $cipher_method_to_test);
-        }
-        return $cipher_method_to_test;
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function getAvailableStrongCipherMethods()
-    {
-        return array_filter($this->installed_cipher_methods, [$this, 'weakAlgorithmFilter']);
-    }
-
-
-    /**
-     * @param string $cipher_method
-     * @param false  $throw_exception
-     * @return bool
-     */
-    protected function validateCipherMethod($cipher_method, $throw_exception = false)
-    {
-        // verify that the requested cipher method is actually installed and can produce an initialization vector
-        if (
-            in_array($cipher_method, $this->installed_cipher_methods, true)
-            && openssl_cipher_iv_length($cipher_method) !== false
-        ) {
-            return true;
-        }
-        if (! $throw_exception) {
-            return false;
-        }
-        throw new RuntimeException(
-            sprintf(
-                esc_html__(
-                    'The requested OpenSSL cipher method "%1$s" is invalid or not installed on the server. Please contact the server administrator.',
-                    'event_espresso'
-                ),
-                $cipher_method
-            )
-        );
-    }
-
-
-    /**
-     * @see https://www.php.net/manual/en/function.openssl-get-cipher-methods.php#example-890
-     * @param string $cipher_method
-     */
-    protected function weakAlgorithmFilter($cipher_method)
-    {
-        foreach ($this->weak_algorithms as $weak_algorithm) {
-            if (stripos($cipher_method, $weak_algorithm) !== false) {
-                return false;
-            }
-        }
-        return true;
-    }
+	/**
+	 * @var string
+	 */
+	protected $cipher_method_option_name;
+
+	/**
+	 * list of cipher methods that we consider usable,
+	 * essentially all of the installed_cipher_methods minus weak_algorithms
+	 *
+	 * @var array
+	 */
+	protected $cipher_methods = [];
+
+	/**
+	 * @var string
+	 */
+	protected $default_cipher_method;
+
+	/**
+	 * list of ALL cipher methods available on the server
+	 *
+	 * @var array
+	 */
+	protected $installed_cipher_methods;
+
+	/**
+	 * the OpenSSL cipher method to use. default: AES-128-CBC
+	 *
+	 * @var string
+	 */
+	protected $validated_cipher_method;
+
+	/**
+	 * as early as Aug 2016, Openssl declared the following weak: RC2, RC4, DES, 3DES, MD5 based
+	 * and ECB mode should be avoided
+	 *
+	 * @var array
+	 */
+	protected $weak_algorithms = ['des', 'ecb', 'md5', 'rc2', 'rc4'];
+
+
+	/**
+	 * @param string $default_cipher_method
+	 * @param string $cipher_method_option_name
+	 */
+	public function __construct($default_cipher_method, $cipher_method_option_name)
+	{
+		$this->default_cipher_method     = $default_cipher_method;
+		$this->cipher_method_option_name = $cipher_method_option_name;
+		$this->installed_cipher_methods  = openssl_get_cipher_methods();
+	}
+
+
+	/**
+	 * Returns a cipher method that has been verified to work.
+	 * First checks if the cached cipher has been set already and if so, returns that.
+	 * Then tests the incoming default and returns that if it's good.
+	 * If not, then it retrieves the previously tested and saved cipher method.
+	 * But if that doesn't exist, then calls getAvailableCipherMethod()
+	 * to see what is available on the server, and returns the results.
+	 *
+	 * @param string $cipher_method
+	 * @param bool   $load_alternate [optional] if TRUE, will load the default cipher method (or any strong algorithm)
+	 *                               if the requested cipher method is not installed or invalid.
+	 *                               if FALSE, will throw an exception if the requested cipher method is not valid.
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function getCipherMethod($cipher_method = null, $load_alternate = true)
+	{
+		if (empty($cipher_method) && $this->validated_cipher_method !== null) {
+			return $this->validated_cipher_method;
+		}
+		// if nothing specific was requested and it's ok to load an alternate, then grab the system default
+		if (empty($cipher_method) && $load_alternate) {
+			$cipher_method = $this->default_cipher_method;
+		}
+		// verify that the cipher method can produce an initialization vector.
+		// but if the requested is invalid and we don't want to load an alternate, then throw an exception
+		$throw_exception = ! $load_alternate;
+		if ($this->validateCipherMethod($cipher_method, $throw_exception) === false) {
+			// nope? ... ok let's see what we can find
+			$cipher_method = $this->getAvailableCipherMethod();
+		}
+		// if nothing has been previously validated, then save the currently requested cipher which appears to be good
+		if ($this->validated_cipher_method === null) {
+			$this->validated_cipher_method = $cipher_method;
+		}
+		return $cipher_method;
+	}
+
+
+	/**
+	 * returns true if the selected cipher method either uses Galois/Counter Mode (GCM)
+	 * or Counter with CBC-MAC (CCM) authenticated encryption modes
+	 * (also need to be using PHP 7.1 or greater to actually use authenticated encryption modes)
+	 *
+	 * @return bool
+	 */
+	public function usesAuthenticatedEncryptionMode()
+	{
+		return PHP_VERSION_ID >= 70100
+			   && (
+				   stripos($this->validated_cipher_method, 'gcm') !== false
+				   || stripos($this->validated_cipher_method, 'ccm') !== false
+			   );
+	}
+
+
+	/**
+	 * @param string $cipher_method
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function getAvailableCipherMethod($cipher_method = null)
+	{
+		// if nothing was supplied, the get what we found in the past to work
+		$cipher_method_to_test = $cipher_method ?: get_option($this->cipher_method_option_name, '');
+		// verify that the incoming cipher method exists and can produce an initialization vector
+		if ($this->validateCipherMethod($cipher_method_to_test) === false) {
+			// what? there's no list?
+			if (empty($this->cipher_methods)) {
+				// generate that list and cache it
+				$this->cipher_methods = $this->getAvailableStrongCipherMethods();
+			}
+			// then grab the first item from the list (we'll add it back later if it is good)
+			$cipher_method_to_test = array_shift($this->cipher_methods);
+			if ($cipher_method_to_test === null) {
+				throw new RuntimeException(
+					esc_html__(
+						'OpenSSL support appears to be enabled on the server, but no cipher methods are available. Please contact the server administrator.',
+						'event_espresso'
+					)
+				);
+			}
+			// verify that the next cipher method works
+			return $this->getAvailableCipherMethod($cipher_method_to_test);
+		}
+		// if we've gotten this far, then we found an available cipher method that works
+		// so save that for next time, if it's not the same as what's there already
+		if ($cipher_method_to_test !== $cipher_method) {
+			update_option($this->cipher_method_option_name, $cipher_method_to_test);
+		}
+		// if we previously removed this cipher method from the list of valid ones, then let's put it back
+		if (! in_array($cipher_method_to_test, $this->cipher_methods, true)) {
+			array_unshift($this->cipher_methods, $cipher_method_to_test);
+		}
+		return $cipher_method_to_test;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function getAvailableStrongCipherMethods()
+	{
+		return array_filter($this->installed_cipher_methods, [$this, 'weakAlgorithmFilter']);
+	}
+
+
+	/**
+	 * @param string $cipher_method
+	 * @param false  $throw_exception
+	 * @return bool
+	 */
+	protected function validateCipherMethod($cipher_method, $throw_exception = false)
+	{
+		// verify that the requested cipher method is actually installed and can produce an initialization vector
+		if (
+			in_array($cipher_method, $this->installed_cipher_methods, true)
+			&& openssl_cipher_iv_length($cipher_method) !== false
+		) {
+			return true;
+		}
+		if (! $throw_exception) {
+			return false;
+		}
+		throw new RuntimeException(
+			sprintf(
+				esc_html__(
+					'The requested OpenSSL cipher method "%1$s" is invalid or not installed on the server. Please contact the server administrator.',
+					'event_espresso'
+				),
+				$cipher_method
+			)
+		);
+	}
+
+
+	/**
+	 * @see https://www.php.net/manual/en/function.openssl-get-cipher-methods.php#example-890
+	 * @param string $cipher_method
+	 */
+	protected function weakAlgorithmFilter($cipher_method)
+	{
+		foreach ($this->weak_algorithms as $weak_algorithm) {
+			if (stripos($cipher_method, $weak_algorithm) !== false) {
+				return false;
+			}
+		}
+		return true;
+	}
 }

core/services/encryption/openssl/OpenSSLv2.php

Spacing +2 added lines, -2 removed lines

@@ -143,7 +143,7 @@ 
         );
         $this->validateEncryption($encrypted_text);
         // concatenate everything into one big string
-        return $iv . $tag . $encrypted_text;
+        return $iv.$tag.$encrypted_text;
     }
 
 
@@ -165,7 +165,7 @@ 
         );
         $this->validateEncryption($encrypted_text);
         // prepend the initialization vector
-        return $iv . $encrypted_text;
+        return $iv.$encrypted_text;
     }
 
 

Indentation +217 added lines, -217 removed lines

@@ -23,221 +23,221 @@
  */
 class OpenSSLv2 extends OpenSSL
 {
-    /**
-     * name used for a default encryption key in case no others are set
-     */
-    const DEFAULT_ENCRYPTION_KEY_ID = 'default_openssl_v2_key';
-
-    /**
-     * name used for saving encryption keys to the wp_options table
-     */
-    const ENCRYPTION_KEYS_OPTION_NAME = 'ee_openssl_v2_encryption_keys';
-
-    /**
-     * the OPENSSL cipher method used
-     */
-    const CIPHER_METHOD = 'aes-256-gcm';
-
-    /**
-     * WP "options_name" used to store a verified available cipher method
-     */
-    const CIPHER_METHOD_OPTION_NAME = 'ee_openssl_v2_cipher_method';
-
-    /**
-     * The length of the authentication tag. Its value can be between 4 and 16 for GCM mode.
-     */
-    const AUTH_TAG_LENGTH = 16;
-
-
-    /**
-     * To use custom a cipher method and/or encryption keys and/or minimum PHP version:
-     *  - extend this class
-     *  - configure a new CipherMethod / EncryptionKeyManager in the constructor
-     *  - pass those to this constructor, like so:
-     *
-     *      public function __construct(Base64Encoder $base64_encoder) {
-     *          parent::__construct(
-     *              $base64_encoder,
-     *              new CipherMethod(CIPHER_METHOD, CIPHER_METHOD_OPTION_NAME),
-     *              new EncryptionKeyManager(CUSTOM_KEY_ID, CUSTOM_KEYS_OPTION_NAME),
-     *              '7.1.0'
-     *          );
-     *      }
-     *
-     * @param Base64Encoder                      $base64_encoder
-     * @param CipherMethod|null                  $cipher_method
-     * @param EncryptionKeyManagerInterface|null $encryption_key_manager
-     * @param string                             $min_php_version defaults to 7.1.0
-     *                                                            (when openssl auth tag and random_bytes() were added)
-     */
-    public function __construct(
-        Base64Encoder $base64_encoder,
-        CipherMethod $cipher_method = null,
-        EncryptionKeyManagerInterface $encryption_key_manager = null,
-        $min_php_version = '7.1.0'
-    ) {
-        parent::__construct(
-            $base64_encoder,
-            $cipher_method instanceof CipherMethod
-                ? $cipher_method
-                : new CipherMethod(
-                    OpenSSLv2::CIPHER_METHOD,
-                    OpenSSLv2::CIPHER_METHOD_OPTION_NAME
-                ),
-            $encryption_key_manager instanceof EncryptionKeyManager
-                ? $encryption_key_manager
-                : new EncryptionKeyManager(
-                    $base64_encoder,
-                    OpenSSLv2::DEFAULT_ENCRYPTION_KEY_ID,
-                    OpenSSLv2::ENCRYPTION_KEYS_OPTION_NAME
-                ),
-            $min_php_version
-        );
-    }
-
-
-    /**
-     * encrypts data
-     *
-     * @param string $text_to_encrypt           - the text to be encrypted
-     * @param string $encryption_key_identifier - [optional] cryptographically secure passphrase. generated if not set
-     * @param string $aad                       - [optional] additional authentication data
-     * @return string
-     * @throws Exception
-     */
-    public function encrypt($text_to_encrypt, $encryption_key_identifier = '', $aad = '')
-    {
-        $cipher_method  = $this->cipher_method->getCipherMethod();
-        $encryption_key = $this->encryption_key_manager->getEncryptionKey($encryption_key_identifier);
-        // generate initialization vector for the cipher method.
-        $iv = random_bytes(openssl_cipher_iv_length($cipher_method));
-        // encrypt it (encode to remove special characters)
-        $text_to_encrypt = $this->base64_encoder->encodeString($text_to_encrypt);
-        $encrypted_text  = $this->cipher_method->usesAuthenticatedEncryptionMode()
-            ? $this->authenticatedEncrypt($text_to_encrypt, $cipher_method, $encryption_key, $iv, $aad)
-            : $this->nonAuthenticatedEncrypt($text_to_encrypt, $cipher_method, $encryption_key, $iv);
-        return $this->base64_encoder->encodeString($encrypted_text);
-    }
-
-
-    /**
-     * @param string $text_to_encrypt - the text to be encrypted
-     * @param string $cipher_method   - the OpenSSL cipher method used during encryption
-     * @param string $encryption_key  - cryptographically secure passphrase uses default if not set
-     * @param string $iv              - the initialization vector
-     * @param string $aad             - additional authentication data
-     * @return string
-     */
-    private function authenticatedEncrypt($text_to_encrypt, $cipher_method, $encryption_key, $iv, $aad)
-    {
-        $encrypted_text = openssl_encrypt(
-            $text_to_encrypt,
-            $cipher_method,
-            $this->getDigestHashValue($encryption_key, OpenSSL::DEFAULT_DIGEST_METHOD, OPENSSL_RAW_DATA),
-            0,
-            $iv,
-            $tag,
-            $aad,
-            OpenSSLv2::AUTH_TAG_LENGTH
-        );
-        $this->validateEncryption($encrypted_text);
-        // concatenate everything into one big string
-        return $iv . $tag . $encrypted_text;
-    }
-
-
-    /**
-     * @param string $text_to_encrypt - the text to be encrypted
-     * @param string $cipher_method   - the OpenSSL cipher method used during encryption
-     * @param string $encryption_key  - cryptographically secure passphrase uses default if not set
-     * @param string $iv              - the initialization vector
-     * @return string
-     */
-    private function nonAuthenticatedEncrypt($text_to_encrypt, $cipher_method, $encryption_key, $iv)
-    {
-        $encrypted_text = openssl_encrypt(
-            $text_to_encrypt,
-            $cipher_method,
-            $this->getDigestHashValue($encryption_key),
-            0,
-            $iv
-        );
-        $this->validateEncryption($encrypted_text);
-        // prepend the initialization vector
-        return $iv . $encrypted_text;
-    }
-
-
-    /**
-     * decrypts data
-     *
-     * @param string $encrypted_text            - the text to be decrypted
-     * @param string $encryption_key_identifier - [optional] cryptographically secure passphrase uses default if not set
-     * @param string $aad                       - [optional] additional authentication data
-     * @return string
-     */
-    public function decrypt($encrypted_text, $encryption_key_identifier = '', $aad = '')
-    {
-        $cipher_method  = $this->cipher_method->getCipherMethod();
-        $encryption_key = $this->encryption_key_manager->getEncryptionKey($encryption_key_identifier);
-        // maybe decode
-        $encrypted_text = $this->base64_encoder->decodeString($encrypted_text);
-        $iv_length      = openssl_cipher_iv_length($cipher_method);
-        // use the iv length to snip it from the decoded string
-        $iv = substr($encrypted_text, 0, $iv_length);
-        // then remove it from the rest of the decoded string
-        $encrypted_text = substr($encrypted_text, $iv_length);
-        // decrypt it
-        $decrypted_text = $this->cipher_method->usesAuthenticatedEncryptionMode()
-            ? $this->authenticatedDecrypt($encrypted_text, $cipher_method, $encryption_key, $iv, $aad)
-            : $this->nonAuthenticatedDecrypt($encrypted_text, $cipher_method, $encryption_key, $iv);
-
-        $this->validateDecryption($decrypted_text);
-        return trim($this->base64_encoder->decodeString($decrypted_text));
-    }
-
-
-    /**
-     * @param string $encrypted_text - the text to be decrypted
-     * @param string $cipher_method  - the OpenSSL cipher method used during encryption
-     * @param string $encryption_key - cryptographically secure passphrase uses default if not set
-     * @param string $iv             - the initialization vector
-     * @param string $aad            - additional authentication data
-     * @return string|false
-     */
-    private function authenticatedDecrypt($encrypted_text, $cipher_method, $encryption_key, $iv, $aad)
-    {
-        // use the tag length to snip it from the decoded string
-        $tag = substr($encrypted_text, 0, OpenSSLv2::AUTH_TAG_LENGTH);
-        // then remove it from the rest of the decoded string
-        $encrypted_text = substr($encrypted_text, OpenSSLv2::AUTH_TAG_LENGTH);
-        return openssl_decrypt(
-            $encrypted_text,
-            $cipher_method,
-            $this->getDigestHashValue($encryption_key, OpenSSL::DEFAULT_DIGEST_METHOD, OPENSSL_RAW_DATA),
-            0,
-            $iv,
-            $tag,
-            $aad
-        );
-    }
-
-
-    /**
-     * @param string $encrypted_text - the text to be decrypted
-     * @param string $cipher_method  - the OpenSSL cipher method used during encryption
-     * @param string $encryption_key - cryptographically secure passphrase uses default if not set
-     * @param string $iv             - the initialization vector
-     * @return string|false
-     */
-    private function nonAuthenticatedDecrypt($encrypted_text, $cipher_method, $encryption_key, $iv)
-    {
-        return openssl_decrypt(
-            $encrypted_text,
-            $cipher_method,
-            $this->getDigestHashValue($encryption_key),
-            0,
-            $iv
-        );
-    }
+	/**
+	 * name used for a default encryption key in case no others are set
+	 */
+	const DEFAULT_ENCRYPTION_KEY_ID = 'default_openssl_v2_key';
+
+	/**
+	 * name used for saving encryption keys to the wp_options table
+	 */
+	const ENCRYPTION_KEYS_OPTION_NAME = 'ee_openssl_v2_encryption_keys';
+
+	/**
+	 * the OPENSSL cipher method used
+	 */
+	const CIPHER_METHOD = 'aes-256-gcm';
+
+	/**
+	 * WP "options_name" used to store a verified available cipher method
+	 */
+	const CIPHER_METHOD_OPTION_NAME = 'ee_openssl_v2_cipher_method';
+
+	/**
+	 * The length of the authentication tag. Its value can be between 4 and 16 for GCM mode.
+	 */
+	const AUTH_TAG_LENGTH = 16;
+
+
+	/**
+	 * To use custom a cipher method and/or encryption keys and/or minimum PHP version:
+	 *  - extend this class
+	 *  - configure a new CipherMethod / EncryptionKeyManager in the constructor
+	 *  - pass those to this constructor, like so:
+	 *
+	 *      public function __construct(Base64Encoder $base64_encoder) {
+	 *          parent::__construct(
+	 *              $base64_encoder,
+	 *              new CipherMethod(CIPHER_METHOD, CIPHER_METHOD_OPTION_NAME),
+	 *              new EncryptionKeyManager(CUSTOM_KEY_ID, CUSTOM_KEYS_OPTION_NAME),
+	 *              '7.1.0'
+	 *          );
+	 *      }
+	 *
+	 * @param Base64Encoder                      $base64_encoder
+	 * @param CipherMethod|null                  $cipher_method
+	 * @param EncryptionKeyManagerInterface|null $encryption_key_manager
+	 * @param string                             $min_php_version defaults to 7.1.0
+	 *                                                            (when openssl auth tag and random_bytes() were added)
+	 */
+	public function __construct(
+		Base64Encoder $base64_encoder,
+		CipherMethod $cipher_method = null,
+		EncryptionKeyManagerInterface $encryption_key_manager = null,
+		$min_php_version = '7.1.0'
+	) {
+		parent::__construct(
+			$base64_encoder,
+			$cipher_method instanceof CipherMethod
+				? $cipher_method
+				: new CipherMethod(
+					OpenSSLv2::CIPHER_METHOD,
+					OpenSSLv2::CIPHER_METHOD_OPTION_NAME
+				),
+			$encryption_key_manager instanceof EncryptionKeyManager
+				? $encryption_key_manager
+				: new EncryptionKeyManager(
+					$base64_encoder,
+					OpenSSLv2::DEFAULT_ENCRYPTION_KEY_ID,
+					OpenSSLv2::ENCRYPTION_KEYS_OPTION_NAME
+				),
+			$min_php_version
+		);
+	}
+
+
+	/**
+	 * encrypts data
+	 *
+	 * @param string $text_to_encrypt           - the text to be encrypted
+	 * @param string $encryption_key_identifier - [optional] cryptographically secure passphrase. generated if not set
+	 * @param string $aad                       - [optional] additional authentication data
+	 * @return string
+	 * @throws Exception
+	 */
+	public function encrypt($text_to_encrypt, $encryption_key_identifier = '', $aad = '')
+	{
+		$cipher_method  = $this->cipher_method->getCipherMethod();
+		$encryption_key = $this->encryption_key_manager->getEncryptionKey($encryption_key_identifier);
+		// generate initialization vector for the cipher method.
+		$iv = random_bytes(openssl_cipher_iv_length($cipher_method));
+		// encrypt it (encode to remove special characters)
+		$text_to_encrypt = $this->base64_encoder->encodeString($text_to_encrypt);
+		$encrypted_text  = $this->cipher_method->usesAuthenticatedEncryptionMode()
+			? $this->authenticatedEncrypt($text_to_encrypt, $cipher_method, $encryption_key, $iv, $aad)
+			: $this->nonAuthenticatedEncrypt($text_to_encrypt, $cipher_method, $encryption_key, $iv);
+		return $this->base64_encoder->encodeString($encrypted_text);
+	}
+
+
+	/**
+	 * @param string $text_to_encrypt - the text to be encrypted
+	 * @param string $cipher_method   - the OpenSSL cipher method used during encryption
+	 * @param string $encryption_key  - cryptographically secure passphrase uses default if not set
+	 * @param string $iv              - the initialization vector
+	 * @param string $aad             - additional authentication data
+	 * @return string
+	 */
+	private function authenticatedEncrypt($text_to_encrypt, $cipher_method, $encryption_key, $iv, $aad)
+	{
+		$encrypted_text = openssl_encrypt(
+			$text_to_encrypt,
+			$cipher_method,
+			$this->getDigestHashValue($encryption_key, OpenSSL::DEFAULT_DIGEST_METHOD, OPENSSL_RAW_DATA),
+			0,
+			$iv,
+			$tag,
+			$aad,
+			OpenSSLv2::AUTH_TAG_LENGTH
+		);
+		$this->validateEncryption($encrypted_text);
+		// concatenate everything into one big string
+		return $iv . $tag . $encrypted_text;
+	}
+
+
+	/**
+	 * @param string $text_to_encrypt - the text to be encrypted
+	 * @param string $cipher_method   - the OpenSSL cipher method used during encryption
+	 * @param string $encryption_key  - cryptographically secure passphrase uses default if not set
+	 * @param string $iv              - the initialization vector
+	 * @return string
+	 */
+	private function nonAuthenticatedEncrypt($text_to_encrypt, $cipher_method, $encryption_key, $iv)
+	{
+		$encrypted_text = openssl_encrypt(
+			$text_to_encrypt,
+			$cipher_method,
+			$this->getDigestHashValue($encryption_key),
+			0,
+			$iv
+		);
+		$this->validateEncryption($encrypted_text);
+		// prepend the initialization vector
+		return $iv . $encrypted_text;
+	}
+
+
+	/**
+	 * decrypts data
+	 *
+	 * @param string $encrypted_text            - the text to be decrypted
+	 * @param string $encryption_key_identifier - [optional] cryptographically secure passphrase uses default if not set
+	 * @param string $aad                       - [optional] additional authentication data
+	 * @return string
+	 */
+	public function decrypt($encrypted_text, $encryption_key_identifier = '', $aad = '')
+	{
+		$cipher_method  = $this->cipher_method->getCipherMethod();
+		$encryption_key = $this->encryption_key_manager->getEncryptionKey($encryption_key_identifier);
+		// maybe decode
+		$encrypted_text = $this->base64_encoder->decodeString($encrypted_text);
+		$iv_length      = openssl_cipher_iv_length($cipher_method);
+		// use the iv length to snip it from the decoded string
+		$iv = substr($encrypted_text, 0, $iv_length);
+		// then remove it from the rest of the decoded string
+		$encrypted_text = substr($encrypted_text, $iv_length);
+		// decrypt it
+		$decrypted_text = $this->cipher_method->usesAuthenticatedEncryptionMode()
+			? $this->authenticatedDecrypt($encrypted_text, $cipher_method, $encryption_key, $iv, $aad)
+			: $this->nonAuthenticatedDecrypt($encrypted_text, $cipher_method, $encryption_key, $iv);
+
+		$this->validateDecryption($decrypted_text);
+		return trim($this->base64_encoder->decodeString($decrypted_text));
+	}
+
+
+	/**
+	 * @param string $encrypted_text - the text to be decrypted
+	 * @param string $cipher_method  - the OpenSSL cipher method used during encryption
+	 * @param string $encryption_key - cryptographically secure passphrase uses default if not set
+	 * @param string $iv             - the initialization vector
+	 * @param string $aad            - additional authentication data
+	 * @return string|false
+	 */
+	private function authenticatedDecrypt($encrypted_text, $cipher_method, $encryption_key, $iv, $aad)
+	{
+		// use the tag length to snip it from the decoded string
+		$tag = substr($encrypted_text, 0, OpenSSLv2::AUTH_TAG_LENGTH);
+		// then remove it from the rest of the decoded string
+		$encrypted_text = substr($encrypted_text, OpenSSLv2::AUTH_TAG_LENGTH);
+		return openssl_decrypt(
+			$encrypted_text,
+			$cipher_method,
+			$this->getDigestHashValue($encryption_key, OpenSSL::DEFAULT_DIGEST_METHOD, OPENSSL_RAW_DATA),
+			0,
+			$iv,
+			$tag,
+			$aad
+		);
+	}
+
+
+	/**
+	 * @param string $encrypted_text - the text to be decrypted
+	 * @param string $cipher_method  - the OpenSSL cipher method used during encryption
+	 * @param string $encryption_key - cryptographically secure passphrase uses default if not set
+	 * @param string $iv             - the initialization vector
+	 * @return string|false
+	 */
+	private function nonAuthenticatedDecrypt($encrypted_text, $cipher_method, $encryption_key, $iv)
+	{
+		return openssl_decrypt(
+			$encrypted_text,
+			$cipher_method,
+			$this->getDigestHashValue($encryption_key),
+			0,
+			$iv
+		);
+	}
 }