eventespresso / event-espresso-core

core/middleware/EE_Alpha_Banner_Warning.core.php

Indentation +77 added lines, -77 removed lines

@@ -14,87 +14,87 @@
 {
 
 
-    /**
-     * @deprecated 4.9.53
-     * @param    EE_Request  $request
-     * @param    EE_Response $response
-     * @return    EE_Response
-     */
-    public function handle_request(EE_Request $request, EE_Response $response)
-    {
-        $this->_request = $request;
-        $this->_response = $response;
-        $this->display_alpha_banner_warning();
-        $this->_response = $this->process_request_stack($this->_request, $this->_response);
-        return $this->_response;
-    }
+	/**
+	 * @deprecated 4.9.53
+	 * @param    EE_Request  $request
+	 * @param    EE_Response $response
+	 * @return    EE_Response
+	 */
+	public function handle_request(EE_Request $request, EE_Response $response)
+	{
+		$this->_request = $request;
+		$this->_response = $response;
+		$this->display_alpha_banner_warning();
+		$this->_response = $this->process_request_stack($this->_request, $this->_response);
+		return $this->_response;
+	}
 
 
-    /**
-     * @deprecated
-     * @return    string
-     */
-    public function display_alpha_banner_warning()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\middleware\PreProductionVersionWarning::displayPreProductionVersionWarning()',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.52',
-            '4.10.0'
-        );
-    }
+	/**
+	 * @deprecated
+	 * @return    string
+	 */
+	public function display_alpha_banner_warning()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\middleware\PreProductionVersionWarning::displayPreProductionVersionWarning()',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.52',
+			'4.10.0'
+		);
+	}
 
 
-    /**
-     * @deprecated
-     * @return void
-     */
-    public function alpha_banner_admin_notice()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\middleware\PreProductionVersionWarning::preProductionVersionAdminNotice()',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.52',
-            '4.10.0'
-        );
-    }
+	/**
+	 * @deprecated
+	 * @return void
+	 */
+	public function alpha_banner_admin_notice()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\middleware\PreProductionVersionWarning::preProductionVersionAdminNotice()',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.52',
+			'4.10.0'
+		);
+	}
 
 
-    /**
-     * @deprecated
-     * @return void
-     */
-    public function alpha_banner_warning_notice()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\middleware\PreProductionVersionWarning::preProductionVersionWarningNotice()',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.52',
-            '4.10.0'
-        );
-    }
+	/**
+	 * @deprecated
+	 * @return void
+	 */
+	public function alpha_banner_warning_notice()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\middleware\PreProductionVersionWarning::preProductionVersionWarningNotice()',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.52',
+			'4.10.0'
+		);
+	}
 }

core/EE_Encryption.core.php

Spacing +11 added lines, -11 removed lines

@@ -103,7 +103,7 @@ 
      */
     protected function __construct()
     {
-        if (! defined('ESPRESSO_ENCRYPT')) {
+        if ( ! defined('ESPRESSO_ENCRYPT')) {
             define('ESPRESSO_ENCRYPT', true);
         }
         if (extension_loaded('openssl')) {
@@ -125,7 +125,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! EE_Encryption::$_instance instanceof EE_Encryption) {
+        if ( ! EE_Encryption::$_instance instanceof EE_Encryption) {
             EE_Encryption::$_instance = new self();
         }
         return EE_Encryption::$_instance;
@@ -332,7 +332,7 @@ 
             $iv
         );
         // append the initialization vector
-        $encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER . $iv;
+        $encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER.$iv;
         // trim and maybe encode
         return $this->_use_base64_encode
             ? trim(base64_encode($encrypted_text))
@@ -525,8 +525,8 @@ 
         );
         $string_bits = str_split($text_string);
         foreach ($string_bits as $k => $v) {
-            $temp = ord($v) + ord($key_bits[ $k ]);
-            $string_bits[ $k ] = chr($temp > 255 ? ($temp - 256) : $temp);
+            $temp = ord($v) + ord($key_bits[$k]);
+            $string_bits[$k] = chr($temp > 255 ? ($temp - 256) : $temp);
         }
         $encrypted_text = implode('', $string_bits);
         $encrypted_text .= EE_Encryption::ACME_ENCRYPTION_FLAG;
@@ -570,8 +570,8 @@ 
         );
         $string_bits = str_split($encrypted_text);
         foreach ($string_bits as $k => $v) {
-            $temp = ord($v) - ord($key_bits[ $k ]);
-            $string_bits[ $k ] = chr($temp < 0 ? ($temp + 256) : $temp);
+            $temp = ord($v) - ord($key_bits[$k]);
+            $string_bits[$k] = chr($temp < 0 ? ($temp + 256) : $temp);
         }
         return implode('', $string_bits);
     }
