eventespresso / event-espresso-core

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 +184 added lines, -184 removed lines

@@ -18,188 +18,188 @@
 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()
-    {
-        $date = self::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'))
-            );
-        }
-    }
-
-
-    /**
-     * Normalizes incoming date string so that it is a bit more stable for use.
-     * @param string $date_string
-     * @return string
-     */
-    public static function normalizeInvalidDate($date_string)
-    {
-        return str_replace(
-            array('-0001-11-29', '-0001-11-30', '0000-00-00'),
-            '0000-01-03',
-            $date_string
-        );
-    }
-
-
-    /**
-     * 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'))
-        );
-    }
-
-
-    /**
-     * Parse a string into a new DateTime object according to the specified format
-     *
-     * @param string       $format   Format accepted by date().
-     * @param string       $time     String representing the time.
-     * @param DateTimeZone $timezone A DateTimeZone object representing the desired time zone.
-     * @return DbSafeDateTime|boolean
-     * @link https://php.net/manual/en/datetime.createfromformat.php
-     */
-    public static function createFromFormat($format, $time, $timezone = null)
-    {
-        $time = self::normalizeInvalidDate($time);
-        // Various php versions handle the third argument differently.  This conditional accounts for that.
-        $DateTime = $timezone === null
-            ? parent::createFromFormat($format, $time)
-            : parent::createFromFormat($format, $time, $timezone);
-        return $DateTime instanceof DateTime
-            ? self::createFromDateTime($DateTime)
-            : $DateTime;
-    }
-
-
-    /**
-     * @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()
+	{
+		$date = self::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'))
+			);
+		}
+	}
+
+
+	/**
+	 * Normalizes incoming date string so that it is a bit more stable for use.
+	 * @param string $date_string
+	 * @return string
+	 */
+	public static function normalizeInvalidDate($date_string)
+	{
+		return str_replace(
+			array('-0001-11-29', '-0001-11-30', '0000-00-00'),
+			'0000-01-03',
+			$date_string
+		);
+	}
+
+
+	/**
+	 * 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'))
+		);
+	}
+
+
+	/**
+	 * Parse a string into a new DateTime object according to the specified format
+	 *
+	 * @param string       $format   Format accepted by date().
+	 * @param string       $time     String representing the time.
+	 * @param DateTimeZone $timezone A DateTimeZone object representing the desired time zone.
+	 * @return DbSafeDateTime|boolean
+	 * @link https://php.net/manual/en/datetime.createfromformat.php
+	 */
+	public static function createFromFormat($format, $time, $timezone = null)
+	{
+		$time = self::normalizeInvalidDate($time);
+		// Various php versions handle the third argument differently.  This conditional accounts for that.
+		$DateTime = $timezone === null
+			? parent::createFromFormat($format, $time)
+			: parent::createFromFormat($format, $time, $timezone);
+		return $DateTime instanceof DateTime
+			? self::createFromDateTime($DateTime)
+			: $DateTime;
+	}
+
+
+	/**
+	 * @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/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;
+	}
 }

core/domain/entities/RegCode.php

Indentation +43 added lines, -43 removed lines

@@ -14,49 +14,49 @@
 {
 
 
-    /*
+	/*
      * @var string $reg_code
      */
