eventespresso / event-espresso-core

core/domain/values/model/CustomSelects.php

Indentation +323 added lines, -323 removed lines

@@ -17,327 +17,327 @@
  */
 class CustomSelects
 {
-    const TYPE_SIMPLE = 'simple';
-    const TYPE_COMPLEX = 'complex';
-    const TYPE_STRUCTURED = 'structured';
-
-    private $valid_operators = array('COUNT', 'SUM');
-
-
-    /**
-     * Original incoming select array
-     * @var array
-     */
-    private $original_selects;
-
-    /**
-     * Select string that can be added to the query
-     * @var string
-     */
-    private $columns_to_select_expression;
-
-
-    /**
-     * An array of aliases for the columns included in the incoming select array.
-     * @var array
-     */
-    private $column_aliases_in_select;
-
-
-    /**
-     * Enum representation of the "type" of array coming into this value object.
-     * @var string
-     *
-     */
-    private $type = '';
-
-
-    /**
-     * CustomSelects constructor.
-     * Incoming selects can be in one of the following formats:
-     * ---- self::TYPE_SIMPLE array ----
-     * This is considered the "simple" type. In this case the array is an numerically indexed array with single or
-     * multiple columns to select as the values.
-     * eg. array( 'ATT_ID', 'REG_ID' )
-     * eg. array( '*' )
-     * If you want to use the columns in any WHERE, GROUP BY, or HAVING clauses, you must instead use the "complex" or
-     * "structured" method.
-     * ---- self::TYPE_COMPLEX array ----
-     * This is considered the "complex" type.  In this case the array is indexed by arbitrary strings that serve as
-     * column alias, and the value is an numerically indexed array where there are two values.  The first value (0) is
-     * the selection and the second value (1) is the data type.  Data types must be one of the types defined in
-     * EEM_Base::$_valid_wpdb_data_types.
-     * eg. array( 'count' => array('count(REG_ID)', '%d') )
-     * Complex array configuration allows for using the column alias in any WHERE, GROUP BY, or HAVING clauses.
-     * ---- self::TYPE_STRUCTURED array ---
-     * This is considered the "structured" type. This type is similar to the complex type except that the array attached
-     * to the column alias contains three values.  The first value is the qualified column name (which can include
-     * join syntax for models).  The second value is the operator performed on the column (i.e. 'COUNT', 'SUM' etc).,
-     * the third value is the data type.  Note, if the select does not have an operator, you can use an empty string for
-     * the second value.
-     * Note: for now SUM is only for simple single column expressions (i.e. SUM(Transaction.TXN_total))
-     * eg. array( 'registration_count' => array('Registration.REG_ID', 'count', '%d') );
-     *
-     * NOTE: mixing array types in the incoming $select will cause errors.
-     *
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    public function __construct(array $selects)
-    {
-        $this->original_selects = $selects;
-        $this->deriveType($selects);
-        $this->deriveParts($selects);
-    }
-
-
-    /**
-     * Derives what type of custom select has been sent in.
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    private function deriveType(array $selects)
-    {
-        // first if the first key for this array is an integer then its coming in as a simple format, so we'll also
-        // ensure all elements of the array are simple.
-        if (is_int(key($selects))) {
-            // let's ensure all keys are ints
-            $invalid_keys = array_filter(
-                array_keys($selects),
-                function ($value) {
-                    return ! is_int($value);
-                }
-            );
-            if (! empty($invalid_keys)) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'Incoming array looks like its formatted for "%1$s" type selects, however it has elements that are not indexed numerically',
-                            'event_espresso'
-                        ),
-                        self::TYPE_SIMPLE
-                    )
-                );
-            }
-            $this->type = self::TYPE_SIMPLE;
-            return;
-        }
-        // made it here so that means we've got either complex or structured selects.  Let's find out which by popping
-        // the first array element off.
-        $first_element = reset($selects);
-
-        if (! is_array($first_element)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'Incoming array looks like its formatted as a "%1$s" or "%2$s" type.  However, the values in the array must be arrays themselves and they are not.',
-                        'event_espresso'
-                    ),
-                    self::TYPE_COMPLEX,
-                    self::TYPE_STRUCTURED
-                )
-            );
-        }
-        $this->type = count($first_element) === 2
-            ? self::TYPE_COMPLEX
-            : self::TYPE_STRUCTURED;
-    }
-
-
-    /**
-     * Sets up the various properties for the vo depending on type.
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    private function deriveParts(array $selects)
-    {
-        $column_parts = array();
-        switch ($this->type) {
-            case self::TYPE_SIMPLE:
-                $column_parts = $selects;
-                $this->column_aliases_in_select = $selects;
-                break;
-            case self::TYPE_COMPLEX:
-                foreach ($selects as $alias => $parts) {
-                    $this->validateSelectValueForType($parts, $alias);
-                    $column_parts[] = "{$parts[0]} AS {$alias}";
-                    $this->column_aliases_in_select[] = $alias;
-                }
-                break;
-            case self::TYPE_STRUCTURED:
-                foreach ($selects as $alias => $parts) {
-                    $this->validateSelectValueForType($parts, $alias);
-                    $column_parts[] = $parts[1] !== ''
-                        ? $this->assembleSelectStringWithOperator($parts, $alias)
-                        : "{$parts[0]} AS {$alias}";
-                    $this->column_aliases_in_select[] = $alias;
-                }
-                break;
-        }
-        $this->columns_to_select_expression = implode(', ', $column_parts);
-    }
-
-
-    /**
-     * Validates self::TYPE_COMPLEX and self::TYPE_STRUCTURED select statement parts.
-     * @param array $select_parts
-     * @param string      $alias
-     * @throws InvalidArgumentException
-     */
-    private function validateSelectValueForType(array $select_parts, $alias)
-    {
-        $valid_data_types = array('%d', '%s', '%f');
-        if (count($select_parts) !== $this->expectedSelectPartCountForType()) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The provided select part array for the %1$s column is expected to have a count of %2$d because the incoming select array is of type %3$s.  However the count was %4$d.',
-                        'event_espresso'
-                    ),
-                    $alias,
-                    $this->expectedSelectPartCountForType(),
-                    $this->type,
-                    count($select_parts)
-                )
-            );
-        }
-        // validate data type.
-        $data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
-        $data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
-
-        if (! in_array($data_type, $valid_data_types, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'Datatype %1$s (for selection "%2$s" and alias "%3$s") is not a valid wpdb datatype (eg %%s)',
-                        'event_espresso'
-                    ),
-                    $data_type,
-                    $select_parts[0],
-                    $alias,
-                    implode(', ', $valid_data_types)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Each type will have an expected count of array elements, this returns what that expected count is.
-     * @param string $type
-     * @return int
-     */
-    private function expectedSelectPartCountForType($type = '')
-    {
-        $type = $type === '' ? $this->type : $type;
-        $types_count_map = array(
-            self::TYPE_COMPLEX => 2,
-            self::TYPE_STRUCTURED => 3
-        );
-        return isset($types_count_map[$type]) ? $types_count_map[$type] : 0;
-    }
-
-
-    /**
-     * Prepares the select statement part for for structured type selects.
-     * @param array  $select_parts
-     * @param string $alias
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    private function assembleSelectStringWithOperator(array $select_parts, $alias)
-    {
-        $operator = strtoupper($select_parts[1]);
-        // validate operator
-        if (! in_array($operator, $this->valid_operators, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'An invalid operator has been provided (%1$s) for the column %2$s.  Valid operators must be one of the following: %3$s.',
-                        'event_espresso'
-                    ),
-                    $operator,
-                    $alias,
-                    implode(', ', $this->valid_operators)
-                )
-            );
-        }
-        return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
-    }
-
-
-    /**
-     * Return the datatype from the given select part.
-     * Remember the select_part has already been validated on object instantiation.
-     * @param array $select_part
-     * @return string
-     */
-    private function getDataTypeForSelectType(array $select_part)
-    {
-        switch ($this->type) {
-            case self::TYPE_COMPLEX:
-                return $select_part[1];
-            case self::TYPE_STRUCTURED:
-                return $select_part[2];
-            default:
-                return '';
-        }
-    }
-
-
-    /**
-     * Returns the original select array sent into the VO.
-     * @return array
-     */
-    public function originalSelects()
-    {
-        return $this->original_selects;
-    }
-
-
-    /**
-     * Returns the final assembled select expression derived from the incoming select array.
-     * @return string
-     */
-    public function columnsToSelectExpression()
-    {
-        return $this->columns_to_select_expression;
-    }
-
-
-    /**
-     * Returns all the column aliases derived from the incoming select array.
-     * @return array
-     */
-    public function columnAliases()
-    {
-        return $this->column_aliases_in_select;
-    }
-
-
-    /**
-     * Returns the enum type for the incoming select array.
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-
-    /**
-     * Return the datatype for the given column_alias
-     * @param string $column_alias
-     * @return string  (if there's no data type we return string as the default).
-     */
-    public function getDataTypeForAlias($column_alias)
-    {
-        if (isset($this->original_selects[$column_alias])
-            && in_array($column_alias, $this->columnAliases(), true)
-        ) {
-            return $this->getDataTypeForSelectType($this->original_selects[$column_alias]);
-        }
-        return '%s';
-    }
+	const TYPE_SIMPLE = 'simple';
+	const TYPE_COMPLEX = 'complex';
+	const TYPE_STRUCTURED = 'structured';
+
+	private $valid_operators = array('COUNT', 'SUM');
+
+
+	/**
+	 * Original incoming select array
+	 * @var array
+	 */
+	private $original_selects;
+
+	/**
+	 * Select string that can be added to the query
+	 * @var string
+	 */
+	private $columns_to_select_expression;
+
+
+	/**
+	 * An array of aliases for the columns included in the incoming select array.
+	 * @var array
+	 */
+	private $column_aliases_in_select;
+
+
+	/**
+	 * Enum representation of the "type" of array coming into this value object.
+	 * @var string
+	 *
+	 */
+	private $type = '';
+
+
+	/**
+	 * CustomSelects constructor.
+	 * Incoming selects can be in one of the following formats:
+	 * ---- self::TYPE_SIMPLE array ----
+	 * This is considered the "simple" type. In this case the array is an numerically indexed array with single or
+	 * multiple columns to select as the values.
+	 * eg. array( 'ATT_ID', 'REG_ID' )
+	 * eg. array( '*' )
+	 * If you want to use the columns in any WHERE, GROUP BY, or HAVING clauses, you must instead use the "complex" or
+	 * "structured" method.
+	 * ---- self::TYPE_COMPLEX array ----
+	 * This is considered the "complex" type.  In this case the array is indexed by arbitrary strings that serve as
+	 * column alias, and the value is an numerically indexed array where there are two values.  The first value (0) is
+	 * the selection and the second value (1) is the data type.  Data types must be one of the types defined in
+	 * EEM_Base::$_valid_wpdb_data_types.
+	 * eg. array( 'count' => array('count(REG_ID)', '%d') )
+	 * Complex array configuration allows for using the column alias in any WHERE, GROUP BY, or HAVING clauses.
+	 * ---- self::TYPE_STRUCTURED array ---
+	 * This is considered the "structured" type. This type is similar to the complex type except that the array attached
+	 * to the column alias contains three values.  The first value is the qualified column name (which can include
+	 * join syntax for models).  The second value is the operator performed on the column (i.e. 'COUNT', 'SUM' etc).,
+	 * the third value is the data type.  Note, if the select does not have an operator, you can use an empty string for
+	 * the second value.
+	 * Note: for now SUM is only for simple single column expressions (i.e. SUM(Transaction.TXN_total))
+	 * eg. array( 'registration_count' => array('Registration.REG_ID', 'count', '%d') );
+	 *
+	 * NOTE: mixing array types in the incoming $select will cause errors.
+	 *
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(array $selects)
+	{
+		$this->original_selects = $selects;
+		$this->deriveType($selects);
+		$this->deriveParts($selects);
+	}
+
+
+	/**
+	 * Derives what type of custom select has been sent in.
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	private function deriveType(array $selects)
+	{
+		// first if the first key for this array is an integer then its coming in as a simple format, so we'll also
+		// ensure all elements of the array are simple.
+		if (is_int(key($selects))) {
+			// let's ensure all keys are ints
+			$invalid_keys = array_filter(
+				array_keys($selects),
+				function ($value) {
+					return ! is_int($value);
+				}
+			);
+			if (! empty($invalid_keys)) {
+				throw new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'Incoming array looks like its formatted for "%1$s" type selects, however it has elements that are not indexed numerically',
+							'event_espresso'
+						),
+						self::TYPE_SIMPLE
+					)
+				);
+			}
+			$this->type = self::TYPE_SIMPLE;
+			return;
+		}
+		// made it here so that means we've got either complex or structured selects.  Let's find out which by popping
+		// the first array element off.
+		$first_element = reset($selects);
+
+		if (! is_array($first_element)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'Incoming array looks like its formatted as a "%1$s" or "%2$s" type.  However, the values in the array must be arrays themselves and they are not.',
+						'event_espresso'
+					),
+					self::TYPE_COMPLEX,
+					self::TYPE_STRUCTURED
+				)
+			);
+		}
+		$this->type = count($first_element) === 2
+			? self::TYPE_COMPLEX
+			: self::TYPE_STRUCTURED;
+	}
+
+
+	/**
+	 * Sets up the various properties for the vo depending on type.
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	private function deriveParts(array $selects)
+	{
+		$column_parts = array();
+		switch ($this->type) {
+			case self::TYPE_SIMPLE:
+				$column_parts = $selects;
+				$this->column_aliases_in_select = $selects;
+				break;
+			case self::TYPE_COMPLEX:
+				foreach ($selects as $alias => $parts) {
+					$this->validateSelectValueForType($parts, $alias);
+					$column_parts[] = "{$parts[0]} AS {$alias}";
+					$this->column_aliases_in_select[] = $alias;
+				}
+				break;
+			case self::TYPE_STRUCTURED:
+				foreach ($selects as $alias => $parts) {
+					$this->validateSelectValueForType($parts, $alias);
+					$column_parts[] = $parts[1] !== ''
+						? $this->assembleSelectStringWithOperator($parts, $alias)
+						: "{$parts[0]} AS {$alias}";
+					$this->column_aliases_in_select[] = $alias;
+				}
+				break;
+		}
+		$this->columns_to_select_expression = implode(', ', $column_parts);
+	}
+
+
+	/**
+	 * Validates self::TYPE_COMPLEX and self::TYPE_STRUCTURED select statement parts.
+	 * @param array $select_parts
+	 * @param string      $alias
+	 * @throws InvalidArgumentException
+	 */
+	private function validateSelectValueForType(array $select_parts, $alias)
+	{
+		$valid_data_types = array('%d', '%s', '%f');
+		if (count($select_parts) !== $this->expectedSelectPartCountForType()) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The provided select part array for the %1$s column is expected to have a count of %2$d because the incoming select array is of type %3$s.  However the count was %4$d.',
+						'event_espresso'
+					),
+					$alias,
+					$this->expectedSelectPartCountForType(),
+					$this->type,
+					count($select_parts)
+				)
+			);
+		}
+		// validate data type.
+		$data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
+		$data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
+
+		if (! in_array($data_type, $valid_data_types, true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'Datatype %1$s (for selection "%2$s" and alias "%3$s") is not a valid wpdb datatype (eg %%s)',
+						'event_espresso'
+					),
+					$data_type,
+					$select_parts[0],
+					$alias,
+					implode(', ', $valid_data_types)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Each type will have an expected count of array elements, this returns what that expected count is.
+	 * @param string $type
+	 * @return int
+	 */
+	private function expectedSelectPartCountForType($type = '')
+	{
+		$type = $type === '' ? $this->type : $type;
+		$types_count_map = array(
+			self::TYPE_COMPLEX => 2,
+			self::TYPE_STRUCTURED => 3
+		);
+		return isset($types_count_map[$type]) ? $types_count_map[$type] : 0;
+	}
+
+
+	/**
+	 * Prepares the select statement part for for structured type selects.
+	 * @param array  $select_parts
+	 * @param string $alias
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	private function assembleSelectStringWithOperator(array $select_parts, $alias)
+	{
+		$operator = strtoupper($select_parts[1]);
+		// validate operator
+		if (! in_array($operator, $this->valid_operators, true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'An invalid operator has been provided (%1$s) for the column %2$s.  Valid operators must be one of the following: %3$s.',
+						'event_espresso'
+					),
+					$operator,
+					$alias,
+					implode(', ', $this->valid_operators)
+				)
+			);
+		}
+		return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
+	}
+
+
+	/**
+	 * Return the datatype from the given select part.
+	 * Remember the select_part has already been validated on object instantiation.
+	 * @param array $select_part
+	 * @return string
+	 */
+	private function getDataTypeForSelectType(array $select_part)
+	{
+		switch ($this->type) {
+			case self::TYPE_COMPLEX:
+				return $select_part[1];
+			case self::TYPE_STRUCTURED:
+				return $select_part[2];
+			default:
+				return '';
+		}
+	}
+
+
+	/**
+	 * Returns the original select array sent into the VO.
+	 * @return array
+	 */
+	public function originalSelects()
+	{
+		return $this->original_selects;
+	}
+
+
+	/**
+	 * Returns the final assembled select expression derived from the incoming select array.
+	 * @return string
+	 */
+	public function columnsToSelectExpression()
+	{
+		return $this->columns_to_select_expression;
+	}
+
+
+	/**
+	 * Returns all the column aliases derived from the incoming select array.
+	 * @return array
+	 */
+	public function columnAliases()
+	{
+		return $this->column_aliases_in_select;
+	}
+
+
+	/**
+	 * Returns the enum type for the incoming select array.
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+
+	/**
+	 * Return the datatype for the given column_alias
+	 * @param string $column_alias
+	 * @return string  (if there's no data type we return string as the default).
+	 */
+	public function getDataTypeForAlias($column_alias)
+	{
+		if (isset($this->original_selects[$column_alias])
+			&& in_array($column_alias, $this->columnAliases(), true)
+		) {
+			return $this->getDataTypeForSelectType($this->original_selects[$column_alias]);
+		}
+		return '%s';
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -104,11 +104,11 @@ 
             // let's ensure all keys are ints
             $invalid_keys = array_filter(
                 array_keys($selects),
-                function ($value) {
+                function($value) {
                     return ! is_int($value);
                 }
             );
-            if (! empty($invalid_keys)) {
+            if ( ! empty($invalid_keys)) {
                 throw new InvalidArgumentException(
                     sprintf(
                         esc_html__(
@@ -126,7 +126,7 @@ 
         // the first array element off.
         $first_element = reset($selects);
 
-        if (! is_array($first_element)) {
+        if ( ! is_array($first_element)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -205,7 +205,7 @@ 
         $data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
         $data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
 
-        if (! in_array($data_type, $valid_data_types, true)) {
+        if ( ! in_array($data_type, $valid_data_types, true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -249,7 +249,7 @@ 
     {
         $operator = strtoupper($select_parts[1]);
         // validate operator
-        if (! in_array($operator, $this->valid_operators, true)) {
+        if ( ! in_array($operator, $this->valid_operators, true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -262,7 +262,7 @@ 
                 )
             );
         }
-        return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
+        return $operator.'('.$select_parts[0].') AS '.$alias;
     }
 
 

core/domain/values/Url.php

Indentation +194 added lines, -194 removed lines

@@ -17,198 +17,198 @@
 class Url
 {
 
-    /**
-     * @var string $scheme
-     */
-    private $scheme;
-
-    /**
-     * @var string $host
-     */
-    private $host;
-
-    /**
-     * @var string $path
-     */
-    private $path;
-
-    /**
-     * @var string $query
-     */
-    private $query;
-
-    /**
-     * @var string $fragment
-     */
-    private $fragment;
-
-
-    /**
-     * Url constructor.
-     *
-     * @param $url
-     * @throws InvalidArgumentException
-     */
-    public function __construct($url)
-    {
-        if (! filter_var(
-            $url,
-            FILTER_VALIDATE_URL,
-            array(FILTER_FLAG_SCHEME_REQUIRED, FILTER_FLAG_HOST_REQUIRED)
-        )) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'Invalid URL. Both the "Scheme" and "Host" are required.',
-                    'event_espresso'
-                )
-            );
-        }
-        $url = parse_url($url);
-        $this->setScheme($url);
-        $this->setHost($url);
-        $this->setPath($url);
-        $this->setQuery($url);
-        $this->setFragment($url);
-    }
-
-
-    /**
-     * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
-     * will return a string like: 'abc://'
-     *
-     * @return string
-     */
-    public function scheme()
-    {
-        return $this->scheme;
-    }
-
-
-    /**
-     * @param array $url
-     */
-    private function setScheme($url)
-    {
-        $this->scheme = $url['scheme'] . '://';
-    }
-
-
-    /**
-     * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
-     * will return a string like: 'example.com'
-     *
-     * @return string
-     */
-    public function host()
-    {
-        return $this->host;
-    }
-
-
-    /**
-     * @param array $url
-     */
-    private function setHost($url)
-    {
-        $this->host = $url['host'];
-    }
-
-
-    /**
-     * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
-     * will return a string like: '/path/data'
-     *
-     * @return string
-     */
-    public function path()
-    {
-        return $this->path;
-    }
-
-
-    /**
-     * @param array $url
-     */
-    private function setPath($url)
-    {
-        $this->path = isset($url['path']) ? $url['path'] : '';
-    }
-
-
-    /**
-     * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
-     * will return a string like: '?key=value'
-     *
-     * @return string
-     */
-    public function queryString()
-    {
-        return $this->query !== '' ? '?' . $this->query : '';
-    }
-
-
-    /**
-     * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
-     * will return an array like: array('key' => 'value')
-     *
-     * @return array
-     */
-    public function queryParams()
-    {
-        return wp_parse_args($this->query);
-    }
-
-
-    /**
-     * @param array $url
-     */
-    private function setQuery($url)
-    {
-        $this->query = isset($url['query']) ? $url['query'] : '';
-    }
-
-
-    /**
-     * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
-     * will return a string like: '#id'
-     *
-     * @return string
-     */
-    public function fragment()
-    {
-        return $this->fragment !== '' ? '#' . $this->fragment : '';
-    }
-
-
-    /**
-     * @param array $url
-     */
-    private function setFragment($url)
-    {
-        $this->fragment = isset($url['fragment']) ? $url['fragment'] : '';
-    }
-
-
-    /**
-     * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
-     * will return a string like: 'abc://example.com/path/data?key=value#id'
-     *
-     * @return string
-     */
-    public function getFullUrl()
-    {
-        return $this->scheme() . $this->host() . $this->path() . $this->queryString() . $this->fragment();
-    }
-
-
-    /**
-     * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
-     * will return a string like: 'abc://example.com/path/data?key=value#id'
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->getFullUrl();
-    }
+	/**
+	 * @var string $scheme
+	 */
+	private $scheme;
+
+	/**
+	 * @var string $host
+	 */
+	private $host;
+
+	/**
+	 * @var string $path
+	 */
+	private $path;
+
+	/**
+	 * @var string $query
+	 */
+	private $query;
+
+	/**
+	 * @var string $fragment
+	 */
+	private $fragment;
+
+
+	/**
+	 * Url constructor.
+	 *
+	 * @param $url
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($url)
+	{
+		if (! filter_var(
+			$url,
+			FILTER_VALIDATE_URL,
+			array(FILTER_FLAG_SCHEME_REQUIRED, FILTER_FLAG_HOST_REQUIRED)
+		)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'Invalid URL. Both the "Scheme" and "Host" are required.',
+					'event_espresso'
+				)
+			);
+		}
+		$url = parse_url($url);
+		$this->setScheme($url);
+		$this->setHost($url);
+		$this->setPath($url);
+		$this->setQuery($url);
+		$this->setFragment($url);
+	}
+
+
+	/**
+	 * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
+	 * will return a string like: 'abc://'
+	 *
+	 * @return string
+	 */
+	public function scheme()
+	{
+		return $this->scheme;
+	}
+
+
+	/**
+	 * @param array $url
+	 */
+	private function setScheme($url)
+	{
+		$this->scheme = $url['scheme'] . '://';
+	}
+
+
+	/**
+	 * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
+	 * will return a string like: 'example.com'
+	 *
+	 * @return string
+	 */
+	public function host()
+	{
+		return $this->host;
+	}
+
+
+	/**
+	 * @param array $url
+	 */
+	private function setHost($url)
+	{
+		$this->host = $url['host'];
+	}
+
+
+	/**
+	 * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
+	 * will return a string like: '/path/data'
+	 *
+	 * @return string
+	 */
+	public function path()
+	{
+		return $this->path;
+	}
+
+
+	/**
+	 * @param array $url
+	 */
+	private function setPath($url)
+	{
+		$this->path = isset($url['path']) ? $url['path'] : '';
+	}
+
+
+	/**
+	 * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
+	 * will return a string like: '?key=value'
+	 *
+	 * @return string
+	 */
+	public function queryString()
+	{
+		return $this->query !== '' ? '?' . $this->query : '';
+	}
+
+
+	/**
+	 * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
+	 * will return an array like: array('key' => 'value')
+	 *
+	 * @return array
+	 */
+	public function queryParams()
+	{
+		return wp_parse_args($this->query);
+	}
+
+
+	/**
+	 * @param array $url
+	 */
+	private function setQuery($url)
+	{
+		$this->query = isset($url['query']) ? $url['query'] : '';
+	}
+
+
+	/**
+	 * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
+	 * will return a string like: '#id'
+	 *
+	 * @return string
+	 */
+	public function fragment()
+	{
+		return $this->fragment !== '' ? '#' . $this->fragment : '';
+	}
+
+
+	/**
+	 * @param array $url
+	 */
+	private function setFragment($url)
+	{
+		$this->fragment = isset($url['fragment']) ? $url['fragment'] : '';
+	}
+
+
+	/**
+	 * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
+	 * will return a string like: 'abc://example.com/path/data?key=value#id'
+	 *
+	 * @return string
+	 */
+	public function getFullUrl()
+	{
+		return $this->scheme() . $this->host() . $this->path() . $this->queryString() . $this->fragment();
+	}
+
+
+	/**
+	 * For a URL like: abc://username:password@example.com:123/path/data?key=value#id
+	 * will return a string like: 'abc://example.com/path/data?key=value#id'
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->getFullUrl();
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -51,7 +51,7 @@ 
      */
     public function __construct($url)
     {
-        if (! filter_var(
+        if ( ! filter_var(
             $url,
             FILTER_VALIDATE_URL,
             array(FILTER_FLAG_SCHEME_REQUIRED, FILTER_FLAG_HOST_REQUIRED)
@@ -89,7 +89,7 @@ 
      */
     private function setScheme($url)
     {
-        $this->scheme = $url['scheme'] . '://';
+        $this->scheme = $url['scheme'].'://';
     }
 
 
@@ -143,7 +143,7 @@ 
      */
     public function queryString()
     {
-        return $this->query !== '' ? '?' . $this->query : '';
+        return $this->query !== '' ? '?'.$this->query : '';
     }
 
 
@@ -176,7 +176,7 @@ 
      */
     public function fragment()
     {
-        return $this->fragment !== '' ? '#' . $this->fragment : '';
+        return $this->fragment !== '' ? '#'.$this->fragment : '';
     }
 
 
@@ -197,7 +197,7 @@ 
      */
     public function getFullUrl()
     {
-        return $this->scheme() . $this->host() . $this->path() . $this->queryString() . $this->fragment();
+        return $this->scheme().$this->host().$this->path().$this->queryString().$this->fragment();
     }
 
 

core/domain/values/session/SessionLifespan.php

Indentation +94 added lines, -94 removed lines

@@ -20,98 +20,98 @@
 class SessionLifespan
 {
 
-    /**
-     * how long an EE session lasts in seconds
-     * default session lifespan of 1 hour (for not so instant IPNs)
-     *
-     * @var int $lifespan
-     */
-    private $lifespan;
-
-
-    /**
-     * SessionLifespan constructor.
-     *
-     * @param int $lifespan
-     * @throws DomainException
-     */
-    public function __construct($lifespan = 0)
-    {
-        $lifespan = absint($lifespan);
-        $lifespan = $lifespan > 0 ? $lifespan : (int) HOUR_IN_SECONDS;
-        $this->setLifespan($lifespan);
-    }
-
-
-    /**
-     * @param int $lifespan
-     * @throws DomainException
-     */
-    protected function setLifespan($lifespan)
-    {
-        if ($lifespan < 60) {
-            throw new DomainException(
-                esc_html__(
-                    'The session lifespan needs to be at least 60 seconds, and even that is extremely short',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->lifespan = apply_filters(
-            'FHEE__EventEspresso_core_domain_values_session_SessionLifespan__setLifespan___lifespan',
-            // apply legacy filter for now but add doing it wrong notice in future
-            apply_filters(
-                'FHEE__EE_Session__construct___lifespan',
-                $lifespan
-            )
-        ) + 1;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function inSeconds()
-    {
-        return $this->lifespan;
-    }
-
-
-    /**
-     * @param string $separator
-     * @return string
-     */
-    public function inHoursMinutesSeconds($separator = ':')
-    {
-        return sprintf(
-            '%02d%s%02d%s%02d',
-            floor($this->lifespan / 3600),
-            $separator,
-            ($this->lifespan / 60) % 60,
-            $separator,
-            $this->lifespan % 60
-        );
-    }
-
-
-    /**
-     * Returns a timestamp for when the session would expire based on this lifespan
-     *
-     * @param bool $utc If true, displays expiration in UTC
-     *                  If false, displays expiration in local time
-     * @return int
-     */
-    public function expiration($utc = true)
-    {
-        return (int) current_time('timestamp', $utc) - $this->lifespan;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return (string) $this->inSeconds();
-    }
+	/**
+	 * how long an EE session lasts in seconds
+	 * default session lifespan of 1 hour (for not so instant IPNs)
+	 *
+	 * @var int $lifespan
+	 */
+	private $lifespan;
+
+
+	/**
+	 * SessionLifespan constructor.
+	 *
+	 * @param int $lifespan
+	 * @throws DomainException
+	 */
+	public function __construct($lifespan = 0)
+	{
+		$lifespan = absint($lifespan);
+		$lifespan = $lifespan > 0 ? $lifespan : (int) HOUR_IN_SECONDS;
+		$this->setLifespan($lifespan);
+	}
+
+
+	/**
+	 * @param int $lifespan
+	 * @throws DomainException
+	 */
+	protected function setLifespan($lifespan)
+	{
+		if ($lifespan < 60) {
+			throw new DomainException(
+				esc_html__(
+					'The session lifespan needs to be at least 60 seconds, and even that is extremely short',
+					'event_espresso'
+				)
+			);
+		}
+		$this->lifespan = apply_filters(
+			'FHEE__EventEspresso_core_domain_values_session_SessionLifespan__setLifespan___lifespan',
+			// apply legacy filter for now but add doing it wrong notice in future
+			apply_filters(
+				'FHEE__EE_Session__construct___lifespan',
+				$lifespan
+			)
+		) + 1;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function inSeconds()
+	{
+		return $this->lifespan;
+	}
+
+
+	/**
+	 * @param string $separator
+	 * @return string
+	 */
+	public function inHoursMinutesSeconds($separator = ':')
+	{
+		return sprintf(
+			'%02d%s%02d%s%02d',
+			floor($this->lifespan / 3600),
+			$separator,
+			($this->lifespan / 60) % 60,
+			$separator,
+			$this->lifespan % 60
+		);
+	}
+
+
+	/**
+	 * Returns a timestamp for when the session would expire based on this lifespan
+	 *
+	 * @param bool $utc If true, displays expiration in UTC
+	 *                  If false, displays expiration in local time
+	 * @return int
+	 */
+	public function expiration($utc = true)
+	{
+		return (int) current_time('timestamp', $utc) - $this->lifespan;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return (string) $this->inSeconds();
+	}
 }

core/domain/values/Version.php

Indentation +291 added lines, -291 removed lines

@@ -16,295 +16,295 @@
 class Version
 {
 
-    const RELEASE_TYPE_RC    = 'rc';
-
-    const RELEASE_TYPE_BETA  = 'beta';
-
-    const RELEASE_TYPE_DECAF = 'decaf';
-
-    const RELEASE_TYPE_PROD  = 'p';
-
-    /**
-     * @var int $major
-     */
-    private $major;
-
-    /**
-     * @var int $minor
-     */
-    private $minor;
-
-    /**
-     * @var int $patch
-     */
-    private $patch;
-
-    /**
-     * @var string $release
-     */
-    private $release;
-
-    /**
-     * @var int $build
-     */
-    private $build;
-
-
-    /**
-     * Version constructor.
-     *
-     * @param int    $major
-     * @param int    $minor
-     * @param int    $patch
-     * @param string $release
-     * @param int    $build
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function __construct($major, $minor, $patch, $release = Version::RELEASE_TYPE_PROD, $build = 0)
-    {
-        $this->setMajor($major);
-        $this->setMinor($minor);
-        $this->setPatch($patch);
-        $this->setRelease($release);
-        $this->setBuild($build);
-    }
-
-
-    /**
-     * @param string $version_string
-     * @return Version
-     * @throws InvalidArgumentException
-     */
-    public static function fromString($version_string)
-    {
-        // compare incoming version string against the lowest possible valid version
-        if (version_compare($version_string, '0.0.1.dev.001', '<')) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('"%1$s" is not a valid version string', 'event_espresso'),
-                    $version_string
-                )
-            );
-        }
-        // break apart incoming version string
-        $version_parts = explode('.', $version_string);
-        // verify that version string at least contains {major}.{minor}.{patch}
-        if (count($version_parts) < 3) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'At minimum, a version string needs to be in a "{major}.{minor}.{patch}" format, therefore "%1$s" is not valid',
-                        'event_espresso'
-                    ),
-                    $version_string
-                )
-            );
-        }
-        // add defaults for missing pieces
-        $version_parts += array(0,0,0,'p',0);
-        // reassign to individual variables
-        list($major, $minor, $patch, $release, $build) = $version_parts;
-        return new Version(
-            (int) $major,
-            (int) $minor,
-            (int) $patch,
-            $release,
-            (int) $build
-        );
-    }
-
-
-    /**
-     * @return int
-     */
-    public function major()
-    {
-        return $this->major;
-    }
-
-
-    /**
-     * @param int|string $major
-     * @throws InvalidDataTypeException
-     */
-    private function setMajor($major)
-    {
-        if (! is_int($major)) {
-            throw new InvalidDataTypeException(
-                '$major',
-                $major,
-                'integer'
-            );
-        }
-        $this->major = absint($major);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function minor()
-    {
-        return $this->minor;
-    }
-
-
-    /**
-     * @param int|string $minor
-     * @throws InvalidDataTypeException
-     */
-    private function setMinor($minor)
-    {
-        if (! is_int($minor)) {
-            throw new InvalidDataTypeException(
-                '$minor',
-                $minor,
-                'integer'
-            );
-        }
-        $this->minor = absint($minor);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function patch()
-    {
-        return $this->patch;
-    }
-
-
-    /**
-     * @param int|string $patch
-     * @throws InvalidDataTypeException
-     */
-    private function setPatch($patch)
-    {
-        if (! is_int($patch)) {
-            throw new InvalidDataTypeException(
-                '$patch',
-                $patch,
-                'integer'
-            );
-        }
-        $this->patch = absint($patch);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function release()
-    {
-        return $this->release;
-    }
-
-
-    /**
-     * @param string $release
-     * @throws InvalidArgumentException
-     */
-    private function setRelease($release)
-    {
-        $valid_release_types = array(
-            Version::RELEASE_TYPE_RC,
-            Version::RELEASE_TYPE_BETA,
-            Version::RELEASE_TYPE_DECAF,
-            Version::RELEASE_TYPE_PROD,
-        );
-        if (! in_array($release, $valid_release_types, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid release type. Please use one of the following values: %2$s',
-                        'event_espresso'
-                    ),
-                    $release,
-                    implode(', ', $valid_release_types)
-                )
-            );
-        }
-        $this->release = $release;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function build()
-    {
-        return $this->build;
-    }
-
-
-    /**
-     * @param int|string $build
-     * @throws InvalidDataTypeException
-     */
-    private function setBuild($build)
-    {
-        if (! is_int($build)) {
-            throw new InvalidDataTypeException(
-                '$build',
-                $build,
-                'integer'
-            );
-        }
-        $this->build = absint($build);
-    }
-
-
-    /**
-     * @param Version $other_version
-     * @return int
-     */
-    public function compare(Version $other_version)
-    {
-        return version_compare((string) $this, (string) $other_version);
-    }
-
-
-    /**
-     * @param Version $other_version
-     * @return bool
-     */
-    public function equals(Version $other_version)
-    {
-        return version_compare((string) $this, (string) $other_version, '==');
-    }
-
-
-    /**
-     * @param Version $other_version
-     * @return bool
-     */
-    public function newerThan(Version $other_version)
-    {
-        return version_compare((string) $this, (string) $other_version, '>');
-    }
-
-
-    /**
-     * @param Version $other_version
-     * @return bool
-     */
-    public function olderThan(Version $other_version)
-    {
-        return version_compare((string) $this, (string) $other_version, '<');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        $version_string = "{$this->major}.{$this->minor}.{$this->patch}.{$this->release}";
-        if ($this->release !== Version::RELEASE_TYPE_PROD && $this->release !== Version::RELEASE_TYPE_DECAF) {
-            $version_string .= '.' . str_pad($this->build, 3, '0', STR_PAD_LEFT);
-        }
-        return $version_string;
-    }
+	const RELEASE_TYPE_RC    = 'rc';
+
+	const RELEASE_TYPE_BETA  = 'beta';
+
+	const RELEASE_TYPE_DECAF = 'decaf';
+
+	const RELEASE_TYPE_PROD  = 'p';
+
+	/**
+	 * @var int $major
+	 */
+	private $major;
+
+	/**
+	 * @var int $minor
+	 */
+	private $minor;
+
+	/**
+	 * @var int $patch
+	 */
+	private $patch;
+
+	/**
+	 * @var string $release
+	 */
+	private $release;
+
+	/**
+	 * @var int $build
+	 */
+	private $build;
+
+
+	/**
+	 * Version constructor.
+	 *
+	 * @param int    $major
+	 * @param int    $minor
+	 * @param int    $patch
+	 * @param string $release
+	 * @param int    $build
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($major, $minor, $patch, $release = Version::RELEASE_TYPE_PROD, $build = 0)
+	{
+		$this->setMajor($major);
+		$this->setMinor($minor);
+		$this->setPatch($patch);
+		$this->setRelease($release);
+		$this->setBuild($build);
+	}
+
+
+	/**
+	 * @param string $version_string
+	 * @return Version
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromString($version_string)
+	{
+		// compare incoming version string against the lowest possible valid version
+		if (version_compare($version_string, '0.0.1.dev.001', '<')) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('"%1$s" is not a valid version string', 'event_espresso'),
+					$version_string
+				)
+			);
+		}
+		// break apart incoming version string
+		$version_parts = explode('.', $version_string);
+		// verify that version string at least contains {major}.{minor}.{patch}
+		if (count($version_parts) < 3) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'At minimum, a version string needs to be in a "{major}.{minor}.{patch}" format, therefore "%1$s" is not valid',
+						'event_espresso'
+					),
+					$version_string
+				)
+			);
+		}
+		// add defaults for missing pieces
+		$version_parts += array(0,0,0,'p',0);
+		// reassign to individual variables
+		list($major, $minor, $patch, $release, $build) = $version_parts;
+		return new Version(
+			(int) $major,
+			(int) $minor,
+			(int) $patch,
+			$release,
+			(int) $build
+		);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function major()
+	{
+		return $this->major;
+	}
+
+
+	/**
+	 * @param int|string $major
+	 * @throws InvalidDataTypeException
+	 */
+	private function setMajor($major)
+	{
+		if (! is_int($major)) {
+			throw new InvalidDataTypeException(
+				'$major',
+				$major,
+				'integer'
+			);
+		}
+		$this->major = absint($major);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function minor()
+	{
+		return $this->minor;
+	}
+
+
+	/**
+	 * @param int|string $minor
+	 * @throws InvalidDataTypeException
+	 */
+	private function setMinor($minor)
+	{
+		if (! is_int($minor)) {
+			throw new InvalidDataTypeException(
+				'$minor',
+				$minor,
+				'integer'
+			);
+		}
+		$this->minor = absint($minor);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function patch()
+	{
+		return $this->patch;
+	}
+
+
+	/**
+	 * @param int|string $patch
+	 * @throws InvalidDataTypeException
+	 */
+	private function setPatch($patch)
+	{
+		if (! is_int($patch)) {
+			throw new InvalidDataTypeException(
+				'$patch',
+				$patch,
+				'integer'
+			);
+		}
+		$this->patch = absint($patch);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function release()
+	{
+		return $this->release;
+	}
+
+
+	/**
+	 * @param string $release
+	 * @throws InvalidArgumentException
+	 */
+	private function setRelease($release)
+	{
+		$valid_release_types = array(
+			Version::RELEASE_TYPE_RC,
+			Version::RELEASE_TYPE_BETA,
+			Version::RELEASE_TYPE_DECAF,
+			Version::RELEASE_TYPE_PROD,
+		);
+		if (! in_array($release, $valid_release_types, true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid release type. Please use one of the following values: %2$s',
+						'event_espresso'
+					),
+					$release,
+					implode(', ', $valid_release_types)
+				)
+			);
+		}
+		$this->release = $release;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function build()
+	{
+		return $this->build;
+	}
+
+
+	/**
+	 * @param int|string $build
+	 * @throws InvalidDataTypeException
+	 */
+	private function setBuild($build)
+	{
+		if (! is_int($build)) {
+			throw new InvalidDataTypeException(
+				'$build',
+				$build,
+				'integer'
+			);
+		}
+		$this->build = absint($build);
+	}
+
+
+	/**
+	 * @param Version $other_version
+	 * @return int
+	 */
+	public function compare(Version $other_version)
+	{
+		return version_compare((string) $this, (string) $other_version);
+	}
+
+
+	/**
+	 * @param Version $other_version
+	 * @return bool
+	 */
+	public function equals(Version $other_version)
+	{
+		return version_compare((string) $this, (string) $other_version, '==');
+	}
+
+
+	/**
+	 * @param Version $other_version
+	 * @return bool
+	 */
+	public function newerThan(Version $other_version)
+	{
+		return version_compare((string) $this, (string) $other_version, '>');
+	}
+
+
+	/**
+	 * @param Version $other_version
+	 * @return bool
+	 */
+	public function olderThan(Version $other_version)
+	{
+		return version_compare((string) $this, (string) $other_version, '<');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		$version_string = "{$this->major}.{$this->minor}.{$this->patch}.{$this->release}";
+		if ($this->release !== Version::RELEASE_TYPE_PROD && $this->release !== Version::RELEASE_TYPE_DECAF) {
+			$version_string .= '.' . str_pad($this->build, 3, '0', STR_PAD_LEFT);
+		}
+		return $version_string;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -102,7 +102,7 @@ 
             );
         }
         // add defaults for missing pieces
-        $version_parts += array(0,0,0,'p',0);
+        $version_parts += array(0, 0, 0, 'p', 0);
         // reassign to individual variables
         list($major, $minor, $patch, $release, $build) = $version_parts;
         return new Version(
@@ -130,7 +130,7 @@ 
      */
     private function setMajor($major)
     {
-        if (! is_int($major)) {
+        if ( ! is_int($major)) {
             throw new InvalidDataTypeException(
                 '$major',
                 $major,
@@ -156,7 +156,7 @@ 
      */
     private function setMinor($minor)
     {
-        if (! is_int($minor)) {
+        if ( ! is_int($minor)) {
             throw new InvalidDataTypeException(
                 '$minor',
                 $minor,
@@ -182,7 +182,7 @@ 
      */
     private function setPatch($patch)
     {
-        if (! is_int($patch)) {
+        if ( ! is_int($patch)) {
             throw new InvalidDataTypeException(
                 '$patch',
                 $patch,
@@ -214,7 +214,7 @@ 
             Version::RELEASE_TYPE_DECAF,
             Version::RELEASE_TYPE_PROD,
         );
-        if (! in_array($release, $valid_release_types, true)) {
+        if ( ! in_array($release, $valid_release_types, true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -245,7 +245,7 @@ 
      */
     private function setBuild($build)
     {
-        if (! is_int($build)) {
+        if ( ! is_int($build)) {
             throw new InvalidDataTypeException(
                 '$build',
                 $build,
@@ -303,7 +303,7 @@ 
     {
         $version_string = "{$this->major}.{$this->minor}.{$this->patch}.{$this->release}";
         if ($this->release !== Version::RELEASE_TYPE_PROD && $this->release !== Version::RELEASE_TYPE_DECAF) {
-            $version_string .= '.' . str_pad($this->build, 3, '0', STR_PAD_LEFT);
+            $version_string .= '.'.str_pad($this->build, 3, '0', STR_PAD_LEFT);
         }
         return $version_string;
     }

core/domain/values/EmailAddress.php

Indentation +44 added lines, -44 removed lines

@@ -15,59 +15,59 @@
 class EmailAddress
 {
 
-    /**
-     * @var string $email_address
-     */
-    private $email_address;
+	/**
+	 * @var string $email_address
+	 */
+	private $email_address;
 
 
 
-    /**
-     * EmailAddress constructor.
-     *
-     * @param string                  $email_address
-     * @param EmailValidatorInterface $validator
-     * @throws EmailValidationException
-     */
-    public function __construct($email_address, EmailValidatorInterface $validator)
-    {
-        $validator->validate($email_address);
-        $this->email_address = $email_address;
-    }
+	/**
+	 * EmailAddress constructor.
+	 *
+	 * @param string                  $email_address
+	 * @param EmailValidatorInterface $validator
+	 * @throws EmailValidationException
+	 */
+	public function __construct($email_address, EmailValidatorInterface $validator)
+	{
+		$validator->validate($email_address);
+		$this->email_address = $email_address;
+	}
 
 
 
-    /**
-     * returns the string value for this EmailAddress
-     *
-     * @return string
-     */
-    public function get()
-    {
-        return $this->email_address;
-    }
+	/**
+	 * returns the string value for this EmailAddress
+	 *
+	 * @return string
+	 */
+	public function get()
+	{
+		return $this->email_address;
+	}
 
 
 
-    /**
-     * compare another EmailAddress to this one to determine if they are the same
-     *
-     * @param EmailAddress $address
-     * @return bool
-     */
-    public function equals(EmailAddress $address)
-    {
-        return strtolower((string)$this) === strtolower((string)$address);
-    }
+	/**
+	 * compare another EmailAddress to this one to determine if they are the same
+	 *
+	 * @param EmailAddress $address
+	 * @return bool
+	 */
+	public function equals(EmailAddress $address)
+	{
+		return strtolower((string)$this) === strtolower((string)$address);
+	}
 
 
-    /**
-     * allows an EmailAddress object to be used as a string
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->email_address;
-    }
+	/**
+	 * allows an EmailAddress object to be used as a string
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->email_address;
+	}
 }

core/domain/RequiresRegistryInterface.php

Indentation +4 added lines, -4 removed lines

@@ -15,8 +15,8 @@
 interface RequiresRegistryInterface
 {
 
-    /**
-     * @param EE_Registry $registry
-     */
-    public function setRegistry($registry);
+	/**
+	 * @param EE_Registry $registry
+	 */
+	public function setRegistry($registry);
 }

core/domain/entities/DbSafeDateTime.php

Indentation +150 added lines, -150 removed lines

@@ -18,154 +18,154 @@
 class DbSafeDateTime extends DateTime
 {
 
-    // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
-    /**
-     * @type string db_safe_timestamp_format
-     */
-    const db_safe_timestamp_format = 'Y-m-d H:i:s O e';
-    // phpcs:enable
-
-    /**
-     * DateTime object converted to a string that includes the date, time, UTC offset, and timezone identifier
-     *
-     * @type string $_datetime_string
-     */
-    protected $_datetime_string = '';
-
-    /**
-     * where to write the error log to
-     *
-     * @type string $_error_log_dir
-     */
-    protected $_error_log_dir = '';
-
-
-    /**
-     * @param string $error_log_dir
-     */
-    public function setErrorLogDir($error_log_dir)
-    {
-        // if the folder path is writable, then except the path + filename, else keep empty
-        $this->_error_log_dir = is_writable(str_replace(basename($error_log_dir), '', $error_log_dir))
-            ? $error_log_dir
-            : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->format(DbSafeDateTime::db_safe_timestamp_format);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function __sleep()
-    {
-        $this->_datetime_string = $this->format(DbSafeDateTime::db_safe_timestamp_format);
-        $date = DateTime::createFromFormat(
-            DbSafeDateTime::db_safe_timestamp_format,
-            $this->_datetime_string
-        );
-        if (! $date instanceof DateTime) {
-            try {
-                // we want a stack trace to determine where the malformed date came from, so...
-                throw new DomainException('');
-            } catch (DomainException $e) {
-                $stack_trace = $e->getTraceAsString();
-            }
-            $this->writeToErrorLog(
-                sprintf(
-                    __(
-                        'A valid DateTime could not be generated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s %2$s Stack Trace: %5$s',
-                        'event_espresso'
-                    ),
-                    $this->_datetime_string,
-                    '<br />',
-                    print_r(DateTime::getLastErrors(), true),
-                    PHP_VERSION,
-                    $stack_trace
-                )
-            );
-        }
-        return array('_datetime_string');
-    }
-
-
-    /**
-     * if an empty or null value got saved to the db for a datetime,
-     * then some servers and/or PHP itself will incorrectly convert that date string
-     * resulting in "-0001-11-30" for the year-month-day.
-     * see the Notes section
-     *
-     * @link http://php.net/manual/en/datetime.formats.date.php
-     * We'll replace those with "0000-00-00" which will allow a valid DateTime object to be created,
-     * but still result in the internal date for that object being set to "-0001-11-30 10:00:00.000000".
-     * so we're no better off, but at least things won't go fatal on us.
-     */
-    public function __wakeup()
-    {
-        $this->_datetime_string = str_replace(
-            array('-0001-11-29', '-0001-11-30'),
-            '0000-00-00',
-            $this->_datetime_string
-        );
-        $date = DateTime::createFromFormat(
-            DbSafeDateTime::db_safe_timestamp_format,
-            $this->_datetime_string
-        );
-        if (! $date instanceof DateTime) {
-            $this->writeToErrorLog(
-                sprintf(
-                    __(
-                        'A valid DateTime could not be recreated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s',
-                        'event_espresso'
-                    ),
-                    $this->_datetime_string,
-                    '<br />',
-                    print_r(DateTime::getLastErrors(), true),
-                    PHP_VERSION
-                )
-            );
-        } else {
-            $this->__construct(
-                $date->format(\EE_Datetime_Field::mysql_timestamp_format),
-                new DateTimeZone($date->format('e'))
-            );
-        }
-    }
-
-
-    /**
-     * Creates a DbSafeDateTime from ye old DateTime
-     *
-     * @param DateTime $datetime
-     * @return \EventEspresso\core\domain\entities\DbSafeDateTime
-     */
-    public static function createFromDateTime(DateTime $datetime)
-    {
-        return new DbSafeDateTime(
-            $datetime->format(\EE_Datetime_Field::mysql_timestamp_format),
-            new DateTimeZone($datetime->format('e'))
-        );
-    }
-
-
-    /**
-     * @param string $message
-     */
-    private function writeToErrorLog($message)
-    {
-        if (! empty($this->_error_log_dir)) {
-            /** @noinspection ForgottenDebugOutputInspection */
-            error_log($message, 3, $this->_error_log_dir);
-        } else {
-            /** @noinspection ForgottenDebugOutputInspection */
-            error_log($message);
-        }
-    }
+	// phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
+	/**
+	 * @type string db_safe_timestamp_format
+	 */
+	const db_safe_timestamp_format = 'Y-m-d H:i:s O e';
+	// phpcs:enable
+
+	/**
+	 * DateTime object converted to a string that includes the date, time, UTC offset, and timezone identifier
+	 *
+	 * @type string $_datetime_string
+	 */
+	protected $_datetime_string = '';
+
+	/**
+	 * where to write the error log to
+	 *
+	 * @type string $_error_log_dir
+	 */
+	protected $_error_log_dir = '';
+
+
+	/**
+	 * @param string $error_log_dir
+	 */
+	public function setErrorLogDir($error_log_dir)
+	{
+		// if the folder path is writable, then except the path + filename, else keep empty
+		$this->_error_log_dir = is_writable(str_replace(basename($error_log_dir), '', $error_log_dir))
+			? $error_log_dir
+			: '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->format(DbSafeDateTime::db_safe_timestamp_format);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$this->_datetime_string = $this->format(DbSafeDateTime::db_safe_timestamp_format);
+		$date = DateTime::createFromFormat(
+			DbSafeDateTime::db_safe_timestamp_format,
+			$this->_datetime_string
+		);
+		if (! $date instanceof DateTime) {
+			try {
+				// we want a stack trace to determine where the malformed date came from, so...
+				throw new DomainException('');
+			} catch (DomainException $e) {
+				$stack_trace = $e->getTraceAsString();
+			}
+			$this->writeToErrorLog(
+				sprintf(
+					__(
+						'A valid DateTime could not be generated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s %2$s Stack Trace: %5$s',
+						'event_espresso'
+					),
+					$this->_datetime_string,
+					'<br />',
+					print_r(DateTime::getLastErrors(), true),
+					PHP_VERSION,
+					$stack_trace
+				)
+			);
+		}
+		return array('_datetime_string');
+	}
+
+
+	/**
+	 * if an empty or null value got saved to the db for a datetime,
+	 * then some servers and/or PHP itself will incorrectly convert that date string
+	 * resulting in "-0001-11-30" for the year-month-day.
+	 * see the Notes section
+	 *
+	 * @link http://php.net/manual/en/datetime.formats.date.php
+	 * We'll replace those with "0000-00-00" which will allow a valid DateTime object to be created,
+	 * but still result in the internal date for that object being set to "-0001-11-30 10:00:00.000000".
+	 * so we're no better off, but at least things won't go fatal on us.
+	 */
+	public function __wakeup()
+	{
+		$this->_datetime_string = str_replace(
+			array('-0001-11-29', '-0001-11-30'),
+			'0000-00-00',
+			$this->_datetime_string
+		);
+		$date = DateTime::createFromFormat(
+			DbSafeDateTime::db_safe_timestamp_format,
+			$this->_datetime_string
+		);
+		if (! $date instanceof DateTime) {
+			$this->writeToErrorLog(
+				sprintf(
+					__(
+						'A valid DateTime could not be recreated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s',
+						'event_espresso'
+					),
+					$this->_datetime_string,
+					'<br />',
+					print_r(DateTime::getLastErrors(), true),
+					PHP_VERSION
+				)
+			);
+		} else {
+			$this->__construct(
+				$date->format(\EE_Datetime_Field::mysql_timestamp_format),
+				new DateTimeZone($date->format('e'))
+			);
+		}
+	}
+
+
+	/**
+	 * Creates a DbSafeDateTime from ye old DateTime
+	 *
+	 * @param DateTime $datetime
+	 * @return \EventEspresso\core\domain\entities\DbSafeDateTime
+	 */
+	public static function createFromDateTime(DateTime $datetime)
+	{
+		return new DbSafeDateTime(
+			$datetime->format(\EE_Datetime_Field::mysql_timestamp_format),
+			new DateTimeZone($datetime->format('e'))
+		);
+	}
+
+
+	/**
+	 * @param string $message
+	 */
+	private function writeToErrorLog($message)
+	{
+		if (! empty($this->_error_log_dir)) {
+			/** @noinspection ForgottenDebugOutputInspection */
+			error_log($message, 3, $this->_error_log_dir);
+		} else {
+			/** @noinspection ForgottenDebugOutputInspection */
+			error_log($message);
+		}
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -71,7 +71,7 @@ 
             DbSafeDateTime::db_safe_timestamp_format,
             $this->_datetime_string
         );
-        if (! $date instanceof DateTime) {
+        if ( ! $date instanceof DateTime) {
             try {
                 // we want a stack trace to determine where the malformed date came from, so...
                 throw new DomainException('');
@@ -118,7 +118,7 @@ 
             DbSafeDateTime::db_safe_timestamp_format,
             $this->_datetime_string
         );
-        if (! $date instanceof DateTime) {
+        if ( ! $date instanceof DateTime) {
             $this->writeToErrorLog(
                 sprintf(
                     __(
@@ -160,7 +160,7 @@ 
      */
     private function writeToErrorLog($message)
     {
-        if (! empty($this->_error_log_dir)) {
+        if ( ! empty($this->_error_log_dir)) {
             /** @noinspection ForgottenDebugOutputInspection */
             error_log($message, 3, $this->_error_log_dir);
         } else {

core/domain/entities/RegUrlLink.php

Indentation +83 added lines, -83 removed lines

@@ -18,97 +18,97 @@
 class RegUrlLink
 {
 
-    /*
+	/*
      * @var string $reg_url_link
      */
-    private $reg_url_link;
+	private $reg_url_link;
 
 
-    /**
-     * @param string $reg_url_link
-     * @return RegUrlLink
-     * @throws InvalidArgumentException
-     */
-    public static function fromRegUrlLinkString($reg_url_link)
-    {
-        if (empty($reg_url_link) || ! is_string($reg_url_link)) {
-            throw new InvalidArgumentException(
-                __(
-                    'You must supply a valid non-empty string to generate a reg_url_link.',
-                    'event_espresso'
-                )
-            );
-        }
-        return new RegUrlLink(1, '', $reg_url_link);
-    }
+	/**
+	 * @param string $reg_url_link
+	 * @return RegUrlLink
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromRegUrlLinkString($reg_url_link)
+	{
+		if (empty($reg_url_link) || ! is_string($reg_url_link)) {
+			throw new InvalidArgumentException(
+				__(
+					'You must supply a valid non-empty string to generate a reg_url_link.',
+					'event_espresso'
+				)
+			);
+		}
+		return new RegUrlLink(1, '', $reg_url_link);
+	}
 
 
-    /**
-     * @param EE_Registration $registration
-     * @return RegUrlLink
-     * @throws EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public static function fromRegistration(EE_Registration $registration)
-    {
-        return new RegUrlLink(
-            $registration->count(),
-            $registration->ticket_line_item()
-        );
-    }
+	/**
+	 * @param EE_Registration $registration
+	 * @return RegUrlLink
+	 * @throws EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromRegistration(EE_Registration $registration)
+	{
+		return new RegUrlLink(
+			$registration->count(),
+			$registration->ticket_line_item()
+		);
+	}
 
 
-    /**
-     * CreateRegUrlLinkCommand constructor.
-     *
-     * @param int    $reg_count
-     * @param mixed  $base_code
-     * @param string $reg_url_link
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $reg_count = 1,
-        $base_code = '',
-        $reg_url_link = ''
-    ) {
-        if (! empty($reg_url_link) && is_string($reg_url_link)) {
-            $this->reg_url_link = apply_filters(
-                'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-                $reg_url_link,
-                $reg_count,
-                $base_code,
-                $reg_url_link
-            );
-            return;
-        }
-        $reg_count = max(1, absint($reg_count));
-        $base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code;
-        if (empty($base_code) || ! is_string($base_code)) {
-            throw new InvalidArgumentException(
-                __(
-                    'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->reg_url_link = (string)apply_filters(
-            'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-            $reg_count . '-' . md5($base_code . microtime()),
-            $reg_count,
-            $base_code,
-            $reg_url_link
-        );
-    }
+	/**
+	 * CreateRegUrlLinkCommand constructor.
+	 *
+	 * @param int    $reg_count
+	 * @param mixed  $base_code
+	 * @param string $reg_url_link
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$reg_count = 1,
+		$base_code = '',
+		$reg_url_link = ''
+	) {
+		if (! empty($reg_url_link) && is_string($reg_url_link)) {
+			$this->reg_url_link = apply_filters(
+				'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
+				$reg_url_link,
+				$reg_count,
+				$base_code,
+				$reg_url_link
+			);
+			return;
+		}
+		$reg_count = max(1, absint($reg_count));
+		$base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code;
+		if (empty($base_code) || ! is_string($base_code)) {
+			throw new InvalidArgumentException(
+				__(
+					'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->reg_url_link = (string)apply_filters(
+			'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
+			$reg_count . '-' . md5($base_code . microtime()),
+			$reg_count,
+			$base_code,
+			$reg_url_link
+		);
+	}
 
 
-    /**
-     * Return the object as a string
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->reg_url_link;
-    }
+	/**
+	 * Return the object as a string
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->reg_url_link;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
         $base_code = '',
         $reg_url_link = ''
     ) {
-        if (! empty($reg_url_link) && is_string($reg_url_link)) {
+        if ( ! empty($reg_url_link) && is_string($reg_url_link)) {
             $this->reg_url_link = apply_filters(
                 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
                 $reg_url_link,
@@ -92,9 +92,9 @@ 
                 )
             );
         }
-        $this->reg_url_link = (string)apply_filters(
+        $this->reg_url_link = (string) apply_filters(
             'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-            $reg_count . '-' . md5($base_code . microtime()),
+            $reg_count.'-'.md5($base_code.microtime()),
             $reg_count,
             $base_code,
             $reg_url_link

core/domain/entities/notifications/PersistentAdminNotice.php

Indentation +311 added lines, -311 removed lines

@@ -24,315 +24,315 @@
 class PersistentAdminNotice implements RequiresCapCheckInterface
 {
 
-    /**
-     * @var string $name
-     */
-    protected $name = '';
-
-    /**
-     * @var string $message
-     */
-    protected $message = '';
-
-    /**
-     * @var boolean $force_update
-     */
-    protected $force_update = false;
-
-    /**
-     * @var string $capability
-     */
-    protected $capability = 'manage_options';
-
-    /**
-     * @var string $cap_context
-     */
-    protected $cap_context = 'view persistent admin notice';
-
-    /**
-     * @var boolean $dismissed
-     */
-    protected $dismissed = false;
-
-    /**
-     * @var CapCheckInterface $cap_check
-     */
-    protected $cap_check;
-
-    /**
-     * if true, then this notice will be deleted from the database
-     *
-     * @var boolean $purge
-     */
-    protected $purge = false;
-
-    /**
-     * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager
-     * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer
-     *
-     * @var boolean $registered
-     */
-    private $registered = false;
-
-
-    /**
-     * PersistentAdminNotice constructor
-     *
-     * @param string $name         [required] the name, or key of the Persistent Admin Notice to be stored
-     * @param string $message      [required] the message to be stored persistently until dismissed
-     * @param bool   $force_update enforce the reappearance of a persistent message
-     * @param string $capability   user capability required to view this notice
-     * @param string $cap_context  description for why the cap check is being performed
-     * @param bool   $dismissed    whether or not the user has already dismissed/viewed this notice
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        $name,
-        $message,
-        $force_update = false,
-        $capability = 'manage_options',
-        $cap_context = 'view persistent admin notice',
-        $dismissed = false
-    ) {
-        $this->setName($name);
-        $this->setMessage($message);
-        $this->setForceUpdate($force_update);
-        $this->setCapability($capability);
-        $this->setCapContext($cap_context);
-        $this->setDismissed($dismissed);
-        add_action(
-            'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
-            array($this, 'registerPersistentAdminNotice')
-        );
-        add_action('shutdown', array($this, 'confirmRegistered'), 999);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
-
-
-    /**
-     * @param string $name
-     * @throws InvalidDataTypeException
-     */
-    private function setName($name)
-    {
-        if (! is_string($name)) {
-            throw new InvalidDataTypeException('$name', $name, 'string');
-        }
-        $this->name = sanitize_key($name);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getMessage()
-    {
-        return $this->message;
-    }
-
-
-    /**
-     * @param string $message
-     * @throws InvalidDataTypeException
-     */
-    private function setMessage($message)
-    {
-        if (! is_string($message)) {
-            throw new InvalidDataTypeException('$message', $message, 'string');
-        }
-        global $allowedtags;
-        $allowedtags['br'] = array();
-        $this->message = wp_kses($message, $allowedtags);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function getForceUpdate()
-    {
-        return $this->force_update;
-    }
-
-
-    /**
-     * @param bool $force_update
-     */
-    private function setForceUpdate($force_update)
-    {
-        $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getCapability()
-    {
-        return $this->capability;
-    }
-
-
-    /**
-     * @param string $capability
-     * @throws InvalidDataTypeException
-     */
-    private function setCapability($capability)
-    {
-        if (! is_string($capability)) {
-            throw new InvalidDataTypeException('$capability', $capability, 'string');
-        }
-        $this->capability = ! empty($capability) ? $capability : 'manage_options';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getCapContext()
-    {
-        return $this->cap_context;
-    }
-
-
-    /**
-     * @param string $cap_context
-     * @throws InvalidDataTypeException
-     */
-    private function setCapContext($cap_context)
-    {
-        if (! is_string($cap_context)) {
-            throw new InvalidDataTypeException('$cap_context', $cap_context, 'string');
-        }
-        $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice';
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function getDismissed()
-    {
-        return $this->dismissed;
-    }
-
-
-    /**
-     * @param bool $dismissed
-     */
-    public function setDismissed($dismissed)
-    {
-        $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return CapCheckInterface
-     * @throws InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        if (! $this->cap_check instanceof CapCheckInterface) {
-            $this->setCapCheck(
-                new CapCheck(
-                    $this->capability,
-                    $this->cap_context
-                )
-            );
-        }
-        return $this->cap_check;
-    }
-
-
-    /**
-     * @param CapCheckInterface $cap_check
-     */
-    private function setCapCheck(CapCheckInterface $cap_check)
-    {
-        $this->cap_check = $cap_check;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function getPurge()
-    {
-        return $this->purge;
-    }
-
-
-    /**
-     * @param bool $purge
-     */
-    public function setPurge($purge)
-    {
-        $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * given a valid PersistentAdminNotice Collection,
-     * this notice will be added if it is not already found in the collection (using its name as the identifier)
-     * if an existing notice is found that has already been dismissed,
-     * but we are overriding with a forced update, then we will toggle its dismissed state,
-     * so that the notice is displayed again
-     *
-     * @param Collection $persistent_admin_notice_collection
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     */
-    public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection)
-    {
-        if ($this->registered) {
-            return;
-        }
-        // first check if this notice has already been added to the collection
-        if ($persistent_admin_notice_collection->has($this->name)) {
-            /** @var PersistentAdminNotice $existing */
-            $existing = $persistent_admin_notice_collection->get($this->name);
-            // we don't need to add it again (we can't actually)
-            // but if it has already been dismissed, and we are overriding with a forced update
-            if ($existing->getDismissed() && $this->getForceUpdate()) {
-                // then toggle the notice's dismissed state to true
-                // so that it gets displayed again
-                $existing->setDismissed(false);
-                // and make sure the message is set
-                $existing->setMessage($this->message);
-            }
-        } else {
-            $persistent_admin_notice_collection->add($this, $this->name);
-        }
-        $this->registered = true;
-    }
-
-
-    /**
-     * @throws Exception
-     */
-    public function confirmRegistered()
-    {
-        if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) {
-            PersistentAdminNoticeManager::loadRegisterAndSaveNotices();
-        }
-        if (! $this->registered && WP_DEBUG) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.',
-                        'event_espresso'
-                    ),
-                    $this->name
-                )
-            );
-        }
-    }
+	/**
+	 * @var string $name
+	 */
+	protected $name = '';
+
+	/**
+	 * @var string $message
+	 */
+	protected $message = '';
+
+	/**
+	 * @var boolean $force_update
+	 */
+	protected $force_update = false;
+
+	/**
+	 * @var string $capability
+	 */
+	protected $capability = 'manage_options';
+
+	/**
+	 * @var string $cap_context
+	 */
+	protected $cap_context = 'view persistent admin notice';
+
+	/**
+	 * @var boolean $dismissed
+	 */
+	protected $dismissed = false;
+
+	/**
+	 * @var CapCheckInterface $cap_check
+	 */
+	protected $cap_check;
+
+	/**
+	 * if true, then this notice will be deleted from the database
+	 *
+	 * @var boolean $purge
+	 */
+	protected $purge = false;
+
+	/**
+	 * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager
+	 * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer
+	 *
+	 * @var boolean $registered
+	 */
+	private $registered = false;
+
+
+	/**
+	 * PersistentAdminNotice constructor
+	 *
+	 * @param string $name         [required] the name, or key of the Persistent Admin Notice to be stored
+	 * @param string $message      [required] the message to be stored persistently until dismissed
+	 * @param bool   $force_update enforce the reappearance of a persistent message
+	 * @param string $capability   user capability required to view this notice
+	 * @param string $cap_context  description for why the cap check is being performed
+	 * @param bool   $dismissed    whether or not the user has already dismissed/viewed this notice
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		$name,
+		$message,
+		$force_update = false,
+		$capability = 'manage_options',
+		$cap_context = 'view persistent admin notice',
+		$dismissed = false
+	) {
+		$this->setName($name);
+		$this->setMessage($message);
+		$this->setForceUpdate($force_update);
+		$this->setCapability($capability);
+		$this->setCapContext($cap_context);
+		$this->setDismissed($dismissed);
+		add_action(
+			'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
+			array($this, 'registerPersistentAdminNotice')
+		);
+		add_action('shutdown', array($this, 'confirmRegistered'), 999);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
+
+
+	/**
+	 * @param string $name
+	 * @throws InvalidDataTypeException
+	 */
+	private function setName($name)
+	{
+		if (! is_string($name)) {
+			throw new InvalidDataTypeException('$name', $name, 'string');
+		}
+		$this->name = sanitize_key($name);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getMessage()
+	{
+		return $this->message;
+	}
+
+
+	/**
+	 * @param string $message
+	 * @throws InvalidDataTypeException
+	 */
+	private function setMessage($message)
+	{
+		if (! is_string($message)) {
+			throw new InvalidDataTypeException('$message', $message, 'string');
+		}
+		global $allowedtags;
+		$allowedtags['br'] = array();
+		$this->message = wp_kses($message, $allowedtags);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function getForceUpdate()
+	{
+		return $this->force_update;
+	}
+
+
+	/**
+	 * @param bool $force_update
+	 */
+	private function setForceUpdate($force_update)
+	{
+		$this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getCapability()
+	{
+		return $this->capability;
+	}
+
+
+	/**
+	 * @param string $capability
+	 * @throws InvalidDataTypeException
+	 */
+	private function setCapability($capability)
+	{
+		if (! is_string($capability)) {
+			throw new InvalidDataTypeException('$capability', $capability, 'string');
+		}
+		$this->capability = ! empty($capability) ? $capability : 'manage_options';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getCapContext()
+	{
+		return $this->cap_context;
+	}
+
+
+	/**
+	 * @param string $cap_context
+	 * @throws InvalidDataTypeException
+	 */
+	private function setCapContext($cap_context)
+	{
+		if (! is_string($cap_context)) {
+			throw new InvalidDataTypeException('$cap_context', $cap_context, 'string');
+		}
+		$this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice';
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function getDismissed()
+	{
+		return $this->dismissed;
+	}
+
+
+	/**
+	 * @param bool $dismissed
+	 */
+	public function setDismissed($dismissed)
+	{
+		$this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return CapCheckInterface
+	 * @throws InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		if (! $this->cap_check instanceof CapCheckInterface) {
+			$this->setCapCheck(
+				new CapCheck(
+					$this->capability,
+					$this->cap_context
+				)
+			);
+		}
+		return $this->cap_check;
+	}
+
+
+	/**
+	 * @param CapCheckInterface $cap_check
+	 */
+	private function setCapCheck(CapCheckInterface $cap_check)
+	{
+		$this->cap_check = $cap_check;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function getPurge()
+	{
+		return $this->purge;
+	}
+
+
+	/**
+	 * @param bool $purge
+	 */
+	public function setPurge($purge)
+	{
+		$this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * given a valid PersistentAdminNotice Collection,
+	 * this notice will be added if it is not already found in the collection (using its name as the identifier)
+	 * if an existing notice is found that has already been dismissed,
+	 * but we are overriding with a forced update, then we will toggle its dismissed state,
+	 * so that the notice is displayed again
+	 *
+	 * @param Collection $persistent_admin_notice_collection
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 */
+	public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection)
+	{
+		if ($this->registered) {
+			return;
+		}
+		// first check if this notice has already been added to the collection
+		if ($persistent_admin_notice_collection->has($this->name)) {
+			/** @var PersistentAdminNotice $existing */
+			$existing = $persistent_admin_notice_collection->get($this->name);
+			// we don't need to add it again (we can't actually)
+			// but if it has already been dismissed, and we are overriding with a forced update
+			if ($existing->getDismissed() && $this->getForceUpdate()) {
+				// then toggle the notice's dismissed state to true
+				// so that it gets displayed again
+				$existing->setDismissed(false);
+				// and make sure the message is set
+				$existing->setMessage($this->message);
+			}
+		} else {
+			$persistent_admin_notice_collection->add($this, $this->name);
+		}
+		$this->registered = true;
+	}
+
+
+	/**
+	 * @throws Exception
+	 */
+	public function confirmRegistered()
+	{
+		if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) {
+			PersistentAdminNoticeManager::loadRegisterAndSaveNotices();
+		}
+		if (! $this->registered && WP_DEBUG) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.',
+						'event_espresso'
+					),
+					$this->name
+				)
+			);
+		}
+	}
 }