eventespresso / event-espresso-core

core/services/session/SessionStartHandler.php

Indentation +383 added lines, -383 removed lines

@@ -29,387 +29,387 @@
  */
 class SessionStartHandler
 {
-    const OPTION_NAME_SESSION_SAVE_HANDLER_STATUS = 'ee_session_save_handler_status';
-
-    const REQUEST_PARAM_RETRY_SESSION             = 'ee_retry_session';
-
-    const SESSION_SAVE_HANDLER_STATUS_FAILED      = 'session_save_handler_failed';
-
-    const SESSION_SAVE_HANDLER_STATUS_SUCCESS     = 'session_save_handler_success';
-
-    const SESSION_SAVE_HANDLER_STATUS_UNKNOWN     = 'session_save_handler_untested';
-
-
-    protected RequestInterface $request;
-
-
-    /**
-     * StartSession constructor.
-     *
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * Check if a custom session save handler is in play
-     * and attempt to start the PHP session
-     *
-     * @since 4.9.68.p
-     */
-    public function startSession(): int
-    {
-        // check that session has started
-        if (session_id() === '') {
-            // clear any previous error
-            error_clear_last();
-
-            // convert warnings to ErrorException so we can catch them
-            $previous_handler = set_error_handler([$this, 'customErrorHandler'], E_WARNING);
-
-            try {
-                // starts a new session if one doesn't already exist, or re-initiates an existing one
-                if ($this->hasKnownCustomSessionSaveHandler()) {
-                    $this->checkCustomSessionSaveHandler();
-                } else {
-                    $this->verifySessionSavePath();
-                    $this->sessionStart();
-                }
-            } catch (Throwable $error) {
-                error_log(
-                    sprintf(
-                        '[SessionStartHandler] session_start() warning: %s in %s:%s',
-                        $error->getMessage(),
-                        $error->getFile(),
-                        $error->getLine()
-                    )
-                );
-                $this->displaySessionErrorNotice(
-                    $error->getMessage(),
-                    $error->getFile(),
-                    __FUNCTION__,
-                    $error->getLine()
-                );
-            } finally {
-                $this->restorePreviousErrorHandler($previous_handler);
-            }
-        }
-        return session_status();
-    }
-
-
-    /**
-     * @return void
-     * @throws Throwable
-     * @since 5.0.46
-     */
-    public function sessionStart(): void
-    {
-        session_start();
-        session_write_close();
-    }
-
-
-    /**
-     * @return void
-     * @throws ErrorException
-     * @since 5.0.46
-     */
-    private function verifySessionSavePath(): void
-    {
-        $session_save_path = session_save_path() ?: '';
-        // Normalize "N;/path" style values
-        if (strpos($session_save_path, ';') !== false) {
-            $parts             = explode(';', $session_save_path);
-            $session_save_path = end($parts);
-        }
-        $session_save_path = trim((string) $session_save_path);
-        if ($session_save_path === '') {
-            // fall back to a sane temp dir if PHP reports no explicit session_save_path
-            $session_save_path = sys_get_temp_dir();
-        }
-
-        // use the real filesystem path
-        $real_path = realpath($session_save_path) ?: $session_save_path;
-        if (! is_dir($real_path) || ! is_writable($real_path)) {
-            throw new ErrorException(
-                sprintf(
-                    esc_html__('Invalid or missing session save path: %s', 'event_espresso'),
-                    $session_save_path
-                ),
-                0,
-                E_WARNING,
-                __FILE__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * Returns `true` if the 'session.save_handler' ini setting matches a known custom handler
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function hasKnownCustomSessionSaveHandler(): bool
-    {
-        return strtolower((string) ini_get('session.save_handler')) === 'user';
-    }
-
-
-    /**
-     * Attempt to start the PHP session when a custom Session Save Handler is known to be set.
-     *
-     * @throws ErrorException
-     * @throws Throwable
-     * @since 4.9.68.p
-     */
-    private function checkCustomSessionSaveHandler(): void
-    {
-        // If we've already successfully tested the session save handler
-        // on a previous request then just start the session
-        if ($this->sessionSaveHandlerIsValid()) {
-            $this->sessionStart();
-            return;
-        }
-        // If not, then attempt to deal with any errors,
-        // otherwise, try to hobble along without the session
-        if (! $this->handleSessionSaveHandlerErrors()) {
-            return;
-        }
-        // there is no record of a fatal error while trying to start the session
-        // so let's see if there's a custom session save handler. Proceed with caution
-        if ($this->initializeSessionSaveHandlerStatus() === false) {
-            throw new ErrorException(
-                esc_html__('Failed to initialize session save handler status', 'event_espresso'),
-                0,
-                E_WARNING,
-                __FILE__,
-                __LINE__
-            );
-        }
-        // hold your breath, the custom session save handler might cause a fatal here...
-        $this->sessionStart();
-        // phew! we made it! the custom session handler is a-ok
-        if ($this->setSessionSaveHandlerStatusToValid() === false) {
-            throw new ErrorException(
-                esc_html__('Failed to set session save handler status to valid', 'event_espresso'),
-                0,
-                E_WARNING,
-                __FILE__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * retrieves the value for the 'ee_session_save_handler_status' WP option.
-     * default value = 'session_save_handler_untested'
-     *
-     * @return string
-     * @since 4.9.68.p
-     */
-    private function getSessionSaveHandlerStatus(): string
-    {
-        return get_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
-        );
-    }
-
-
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_failed'
-     * which can then be upgraded is everything works correctly
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function initializeSessionSaveHandlerStatus(): bool
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED
-        );
-    }
-
-
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_success'
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function setSessionSaveHandlerStatusToValid(): bool
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS
-        );
-    }
-
-
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_untested'
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function resetSessionSaveHandlerStatus(): bool
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
-        );
-    }
-
-
-    /**
-     * Returns `true` if the 'ee_session_save_handler_status' WP option value
-     * is equal to 'session_save_handler_success'
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function sessionSaveHandlerIsValid(): bool
-    {
-        return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS;
-    }
-
-
-    /**
-     * Returns `true` if the 'ee_session_save_handler_status' WP option value
-     * is equal to 'session_save_handler_failed'
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function sessionSaveHandlerFailed(): bool
-    {
-        return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED;
-    }
-
-
-    /**
-     * @param int    $severity
-     * @param string $message
-     * @param string $file
-     * @param int    $line
-     * @return bool
-     * @throws ErrorException
-     * @since 5.0.46
-     */
-    public function customErrorHandler(int $severity, string $message, string $file, int $line): bool
-    {
-        // Only convert warnings we care about
-        if (($severity & E_WARNING) === E_WARNING) {
-            throw new ErrorException($message, 0, $severity, $file, $line);
-        }
-        // fallback to PHP's normal handler for other severities
-        return false;
-    }
-
-
-    /**
-     * @param callable|null $previous_handler
-     * @return void
-     * @since 5.0.46
-     */
-    private function restorePreviousErrorHandler(?callable $previous_handler): void
-    {
-        if ($previous_handler !== null) {
-            set_error_handler($previous_handler);
-        } else {
-            restore_error_handler();
-        }
-    }
-
-
-    /**
-     * Returns `true` if no errors were detected with the session save handler,
-     * otherwise attempts to work notify the appropriate authorities
-     * with a suggestion for how to fix the issue, and returns `false`.
-     *
-     * @return bool
-     * @throws ErrorException
-     * @throws Throwable
-     * @since 4.9.68.p
-     */
-    private function handleSessionSaveHandlerErrors(): bool
-    {
-        // Check if we had a fatal error last time while trying to start the session
-        if ($this->sessionSaveHandlerFailed()) {
-            // apparently, last time we tried using the custom session save handler there was a fatal
-            if ($this->request->requestParamIsSet(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION)) {
-                if ($this->resetSessionSaveHandlerStatus() === false) {
-                    throw new ErrorException(
-                        esc_html__('Failed to reset session save handler status', 'event_espresso'),
-                        0,
-                        E_WARNING,
-                        __FILE__,
-                        __LINE__
-                    );
-                }
-                // remove "ee_retry_session", otherwise if the problem still isn't fixed,
-                // we'll just keep getting the fatal error over and over.
-                // Better to remove it and redirect, and try on the next request
-                EEH_URL::safeRedirectAndExit(
-                    remove_query_arg(
-                        [SessionStartHandler::REQUEST_PARAM_RETRY_SESSION],
-                        EEH_URL::current_url()
-                    )
-                );
-            }
-            // so the session is broken, don't try it again,
-            // just show a message to users that can fix it
-            $this->displaySessionSaveHandlerErrorNotice();
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @since 4.9.68.p
-     */
-    private function displaySessionSaveHandlerErrorNotice(): void
-    {
-        $retry_session_url = add_query_arg(
-            [SessionStartHandler::REQUEST_PARAM_RETRY_SESSION => true],
-            EEH_URL::current_url()
-        );
-        $this->displaySessionErrorNotice(
-            sprintf(
-                esc_html__(
-                    'It appears there was a fatal error while starting the session, so Event Espresso is not able to process registrations normally. Some hosting companies, like Pantheon, require an extra plugin for Event Espresso to work. Please install the %1$sWordPress Native PHP Sessions plugin%2$s, then %3$sclick here to check if the problem is resolved.%2$s',
-                    'event_espresso'
-                ),
-                '<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
-                '</a>',
-                '<a href="' . $retry_session_url . '">'
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * Generates an EE_Error notice regarding the current session woes
-     * but only if the current user is an admin with permission to 'install_plugins'.
-     *
-     * @since 5.0.46
-     */
-    private function displaySessionErrorNotice(string $message, string $file, string $function, int $line): void
-    {
-        if (current_user_can('install_plugins')) {
-            EE_Error::add_error($message, $file, $function, $line);
-        }
-    }
+	const OPTION_NAME_SESSION_SAVE_HANDLER_STATUS = 'ee_session_save_handler_status';
+
+	const REQUEST_PARAM_RETRY_SESSION             = 'ee_retry_session';
+
+	const SESSION_SAVE_HANDLER_STATUS_FAILED      = 'session_save_handler_failed';
+
+	const SESSION_SAVE_HANDLER_STATUS_SUCCESS     = 'session_save_handler_success';
+
+	const SESSION_SAVE_HANDLER_STATUS_UNKNOWN     = 'session_save_handler_untested';
+
+
+	protected RequestInterface $request;
+
+
+	/**
+	 * StartSession constructor.
+	 *
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * Check if a custom session save handler is in play
+	 * and attempt to start the PHP session
+	 *
+	 * @since 4.9.68.p
+	 */
+	public function startSession(): int
+	{
+		// check that session has started
+		if (session_id() === '') {
+			// clear any previous error
+			error_clear_last();
+
+			// convert warnings to ErrorException so we can catch them
+			$previous_handler = set_error_handler([$this, 'customErrorHandler'], E_WARNING);
+
+			try {
+				// starts a new session if one doesn't already exist, or re-initiates an existing one
+				if ($this->hasKnownCustomSessionSaveHandler()) {
+					$this->checkCustomSessionSaveHandler();
+				} else {
+					$this->verifySessionSavePath();
+					$this->sessionStart();
+				}
+			} catch (Throwable $error) {
+				error_log(
+					sprintf(
+						'[SessionStartHandler] session_start() warning: %s in %s:%s',
+						$error->getMessage(),
+						$error->getFile(),
+						$error->getLine()
+					)
+				);
+				$this->displaySessionErrorNotice(
+					$error->getMessage(),
+					$error->getFile(),
+					__FUNCTION__,
+					$error->getLine()
+				);
+			} finally {
+				$this->restorePreviousErrorHandler($previous_handler);
+			}
+		}
+		return session_status();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws Throwable
+	 * @since 5.0.46
+	 */
+	public function sessionStart(): void
+	{
+		session_start();
+		session_write_close();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws ErrorException
+	 * @since 5.0.46
+	 */
+	private function verifySessionSavePath(): void
+	{
+		$session_save_path = session_save_path() ?: '';
+		// Normalize "N;/path" style values
+		if (strpos($session_save_path, ';') !== false) {
+			$parts             = explode(';', $session_save_path);
+			$session_save_path = end($parts);
+		}
+		$session_save_path = trim((string) $session_save_path);
+		if ($session_save_path === '') {
+			// fall back to a sane temp dir if PHP reports no explicit session_save_path
+			$session_save_path = sys_get_temp_dir();
+		}
+
+		// use the real filesystem path
+		$real_path = realpath($session_save_path) ?: $session_save_path;
+		if (! is_dir($real_path) || ! is_writable($real_path)) {
+			throw new ErrorException(
+				sprintf(
+					esc_html__('Invalid or missing session save path: %s', 'event_espresso'),
+					$session_save_path
+				),
+				0,
+				E_WARNING,
+				__FILE__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * Returns `true` if the 'session.save_handler' ini setting matches a known custom handler
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function hasKnownCustomSessionSaveHandler(): bool
+	{
+		return strtolower((string) ini_get('session.save_handler')) === 'user';
+	}
+
+
+	/**
+	 * Attempt to start the PHP session when a custom Session Save Handler is known to be set.
+	 *
+	 * @throws ErrorException
+	 * @throws Throwable
+	 * @since 4.9.68.p
+	 */
+	private function checkCustomSessionSaveHandler(): void
+	{
+		// If we've already successfully tested the session save handler
+		// on a previous request then just start the session
+		if ($this->sessionSaveHandlerIsValid()) {
+			$this->sessionStart();
+			return;
+		}
+		// If not, then attempt to deal with any errors,
+		// otherwise, try to hobble along without the session
+		if (! $this->handleSessionSaveHandlerErrors()) {
+			return;
+		}
+		// there is no record of a fatal error while trying to start the session
+		// so let's see if there's a custom session save handler. Proceed with caution
+		if ($this->initializeSessionSaveHandlerStatus() === false) {
+			throw new ErrorException(
+				esc_html__('Failed to initialize session save handler status', 'event_espresso'),
+				0,
+				E_WARNING,
+				__FILE__,
+				__LINE__
+			);
+		}
+		// hold your breath, the custom session save handler might cause a fatal here...
+		$this->sessionStart();
+		// phew! we made it! the custom session handler is a-ok
+		if ($this->setSessionSaveHandlerStatusToValid() === false) {
+			throw new ErrorException(
+				esc_html__('Failed to set session save handler status to valid', 'event_espresso'),
+				0,
+				E_WARNING,
+				__FILE__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * retrieves the value for the 'ee_session_save_handler_status' WP option.
+	 * default value = 'session_save_handler_untested'
+	 *
+	 * @return string
+	 * @since 4.9.68.p
+	 */
+	private function getSessionSaveHandlerStatus(): string
+	{
+		return get_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
+		);
+	}
+
+
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_failed'
+	 * which can then be upgraded is everything works correctly
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function initializeSessionSaveHandlerStatus(): bool
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED
+		);
+	}
+
+
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_success'
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function setSessionSaveHandlerStatusToValid(): bool
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS
+		);
+	}
+
+
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_untested'
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function resetSessionSaveHandlerStatus(): bool
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
+		);
+	}
+
+
+	/**
+	 * Returns `true` if the 'ee_session_save_handler_status' WP option value
+	 * is equal to 'session_save_handler_success'
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function sessionSaveHandlerIsValid(): bool
+	{
+		return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS;
+	}
+
+
+	/**
+	 * Returns `true` if the 'ee_session_save_handler_status' WP option value
+	 * is equal to 'session_save_handler_failed'
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function sessionSaveHandlerFailed(): bool
+	{
+		return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED;
+	}
+
+
+	/**
+	 * @param int    $severity
+	 * @param string $message
+	 * @param string $file
+	 * @param int    $line
+	 * @return bool
+	 * @throws ErrorException
+	 * @since 5.0.46
+	 */
+	public function customErrorHandler(int $severity, string $message, string $file, int $line): bool
+	{
+		// Only convert warnings we care about
+		if (($severity & E_WARNING) === E_WARNING) {
+			throw new ErrorException($message, 0, $severity, $file, $line);
+		}
+		// fallback to PHP's normal handler for other severities
+		return false;
+	}
+
+
+	/**
+	 * @param callable|null $previous_handler
+	 * @return void
+	 * @since 5.0.46
+	 */
+	private function restorePreviousErrorHandler(?callable $previous_handler): void
+	{
+		if ($previous_handler !== null) {
+			set_error_handler($previous_handler);
+		} else {
+			restore_error_handler();
+		}
+	}
+
+
+	/**
+	 * Returns `true` if no errors were detected with the session save handler,
+	 * otherwise attempts to work notify the appropriate authorities
+	 * with a suggestion for how to fix the issue, and returns `false`.
+	 *
+	 * @return bool
+	 * @throws ErrorException
+	 * @throws Throwable
+	 * @since 4.9.68.p
+	 */
+	private function handleSessionSaveHandlerErrors(): bool
+	{
+		// Check if we had a fatal error last time while trying to start the session
+		if ($this->sessionSaveHandlerFailed()) {
+			// apparently, last time we tried using the custom session save handler there was a fatal
+			if ($this->request->requestParamIsSet(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION)) {
+				if ($this->resetSessionSaveHandlerStatus() === false) {
+					throw new ErrorException(
+						esc_html__('Failed to reset session save handler status', 'event_espresso'),
+						0,
+						E_WARNING,
+						__FILE__,
+						__LINE__
+					);
+				}
+				// remove "ee_retry_session", otherwise if the problem still isn't fixed,
+				// we'll just keep getting the fatal error over and over.
+				// Better to remove it and redirect, and try on the next request
+				EEH_URL::safeRedirectAndExit(
+					remove_query_arg(
+						[SessionStartHandler::REQUEST_PARAM_RETRY_SESSION],
+						EEH_URL::current_url()
+					)
+				);
+			}
+			// so the session is broken, don't try it again,
+			// just show a message to users that can fix it
+			$this->displaySessionSaveHandlerErrorNotice();
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @since 4.9.68.p
+	 */
+	private function displaySessionSaveHandlerErrorNotice(): void
+	{
+		$retry_session_url = add_query_arg(
+			[SessionStartHandler::REQUEST_PARAM_RETRY_SESSION => true],
+			EEH_URL::current_url()
+		);
+		$this->displaySessionErrorNotice(
+			sprintf(
+				esc_html__(
+					'It appears there was a fatal error while starting the session, so Event Espresso is not able to process registrations normally. Some hosting companies, like Pantheon, require an extra plugin for Event Espresso to work. Please install the %1$sWordPress Native PHP Sessions plugin%2$s, then %3$sclick here to check if the problem is resolved.%2$s',
+					'event_espresso'
+				),
+				'<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
+				'</a>',
+				'<a href="' . $retry_session_url . '">'
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * Generates an EE_Error notice regarding the current session woes
+	 * but only if the current user is an admin with permission to 'install_plugins'.
+	 *
+	 * @since 5.0.46
+	 */
+	private function displaySessionErrorNotice(string $message, string $file, string $function, int $line): void
+	{
+		if (current_user_can('install_plugins')) {
+			EE_Error::add_error($message, $file, $function, $line);
+		}
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -134,7 +134,7 @@ 
 
         // use the real filesystem path
         $real_path = realpath($session_save_path) ?: $session_save_path;
-        if (! is_dir($real_path) || ! is_writable($real_path)) {
+        if ( ! is_dir($real_path) || ! is_writable($real_path)) {
             throw new ErrorException(
                 sprintf(
                     esc_html__('Invalid or missing session save path: %s', 'event_espresso'),
@@ -178,7 +178,7 @@ 
         }
         // If not, then attempt to deal with any errors,
         // otherwise, try to hobble along without the session
-        if (! $this->handleSessionSaveHandlerErrors()) {
+        if ( ! $this->handleSessionSaveHandlerErrors()) {
             return;
         }
         // there is no record of a fatal error while trying to start the session
@@ -391,7 +391,7 @@ 
                 ),
                 '<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
                 '</a>',
-                '<a href="' . $retry_session_url . '">'
+                '<a href="'.$retry_session_url.'">'
             ),
             __FILE__,
             __FUNCTION__,

caffeinated/core/libraries/messages/message_type/newsletter/EE_Newsletter_message_type.class.php

Indentation +185 added lines, -185 removed lines

@@ -12,189 +12,189 @@
  */
 class EE_Newsletter_message_type extends EE_message_type
 {
-    public function __construct()
-    {
-        $this->name              = 'newsletter';
-        $this->description       = esc_html__(
-            'Batch message type messages are triggered manually by the admin for sending notifications to a selected group of recipients. This should only be used for more general notification type messages that contain information specific for the recipients. For "newsletter" type messages we recommend using an email list service like MailChimp, because sending non-related mail-outs to contacts increases the risk of your site domain getting added to spam lists, which will prevent messages getting to users.',
-            'event_espresso'
-        );
-        $this->label             = [
-            'singular' => esc_html__('batch', 'event_espresso'),
-            'plural'   => esc_html__('batches', 'event_espresso'),
-        ];
-        $this->_master_templates = [
-            'email' => 'registration',
-        ];
-
-        parent::__construct();
-    }
-
-
-    /**
-     * Sets admin_registered_pages property
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = []; // no admin pages to register this with.
-    }
-
-
-    /**
-     * Sets property related to data handler.
-     */
-    protected function _set_data_handler()
-    {
-        $this->_data_handler   = 'Registrations';
-        $this->_single_message = $this->_data instanceof EE_Registration;
-    }
-
-
-    /**
-     * Returns the data for the given context for this message type.
-     *
-     * @param string          $context
-     * @param EE_Registration $registration
-     * @param int             $id
-     * @return array
-     */
-    protected function _get_data_for_context($context, EE_Registration $registration, $id)
-    {
-        // newsletter message type data handler is 'Registrations' and it expects an array of EE_Registration objects.
-        return [$registration];
-    }
-
-
-    /**
-     * Sets the admin settings fields property for this message type.
-     */
-    protected function _set_admin_settings_fields()
-    {
-        $this->_admin_settings_fields = [];
-    }
-
-
-    /**
-     * Sets the contexts for this message type.
-     */
-    protected function _set_contexts()
-    {
-        $this->_context_label = [
-            'label'       => esc_html__('recipient', 'event_espresso'),
-            'plural'      => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will receive the message.', 'event_espresso'),
-        ];
-
-        $this->_contexts = [
-            'attendee' => [
-                'label'       => esc_html__('Registrant', 'event_espresso'),
-                'description' => esc_html__('This template goes to selected registrants.', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     * used to set the valid shortcodes.
-     * For the newsletter message type we only have two valid shortcode libraries in use, recipient details and
-     * organization.  That's it!
-     *
-     * @return  void
-     * @since   4.3.0
-     */
-    protected function _set_valid_shortcodes()
-    {
-        parent::_set_valid_shortcodes();
-
-        $included_shortcodes = [
-            'recipient_details',
-            'organization',
-            'newsletter',
-        ];
-
-        foreach ($this->_valid_shortcodes as $context => $shortcodes) {
-            foreach ($shortcodes as $key => $shortcode) {
-                if (! in_array($shortcode, $included_shortcodes, true)) {
-                    unset($this->_valid_shortcodes[ $context ][ $key ]);
-                }
-            }
-            $this->_valid_shortcodes[ $context ][] = 'newsletter';
-        }
-    }
-
-
-    /**
-     * Override default _attendee_addressees in EE_message_type because we want to loop through the registrations
-     * for EE_message_type.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _attendee_addressees()
-    {
-        $addressee = [];
-
-        // looping through registrations
-        foreach ($this->_data->registrations as $details) {
-            // set $attendee array to blank on each loop
-            $aee = [];
-
-            // need to get the attendee from this registration.
-            $attendee = isset($details['att_obj']) && $details['att_obj'] instanceof EE_Attendee
-                ? $details['att_obj']
-                : null;
-
-            if (! $attendee instanceof EE_Attendee) {
-                continue;
-            }
-
-            // set $aee from attendee object
-            $aee['att_obj']        = $attendee;
-            $aee['reg_objs']       = isset($this->_data->attendees[ $attendee->ID() ]['reg_objs'])
-                ? $this->_data->attendees[ $attendee->ID() ]['reg_objs']
-                : [];
-            $aee['attendee_email'] = $attendee->email();
-            $aee['tkt_objs']       = isset($this->_data->attendees[ $attendee->ID() ]['tkt_objs'])
-                ? $this->_data->attendees[ $attendee->ID() ]['tkt_objs']
-                : [];
-
-            if (isset($this->_data->attendees[ $attendee->ID() ]['evt_objs'])) {
-                $aee['evt_objs'] = $this->_data->attendees[ $attendee->ID() ]['evt_objs'];
-                $aee['events']   = $this->_data->attendees[ $attendee->ID() ]['evt_objs'];
-            } else {
-                $aee['evt_objs'] = $aee['events'] = [];
-            }
-
-            $aee['reg_obj']   = $details['reg_obj'] ?? null;
-            $aee['attendees'] = $this->_data->attendees;
-
-            // merge in the primary attendee data
-            $aee = array_merge($this->_default_addressee_data, $aee);
-
-            // make sure txn is set
-            if (empty($aee['txn']) && $aee['reg_obj'] instanceof EE_Registration) {
-                $aee['txn'] = $aee['reg_obj']->transaction();
-            }
-
-            $addressee[] = new EE_Messages_Addressee($aee);
-        }
-        return $addressee;
-    }
-
-
-    /**
-     * Allows a message type to specifically exclude template fields for the provided messenger.
-     * Filtered so this can be programmatically altered as well.
-     *
-     * @param string $messenger_name name of messenger
-     * @return array
-     */
-    public function excludedFieldsForMessenger($messenger_name)
-    {
-        $excluded_fields = [
-            'email' => ['cc'],
-        ];
-        return $excluded_fields[ $messenger_name ] ?? parent::excludedFieldsForMessenger($messenger_name);
-    }
+	public function __construct()
+	{
+		$this->name              = 'newsletter';
+		$this->description       = esc_html__(
+			'Batch message type messages are triggered manually by the admin for sending notifications to a selected group of recipients. This should only be used for more general notification type messages that contain information specific for the recipients. For "newsletter" type messages we recommend using an email list service like MailChimp, because sending non-related mail-outs to contacts increases the risk of your site domain getting added to spam lists, which will prevent messages getting to users.',
+			'event_espresso'
+		);
+		$this->label             = [
+			'singular' => esc_html__('batch', 'event_espresso'),
+			'plural'   => esc_html__('batches', 'event_espresso'),
+		];
+		$this->_master_templates = [
+			'email' => 'registration',
+		];
+
+		parent::__construct();
+	}
+
+
+	/**
+	 * Sets admin_registered_pages property
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = []; // no admin pages to register this with.
+	}
+
+
+	/**
+	 * Sets property related to data handler.
+	 */
+	protected function _set_data_handler()
+	{
+		$this->_data_handler   = 'Registrations';
+		$this->_single_message = $this->_data instanceof EE_Registration;
+	}
+
+
+	/**
+	 * Returns the data for the given context for this message type.
+	 *
+	 * @param string          $context
+	 * @param EE_Registration $registration
+	 * @param int             $id
+	 * @return array
+	 */
+	protected function _get_data_for_context($context, EE_Registration $registration, $id)
+	{
+		// newsletter message type data handler is 'Registrations' and it expects an array of EE_Registration objects.
+		return [$registration];
+	}
+
+
+	/**
+	 * Sets the admin settings fields property for this message type.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+		$this->_admin_settings_fields = [];
+	}
+
+
+	/**
+	 * Sets the contexts for this message type.
+	 */
+	protected function _set_contexts()
+	{
+		$this->_context_label = [
+			'label'       => esc_html__('recipient', 'event_espresso'),
+			'plural'      => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will receive the message.', 'event_espresso'),
+		];
+
+		$this->_contexts = [
+			'attendee' => [
+				'label'       => esc_html__('Registrant', 'event_espresso'),
+				'description' => esc_html__('This template goes to selected registrants.', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 * used to set the valid shortcodes.
+	 * For the newsletter message type we only have two valid shortcode libraries in use, recipient details and
+	 * organization.  That's it!
+	 *
+	 * @return  void
+	 * @since   4.3.0
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		parent::_set_valid_shortcodes();
+
+		$included_shortcodes = [
+			'recipient_details',
+			'organization',
+			'newsletter',
+		];
+
+		foreach ($this->_valid_shortcodes as $context => $shortcodes) {
+			foreach ($shortcodes as $key => $shortcode) {
+				if (! in_array($shortcode, $included_shortcodes, true)) {
+					unset($this->_valid_shortcodes[ $context ][ $key ]);
+				}
+			}
+			$this->_valid_shortcodes[ $context ][] = 'newsletter';
+		}
+	}
+
+
+	/**
+	 * Override default _attendee_addressees in EE_message_type because we want to loop through the registrations
+	 * for EE_message_type.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _attendee_addressees()
+	{
+		$addressee = [];
+
+		// looping through registrations
+		foreach ($this->_data->registrations as $details) {
+			// set $attendee array to blank on each loop
+			$aee = [];
+
+			// need to get the attendee from this registration.
+			$attendee = isset($details['att_obj']) && $details['att_obj'] instanceof EE_Attendee
+				? $details['att_obj']
+				: null;
+
+			if (! $attendee instanceof EE_Attendee) {
+				continue;
+			}
+
+			// set $aee from attendee object
+			$aee['att_obj']        = $attendee;
+			$aee['reg_objs']       = isset($this->_data->attendees[ $attendee->ID() ]['reg_objs'])
+				? $this->_data->attendees[ $attendee->ID() ]['reg_objs']
+				: [];
+			$aee['attendee_email'] = $attendee->email();
+			$aee['tkt_objs']       = isset($this->_data->attendees[ $attendee->ID() ]['tkt_objs'])
+				? $this->_data->attendees[ $attendee->ID() ]['tkt_objs']
+				: [];
+
+			if (isset($this->_data->attendees[ $attendee->ID() ]['evt_objs'])) {
+				$aee['evt_objs'] = $this->_data->attendees[ $attendee->ID() ]['evt_objs'];
+				$aee['events']   = $this->_data->attendees[ $attendee->ID() ]['evt_objs'];
+			} else {
+				$aee['evt_objs'] = $aee['events'] = [];
+			}
+
+			$aee['reg_obj']   = $details['reg_obj'] ?? null;
+			$aee['attendees'] = $this->_data->attendees;
+
+			// merge in the primary attendee data
+			$aee = array_merge($this->_default_addressee_data, $aee);
+
+			// make sure txn is set
+			if (empty($aee['txn']) && $aee['reg_obj'] instanceof EE_Registration) {
+				$aee['txn'] = $aee['reg_obj']->transaction();
+			}
+
+			$addressee[] = new EE_Messages_Addressee($aee);
+		}
+		return $addressee;
+	}
+
+
+	/**
+	 * Allows a message type to specifically exclude template fields for the provided messenger.
+	 * Filtered so this can be programmatically altered as well.
+	 *
+	 * @param string $messenger_name name of messenger
+	 * @return array
+	 */
+	public function excludedFieldsForMessenger($messenger_name)
+	{
+		$excluded_fields = [
+			'email' => ['cc'],
+		];
+		return $excluded_fields[ $messenger_name ] ?? parent::excludedFieldsForMessenger($messenger_name);
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -19,7 +19,7 @@ 
             'Batch message type messages are triggered manually by the admin for sending notifications to a selected group of recipients. This should only be used for more general notification type messages that contain information specific for the recipients. For "newsletter" type messages we recommend using an email list service like MailChimp, because sending non-related mail-outs to contacts increases the risk of your site domain getting added to spam lists, which will prevent messages getting to users.',
             'event_espresso'
         );
-        $this->label             = [
+        $this->label = [
             'singular' => esc_html__('batch', 'event_espresso'),
             'plural'   => esc_html__('batches', 'event_espresso'),
         ];
@@ -114,11 +114,11 @@ 
 
         foreach ($this->_valid_shortcodes as $context => $shortcodes) {
             foreach ($shortcodes as $key => $shortcode) {
-                if (! in_array($shortcode, $included_shortcodes, true)) {
-                    unset($this->_valid_shortcodes[ $context ][ $key ]);
+                if ( ! in_array($shortcode, $included_shortcodes, true)) {
+                    unset($this->_valid_shortcodes[$context][$key]);
                 }
             }
-            $this->_valid_shortcodes[ $context ][] = 'newsletter';
+            $this->_valid_shortcodes[$context][] = 'newsletter';
         }
     }
 
@@ -145,23 +145,23 @@ 
                 ? $details['att_obj']
                 : null;
 
-            if (! $attendee instanceof EE_Attendee) {
+            if ( ! $attendee instanceof EE_Attendee) {
                 continue;
             }
 
             // set $aee from attendee object
             $aee['att_obj']        = $attendee;
-            $aee['reg_objs']       = isset($this->_data->attendees[ $attendee->ID() ]['reg_objs'])
-                ? $this->_data->attendees[ $attendee->ID() ]['reg_objs']
+            $aee['reg_objs']       = isset($this->_data->attendees[$attendee->ID()]['reg_objs'])
+                ? $this->_data->attendees[$attendee->ID()]['reg_objs']
                 : [];
             $aee['attendee_email'] = $attendee->email();
-            $aee['tkt_objs']       = isset($this->_data->attendees[ $attendee->ID() ]['tkt_objs'])
-                ? $this->_data->attendees[ $attendee->ID() ]['tkt_objs']
+            $aee['tkt_objs']       = isset($this->_data->attendees[$attendee->ID()]['tkt_objs'])
+                ? $this->_data->attendees[$attendee->ID()]['tkt_objs']
                 : [];
 
-            if (isset($this->_data->attendees[ $attendee->ID() ]['evt_objs'])) {
-                $aee['evt_objs'] = $this->_data->attendees[ $attendee->ID() ]['evt_objs'];
-                $aee['events']   = $this->_data->attendees[ $attendee->ID() ]['evt_objs'];
+            if (isset($this->_data->attendees[$attendee->ID()]['evt_objs'])) {
+                $aee['evt_objs'] = $this->_data->attendees[$attendee->ID()]['evt_objs'];
+                $aee['events']   = $this->_data->attendees[$attendee->ID()]['evt_objs'];
             } else {
                 $aee['evt_objs'] = $aee['events'] = [];
             }
@@ -195,6 +195,6 @@ 
         $excluded_fields = [
             'email' => ['cc'],
         ];
-        return $excluded_fields[ $messenger_name ] ?? parent::excludedFieldsForMessenger($messenger_name);
+        return $excluded_fields[$messenger_name] ?? parent::excludedFieldsForMessenger($messenger_name);
     }
 }