@@ -585,16 +585,16 @@ 
     protected function valid_base_64($string)
     {
         // ensure data is a string
-        if (! is_string($string) || ! $this->_use_base64_encode) {
+        if ( ! is_string($string) || ! $this->_use_base64_encode) {
             return false;
         }
         $decoded = base64_decode($string, true);
         // Check if there is no invalid character in string
-        if (! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
+        if ( ! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
             return false;
         }
         // Decode the string in strict mode and send the response
-        if (! base64_decode($string, true)) {
+        if ( ! base64_decode($string, true)) {
             return false;
         }
         // Encode and compare it to original one
@@ -614,7 +614,7 @@ 
         $iterations = ceil($length / 40);
         $random_string = '';
         for ($i = 0; $i < $iterations; $i++) {
-            $random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
+            $random_string .= sha1(microtime(true).mt_rand(10000, 90000));
         }
         $random_string = substr($random_string, 0, $length);
         return $random_string;

Indentation +577 added lines, -577 removed lines

@@ -25,581 +25,581 @@
 class EE_Encryption implements InterminableInterface
 {
 
-    /**
-     * key used for saving the encryption key to the wp_options table
-     */
-    const ENCRYPTION_OPTION_KEY = 'ee_encryption_key';
-
-    /**
-     * the OPENSSL cipher method used
-     */
-    const OPENSSL_CIPHER_METHOD = 'AES-128-CBC';
-
-    /**
-     * WP "options_name" used to store a verified available cipher method
-     */
-    const OPENSSL_CIPHER_METHOD_OPTION_NAME = 'ee_openssl_cipher_method';
-
-    /**
-     * the OPENSSL digest method used
-     */
-    const OPENSSL_DIGEST_METHOD = 'sha512';
-
-    /**
-     * separates the encrypted text from the initialization vector
-     */
-    const OPENSSL_IV_DELIMITER = ':iv:';
-
-    /**
-     * appended to text encrypted using the acme encryption
-     */
-    const ACME_ENCRYPTION_FLAG = '::ae';
-
-
-    /**
-     * instance of the EE_Encryption object
-     */
-    protected static $_instance;
-
-    /**
-     * @var string $_encryption_key
-     */
-    protected $_encryption_key;
-
-    /**
-     * @var string $cipher_method
-     */
-    private $cipher_method = '';
-
-    /**
-     * @var array $cipher_methods
-     */
-    private $cipher_methods = array();
-
-    /**
-     * @var array $digest_methods
-     */
-    private $digest_methods = array();
-
-    /**
-     * @var boolean $_use_openssl_encrypt
-     */
-    protected $_use_openssl_encrypt = false;
-
-    /**
-     * @var boolean $_use_base64_encode
-     */
-    protected $_use_base64_encode = false;
-
-
-    /**
-     * protected constructor to prevent direct creation
-     */
-    protected function __construct()
-    {
-        if (! defined('ESPRESSO_ENCRYPT')) {
-            define('ESPRESSO_ENCRYPT', true);
-        }
-        if (extension_loaded('openssl')) {
-            $this->_use_openssl_encrypt = true;
-        }
-        if (function_exists('base64_encode')) {
-            $this->_use_base64_encode = true;
-        }
-    }
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @return EE_Encryption
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! EE_Encryption::$_instance instanceof EE_Encryption) {
-            EE_Encryption::$_instance = new self();
-        }
-        return EE_Encryption::$_instance;
-    }
-
-
-    /**
-     * get encryption key
-     *
-     * @return string
-     */
-    public function get_encryption_key()
-    {
-        // if encryption key has not been set
-        if (empty($this->_encryption_key)) {
-            // retrieve encryption_key from db
-            $this->_encryption_key = get_option(EE_Encryption::ENCRYPTION_OPTION_KEY, '');
-            // WHAT?? No encryption_key in the db ??
-            if ($this->_encryption_key === '') {
-                // let's make one. And md5 it to make it just the right size for a key
-                $new_key = md5($this->generate_random_string());
-                // now save it to the db for later
-                add_option(EE_Encryption::ENCRYPTION_OPTION_KEY, $new_key);
-                // here's the key - FINALLY !
-                $this->_encryption_key = $new_key;
-            }
-        }
-        return $this->_encryption_key;
-    }
-
-
-    /**
-     * encrypts data
-     *
-     * @param string $text_string - the text to be encrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    public function encrypt($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        if ($this->_use_openssl_encrypt) {
-            $encrypted_text = $this->openssl_encrypt($text_string);
-        } else {
-            $encrypted_text = $this->acme_encrypt($text_string);
-        }
-        return $encrypted_text;
-    }
-
-
-    /**
-     * decrypts data
-     *
-     * @param string $encrypted_text - the text to be decrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    public function decrypt($encrypted_text = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // if PHP's mcrypt functions are installed then we'll use them
-        if ($this->_use_openssl_encrypt) {
-            $decrypted_text = $this->openssl_decrypt($encrypted_text);
-        } else {
-            $decrypted_text = $this->acme_decrypt($encrypted_text);
-        }
-        return $decrypted_text;
-    }
-
-
-    /**
-     * encodes string with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $text_string the text to be encoded
-     * @return string
-     */
-    public function base64_string_encode($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string) || ! $this->_use_base64_encode) {
-            return $text_string;
-        }
-        // encode
-        return base64_encode($text_string);
-    }
-
-
-    /**
-     * decodes string that has been encoded with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $encoded_string the text to be decoded
-     * @return string
-     * @throws RuntimeException
-     */
-    public function base64_string_decode($encoded_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
-            return $encoded_string;
-        }
-        // decode
-        $decoded_string = base64_decode($encoded_string);
-        if ($decoded_string === false) {
-            throw new RuntimeException(
-                esc_html__('Base 64 decoding failed.', 'event_espresso')
-            );
-        }
-        return $decoded_string;
-    }
-
-
-    /**
-     * encodes  url string with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $text_string the text to be encoded
-     * @return string
-     */
-    public function base64_url_encode($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string) || ! $this->_use_base64_encode) {
-            return $text_string;
-        }
-        // encode
-        $encoded_string = base64_encode($text_string);
-        // remove chars to make encoding more URL friendly
-        return strtr($encoded_string, '+/=', '-_,');
-    }
-
-
-    /**
-     * decodes  url string that has been encoded with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $encoded_string the text to be decoded
-     * @return string
-     * @throws RuntimeException
-     */
-    public function base64_url_decode($encoded_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
-            return $encoded_string;
-        }
-        // replace previously removed characters
-        $encoded_string = strtr($encoded_string, '-_,', '+/=');
-        // decode
-        $decoded_string = base64_decode($encoded_string);
-        if ($decoded_string === false) {
-            throw new RuntimeException(
-                esc_html__('Base 64 decoding failed.', 'event_espresso')
-            );
-        }
-        return $decoded_string;
-    }
-
-
-    /**
-     * encrypts data using PHP's openssl functions
-     *
-     * @param string $text_string the text to be encrypted
-     * @param string $cipher_method
-     * @param string $encryption_key
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function openssl_encrypt(
-        $text_string = '',
-        $cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
-        $encryption_key = ''
-    ) {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        $this->cipher_method = $this->getCipherMethod($cipher_method);
-        // get initialization vector size
-        $iv_size = openssl_cipher_iv_length($this->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_size, $is_strong);
-        if ($iv === false || $is_strong === false) {
-            throw new RuntimeException(
-                esc_html__('Failed to generate OpenSSL initialization vector.', 'event_espresso')
-            );
-        }
-        // encrypt it
-        $encrypted_text = openssl_encrypt(
-            $text_string,
-            $this->cipher_method,
-            $this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
-            0,
-            $iv
-        );
-        // append the initialization vector
-        $encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER . $iv;
-        // trim and maybe encode
-        return $this->_use_base64_encode
-            ? trim(base64_encode($encrypted_text))
-            : trim($encrypted_text);
-    }
-
-
-    /**
-     * 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
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function getCipherMethod($cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD)
-    {
-        if ($this->cipher_method !== '') {
-            return $this->cipher_method;
-        }
-        // verify that the default cipher method can produce an initialization vector
-        if (openssl_cipher_iv_length($cipher_method) === false) {
-            // nope? okay let's get what we found in the past to work
-            $cipher_method = get_option(EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME, '');
-            // oops... haven't tested available cipher methods yet
-            if ($cipher_method === '' || openssl_cipher_iv_length($cipher_method) === false) {
-                $cipher_method = $this->getAvailableCipherMethod($cipher_method);
-            }
-        }
-        return $cipher_method;
-    }
-
-
-    /**
-     * @param string $cipher_method
-     * @return string
-     * @throws \RuntimeException
-     */
-    protected function getAvailableCipherMethod($cipher_method)
-    {
-        // verify that the incoming cipher method can produce an initialization vector
-        if (openssl_cipher_iv_length($cipher_method) === false) {
-            // nope? then check the next cipher in the list of available cipher methods
-            $cipher_method = next($this->cipher_methods);
-            // what? there's no list? then generate that list and cache it,
-            if (empty($this->cipher_methods)) {
-                $this->cipher_methods = openssl_get_cipher_methods();
-                // then grab the first item from the list
-                $cipher_method = reset($this->cipher_methods);
-            }
-            if ($cipher_method === false) {
-                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);
-        }
-        // if we've gotten this far, then we found an available cipher method that works
-        // so save that for next time
-        update_option(
-            EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME,
-            $cipher_method
-        );
-        return $cipher_method;
-    }
-
-
-    /**
-     * decrypts data that has been encrypted with PHP's openssl functions
-     *
-     * @param string $encrypted_text the text to be decrypted
-     * @param string $cipher_method
-     * @param string $encryption_key
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function openssl_decrypt(
-        $encrypted_text = '',
-        $cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
-        $encryption_key = ''
-    ) {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // decode
-        $encrypted_text = $this->valid_base_64($encrypted_text)
-            ? $this->base64_url_decode($encrypted_text)
-            : $encrypted_text;
-        $encrypted_components = explode(
-            EE_Encryption::OPENSSL_IV_DELIMITER,
-            $encrypted_text,
-            2
-        );
-        // decrypt it
-        $decrypted_text = openssl_decrypt(
-            $encrypted_components[0],
-            $this->getCipherMethod($cipher_method),
-            $this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
-            0,
-            $encrypted_components[1]
-        );
-        $decrypted_text = trim($decrypted_text);
-        return $decrypted_text;
-    }
-
-
-    /**
-     * 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 $digest_method
-     * @param string $encryption_key
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function getDigestHashValue($digest_method = EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key = '')
-    {
-        $encryption_key = $encryption_key !== ''
-            ? $encryption_key
-            : $this->get_encryption_key();
-        $digest_hash_value = openssl_digest($encryption_key, $digest_method);
-        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
-     */
-    protected 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;
-    }
-
-
-    /**
-     * encrypts data for acme servers that didn't bother to install PHP mcrypt
-     *
-     * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
-     * @param string $text_string the text to be decrypted
-     * @return string
-     */
-    protected function acme_encrypt($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        $key_bits = str_split(
-            str_pad(
-                '',
-                strlen($text_string),
-                $this->get_encryption_key(),
-                STR_PAD_RIGHT
-            )
-        );
-        $string_bits = str_split($text_string);
-        foreach ($string_bits as $k => $v) {
-            $temp = ord($v) + ord($key_bits[ $k ]);
-            $string_bits[ $k ] = chr($temp > 255 ? ($temp - 256) : $temp);
-        }
-        $encrypted_text = implode('', $string_bits);
-        $encrypted_text .= EE_Encryption::ACME_ENCRYPTION_FLAG;
-        return $this->_use_base64_encode
-            ? base64_encode($encrypted_text)
-            : $encrypted_text;
-    }
-
-
-    /**
-     * decrypts data for acme servers that didn't bother to install PHP mcrypt
-     *
-     * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
-     * @param string $encrypted_text the text to be decrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function acme_decrypt($encrypted_text = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // decode the data ?
-        $encrypted_text = $this->valid_base_64($encrypted_text)
-            ? $this->base64_url_decode($encrypted_text)
-            : $encrypted_text;
-        $encrypted_text = substr($encrypted_text, 0, -4);
-        $key_bits = str_split(
-            str_pad(
-                '',
-                strlen($encrypted_text),
-                $this->get_encryption_key(),
-                STR_PAD_RIGHT
-            )
-        );
-        $string_bits = str_split($encrypted_text);
-        foreach ($string_bits as $k => $v) {
-            $temp = ord($v) - ord($key_bits[ $k ]);
-            $string_bits[ $k ] = chr($temp < 0 ? ($temp + 256) : $temp);
-        }
-        return implode('', $string_bits);
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/2556345/detect-base64-encoding-in-php#30231906
-     * @param $string
-     * @return bool
-     */
-    protected function valid_base_64($string)
-    {
-        // ensure data is a string
-        if (! is_string($string) || ! $this->_use_base64_encode) {
-            return false;
-        }
-        $decoded = base64_decode($string, true);
-        // Check if there is no invalid character in string
-        if (! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
-            return false;
-        }
-        // Decode the string in strict mode and send the response
-        if (! base64_decode($string, true)) {
-            return false;
-        }
-        // Encode and compare it to original one
-        return base64_encode($decoded) === $string;
-    }
-
-
-    /**
-     * generate random string
-     *
-     * @see http://stackoverflow.com/questions/637278/what-is-the-best-way-to-generate-a-random-key-within-php
-     * @param int $length number of characters for random string
-     * @return string
-     */
-    public function generate_random_string($length = 40)
-    {
-        $iterations = ceil($length / 40);
-        $random_string = '';
-        for ($i = 0; $i < $iterations; $i++) {
-            $random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
-        }
-        $random_string = substr($random_string, 0, $length);
-        return $random_string;
-    }
+	/**
+	 * key used for saving the encryption key to the wp_options table
+	 */
+	const ENCRYPTION_OPTION_KEY = 'ee_encryption_key';
+
+	/**
+	 * the OPENSSL cipher method used
+	 */
+	const OPENSSL_CIPHER_METHOD = 'AES-128-CBC';
+
+	/**
+	 * WP "options_name" used to store a verified available cipher method
+	 */
+	const OPENSSL_CIPHER_METHOD_OPTION_NAME = 'ee_openssl_cipher_method';
+
+	/**
+	 * the OPENSSL digest method used
+	 */
+	const OPENSSL_DIGEST_METHOD = 'sha512';
+
+	/**
+	 * separates the encrypted text from the initialization vector
+	 */
+	const OPENSSL_IV_DELIMITER = ':iv:';
+
+	/**
+	 * appended to text encrypted using the acme encryption
+	 */
+	const ACME_ENCRYPTION_FLAG = '::ae';
+
+
+	/**
+	 * instance of the EE_Encryption object
+	 */
+	protected static $_instance;
+
+	/**
+	 * @var string $_encryption_key
+	 */
+	protected $_encryption_key;
+
+	/**
+	 * @var string $cipher_method
+	 */
+	private $cipher_method = '';
+
+	/**
+	 * @var array $cipher_methods
+	 */
+	private $cipher_methods = array();
+
+	/**
+	 * @var array $digest_methods
+	 */
+	private $digest_methods = array();
+
+	/**
+	 * @var boolean $_use_openssl_encrypt
+	 */
+	protected $_use_openssl_encrypt = false;
+
+	/**
+	 * @var boolean $_use_base64_encode
+	 */
+	protected $_use_base64_encode = false;
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 */
+	protected function __construct()
+	{
+		if (! defined('ESPRESSO_ENCRYPT')) {
+			define('ESPRESSO_ENCRYPT', true);
+		}
+		if (extension_loaded('openssl')) {
+			$this->_use_openssl_encrypt = true;
+		}
+		if (function_exists('base64_encode')) {
+			$this->_use_base64_encode = true;
+		}
+	}
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @return EE_Encryption
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! EE_Encryption::$_instance instanceof EE_Encryption) {
+			EE_Encryption::$_instance = new self();
+		}
+		return EE_Encryption::$_instance;
+	}
+
+
+	/**
+	 * get encryption key
+	 *
+	 * @return string
+	 */
+	public function get_encryption_key()
+	{
+		// if encryption key has not been set
+		if (empty($this->_encryption_key)) {
+			// retrieve encryption_key from db
+			$this->_encryption_key = get_option(EE_Encryption::ENCRYPTION_OPTION_KEY, '');
+			// WHAT?? No encryption_key in the db ??
+			if ($this->_encryption_key === '') {
+				// let's make one. And md5 it to make it just the right size for a key
+				$new_key = md5($this->generate_random_string());
+				// now save it to the db for later
+				add_option(EE_Encryption::ENCRYPTION_OPTION_KEY, $new_key);
+				// here's the key - FINALLY !
+				$this->_encryption_key = $new_key;
+			}
+		}
+		return $this->_encryption_key;
+	}
+
+
+	/**
+	 * encrypts data
+	 *
+	 * @param string $text_string - the text to be encrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function encrypt($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		if ($this->_use_openssl_encrypt) {
+			$encrypted_text = $this->openssl_encrypt($text_string);
+		} else {
+			$encrypted_text = $this->acme_encrypt($text_string);
+		}
+		return $encrypted_text;
+	}
+
+
+	/**
+	 * decrypts data
+	 *
+	 * @param string $encrypted_text - the text to be decrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function decrypt($encrypted_text = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// if PHP's mcrypt functions are installed then we'll use them
+		if ($this->_use_openssl_encrypt) {
+			$decrypted_text = $this->openssl_decrypt($encrypted_text);
+		} else {
+			$decrypted_text = $this->acme_decrypt($encrypted_text);
+		}
+		return $decrypted_text;
+	}
+
+
+	/**
+	 * encodes string with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $text_string the text to be encoded
+	 * @return string
+	 */
+	public function base64_string_encode($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string) || ! $this->_use_base64_encode) {
+			return $text_string;
+		}
+		// encode
+		return base64_encode($text_string);
+	}
+
+
+	/**
+	 * decodes string that has been encoded with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $encoded_string the text to be decoded
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function base64_string_decode($encoded_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
+			return $encoded_string;
+		}
+		// decode
+		$decoded_string = base64_decode($encoded_string);
+		if ($decoded_string === false) {
+			throw new RuntimeException(
+				esc_html__('Base 64 decoding failed.', 'event_espresso')
+			);
+		}
+		return $decoded_string;
+	}
+
+
+	/**
+	 * encodes  url string with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $text_string the text to be encoded
+	 * @return string
+	 */
+	public function base64_url_encode($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string) || ! $this->_use_base64_encode) {
+			return $text_string;
+		}
+		// encode
+		$encoded_string = base64_encode($text_string);
+		// remove chars to make encoding more URL friendly
+		return strtr($encoded_string, '+/=', '-_,');
+	}
+
+
+	/**
+	 * decodes  url string that has been encoded with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $encoded_string the text to be decoded
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function base64_url_decode($encoded_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
+			return $encoded_string;
+		}
+		// replace previously removed characters
+		$encoded_string = strtr($encoded_string, '-_,', '+/=');
+		// decode
+		$decoded_string = base64_decode($encoded_string);
+		if ($decoded_string === false) {
+			throw new RuntimeException(
+				esc_html__('Base 64 decoding failed.', 'event_espresso')
+			);
+		}
+		return $decoded_string;
+	}
+
+
+	/**
+	 * encrypts data using PHP's openssl functions
+	 *
+	 * @param string $text_string the text to be encrypted
+	 * @param string $cipher_method
+	 * @param string $encryption_key
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function openssl_encrypt(
+		$text_string = '',
+		$cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
+		$encryption_key = ''
+	) {
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		$this->cipher_method = $this->getCipherMethod($cipher_method);
+		// get initialization vector size
+		$iv_size = openssl_cipher_iv_length($this->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_size, $is_strong);
+		if ($iv === false || $is_strong === false) {
+			throw new RuntimeException(
+				esc_html__('Failed to generate OpenSSL initialization vector.', 'event_espresso')
+			);
+		}
+		// encrypt it
+		$encrypted_text = openssl_encrypt(
+			$text_string,
+			$this->cipher_method,
+			$this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
+			0,
+			$iv
+		);
+		// append the initialization vector
+		$encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER . $iv;
+		// trim and maybe encode
+		return $this->_use_base64_encode
+			? trim(base64_encode($encrypted_text))
+			: trim($encrypted_text);
+	}
+
+
+	/**
+	 * 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
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function getCipherMethod($cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD)
+	{
+		if ($this->cipher_method !== '') {
+			return $this->cipher_method;
+		}
+		// verify that the default cipher method can produce an initialization vector
+		if (openssl_cipher_iv_length($cipher_method) === false) {
+			// nope? okay let's get what we found in the past to work
+			$cipher_method = get_option(EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME, '');
+			// oops... haven't tested available cipher methods yet
+			if ($cipher_method === '' || openssl_cipher_iv_length($cipher_method) === false) {
+				$cipher_method = $this->getAvailableCipherMethod($cipher_method);
+			}
+		}
+		return $cipher_method;
+	}
+
+
+	/**
+	 * @param string $cipher_method
+	 * @return string
+	 * @throws \RuntimeException
+	 */
+	protected function getAvailableCipherMethod($cipher_method)
+	{
+		// verify that the incoming cipher method can produce an initialization vector
+		if (openssl_cipher_iv_length($cipher_method) === false) {
+			// nope? then check the next cipher in the list of available cipher methods
+			$cipher_method = next($this->cipher_methods);
+			// what? there's no list? then generate that list and cache it,
+			if (empty($this->cipher_methods)) {
+				$this->cipher_methods = openssl_get_cipher_methods();
+				// then grab the first item from the list
+				$cipher_method = reset($this->cipher_methods);
+			}
+			if ($cipher_method === false) {
+				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);
+		}
+		// if we've gotten this far, then we found an available cipher method that works
+		// so save that for next time
+		update_option(
+			EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME,
+			$cipher_method
+		);
+		return $cipher_method;
+	}
+
+
+	/**
+	 * decrypts data that has been encrypted with PHP's openssl functions
+	 *
+	 * @param string $encrypted_text the text to be decrypted
+	 * @param string $cipher_method
+	 * @param string $encryption_key
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function openssl_decrypt(
+		$encrypted_text = '',
+		$cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
+		$encryption_key = ''
+	) {
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// decode
+		$encrypted_text = $this->valid_base_64($encrypted_text)
+			? $this->base64_url_decode($encrypted_text)
+			: $encrypted_text;
+		$encrypted_components = explode(
+			EE_Encryption::OPENSSL_IV_DELIMITER,
+			$encrypted_text,
+			2
+		);
+		// decrypt it
+		$decrypted_text = openssl_decrypt(
+			$encrypted_components[0],
+			$this->getCipherMethod($cipher_method),
+			$this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
+			0,
+			$encrypted_components[1]
+		);
+		$decrypted_text = trim($decrypted_text);
+		return $decrypted_text;
+	}
+
+
+	/**
+	 * 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 $digest_method
+	 * @param string $encryption_key
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function getDigestHashValue($digest_method = EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key = '')
+	{
+		$encryption_key = $encryption_key !== ''
+			? $encryption_key
+			: $this->get_encryption_key();
+		$digest_hash_value = openssl_digest($encryption_key, $digest_method);
+		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
+	 */
+	protected 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;
+	}
+
+
+	/**
+	 * encrypts data for acme servers that didn't bother to install PHP mcrypt
+	 *
+	 * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
+	 * @param string $text_string the text to be decrypted
+	 * @return string
+	 */
+	protected function acme_encrypt($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		$key_bits = str_split(
+			str_pad(
+				'',
+				strlen($text_string),
+				$this->get_encryption_key(),
+				STR_PAD_RIGHT
+			)
+		);
+		$string_bits = str_split($text_string);
+		foreach ($string_bits as $k => $v) {
+			$temp = ord($v) + ord($key_bits[ $k ]);
+			$string_bits[ $k ] = chr($temp > 255 ? ($temp - 256) : $temp);
+		}
+		$encrypted_text = implode('', $string_bits);
+		$encrypted_text .= EE_Encryption::ACME_ENCRYPTION_FLAG;
+		return $this->_use_base64_encode
+			? base64_encode($encrypted_text)
+			: $encrypted_text;
+	}
+
+
+	/**
+	 * decrypts data for acme servers that didn't bother to install PHP mcrypt
+	 *
+	 * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
+	 * @param string $encrypted_text the text to be decrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function acme_decrypt($encrypted_text = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// decode the data ?
+		$encrypted_text = $this->valid_base_64($encrypted_text)
+			? $this->base64_url_decode($encrypted_text)
+			: $encrypted_text;
+		$encrypted_text = substr($encrypted_text, 0, -4);
+		$key_bits = str_split(
+			str_pad(
+				'',
+				strlen($encrypted_text),
+				$this->get_encryption_key(),
+				STR_PAD_RIGHT
+			)
+		);
+		$string_bits = str_split($encrypted_text);
+		foreach ($string_bits as $k => $v) {
+			$temp = ord($v) - ord($key_bits[ $k ]);
+			$string_bits[ $k ] = chr($temp < 0 ? ($temp + 256) : $temp);
+		}
+		return implode('', $string_bits);
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/2556345/detect-base64-encoding-in-php#30231906
+	 * @param $string
+	 * @return bool
+	 */
+	protected function valid_base_64($string)
+	{
+		// ensure data is a string
+		if (! is_string($string) || ! $this->_use_base64_encode) {
+			return false;
+		}
+		$decoded = base64_decode($string, true);
+		// Check if there is no invalid character in string
+		if (! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
+			return false;
+		}
+		// Decode the string in strict mode and send the response
+		if (! base64_decode($string, true)) {
+			return false;
+		}
+		// Encode and compare it to original one
+		return base64_encode($decoded) === $string;
+	}
+
+
+	/**
+	 * generate random string
+	 *
+	 * @see http://stackoverflow.com/questions/637278/what-is-the-best-way-to-generate-a-random-key-within-php
+	 * @param int $length number of characters for random string
+	 * @return string
+	 */
+	public function generate_random_string($length = 40)
+	{
+		$iterations = ceil($length / 40);
+		$random_string = '';
+		for ($i = 0; $i < $iterations; $i++) {
+			$random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
+		}
+		$random_string = substr($random_string, 0, $length);
+		return $random_string;
+	}
 }

