eventespresso / event-espresso-core

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/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

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 {

Indentation +152 added lines, -152 removed lines

@@ -18,156 +18,156 @@
 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
-
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    /**
-     * 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 = '';
-    // phpcs:enable
-
-
-    /**
-     * @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
+
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	/**
+	 * 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 = '';
+	// phpcs:enable
+
+
+	/**
+	 * @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);
+		}
+	}
 }

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
+				)
+			);
+		}
+	}
 }

core/domain/entities/contexts/RequestTypeContext.php

Indentation +133 added lines, -133 removed lines

@@ -16,137 +16,137 @@
 class RequestTypeContext extends Context
 {
 
-    /**
-     * indicates that the current request involves some form of activation
-     */
-    const ACTIVATION = 'activation-request';
-
-    /**
-     * indicates that the current request is for the admin but is not being made via AJAX
-     */
-    const ADMIN = 'non-ajax-admin-request';
-
-    /**
-     * indicates that the current request is for the admin AND is being made via AJAX
-     */
-    const AJAX_ADMIN = 'admin-ajax-request';
-
-    /**
-     * indicates that the current request is for the frontend AND is being made via AJAX
-     */
-    const AJAX_FRONT = 'frontend-ajax-request';
-
-    /**
-     * indicates that the current request is being made via AJAX, but is NOT for EE
-     */
-    const AJAX_OTHER = 'other-ajax-request';
-
-    /**
-     * indicates that the current request is for the EE REST API
-     */
-    const API = 'rest-api';
-
-    /**
-     * indicates that the current request is from the command line
-     */
-    const CLI = 'command-line';
-
-    /**
-     * indicates that the current request is for a WP_Cron
-     */
-    const CRON = 'wp-cron';
-
-    /**
-     * indicates that the current request is for a feed (ie: RSS)
-     */
-    const FEED = 'feed-request';
-
-    /**
-     * indicates that the current request is for the frontend but is not being made via AJAX
-     */
-    const FRONTEND = 'non-ajax-frontend-request';
-
-    /**
-     * indicates that the current request is for content that is to be displayed within an iframe
-     */
-    const IFRAME = 'iframe-request';
-
-    /**
-     * @var boolean $is_activation
-     */
-    private $is_activation = false;
-
-    /**
-     * @var array $valid_request_types
-     */
-    private $valid_request_types = array();
-
-
-    /**
-     * RequestTypeContext constructor.
-     *
-     * @param string $slug
-     * @param string $description
-     * @throws InvalidArgumentException
-     */
-    public function __construct($slug, $description)
-    {
-        parent::__construct($slug, $description);
-        if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    var_export($this->validRequestTypes(), true)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function validRequestTypes()
-    {
-        if (empty($this->valid_request_types)) {
-            $this->valid_request_types = apply_filters(
-                'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
-                array(
-                    RequestTypeContext::ACTIVATION,
-                    RequestTypeContext::ADMIN,
-                    RequestTypeContext::AJAX_ADMIN,
-                    RequestTypeContext::AJAX_FRONT,
-                    RequestTypeContext::AJAX_OTHER,
-                    RequestTypeContext::API,
-                    RequestTypeContext::CLI,
-                    RequestTypeContext::CRON,
-                    RequestTypeContext::FEED,
-                    RequestTypeContext::FRONTEND,
-                    RequestTypeContext::IFRAME,
-                )
-            );
-        }
-        return $this->valid_request_types;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->is_activation;
-    }
-
-
-    /**
-     * @param bool $is_activation
-     */
-    public function setIsActivation($is_activation)
-    {
-        $this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * indicates that the current request involves some form of activation
+	 */
+	const ACTIVATION = 'activation-request';
+
+	/**
+	 * indicates that the current request is for the admin but is not being made via AJAX
+	 */
+	const ADMIN = 'non-ajax-admin-request';
+
+	/**
+	 * indicates that the current request is for the admin AND is being made via AJAX
+	 */
+	const AJAX_ADMIN = 'admin-ajax-request';
+
+	/**
+	 * indicates that the current request is for the frontend AND is being made via AJAX
+	 */
+	const AJAX_FRONT = 'frontend-ajax-request';
+
+	/**
+	 * indicates that the current request is being made via AJAX, but is NOT for EE
+	 */
+	const AJAX_OTHER = 'other-ajax-request';
+
+	/**
+	 * indicates that the current request is for the EE REST API
+	 */
+	const API = 'rest-api';
+
+	/**
+	 * indicates that the current request is from the command line
+	 */
+	const CLI = 'command-line';
+
+	/**
+	 * indicates that the current request is for a WP_Cron
+	 */
+	const CRON = 'wp-cron';
+
+	/**
+	 * indicates that the current request is for a feed (ie: RSS)
+	 */
+	const FEED = 'feed-request';
+
+	/**
+	 * indicates that the current request is for the frontend but is not being made via AJAX
+	 */
+	const FRONTEND = 'non-ajax-frontend-request';
+
+	/**
+	 * indicates that the current request is for content that is to be displayed within an iframe
+	 */
+	const IFRAME = 'iframe-request';
+
+	/**
+	 * @var boolean $is_activation
+	 */
+	private $is_activation = false;
+
+	/**
+	 * @var array $valid_request_types
+	 */
+	private $valid_request_types = array();
+
+
+	/**
+	 * RequestTypeContext constructor.
+	 *
+	 * @param string $slug
+	 * @param string $description
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($slug, $description)
+	{
+		parent::__construct($slug, $description);
+		if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
+						'event_espresso'
+					),
+					var_export($this->validRequestTypes(), true)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function validRequestTypes()
+	{
+		if (empty($this->valid_request_types)) {
+			$this->valid_request_types = apply_filters(
+				'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
+				array(
+					RequestTypeContext::ACTIVATION,
+					RequestTypeContext::ADMIN,
+					RequestTypeContext::AJAX_ADMIN,
+					RequestTypeContext::AJAX_FRONT,
+					RequestTypeContext::AJAX_OTHER,
+					RequestTypeContext::API,
+					RequestTypeContext::CLI,
+					RequestTypeContext::CRON,
+					RequestTypeContext::FEED,
+					RequestTypeContext::FRONTEND,
+					RequestTypeContext::IFRAME,
+				)
+			);
+		}
+		return $this->valid_request_types;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->is_activation;
+	}
+
+
+	/**
+	 * @param bool $is_activation
+	 */
+	public function setIsActivation($is_activation)
+	{
+		$this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/domain/entities/contexts/Context.php

Indentation +47 added lines, -47 removed lines

@@ -14,62 +14,62 @@
 class Context implements ContextInterface
 {
 
-    /**
-     * @var string $slug
-     */
-    private $slug;
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
 
-    /**
-     * @var string $description
-     */
-    private $description;
+	/**
+	 * @var string $description
+	 */
+	private $description;
 
 
-    /**
-     * Context constructor.
-     *
-     * @param string $slug
-     * @param string $description
-     */
-    public function __construct($slug, $description)
-    {
-        $this->setSlug($slug);
-        $this->setDescription($description);
-    }
+	/**
+	 * Context constructor.
+	 *
+	 * @param string $slug
+	 * @param string $description
+	 */
+	public function __construct($slug, $description)
+	{
+		$this->setSlug($slug);
+		$this->setDescription($description);
+	}
 
 
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->slug;
-    }
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->slug;
+	}
 
 
-    /**
-     * @param string $slug
-     */
-    private function setSlug($slug)
-    {
-        $this->slug = sanitize_key($slug);
-    }
+	/**
+	 * @param string $slug
+	 */
+	private function setSlug($slug)
+	{
+		$this->slug = sanitize_key($slug);
+	}
 
 
-    /**
-     * @return string
-     */
-    public function description()
-    {
-        return $this->description;
-    }
+	/**
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->description;
+	}
 
 
-    /**
-     * @param string $description
-     */
-    private function setDescription($description)
-    {
-        $this->description = sanitize_text_field($description);
-    }
+	/**
+	 * @param string $description
+	 */
+	private function setDescription($description)
+	{
+		$this->description = sanitize_text_field($description);
+	}
 }

core/domain/entities/custom_post_types/CustomTaxonomyTerm.php

Indentation +46 added lines, -46 removed lines

@@ -13,60 +13,60 @@
 class CustomTaxonomyTerm
 {
 
-    /**
-     * @var string $taxonomy_slug
-     */
-    public $taxonomy_slug;
+	/**
+	 * @var string $taxonomy_slug
+	 */
+	public $taxonomy_slug;
 
-    /**
-     * @var string $term_slug
-     */
-    public $term_slug;
+	/**
+	 * @var string $term_slug
+	 */
+	public $term_slug;
 
-    /**
-     * @var array $custom_post_type_slugs
-     */
-    public $custom_post_type_slugs;
+	/**
+	 * @var array $custom_post_type_slugs
+	 */
+	public $custom_post_type_slugs;
 
 
-    /**
-     * CustomTaxonomyTerm constructor.
-     *
-     * @param string $taxonomy_slug
-     * @param string $term_slug
-     * @param array  $custom_post_type_slugs
-     */
-    public function __construct($taxonomy_slug, $term_slug, array $custom_post_type_slugs = array())
-    {
-        $this->taxonomy_slug = $taxonomy_slug;
-        $this->term_slug = $term_slug;
-        $this->custom_post_type_slugs = $custom_post_type_slugs;
-    }
+	/**
+	 * CustomTaxonomyTerm constructor.
+	 *
+	 * @param string $taxonomy_slug
+	 * @param string $term_slug
+	 * @param array  $custom_post_type_slugs
+	 */
+	public function __construct($taxonomy_slug, $term_slug, array $custom_post_type_slugs = array())
+	{
+		$this->taxonomy_slug = $taxonomy_slug;
+		$this->term_slug = $term_slug;
+		$this->custom_post_type_slugs = $custom_post_type_slugs;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function taxonomySlug()
-    {
-        return $this->taxonomy_slug;
-    }
+	/**
+	 * @return string
+	 */
+	public function taxonomySlug()
+	{
+		return $this->taxonomy_slug;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function termSlug()
-    {
-        return $this->term_slug;
-    }
+	/**
+	 * @return string
+	 */
+	public function termSlug()
+	{
+		return $this->term_slug;
+	}
 
 
-    /**
-     * @return array
-     */
-    public function customPostTypeSlugs()
-    {
-        return $this->custom_post_type_slugs;
-    }
+	/**
+	 * @return array
+	 */
+	public function customPostTypeSlugs()
+	{
+		return $this->custom_post_type_slugs;
+	}
 }