-    private $reg_code;
-
-
-    /**
-     * RegCode constructor.
-     *
-     * @param RegUrlLink      $reg_url_link
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     */
-    public function __construct(
-        RegUrlLink $reg_url_link,
-        \EE_Transaction $transaction,
-        \EE_Ticket $ticket
-    ) {
-        // figure out where to start parsing the reg code
-        $chars = strpos($reg_url_link, '-') + 5;
-        // TXN_ID + TKT_ID + first 3 and last 3 chars of reg_url_link
-        $this->reg_code = array(
-            $transaction->ID(),
-            $ticket->ID(),
-            substr($reg_url_link, 0, $chars),
-        );
-        // now put it all together
-        $this->reg_code = apply_filters(
-            'FHEE__Create__regCode__new_reg_code',
-            implode('-', $this->reg_code),
-            $transaction,
-            $ticket
-        );
-    }
-
-
-    /**
-     * Return the object as a string
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->reg_code;
-    }
+	private $reg_code;
+
+
+	/**
+	 * RegCode constructor.
+	 *
+	 * @param RegUrlLink      $reg_url_link
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 */
+	public function __construct(
+		RegUrlLink $reg_url_link,
+		\EE_Transaction $transaction,
+		\EE_Ticket $ticket
+	) {
+		// figure out where to start parsing the reg code
+		$chars = strpos($reg_url_link, '-') + 5;
+		// TXN_ID + TKT_ID + first 3 and last 3 chars of reg_url_link
+		$this->reg_code = array(
+			$transaction->ID(),
+			$ticket->ID(),
+			substr($reg_url_link, 0, $chars),
+		);
+		// now put it all together
+		$this->reg_code = apply_filters(
+			'FHEE__Create__regCode__new_reg_code',
+			implode('-', $this->reg_code),
+			$transaction,
+			$ticket
+		);
+	}
+
+
+	/**
+	 * Return the object as a string
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->reg_code;
+	}
 }

core/domain/entities/shortcodes/EspressoThankYou.php

Indentation +60 added lines, -60 removed lines

@@ -16,71 +16,71 @@
 class EspressoThankYou extends EspressoShortcode
 {
 
-    /**
-     * @var boolean $is_thank_you_page
-     */
-    private $is_thank_you_page = false;
+	/**
+	 * @var boolean $is_thank_you_page
+	 */
+	private $is_thank_you_page = false;
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_THANK_YOU';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_THANK_YOU';
+	}
 
 
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
 
 
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function initializeShortcode()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts) || count($wp_query->posts) > 1) {
-            return;
-        }
-        $post = reset($wp_query->posts);
-        if (! $post instanceof WP_Post || $post->ID !== EE_Registry::instance()->CFG->core->thank_you_page_id) {
-            return;
-        }
-        $this->is_thank_you_page = true;
-        \EED_Thank_You_Page::instance()->load_resources();
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function initializeShortcode()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts) || count($wp_query->posts) > 1) {
+			return;
+		}
+		$post = reset($wp_query->posts);
+		if (! $post instanceof WP_Post || $post->ID !== EE_Registry::instance()->CFG->core->thank_you_page_id) {
+			return;
+		}
+		$this->is_thank_you_page = true;
+		\EED_Thank_You_Page::instance()->load_resources();
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     * @throws \EE_Error
-     */
-    public function processShortcode($attributes = array())
-    {
-        return $this->is_thank_you_page
-            ? \EED_Thank_You_Page::instance()->thank_you_page_results()
-            : '';
-    }
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function processShortcode($attributes = array())
+	{
+		return $this->is_thank_you_page
+			? \EED_Thank_You_Page::instance()->thank_you_page_results()
+			: '';
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
             return;
         }
         $post = reset($wp_query->posts);
-        if (! $post instanceof WP_Post || $post->ID !== EE_Registry::instance()->CFG->core->thank_you_page_id) {
+        if ( ! $post instanceof WP_Post || $post->ID !== EE_Registry::instance()->CFG->core->thank_you_page_id) {
             return;
         }
         $this->is_thank_you_page = true;

core/domain/entities/shortcodes/EspressoCheckout.php

Indentation +45 added lines, -45 removed lines

@@ -18,55 +18,55 @@
 {
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_CHECKOUT';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_CHECKOUT';
+	}
 
 
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
 
 
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function initializeShortcode()
-    {
-        global $wp_query;
-        EED_Single_Page_Checkout::init($wp_query);
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function initializeShortcode()
+	{
+		global $wp_query;
+		EED_Single_Page_Checkout::init($wp_query);
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array())
-    {
-        return EE_Registry::instance()->REQ->get_output();
-    }
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array())
+	{
+		return EE_Registry::instance()->REQ->get_output();
+	}
 }

