eventespresso / event-espresso-core

core/services/encryption/EncryptionKeyManagerInterface.php

Indentation +81 added lines, -81 removed lines

@@ -12,85 +12,85 @@
  */
 interface EncryptionKeyManagerInterface
 {
-    /**
-     * add an encryption key
-     *
-     * @param string $encryption_key_identifier - name of the encryption key to use
-     * @param string $encryption_key            - cryptographically secure passphrase. will generate if necessary
-     * @param bool   $overwrite                 - prevents accidental overwriting of an existing key which would be bad
-     * @return bool
-     */
-    public function addEncryptionKey($encryption_key_identifier, $encryption_key = '', $overwrite = false);
-
-
-    /**
-     * returns true if encryption key has already been generated
-     *
-     * @param string $encryption_key_identifier - encryption key name
-     * @return bool
-     */
-    public function encryptionKeyExists($encryption_key_identifier = '');
-
-
-    /**
-     * returns cryptographically secure passphrase. will use default if necessary
-     *
-     * @param string $encryption_key_identifier - encryption key name. will use default if necessary
-     * @param bool   $generate                  - will generate a new key if the requested one does not exist
-     * @param bool   $throw_exception           - if TRUE (default), will throw an exception if key is not found
-     * @return string
-     */
-    public function getEncryptionKey($encryption_key_identifier = '', $generate = false, $throw_exception = true);
-
-
-    /**
-     * creates a new encryption key
-     *
-     * @param bool $strong if true (default) will attempt to generate a cryptographically secure key
-     * @return string
-     */
-    public function generateEncryptionKey($strong = true);
-
-
-    /**
-     * @return int
-     */
-    public function bitDepth();
-
-
-    /**
-     * @param int $bit_depth options are 64, 128, 192, or 256
-     */
-    public function setBitDepth($bit_depth);
-
-
-    /**
-     * @return int
-     */
-    public function keyLength();
-
-
-    /**
-     * @param int $key_length
-     */
-    public function setKeyLength($key_length);
-
-
-    /**
-     * deletes ALL existing encryption keys from the db
-     *
-     * @return bool true if keys successfully deleted, false otherwise.
-     */
-    public function removeAllEncryptionKeys();
-
-
-    /**
-     * deletes an existing encryption key from those saved in the db
-     *
-     * @param string $encryption_key_identifier encryption key name
-     * @return int  1: key removed successfully.
-     *              0: key did not exist.
-     *             -1: failed to remove key
-     */
-    public function removeEncryptionKey($encryption_key_identifier = '');
+	/**
+	 * add an encryption key
+	 *
+	 * @param string $encryption_key_identifier - name of the encryption key to use
+	 * @param string $encryption_key            - cryptographically secure passphrase. will generate if necessary
+	 * @param bool   $overwrite                 - prevents accidental overwriting of an existing key which would be bad
+	 * @return bool
+	 */
+	public function addEncryptionKey($encryption_key_identifier, $encryption_key = '', $overwrite = false);
+
+
+	/**
+	 * returns true if encryption key has already been generated
+	 *
+	 * @param string $encryption_key_identifier - encryption key name
+	 * @return bool
+	 */
+	public function encryptionKeyExists($encryption_key_identifier = '');
+
+
+	/**
+	 * returns cryptographically secure passphrase. will use default if necessary
+	 *
+	 * @param string $encryption_key_identifier - encryption key name. will use default if necessary
+	 * @param bool   $generate                  - will generate a new key if the requested one does not exist
+	 * @param bool   $throw_exception           - if TRUE (default), will throw an exception if key is not found
+	 * @return string
+	 */
+	public function getEncryptionKey($encryption_key_identifier = '', $generate = false, $throw_exception = true);
+
+
+	/**
+	 * creates a new encryption key
+	 *
+	 * @param bool $strong if true (default) will attempt to generate a cryptographically secure key
+	 * @return string
+	 */
+	public function generateEncryptionKey($strong = true);
+
+
+	/**
+	 * @return int
+	 */
+	public function bitDepth();
+
+
+	/**
+	 * @param int $bit_depth options are 64, 128, 192, or 256
+	 */
+	public function setBitDepth($bit_depth);
+
+
+	/**
+	 * @return int
+	 */
+	public function keyLength();
+
+
+	/**
+	 * @param int $key_length
+	 */
+	public function setKeyLength($key_length);
+
+
+	/**
+	 * deletes ALL existing encryption keys from the db
+	 *
+	 * @return bool true if keys successfully deleted, false otherwise.
+	 */
+	public function removeAllEncryptionKeys();
+
+
+	/**
+	 * deletes an existing encryption key from those saved in the db
+	 *
+	 * @param string $encryption_key_identifier encryption key name
+	 * @return int  1: key removed successfully.
+	 *              0: key did not exist.
+	 *             -1: failed to remove key
+	 */
+	public function removeEncryptionKey($encryption_key_identifier = '');
 }

core/services/encryption/EncryptionKeyManager.php

Indentation +297 added lines, -297 removed lines