core/EE_Module_Request_Router.core.php

Indentation +235 added lines, -235 removed lines

@@ -15,255 +15,255 @@
 final class EE_Module_Request_Router implements InterminableInterface
 {
 
-    /**
-     * @var EE_Request $request
-     */
-    private $request;
+	/**
+	 * @var EE_Request $request
+	 */
+	private $request;
 
-    /**
-     * @var array $_previous_routes
-     */
-    private static $_previous_routes = array();
+	/**
+	 * @var array $_previous_routes
+	 */
+	private static $_previous_routes = array();
 
-    /**
-     * @var WP_Query $WP_Query
-     */
-    public $WP_Query;
+	/**
+	 * @var WP_Query $WP_Query
+	 */
+	public $WP_Query;
 
 
-    /**
-     * EE_Module_Request_Router constructor.
-     *
-     * @param EE_Request $request
-     */
-    public function __construct(EE_Request $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * EE_Module_Request_Router constructor.
+	 *
+	 * @param EE_Request $request
+	 */
+	public function __construct(EE_Request $request)
+	{
+		$this->request = $request;
+	}
 
 
-    /**
-     * on the first call  to this method, it checks the EE_Request_Handler for a "route"
-     * on subsequent calls to this method,
-     * instead of checking the EE_Request_Handler for a route, it checks the previous routes array,
-     * and checks if the last called route has any forwarding routes registered for it
-     *
-     * @param WP_Query $WP_Query
-     * @return NULL|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_route(WP_Query $WP_Query)
-    {
-        $this->WP_Query = $WP_Query;
-        // assume this if first route being called
-        $previous_route = false;
-        // but is it really ???
-        if (! empty(self::$_previous_routes)) {
-            // get last run route
-            $previous_routes = array_values(self::$_previous_routes);
-            $previous_route = array_pop($previous_routes);
-        }
-        //  has another route already been run ?
-        if ($previous_route) {
-            // check if  forwarding has been set
-            $current_route = $this->get_forward($previous_route);
-            try {
-                // check for recursive forwarding
-                if (isset(self::$_previous_routes[ $current_route ])) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'An error occurred. The %s route has already been called, and therefore can not be forwarded to, because an infinite loop would be created and break the interweb.',
-                                'event_espresso'
-                            ),
-                            $current_route
-                        )
-                    );
-                }
-            } catch (EE_Error $e) {
-                $e->get_error();
-                return null;
-            }
-        } else {
-            // first route called
-            $current_route = null;
-            // grab all routes
-            $routes = EE_Config::get_routes();
-            foreach ($routes as $key => $route) {
-                // first determine if route key uses w?ldc*rds
-                $uses_wildcards = strpos($key, '?') !== false
-                                  || strpos($key, '*') !== false;
-                // check request for module route
-                $route_found = $uses_wildcards
-                    ? $this->request->matches($key)
-                    : $this->request->is_set($key);
-                if ($route_found) {
-                    $current_route = $uses_wildcards
-                        ? $this->request->getMatch($key)
-                        : $this->request->get($key);
-                    $current_route = sanitize_text_field($current_route);
-                    if ($current_route) {
-                        $current_route = array($key, $current_route);
-                        break;
-                    }
-                }
-            }
-        }
-        // sorry, but I can't read what you route !
-        if (empty($current_route)) {
-            return null;
-        }
-        // add route to previous routes array
-        self::$_previous_routes[] = $current_route;
-        return $current_route;
-    }
+	/**
+	 * on the first call  to this method, it checks the EE_Request_Handler for a "route"
+	 * on subsequent calls to this method,
+	 * instead of checking the EE_Request_Handler for a route, it checks the previous routes array,
+	 * and checks if the last called route has any forwarding routes registered for it
+	 *
+	 * @param WP_Query $WP_Query
+	 * @return NULL|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_route(WP_Query $WP_Query)
+	{
+		$this->WP_Query = $WP_Query;
+		// assume this if first route being called
+		$previous_route = false;
+		// but is it really ???
+		if (! empty(self::$_previous_routes)) {
+			// get last run route
+			$previous_routes = array_values(self::$_previous_routes);
+			$previous_route = array_pop($previous_routes);
+		}
+		//  has another route already been run ?
+		if ($previous_route) {
+			// check if  forwarding has been set
+			$current_route = $this->get_forward($previous_route);
+			try {
+				// check for recursive forwarding
+				if (isset(self::$_previous_routes[ $current_route ])) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'An error occurred. The %s route has already been called, and therefore can not be forwarded to, because an infinite loop would be created and break the interweb.',
+								'event_espresso'
+							),
+							$current_route
+						)
+					);
+				}
+			} catch (EE_Error $e) {
+				$e->get_error();
+				return null;
+			}
+		} else {
+			// first route called
+			$current_route = null;
+			// grab all routes
+			$routes = EE_Config::get_routes();
+			foreach ($routes as $key => $route) {
+				// first determine if route key uses w?ldc*rds
+				$uses_wildcards = strpos($key, '?') !== false
+								  || strpos($key, '*') !== false;
+				// check request for module route
+				$route_found = $uses_wildcards
+					? $this->request->matches($key)
+					: $this->request->is_set($key);
+				if ($route_found) {
+					$current_route = $uses_wildcards
+						? $this->request->getMatch($key)
+						: $this->request->get($key);
+					$current_route = sanitize_text_field($current_route);
+					if ($current_route) {
+						$current_route = array($key, $current_route);
+						break;
+					}
+				}
+			}
+		}
+		// sorry, but I can't read what you route !
+		if (empty($current_route)) {
+			return null;
+		}
+		// add route to previous routes array
+		self::$_previous_routes[] = $current_route;
+		return $current_route;
+	}
 
 
-    /**
-     * this method simply takes a valid route, and resolves what module class method the route points to
-     *
-     * @param string $key
-     * @param string $current_route
-     * @return mixed EED_Module | boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function resolve_route($key, $current_route)
-    {
-        // get module method that route has been mapped to
-        $module_method = EE_Config::get_route($current_route, $key);
-        // verify result was returned
-        if (empty($module_method)) {
-            $msg = sprintf(
-                __('The requested route %s could not be mapped to any registered modules.', 'event_espresso'),
-                $current_route
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // verify that result is an array
-        if (! is_array($module_method)) {
-            $msg = sprintf(__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // grab module name
-        $module_name = $module_method[0];
-        // verify that a class method was registered properly
-        if (! isset($module_method[1])) {
-            $msg = sprintf(
-                __('A class method for the %s  route has not been properly registered.', 'event_espresso'),
-                $current_route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // grab method
-        $method = $module_method[1];
-        // verify that class exists
-        if (! class_exists($module_name)) {
-            $msg = sprintf(__('The requested %s class could not be found.', 'event_espresso'), $module_name);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // verify that method exists
-        if (! method_exists($module_name, $method)) {
-            $msg = sprintf(
-                __('The class method %s for the %s route is in invalid.', 'event_espresso'),
-                $method,
-                $current_route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // instantiate module and call route method
-        return $this->_module_router($module_name, $method);
-    }
+	/**
+	 * this method simply takes a valid route, and resolves what module class method the route points to
+	 *
+	 * @param string $key
+	 * @param string $current_route
+	 * @return mixed EED_Module | boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function resolve_route($key, $current_route)
+	{
+		// get module method that route has been mapped to
+		$module_method = EE_Config::get_route($current_route, $key);
+		// verify result was returned
+		if (empty($module_method)) {
+			$msg = sprintf(
+				__('The requested route %s could not be mapped to any registered modules.', 'event_espresso'),
+				$current_route
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// verify that result is an array
+		if (! is_array($module_method)) {
+			$msg = sprintf(__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// grab module name
+		$module_name = $module_method[0];
+		// verify that a class method was registered properly
+		if (! isset($module_method[1])) {
+			$msg = sprintf(
+				__('A class method for the %s  route has not been properly registered.', 'event_espresso'),
+				$current_route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// grab method
+		$method = $module_method[1];
+		// verify that class exists
+		if (! class_exists($module_name)) {
+			$msg = sprintf(__('The requested %s class could not be found.', 'event_espresso'), $module_name);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// verify that method exists
+		if (! method_exists($module_name, $method)) {
+			$msg = sprintf(
+				__('The class method %s for the %s route is in invalid.', 'event_espresso'),
+				$method,
+				$current_route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// instantiate module and call route method
+		return $this->_module_router($module_name, $method);
+	}
 
 
-    /**
-     * this method instantiates modules and calls the method that was defined when the route was registered
-     *
-     * @param string $module_name
-     * @return EED_Module|object|null
-     * @throws ReflectionException
-     */
-    public static function module_factory($module_name)
-    {
-        if ($module_name === 'EED_Module') {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'EED_Module is an abstract parent class an can not be instantiated. Please provide a proper module name.',
-                        'event_espresso'
-                    ),
-                    $module_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        // instantiate module class
-        $module = new $module_name();
-        // ensure that class is actually a module
-        if (! $module instanceof EED_Module) {
-            EE_Error::add_error(
-                sprintf(__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $module;
-    }
+	/**
+	 * this method instantiates modules and calls the method that was defined when the route was registered
+	 *
+	 * @param string $module_name
+	 * @return EED_Module|object|null
+	 * @throws ReflectionException
+	 */
+	public static function module_factory($module_name)
+	{
+		if ($module_name === 'EED_Module') {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'EED_Module is an abstract parent class an can not be instantiated. Please provide a proper module name.',
+						'event_espresso'
+					),
+					$module_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		// instantiate module class
+		$module = new $module_name();
+		// ensure that class is actually a module
+		if (! $module instanceof EED_Module) {
+			EE_Error::add_error(
+				sprintf(__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $module;
+	}
 
 
-    /**
-     * this method instantiates modules and calls the method that was defined when the route was registered
-     *
-     * @param string $module_name
-     * @param string $method
-     * @return EED_Module|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _module_router($module_name, $method)
-    {
-        // instantiate module class
-        $module = EE_Module_Request_Router::module_factory($module_name);
-        if ($module instanceof EED_Module) {
-            // and call whatever action the route was for
-            try {
-                call_user_func(array($module, $method), $this->WP_Query);
-            } catch (EE_Error $e) {
-                $e->get_error();
-                return null;
-            }
-        }
-        return $module;
-    }
+	/**
+	 * this method instantiates modules and calls the method that was defined when the route was registered
+	 *
+	 * @param string $module_name
+	 * @param string $method
+	 * @return EED_Module|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _module_router($module_name, $method)
+	{
+		// instantiate module class
+		$module = EE_Module_Request_Router::module_factory($module_name);
+		if ($module instanceof EED_Module) {
+			// and call whatever action the route was for
+			try {
+				call_user_func(array($module, $method), $this->WP_Query);
+			} catch (EE_Error $e) {
+				$e->get_error();
+				return null;
+			}
+		}
+		return $module;
+	}
 
 
-    /**
-     * @param $current_route
-     * @return string
-     */
-    public function get_forward($current_route)
-    {
-        return EE_Config::get_forward($current_route);
-    }
+	/**
+	 * @param $current_route
+	 * @return string
+	 */
+	public function get_forward($current_route)
+	{
+		return EE_Config::get_forward($current_route);
+	}
 
 
-    /**
-     * @param $current_route
-     * @return string
-     */
-    public function get_view($current_route)
-    {
-        return EE_Config::get_view($current_route);
-    }
+	/**
+	 * @param $current_route
+	 * @return string
+	 */
+	public function get_view($current_route)
+	{
+		return EE_Config::get_view($current_route);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -59,7 +59,7 @@ 
         // assume this if first route being called
         $previous_route = false;
         // but is it really ???
-        if (! empty(self::$_previous_routes)) {
+        if ( ! empty(self::$_previous_routes)) {
             // get last run route
             $previous_routes = array_values(self::$_previous_routes);
             $previous_route = array_pop($previous_routes);
@@ -70,7 +70,7 @@ 
             $current_route = $this->get_forward($previous_route);
             try {
                 // check for recursive forwarding
-                if (isset(self::$_previous_routes[ $current_route ])) {
+                if (isset(self::$_previous_routes[$current_route])) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -143,38 +143,38 @@ 
             return false;
         }
         // verify that result is an array
-        if (! is_array($module_method)) {
+        if ( ! is_array($module_method)) {
             $msg = sprintf(__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // grab module name
         $module_name = $module_method[0];
         // verify that a class method was registered properly
-        if (! isset($module_method[1])) {
+        if ( ! isset($module_method[1])) {
             $msg = sprintf(
                 __('A class method for the %s  route has not been properly registered.', 'event_espresso'),
                 $current_route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // grab method
         $method = $module_method[1];
         // verify that class exists
-        if (! class_exists($module_name)) {
+        if ( ! class_exists($module_name)) {
             $msg = sprintf(__('The requested %s class could not be found.', 'event_espresso'), $module_name);
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // verify that method exists
-        if (! method_exists($module_name, $method)) {
+        if ( ! method_exists($module_name, $method)) {
             $msg = sprintf(
                 __('The class method %s for the %s route is in invalid.', 'event_espresso'),
                 $method,
                 $current_route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // instantiate module and call route method
@@ -209,7 +209,7 @@ 
         // instantiate module class
         $module = new $module_name();
         // ensure that class is actually a module
-        if (! $module instanceof EED_Module) {
+        if ( ! $module instanceof EED_Module) {
             EE_Error::add_error(
                 sprintf(__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
                 __FILE__,

core/templates/espresso-ajax-notices.template.php

Indentation +3 added lines, -3 removed lines

@@ -1,9 +1,9 @@
 <div id="espresso-ajax-loading" style="display:none;">
     <span class="ee-spinner ee-spin"></span><span style="display:none;">
         <?php _e(
-            'loading...',
-            'event_espresso'
-        ); ?></span>
+			'loading...',
+			'event_espresso'
+		); ?></span>
 </div>
 
 <div id="espresso-ajax-notices">

core/EE_Bootstrap.core.php

Indentation +62 added lines, -62 removed lines

@@ -14,78 +14,78 @@
 {
 
 
-    /**
-     * load_espresso_addons
-     * runs during the WP 'plugins_loaded' action at priority 1
-     * and is the initial loading phase for EE addons
-     * no other logic should be performed at this point
-     */
-    public static function load_espresso_addons()
-    {
-        do_action('AHEE__EE_Bootstrap__load_espresso_addons');
-    }
+	/**
+	 * load_espresso_addons
+	 * runs during the WP 'plugins_loaded' action at priority 1
+	 * and is the initial loading phase for EE addons
+	 * no other logic should be performed at this point
+	 */
+	public static function load_espresso_addons()
+	{
+		do_action('AHEE__EE_Bootstrap__load_espresso_addons');
+	}
 
 
-    /**
-     * detect_activations_or_upgrades
-     * runs during the WP 'plugins_loaded' action at priority 3
-     * Now that all of the addons have been loaded,
-     * we can determine if anything needs activating or upgrading
-     */
-    public static function detect_activations_or_upgrades()
-    {
-        do_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades');
-    }
+	/**
+	 * detect_activations_or_upgrades
+	 * runs during the WP 'plugins_loaded' action at priority 3
+	 * Now that all of the addons have been loaded,
+	 * we can determine if anything needs activating or upgrading
+	 */
+	public static function detect_activations_or_upgrades()
+	{
+		do_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades');
+	}
 
 
-    /**
-     * load_core_configuration
-     * runs during the WP 'plugins_loaded' action at priority 5
-     * Now that the database is assumed to be at the correct version
-     * we can load and set all of the system configurations
-     */
-    public static function load_core_configuration()
-    {
-        do_action('AHEE__EE_Bootstrap__load_core_configuration');
-    }
+	/**
+	 * load_core_configuration
+	 * runs during the WP 'plugins_loaded' action at priority 5
+	 * Now that the database is assumed to be at the correct version
+	 * we can load and set all of the system configurations
+	 */
+	public static function load_core_configuration()
+	{
+		do_action('AHEE__EE_Bootstrap__load_core_configuration');
+	}
 
 
-    /**
-     * register_shortcodes_modules_and_widgets
-     * runs during the WP 'plugins_loaded' action at priority 7
-     * and handles registering all o four shortcodes, modules and widgets
-     * so that they are ready to be used throughout the system
-     */
-    public static function register_shortcodes_modules_and_widgets()
-    {
-        do_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets');
-    }
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * runs during the WP 'plugins_loaded' action at priority 7
+	 * and handles registering all o four shortcodes, modules and widgets
+	 * so that they are ready to be used throughout the system
+	 */
+	public static function register_shortcodes_modules_and_widgets()
+	{
+		do_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets');
+	}
 
 
-    /**
-     * brew_espresso
-     * runs during the WP 'plugins_loaded' action at priority 9
-     * bootstrapping is considered complete at this point,
-     * so let the fun begin...
-     */
-    public static function brew_espresso()
-    {
-        do_action('AHEE__EE_Bootstrap__brew_espresso');
-    }
+	/**
+	 * brew_espresso
+	 * runs during the WP 'plugins_loaded' action at priority 9
+	 * bootstrapping is considered complete at this point,
+	 * so let the fun begin...
+	 */
+	public static function brew_espresso()
+	{
+		do_action('AHEE__EE_Bootstrap__brew_espresso');
+	}
 
 
-    /**
-     * @deprecated 4.9.53
-     */
-    public function run_request_stack()
-    {
-    }
+	/**
+	 * @deprecated 4.9.53
+	 */
+	public function run_request_stack()
+	{
+	}
 
 
-    /**
-     * @deprecated 4.9.53
-     */
-    public function build_request_stack()
-    {
-    }
+	/**
+	 * @deprecated 4.9.53
+	 */
+	public function build_request_stack()
+	{
+	}
 }

core/helpers/EEH_Address.helper.php

Indentation +111 added lines, -111 removed lines

@@ -13,124 +13,124 @@
 
 
 
-    /**
-     *    format - output formatted EE object address information
-     *
-     * @access public
-     * @param         object      EEI_Address $obj_with_address
-     * @param string  $type       how the address is formatted. for example: 'multiline' or 'inline'
-     * @param boolean $use_schema whether to apply schema.org formatting to the address
-     * @param bool    $add_wrapper
-     * @return string
-     */
-    public static function format(
-        $obj_with_address = null,
-        $type = 'multiline',
-        $use_schema = true,
-        $add_wrapper = true
-    ) {
-        // check that incoming object implements the EEI_Address interface
-        if (! $obj_with_address instanceof EEI_Address) {
-            $msg = __('The address could not be formatted.', 'event_espresso');
-            $dev_msg = __(
-                'The Address Formatter requires passed objects to implement the EEI_Address interface.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-            return null;
-        }
-        // obtain an address formatter
-        $formatter = EEH_Address::_get_formatter($type);
-        // apply schema.org formatting ?
-        $use_schema = ! is_admin() ? $use_schema : false;
-        $formatted_address = $use_schema
-            ? EEH_Address::_schema_formatting($formatter, $obj_with_address)
-            : EEH_Address::_regular_formatting($formatter, $obj_with_address, $add_wrapper);
-        $formatted_address = $add_wrapper && ! $use_schema
-            ? '<div class="espresso-address-dv">' . $formatted_address . '</div>'
-            : $formatted_address;
-        // return the formatted address
-        return $formatted_address;
-    }
+	/**
+	 *    format - output formatted EE object address information
+	 *
+	 * @access public
+	 * @param         object      EEI_Address $obj_with_address
+	 * @param string  $type       how the address is formatted. for example: 'multiline' or 'inline'
+	 * @param boolean $use_schema whether to apply schema.org formatting to the address
+	 * @param bool    $add_wrapper
+	 * @return string
+	 */
+	public static function format(
+		$obj_with_address = null,
+		$type = 'multiline',
+		$use_schema = true,
+		$add_wrapper = true
+	) {
+		// check that incoming object implements the EEI_Address interface
+		if (! $obj_with_address instanceof EEI_Address) {
+			$msg = __('The address could not be formatted.', 'event_espresso');
+			$dev_msg = __(
+				'The Address Formatter requires passed objects to implement the EEI_Address interface.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+			return null;
+		}
+		// obtain an address formatter
+		$formatter = EEH_Address::_get_formatter($type);
+		// apply schema.org formatting ?
+		$use_schema = ! is_admin() ? $use_schema : false;
+		$formatted_address = $use_schema
+			? EEH_Address::_schema_formatting($formatter, $obj_with_address)
+			: EEH_Address::_regular_formatting($formatter, $obj_with_address, $add_wrapper);
+		$formatted_address = $add_wrapper && ! $use_schema
+			? '<div class="espresso-address-dv">' . $formatted_address . '</div>'
+			: $formatted_address;
+		// return the formatted address
+		return $formatted_address;
+	}
 
 
 
-    /**
-     *    _get_formatter - obtain the requester formatter class
-     *
-     * @access private
-     * @param string $type how the address is formatted. for example: 'multiline' or 'inline'
-     * @return EEI_Address_Formatter
-     */
-    private static function _get_formatter($type)
-    {
-        switch ($type) {
-            case 'multiline':
-                return new EventEspresso\core\services\address\formatters\MultiLineAddressFormatter();
-            case 'inline':
-                return new EventEspresso\core\services\address\formatters\InlineAddressFormatter();
-            default:
-                return new EventEspresso\core\services\address\formatters\NullAddressFormatter();
-        }
-    }
+	/**
+	 *    _get_formatter - obtain the requester formatter class
+	 *
+	 * @access private
+	 * @param string $type how the address is formatted. for example: 'multiline' or 'inline'
+	 * @return EEI_Address_Formatter
+	 */
+	private static function _get_formatter($type)
+	{
+		switch ($type) {
+			case 'multiline':
+				return new EventEspresso\core\services\address\formatters\MultiLineAddressFormatter();
+			case 'inline':
+				return new EventEspresso\core\services\address\formatters\InlineAddressFormatter();
+			default:
+				return new EventEspresso\core\services\address\formatters\NullAddressFormatter();
+		}
+	}
 
 
 
-    /**
-     *    _regular_formatting
-     *    adds formatting to an address
-     *
-     * @access private
-     * @param      object EEI_Address_Formatter $formatter
-     * @param      object EEI_Address $obj_with_address
-     * @param bool $add_wrapper
-     * @return string
-     */
-    private static function _regular_formatting(
-        EEI_Address_Formatter $formatter,
-        EEI_Address $obj_with_address,
-        $add_wrapper = true
-    ) {
-        $formatted_address = $add_wrapper ? '<div>' : '';
-        $formatted_address .= $formatter->format(
-            $obj_with_address->address(),
-            $obj_with_address->address2(),
-            $obj_with_address->city(),
-            $obj_with_address->state_name(),
-            $obj_with_address->zip(),
-            $obj_with_address->country_name(),
-            $obj_with_address->country_ID()
-        );
-        $formatted_address .= $add_wrapper ? '</div>' : '';
-        // return the formatted address
-        return $formatted_address;
-    }
+	/**
+	 *    _regular_formatting
+	 *    adds formatting to an address
+	 *
+	 * @access private
+	 * @param      object EEI_Address_Formatter $formatter
+	 * @param      object EEI_Address $obj_with_address
+	 * @param bool $add_wrapper
+	 * @return string
+	 */
+	private static function _regular_formatting(
+		EEI_Address_Formatter $formatter,
+		EEI_Address $obj_with_address,
+		$add_wrapper = true
+	) {
+		$formatted_address = $add_wrapper ? '<div>' : '';
+		$formatted_address .= $formatter->format(
+			$obj_with_address->address(),
+			$obj_with_address->address2(),
+			$obj_with_address->city(),
+			$obj_with_address->state_name(),
+			$obj_with_address->zip(),
+			$obj_with_address->country_name(),
+			$obj_with_address->country_ID()
+		);
+		$formatted_address .= $add_wrapper ? '</div>' : '';
+		// return the formatted address
+		return $formatted_address;
+	}
 
 
 
-    /**
-     *    _schema_formatting
-     *    adds schema.org formatting to an address
-     *
-     * @access private
-     * @param object EEI_Address_Formatter $formatter
-     * @param object EEI_Address $obj_with_address
-     * @return string
-     */
-    private static function _schema_formatting(EEI_Address_Formatter $formatter, EEI_Address $obj_with_address)
-    {
-        $formatted_address = '<div itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">';
-        $formatted_address .= $formatter->format(
-            EEH_Schema::streetAddress($obj_with_address),
-            EEH_Schema::postOfficeBoxNumber($obj_with_address),
-            EEH_Schema::addressLocality($obj_with_address),
-            EEH_Schema::addressRegion($obj_with_address),
-            EEH_Schema::postalCode($obj_with_address),
-            EEH_Schema::addressCountry($obj_with_address),
-            $obj_with_address->country_ID()
-        );
-        $formatted_address .= '</div>';
-        // return the formatted address
-        return $formatted_address;
-    }
+	/**
+	 *    _schema_formatting
+	 *    adds schema.org formatting to an address
+	 *
+	 * @access private
+	 * @param object EEI_Address_Formatter $formatter
+	 * @param object EEI_Address $obj_with_address
+	 * @return string
+	 */
+	private static function _schema_formatting(EEI_Address_Formatter $formatter, EEI_Address $obj_with_address)
+	{
+		$formatted_address = '<div itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">';
+		$formatted_address .= $formatter->format(
+			EEH_Schema::streetAddress($obj_with_address),
+			EEH_Schema::postOfficeBoxNumber($obj_with_address),
+			EEH_Schema::addressLocality($obj_with_address),
+			EEH_Schema::addressRegion($obj_with_address),
+			EEH_Schema::postalCode($obj_with_address),
+			EEH_Schema::addressCountry($obj_with_address),
+			$obj_with_address->country_ID()
+		);
+		$formatted_address .= '</div>';
+		// return the formatted address
+		return $formatted_address;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -30,13 +30,13 @@ 
         $add_wrapper = true
     ) {
         // check that incoming object implements the EEI_Address interface
-        if (! $obj_with_address instanceof EEI_Address) {
+        if ( ! $obj_with_address instanceof EEI_Address) {
             $msg = __('The address could not be formatted.', 'event_espresso');
             $dev_msg = __(
                 'The Address Formatter requires passed objects to implement the EEI_Address interface.',
                 'event_espresso'
             );
-            EE_Error::add_error($msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
             return null;
         }
         // obtain an address formatter
@@ -47,7 +47,7 @@ 
             ? EEH_Address::_schema_formatting($formatter, $obj_with_address)
             : EEH_Address::_regular_formatting($formatter, $obj_with_address, $add_wrapper);
         $formatted_address = $add_wrapper && ! $use_schema
-            ? '<div class="espresso-address-dv">' . $formatted_address . '</div>'
+            ? '<div class="espresso-address-dv">'.$formatted_address.'</div>'
             : $formatted_address;
         // return the formatted address
         return $formatted_address;

core/helpers/EEH_Formatter.helper.php

Indentation +92 added lines, -92 removed lines

@@ -12,108 +12,108 @@
 {
 
 
-    /**
-     * _admin_format_content
-     * Text formatting function for wp_editor.
-     * This should fix all of the formatting issues of text output from the database.
-     *
-     * @static
-     * @access public
-     * @param  string $content content to format
-     * @return string          formatted content
-     */
-    public static function admin_format_content($content = '')
-    {
-        return wpautop(stripslashes_deep(html_entity_decode($content, ENT_QUOTES, "UTF-8")));
-    }
+	/**
+	 * _admin_format_content
+	 * Text formatting function for wp_editor.
+	 * This should fix all of the formatting issues of text output from the database.
+	 *
+	 * @static
+	 * @access public
+	 * @param  string $content content to format
+	 * @return string          formatted content
+	 */
+	public static function admin_format_content($content = '')
+	{
+		return wpautop(stripslashes_deep(html_entity_decode($content, ENT_QUOTES, "UTF-8")));
+	}
 
 
 
-    /**
-     * ee_tep_output_string
-     * todo: we need a description for this.
-     *
-     * @static
-     * @access public
-     * @param  string  $string    string to handle
-     * @param  boolean $translate //todo what is this for?
-     * @param  boolean $protected true then we run htmlspecialchars and return
-     * @return string
-     */
-    public static function ee_tep_output_string($string, $translate = false, $protected = false)
-    {
-        if ($protected === true) {
-            return htmlspecialchars($string);
-        } else {
-            if ($translate === false) {
-                return self::ee_tep_parse_input_field_data($string, array( '"' => '"' ));
-            } else {
-                return self::ee_tep_parse_input_field_data($string, $translate);
-            }
-        }
-    }
+	/**
+	 * ee_tep_output_string
+	 * todo: we need a description for this.
+	 *
+	 * @static
+	 * @access public
+	 * @param  string  $string    string to handle
+	 * @param  boolean $translate //todo what is this for?
+	 * @param  boolean $protected true then we run htmlspecialchars and return
+	 * @return string
+	 */
+	public static function ee_tep_output_string($string, $translate = false, $protected = false)
+	{
+		if ($protected === true) {
+			return htmlspecialchars($string);
+		} else {
+			if ($translate === false) {
+				return self::ee_tep_parse_input_field_data($string, array( '"' => '"' ));
+			} else {
+				return self::ee_tep_parse_input_field_data($string, $translate);
+			}
+		}
+	}
 
 
 
-    /**
-     * ee_tep_parse_input_field_data
-     *
-     * @param  string $data string to be "translated"
-     * @param         array ] $parse array in the form array( 'from' => 'to', ... )
-     * @return string
-     */
-    public static function ee_tep_parse_input_field_data($data, $parse)
-    {
-        return strtr(trim($data), $parse);
-    }
+	/**
+	 * ee_tep_parse_input_field_data
+	 *
+	 * @param  string $data string to be "translated"
+	 * @param         array ] $parse array in the form array( 'from' => 'to', ... )
+	 * @return string
+	 */
+	public static function ee_tep_parse_input_field_data($data, $parse)
+	{
+		return strtr(trim($data), $parse);
+	}
 
 
 
-    /**
-     * [ee_tep_not_null description]
-     *
-     * @param  string | array $value [description]
-     * @return bool       [description]
-     */
-    public static function ee_tep_not_null($value)
-    {
-        if (is_array($value)) {
-            if (count($value) > 0) {
-                return true;
-            } else {
-                return false;
-            }
-        } else {
-            if (( $value !== '' ) && ( strtolower($value) !== 'null' ) && ( strlen(trim($value)) > 0 )) {
-                return true;
-            } else {
-                return false;
-            }
-        }
-    }
+	/**
+	 * [ee_tep_not_null description]
+	 *
+	 * @param  string | array $value [description]
+	 * @return bool       [description]
+	 */
+	public static function ee_tep_not_null($value)
+	{
+		if (is_array($value)) {
+			if (count($value) > 0) {
+				return true;
+			} else {
+				return false;
+			}
+		} else {
+			if (( $value !== '' ) && ( strtolower($value) !== 'null' ) && ( strlen(trim($value)) > 0 )) {
+				return true;
+			} else {
+				return false;
+			}
+		}
+	}
 
 
 
-    /**
-     * Formats a date
-     *
-     * @param string $date
-     * @param string $format - format for the date
-     * @deprecated 4.6.12  Note, a search revealed this was not used anywhere in core or in our
-     *                       addons at time of writing this.  So just deprecated in case of third party use.
-     * @return string
-     * @deprecated v4.6.21
-     */
-    public static function event_date_display($date, $format = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'This method is deprecated as of EE 4.6.12.  Currently it does not reformat as with prior behaviour but just returns the incoming string.  Please use the EE_Datetime helpers for Datetime on the event to display as desired.',
-                'event_espresso'
-            ),
-            '4.6.21'
-        );
-        return $date;
-    }
+	/**
+	 * Formats a date
+	 *
+	 * @param string $date
+	 * @param string $format - format for the date
+	 * @deprecated 4.6.12  Note, a search revealed this was not used anywhere in core or in our
+	 *                       addons at time of writing this.  So just deprecated in case of third party use.
+	 * @return string
+	 * @deprecated v4.6.21
+	 */
+	public static function event_date_display($date, $format = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'This method is deprecated as of EE 4.6.12.  Currently it does not reformat as with prior behaviour but just returns the incoming string.  Please use the EE_Datetime helpers for Datetime on the event to display as desired.',
+				'event_espresso'
+			),
+			'4.6.21'
+		);
+		return $date;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
             return htmlspecialchars($string);
         } else {
             if ($translate === false) {
-                return self::ee_tep_parse_input_field_data($string, array( '"' => '"' ));
+                return self::ee_tep_parse_input_field_data($string, array('"' => '"'));
             } else {
                 return self::ee_tep_parse_input_field_data($string, $translate);
             }
@@ -84,7 +84,7 @@ 
                 return false;
             }
         } else {
-            if (( $value !== '' ) && ( strtolower($value) !== 'null' ) && ( strlen(trim($value)) > 0 )) {
+            if (($value !== '') && (strtolower($value) !== 'null') && (strlen(trim($value)) > 0)) {
                 return true;
             } else {
                 return false;

core/helpers/EEH_Base.helper.php

Indentation +36 added lines, -36 removed lines

@@ -11,42 +11,42 @@
 class EEH_Base
 {
 
-    /**
-     *  @var    array   $uri_segment_array  URL segments
-     *  @access     private
-     */
+	/**
+	 *  @var    array   $uri_segment_array  URL segments
+	 *  @access     private
+	 */
 //  final private function __construct() {}
 
-    /**
-     *      @ override magic methods
-     *      @ return void
-     */
-    public function __set($a, $b)
-    {
-        return false;
-    }
-    public function __get($a)
-    {
-        return false;
-    }
-    public function __isset($a)
-    {
-        return false;
-    }
-    public function __unset($a)
-    {
-        return false;
-    }
-    public function __clone()
-    {
-        return false;
-    }
-    public function __wakeup()
-    {
-        return false;
-    }
-    public function __destruct()
-    {
-        return false;
-    }
+	/**
+	 *      @ override magic methods
+	 *      @ return void
+	 */
+	public function __set($a, $b)
+	{
+		return false;
+	}
+	public function __get($a)
+	{
+		return false;
+	}
+	public function __isset($a)
+	{
+		return false;
+	}
+	public function __unset($a)
+	{
+		return false;
+	}
+	public function __clone()
+	{
+		return false;
+	}
+	public function __wakeup()
+	{
+		return false;
+	}
+	public function __destruct()
+	{
+		return false;
+	}
 }

core/helpers/EEH_Array.helper.php

Spacing +7 added lines, -7 removed lines

@@ -65,12 +65,12 @@ 
         if (is_array($arr)) {
             $first_item = reset($arr);
             if (is_array($first_item)) {
-                return true;// yep, there's at least 2 levels to this array
+                return true; // yep, there's at least 2 levels to this array
             } else {
-                return false;// nope, only 1 level
+                return false; // nope, only 1 level
             }
         } else {
-            return false;// its not an array at all!
+            return false; // its not an array at all!
         }
     }
 
@@ -84,7 +84,7 @@ 
      */
     public static function is_set($arr, $index, $default)
     {
-        return isset($arr[ $index ]) ? $arr[ $index ] : $default;
+        return isset($arr[$index]) ? $arr[$index] : $default;
     }
 
     /**
@@ -171,7 +171,7 @@ 
     public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
     {
         foreach ($array2 as $key => $value) {
-            $array1[ $key ] = $value;
+            $array1[$key] = $value;
         }
         return $array1;
     }
@@ -193,8 +193,8 @@ 
         $multidimensional = array();
         $reference = &$multidimensional;
         foreach ($flat_array as $key) {
-            $reference[ $key ] = array();
-            $reference = &$reference[ $key ];
+            $reference[$key] = array();
+            $reference = &$reference[$key];
         }
         if ($final_value !== null) {
             $reference = $final_value;

Indentation +199 added lines, -199 removed lines

@@ -13,203 +13,203 @@
 {
 
 
-    /**
-     * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
-     * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
-     *
-     * @uses array_udiff core php function for setting up our own array comparison
-     * @uses self::_compare_objects as the custom method for array_udiff
-     * @param  array $array1 an array of objects
-     * @param  array $array2 an array of objects
-     * @return array         an array of objects found in array 1 that aren't found in array 2.
-     */
-    public static function object_array_diff($array1, $array2)
-    {
-        return array_udiff($array1, $array2, array('self', '_compare_objects'));
-    }
-
-    /**
-     * Given that $arr is an array, determines if it's associative or numerically AND sequentially indexed
-     *
-     * @param array $array
-     * @return boolean
-     */
-    public static function is_associative_array(array $array): bool
-    {
-        return ! empty($array) && array_keys($array) !== range(0, count($array) - 1);
-    }
-
-    /**
-     * Gets an item from the array and leave the array intact. Use in place of end()
-     * when you don't want to change the array
-     *
-     * @param array $arr
-     * @return mixed what ever is in the array
-     */
-    public static function get_one_item_from_array($arr)
-    {
-        $item = end($arr);
-        reset($arr);
-        return $item;
-    }
-
-    /**
-     * Detects if this is a multi-dimensional array (meaning that the top-level
-     * values are themselves array. Eg array(array(...),...)
-     *
-     * @param mixed $arr
-     * @return boolean
-     */
-    public static function is_multi_dimensional_array($arr)
-    {
-        if (is_array($arr)) {
-            $first_item = reset($arr);
-            if (is_array($first_item)) {
-                return true;// yep, there's at least 2 levels to this array
-            } else {
-                return false;// nope, only 1 level
-            }
-        } else {
-            return false;// its not an array at all!
-        }
-    }
-
-    /**
-     * Shorthand for isset( $arr[ $index ] ) ? $arr[ $index ] : $default
-     *
-     * @param array $arr
-     * @param mixed $index
-     * @param mixed $default
-     * @return mixed
-     */
-    public static function is_set($arr, $index, $default)
-    {
-        return isset($arr[ $index ]) ? $arr[ $index ] : $default;
-    }
-
-    /**
-     * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
-     *
-     * @param mixed $value usually a string, but could be an array or object
-     * @return mixed the UN-serialized data
-     */
-    public static function maybe_unserialize($value)
-    {
-        $data = maybe_unserialize($value);
-        // it's possible that this still has serialized data if its the session.  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesnt' unserialize this automatically.
-        $token = 'C';
-        $data = is_string($data) ? trim($data) : $data;
-        if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^{$token}:[0-9]+:/s", $data)) {
-            return unserialize($data);
-        } else {
-            return $data;
-        }
-    }
-
-
-    /**
-     * insert_into_array
-     *
-     * @param array        $target_array the array to insert new data into
-     * @param array        $array_to_insert the new data to be inserted
-     * @param int | string $offset a known key within $target_array where new data will be inserted
-     * @param bool         $add_before whether to add new data before or after the offset key
-     * @param bool         $preserve_keys whether or not to reset numerically indexed arrays
-     * @return array
-     */
-    public static function insert_into_array(
-        $target_array = array(),
-        $array_to_insert = array(),
-        $offset = null,
-        $add_before = true,
-        $preserve_keys = true
-    ) {
-        // ensure incoming arrays are actually arrays
-        $target_array = (array) $target_array;
-        $array_to_insert = (array) $array_to_insert;
-        // if no offset key was supplied
-        if (empty($offset)) {
-            // use start or end of $target_array based on whether we are adding before or not
-            $offset = $add_before ? 0 : count($target_array);
-        }
-        // if offset key is a string, then find the corresponding numeric location for that element
-        $offset = is_int($offset) ? $offset : array_search($offset, array_keys($target_array));
-        // add one to the offset if adding after
-        $offset = $add_before ? $offset : $offset + 1;
-        // but ensure offset does not exceed the length of the array
-        $offset = $offset > count($target_array) ? count($target_array) : $offset;
-        // reindex array ???
-        if ($preserve_keys) {
-            // take a slice of the target array from the beginning till the offset,
-            // then add the new data
-            // then add another slice that starts at the offset and goes till the end
-            return array_slice($target_array, 0, $offset, true) + $array_to_insert + array_slice(
-                $target_array,
-                $offset,
-                null,
-                true
-            );
-        } else {
-            // since we don't want to preserve keys, we can use array_splice
-            array_splice($target_array, $offset, 0, $array_to_insert);
-            return $target_array;
-        }
-    }
-
-
-    /**
-     * array_merge() is slow and should never be used while looping over data
-     * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
-     * so really this acts more like array_replace( $array1, $array2 )
-     * or a union with the arrays flipped ( $array2 + $array1 )
-     * this saves a few lines of code and improves readability
-     *
-     * @param array $array1
-     * @param array $array2
-     * @return array
-     */
-    public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
-    {
-        foreach ($array2 as $key => $value) {
-            $array1[ $key ] = $value;
-        }
-        return $array1;
-    }
-
-
-    /**
-     * given a flat array like $array = array('A', 'B', 'C')
-     * will convert into a multidimensional array like $array[A][B][C]
-     * if $final_value is provided and is anything other than null,
-     * then that will be set as the value for the innermost array key
-     * like so: $array[A][B][C] = $final_value
-     *
-     * @param array $flat_array
-     * @param mixed $final_value
-     * @return array
-     */
-    public static function convert_array_values_to_keys(array $flat_array, $final_value = null)
-    {
-        $multidimensional = array();
-        $reference = &$multidimensional;
-        foreach ($flat_array as $key) {
-            $reference[ $key ] = array();
-            $reference = &$reference[ $key ];
-        }
-        if ($final_value !== null) {
-            $reference = $final_value;
-        }
-        return $multidimensional;
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    public static function is_array_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
-    }
+	/**
+	 * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
+	 * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
+	 *
+	 * @uses array_udiff core php function for setting up our own array comparison
+	 * @uses self::_compare_objects as the custom method for array_udiff
+	 * @param  array $array1 an array of objects
+	 * @param  array $array2 an array of objects
+	 * @return array         an array of objects found in array 1 that aren't found in array 2.
+	 */
+	public static function object_array_diff($array1, $array2)
+	{
+		return array_udiff($array1, $array2, array('self', '_compare_objects'));
+	}
+
+	/**
+	 * Given that $arr is an array, determines if it's associative or numerically AND sequentially indexed
+	 *
+	 * @param array $array
+	 * @return boolean
+	 */
+	public static function is_associative_array(array $array): bool
+	{
+		return ! empty($array) && array_keys($array) !== range(0, count($array) - 1);
+	}
+
+	/**
+	 * Gets an item from the array and leave the array intact. Use in place of end()
+	 * when you don't want to change the array
+	 *
+	 * @param array $arr
+	 * @return mixed what ever is in the array
+	 */
+	public static function get_one_item_from_array($arr)
+	{
+		$item = end($arr);
+		reset($arr);
+		return $item;
+	}
+
+	/**
+	 * Detects if this is a multi-dimensional array (meaning that the top-level
+	 * values are themselves array. Eg array(array(...),...)
+	 *
+	 * @param mixed $arr
+	 * @return boolean
+	 */
+	public static function is_multi_dimensional_array($arr)
+	{
+		if (is_array($arr)) {
+			$first_item = reset($arr);
+			if (is_array($first_item)) {
+				return true;// yep, there's at least 2 levels to this array
+			} else {
+				return false;// nope, only 1 level
+			}
+		} else {
+			return false;// its not an array at all!
+		}
+	}
+
+	/**
+	 * Shorthand for isset( $arr[ $index ] ) ? $arr[ $index ] : $default
+	 *
+	 * @param array $arr
+	 * @param mixed $index
+	 * @param mixed $default
+	 * @return mixed
+	 */
+	public static function is_set($arr, $index, $default)
+	{
+		return isset($arr[ $index ]) ? $arr[ $index ] : $default;
+	}
+
+	/**
+	 * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
+	 *
+	 * @param mixed $value usually a string, but could be an array or object
+	 * @return mixed the UN-serialized data
+	 */
+	public static function maybe_unserialize($value)
+	{
+		$data = maybe_unserialize($value);
+		// it's possible that this still has serialized data if its the session.  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesnt' unserialize this automatically.
+		$token = 'C';
+		$data = is_string($data) ? trim($data) : $data;
+		if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^{$token}:[0-9]+:/s", $data)) {
+			return unserialize($data);
+		} else {
+			return $data;
+		}
+	}
+
+
+	/**
+	 * insert_into_array
+	 *
+	 * @param array        $target_array the array to insert new data into
+	 * @param array        $array_to_insert the new data to be inserted
+	 * @param int | string $offset a known key within $target_array where new data will be inserted
+	 * @param bool         $add_before whether to add new data before or after the offset key
+	 * @param bool         $preserve_keys whether or not to reset numerically indexed arrays
+	 * @return array
+	 */
+	public static function insert_into_array(
+		$target_array = array(),
+		$array_to_insert = array(),
+		$offset = null,
+		$add_before = true,
+		$preserve_keys = true
+	) {
+		// ensure incoming arrays are actually arrays
+		$target_array = (array) $target_array;
+		$array_to_insert = (array) $array_to_insert;
+		// if no offset key was supplied
+		if (empty($offset)) {
+			// use start or end of $target_array based on whether we are adding before or not
+			$offset = $add_before ? 0 : count($target_array);
+		}
+		// if offset key is a string, then find the corresponding numeric location for that element
+		$offset = is_int($offset) ? $offset : array_search($offset, array_keys($target_array));
+		// add one to the offset if adding after
+		$offset = $add_before ? $offset : $offset + 1;
+		// but ensure offset does not exceed the length of the array
+		$offset = $offset > count($target_array) ? count($target_array) : $offset;
+		// reindex array ???
+		if ($preserve_keys) {
+			// take a slice of the target array from the beginning till the offset,
+			// then add the new data
+			// then add another slice that starts at the offset and goes till the end
+			return array_slice($target_array, 0, $offset, true) + $array_to_insert + array_slice(
+				$target_array,
+				$offset,
+				null,
+				true
+			);
+		} else {
+			// since we don't want to preserve keys, we can use array_splice
+			array_splice($target_array, $offset, 0, $array_to_insert);
+			return $target_array;
+		}
+	}
+
+
+	/**
+	 * array_merge() is slow and should never be used while looping over data
+	 * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
+	 * so really this acts more like array_replace( $array1, $array2 )
+	 * or a union with the arrays flipped ( $array2 + $array1 )
+	 * this saves a few lines of code and improves readability
+	 *
+	 * @param array $array1
+	 * @param array $array2
+	 * @return array
+	 */
+	public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
+	{
+		foreach ($array2 as $key => $value) {
+			$array1[ $key ] = $value;
+		}
+		return $array1;
+	}
+
+
+	/**
+	 * given a flat array like $array = array('A', 'B', 'C')
+	 * will convert into a multidimensional array like $array[A][B][C]
+	 * if $final_value is provided and is anything other than null,
+	 * then that will be set as the value for the innermost array key
+	 * like so: $array[A][B][C] = $final_value
+	 *
+	 * @param array $flat_array
+	 * @param mixed $final_value
+	 * @return array
+	 */
+	public static function convert_array_values_to_keys(array $flat_array, $final_value = null)
+	{
+		$multidimensional = array();
+		$reference = &$multidimensional;
+		foreach ($flat_array as $key) {
+			$reference[ $key ] = array();
+			$reference = &$reference[ $key ];
+		}
+		if ($final_value !== null) {
+			$reference = $final_value;
+		}
+		return $multidimensional;
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	public static function is_array_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
+	}
 }