core/domain/entities/shortcodes/EspressoTxnPage.php

Indentation +77 added lines, -77 removed lines

@@ -22,87 +22,87 @@
 {
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_TXN_PAGE';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_TXN_PAGE';
+	}
 
 
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
 
 
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     * @throws \Exception
-     * @throws \EE_Error
-     */
-    public function initializeShortcode()
-    {
-        $transaction = null;
-        if (EE_Registry::instance()->REQ->is_set('e_reg_url_link')) {
-            /** @var EEM_Transaction $EEM_Transaction */
-            $EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
-            $transaction = $EEM_Transaction->get_transaction_from_reg_url_link();
-        }
-        if ($transaction instanceof EE_Transaction) {
-            $payment_method = null;
-            $payment_method_slug = EE_Registry::instance()->REQ->get('ee_payment_method', null);
-            if ($payment_method_slug) {
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($payment_method_slug);
-            }
-            if ($payment_method instanceof EE_Payment_Method && $payment_method->is_off_site()) {
-                $gateway = $payment_method->type_obj()->get_gateway();
-                if ($gateway instanceof EE_Offsite_Gateway
-                    && $gateway->handle_IPN_in_this_request(
-                        \EE_Registry::instance()->REQ->params(),
-                        true
-                    )
-                ) {
-                    /** @type EE_Payment_Processor $payment_processor */
-                    $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                    $payment_processor->process_ipn($_REQUEST, $transaction, $payment_method);
-                }
-            }
-            // allow gateways to add a filter to stop rendering the page
-            if (apply_filters('FHEE__EES_Espresso_Txn_Page__run__exit', false)) {
-                exit;
-            }
-        }
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 * @throws \Exception
+	 * @throws \EE_Error
+	 */
+	public function initializeShortcode()
+	{
+		$transaction = null;
+		if (EE_Registry::instance()->REQ->is_set('e_reg_url_link')) {
+			/** @var EEM_Transaction $EEM_Transaction */
+			$EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
+			$transaction = $EEM_Transaction->get_transaction_from_reg_url_link();
+		}
+		if ($transaction instanceof EE_Transaction) {
+			$payment_method = null;
+			$payment_method_slug = EE_Registry::instance()->REQ->get('ee_payment_method', null);
+			if ($payment_method_slug) {
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($payment_method_slug);
+			}
+			if ($payment_method instanceof EE_Payment_Method && $payment_method->is_off_site()) {
+				$gateway = $payment_method->type_obj()->get_gateway();
+				if ($gateway instanceof EE_Offsite_Gateway
+					&& $gateway->handle_IPN_in_this_request(
+						\EE_Registry::instance()->REQ->params(),
+						true
+					)
+				) {
+					/** @type EE_Payment_Processor $payment_processor */
+					$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+					$payment_processor->process_ipn($_REQUEST, $transaction, $payment_method);
+				}
+			}
+			// allow gateways to add a filter to stop rendering the page
+			if (apply_filters('FHEE__EES_Espresso_Txn_Page__run__exit', false)) {
+				exit;
+			}
+		}
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array())
-    {
-        return esc_html__(
-            'This is the Event Espresso Transactions page. This page receives instant payment notification (IPN) requests and should have a status of published, but should not be easily accessible by site visitors. Do not add it to your website\'s navigation menu or link to it from another page. Also, do not delete it or change its status to private.',
-            'event_espresso'
-        );
-    }
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array())
+	{
+		return esc_html__(
+			'This is the Event Espresso Transactions page. This page receives instant payment notification (IPN) requests and should have a status of published, but should not be easily accessible by site visitors. Do not add it to your website\'s navigation menu or link to it from another page. Also, do not delete it or change its status to private.',
+			'event_espresso'
+		);
+	}
 }