@@ -16,301 +16,301 @@
  */
 class EncryptionKeyManager implements EncryptionKeyManagerInterface
 {
-    /**
-     * @var Base64Encoder
-     */
-    protected $base64_encoder;
-
-    /**
-     * name used for a default encryption key in case no others are set
-     *
-     * @var string
-     */
-    private $default_encryption_key_id;
-
-    /**
-     * name used for saving encryption keys to the wp_options table
-     *
-     * @var string
-     */
-    private $encryption_keys_option_name;
-
-    /**
-     * @var array
-     */
-    private $encryption_keys = null;
-
-    /**
-     * number of bits used when generating cryptographically secure keys
-     *
-     * @var int
-     */
-    private $bit_depth = 128;
-
-    /**
-     * @var int[]
-     */
-    private $bit_depth_options = [64, 128, 192, 256];
-
-    /**
-     * number of characters used when generating cryptographically weak keys
-     *
-     * @var int
-     */
-    private $key_length = 40;
-
-
-    /**
-     * @param Base64Encoder $base64_encoder
-     * @param string        $default_encryption_key_id
-     * @param string        $encryption_keys_option_name
-     */
-    public function __construct(Base64Encoder $base64_encoder, $default_encryption_key_id, $encryption_keys_option_name)
-    {
-        $this->base64_encoder              = $base64_encoder;
-        $this->default_encryption_key_id   = $default_encryption_key_id;
-        $this->encryption_keys_option_name = $encryption_keys_option_name;
-    }
-
-
-    /**
-     * add an encryption key
-     *
-     * @param string $encryption_key_identifier - name of the encryption key to use
-     * @param string $encryption_key            - cryptographically secure passphrase. will generate if necessary
-     * @param bool   $overwrite                 - prevents accidental overwriting of an existing key which would be bad
-     * @return bool
-     * @throws Exception
-     */
-    public function addEncryptionKey($encryption_key_identifier, $encryption_key = '', $overwrite = false)
-    {
-        $encryption_key_identifier = $encryption_key_identifier ?: $this->default_encryption_key_id;
-        if ($this->encryptionKeyExists($encryption_key_identifier) && ! $overwrite) {
-            // WOAH!!! that key already exists and we don't want to overwrite it
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" encryption key already exists and can not be overwritten because previously encrypted values would no longer be capable of being decrypted.',
-                        'event_espresso'
-                    ),
-                    $encryption_key_identifier
-                )
-            );
-        }
-        $this->encryption_keys[ $encryption_key_identifier ] = $encryption_key ?: $this->generateEncryptionKey();
-        return $this->saveEncryptionKeys();
-    }
-
-
-    /**
-     * returns true if encryption key has already been generated
-     *
-     * @param string $encryption_key_identifier - encryption key name
-     * @return bool
-     * @throws Exception
-     * @throws OutOfBoundsException
-     */
-    public function encryptionKeyExists($encryption_key_identifier = '')
-    {
-        // ensure keys are loaded
-        $this->retrieveEncryptionKeys();
-        return isset($this->encryption_keys[ $encryption_key_identifier ]);
-    }
-
-
-    /**
-     * returns cryptographically secure passphrase. will use default if necessary
-     *
-     * @param string $encryption_key_identifier - encryption key name. will use default if necessary
-     * @param bool   $generate                  - will generate a new key if the requested one does not exist
-     * @param bool   $throw_exception           - if TRUE (default), will throw an exception if key is not found
-     * @return string
-     * @throws Exception
-     */
-    public function getEncryptionKey($encryption_key_identifier = '', $generate = true, $throw_exception = true)
-    {
-        $encryption_key_identifier = $encryption_key_identifier ?: $this->default_encryption_key_id;
-        // if encryption key has not been set
-        if (! $this->encryptionKeyExists($encryption_key_identifier)) {
-            if ($generate) {
-                $this->addEncryptionKey($encryption_key_identifier);
-            } else {
-                if (! $throw_exception) {
-                    return '';
-                }
-                throw new OutOfBoundsException(
-                    sprintf(
-                        esc_html__('The "%1$s" encryption key was not found or is invalid.', 'event_espresso'),
-                        $encryption_key_identifier
-                    )
-                );
-            }
-        }
-        return $this->encryption_keys[ $encryption_key_identifier ];
-    }
-
-
-    /**
-     * creates a new encryption key
-     *
-     * @param bool $strong if true (default) will attempt to generate a cryptographically secure key
-     * @return string
-     * @throws Exception
-     */
-    public function generateEncryptionKey($strong = true)
-    {
-        return $strong && PHP_VERSION_ID >= 70100
-            ? $this->generateStrongEncryptionKey()
-            : $this->generateWeakEncryptionKey();
-    }
-
-
-    /**
-     * creates a new cryptographically secure encryption key
-     *
-     * @return string
-     * @throws Exception
-     */
-    protected function generateStrongEncryptionKey()
-    {
-        // bit_depth needs to be divided by 8 to convert to bytes
-        return $this->base64_encoder->encodeString(random_bytes($this->bit_depth / 8));
-    }
-
-
-    /**
-     * creates a new encryption key that should not be trusted to be cryptographically secure
-     *
-     * @return string
-     * @throws Exception
-     */
-    protected function generateWeakEncryptionKey()
-    {
-        // @see http://stackoverflow.com/questions/637278/what-is-the-best-way-to-generate-a-random-key-within-php
-        $iterations    = ceil($this->key_length / 40);
-        $random_string = '';
-        for ($i = 0; $i < $iterations; $i++) {
-            $random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
-        }
-        $random_string = (string) substr($random_string, 0, $this->key_length);
-        return $this->base64_encoder->encodeString($random_string);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function bitDepth()
-    {
-        return $this->bit_depth;
-    }
-
-
-    /**
-     * @param int $bit_depth options are 64, 128, 192, or 256
-     */
-    public function setBitDepth($bit_depth)
-    {
-        $bit_depth       = absint($bit_depth);
-        $this->bit_depth = in_array($bit_depth, $this->bit_depth_options, true) ? $bit_depth : 128;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function keyLength()
-    {
-        return $this->key_length;
-    }
-
-
-    /**
-     * @param int $key_length
-     */
-    public function setKeyLength($key_length)
-    {
-        // let's not let the key length go below 8 or above 128
-        $this->key_length = min(max(absint($key_length), 8), 128);
-    }
-
-
-    /**
-     * deletes ALL existing encryption keys from the db
-     *
-     * @return bool true if keys successfully deleted, false otherwise.
-     */
-    public function removeAllEncryptionKeys()
-    {
-        return delete_option($this->encryption_keys_option_name);
-    }
-
-
-    /**
-     * deletes an existing encryption key from those saved in the db
-     *
-     * @param string $encryption_key_identifier encryption key name
-     * @return int  1: key removed successfully.
-     *              0: key did not exist.
-     *             -1: failed to remove key
-     * @throws Exception
-     */
-    public function removeEncryptionKey($encryption_key_identifier = '')
-    {
-        // if encryption key has not been set
-        if (! $this->encryptionKeyExists($encryption_key_identifier)) {
-            return 0;
-        }
-        unset($this->encryption_keys[ $encryption_key_identifier ]);
-        return $this->saveEncryptionKeys() ? 1 : -1;
-    }
-
-
-    /**
-     * retrieves encryption keys from db
-     *
-     * @return array
-     * @throws Exception
-     * @throws RuntimeException
-     */
-    protected function retrieveEncryptionKeys()
-    {
-        // if encryption key has not been set
-        if (empty($this->encryption_keys)) {
-            // retrieve encryption_key from db
-            $this->encryption_keys = get_option($this->encryption_keys_option_name, null);
-            // WHAT?? No encryption keys in the db ??
-            if ($this->encryption_keys === null) {
-                $this->encryption_keys = [];
-                // let's create the default key and save it
-                $new_key                                                   = $this->generateEncryptionKey();
-                $this->encryption_keys[ $this->default_encryption_key_id ] = $new_key;
-                if (! $this->saveEncryptionKeys(true)) {
-                    throw new RuntimeException(
-                        sprintf(
-                            esc_html__(
-                                'Failed to save the "%1$s" encryption keys array to the database.',
-                                'event_espresso'
-                            ),
-                            $this->encryption_keys_option_name
-                        )
-                    );
-                }
-            }
-        }
-        return $this->encryption_keys;
-    }
-
-
-    /**
-     * saves encryption keys from db
-     *
-     * @return bool
-     */
-    protected function saveEncryptionKeys($initialize = false)
-    {
-        return $initialize
-            ? add_option($this->encryption_keys_option_name, $this->encryption_keys, '', false)
-            : update_option($this->encryption_keys_option_name, $this->encryption_keys, false);
-    }
+	/**
+	 * @var Base64Encoder
+	 */
+	protected $base64_encoder;
+
+	/**
+	 * name used for a default encryption key in case no others are set
+	 *
+	 * @var string
+	 */
+	private $default_encryption_key_id;
+
+	/**
+	 * name used for saving encryption keys to the wp_options table
+	 *
+	 * @var string
+	 */
+	private $encryption_keys_option_name;
+
+	/**
+	 * @var array
+	 */
+	private $encryption_keys = null;
+
+	/**
+	 * number of bits used when generating cryptographically secure keys
+	 *
+	 * @var int
+	 */
+	private $bit_depth = 128;
+
+	/**
+	 * @var int[]
+	 */
+	private $bit_depth_options = [64, 128, 192, 256];
+
+	/**
+	 * number of characters used when generating cryptographically weak keys
+	 *
+	 * @var int
+	 */
+	private $key_length = 40;
+
+
+	/**
+	 * @param Base64Encoder $base64_encoder
+	 * @param string        $default_encryption_key_id
+	 * @param string        $encryption_keys_option_name
+	 */
+	public function __construct(Base64Encoder $base64_encoder, $default_encryption_key_id, $encryption_keys_option_name)
+	{
+		$this->base64_encoder              = $base64_encoder;
+		$this->default_encryption_key_id   = $default_encryption_key_id;
+		$this->encryption_keys_option_name = $encryption_keys_option_name;
+	}
+
+
+	/**
+	 * add an encryption key
+	 *
+	 * @param string $encryption_key_identifier - name of the encryption key to use
+	 * @param string $encryption_key            - cryptographically secure passphrase. will generate if necessary
+	 * @param bool   $overwrite                 - prevents accidental overwriting of an existing key which would be bad
+	 * @return bool
+	 * @throws Exception
+	 */
+	public function addEncryptionKey($encryption_key_identifier, $encryption_key = '', $overwrite = false)
+	{
+		$encryption_key_identifier = $encryption_key_identifier ?: $this->default_encryption_key_id;
+		if ($this->encryptionKeyExists($encryption_key_identifier) && ! $overwrite) {
+			// WOAH!!! that key already exists and we don't want to overwrite it
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'The "%1$s" encryption key already exists and can not be overwritten because previously encrypted values would no longer be capable of being decrypted.',
+						'event_espresso'
+					),
+					$encryption_key_identifier
+				)
+			);
+		}
+		$this->encryption_keys[ $encryption_key_identifier ] = $encryption_key ?: $this->generateEncryptionKey();
+		return $this->saveEncryptionKeys();
+	}
+
+
+	/**
+	 * returns true if encryption key has already been generated
+	 *
+	 * @param string $encryption_key_identifier - encryption key name
+	 * @return bool
+	 * @throws Exception
+	 * @throws OutOfBoundsException
+	 */
+	public function encryptionKeyExists($encryption_key_identifier = '')
+	{
+		// ensure keys are loaded
+		$this->retrieveEncryptionKeys();
+		return isset($this->encryption_keys[ $encryption_key_identifier ]);
+	}
+
+
+	/**
+	 * returns cryptographically secure passphrase. will use default if necessary
+	 *
+	 * @param string $encryption_key_identifier - encryption key name. will use default if necessary
+	 * @param bool   $generate                  - will generate a new key if the requested one does not exist
+	 * @param bool   $throw_exception           - if TRUE (default), will throw an exception if key is not found
+	 * @return string
+	 * @throws Exception
+	 */
+	public function getEncryptionKey($encryption_key_identifier = '', $generate = true, $throw_exception = true)
+	{
+		$encryption_key_identifier = $encryption_key_identifier ?: $this->default_encryption_key_id;
+		// if encryption key has not been set
+		if (! $this->encryptionKeyExists($encryption_key_identifier)) {
+			if ($generate) {
+				$this->addEncryptionKey($encryption_key_identifier);
+			} else {
+				if (! $throw_exception) {
+					return '';
+				}
+				throw new OutOfBoundsException(
+					sprintf(
+						esc_html__('The "%1$s" encryption key was not found or is invalid.', 'event_espresso'),
+						$encryption_key_identifier
+					)
+				);
+			}
+		}
+		return $this->encryption_keys[ $encryption_key_identifier ];
+	}
+
+
+	/**
+	 * creates a new encryption key
+	 *
+	 * @param bool $strong if true (default) will attempt to generate a cryptographically secure key
+	 * @return string
+	 * @throws Exception
+	 */
+	public function generateEncryptionKey($strong = true)
+	{
+		return $strong && PHP_VERSION_ID >= 70100
+			? $this->generateStrongEncryptionKey()
+			: $this->generateWeakEncryptionKey();
+	}
+
+
+	/**
+	 * creates a new cryptographically secure encryption key
+	 *
+	 * @return string
+	 * @throws Exception
+	 */
+	protected function generateStrongEncryptionKey()
+	{
+		// bit_depth needs to be divided by 8 to convert to bytes
+		return $this->base64_encoder->encodeString(random_bytes($this->bit_depth / 8));
+	}
+
+
+	/**
+	 * creates a new encryption key that should not be trusted to be cryptographically secure
+	 *
+	 * @return string
+	 * @throws Exception
+	 */
+	protected function generateWeakEncryptionKey()
+	{
+		// @see http://stackoverflow.com/questions/637278/what-is-the-best-way-to-generate-a-random-key-within-php
+		$iterations    = ceil($this->key_length / 40);
+		$random_string = '';
+		for ($i = 0; $i < $iterations; $i++) {
+			$random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
+		}
+		$random_string = (string) substr($random_string, 0, $this->key_length);
+		return $this->base64_encoder->encodeString($random_string);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function bitDepth()
+	{
+		return $this->bit_depth;
+	}
+
+
+	/**
+	 * @param int $bit_depth options are 64, 128, 192, or 256
+	 */
+	public function setBitDepth($bit_depth)
+	{
+		$bit_depth       = absint($bit_depth);
+		$this->bit_depth = in_array($bit_depth, $this->bit_depth_options, true) ? $bit_depth : 128;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function keyLength()
+	{
+		return $this->key_length;
+	}
+
+
+	/**
+	 * @param int $key_length
+	 */
+	public function setKeyLength($key_length)
+	{
+		// let's not let the key length go below 8 or above 128
+		$this->key_length = min(max(absint($key_length), 8), 128);
+	}
+
+
+	/**
+	 * deletes ALL existing encryption keys from the db
+	 *
+	 * @return bool true if keys successfully deleted, false otherwise.
+	 */
+	public function removeAllEncryptionKeys()
+	{
+		return delete_option($this->encryption_keys_option_name);
+	}
+
+
+	/**
+	 * deletes an existing encryption key from those saved in the db
+	 *
+	 * @param string $encryption_key_identifier encryption key name
+	 * @return int  1: key removed successfully.
+	 *              0: key did not exist.
+	 *             -1: failed to remove key
+	 * @throws Exception
+	 */
+	public function removeEncryptionKey($encryption_key_identifier = '')
+	{
+		// if encryption key has not been set
+		if (! $this->encryptionKeyExists($encryption_key_identifier)) {
+			return 0;
+		}
+		unset($this->encryption_keys[ $encryption_key_identifier ]);
+		return $this->saveEncryptionKeys() ? 1 : -1;
+	}
+
+
+	/**
+	 * retrieves encryption keys from db
+	 *
+	 * @return array
+	 * @throws Exception
+	 * @throws RuntimeException
+	 */
+	protected function retrieveEncryptionKeys()
+	{
+		// if encryption key has not been set
+		if (empty($this->encryption_keys)) {
+			// retrieve encryption_key from db
+			$this->encryption_keys = get_option($this->encryption_keys_option_name, null);
+			// WHAT?? No encryption keys in the db ??
+			if ($this->encryption_keys === null) {
+				$this->encryption_keys = [];
+				// let's create the default key and save it
+				$new_key                                                   = $this->generateEncryptionKey();
+				$this->encryption_keys[ $this->default_encryption_key_id ] = $new_key;
+				if (! $this->saveEncryptionKeys(true)) {
+					throw new RuntimeException(
+						sprintf(
+							esc_html__(
+								'Failed to save the "%1$s" encryption keys array to the database.',
+								'event_espresso'
+							),
+							$this->encryption_keys_option_name
+						)
+					);
+				}
+			}
+		}
+		return $this->encryption_keys;
+	}
+
+
+	/**
+	 * saves encryption keys from db
+	 *
+	 * @return bool
+	 */
+	protected function saveEncryptionKeys($initialize = false)
+	{
+		return $initialize
+			? add_option($this->encryption_keys_option_name, $this->encryption_keys, '', false)
+			: update_option($this->encryption_keys_option_name, $this->encryption_keys, false);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -97,7 +97,7 @@ 
                 )
             );
         }
-        $this->encryption_keys[ $encryption_key_identifier ] = $encryption_key ?: $this->generateEncryptionKey();
+        $this->encryption_keys[$encryption_key_identifier] = $encryption_key ?: $this->generateEncryptionKey();
         return $this->saveEncryptionKeys();
     }
 
@@ -114,7 +114,7 @@ 
     {
         // ensure keys are loaded
         $this->retrieveEncryptionKeys();
-        return isset($this->encryption_keys[ $encryption_key_identifier ]);
+        return isset($this->encryption_keys[$encryption_key_identifier]);
     }
 
 
@@ -131,11 +131,11 @@ 
     {
         $encryption_key_identifier = $encryption_key_identifier ?: $this->default_encryption_key_id;
         // if encryption key has not been set
-        if (! $this->encryptionKeyExists($encryption_key_identifier)) {
+        if ( ! $this->encryptionKeyExists($encryption_key_identifier)) {
             if ($generate) {
                 $this->addEncryptionKey($encryption_key_identifier);
             } else {
-                if (! $throw_exception) {
+                if ( ! $throw_exception) {
                     return '';
                 }
                 throw new OutOfBoundsException(
@@ -146,7 +146,7 @@ 
                 );
             }
         }
-        return $this->encryption_keys[ $encryption_key_identifier ];
+        return $this->encryption_keys[$encryption_key_identifier];
     }
 
 
@@ -190,7 +190,7 @@ 
         $iterations    = ceil($this->key_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 = (string) substr($random_string, 0, $this->key_length);
         return $this->base64_encoder->encodeString($random_string);
@@ -258,10 +258,10 @@ 
     public function removeEncryptionKey($encryption_key_identifier = '')
     {
         // if encryption key has not been set
-        if (! $this->encryptionKeyExists($encryption_key_identifier)) {
+        if ( ! $this->encryptionKeyExists($encryption_key_identifier)) {
             return 0;
         }
-        unset($this->encryption_keys[ $encryption_key_identifier ]);
+        unset($this->encryption_keys[$encryption_key_identifier]);
         return $this->saveEncryptionKeys() ? 1 : -1;
     }
 
@@ -284,8 +284,8 @@ 
                 $this->encryption_keys = [];
                 // let's create the default key and save it
                 $new_key                                                   = $this->generateEncryptionKey();
-                $this->encryption_keys[ $this->default_encryption_key_id ] = $new_key;
-                if (! $this->saveEncryptionKeys(true)) {
+                $this->encryption_keys[$this->default_encryption_key_id] = $new_key;
+                if ( ! $this->saveEncryptionKeys(true)) {
                     throw new RuntimeException(
                         sprintf(
                             esc_html__(

public/Espresso_Arabica_2014/content-espresso_events-details.php

Indentation +11 added lines, -11 removed lines

@@ -13,20 +13,20 @@
 	    <?php if ( ! post_password_required() && ( comments_open() || get_comments_number() ) ) : ?>
 	    <span class="comments-link">
         <?php comments_popup_link(
-            esc_html__( 'Leave a comment', 'event_espresso' ),
-            esc_html__( '1 Comment', 'event_espresso' ),
-            esc_html__( '% Comments', 'event_espresso' )
-        ); ?>
+			esc_html__( 'Leave a comment', 'event_espresso' ),
+			esc_html__( '1 Comment', 'event_espresso' ),
+			esc_html__( '% Comments', 'event_espresso' )
+		); ?>
         </span>
 
         <?php
-            endif;
-            edit_post_link(
-                esc_html__( 'Edit', 'event_espresso' ),
-                '<span class="edit-link">',
-                '</span>'
-            );
-        ?>
+			endif;
+			edit_post_link(
+				esc_html__( 'Edit', 'event_espresso' ),
+				'<span class="edit-link">',
+				'</span>'
+			);
+		?>
 	</div>
 
 <?php endif;

Spacing +15 added lines, -15 removed lines

@@ -4,27 +4,27 @@ 
 <div class="event-content">
 <?php use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
-if ( apply_filters( 'FHEE__content_espresso_events_details_template__display_entry_meta', TRUE )): ?>
+if (apply_filters('FHEE__content_espresso_events_details_template__display_entry_meta', TRUE)): ?>
 
 	<div class="entry-meta">
 
 		<span class="tags-links">
-            <?php espresso_event_categories( $post->ID, TRUE, TRUE ); ?>
+            <?php espresso_event_categories($post->ID, TRUE, TRUE); ?>
         </span>
 
-	    <?php if ( ! post_password_required() && ( comments_open() || get_comments_number() ) ) : ?>
+	    <?php if ( ! post_password_required() && (comments_open() || get_comments_number())) : ?>
 	    <span class="comments-link">
         <?php comments_popup_link(
-            esc_html__( 'Leave a comment', 'event_espresso' ),
-            esc_html__( '1 Comment', 'event_espresso' ),
-            esc_html__( '% Comments', 'event_espresso' )
+            esc_html__('Leave a comment', 'event_espresso'),
+            esc_html__('1 Comment', 'event_espresso'),
+            esc_html__('% Comments', 'event_espresso')
         ); ?>
         </span>
 
         <?php
             endif;
             edit_post_link(
-                esc_html__( 'Edit', 'event_espresso' ),
+                esc_html__('Edit', 'event_espresso'),
                 '<span class="edit-link">',
                 '</span>'
             );
@@ -32,25 +32,25 @@ 
 	</div>
 
 <?php endif;
-	$event_phone = espresso_event_phone( $post->ID, FALSE );
+	$event_phone = espresso_event_phone($post->ID, FALSE);
 
-	if ( $event_phone != '' ) : ?>
+	if ($event_phone != '') : ?>
 	<p class="event-phone">
 		<span class="small-text">
-            <strong><?php esc_html_e( 'Event Phone:', 'event_espresso' ); ?> </strong>
+            <strong><?php esc_html_e('Event Phone:', 'event_espresso'); ?> </strong>
         </span>
         <?php echo wp_kses($event_phone, AllowedTags::getAllowedTags()); ?>
 	</p>
-<?php endif;  ?>
+<?php endif; ?>
 
 <?php
-	if ( apply_filters( 'FHEE__content_espresso_events_details_template__display_the_content', true ) ) {
-		do_action( 'AHEE_event_details_before_the_content', $post );
+	if (apply_filters('FHEE__content_espresso_events_details_template__display_the_content', true)) {
+		do_action('AHEE_event_details_before_the_content', $post);
 		echo apply_filters(
 			'FHEE__content_espresso_events_details_template__the_content',
-			espresso_event_content_or_excerpt( 55, null, false ) 
+			espresso_event_content_or_excerpt(55, null, false) 
 		);
-		do_action( 'AHEE_event_details_after_the_content', $post );
+		do_action('AHEE_event_details_after_the_content', $post);
 	}
  ?>
 </div>

public/Espresso_Arabica_2014/content-espresso_venues-location.php

Spacing +4 added lines, -4 removed lines

@@ -1,16 +1,16 @@
 <?php //echo '<h1>' . __FILE__ . '</h1>'; 
 global $post; 
-if ( espresso_venue_has_address( $post->ID )) :
+if (espresso_venue_has_address($post->ID)) :
 ?>
 <div class="venue-location">
 	
 	<h3 class="venue-address-h3 ee-venue-h3">
-		<span class="dashicons dashicons-location-alt"></span><?php esc_html_e( 'Location', 'event_espresso' ); ?>
+		<span class="dashicons dashicons-location-alt"></span><?php esc_html_e('Location', 'event_espresso'); ?>
 	</h3>
-	<span class="small-text"><strong><?php esc_html_e( 'Address:', 'event_espresso' ); ?></strong></span><?php espresso_venue_address( 'inline', $post->ID ); ?>
+	<span class="small-text"><strong><?php esc_html_e('Address:', 'event_espresso'); ?></strong></span><?php espresso_venue_address('inline', $post->ID); ?>
 	<div class="clear"></div>
 
-	<div class="venue-gmap"><?php espresso_venue_gmap( $post->ID ); ?></div>
+	<div class="venue-gmap"><?php espresso_venue_gmap($post->ID); ?></div>
 	<div class="clear"></div>
 	
 </div>

public/Espresso_Arabica_2014/content-espresso_events-venues.php

Braces +10 added lines, -4 removed lines

@@ -51,8 +51,11 @@ 
 		<?php echo do_shortcode( $venue_description ); ?>
 	</p>
 		<?php endif;  ?>
-	<?php else : ?>
-		<?php $venue_excerpt = espresso_venue_excerpt( $VNU_ID, FALSE ); ?>
+	<?php else {
+	: ?>
+		<?php $venue_excerpt = espresso_venue_excerpt( $VNU_ID, FALSE );
+}
+?>
 		<?php if ( $venue_excerpt ) : ?>
 	<p>
 		<strong><?php esc_html_e( 'Description:', 'event_espresso' ); ?></strong><br/>
@@ -64,12 +67,15 @@ 
 <!-- .espresso-venue-dv -->
 <?php
 do_action( 'AHEE_event_details_after_venue_details', $post );
-else :
+else {
+	:
 	if ( espresso_venue_is_password_protected() ) :
 ?>
 	<div class="espresso-venue-dv  espresso-password-protected-venue-dv" >
 		<h3 class="event-venues-h3 ee-event-h3">
-			<?php esc_html_e( 'Location', 'event_espresso' );?>
+			<?php esc_html_e( 'Location', 'event_espresso' );
+}
+?>
 		</h3>
 		<?php echo espresso_password_protected_venue_form(); ?>
 	</div>

Spacing +32 added lines, -32 removed lines

@@ -3,75 +3,75 @@
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
 if (
-	( is_single() && espresso_display_venue_in_event_details() )
-	|| ( is_archive() && espresso_display_venue_in_event_list() )
+	(is_single() && espresso_display_venue_in_event_details())
+	|| (is_archive() && espresso_display_venue_in_event_list())
 ) :
 	global $post;
-	do_action( 'AHEE_event_details_before_venue_details', $post );
-	$venue_name = espresso_venue_name( 0, 'details', FALSE );
-	if ( empty( $venue_name ) && espresso_is_venue_private() ) {
-		do_action( 'AHEE_event_details_after_venue_details', $post );
+	do_action('AHEE_event_details_before_venue_details', $post);
+	$venue_name = espresso_venue_name(0, 'details', FALSE);
+	if (empty($venue_name) && espresso_is_venue_private()) {
+		do_action('AHEE_event_details_after_venue_details', $post);
 		return '';
 	}
 ?>
 
 <div class="espresso-venue-dv<?php echo espresso_is_venue_private() ? ' espresso-private-venue-dv' : ''; ?>">
 	<h4>
-        <strong><?php esc_html_e( 'Venue:', 'event_espresso' ); ?></strong>&nbsp;&nbsp;
+        <strong><?php esc_html_e('Venue:', 'event_espresso'); ?></strong>&nbsp;&nbsp;
         <strong> <?php echo wp_kses($venue_name, AllowedTags::getAllowedTags()); ?></strong>
     </h4>
 	<p><span class="smaller-text tags-links"><?php echo espresso_venue_categories(); ?></span></p>
-<?php  if ( $venue_phone = espresso_venue_phone( $post->ID, FALSE )) : ?>
+<?php  if ($venue_phone = espresso_venue_phone($post->ID, FALSE)) : ?>
 	<p>
 		<span class="small-text">
-            <strong><?php esc_html_e( 'Venue Phone:', 'event_espresso' ); ?></strong>
+            <strong><?php esc_html_e('Venue Phone:', 'event_espresso'); ?></strong>
         </span>
         <?php echo wp_kses($venue_phone, AllowedTags::getAllowedTags()); ?>
 	</p>
-<?php endif;  ?>
-<?php if ( $venue_website = espresso_venue_website( $post->ID, FALSE )) : ?>
+<?php endif; ?>
+<?php if ($venue_website = espresso_venue_website($post->ID, FALSE)) : ?>
 	<p>
 		<span class="small-text">
-            <strong><?php esc_html_e( 'Venue Website:', 'event_espresso' ); ?></strong>
+            <strong><?php esc_html_e('Venue Website:', 'event_espresso'); ?></strong>
         </span>
         <?php echo wp_kses($venue_website, AllowedTags::getAllowedTags()); ?>
 	</p>
 <?php endif; ?>
-<?php  if ( espresso_venue_has_address( $post->ID )) : ?>
-	<strong><span class="dashicons dashicons-location-alt"></span><?php esc_html_e( 'Address:', 'event_espresso' ); ?></strong>
-	<?php espresso_venue_address( 'inline' ); // already escaped ?>
-	<?php espresso_venue_gmap( $post->ID ); // already escaped ?>
+<?php  if (espresso_venue_has_address($post->ID)) : ?>
+	<strong><span class="dashicons dashicons-location-alt"></span><?php esc_html_e('Address:', 'event_espresso'); ?></strong>
+	<?php espresso_venue_address('inline'); // already escaped ?>
+	<?php espresso_venue_gmap($post->ID); // already escaped ?>
 	<div class="clear"><br/></div>
-<?php endif;  ?>
+<?php endif; ?>
 
-	<?php $VNU_ID = espresso_venue_id( $post->ID ); ?>
-	<?php if ( is_single() ) : ?>
-		<?php $venue_description = espresso_venue_description( $VNU_ID, FALSE ); ?>
-		<?php if ( $venue_description ) : ?>
+	<?php $VNU_ID = espresso_venue_id($post->ID); ?>
+	<?php if (is_single()) : ?>
+		<?php $venue_description = espresso_venue_description($VNU_ID, FALSE); ?>
+		<?php if ($venue_description) : ?>
 	<p>
-		<strong><?php esc_html_e( 'Description:', 'event_espresso' ); ?></strong><br/>
-		<?php echo do_shortcode( $venue_description ); ?>
+		<strong><?php esc_html_e('Description:', 'event_espresso'); ?></strong><br/>
+		<?php echo do_shortcode($venue_description); ?>
 	</p>
-		<?php endif;  ?>
+		<?php endif; ?>
 	<?php else : ?>
-		<?php $venue_excerpt = espresso_venue_excerpt( $VNU_ID, FALSE ); ?>
-		<?php if ( $venue_excerpt ) : ?>
+		<?php $venue_excerpt = espresso_venue_excerpt($VNU_ID, FALSE); ?>
+		<?php if ($venue_excerpt) : ?>
 	<p>
-		<strong><?php esc_html_e( 'Description:', 'event_espresso' ); ?></strong><br/>
+		<strong><?php esc_html_e('Description:', 'event_espresso'); ?></strong><br/>
 		<?php echo wp_kses($venue_excerpt, AllowedTags::getAllowedTags()); ?>
 	</p>
-			<?php endif;  ?>
-		<?php endif;  ?>
+			<?php endif; ?>
+		<?php endif; ?>
 </div>
 <!-- .espresso-venue-dv -->
 <?php
-do_action( 'AHEE_event_details_after_venue_details', $post );
+do_action('AHEE_event_details_after_venue_details', $post);
 else :
-	if ( espresso_venue_is_password_protected() ) :
+	if (espresso_venue_is_password_protected()) :
 ?>
 	<div class="espresso-venue-dv  espresso-password-protected-venue-dv" >
 		<h3 class="event-venues-h3 ee-event-h3">
-			<?php esc_html_e( 'Location', 'event_espresso' );?>
+			<?php esc_html_e('Location', 'event_espresso'); ?>
 		</h3>
 		<?php echo espresso_password_protected_venue_form(); ?>
 	</div>

public/Espresso_Arabica_2014/content-espresso_events-header.php

Spacing +2 added lines, -2 removed lines

@@ -7,10 +7,10 @@
 	<?php echo "<{$tag}  id=\"event-details-{$tag}-{$post->ID}\" class=\"entry-title\">"; ?>
 		<a class="ee-event-header-lnk"
            href="<?php the_permalink(); ?>"
-           <?php echo \EED_Events_Archive::link_target();?>
+           <?php echo \EED_Events_Archive::link_target(); ?>
         >
             <?php the_title(); ?>
         </a>
 	<?php echo "</{$tag}>"; ?>
-	<?php if ( ! is_archive() && has_excerpt( $post->ID )): the_excerpt(); endif;?>
+	<?php if ( ! is_archive() && has_excerpt($post->ID)): the_excerpt(); endif; ?>
 </header>

ui/blocks/event-attendees.php

Indentation +20 added lines, -20 removed lines

@@ -13,25 +13,25 @@ 
 <div id="ee-block-event-attendees" class="ee-core-blocks event-espresso-blocks event-attendees">
     <ul>
         <?php
-        foreach ($attendees as $attendee) {
-            $attendee_name = esc_html($attendee->full_name());
+		foreach ($attendees as $attendee) {
+			$attendee_name = esc_html($attendee->full_name());
 
-            $gravatar = $attributes['showGravatar']
-                ? get_avatar_url(
-                    $attendee->email(),
-                    array(
-                        'width'   => $attributes['avatarSize'],
-                        'height'  => $attributes['avatarSize']
-                    )
-                )
-                : '';
+			$gravatar = $attributes['showGravatar']
+				? get_avatar_url(
+					$attendee->email(),
+					array(
+						'width'   => $attributes['avatarSize'],
+						'height'  => $attributes['avatarSize']
+					)
+				)
+				: '';
 
-            $gravatar_class = $attributes['avatarClass']
-                ? $attributes['avatarClass'] . ' contact-avatar-img avatar'
-                : 'contact-avatar-img avatar';
+			$gravatar_class = $attributes['avatarClass']
+				? $attributes['avatarClass'] . ' contact-avatar-img avatar'
+				: 'contact-avatar-img avatar';
 
-            $gravatar = $gravatar !== ''
-                ? '
+			$gravatar = $gravatar !== ''
+				? '
                 <div class="contact-image-wrap-div">
                     <img class="' . esc_attr($gravatar_class) . '"
                          width="' . esc_attr($attributes['avatarSize']) . '"
@@ -40,13 +40,13 @@ 
                          alt="contact avatar"
                      >
                  </div>'
-                : '';
+				: '';
 
-            echo "
+			echo "
             <li>
                 {$gravatar}<span>{$attendee_name}</span>
             </li>";
-        }
-        ?>
+		}
+		?>
     </ul>
 </div>

Spacing +5 added lines, -5 removed lines

@@ -27,16 +27,16 @@
                 : '';
 
             $gravatar_class = $attributes['avatarClass']
-                ? $attributes['avatarClass'] . ' contact-avatar-img avatar'
+                ? $attributes['avatarClass'].' contact-avatar-img avatar'
                 : 'contact-avatar-img avatar';
 
             $gravatar = $gravatar !== ''
                 ? '
                 <div class="contact-image-wrap-div">
-                    <img class="' . esc_attr($gravatar_class) . '"
-                         width="' . esc_attr($attributes['avatarSize']) . '"
-                         height="' . esc_attr($attributes['avatarSize']) . '"
-                         src="' . esc_url_raw($gravatar) . '" 
+                    <img class="' . esc_attr($gravatar_class).'"
+                         width="' . esc_attr($attributes['avatarSize']).'"
+                         height="' . esc_attr($attributes['avatarSize']).'"
+                         src="' . esc_url_raw($gravatar).'" 
                          alt="contact avatar"
                      >
                  </div>'

core/services/progress_steps/ProgressStep.php

Spacing +5 added lines, -5 removed lines

@@ -121,7 +121,7 @@ 
      */
     protected function setId($id = '')
     {
-        if (! is_string($id)) {
+        if ( ! is_string($id)) {
             throw new InvalidDataTypeException('$id', $id, 'string');
         }
         $this->id = $id;
@@ -144,7 +144,7 @@ 
      */
     protected function setOrder($order = 0)
     {
-        if (! is_int($order)) {
+        if ( ! is_int($order)) {
             throw new InvalidDataTypeException('$order', $order, 'integer');
         }
         $this->order = absint($order);
@@ -173,11 +173,11 @@ 
      */
     protected function setHtmlClass($html_class)
     {
-        if (! is_string($html_class)) {
+        if ( ! is_string($html_class)) {
             throw new InvalidDataTypeException('$html_class', $html_class, 'string');
         }
         if (strpos($html_class, 'progress-step-') === false) {
-            $html_class = 'progress-step-' . $html_class;
+            $html_class = 'progress-step-'.$html_class;
         }
         $this->html_class = $html_class;
     }
@@ -199,7 +199,7 @@ 
      */
     protected function setText($text)
     {
-        if (! is_string($text)) {
+        if ( ! is_string($text)) {
             throw new InvalidDataTypeException('$text', $text, 'string');
         }
         $this->text = sanitize_text_field($text);

Indentation +186 added lines, -186 removed lines

@@ -16,190 +16,190 @@
  */
 class ProgressStep implements ProgressStepInterface
 {
-    /**
-     * @var boolean $current
-     */
-    private $current = false;
-
-
-    /**
-     * @var boolean $completed
-     */
-    private $completed = false;
-
-
-    /**
-     * @var string $html_class
-     */
-    private $html_class;
-
-    /**
-     * @var string $id
-     */
-    private $id = '';
-
-    /**
-     * @var int $order
-     */
-    private $order = 0;
-
-    /**
-     * @var string $text
-     */
-    private $text = '';
-
-
-    /**
-     * ProgressStep constructor
-     *
-     * @param int    $order
-     * @param string $id
-     * @param string $html_class
-     * @param string $text
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($order, $id, $html_class, $text)
-    {
-        $this->setOrder($order);
-        $this->setId($id);
-        $this->setHtmlClass($html_class);
-        $this->setText($text);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function isCurrent()
-    {
-        return $this->current;
-    }
-
-
-    /**
-     * @param boolean $current
-     */
-    public function setIsCurrent($current = true)
-    {
-        $this->current = filter_var($current, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function isCompleted()
-    {
-        return $this->completed;
-    }
-
-
-    /**
-     * @param boolean $completed
-     */
-    public function setIsCompleted($completed = true)
-    {
-        $this->completed = filter_var($completed, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function id()
-    {
-        return $this->id;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $id
-     * @throws InvalidDataTypeException
-     */
-    protected function setId($id = '')
-    {
-        if (! is_string($id)) {
-            throw new InvalidDataTypeException('$id', $id, 'string');
-        }
-        $this->id = $id;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->order;
-    }
-
-
-    /**
-     * @access protected
-     * @param int $order
-     * @throws InvalidDataTypeException
-     */
-    protected function setOrder($order = 0)
-    {
-        if (! is_int($order)) {
-            throw new InvalidDataTypeException('$order', $order, 'integer');
-        }
-        $this->order = absint($order);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function htmlClass()
-    {
-        $html_class = $this->html_class;
-        if ($this->isCurrent()) {
-            $html_class .= ' progress-step-active';
-        } elseif ($this->isCompleted()) {
-            $html_class .= ' progress-step-completed';
-        }
-        return $html_class;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $html_class
-     * @throws InvalidDataTypeException
-     */
-    protected function setHtmlClass($html_class)
-    {
-        if (! is_string($html_class)) {
-            throw new InvalidDataTypeException('$html_class', $html_class, 'string');
-        }
-        if (strpos($html_class, 'progress-step-') === false) {
-            $html_class = 'progress-step-' . $html_class;
-        }
-        $this->html_class = $html_class;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function text()
-    {
-        return $this->text;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $text
-     * @throws InvalidDataTypeException
-     */
-    protected function setText($text)
-    {
-        if (! is_string($text)) {
-            throw new InvalidDataTypeException('$text', $text, 'string');
-        }
-        $this->text = sanitize_text_field($text);
-    }
+	/**
+	 * @var boolean $current
+	 */
+	private $current = false;
+
+
+	/**
+	 * @var boolean $completed
+	 */
+	private $completed = false;
+
+
+	/**
+	 * @var string $html_class
+	 */
+	private $html_class;
+
+	/**
+	 * @var string $id
+	 */
+	private $id = '';
+
+	/**
+	 * @var int $order
+	 */
+	private $order = 0;
+
+	/**
+	 * @var string $text
+	 */
+	private $text = '';
+
+
+	/**
+	 * ProgressStep constructor
+	 *
+	 * @param int    $order
+	 * @param string $id
+	 * @param string $html_class
+	 * @param string $text
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($order, $id, $html_class, $text)
+	{
+		$this->setOrder($order);
+		$this->setId($id);
+		$this->setHtmlClass($html_class);
+		$this->setText($text);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function isCurrent()
+	{
+		return $this->current;
+	}
+
+
+	/**
+	 * @param boolean $current
+	 */
+	public function setIsCurrent($current = true)
+	{
+		$this->current = filter_var($current, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function isCompleted()
+	{
+		return $this->completed;
+	}
+
+
+	/**
+	 * @param boolean $completed
+	 */
+	public function setIsCompleted($completed = true)
+	{
+		$this->completed = filter_var($completed, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function id()
+	{
+		return $this->id;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $id
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setId($id = '')
+	{
+		if (! is_string($id)) {
+			throw new InvalidDataTypeException('$id', $id, 'string');
+		}
+		$this->id = $id;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->order;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param int $order
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setOrder($order = 0)
+	{
+		if (! is_int($order)) {
+			throw new InvalidDataTypeException('$order', $order, 'integer');
+		}
+		$this->order = absint($order);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function htmlClass()
+	{
+		$html_class = $this->html_class;
+		if ($this->isCurrent()) {
+			$html_class .= ' progress-step-active';
+		} elseif ($this->isCompleted()) {
+			$html_class .= ' progress-step-completed';
+		}
+		return $html_class;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $html_class
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setHtmlClass($html_class)
+	{
+		if (! is_string($html_class)) {
+			throw new InvalidDataTypeException('$html_class', $html_class, 'string');
+		}
+		if (strpos($html_class, 'progress-step-') === false) {
+			$html_class = 'progress-step-' . $html_class;
+		}
+		$this->html_class = $html_class;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function text()
+	{
+		return $this->text;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $text
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setText($text)
+	{
+		if (! is_string($text)) {
+			throw new InvalidDataTypeException('$text', $text, 'string');
+		}
+		$this->text = sanitize_text_field($text);
+	}
 }

core/libraries/messages/EE_Message_Type_Collection.lib.php

Spacing +1 added lines, -1 removed lines

@@ -174,7 +174,7 @@
             $this->rewind();
             while ($this->valid()) {
                 echo '<h5 style="color:#2EA2CC;">
-                    ' . __CLASS__ . ' class : <span style="color:#E76700">' . esc_html($this->getInfo()) . '</span>
+                    ' . __CLASS__.' class : <span style="color:#E76700">'.esc_html($this->getInfo()).'</span>
                     </h5>';
                 $this->next();
             }

Indentation +137 added lines, -137 removed lines

@@ -13,143 +13,143 @@
  */
 class EE_Message_Type_Collection extends EE_Object_Collection
 {
-    /**
-     * EE_Message_Type_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_message_type';
-    }
-
-
-
-    /**
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_info()
-     *
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function add($object, $info = ''): bool
-    {
-        $info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
-        return parent::add($object, $info);
-    }
-
-
-
-    /**
-     * Sets the data associated with an object in the Collection
-     * if no $info is supplied, then the spl_object_hash() is used
-     *
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function set_info($object, $info = ''): bool
-    {
-        $info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
-        return parent::set_info($object, $info);
-    }
-
-
-
-    /**
-     * finds and returns an object in the Collection based on the info that was set using addObject()
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
-     *
-     * @param mixed
-     * @return null | object
-     */
-    public function get_by_info($info = '')
-    {
-        return parent::get_by_info(str_replace(' ', '_', strtolower($info)));
-    }
-
-
-
-    /**
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @param object $object
-     * @return bool
-     */
-    public function has($object): bool
-    {
-        return parent::has($object);
-    }
-
-
-
-    /**
-     * returns TRUE or FALSE depending on whether the supplied message_type classname is within the Collection
-     *
-     * @param string $message_type_name
-     * @return bool
-     */
-    public function has_by_name(string $message_type_name): bool
-    {
-        return $this->get_by_info($message_type_name) instanceof $this->interface;
-    }
-
-
-
-    /**
-     * detaches an object from the Collection
-     *
-     * @param $object
-     * @return bool
-     */
-    public function remove($object): bool
-    {
-        return parent::remove($object);
-    }
-
-
-
-    /**
-     * advances pointer to the provided object
-     *
-     * @param $object
-     * @return void
-     */
-    public function set_current($object)
-    {
-        parent::set_current($object);
-    }
-
-
-
-    /**
-     * advances pointer to the object whose info matches that which was provided
-     *
-     * @param $info
-     * @return void
-     */
-    public function set_current_by_info($info)
-    {
-        parent::set_current_by_info($info);
-    }
-
-
-
-    /**
-     * displays list of collection classes if WP_DEBUG is on
-     *
-     * @return void
-     */
-    public function show_collection_classes()
-    {
-        if (WP_DEBUG) {
-            $this->rewind();
-            while ($this->valid()) {
-                echo '<h5 style="color:#2EA2CC;">
+	/**
+	 * EE_Message_Type_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_message_type';
+	}
+
+
+
+	/**
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_info()
+	 *
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function add($object, $info = ''): bool
+	{
+		$info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
+		return parent::add($object, $info);
+	}
+
+
+
+	/**
+	 * Sets the data associated with an object in the Collection
+	 * if no $info is supplied, then the spl_object_hash() is used
+	 *
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function set_info($object, $info = ''): bool
+	{
+		$info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
+		return parent::set_info($object, $info);
+	}
+
+
+
+	/**
+	 * finds and returns an object in the Collection based on the info that was set using addObject()
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
+	 *
+	 * @param mixed
+	 * @return null | object
+	 */
+	public function get_by_info($info = '')
+	{
+		return parent::get_by_info(str_replace(' ', '_', strtolower($info)));
+	}
+
+
+
+	/**
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @param object $object
+	 * @return bool
+	 */
+	public function has($object): bool
+	{
+		return parent::has($object);
+	}
+
+
+
+	/**
+	 * returns TRUE or FALSE depending on whether the supplied message_type classname is within the Collection
+	 *
+	 * @param string $message_type_name
+	 * @return bool
+	 */
+	public function has_by_name(string $message_type_name): bool
+	{
+		return $this->get_by_info($message_type_name) instanceof $this->interface;
+	}
+
+
+
+	/**
+	 * detaches an object from the Collection
+	 *
+	 * @param $object
+	 * @return bool
+	 */
+	public function remove($object): bool
+	{
+		return parent::remove($object);
+	}
+
+
+
+	/**
+	 * advances pointer to the provided object
+	 *
+	 * @param $object
+	 * @return void
+	 */
+	public function set_current($object)
+	{
+		parent::set_current($object);
+	}
+
+
+
+	/**
+	 * advances pointer to the object whose info matches that which was provided
+	 *
+	 * @param $info
+	 * @return void
+	 */
+	public function set_current_by_info($info)
+	{
+		parent::set_current_by_info($info);
+	}
+
+
+
+	/**
+	 * displays list of collection classes if WP_DEBUG is on
+	 *
+	 * @return void
+	 */
+	public function show_collection_classes()
+	{
+		if (WP_DEBUG) {
+			$this->rewind();
+			while ($this->valid()) {
+				echo '<h5 style="color:#2EA2CC;">
                     ' . __CLASS__ . ' class : <span style="color:#E76700">' . esc_html($this->getInfo()) . '</span>
                     </h5>';
-                $this->next();
-            }
-        }
-    }
+				$this->next();
+			}
+		}
+	}
 }