eventespresso / event-espresso-core

core/services/json/JsonDataWordpressOption.php

Indentation +90 added lines, -90 removed lines

@@ -15,94 +15,94 @@
  */
 abstract class JsonDataWordpressOption extends WordPressOption
 {
-    private JsonDataHandler $json_data_handler;
-
-    /**
-     * @var array|mixed|stdClass
-     */
-    private $options = [];
-
-
-    /**
-     * JsonDataWordpressOption constructor.
-     *
-     * @param JsonDataHandler $json_data_handler
-     * @param string          $option_name
-     * @param                 $default_value
-     * @param bool            $autoload
-     */
-    public function __construct(
-        JsonDataHandler $json_data_handler,
-        string $option_name,
-        $default_value,
-        bool $autoload = false
-    ) {
-        $this->json_data_handler = $json_data_handler;
-        if (! $this->json_data_handler->dataType()) {
-            $this->json_data_handler->configure(JsonDataHandler::DATA_TYPE_OBJECT);
-        }
-        parent::__construct($option_name, $default_value, $autoload);
-    }
-
-
-    /**
-     * @param $value
-     * @return int
-     */
-    public function updateOption($value): int
-    {
-        $update = parent::updateOption($this->json_data_handler->encodeData($value));
-        if ($update === WordPressOption::UPDATE_SUCCESS) {
-            $this->options = $value;
-        }
-        return $update;
-    }
-
-
-    /**
-     * @param string $property
-     * @param mixed  $value
-     * @return void
-     */
-    public function addProperty(string $property, $value)
-    {
-        $options              = $this->getAll();
-        $options->{$property} = $value;
-        $this->updateOption($options);
-    }
-
-
-    /**
-     * @param string $property
-     * @return mixed
-     */
-    public function getProperty(string $property)
-    {
-        $options = $this->getAll();
-        return property_exists($options, $property) ? $options->{$property} : null;
-    }
-
-
-    /**
-     * @return array|mixed|stdClass
-     */
-    public function getAll()
-    {
-        if (empty($this->options)) {
-            $this->options = $this->json_data_handler->decodeJson($this->loadOption());
-        }
-        return $this->options;
-    }
-
-
-    /**
-     * @param string $property
-     * @return void
-     */
-    public function removeProperty(string $property)
-    {
-        $options = $this->getAll();
-        unset($options->{$property});
-        $this->updateOption($options);
-    }
+	private JsonDataHandler $json_data_handler;
+
+	/**
+	 * @var array|mixed|stdClass
+	 */
+	private $options = [];
+
+
+	/**
+	 * JsonDataWordpressOption constructor.
+	 *
+	 * @param JsonDataHandler $json_data_handler
+	 * @param string          $option_name
+	 * @param                 $default_value
+	 * @param bool            $autoload
+	 */
+	public function __construct(
+		JsonDataHandler $json_data_handler,
+		string $option_name,
+		$default_value,
+		bool $autoload = false
+	) {
+		$this->json_data_handler = $json_data_handler;
+		if (! $this->json_data_handler->dataType()) {
+			$this->json_data_handler->configure(JsonDataHandler::DATA_TYPE_OBJECT);
+		}
+		parent::__construct($option_name, $default_value, $autoload);
+	}
+
+
+	/**
+	 * @param $value
+	 * @return int
+	 */
+	public function updateOption($value): int
+	{
+		$update = parent::updateOption($this->json_data_handler->encodeData($value));
+		if ($update === WordPressOption::UPDATE_SUCCESS) {
+			$this->options = $value;
+		}
+		return $update;
+	}
+
+
+	/**
+	 * @param string $property
+	 * @param mixed  $value
+	 * @return void
+	 */
+	public function addProperty(string $property, $value)
+	{
+		$options              = $this->getAll();
+		$options->{$property} = $value;
+		$this->updateOption($options);
+	}
+
+
+	/**
+	 * @param string $property
+	 * @return mixed
+	 */
+	public function getProperty(string $property)
+	{
+		$options = $this->getAll();
+		return property_exists($options, $property) ? $options->{$property} : null;
+	}
+
+
+	/**
+	 * @return array|mixed|stdClass
+	 */
+	public function getAll()
+	{
+		if (empty($this->options)) {
+			$this->options = $this->json_data_handler->decodeJson($this->loadOption());
+		}
+		return $this->options;
+	}
+
+
+	/**
+	 * @param string $property
+	 * @return void
+	 */
+	public function removeProperty(string $property)
+	{
+		$options = $this->getAll();
+		unset($options->{$property});
+		$this->updateOption($options);
+	}
 }

core/services/json/JsonDataHandler.php

Indentation +327 added lines, -327 removed lines

@@ -14,331 +14,331 @@
  */
 class JsonDataHandler
 {
-    const DATA_TYPE_ARRAY     = 'array';
-
-    const DATA_TYPE_OBJECT    = 'object';
-
-    const DATA_TYPE_USE_FLAGS = 'flags';
-
-    const NO_ERROR_MSG        = 'No error';
-
-    private string $data_type = JsonDataHandler::DATA_TYPE_USE_FLAGS;
-
-    /**
-     * @var array|stdClass|null
-     */
-    private $decoded_data = null;
-
-    /**
-     * JSON_BIGINT_AS_STRING,
-     * JSON_INVALID_UTF8_IGNORE,
-     * JSON_INVALID_UTF8_SUBSTITUTE,
-     * JSON_OBJECT_AS_ARRAY,
-     * JSON_THROW_ON_ERROR
-     *
-     * @var int
-     */
-    private int $decode_flags = 0;
-
-    private int $depth = 512;
-
-    private string $encoded_data = '';
-
-    /**
-     * JSON_FORCE_OBJECT,
-     * JSON_HEX_QUOT,
-     * JSON_HEX_TAG,
-     * JSON_HEX_AMP,
-     * JSON_HEX_APOS,
-     * JSON_INVALID_UTF8_IGNORE,
-     * JSON_INVALID_UTF8_SUBSTITUTE,
-     * JSON_NUMERIC_CHECK,
-     * JSON_PARTIAL_OUTPUT_ON_ERROR,
-     * JSON_PRESERVE_ZERO_FRACTION,
-     * JSON_PRETTY_PRINT,
-     * JSON_UNESCAPED_LINE_TERMINATORS,
-     * JSON_UNESCAPED_SLASHES,
-     * JSON_UNESCAPED_UNICODE,
-     * JSON_THROW_ON_ERROR.
-     *
-     * @var int
-     */
-    private int $encode_flags = 0;
-
-    private int $last_error_code = JSON_ERROR_NONE;
-
-    private string $last_error_msg = JsonDataHandler::NO_ERROR_MSG;
-
-
-    /**
-     * JsonDataHandler constructor.
-     */
-    public function __construct()
-    {
-        if (! defined('JSON_INVALID_UTF8_IGNORE')) {
-            define('JSON_INVALID_UTF8_IGNORE', 1048576);
-        }
-        if (! defined('JSON_INVALID_UTF8_SUBSTITUTE')) {
-            define('JSON_INVALID_UTF8_SUBSTITUTE', 2097152);
-        }
-        if (! defined('JSON_THROW_ON_ERROR')) {
-            define('JSON_THROW_ON_ERROR', 4194304);
-        }
-    }
-
-
-    /**
-     * set $data_type, $decode_flags, $encode_flags, and depth all in one shot
-     *
-     * @param string $data_type
-     * @param int    $decode_flags
-     * @param int    $encode_flags
-     * @param int    $depth
-     */
-    public function configure(
-        string $data_type = JsonDataHandler::DATA_TYPE_USE_FLAGS,
-        int $decode_flags = 0,
-        int $encode_flags = 0,
-        int $depth = 512
-    ) {
-        $this->setDataType($data_type);
-        $this->setDecodeFlags($decode_flags);
-        $this->setDepth($depth);
-        $this->setEncodeFlags($encode_flags);
-    }
-
-
-    /**
-     * @param string $data_type
-     */
-    public function setDataType(string $data_type): void
-    {
-        $this->data_type = $data_type === JsonDataHandler::DATA_TYPE_ARRAY
-                           || $data_type === JsonDataHandler::DATA_TYPE_OBJECT
-                           || $data_type === JsonDataHandler::DATA_TYPE_USE_FLAGS
-            ? $data_type
-            : JsonDataHandler::DATA_TYPE_USE_FLAGS;
-    }
-
-
-    /**
-     * One or more Bitmask values:
-     * JSON_BIGINT_AS_STRING,
-     * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
-     * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
-     * JSON_OBJECT_AS_ARRAY,
-     * JSON_THROW_ON_ERROR              PHP >= 7.3
-     *
-     * pass multiple values separated with |
-     * ex: JSON_BIGINT_AS_STRING | JSON_INVALID_UTF8_IGNORE | JSON_OBJECT_AS_ARRAY
-     *
-     * @param int $decode_flags
-     */
-    public function setDecodeFlags(int $decode_flags): void
-    {
-        $this->decode_flags = $decode_flags === JSON_BIGINT_AS_STRING
-                              || $decode_flags === JSON_OBJECT_AS_ARRAY
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
-                              || $decode_flags === JSON_INVALID_UTF8_IGNORE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
-                              || $decode_flags === JSON_INVALID_UTF8_SUBSTITUTE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
-                              || $decode_flags === JSON_THROW_ON_ERROR
-            ? $decode_flags
-            : 0;
-    }
-
-
-    /**
-     * @param int $depth
-     */
-    public function setDepth(int $depth): void
-    {
-        $depth       = absint($depth);
-        $this->depth = $depth ?: 512;
-    }
-
-
-    /**
-     * One or more Bitmask values:
-     * JSON_FORCE_OBJECT,
-     * JSON_HEX_QUOT,
-     * JSON_HEX_TAG,
-     * JSON_HEX_AMP,
-     * JSON_HEX_APOS,
-     * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
-     * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
-     * JSON_NUMERIC_CHECK,
-     * JSON_PARTIAL_OUTPUT_ON_ERROR,
-     * JSON_PRESERVE_ZERO_FRACTION,
-     * JSON_PRETTY_PRINT,
-     * JSON_UNESCAPED_LINE_TERMINATORS,
-     * JSON_UNESCAPED_SLASHES,
-     * JSON_UNESCAPED_UNICODE,
-     * JSON_THROW_ON_ERROR.             PHP >= 7.3
-     *
-     * pass multiple values separated with |
-     * ex: JSON_FORCE_OBJECT | JSON_INVALID_UTF8_IGNORE | JSON_THROW_ON_ERROR
-     *
-     * @param int $encode_flags
-     */
-    public function setEncodeFlags(int $encode_flags): void
-    {
-        $this->encode_flags = $encode_flags === JSON_FORCE_OBJECT
-                              || $encode_flags === JSON_HEX_QUOT
-                              || $encode_flags === JSON_HEX_TAG
-                              || $encode_flags === JSON_HEX_AMP
-                              || $encode_flags === JSON_HEX_APOS
-                              || $encode_flags === JSON_NUMERIC_CHECK
-                              || $encode_flags === JSON_PARTIAL_OUTPUT_ON_ERROR
-                              || $encode_flags === JSON_PRESERVE_ZERO_FRACTION
-                              || $encode_flags === JSON_PRETTY_PRINT
-                              || $encode_flags === JSON_UNESCAPED_LINE_TERMINATORS
-                              || $encode_flags === JSON_UNESCAPED_SLASHES
-                              || $encode_flags === JSON_UNESCAPED_UNICODE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
-                              || $encode_flags === JSON_INVALID_UTF8_IGNORE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
-                              || $encode_flags === JSON_INVALID_UTF8_SUBSTITUTE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
-                              || $encode_flags === JSON_THROW_ON_ERROR
-            ? $encode_flags
-            : 0;
-    }
-
-
-    /**
-     * @return string|null
-     */
-    public function dataType(): ?string
-    {
-        return $this->data_type;
-    }
-
-
-    /**
-     * @return bool|null
-     */
-    private function asAssociative(): ?bool
-    {
-        switch ($this->data_type) {
-            case JsonDataHandler::DATA_TYPE_ARRAY:
-                return true;
-            case JsonDataHandler::DATA_TYPE_OBJECT:
-                return false;
-            case JsonDataHandler::DATA_TYPE_USE_FLAGS:
-                return null;
-        }
-        return null;
-    }
-
-
-    /**
-     * @param array|string $json
-     * @return array|mixed|stdClass
-     */
-    public function decodeJson($json)
-    {
-        $this->resetErrors();
-        if ($this->isJson($json)) {
-            $this->decoded_data    = json_decode($json, $this->asAssociative(), $this->depth, $this->decode_flags);
-            $this->last_error_code = json_last_error();
-            $this->last_error_msg  = json_last_error_msg();
-        } else {
-            $this->decoded_data    = $json;
-            $this->last_error_code = JSON_ERROR_NONE;
-            $this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
-        }
-        return $this->decoded_data;
-    }
-
-
-    /**
-     * @param $data
-     * @return string
-     */
-    public function encodeData($data): string
-    {
-        $this->resetErrors();
-        if ($this->isJson($data)) {
-            $this->encoded_data    = $data;
-            $this->last_error_code = JSON_ERROR_NONE;
-            $this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
-        } else {
-            $this->encoded_data    = json_encode($data, $this->encode_flags, $this->depth);
-            $this->last_error_code = json_last_error();
-            $this->last_error_msg  = json_last_error_msg();
-        }
-        return $this->encoded_data ?: '{}';
-    }
-
-
-    /**
-     * @return array|stdClass
-     */
-    public function getDecodedData()
-    {
-        return $this->decoded_data;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getEncodedData(): string
-    {
-        return $this->encoded_data;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return int
-     */
-    public function getLastErrorCode(bool $reset = false): int
-    {
-        $last_error = $this->last_error_code;
-        if ($reset) {
-            $this->resetErrors();
-        }
-        return $last_error;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function getLastErrorMessage(bool $reset = false): string
-    {
-        $last_error = $this->last_error_msg;
-        if ($reset) {
-            $this->resetErrors();
-        }
-        return $last_error;
-    }
-
-
-    /**
-     * @param array|string $maybe_json
-     * @return bool
-     */
-    public function isJson($maybe_json): bool
-    {
-        if (! is_string($maybe_json)) {
-            return false;
-        }
-        $decoded = json_decode($maybe_json, $this->asAssociative(), $this->depth, $this->decode_flags);
-        return json_last_error() === JSON_ERROR_NONE && ! ($decoded === null && ! empty($maybe_json));
-    }
-
-
-    /**
-     * @since 5.0.0.p
-     */
-    public function resetErrors()
-    {
-        $this->last_error_code = JSON_ERROR_NONE;
-        $this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
-    }
+	const DATA_TYPE_ARRAY     = 'array';
+
+	const DATA_TYPE_OBJECT    = 'object';
+
+	const DATA_TYPE_USE_FLAGS = 'flags';
+
+	const NO_ERROR_MSG        = 'No error';
+
+	private string $data_type = JsonDataHandler::DATA_TYPE_USE_FLAGS;
+
+	/**
+	 * @var array|stdClass|null
+	 */
+	private $decoded_data = null;
+
+	/**
+	 * JSON_BIGINT_AS_STRING,
+	 * JSON_INVALID_UTF8_IGNORE,
+	 * JSON_INVALID_UTF8_SUBSTITUTE,
+	 * JSON_OBJECT_AS_ARRAY,
+	 * JSON_THROW_ON_ERROR
+	 *
+	 * @var int
+	 */
+	private int $decode_flags = 0;
+
+	private int $depth = 512;
+
+	private string $encoded_data = '';
+
+	/**
+	 * JSON_FORCE_OBJECT,
+	 * JSON_HEX_QUOT,
+	 * JSON_HEX_TAG,
+	 * JSON_HEX_AMP,
+	 * JSON_HEX_APOS,
+	 * JSON_INVALID_UTF8_IGNORE,
+	 * JSON_INVALID_UTF8_SUBSTITUTE,
+	 * JSON_NUMERIC_CHECK,
+	 * JSON_PARTIAL_OUTPUT_ON_ERROR,
+	 * JSON_PRESERVE_ZERO_FRACTION,
+	 * JSON_PRETTY_PRINT,
+	 * JSON_UNESCAPED_LINE_TERMINATORS,
+	 * JSON_UNESCAPED_SLASHES,
+	 * JSON_UNESCAPED_UNICODE,
+	 * JSON_THROW_ON_ERROR.
+	 *
+	 * @var int
+	 */
+	private int $encode_flags = 0;
+
+	private int $last_error_code = JSON_ERROR_NONE;
+
+	private string $last_error_msg = JsonDataHandler::NO_ERROR_MSG;
+
+
+	/**
+	 * JsonDataHandler constructor.
+	 */
+	public function __construct()
+	{
+		if (! defined('JSON_INVALID_UTF8_IGNORE')) {
+			define('JSON_INVALID_UTF8_IGNORE', 1048576);
+		}
+		if (! defined('JSON_INVALID_UTF8_SUBSTITUTE')) {
+			define('JSON_INVALID_UTF8_SUBSTITUTE', 2097152);
+		}
+		if (! defined('JSON_THROW_ON_ERROR')) {
+			define('JSON_THROW_ON_ERROR', 4194304);
+		}
+	}
+
+
+	/**
+	 * set $data_type, $decode_flags, $encode_flags, and depth all in one shot
+	 *
+	 * @param string $data_type
+	 * @param int    $decode_flags
+	 * @param int    $encode_flags
+	 * @param int    $depth
+	 */
+	public function configure(
+		string $data_type = JsonDataHandler::DATA_TYPE_USE_FLAGS,
+		int $decode_flags = 0,
+		int $encode_flags = 0,
+		int $depth = 512
+	) {
+		$this->setDataType($data_type);
+		$this->setDecodeFlags($decode_flags);
+		$this->setDepth($depth);
+		$this->setEncodeFlags($encode_flags);
+	}
+
+
+	/**
+	 * @param string $data_type
+	 */
+	public function setDataType(string $data_type): void
+	{
+		$this->data_type = $data_type === JsonDataHandler::DATA_TYPE_ARRAY
+						   || $data_type === JsonDataHandler::DATA_TYPE_OBJECT
+						   || $data_type === JsonDataHandler::DATA_TYPE_USE_FLAGS
+			? $data_type
+			: JsonDataHandler::DATA_TYPE_USE_FLAGS;
+	}
+
+
+	/**
+	 * One or more Bitmask values:
+	 * JSON_BIGINT_AS_STRING,
+	 * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
+	 * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
+	 * JSON_OBJECT_AS_ARRAY,
+	 * JSON_THROW_ON_ERROR              PHP >= 7.3
+	 *
+	 * pass multiple values separated with |
+	 * ex: JSON_BIGINT_AS_STRING | JSON_INVALID_UTF8_IGNORE | JSON_OBJECT_AS_ARRAY
+	 *
+	 * @param int $decode_flags
+	 */
+	public function setDecodeFlags(int $decode_flags): void
+	{
+		$this->decode_flags = $decode_flags === JSON_BIGINT_AS_STRING
+							  || $decode_flags === JSON_OBJECT_AS_ARRAY
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
+							  || $decode_flags === JSON_INVALID_UTF8_IGNORE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
+							  || $decode_flags === JSON_INVALID_UTF8_SUBSTITUTE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
+							  || $decode_flags === JSON_THROW_ON_ERROR
+			? $decode_flags
+			: 0;
+	}
+
+
+	/**
+	 * @param int $depth
+	 */
+	public function setDepth(int $depth): void
+	{
+		$depth       = absint($depth);
+		$this->depth = $depth ?: 512;
+	}
+
+
+	/**
+	 * One or more Bitmask values:
+	 * JSON_FORCE_OBJECT,
+	 * JSON_HEX_QUOT,
+	 * JSON_HEX_TAG,
+	 * JSON_HEX_AMP,
+	 * JSON_HEX_APOS,
+	 * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
+	 * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
+	 * JSON_NUMERIC_CHECK,
+	 * JSON_PARTIAL_OUTPUT_ON_ERROR,
+	 * JSON_PRESERVE_ZERO_FRACTION,
+	 * JSON_PRETTY_PRINT,
+	 * JSON_UNESCAPED_LINE_TERMINATORS,
+	 * JSON_UNESCAPED_SLASHES,
+	 * JSON_UNESCAPED_UNICODE,
+	 * JSON_THROW_ON_ERROR.             PHP >= 7.3
+	 *
+	 * pass multiple values separated with |
+	 * ex: JSON_FORCE_OBJECT | JSON_INVALID_UTF8_IGNORE | JSON_THROW_ON_ERROR
+	 *
+	 * @param int $encode_flags
+	 */
+	public function setEncodeFlags(int $encode_flags): void
+	{
+		$this->encode_flags = $encode_flags === JSON_FORCE_OBJECT
+							  || $encode_flags === JSON_HEX_QUOT
+							  || $encode_flags === JSON_HEX_TAG
+							  || $encode_flags === JSON_HEX_AMP
+							  || $encode_flags === JSON_HEX_APOS
+							  || $encode_flags === JSON_NUMERIC_CHECK
+							  || $encode_flags === JSON_PARTIAL_OUTPUT_ON_ERROR
+							  || $encode_flags === JSON_PRESERVE_ZERO_FRACTION
+							  || $encode_flags === JSON_PRETTY_PRINT
+							  || $encode_flags === JSON_UNESCAPED_LINE_TERMINATORS
+							  || $encode_flags === JSON_UNESCAPED_SLASHES
+							  || $encode_flags === JSON_UNESCAPED_UNICODE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
+							  || $encode_flags === JSON_INVALID_UTF8_IGNORE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
+							  || $encode_flags === JSON_INVALID_UTF8_SUBSTITUTE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
+							  || $encode_flags === JSON_THROW_ON_ERROR
+			? $encode_flags
+			: 0;
+	}
+
+
+	/**
+	 * @return string|null
+	 */
+	public function dataType(): ?string
+	{
+		return $this->data_type;
+	}
+
+
+	/**
+	 * @return bool|null
+	 */
+	private function asAssociative(): ?bool
+	{
+		switch ($this->data_type) {
+			case JsonDataHandler::DATA_TYPE_ARRAY:
+				return true;
+			case JsonDataHandler::DATA_TYPE_OBJECT:
+				return false;
+			case JsonDataHandler::DATA_TYPE_USE_FLAGS:
+				return null;
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param array|string $json
+	 * @return array|mixed|stdClass
+	 */
+	public function decodeJson($json)
+	{
+		$this->resetErrors();
+		if ($this->isJson($json)) {
+			$this->decoded_data    = json_decode($json, $this->asAssociative(), $this->depth, $this->decode_flags);
+			$this->last_error_code = json_last_error();
+			$this->last_error_msg  = json_last_error_msg();
+		} else {
+			$this->decoded_data    = $json;
+			$this->last_error_code = JSON_ERROR_NONE;
+			$this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
+		}
+		return $this->decoded_data;
+	}
+
+
+	/**
+	 * @param $data
+	 * @return string
+	 */
+	public function encodeData($data): string
+	{
+		$this->resetErrors();
+		if ($this->isJson($data)) {
+			$this->encoded_data    = $data;
+			$this->last_error_code = JSON_ERROR_NONE;
+			$this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
+		} else {
+			$this->encoded_data    = json_encode($data, $this->encode_flags, $this->depth);
+			$this->last_error_code = json_last_error();
+			$this->last_error_msg  = json_last_error_msg();
+		}
+		return $this->encoded_data ?: '{}';
+	}
+
+
+	/**
+	 * @return array|stdClass
+	 */
+	public function getDecodedData()
+	{
+		return $this->decoded_data;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getEncodedData(): string
+	{
+		return $this->encoded_data;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return int
+	 */
+	public function getLastErrorCode(bool $reset = false): int
+	{
+		$last_error = $this->last_error_code;
+		if ($reset) {
+			$this->resetErrors();
+		}
+		return $last_error;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function getLastErrorMessage(bool $reset = false): string
+	{
+		$last_error = $this->last_error_msg;
+		if ($reset) {
+			$this->resetErrors();
+		}
+		return $last_error;
+	}
+
+
+	/**
+	 * @param array|string $maybe_json
+	 * @return bool
+	 */
+	public function isJson($maybe_json): bool
+	{
+		if (! is_string($maybe_json)) {
+			return false;
+		}
+		$decoded = json_decode($maybe_json, $this->asAssociative(), $this->depth, $this->decode_flags);
+		return json_last_error() === JSON_ERROR_NONE && ! ($decoded === null && ! empty($maybe_json));
+	}
+
+
+	/**
+	 * @since 5.0.0.p
+	 */
+	public function resetErrors()
+	{
+		$this->last_error_code = JSON_ERROR_NONE;
+		$this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
+	}
 }

core/services/notifications/PersistentAdminNoticeManager.php

Indentation +371 added lines, -371 removed lines

@@ -29,375 +29,375 @@
  */
 class PersistentAdminNoticeManager
 {
-    const WP_OPTION_KEY = 'ee_pers_admin_notices';
-
-    private CapabilitiesChecker $capabilities_checker;
-
-    private RequestInterface $request;
-
-    /**
-     * @var Collection|PersistentAdminNotice[]|null $notice_collection
-     */
-    private ?Collection $notice_collection = null;
-
-    /**
-     * if AJAX is not enabled, then the return URL will be used for redirecting back to the admin page where the
-     * persistent admin notice was displayed, and ultimately dismissed from.
-     *
-     * @var string $return_url
-     */
-    private string $return_url;
-
-
-
-    /**
-     * PersistentAdminNoticeManager constructor
-     *
-     * @param CapabilitiesChecker $capabilities_checker
-     * @param RequestInterface    $request
-     * @param string              $return_url where to  redirect to after dismissing notices
-     */
-    public function __construct(
-        CapabilitiesChecker $capabilities_checker,
-        RequestInterface $request,
-        string $return_url = ''
-    ) {
-        $this->capabilities_checker = $capabilities_checker;
-        $this->request = $request;
-        $this->setReturnUrl($return_url);
-        // setup up notices at priority 9 because `EE_Admin::display_admin_notices()` runs at priority 10,
-        // and we want to retrieve and generate any nag notices at the last possible moment
-        add_action('admin_notices', array($this, 'displayNotices'), 9);
-        add_action('network_admin_notices', array($this, 'displayNotices'), 9);
-        add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismissNotice'));
-        add_action('shutdown', array($this, 'registerAndSaveNotices'), 998);
-    }
-
-
-    /**
-     * @param string $return_url
-     */
-    public function setReturnUrl(string $return_url)
-    {
-        $this->return_url = $return_url;
-    }
-
-
-    /**
-     * @return Collection
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function getPersistentAdminNoticeCollection(): Collection
-    {
-        if (! $this->notice_collection instanceof Collection) {
-            $this->notice_collection = new Collection(
-                'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
-            );
-            $this->retrieveStoredNotices();
-            $this->registerNotices();
-        }
-        return $this->notice_collection;
-    }
-
-
-    /**
-     * generates PersistentAdminNotice objects for all non-dismissed notices saved to the db
-     *
-     * @return void
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function retrieveStoredNotices()
-    {
-        $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-        if (! empty($persistent_admin_notices)) {
-            foreach ($persistent_admin_notices as $name => $details) {
-                if (is_array($details)) {
-                    if (
-                        ! isset(
-                            $details['message'],
-                            $details['capability'],
-                            $details['cap_context'],
-                            $details['dismissed']
-                        )
-                    ) {
-                        throw new DomainException(
-                            sprintf(
-                                esc_html__(
-                                    'The "%1$s" PersistentAdminNotice could not be retrieved from the database.',
-                                    'event_espresso'
-                                ),
-                                $name
-                            )
-                        );
-                    }
-                    // new format for nag notices
-                    $this->notice_collection->add(
-                        new PersistentAdminNotice(
-                            (string) $name,
-                            (string) $details['message'],
-                            false,
-                            (string) $details['capability'],
-                            (string) $details['cap_context'],
-                            (bool) $details['dismissed']
-                        ),
-                        sanitize_key($name)
-                    );
-                } else {
-                    try {
-                        // old nag notices, that we want to convert to the new format
-                        $this->notice_collection->add(
-                            new PersistentAdminNotice(
-                                (string) $name,
-                                (string) $details,
-                                false,
-                                '',
-                                '',
-                                empty($details)
-                            ),
-                            sanitize_key($name)
-                        );
-                    } catch (Exception $e) {
-                        EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                    }
-                }
-                // each notice will self register when the action hook in registerNotices is triggered
-            }
-        }
-    }
-
-
-    /**
-     * exposes the Persistent Admin Notice Collection via an action
-     * so that PersistentAdminNotice objects can be added and/or removed
-     * without compromising the actual collection like a filter would
-     */
-    protected function registerNotices()
-    {
-        do_action(
-            'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
-            $this->notice_collection
-        );
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidClassException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function displayNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            $enqueue_assets = false;
-            // and display notices
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                /** @var PersistentAdminNotice $persistent_admin_notice */
-                // don't display notices that have already been dismissed
-                if ($persistent_admin_notice->getDismissed()) {
-                    continue;
-                }
-                try {
-                    $this->capabilities_checker->processCapCheck(
-                        $persistent_admin_notice->getCapCheck()
-                    );
-                } catch (InsufficientPermissionsException $e) {
-                    // user does not have required cap, so skip to next notice
-                    // and just eat the exception - nom nom nom nom
-                    continue;
-                }
-                if ($persistent_admin_notice->getMessage() === '') {
-                    continue;
-                }
-                $this->displayPersistentAdminNotice($persistent_admin_notice);
-                $enqueue_assets = true;
-            }
-            if ($enqueue_assets) {
-                $this->enqueueAssets();
-            }
-        }
-    }
-
-
-    /**
-     * does what it's named
-     *
-     * @return void
-     */
-    public function enqueueAssets()
-    {
-        wp_register_script(
-            'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee_error_js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-            array('espresso_core'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_error_js',
-            'ee_dismiss',
-            array(
-                'return_url'    => urlencode($this->return_url),
-                'ajax_url'      => WP_AJAX_URL,
-                'unknown_error' => wp_strip_all_tags(
-                    __(
-                        'An unknown error has occurred on the server while attempting to dismiss this notice.',
-                        'event_espresso'
-                    )
-                ),
-            )
-        );
-        wp_enqueue_script('ee_error_js');
-    }
-
-
-    /**
-     * displayPersistentAdminNoticeHtml
-     *
-     * @param  PersistentAdminNotice $persistent_admin_notice
-     */
-    protected function displayPersistentAdminNotice(PersistentAdminNotice $persistent_admin_notice)
-    {
-        // used in template
-        $persistent_admin_notice_name = $persistent_admin_notice->getName();
-        $persistent_admin_notice_message = $persistent_admin_notice->getMessage();
-        require EE_TEMPLATES . '/notifications/persistent_admin_notice.template.php';
-    }
-
-
-    /**
-     * dismissNotice
-     *
-     * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool   $purge    if true, then delete it from the db
-     * @param bool   $return   forget all of this AJAX or redirect nonsense, and just return
-     * @return void
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function dismissNotice(string $pan_name = '', bool $purge = false, bool $return = false)
-    {
-        $pan_name = $this->request->getRequestParam('ee_nag_notice', $pan_name);
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
-            /** @var PersistentAdminNotice $persistent_admin_notice */
-            $persistent_admin_notice = $this->notice_collection->get($pan_name);
-            $persistent_admin_notice->setDismissed(true);
-            $persistent_admin_notice->setPurge($purge);
-            $this->saveNotices();
-        }
-        if ($return) {
-            return;
-        }
-        if ($this->request->isAjax()) {
-            // grab any notices and concatenate into string
-            echo wp_json_encode(
-                array(
-                    'errors' => implode('<br />', EE_Error::get_notices(false)),
-                )
-            );
-            exit();
-        }
-        // save errors to a transient to be displayed on next request (after redirect)
-        EE_Error::get_notices(false, true);
-        wp_safe_redirect(
-            urldecode(
-                $this->request->getRequestParam('return_url', '')
-            )
-        );
-    }
-
-
-    /**
-     * saveNotices
-     *
-     * @throws DomainException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function saveNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-            // maybe initialize persistent_admin_notices
-            if (empty($persistent_admin_notices)) {
-                add_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array(), '', 'no');
-            }
-            $new_notices_array = [];
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                // remove this notice ?
-                if ($persistent_admin_notice->getPurge()) {
-                    continue;
-                }
-                /** @var PersistentAdminNotice $persistent_admin_notice */
-                $new_notices_array[ $persistent_admin_notice->getName() ] = array(
-                    'message'     => $persistent_admin_notice->getMessage(),
-                    'capability'  => $persistent_admin_notice->getCapability(),
-                    'cap_context' => $persistent_admin_notice->getCapContext(),
-                    'dismissed'   => $persistent_admin_notice->getDismissed(),
-                );
-            }
-            update_option(PersistentAdminNoticeManager::WP_OPTION_KEY, $new_notices_array);
-        }
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function registerAndSaveNotices()
-    {
-        $this->getPersistentAdminNoticeCollection();
-        $this->registerNotices();
-        $this->saveNotices();
-        add_filter(
-            'PersistentAdminNoticeManager__registerAndSaveNotices__complete',
-            '__return_true'
-        );
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public static function loadRegisterAndSaveNotices()
-    {
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        // if shutdown has already run, then call registerAndSaveNotices() manually
-        if (did_action('shutdown')) {
-            $persistent_admin_notice_manager->registerAndSaveNotices();
-        }
-    }
+	const WP_OPTION_KEY = 'ee_pers_admin_notices';
+
+	private CapabilitiesChecker $capabilities_checker;
+
+	private RequestInterface $request;
+
+	/**
+	 * @var Collection|PersistentAdminNotice[]|null $notice_collection
+	 */
+	private ?Collection $notice_collection = null;
+
+	/**
+	 * if AJAX is not enabled, then the return URL will be used for redirecting back to the admin page where the
+	 * persistent admin notice was displayed, and ultimately dismissed from.
+	 *
+	 * @var string $return_url
+	 */
+	private string $return_url;
+
+
+
+	/**
+	 * PersistentAdminNoticeManager constructor
+	 *
+	 * @param CapabilitiesChecker $capabilities_checker
+	 * @param RequestInterface    $request
+	 * @param string              $return_url where to  redirect to after dismissing notices
+	 */
+	public function __construct(
+		CapabilitiesChecker $capabilities_checker,
+		RequestInterface $request,
+		string $return_url = ''
+	) {
+		$this->capabilities_checker = $capabilities_checker;
+		$this->request = $request;
+		$this->setReturnUrl($return_url);
+		// setup up notices at priority 9 because `EE_Admin::display_admin_notices()` runs at priority 10,
+		// and we want to retrieve and generate any nag notices at the last possible moment
+		add_action('admin_notices', array($this, 'displayNotices'), 9);
+		add_action('network_admin_notices', array($this, 'displayNotices'), 9);
+		add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismissNotice'));
+		add_action('shutdown', array($this, 'registerAndSaveNotices'), 998);
+	}
+
+
+	/**
+	 * @param string $return_url
+	 */
+	public function setReturnUrl(string $return_url)
+	{
+		$this->return_url = $return_url;
+	}
+
+
+	/**
+	 * @return Collection
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function getPersistentAdminNoticeCollection(): Collection
+	{
+		if (! $this->notice_collection instanceof Collection) {
+			$this->notice_collection = new Collection(
+				'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
+			);
+			$this->retrieveStoredNotices();
+			$this->registerNotices();
+		}
+		return $this->notice_collection;
+	}
+
+
+	/**
+	 * generates PersistentAdminNotice objects for all non-dismissed notices saved to the db
+	 *
+	 * @return void
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function retrieveStoredNotices()
+	{
+		$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+		if (! empty($persistent_admin_notices)) {
+			foreach ($persistent_admin_notices as $name => $details) {
+				if (is_array($details)) {
+					if (
+						! isset(
+							$details['message'],
+							$details['capability'],
+							$details['cap_context'],
+							$details['dismissed']
+						)
+					) {
+						throw new DomainException(
+							sprintf(
+								esc_html__(
+									'The "%1$s" PersistentAdminNotice could not be retrieved from the database.',
+									'event_espresso'
+								),
+								$name
+							)
+						);
+					}
+					// new format for nag notices
+					$this->notice_collection->add(
+						new PersistentAdminNotice(
+							(string) $name,
+							(string) $details['message'],
+							false,
+							(string) $details['capability'],
+							(string) $details['cap_context'],
+							(bool) $details['dismissed']
+						),
+						sanitize_key($name)
+					);
+				} else {
+					try {
+						// old nag notices, that we want to convert to the new format
+						$this->notice_collection->add(
+							new PersistentAdminNotice(
+								(string) $name,
+								(string) $details,
+								false,
+								'',
+								'',
+								empty($details)
+							),
+							sanitize_key($name)
+						);
+					} catch (Exception $e) {
+						EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+					}
+				}
+				// each notice will self register when the action hook in registerNotices is triggered
+			}
+		}
+	}
+
+
+	/**
+	 * exposes the Persistent Admin Notice Collection via an action
+	 * so that PersistentAdminNotice objects can be added and/or removed
+	 * without compromising the actual collection like a filter would
+	 */
+	protected function registerNotices()
+	{
+		do_action(
+			'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
+			$this->notice_collection
+		);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidClassException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function displayNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			$enqueue_assets = false;
+			// and display notices
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				/** @var PersistentAdminNotice $persistent_admin_notice */
+				// don't display notices that have already been dismissed
+				if ($persistent_admin_notice->getDismissed()) {
+					continue;
+				}
+				try {
+					$this->capabilities_checker->processCapCheck(
+						$persistent_admin_notice->getCapCheck()
+					);
+				} catch (InsufficientPermissionsException $e) {
+					// user does not have required cap, so skip to next notice
+					// and just eat the exception - nom nom nom nom
+					continue;
+				}
+				if ($persistent_admin_notice->getMessage() === '') {
+					continue;
+				}
+				$this->displayPersistentAdminNotice($persistent_admin_notice);
+				$enqueue_assets = true;
+			}
+			if ($enqueue_assets) {
+				$this->enqueueAssets();
+			}
+		}
+	}
+
+
+	/**
+	 * does what it's named
+	 *
+	 * @return void
+	 */
+	public function enqueueAssets()
+	{
+		wp_register_script(
+			'espresso_core',
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee_error_js',
+			EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+			array('espresso_core'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_error_js',
+			'ee_dismiss',
+			array(
+				'return_url'    => urlencode($this->return_url),
+				'ajax_url'      => WP_AJAX_URL,
+				'unknown_error' => wp_strip_all_tags(
+					__(
+						'An unknown error has occurred on the server while attempting to dismiss this notice.',
+						'event_espresso'
+					)
+				),
+			)
+		);
+		wp_enqueue_script('ee_error_js');
+	}
+
+
+	/**
+	 * displayPersistentAdminNoticeHtml
+	 *
+	 * @param  PersistentAdminNotice $persistent_admin_notice
+	 */
+	protected function displayPersistentAdminNotice(PersistentAdminNotice $persistent_admin_notice)
+	{
+		// used in template
+		$persistent_admin_notice_name = $persistent_admin_notice->getName();
+		$persistent_admin_notice_message = $persistent_admin_notice->getMessage();
+		require EE_TEMPLATES . '/notifications/persistent_admin_notice.template.php';
+	}
+
+
+	/**
+	 * dismissNotice
+	 *
+	 * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool   $purge    if true, then delete it from the db
+	 * @param bool   $return   forget all of this AJAX or redirect nonsense, and just return
+	 * @return void
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function dismissNotice(string $pan_name = '', bool $purge = false, bool $return = false)
+	{
+		$pan_name = $this->request->getRequestParam('ee_nag_notice', $pan_name);
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
+			/** @var PersistentAdminNotice $persistent_admin_notice */
+			$persistent_admin_notice = $this->notice_collection->get($pan_name);
+			$persistent_admin_notice->setDismissed(true);
+			$persistent_admin_notice->setPurge($purge);
+			$this->saveNotices();
+		}
+		if ($return) {
+			return;
+		}
+		if ($this->request->isAjax()) {
+			// grab any notices and concatenate into string
+			echo wp_json_encode(
+				array(
+					'errors' => implode('<br />', EE_Error::get_notices(false)),
+				)
+			);
+			exit();
+		}
+		// save errors to a transient to be displayed on next request (after redirect)
+		EE_Error::get_notices(false, true);
+		wp_safe_redirect(
+			urldecode(
+				$this->request->getRequestParam('return_url', '')
+			)
+		);
+	}
+
+
+	/**
+	 * saveNotices
+	 *
+	 * @throws DomainException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function saveNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+			// maybe initialize persistent_admin_notices
+			if (empty($persistent_admin_notices)) {
+				add_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array(), '', 'no');
+			}
+			$new_notices_array = [];
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				// remove this notice ?
+				if ($persistent_admin_notice->getPurge()) {
+					continue;
+				}
+				/** @var PersistentAdminNotice $persistent_admin_notice */
+				$new_notices_array[ $persistent_admin_notice->getName() ] = array(
+					'message'     => $persistent_admin_notice->getMessage(),
+					'capability'  => $persistent_admin_notice->getCapability(),
+					'cap_context' => $persistent_admin_notice->getCapContext(),
+					'dismissed'   => $persistent_admin_notice->getDismissed(),
+				);
+			}
+			update_option(PersistentAdminNoticeManager::WP_OPTION_KEY, $new_notices_array);
+		}
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function registerAndSaveNotices()
+	{
+		$this->getPersistentAdminNoticeCollection();
+		$this->registerNotices();
+		$this->saveNotices();
+		add_filter(
+			'PersistentAdminNoticeManager__registerAndSaveNotices__complete',
+			'__return_true'
+		);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public static function loadRegisterAndSaveNotices()
+	{
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		// if shutdown has already run, then call registerAndSaveNotices() manually
+		if (did_action('shutdown')) {
+			$persistent_admin_notice_manager->registerAndSaveNotices();
+		}
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -92,7 +92,7 @@ 
      */
     protected function getPersistentAdminNoticeCollection(): Collection
     {
-        if (! $this->notice_collection instanceof Collection) {
+        if ( ! $this->notice_collection instanceof Collection) {
             $this->notice_collection = new Collection(
                 'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
             );
@@ -114,7 +114,7 @@ 
     protected function retrieveStoredNotices()
     {
         $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-        if (! empty($persistent_admin_notices)) {
+        if ( ! empty($persistent_admin_notices)) {
             foreach ($persistent_admin_notices as $name => $details) {
                 if (is_array($details)) {
                     if (
@@ -235,14 +235,14 @@ 
     {
         wp_register_script(
             'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee_error_js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js',
             array('espresso_core'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -275,7 +275,7 @@ 
         // used in template
         $persistent_admin_notice_name = $persistent_admin_notice->getName();
         $persistent_admin_notice_message = $persistent_admin_notice->getMessage();
-        require EE_TEMPLATES . '/notifications/persistent_admin_notice.template.php';
+        require EE_TEMPLATES.'/notifications/persistent_admin_notice.template.php';
     }
 
 
@@ -299,7 +299,7 @@ 
     {
         $pan_name = $this->request->getRequestParam('ee_nag_notice', $pan_name);
         $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
+        if ( ! empty($pan_name) && $this->notice_collection->has($pan_name)) {
             /** @var PersistentAdminNotice $persistent_admin_notice */
             $persistent_admin_notice = $this->notice_collection->get($pan_name);
             $persistent_admin_notice->setDismissed(true);
@@ -352,7 +352,7 @@ 
                     continue;
                 }
                 /** @var PersistentAdminNotice $persistent_admin_notice */
-                $new_notices_array[ $persistent_admin_notice->getName() ] = array(
+                $new_notices_array[$persistent_admin_notice->getName()] = array(
                     'message'     => $persistent_admin_notice->getMessage(),
                     'capability'  => $persistent_admin_notice->getCapability(),
                     'cap_context' => $persistent_admin_notice->getCapContext(),

core/services/database/OptionEngine.php

Indentation +54 added lines, -54 removed lines

@@ -12,69 +12,69 @@
  */
 class OptionEngine
 {
-    private bool $is_network_option;
+	private bool $is_network_option;
 
-    private int $network_ID;
+	private int $network_ID;
 
 
-    /**
-     * @param bool $is_network_option
-     */
-    public function __construct(bool $is_network_option = false)
-    {
-        $this->is_network_option = $is_network_option;
-        $this->network_ID        = get_current_network_id();
-    }
+	/**
+	 * @param bool $is_network_option
+	 */
+	public function __construct(bool $is_network_option = false)
+	{
+		$this->is_network_option = $is_network_option;
+		$this->network_ID        = get_current_network_id();
+	}
 
 
-    /**
-     * @param string $option_name
-     * @param mixed  $default_value
-     * @return false|mixed|void
-     */
-    public function getOption(string $option_name, $default_value)
-    {
-        return $this->is_network_option
-            ? get_network_option($this->network_ID, $option_name, $default_value)
-            : get_option($option_name, $default_value);
-    }
+	/**
+	 * @param string $option_name
+	 * @param mixed  $default_value
+	 * @return false|mixed|void
+	 */
+	public function getOption(string $option_name, $default_value)
+	{
+		return $this->is_network_option
+			? get_network_option($this->network_ID, $option_name, $default_value)
+			: get_option($option_name, $default_value);
+	}
 
 
-    /**
-     * @param string $option_name
-     * @param mixed  $value
-     * @param string $autoload
-     * @return bool
-     */
-    public function addOption(string $option_name, $value, string $autoload): bool
-    {
-        return $this->is_network_option
-            ? add_network_option($this->network_ID, $option_name, $value)
-            : add_option($option_name, $value, '', $autoload);
-    }
+	/**
+	 * @param string $option_name
+	 * @param mixed  $value
+	 * @param string $autoload
+	 * @return bool
+	 */
+	public function addOption(string $option_name, $value, string $autoload): bool
+	{
+		return $this->is_network_option
+			? add_network_option($this->network_ID, $option_name, $value)
+			: add_option($option_name, $value, '', $autoload);
+	}
 
 
-    /**
-     * @param string $option_name
-     * @param mixed  $value
-     * @return bool
-     */
-    public function updateOption(string $option_name, $value): bool
-    {
-        return $this->is_network_option
-            ? update_network_option($this->network_ID, $option_name, $value)
-            : update_option($option_name, $value);
-    }
+	/**
+	 * @param string $option_name
+	 * @param mixed  $value
+	 * @return bool
+	 */
+	public function updateOption(string $option_name, $value): bool
+	{
+		return $this->is_network_option
+			? update_network_option($this->network_ID, $option_name, $value)
+			: update_option($option_name, $value);
+	}
 
 
-    /**
-     * @param string $option_name
-     * @return bool
-     */
-    public function deleteOption(string $option_name): bool
-    {
-        return $this->is_network_option
-            ? delete_network_option($this->network_ID, $option_name)
-            : delete_option($option_name);
-    }
+	/**
+	 * @param string $option_name
+	 * @return bool
+	 */
+	public function deleteOption(string $option_name): bool
+	{
+		return $this->is_network_option
+			? delete_network_option($this->network_ID, $option_name)
+			: delete_option($option_name);
+	}
 }

core/services/database/WordPressOption.php

Indentation +168 added lines, -168 removed lines

@@ -17,172 +17,172 @@
  */
 abstract class WordPressOption
 {
-    public const NOT_SET_YET = 'wordpress-option-value-not-yet-set';
-
-    /**
-     * WordPress makes it difficult to determine if an option successfully saved or not,
-     * which is sometimes really important to know, especially if the information you are saving is critical.
-     * The following options allow us to have a better chance of knowing when an update actually failed
-     * or when everything is OK but it just didn't update because the value hasn't changed.
-     */
-    public const UPDATE_SUCCESS = 1;
-
-    public const UPDATE_NONE    = 0;
-
-    public const UPDATE_ERROR   = -1;
-
-    private bool $autoload = false;
-
-    /**
-     * @var mixed
-     */
-    private $default_value = null;
-
-    private string $option_name = '';
-
-    /**
-     * @var mixed
-     */
-    private $value = WordPressOption::NOT_SET_YET;
-
-    private OptionEngine $option_engine;
-
-
-    /**
-     * WordPressOption constructor.
-     *
-     * @param string $option_name
-     * @param mixed  $default_value
-     * @param bool   $autoload          if true, will load the option on EVERY request
-     * @param bool   $is_network_option if true, will save the option to the network as opposed to the current blog
-     */
-    public function __construct(
-        string $option_name,
-        $default_value,
-        bool $autoload = false,
-        bool $is_network_option = false
-    ) {
-        $this->setAutoload($autoload);
-        $this->setDefaultValue($default_value);
-        $this->setOptionName($option_name);
-        $this->option_engine = new OptionEngine($is_network_option);
-    }
-
-
-    /**
-     * @param bool|string $autoload
-     */
-    public function setAutoload($autoload): void
-    {
-        $this->autoload = filter_var($autoload, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param mixed $default_value
-     */
-    public function setDefaultValue($default_value): void
-    {
-        $this->default_value = $default_value;
-    }
-
-
-    /**
-     * @param string $option_name
-     */
-    public function setOptionName(string $option_name): void
-    {
-        $this->option_name = sanitize_key($option_name);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function optionExists(): string
-    {
-        return $this->option_engine->getOption(
-            $this->getOptionName(),
-            WordPressOption::NOT_SET_YET
-        ) !== WordPressOption::NOT_SET_YET;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getOptionName(): string
-    {
-        return $this->option_name;
-    }
-
-
-    /**
-     * @return false|mixed|void
-     */
-    public function loadOption()
-    {
-        if ($this->value === WordPressOption::NOT_SET_YET) {
-            $this->value = $this->option_engine->getOption($this->getOptionName(), $this->default_value);
-        }
-        return $this->value;
-    }
-
-
-    /**
-     * @param $value
-     * @return int
-     */
-    public function updateOption($value): int
-    {
-        // don't update if value has not changed since last update
-        if ($this->valueIsUnchanged($value)) {
-            return WordPressOption::UPDATE_NONE;
-        }
-        $this->value = $value;
-        // because the options for updating differ when adding an option for the first time
-        // we use the WordPressOption::NOT_SET_YET to determine if things already exist in the db
-        $updated = $this->optionExists()
-            ? $this->option_engine->updateOption($this->getOptionName(), $this->value)
-            : $this->option_engine->addOption($this->getOptionName(), $this->value, $this->autoload());
-
-        if ($updated) {
-            return WordPressOption::UPDATE_SUCCESS;
-        }
-        return WordPressOption::UPDATE_ERROR;
-    }
-
-
-    private function valueIsUnchanged($value): bool
-    {
-        if (is_array($value) && is_array($this->value)) {
-            $diff = EEH_Array::array_diff_recursive($value, $this->value);
-            // $diff = array_diff($value, $this->value);
-            return empty($diff);
-        }
-        // emulate WP's method for checking equality
-        return $value === $this->value && maybe_serialize($value) === maybe_serialize($this->value);
-    }
-
-
-    /**
-     * @return string
-     */
-    private function autoload(): string
-    {
-        return $this->autoload ? 'yes' : 'no';
-    }
-
-
-    /**
-     * Deletes the option from the database
-     * for the rest of the request
-     *
-     * @return bool
-     * @since  5.0.0.p
-     */
-    public function deleteOption(): bool
-    {
-        return $this->option_engine->deleteOption($this->getOptionName());
-    }
+	public const NOT_SET_YET = 'wordpress-option-value-not-yet-set';
+
+	/**
+	 * WordPress makes it difficult to determine if an option successfully saved or not,
+	 * which is sometimes really important to know, especially if the information you are saving is critical.
+	 * The following options allow us to have a better chance of knowing when an update actually failed
+	 * or when everything is OK but it just didn't update because the value hasn't changed.
+	 */
+	public const UPDATE_SUCCESS = 1;
+
+	public const UPDATE_NONE    = 0;
+
+	public const UPDATE_ERROR   = -1;
+
+	private bool $autoload = false;
+
+	/**
+	 * @var mixed
+	 */
+	private $default_value = null;
+
+	private string $option_name = '';
+
+	/**
+	 * @var mixed
+	 */
+	private $value = WordPressOption::NOT_SET_YET;
+
+	private OptionEngine $option_engine;
+
+
+	/**
+	 * WordPressOption constructor.
+	 *
+	 * @param string $option_name
+	 * @param mixed  $default_value
+	 * @param bool   $autoload          if true, will load the option on EVERY request
+	 * @param bool   $is_network_option if true, will save the option to the network as opposed to the current blog
+	 */
+	public function __construct(
+		string $option_name,
+		$default_value,
+		bool $autoload = false,
+		bool $is_network_option = false
+	) {
+		$this->setAutoload($autoload);
+		$this->setDefaultValue($default_value);
+		$this->setOptionName($option_name);
+		$this->option_engine = new OptionEngine($is_network_option);
+	}
+
+
+	/**
+	 * @param bool|string $autoload
+	 */
+	public function setAutoload($autoload): void
+	{
+		$this->autoload = filter_var($autoload, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param mixed $default_value
+	 */
+	public function setDefaultValue($default_value): void
+	{
+		$this->default_value = $default_value;
+	}
+
+
+	/**
+	 * @param string $option_name
+	 */
+	public function setOptionName(string $option_name): void
+	{
+		$this->option_name = sanitize_key($option_name);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function optionExists(): string
+	{
+		return $this->option_engine->getOption(
+			$this->getOptionName(),
+			WordPressOption::NOT_SET_YET
+		) !== WordPressOption::NOT_SET_YET;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getOptionName(): string
+	{
+		return $this->option_name;
+	}
+
+
+	/**
+	 * @return false|mixed|void
+	 */
+	public function loadOption()
+	{
+		if ($this->value === WordPressOption::NOT_SET_YET) {
+			$this->value = $this->option_engine->getOption($this->getOptionName(), $this->default_value);
+		}
+		return $this->value;
+	}
+
+
+	/**
+	 * @param $value
+	 * @return int
+	 */
+	public function updateOption($value): int
+	{
+		// don't update if value has not changed since last update
+		if ($this->valueIsUnchanged($value)) {
+			return WordPressOption::UPDATE_NONE;
+		}
+		$this->value = $value;
+		// because the options for updating differ when adding an option for the first time
+		// we use the WordPressOption::NOT_SET_YET to determine if things already exist in the db
+		$updated = $this->optionExists()
+			? $this->option_engine->updateOption($this->getOptionName(), $this->value)
+			: $this->option_engine->addOption($this->getOptionName(), $this->value, $this->autoload());
+
+		if ($updated) {
+			return WordPressOption::UPDATE_SUCCESS;
+		}
+		return WordPressOption::UPDATE_ERROR;
+	}
+
+
+	private function valueIsUnchanged($value): bool
+	{
+		if (is_array($value) && is_array($this->value)) {
+			$diff = EEH_Array::array_diff_recursive($value, $this->value);
+			// $diff = array_diff($value, $this->value);
+			return empty($diff);
+		}
+		// emulate WP's method for checking equality
+		return $value === $this->value && maybe_serialize($value) === maybe_serialize($this->value);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	private function autoload(): string
+	{
+		return $this->autoload ? 'yes' : 'no';
+	}
+
+
+	/**
+	 * Deletes the option from the database
+	 * for the rest of the request
+	 *
+	 * @return bool
+	 * @since  5.0.0.p
+	 */
+	public function deleteOption(): bool
+	{
+		return $this->option_engine->deleteOption($this->getOptionName());
+	}
 }

core/db_classes/EE_Registration.class.php

Indentation +2558 added lines, -2558 removed lines

@@ -17,2562 +17,2562 @@
  */
 class EE_Registration extends EE_Soft_Delete_Base_Class implements EEI_Registration, EEI_Admin_Links
 {
-    /**
-     * Used to reference when a registration has never been checked in.
-     *
-     * @deprecated use \EE_Checkin::status_checked_never instead
-     * @type int
-     */
-    const checkin_status_never = 2;
-
-    /**
-     * Used to reference when a registration has been checked in.
-     *
-     * @deprecated use \EE_Checkin::status_checked_in instead
-     * @type int
-     */
-    const checkin_status_in = 1;
-
-    /**
-     * Used to reference when a registration has been checked out.
-     *
-     * @deprecated use \EE_Checkin::status_checked_out instead
-     * @type int
-     */
-    const checkin_status_out = 0;
-
-    /**
-     * extra meta key for tracking reg status os trashed registrations
-     *
-     * @type string
-     */
-    const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
-
-    /**
-     * extra meta key for tracking if registration has reserved ticket
-     *
-     * @type string
-     */
-    const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = '', $date_formats = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object
-            ?: new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Event ID
-     *
-     * @param int $EVT_ID Event ID
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_event($EVT_ID = 0)
-    {
-        $this->set('EVT_ID', $EVT_ID);
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
-     * be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'REG_code':
-                if (! empty($field_value) && ! $this->reg_code()) {
-                    $this->set_reg_code($field_value, $use_default);
-                }
-                break;
-            case 'STS_ID':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     * Set Status ID
-     * updates the registration status and ALSO...
-     * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
-     * calls release_registration_space() if the reg status changes FROM approved to any other reg status
-     *
-     * @param string                $new_STS_ID
-     * @param boolean               $use_default
-     * @param ContextInterface|null $context
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_status($new_STS_ID = null, $use_default = false, ContextInterface $context = null)
-    {
-        // get current REG_Status
-        $old_STS_ID = $this->status_ID();
-        // if status has changed
-        if (
-            $old_STS_ID !== $new_STS_ID // and that status has actually changed
-            && ! empty($old_STS_ID) // and that old status is actually set
-            && ! empty($new_STS_ID) // as well as the new status
-            && $this->ID() // ensure registration is in the db
-        ) {
-            // update internal status first
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            // THEN handle other changes that occur when reg status changes
-            // TO approved
-            if ($new_STS_ID === EEM_Registration::status_id_approved) {
-                // reserve a space by incrementing ticket and datetime sold values
-                $this->reserveRegistrationSpace();
-                do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID, $context);
-                // OR FROM  approved
-            } elseif ($old_STS_ID === EEM_Registration::status_id_approved) {
-                // release a space by decrementing ticket and datetime sold values
-                $this->releaseRegistrationSpace();
-                do_action(
-                    'AHEE__EE_Registration__set_status__from_approved',
-                    $this,
-                    $old_STS_ID,
-                    $new_STS_ID,
-                    $context
-                );
-            }
-            // update status
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            $this->updateIfCanceledOrReinstated($new_STS_ID, $old_STS_ID, $context);
-            if ($this->statusChangeUpdatesTransaction($context)) {
-                $this->updateTransactionAfterStatusChange();
-            }
-            do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID, $context);
-            return true;
-        }
-        // even though the old value matches the new value, it's still good to
-        // allow the parent set method to have a say
-        parent::set('STS_ID', $new_STS_ID, $use_default);
-        return true;
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param string                $new_STS_ID
-     * @param string                $old_STS_ID
-     * @param ContextInterface|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateIfCanceledOrReinstated($new_STS_ID, $old_STS_ID, ContextInterface $context = null)
-    {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-        // true if registration has been cancelled or declined
-        $this->updateIfCanceled(
-            $closed_reg_statuses,
-            $new_STS_ID,
-            $old_STS_ID,
-            $context
-        );
-        $this->updateIfReinstated(
-            $closed_reg_statuses,
-            $new_STS_ID,
-            $old_STS_ID,
-            $context
-        );
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param array                 $closed_reg_statuses
-     * @param string                $new_STS_ID
-     * @param string                $old_STS_ID
-     * @param ContextInterface|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateIfCanceled(
-        array $closed_reg_statuses,
-        $new_STS_ID,
-        $old_STS_ID,
-        ContextInterface $context = null
-    ) {
-        // true if registration has been cancelled or declined
-        if (
-            in_array($new_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($old_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // cancelled or declined registration
-            $registration_processor->update_registration_after_being_canceled_or_declined(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_canceled_or_declined_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action(
-                'AHEE__EE_Registration__set_status__canceled_or_declined',
-                $this,
-                $old_STS_ID,
-                $new_STS_ID,
-                $context
-            );
-            return;
-        }
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param array                 $closed_reg_statuses
-     * @param string                $new_STS_ID
-     * @param string                $old_STS_ID
-     * @param ContextInterface|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateIfReinstated(
-        array $closed_reg_statuses,
-        $new_STS_ID,
-        $old_STS_ID,
-        ContextInterface $context = null
-    ) {
-        // true if reinstating cancelled or declined registration
-        if (
-            in_array($old_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($new_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // reinstating cancelled or declined registration
-            $registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_reinstating_canceled_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action(
-                'AHEE__EE_Registration__set_status__after_reinstated',
-                $this,
-                $old_STS_ID,
-                $new_STS_ID,
-                $context
-            );
-        }
-    }
-
-
-    /**
-     * @param ContextInterface|null $context
-     * @return bool
-     */
-    private function statusChangeUpdatesTransaction(ContextInterface $context = null)
-    {
-        $contexts_that_do_not_update_transaction = (array) apply_filters(
-            'AHEE__EE_Registration__statusChangeUpdatesTransaction__contexts_that_do_not_update_transaction',
-            ['spco_reg_step_attendee_information_process_registrations'],
-            $context,
-            $this
-        );
-        return ! (
-            $context instanceof ContextInterface
-            && in_array($context->slug(), $contexts_that_do_not_update_transaction, true)
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateTransactionAfterStatusChange()
-    {
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-        $transaction_payments->recalculate_transaction_total($this->transaction(), false);
-        $this->transaction()->update_status_based_on_total_paid();
-    }
-
-
-    /**
-     * get Status ID
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Gets the ticket this registration is for
-     *
-     * @param boolean $include_archived whether to include archived tickets or not.
-     * @return EE_Ticket|EE_Base_Class
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket($include_archived = true)
-    {
-        $query_params = [];
-        if ($include_archived) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $this->get_first_related('Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets the event this registration is for
-     *
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function event(): EE_Event
-    {
-        $event = $this->get_first_related('Event');
-        if (! $event instanceof EE_Event) {
-            throw new EntityNotFoundException('Event ID', $this->event_ID());
-        }
-        return $event;
-    }
-
-
-    /**
-     * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
-     * with the author of the event this registration is for.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    public function wp_user(): int
-    {
-        return $this->event()->wp_user();
-    }
-
-
-    /**
-     * increments this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    private function reserveRegistrationSpace()
-    {
-        // reserved ticket and datetime counts will be decremented as sold counts are incremented
-        // so stop tracking that this reg has a ticket reserved
-        $this->release_reserved_ticket(false, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
-        $ticket = $this->ticket();
-        $ticket->increaseSold();
-        // possibly set event status to sold out
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    private function releaseRegistrationSpace()
-    {
-        $ticket = $this->ticket();
-        $ticket->decreaseSold();
-        // possibly change event status from sold out back to previous status
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * tracks this registration's ticket reservation in extra meta
-     * and can increment related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool   $update_ticket if true, will increment ticket and datetime reserved count
-     * @param string $source
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reserve_ticket($update_ticket = false, $source = 'unknown')
-    {
-        // only reserve ticket if space is not currently reserved
-        if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) !== true) {
-            $reserved = $this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
-            if ($reserved && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->increaseReserved(1, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
-                $this->update_extra_meta('reserve_ticket', "{$this->ticket_ID()} from {$source}");
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * stops tracking this registration's ticket reservation in extra meta
-     * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool   $update_ticket if true, will decrement ticket and datetime reserved count
-     * @param string $source
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function release_reserved_ticket($update_ticket = false, $source = 'unknown')
-    {
-        // only release ticket if space is currently reserved
-        if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) === true) {
-            $reserved = $this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, false);
-            if ($reserved && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
-                $this->update_extra_meta('release_reserved_ticket', "{$this->ticket_ID()} from {$source}");
-            }
-        }
-    }
-
-
-    /**
-     * Set Attendee ID
-     *
-     * @param int $ATT_ID Attendee ID
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_attendee_id($ATT_ID = 0)
-    {
-        $this->set('ATT_ID', $ATT_ID);
-    }
-
-
-    /**
-     *        Set Transaction ID
-     *
-     * @param int $TXN_ID Transaction ID
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     *        Set Session
-     *
-     * @param string $REG_session PHP Session ID
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_session($REG_session = '')
-    {
-        $this->set('REG_session', $REG_session);
-    }
-
-
-    /**
-     *        Set Registration URL Link
-     *
-     * @param string $REG_url_link Registration URL Link
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_reg_url_link($REG_url_link = '')
-    {
-        $this->set('REG_url_link', $REG_url_link);
-    }
-
-
-    /**
-     *        Set Attendee Counter
-     *
-     * @param int $REG_count Primary Attendee
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_count($REG_count = 1)
-    {
-        $this->set('REG_count', $REG_count);
-    }
-
-
-    /**
-     *        Set Group Size
-     *
-     * @param boolean $REG_group_size Group Registration
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_group_size($REG_group_size = false)
-    {
-        $this->set('REG_group_size', $REG_group_size);
-    }
-
-
-    /**
-     *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_not_approved
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_not_approved()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_not_approved;
-    }
-
-
-    /**
-     *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_pending_payment
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_pending_payment()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_pending_payment;
-    }
-
-
-    /**
-     *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_approved()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_approved;
-    }
-
-
-    /**
-     *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_cancelled()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_cancelled;
-    }
-
-
-    /**
-     *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_declined()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_declined;
-    }
-
-
-    /**
-     *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_incomplete
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_incomplete;
-    }
-
-
-    /**
-     *        Set Registration Date
-     *
-     * @param mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
-     *                                                 Date
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_reg_date($REG_date = false)
-    {
-        $this->set('REG_date', $REG_date);
-    }
-
-
-    /**
-     *    Set final price owing for this registration after all ticket/price modifications
-     *
-     * @param float $REG_final_price
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_final_price($REG_final_price = 0.00)
-    {
-        $this->set('REG_final_price', $REG_final_price);
-    }
-
-
-    /**
-     *    Set amount paid towards this registration's final price
-     *
-     * @param float|int|string $REG_paid
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_paid($REG_paid = 0.00)
-    {
-        $this->set('REG_paid', (float) $REG_paid);
-    }
-
-
-    /**
-     *        Attendee Is Going
-     *
-     * @param boolean $REG_att_is_going Attendee Is Going
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_att_is_going($REG_att_is_going = false)
-    {
-        $this->set('REG_att_is_going', $REG_att_is_going);
-    }
-
-
-    /**
-     * Gets the related attendee
-     *
-     * @return EE_Attendee|EE_Base_Class
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function attendee()
-    {
-        return $this->get_first_related('Attendee');
-    }
-
-
-    /**
-     * Gets the name of the attendee.
-     *
-     * @param bool $apply_html_entities set to true if you want to use HTML entities.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    public function attendeeName($apply_html_entities = false)
-    {
-        $attendee = $this->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            $attendee_name = $attendee->full_name($apply_html_entities);
-        } else {
-            $attendee_name = esc_html__('Unknown', 'event_espresso');
-        }
-        return $attendee_name;
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_ID()
-    {
-        return $this->get('EVT_ID');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_name()
-    {
-        $event = $this->event_obj();
-        if ($event) {
-            return $event->name();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Fetches the event this registration is for
-     *
-     * @return EE_Base_Class|EE_Event
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function event_obj()
-    {
-        return $this->get_first_related('Event');
-    }
-
-
-    /**
-     *        get Attendee ID
-     */
-    public function attendee_ID()
-    {
-        return $this->get('ATT_ID');
-    }
-
-
-    /**
-     *        get PHP Session ID
-     */
-    public function session_ID()
-    {
-        return $this->get('REG_session');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the receipt template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function receipt_url($messenger = 'html')
-    {
-        return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the invoice template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function invoice_url($messenger = 'html')
-    {
-        return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
-    }
-
-
-    /**
-     * get Registration URL Link
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_url_link()
-    {
-        return (string) $this->get('REG_url_link');
-    }
-
-
-    /**
-     * Echoes out invoice_url()
-     *
-     * @param string $type 'download','launch', or 'html' (default is 'launch')
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function e_invoice_url($type = 'launch')
-    {
-        echo esc_url_raw($this->invoice_url($type));
-    }
-
-
-    /**
-     * Echoes out payment_overview_url
-     */
-    public function e_payment_overview_url()
-    {
-        echo esc_url_raw($this->payment_overview_url());
-    }
-
-
-    /**
-     * Gets the URL for the checkout payment options reg step
-     * with this registration's REG_url_link added as a query parameter
-     *
-     * @param bool $clear_session Set to true when you want to clear the session on revisiting the
-     *                            payment overview url.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_overview_url($clear_session = false)
-    {
-        return add_query_arg(
-            (array) apply_filters(
-                'FHEE__EE_Registration__payment_overview_url__query_args',
-                [
-                    'e_reg_url_link' => $this->reg_url_link(),
-                    'step'           => 'payment_options',
-                    'revisit'        => true,
-                    'clear_session'  => (bool) $clear_session,
-                ],
-                $this
-            ),
-            EE_Registry::instance()->CFG->core->reg_page_url()
-        );
-    }
-
-
-    /**
-     * Gets the URL for the checkout attendee information reg step
-     * with this registration's REG_url_link added as a query parameter
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function edit_attendee_information_url()
-    {
-        return add_query_arg(
-            (array) apply_filters(
-                'FHEE__EE_Registration__edit_attendee_information_url__query_args',
-                [
-                    'e_reg_url_link' => $this->reg_url_link(),
-                    'step'           => 'attendee_information',
-                    'revisit'        => true,
-                ],
-                $this
-            ),
-            EE_Registry::instance()->CFG->core->reg_page_url()
-        );
-    }
-
-
-    /**
-     * Simply generates and returns the appropriate admin_url link to edit this registration
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_edit_url()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page'    => 'espresso_registrations',
-                'action'  => 'view_registration',
-                '_REG_ID' => $this->ID(),
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * is_primary_registrant?
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_primary_registrant()
-    {
-        return (int) $this->get('REG_count') === 1;
-    }
-
-
-    /**
-     * This returns the primary registration object for this registration group (which may be this object).
-     *
-     * @return EE_Registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_primary_registration()
-    {
-        if ($this->is_primary_registrant()) {
-            return $this;
-        }
-
-        // k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
-        /** @var EE_Registration $primary_registrant */
-        $primary_registrant = EEM_Registration::instance()->get_one(
-            [
-                [
-                    'TXN_ID'    => $this->transaction_ID(),
-                    'REG_count' => 1,
-                ],
-            ]
-        );
-        return $primary_registrant;
-    }
-
-
-    /**
-     * get  Attendee Number
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function count()
-    {
-        return $this->get('REG_count');
-    }
-
-
-    /**
-     * get Group Size
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function group_size()
-    {
-        return $this->get('REG_group_size');
-    }
-
-
-    /**
-     * get Registration Date
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function date()
-    {
-        return $this->get('REG_date');
-    }
-
-
-    /**
-     * gets a pretty date
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_date($date_format = null, $time_format = null)
-    {
-        return $this->get_datetime('REG_date', $date_format, $time_format);
-    }
-
-
-    /**
-     * final_price
-     * the registration's share of the transaction total, so that the
-     * sum of all the transaction's REG_final_prices equal the transaction's total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function final_price(): float
-    {
-        return (float) $this->get('REG_final_price');
-    }
-
-
-    /**
-     * pretty_final_price
-     *  final price as formatted string, with correct decimal places and currency symbol
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_final_price()
-    {
-        return $this->get_pretty('REG_final_price');
-    }
-
-
-    /**
-     * get paid (yeah)
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function paid(): float
-    {
-        return (float) $this->get('REG_paid');
-    }
-
-
-    /**
-     * pretty_paid
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_paid()
-    {
-        return $this->get_pretty('REG_paid');
-    }
-
-
-    /**
-     * owes_monies_and_can_pay
-     * whether or not this registration has monies owing and it's' status allows payment
-     *
-     * @param array $requires_payment list of registration statuses that allow a registrant to make a payment
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function owes_monies_and_can_pay($requires_payment = [])
-    {
-        // these reg statuses require payment (if event is not free)
-        $requires_payment = ! empty($requires_payment)
-            ? $requires_payment
-            : EEM_Registration::reg_statuses_that_allow_payment();
-        if (
-            $this->final_price() !== 0 &&
-            $this->final_price() !== $this->paid() &&
-            in_array($this->status_ID(), $requires_payment)
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Prints out the return value of $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
-    }
-
-
-    /**
-     * Returns a nice version of the status for displaying to customers
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            [$this->status_ID() => esc_html__('unknown', 'event_espresso')],
-            false,
-            'sentence'
-        );
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Registration::status_id_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_pending_payment:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_not_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_cancelled:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_incomplete:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_declined:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_wait_list:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[ $this->status_ID() ];
-    }
-
-
-    /**
-     *        get Attendee Is Going
-     */
-    public function att_is_going()
-    {
-        return $this->get('REG_att_is_going');
-    }
-
-
-    /**
-     * Gets related answers
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Answer[]|EE_Base_Class[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function answers($query_params = [])
-    {
-        return $this->get_many_related('Answer', $query_params);
-    }
-
-
-    /**
-     * Gets the registration's answer value to the specified question
-     * (either the question's ID or a question object)
-     *
-     * @param EE_Question|int $question
-     * @param bool            $pretty_value
-     * @return array|string if pretty_value= true, the result will always be a string
-     * (because the answer might be an array of answer values, so passing pretty_value=true
-     * will convert it into some kind of string)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function answer_value_to_question($question, $pretty_value = true)
-    {
-        $question_id = EEM_Question::instance()->ensure_is_ID($question);
-        return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
-    }
-
-
-    /**
-     * question_groups
-     * returns an array of EE_Question_Group objects for this registration
-     *
-     * @return EE_Question_Group[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function question_groups()
-    {
-        return EEM_Event::instance()->get_question_groups_for_event($this->event_ID(), $this);
-    }
-
-
-    /**
-     * count_question_groups
-     * returns a count of the number of EE_Question_Group objects for this registration
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function count_question_groups()
-    {
-        return EEM_Event::instance()->count_related(
-            $this->event_ID(),
-            'Question_Group',
-            [
-                [
-                    'Event_Question_Group.'
-                    . EEM_Event_Question_Group::instance()->fieldNameForContext($this->is_primary_registrant()) => true,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Returns the registration date in the 'standard' string format
-     * (function may be improved in the future to allow for different formats and timezones)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_date()
-    {
-        return $this->get_datetime('REG_date');
-    }
-
-
-    /**
-     * Gets the datetime-ticket for this registration (ie, it can be used to isolate
-     * the ticket this registration purchased, or the datetime they have registered
-     * to attend)
-     *
-     * @return EE_Base_Class|EE_Datetime_Ticket
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function datetime_ticket()
-    {
-        return $this->get_first_related('Datetime_Ticket');
-    }
-
-
-    /**
-     * Sets the registration's datetime_ticket.
-     *
-     * @param EE_Datetime_Ticket $datetime_ticket
-     * @return EE_Base_Class|EE_Datetime_Ticket
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_datetime_ticket($datetime_ticket)
-    {
-        return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
-    }
-
-
-    /**
-     * Gets deleted
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function deleted()
-    {
-        return $this->get('REG_deleted');
-    }
-
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_deleted($deleted)
-    {
-        if ($deleted) {
-            $this->delete();
-        } else {
-            $this->restore();
-        }
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Base_Class|EE_Status
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Returns the number of times this registration has checked into any of the datetimes
-     * its available for
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function count_checkins()
-    {
-        return $this->get_model()->count_related($this, 'Checkin');
-    }
-
-
-    /**
-     * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
-     * registration is for.  Note, this is ONLY checked in (does not include checkedout)
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function count_checkins_not_checkedout()
-    {
-        return $this->get_model()->count_related($this, 'Checkin', [['CHK_in' => 1]]);
-    }
-
-
-    /**
-     * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
-     * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
-     *                                          consider registration status as well as datetime access.
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function can_checkin($DTT_OR_ID, $check_approved = true)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-        // first check registration status
-        if (! $DTT_ID || ($check_approved && ! $this->is_approved())) {
-            return false;
-        }
-        // is there a datetime ticket that matches this dtt_ID?
-        if (
-            ! (EEM_Datetime_Ticket::instance()->exists(
-                [
-                    [
-                        'TKT_ID' => $this->get('TKT_ID'),
-                        'DTT_ID' => $DTT_ID,
-                    ],
-                ]
-            ))
-        ) {
-            return false;
-        }
-
-        // final check is against TKT_uses
-        return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
-    }
-
-
-    /**
-     * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
-     * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
-     * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
-     * then return false.  Otherwise return true.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
-     * @return bool true means can checkin.  false means cannot checkin.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        if (! $DTT_ID) {
-            return false;
-        }
-
-        $max_uses = $this->ticket() instanceof EE_Ticket
-            ? $this->ticket()->uses()
-            : EE_INF;
-
-        // if max uses is not set or equals infinity then return true cause its not a factor for whether user can
-        // check-in or not.
-        if (! $max_uses || $max_uses === EE_INF) {
-            return true;
-        }
-
-        // does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
-        // go ahead and toggle.
-        if (EEM_Checkin::instance()->exists([['REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID]])) {
-            return true;
-        }
-
-        // made it here so the last check is whether the number of checkins per unique datetime on this registration
-        // disallows further check-ins.
-        $count_unique_dtt_checkins = EEM_Checkin::instance()->count(
-            [
-                [
-                    'REG_ID' => $this->ID(),
-                    'CHK_in' => true,
-                ],
-            ],
-            'DTT_ID',
-            true
-        );
-        // checkins have already reached their max number of uses
-        // so registrant can NOT checkin
-        if ($count_unique_dtt_checkins >= $max_uses) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * toggle Check-in status for this registration
-     * Check-ins are toggled in the following order:
-     * never checked in -> checked in
-     * checked in -> checked out
-     * checked out -> checked in
-     *
-     * @param int  $DTT_ID  include specific datetime to toggle Check-in for.
-     *                      If not included or null, then it is assumed latest datetime is being toggled.
-     * @param bool $verify  If true then can_checkin() is used to verify whether the person
-     *                      can be checked in or not.  Otherwise this forces change in checkin status.
-     * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function toggle_checkin_status($DTT_ID = null, $verify = false)
-    {
-        if (empty($DTT_ID)) {
-            $datetime = $this->get_latest_related_datetime();
-            $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
-            // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
-                        'event_espresso'
-                    ),
-                    $this->ID(),
-                    $DTT_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $status_paths = [
-            EE_Checkin::status_checked_never => EE_Checkin::status_checked_in,
-            EE_Checkin::status_checked_in    => EE_Checkin::status_checked_out,
-            EE_Checkin::status_checked_out   => EE_Checkin::status_checked_in,
-        ];
-        // start by getting the current status so we know what status we'll be changing to.
-        $cur_status = $this->check_in_status_for_datetime($DTT_ID);
-        $status_to  = $status_paths[ $cur_status ];
-        // database only records true for checked IN or false for checked OUT
-        // no record ( null ) means checked in NEVER, but we obviously don't save that
-        $new_status = $status_to === EE_Checkin::status_checked_in;
-        // add relation - note Check-ins are always creating new rows
-        // because we are keeping track of Check-ins over time.
-        // Eventually we'll probably want to show a list table
-        // for the individual Check-ins so that they can be managed.
-        $checkin = EE_Checkin::new_instance(
-            [
-                'REG_ID' => $this->ID(),
-                'DTT_ID' => $DTT_ID,
-                'CHK_in' => $new_status,
-            ]
-        );
-        // if the record could not be saved then return false
-        if ($checkin->save() === 0) {
-            if (WP_DEBUG) {
-                global $wpdb;
-                $error = sprintf(
-                    esc_html__(
-                        'Registration check in update failed because of the following database error: %1$s%2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $wpdb->last_error
-                );
-            } else {
-                $error = esc_html__(
-                    'Registration check in update failed because of an unknown database error',
-                    'event_espresso'
-                );
-            }
-            EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // Fire a checked_in and checkout_out action.
-        $checked_status = $status_to === EE_Checkin::status_checked_in
-            ? 'checked_in'
-            : 'checked_out';
-        do_action("AHEE__EE_Registration__toggle_checkin_status__{$checked_status}", $this, $DTT_ID);
-        return $status_to;
-    }
-
-
-    /**
-     * Returns the latest datetime related to this registration (via the ticket attached to the registration).
-     * "Latest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Datetime|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_latest_related_datetime(): ?EE_Datetime
-    {
-        return EEM_Datetime::instance()->get_one(
-            [
-                [
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ],
-                'order_by' => ['DTT_EVT_start' => 'DESC'],
-            ]
-        );
-    }
-
-
-    /**
-     * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
-     * "Earliest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_earliest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            [
-                [
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ],
-                'order_by' => ['DTT_EVT_start' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     * This method simply returns the check-in status for this registration and the given datetime.
-     * If neither the datetime nor the checkin values are provided as arguments,
-     * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
-     *
-     * @param int|null        $DTT_ID  The ID of the datetime we're checking against
-     *                                 (if empty we'll get the primary datetime for
-     *                                 this registration (via event) and use it's ID);
-     * @param EE_Checkin|null $checkin If present, we use the given checkin object rather than the dtt_id.
-     * @return int                     Integer representing Check-in status.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function check_in_status_for_datetime(?int $DTT_ID = 0, ?EE_Checkin $checkin = null): int
-    {
-        if ($checkin instanceof EE_Checkin) {
-            return $checkin->status();
-        }
-
-        if (! $DTT_ID) {
-            return EE_Checkin::status_invalid;
-        }
-
-        $checkin_query_params = [
-            0          => ['DTT_ID' => $DTT_ID],
-            'order_by' => ['CHK_timestamp' => 'DESC'],
-        ];
-
-        $checkin = $this->get_first_related(
-            'Checkin',
-            $checkin_query_params
-        );
-        return $checkin instanceof EE_Checkin ? $checkin->status() : EE_Checkin::status_checked_never;
-    }
-
-
-    /**
-     * This method returns a localized message for the toggled Check-in message.
-     *
-     * @param int|null $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
-     *                         then it is assumed Check-in for primary datetime was toggled.
-     * @param bool     $error  This just flags that you want an error message returned. This is put in so that the error
-     *                         message can be customized with the attendee name.
-     * @return string internationalized message
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_checkin_msg(?int $DTT_ID, bool $error = false): string
-    {
-        // let's get the attendee first so we can include the name of the attendee
-        $attendee = $this->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            if ($error) {
-                return sprintf(
-                    esc_html__("%s's check-in status was not changed.", "event_espresso"),
-                    $attendee->full_name()
-                );
-            }
-            $cur_status = $this->check_in_status_for_datetime($DTT_ID);
-            // what is the status message going to be?
-            switch ($cur_status) {
-                case EE_Checkin::status_checked_never:
-                    return sprintf(
-                        esc_html__('%s has been removed from Check-in records', 'event_espresso'),
-                        $attendee->full_name()
-                    );
-                case EE_Checkin::status_checked_in:
-                    return sprintf(esc_html__('%s has been checked in', 'event_espresso'), $attendee->full_name());
-                case EE_Checkin::status_checked_out:
-                    return sprintf(esc_html__('%s has been checked out', 'event_espresso'), $attendee->full_name());
-            }
-        }
-        return esc_html__('The check-in status could not be determined.', 'event_espresso');
-    }
-
-
-    /**
-     * Returns the related EE_Transaction to this registration
-     *
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws ReflectionException
-     */
-    public function transaction(): EE_Transaction
-    {
-        $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
-            throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
-        }
-        return $transaction;
-    }
-
-
-    /**
-     * get Registration Code
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_code(): string
-    {
-        return $this->get('REG_code')
-            ?: '';
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function transaction_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     * Set Registration Code
-     *
-     * @param RegCode|string $REG_code Registration Code
-     * @param boolean        $use_default
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_code($REG_code, bool $use_default = false)
-    {
-        if (empty($REG_code)) {
-            EE_Error::add_error(
-                esc_html__('REG_code can not be empty.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-        if (! $this->reg_code()) {
-            parent::set('REG_code', $REG_code, $use_default);
-        } else {
-            EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
-                esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
-                '4.6.0'
-            );
-        }
-    }
-
-
-    /**
-     * Returns all other registrations in the same group as this registrant who have the same ticket option.
-     * Note, if you want to just get all registrations in the same transaction (group), use:
-     *    $registration->transaction()->registrations();
-     *
-     * @return EE_Registration[] or empty array if this isn't a group registration.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    public function get_all_other_registrations_in_group()
-    {
-        if ($this->group_size() < 2) {
-            return [];
-        }
-
-        $query[0] = [
-            'TXN_ID' => $this->transaction_ID(),
-            'REG_ID' => ['!=', $this->ID()],
-            'TKT_ID' => $this->ticket_ID(),
-        ];
-        /** @var EE_Registration[] $registrations */
-        $registrations = $this->get_model()->get_all($query);
-        return $registrations;
-    }
-
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page'    => 'espresso_registrations',
-                'action'  => 'view_registration',
-                '_REG_ID' => $this->ID(),
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page' => 'espresso_registrations',
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payments($query_params = [])
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Registration_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function registration_payments($query_params = [])
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
-     * Note: if there are no payments on the registration there will be no payment method returned.
-     *
-     * @return EE_Payment|EE_Payment_Method|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function payment_method()
-    {
-        return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
-    }
-
-
-    /**
-     * @return \EE_Line_Item
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_line_item()
-    {
-        $ticket            = $this->ticket();
-        $transaction       = $this->transaction();
-        $line_item         = null;
-        $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $transaction->total_line_item(),
-            'Ticket',
-            [$ticket->ID()]
-        );
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof \EE_Line_Item
-                && $ticket_line_item->OBJ_type() === 'Ticket'
-                && $ticket_line_item->OBJ_ID() === $ticket->ID()
-            ) {
-                $line_item = $ticket_line_item;
-                break;
-            }
-        }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
-            throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
-        }
-        return $line_item;
-    }
-
-
-    /**
-     * Soft Deletes this model object.
-     *
-     * @param string $source function name that called this method
-     * @return boolean | int
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function delete()
-    {
-        if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
-            $this->set_status(EEM_Registration::status_id_cancelled);
-        }
-        return parent::delete();
-    }
-
-
-    /**
-     * Restores whatever the previous status was on a registration before it was trashed (if possible)
-     *
-     * @param string $source function name that called this method
-     * @return bool|int
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function restore()
-    {
-        $previous_status = $this->get_extra_meta(
-            EE_Registration::PRE_TRASH_REG_STATUS_KEY,
-            true,
-            EEM_Registration::status_id_cancelled
-        );
-        if ($previous_status) {
-            $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
-            $this->set_status($previous_status);
-        }
-        return parent::restore();
-    }
-
-
-    /**
-     * possibly toggle Registration status based on comparison of REG_paid vs REG_final_price
-     *
-     * @param boolean $trigger_set_status_logic  EE_Registration::set_status() can trigger additional logic
-     *                                           depending on whether the reg status changes to or from "Approved"
-     * @return boolean whether the Registration status was updated
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function updateStatusBasedOnTotalPaid($trigger_set_status_logic = true)
-    {
-        $paid  = $this->paid();
-        $price = $this->final_price();
-        switch (true) {
-            // overpaid or paid
-            case EEH_Money::compare_floats($paid, $price, '>'):
-            case EEH_Money::compare_floats($paid, $price):
-                $new_status = EEM_Registration::status_id_approved;
-                break;
-            //  underpaid
-            case EEH_Money::compare_floats($paid, $price, '<'):
-                $new_status = EEM_Registration::status_id_pending_payment;
-                break;
-            // uhhh Houston...
-            default:
-                throw new RuntimeException(
-                    esc_html__('The total paid calculation for this registration is inaccurate.', 'event_espresso')
-                );
-        }
-        if ($new_status !== $this->status_ID()) {
-            if ($trigger_set_status_logic) {
-                return $this->set_status($new_status);
-            }
-            parent::set('STS_ID', $new_status);
-            return true;
-        }
-        return false;
-    }
-
-
-    /*************************** DEPRECATED ***************************/
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     */
-    public function price_paid()
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Registration::price_paid()',
-            esc_html__(
-                'This method is deprecated, please use EE_Registration::final_price() instead.',
-                'event_espresso'
-            ),
-            '4.7.0'
-        );
-        return $this->final_price();
-    }
-
-
-    /**
-     * @param float $REG_final_price
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws DomainException
-     * @deprecated
-     * @since     4.7.0
-     */
-    public function set_price_paid($REG_final_price = 0.00)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Registration::set_price_paid()',
-            esc_html__(
-                'This method is deprecated, please use EE_Registration::set_final_price() instead.',
-                'event_espresso'
-            ),
-            '4.7.0'
-        );
-        $this->set_final_price($REG_final_price);
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     * @since 4.7.0
-     */
-    public function pretty_price_paid()
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Registration::pretty_price_paid()',
-            esc_html__(
-                'This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
-                'event_espresso'
-            ),
-            '4.7.0'
-        );
-        return $this->pretty_final_price();
-    }
-
-
-    /**
-     * Gets the primary datetime related to this registration via the related Event to this registration
-     *
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated 4.9.17
-     */
-    public function get_related_primary_datetime()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
-                'event_espresso'
-            ),
-            '4.9.17',
-            '5.0.0'
-        );
-        return $this->event()->primary_datetime();
-    }
-
-
-    /**
-     * Returns the contact's name (or "Unknown" if there is no contact.)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    public function name()
-    {
-        return $this->attendeeName();
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wasMoved(): bool
-    {
-        // only need to check 'registration-moved-to' because
-        // the existence of a new REG ID means the registration was moved
-        $reg_moved = $this->get_extra_meta('registration-moved-to', true, []);
-        return isset($reg_moved['NEW_REG_ID']) && $reg_moved['NEW_REG_ID'];
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param float|null $amount
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.8.p
-     */
-    public function applyPayment(EE_Payment $payment, ?float $amount = null): float
-    {
-        // echo "\n\n";
-        // \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
-        // \EEH_Debug_Tools::printr($this->ID(), 'REG ID', __FILE__, __LINE__);
-        $payment_amount = $amount ?? $payment->amount();
-        // ensure $payment_amount is NOT negative
-        $payment_amount = (float) abs($payment_amount);
-        // \EEH_Debug_Tools::printr($payment_amount, 'incoming $payment_amount', __FILE__, __LINE__);
-        // \EEH_Debug_Tools::printr($this->final_price(), 'reg final price', __FILE__, __LINE__);
-        // \EEH_Debug_Tools::printr($this->paid(), 'reg paid to date', __FILE__, __LINE__);
-        $payment_amount = $payment->is_a_refund()
-            ? $this->processRefund($payment_amount)
-            : $this->processPayment($payment_amount);
-        // \EEH_Debug_Tools::printr($payment_amount, 'applied payment_amount', __FILE__, __LINE__);
-        if ($payment_amount) {
-            $reg_payment = EEM_Registration_Payment::instance()->get_one(
-                [['REG_ID' => $this->ID(), 'PAY_ID' => $payment->ID()]]
-            );
-            // if existing registration payment exists
-            if ($reg_payment instanceof EE_Registration_Payment) {
-                // echo "\nUPDATE EXISTING REG PAYMENT";
-                // then update that record
-                $reg_payment->set_amount($payment_amount);
-            } else {
-                // echo "\nCREATE NEW REG PAYMENT";
-                // or add new relation between registration and payment and set amount
-                $reg_payment = EE_Registration_Payment::new_instance(
-                    [
-                        'REG_ID'     => $this->ID(),
-                        'PAY_ID'     => $payment->ID(),
-                        'RPY_amount' => $payment_amount,
-                    ]
-                );
-                // $this->_add_relation_to($payment, 'Payment', ['RPY_amount' => $payment_amount]);
-            }
-            $reg_payment->save();
-            // \EEH_Debug_Tools::printr($reg_payment->ID(), '$reg payment ID', __FILE__, __LINE__);
-        }
-        return $payment_amount;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processPayment(float $payment_amount): float
-    {
-        // echo "\n";
-        // \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
-        $paid  = $this->paid();
-        $owing = $this->final_price() - $paid;
-        // \EEH_Debug_Tools::printr($owing, '$owing', __FILE__, __LINE__);
-        if ($owing <= 0) {
-            return 0.0;
-        }
-        // don't allow payment amount to exceed the incoming amount, OR the amount owing
-        $payment_amount = min($payment_amount, $owing);
-        $paid           = $paid + $payment_amount;
-        // \EEH_Debug_Tools::printr($paid, 'NEW REG PAID AMOUNT', __FILE__, __LINE__);
-        // calculate and set new REG_paid
-        $this->set_paid($paid);
-        // make it stick
-        $this->save();
-        return (float) $payment_amount;
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    private function processRefund(float $payment_amount): float
-    {
-        // echo "\n";
-        // \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
-        $paid = $this->paid();
-        if ($paid <= 0) {
-            return 0.0;
-        }
-        // don't allow refund amount to exceed the incoming amount, OR the amount paid
-        $payment_amount = min($payment_amount, $paid);
-        // calculate and set new REG_paid
-        $paid = $paid - $payment_amount;
-        // \EEH_Debug_Tools::printr($paid, 'NEW REG PAID AMOUNT', __FILE__, __LINE__);
-        $this->set_paid($paid);
-        // make it stick
-        $this->save();
-        // convert payment amount back to a negative value for storage in the db
-        return (float) $payment_amount;
-    }
+	/**
+	 * Used to reference when a registration has never been checked in.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_never instead
+	 * @type int
+	 */
+	const checkin_status_never = 2;
+
+	/**
+	 * Used to reference when a registration has been checked in.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_in instead
+	 * @type int
+	 */
+	const checkin_status_in = 1;
+
+	/**
+	 * Used to reference when a registration has been checked out.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_out instead
+	 * @type int
+	 */
+	const checkin_status_out = 0;
+
+	/**
+	 * extra meta key for tracking reg status os trashed registrations
+	 *
+	 * @type string
+	 */
+	const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
+
+	/**
+	 * extra meta key for tracking if registration has reserved ticket
+	 *
+	 * @type string
+	 */
+	const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = '', $date_formats = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object
+			?: new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Event ID
+	 *
+	 * @param int $EVT_ID Event ID
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_event($EVT_ID = 0)
+	{
+		$this->set('EVT_ID', $EVT_ID);
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
+	 * be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'REG_code':
+				if (! empty($field_value) && ! $this->reg_code()) {
+					$this->set_reg_code($field_value, $use_default);
+				}
+				break;
+			case 'STS_ID':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 * Set Status ID
+	 * updates the registration status and ALSO...
+	 * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
+	 * calls release_registration_space() if the reg status changes FROM approved to any other reg status
+	 *
+	 * @param string                $new_STS_ID
+	 * @param boolean               $use_default
+	 * @param ContextInterface|null $context
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_status($new_STS_ID = null, $use_default = false, ContextInterface $context = null)
+	{
+		// get current REG_Status
+		$old_STS_ID = $this->status_ID();
+		// if status has changed
+		if (
+			$old_STS_ID !== $new_STS_ID // and that status has actually changed
+			&& ! empty($old_STS_ID) // and that old status is actually set
+			&& ! empty($new_STS_ID) // as well as the new status
+			&& $this->ID() // ensure registration is in the db
+		) {
+			// update internal status first
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			// THEN handle other changes that occur when reg status changes
+			// TO approved
+			if ($new_STS_ID === EEM_Registration::status_id_approved) {
+				// reserve a space by incrementing ticket and datetime sold values
+				$this->reserveRegistrationSpace();
+				do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID, $context);
+				// OR FROM  approved
+			} elseif ($old_STS_ID === EEM_Registration::status_id_approved) {
+				// release a space by decrementing ticket and datetime sold values
+				$this->releaseRegistrationSpace();
+				do_action(
+					'AHEE__EE_Registration__set_status__from_approved',
+					$this,
+					$old_STS_ID,
+					$new_STS_ID,
+					$context
+				);
+			}
+			// update status
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			$this->updateIfCanceledOrReinstated($new_STS_ID, $old_STS_ID, $context);
+			if ($this->statusChangeUpdatesTransaction($context)) {
+				$this->updateTransactionAfterStatusChange();
+			}
+			do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID, $context);
+			return true;
+		}
+		// even though the old value matches the new value, it's still good to
+		// allow the parent set method to have a say
+		parent::set('STS_ID', $new_STS_ID, $use_default);
+		return true;
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param string                $new_STS_ID
+	 * @param string                $old_STS_ID
+	 * @param ContextInterface|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateIfCanceledOrReinstated($new_STS_ID, $old_STS_ID, ContextInterface $context = null)
+	{
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+		// true if registration has been cancelled or declined
+		$this->updateIfCanceled(
+			$closed_reg_statuses,
+			$new_STS_ID,
+			$old_STS_ID,
+			$context
+		);
+		$this->updateIfReinstated(
+			$closed_reg_statuses,
+			$new_STS_ID,
+			$old_STS_ID,
+			$context
+		);
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param array                 $closed_reg_statuses
+	 * @param string                $new_STS_ID
+	 * @param string                $old_STS_ID
+	 * @param ContextInterface|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateIfCanceled(
+		array $closed_reg_statuses,
+		$new_STS_ID,
+		$old_STS_ID,
+		ContextInterface $context = null
+	) {
+		// true if registration has been cancelled or declined
+		if (
+			in_array($new_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($old_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// cancelled or declined registration
+			$registration_processor->update_registration_after_being_canceled_or_declined(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_canceled_or_declined_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action(
+				'AHEE__EE_Registration__set_status__canceled_or_declined',
+				$this,
+				$old_STS_ID,
+				$new_STS_ID,
+				$context
+			);
+			return;
+		}
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param array                 $closed_reg_statuses
+	 * @param string                $new_STS_ID
+	 * @param string                $old_STS_ID
+	 * @param ContextInterface|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateIfReinstated(
+		array $closed_reg_statuses,
+		$new_STS_ID,
+		$old_STS_ID,
+		ContextInterface $context = null
+	) {
+		// true if reinstating cancelled or declined registration
+		if (
+			in_array($old_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($new_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// reinstating cancelled or declined registration
+			$registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_reinstating_canceled_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action(
+				'AHEE__EE_Registration__set_status__after_reinstated',
+				$this,
+				$old_STS_ID,
+				$new_STS_ID,
+				$context
+			);
+		}
+	}
+
+
+	/**
+	 * @param ContextInterface|null $context
+	 * @return bool
+	 */
+	private function statusChangeUpdatesTransaction(ContextInterface $context = null)
+	{
+		$contexts_that_do_not_update_transaction = (array) apply_filters(
+			'AHEE__EE_Registration__statusChangeUpdatesTransaction__contexts_that_do_not_update_transaction',
+			['spco_reg_step_attendee_information_process_registrations'],
+			$context,
+			$this
+		);
+		return ! (
+			$context instanceof ContextInterface
+			&& in_array($context->slug(), $contexts_that_do_not_update_transaction, true)
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateTransactionAfterStatusChange()
+	{
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+		$transaction_payments->recalculate_transaction_total($this->transaction(), false);
+		$this->transaction()->update_status_based_on_total_paid();
+	}
+
+
+	/**
+	 * get Status ID
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Gets the ticket this registration is for
+	 *
+	 * @param boolean $include_archived whether to include archived tickets or not.
+	 * @return EE_Ticket|EE_Base_Class
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket($include_archived = true)
+	{
+		$query_params = [];
+		if ($include_archived) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $this->get_first_related('Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets the event this registration is for
+	 *
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function event(): EE_Event
+	{
+		$event = $this->get_first_related('Event');
+		if (! $event instanceof EE_Event) {
+			throw new EntityNotFoundException('Event ID', $this->event_ID());
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
+	 * with the author of the event this registration is for.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	public function wp_user(): int
+	{
+		return $this->event()->wp_user();
+	}
+
+
+	/**
+	 * increments this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	private function reserveRegistrationSpace()
+	{
+		// reserved ticket and datetime counts will be decremented as sold counts are incremented
+		// so stop tracking that this reg has a ticket reserved
+		$this->release_reserved_ticket(false, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+		$ticket = $this->ticket();
+		$ticket->increaseSold();
+		// possibly set event status to sold out
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	private function releaseRegistrationSpace()
+	{
+		$ticket = $this->ticket();
+		$ticket->decreaseSold();
+		// possibly change event status from sold out back to previous status
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * tracks this registration's ticket reservation in extra meta
+	 * and can increment related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool   $update_ticket if true, will increment ticket and datetime reserved count
+	 * @param string $source
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reserve_ticket($update_ticket = false, $source = 'unknown')
+	{
+		// only reserve ticket if space is not currently reserved
+		if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) !== true) {
+			$reserved = $this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
+			if ($reserved && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->increaseReserved(1, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+				$this->update_extra_meta('reserve_ticket', "{$this->ticket_ID()} from {$source}");
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * stops tracking this registration's ticket reservation in extra meta
+	 * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool   $update_ticket if true, will decrement ticket and datetime reserved count
+	 * @param string $source
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function release_reserved_ticket($update_ticket = false, $source = 'unknown')
+	{
+		// only release ticket if space is currently reserved
+		if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) === true) {
+			$reserved = $this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, false);
+			if ($reserved && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+				$this->update_extra_meta('release_reserved_ticket', "{$this->ticket_ID()} from {$source}");
+			}
+		}
+	}
+
+
+	/**
+	 * Set Attendee ID
+	 *
+	 * @param int $ATT_ID Attendee ID
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_attendee_id($ATT_ID = 0)
+	{
+		$this->set('ATT_ID', $ATT_ID);
+	}
+
+
+	/**
+	 *        Set Transaction ID
+	 *
+	 * @param int $TXN_ID Transaction ID
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 *        Set Session
+	 *
+	 * @param string $REG_session PHP Session ID
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_session($REG_session = '')
+	{
+		$this->set('REG_session', $REG_session);
+	}
+
+
+	/**
+	 *        Set Registration URL Link
+	 *
+	 * @param string $REG_url_link Registration URL Link
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_reg_url_link($REG_url_link = '')
+	{
+		$this->set('REG_url_link', $REG_url_link);
+	}
+
+
+	/**
+	 *        Set Attendee Counter
+	 *
+	 * @param int $REG_count Primary Attendee
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_count($REG_count = 1)
+	{
+		$this->set('REG_count', $REG_count);
+	}
+
+
+	/**
+	 *        Set Group Size
+	 *
+	 * @param boolean $REG_group_size Group Registration
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_group_size($REG_group_size = false)
+	{
+		$this->set('REG_group_size', $REG_group_size);
+	}
+
+
+	/**
+	 *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_not_approved
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_not_approved()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_not_approved;
+	}
+
+
+	/**
+	 *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_pending_payment
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_pending_payment()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_pending_payment;
+	}
+
+
+	/**
+	 *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_approved()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_approved;
+	}
+
+
+	/**
+	 *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_cancelled;
+	}
+
+
+	/**
+	 *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_declined()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_declined;
+	}
+
+
+	/**
+	 *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_incomplete
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_incomplete;
+	}
+
+
+	/**
+	 *        Set Registration Date
+	 *
+	 * @param mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
+	 *                                                 Date
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_reg_date($REG_date = false)
+	{
+		$this->set('REG_date', $REG_date);
+	}
+
+
+	/**
+	 *    Set final price owing for this registration after all ticket/price modifications
+	 *
+	 * @param float $REG_final_price
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_final_price($REG_final_price = 0.00)
+	{
+		$this->set('REG_final_price', $REG_final_price);
+	}
+
+
+	/**
+	 *    Set amount paid towards this registration's final price
+	 *
+	 * @param float|int|string $REG_paid
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_paid($REG_paid = 0.00)
+	{
+		$this->set('REG_paid', (float) $REG_paid);
+	}
+
+
+	/**
+	 *        Attendee Is Going
+	 *
+	 * @param boolean $REG_att_is_going Attendee Is Going
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_att_is_going($REG_att_is_going = false)
+	{
+		$this->set('REG_att_is_going', $REG_att_is_going);
+	}
+
+
+	/**
+	 * Gets the related attendee
+	 *
+	 * @return EE_Attendee|EE_Base_Class
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function attendee()
+	{
+		return $this->get_first_related('Attendee');
+	}
+
+
+	/**
+	 * Gets the name of the attendee.
+	 *
+	 * @param bool $apply_html_entities set to true if you want to use HTML entities.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	public function attendeeName($apply_html_entities = false)
+	{
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			$attendee_name = $attendee->full_name($apply_html_entities);
+		} else {
+			$attendee_name = esc_html__('Unknown', 'event_espresso');
+		}
+		return $attendee_name;
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_ID()
+	{
+		return $this->get('EVT_ID');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_name()
+	{
+		$event = $this->event_obj();
+		if ($event) {
+			return $event->name();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Fetches the event this registration is for
+	 *
+	 * @return EE_Base_Class|EE_Event
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function event_obj()
+	{
+		return $this->get_first_related('Event');
+	}
+
+
+	/**
+	 *        get Attendee ID
+	 */
+	public function attendee_ID()
+	{
+		return $this->get('ATT_ID');
+	}
+
+
+	/**
+	 *        get PHP Session ID
+	 */
+	public function session_ID()
+	{
+		return $this->get('REG_session');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the receipt template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function receipt_url($messenger = 'html')
+	{
+		return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the invoice template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function invoice_url($messenger = 'html')
+	{
+		return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
+	}
+
+
+	/**
+	 * get Registration URL Link
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_url_link()
+	{
+		return (string) $this->get('REG_url_link');
+	}
+
+
+	/**
+	 * Echoes out invoice_url()
+	 *
+	 * @param string $type 'download','launch', or 'html' (default is 'launch')
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function e_invoice_url($type = 'launch')
+	{
+		echo esc_url_raw($this->invoice_url($type));
+	}
+
+
+	/**
+	 * Echoes out payment_overview_url
+	 */
+	public function e_payment_overview_url()
+	{
+		echo esc_url_raw($this->payment_overview_url());
+	}
+
+
+	/**
+	 * Gets the URL for the checkout payment options reg step
+	 * with this registration's REG_url_link added as a query parameter
+	 *
+	 * @param bool $clear_session Set to true when you want to clear the session on revisiting the
+	 *                            payment overview url.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_overview_url($clear_session = false)
+	{
+		return add_query_arg(
+			(array) apply_filters(
+				'FHEE__EE_Registration__payment_overview_url__query_args',
+				[
+					'e_reg_url_link' => $this->reg_url_link(),
+					'step'           => 'payment_options',
+					'revisit'        => true,
+					'clear_session'  => (bool) $clear_session,
+				],
+				$this
+			),
+			EE_Registry::instance()->CFG->core->reg_page_url()
+		);
+	}
+
+
+	/**
+	 * Gets the URL for the checkout attendee information reg step
+	 * with this registration's REG_url_link added as a query parameter
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function edit_attendee_information_url()
+	{
+		return add_query_arg(
+			(array) apply_filters(
+				'FHEE__EE_Registration__edit_attendee_information_url__query_args',
+				[
+					'e_reg_url_link' => $this->reg_url_link(),
+					'step'           => 'attendee_information',
+					'revisit'        => true,
+				],
+				$this
+			),
+			EE_Registry::instance()->CFG->core->reg_page_url()
+		);
+	}
+
+
+	/**
+	 * Simply generates and returns the appropriate admin_url link to edit this registration
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_edit_url()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page'    => 'espresso_registrations',
+				'action'  => 'view_registration',
+				'_REG_ID' => $this->ID(),
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * is_primary_registrant?
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_primary_registrant()
+	{
+		return (int) $this->get('REG_count') === 1;
+	}
+
+
+	/**
+	 * This returns the primary registration object for this registration group (which may be this object).
+	 *
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->is_primary_registrant()) {
+			return $this;
+		}
+
+		// k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
+		/** @var EE_Registration $primary_registrant */
+		$primary_registrant = EEM_Registration::instance()->get_one(
+			[
+				[
+					'TXN_ID'    => $this->transaction_ID(),
+					'REG_count' => 1,
+				],
+			]
+		);
+		return $primary_registrant;
+	}
+
+
+	/**
+	 * get  Attendee Number
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function count()
+	{
+		return $this->get('REG_count');
+	}
+
+
+	/**
+	 * get Group Size
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function group_size()
+	{
+		return $this->get('REG_group_size');
+	}
+
+
+	/**
+	 * get Registration Date
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function date()
+	{
+		return $this->get('REG_date');
+	}
+
+
+	/**
+	 * gets a pretty date
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_date($date_format = null, $time_format = null)
+	{
+		return $this->get_datetime('REG_date', $date_format, $time_format);
+	}
+
+
+	/**
+	 * final_price
+	 * the registration's share of the transaction total, so that the
+	 * sum of all the transaction's REG_final_prices equal the transaction's total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function final_price(): float
+	{
+		return (float) $this->get('REG_final_price');
+	}
+
+
+	/**
+	 * pretty_final_price
+	 *  final price as formatted string, with correct decimal places and currency symbol
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_final_price()
+	{
+		return $this->get_pretty('REG_final_price');
+	}
+
+
+	/**
+	 * get paid (yeah)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function paid(): float
+	{
+		return (float) $this->get('REG_paid');
+	}
+
+
+	/**
+	 * pretty_paid
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_paid()
+	{
+		return $this->get_pretty('REG_paid');
+	}
+
+
+	/**
+	 * owes_monies_and_can_pay
+	 * whether or not this registration has monies owing and it's' status allows payment
+	 *
+	 * @param array $requires_payment list of registration statuses that allow a registrant to make a payment
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function owes_monies_and_can_pay($requires_payment = [])
+	{
+		// these reg statuses require payment (if event is not free)
+		$requires_payment = ! empty($requires_payment)
+			? $requires_payment
+			: EEM_Registration::reg_statuses_that_allow_payment();
+		if (
+			$this->final_price() !== 0 &&
+			$this->final_price() !== $this->paid() &&
+			in_array($this->status_ID(), $requires_payment)
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Prints out the return value of $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
+	}
+
+
+	/**
+	 * Returns a nice version of the status for displaying to customers
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			[$this->status_ID() => esc_html__('unknown', 'event_espresso')],
+			false,
+			'sentence'
+		);
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Registration::status_id_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_pending_payment:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_not_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_cancelled:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_incomplete:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_declined:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_wait_list:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[ $this->status_ID() ];
+	}
+
+
+	/**
+	 *        get Attendee Is Going
+	 */
+	public function att_is_going()
+	{
+		return $this->get('REG_att_is_going');
+	}
+
+
+	/**
+	 * Gets related answers
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Answer[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function answers($query_params = [])
+	{
+		return $this->get_many_related('Answer', $query_params);
+	}
+
+
+	/**
+	 * Gets the registration's answer value to the specified question
+	 * (either the question's ID or a question object)
+	 *
+	 * @param EE_Question|int $question
+	 * @param bool            $pretty_value
+	 * @return array|string if pretty_value= true, the result will always be a string
+	 * (because the answer might be an array of answer values, so passing pretty_value=true
+	 * will convert it into some kind of string)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function answer_value_to_question($question, $pretty_value = true)
+	{
+		$question_id = EEM_Question::instance()->ensure_is_ID($question);
+		return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
+	}
+
+
+	/**
+	 * question_groups
+	 * returns an array of EE_Question_Group objects for this registration
+	 *
+	 * @return EE_Question_Group[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function question_groups()
+	{
+		return EEM_Event::instance()->get_question_groups_for_event($this->event_ID(), $this);
+	}
+
+
+	/**
+	 * count_question_groups
+	 * returns a count of the number of EE_Question_Group objects for this registration
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function count_question_groups()
+	{
+		return EEM_Event::instance()->count_related(
+			$this->event_ID(),
+			'Question_Group',
+			[
+				[
+					'Event_Question_Group.'
+					. EEM_Event_Question_Group::instance()->fieldNameForContext($this->is_primary_registrant()) => true,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Returns the registration date in the 'standard' string format
+	 * (function may be improved in the future to allow for different formats and timezones)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_date()
+	{
+		return $this->get_datetime('REG_date');
+	}
+
+
+	/**
+	 * Gets the datetime-ticket for this registration (ie, it can be used to isolate
+	 * the ticket this registration purchased, or the datetime they have registered
+	 * to attend)
+	 *
+	 * @return EE_Base_Class|EE_Datetime_Ticket
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function datetime_ticket()
+	{
+		return $this->get_first_related('Datetime_Ticket');
+	}
+
+
+	/**
+	 * Sets the registration's datetime_ticket.
+	 *
+	 * @param EE_Datetime_Ticket $datetime_ticket
+	 * @return EE_Base_Class|EE_Datetime_Ticket
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_datetime_ticket($datetime_ticket)
+	{
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
+	}
+
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function deleted()
+	{
+		return $this->get('REG_deleted');
+	}
+
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_deleted($deleted)
+	{
+		if ($deleted) {
+			$this->delete();
+		} else {
+			$this->restore();
+		}
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Base_Class|EE_Status
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Returns the number of times this registration has checked into any of the datetimes
+	 * its available for
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function count_checkins()
+	{
+		return $this->get_model()->count_related($this, 'Checkin');
+	}
+
+
+	/**
+	 * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
+	 * registration is for.  Note, this is ONLY checked in (does not include checkedout)
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function count_checkins_not_checkedout()
+	{
+		return $this->get_model()->count_related($this, 'Checkin', [['CHK_in' => 1]]);
+	}
+
+
+	/**
+	 * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
+	 * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
+	 *                                          consider registration status as well as datetime access.
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function can_checkin($DTT_OR_ID, $check_approved = true)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+		// first check registration status
+		if (! $DTT_ID || ($check_approved && ! $this->is_approved())) {
+			return false;
+		}
+		// is there a datetime ticket that matches this dtt_ID?
+		if (
+			! (EEM_Datetime_Ticket::instance()->exists(
+				[
+					[
+						'TKT_ID' => $this->get('TKT_ID'),
+						'DTT_ID' => $DTT_ID,
+					],
+				]
+			))
+		) {
+			return false;
+		}
+
+		// final check is against TKT_uses
+		return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
+	}
+
+
+	/**
+	 * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
+	 * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
+	 * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
+	 * then return false.  Otherwise return true.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
+	 * @return bool true means can checkin.  false means cannot checkin.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		if (! $DTT_ID) {
+			return false;
+		}
+
+		$max_uses = $this->ticket() instanceof EE_Ticket
+			? $this->ticket()->uses()
+			: EE_INF;
+
+		// if max uses is not set or equals infinity then return true cause its not a factor for whether user can
+		// check-in or not.
+		if (! $max_uses || $max_uses === EE_INF) {
+			return true;
+		}
+
+		// does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
+		// go ahead and toggle.
+		if (EEM_Checkin::instance()->exists([['REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID]])) {
+			return true;
+		}
+
+		// made it here so the last check is whether the number of checkins per unique datetime on this registration
+		// disallows further check-ins.
+		$count_unique_dtt_checkins = EEM_Checkin::instance()->count(
+			[
+				[
+					'REG_ID' => $this->ID(),
+					'CHK_in' => true,
+				],
+			],
+			'DTT_ID',
+			true
+		);
+		// checkins have already reached their max number of uses
+		// so registrant can NOT checkin
+		if ($count_unique_dtt_checkins >= $max_uses) {
+			EE_Error::add_error(
+				esc_html__(
+					'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * toggle Check-in status for this registration
+	 * Check-ins are toggled in the following order:
+	 * never checked in -> checked in
+	 * checked in -> checked out
+	 * checked out -> checked in
+	 *
+	 * @param int  $DTT_ID  include specific datetime to toggle Check-in for.
+	 *                      If not included or null, then it is assumed latest datetime is being toggled.
+	 * @param bool $verify  If true then can_checkin() is used to verify whether the person
+	 *                      can be checked in or not.  Otherwise this forces change in checkin status.
+	 * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function toggle_checkin_status($DTT_ID = null, $verify = false)
+	{
+		if (empty($DTT_ID)) {
+			$datetime = $this->get_latest_related_datetime();
+			$DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
+			// verify the registration can checkin for the given DTT_ID
+		} elseif (! $this->can_checkin($DTT_ID, $verify)) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
+						'event_espresso'
+					),
+					$this->ID(),
+					$DTT_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$status_paths = [
+			EE_Checkin::status_checked_never => EE_Checkin::status_checked_in,
+			EE_Checkin::status_checked_in    => EE_Checkin::status_checked_out,
+			EE_Checkin::status_checked_out   => EE_Checkin::status_checked_in,
+		];
+		// start by getting the current status so we know what status we'll be changing to.
+		$cur_status = $this->check_in_status_for_datetime($DTT_ID);
+		$status_to  = $status_paths[ $cur_status ];
+		// database only records true for checked IN or false for checked OUT
+		// no record ( null ) means checked in NEVER, but we obviously don't save that
+		$new_status = $status_to === EE_Checkin::status_checked_in;
+		// add relation - note Check-ins are always creating new rows
+		// because we are keeping track of Check-ins over time.
+		// Eventually we'll probably want to show a list table
+		// for the individual Check-ins so that they can be managed.
+		$checkin = EE_Checkin::new_instance(
+			[
+				'REG_ID' => $this->ID(),
+				'DTT_ID' => $DTT_ID,
+				'CHK_in' => $new_status,
+			]
+		);
+		// if the record could not be saved then return false
+		if ($checkin->save() === 0) {
+			if (WP_DEBUG) {
+				global $wpdb;
+				$error = sprintf(
+					esc_html__(
+						'Registration check in update failed because of the following database error: %1$s%2$s',
+						'event_espresso'
+					),
+					'<br />',
+					$wpdb->last_error
+				);
+			} else {
+				$error = esc_html__(
+					'Registration check in update failed because of an unknown database error',
+					'event_espresso'
+				);
+			}
+			EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// Fire a checked_in and checkout_out action.
+		$checked_status = $status_to === EE_Checkin::status_checked_in
+			? 'checked_in'
+			: 'checked_out';
+		do_action("AHEE__EE_Registration__toggle_checkin_status__{$checked_status}", $this, $DTT_ID);
+		return $status_to;
+	}
+
+
+	/**
+	 * Returns the latest datetime related to this registration (via the ticket attached to the registration).
+	 * "Latest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Datetime|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_latest_related_datetime(): ?EE_Datetime
+	{
+		return EEM_Datetime::instance()->get_one(
+			[
+				[
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				],
+				'order_by' => ['DTT_EVT_start' => 'DESC'],
+			]
+		);
+	}
+
+
+	/**
+	 * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
+	 * "Earliest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_earliest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			[
+				[
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				],
+				'order_by' => ['DTT_EVT_start' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 * This method simply returns the check-in status for this registration and the given datetime.
+	 * If neither the datetime nor the checkin values are provided as arguments,
+	 * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
+	 *
+	 * @param int|null        $DTT_ID  The ID of the datetime we're checking against
+	 *                                 (if empty we'll get the primary datetime for
+	 *                                 this registration (via event) and use it's ID);
+	 * @param EE_Checkin|null $checkin If present, we use the given checkin object rather than the dtt_id.
+	 * @return int                     Integer representing Check-in status.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function check_in_status_for_datetime(?int $DTT_ID = 0, ?EE_Checkin $checkin = null): int
+	{
+		if ($checkin instanceof EE_Checkin) {
+			return $checkin->status();
+		}
+
+		if (! $DTT_ID) {
+			return EE_Checkin::status_invalid;
+		}
+
+		$checkin_query_params = [
+			0          => ['DTT_ID' => $DTT_ID],
+			'order_by' => ['CHK_timestamp' => 'DESC'],
+		];
+
+		$checkin = $this->get_first_related(
+			'Checkin',
+			$checkin_query_params
+		);
+		return $checkin instanceof EE_Checkin ? $checkin->status() : EE_Checkin::status_checked_never;
+	}
+
+
+	/**
+	 * This method returns a localized message for the toggled Check-in message.
+	 *
+	 * @param int|null $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
+	 *                         then it is assumed Check-in for primary datetime was toggled.
+	 * @param bool     $error  This just flags that you want an error message returned. This is put in so that the error
+	 *                         message can be customized with the attendee name.
+	 * @return string internationalized message
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_checkin_msg(?int $DTT_ID, bool $error = false): string
+	{
+		// let's get the attendee first so we can include the name of the attendee
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			if ($error) {
+				return sprintf(
+					esc_html__("%s's check-in status was not changed.", "event_espresso"),
+					$attendee->full_name()
+				);
+			}
+			$cur_status = $this->check_in_status_for_datetime($DTT_ID);
+			// what is the status message going to be?
+			switch ($cur_status) {
+				case EE_Checkin::status_checked_never:
+					return sprintf(
+						esc_html__('%s has been removed from Check-in records', 'event_espresso'),
+						$attendee->full_name()
+					);
+				case EE_Checkin::status_checked_in:
+					return sprintf(esc_html__('%s has been checked in', 'event_espresso'), $attendee->full_name());
+				case EE_Checkin::status_checked_out:
+					return sprintf(esc_html__('%s has been checked out', 'event_espresso'), $attendee->full_name());
+			}
+		}
+		return esc_html__('The check-in status could not be determined.', 'event_espresso');
+	}
+
+
+	/**
+	 * Returns the related EE_Transaction to this registration
+	 *
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws ReflectionException
+	 */
+	public function transaction(): EE_Transaction
+	{
+		$transaction = $this->get_first_related('Transaction');
+		if (! $transaction instanceof \EE_Transaction) {
+			throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 * get Registration Code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_code(): string
+	{
+		return $this->get('REG_code')
+			?: '';
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function transaction_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 * Set Registration Code
+	 *
+	 * @param RegCode|string $REG_code Registration Code
+	 * @param boolean        $use_default
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_code($REG_code, bool $use_default = false)
+	{
+		if (empty($REG_code)) {
+			EE_Error::add_error(
+				esc_html__('REG_code can not be empty.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+		if (! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
+		} else {
+			EE_Error::doing_it_wrong(
+				__CLASS__ . '::' . __FUNCTION__,
+				esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
+				'4.6.0'
+			);
+		}
+	}
+
+
+	/**
+	 * Returns all other registrations in the same group as this registrant who have the same ticket option.
+	 * Note, if you want to just get all registrations in the same transaction (group), use:
+	 *    $registration->transaction()->registrations();
+	 *
+	 * @return EE_Registration[] or empty array if this isn't a group registration.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	public function get_all_other_registrations_in_group()
+	{
+		if ($this->group_size() < 2) {
+			return [];
+		}
+
+		$query[0] = [
+			'TXN_ID' => $this->transaction_ID(),
+			'REG_ID' => ['!=', $this->ID()],
+			'TKT_ID' => $this->ticket_ID(),
+		];
+		/** @var EE_Registration[] $registrations */
+		$registrations = $this->get_model()->get_all($query);
+		return $registrations;
+	}
+
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page'    => 'espresso_registrations',
+				'action'  => 'view_registration',
+				'_REG_ID' => $this->ID(),
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page' => 'espresso_registrations',
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payments($query_params = [])
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Registration_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function registration_payments($query_params = [])
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
+	 * Note: if there are no payments on the registration there will be no payment method returned.
+	 *
+	 * @return EE_Payment|EE_Payment_Method|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function payment_method()
+	{
+		return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
+	}
+
+
+	/**
+	 * @return \EE_Line_Item
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_line_item()
+	{
+		$ticket            = $this->ticket();
+		$transaction       = $this->transaction();
+		$line_item         = null;
+		$ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$transaction->total_line_item(),
+			'Ticket',
+			[$ticket->ID()]
+		);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof \EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === 'Ticket'
+				&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+			) {
+				$line_item = $ticket_line_item;
+				break;
+			}
+		}
+		if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+			throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
+		}
+		return $line_item;
+	}
+
+
+	/**
+	 * Soft Deletes this model object.
+	 *
+	 * @param string $source function name that called this method
+	 * @return boolean | int
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function delete()
+	{
+		if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+			$this->set_status(EEM_Registration::status_id_cancelled);
+		}
+		return parent::delete();
+	}
+
+
+	/**
+	 * Restores whatever the previous status was on a registration before it was trashed (if possible)
+	 *
+	 * @param string $source function name that called this method
+	 * @return bool|int
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function restore()
+	{
+		$previous_status = $this->get_extra_meta(
+			EE_Registration::PRE_TRASH_REG_STATUS_KEY,
+			true,
+			EEM_Registration::status_id_cancelled
+		);
+		if ($previous_status) {
+			$this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
+			$this->set_status($previous_status);
+		}
+		return parent::restore();
+	}
+
+
+	/**
+	 * possibly toggle Registration status based on comparison of REG_paid vs REG_final_price
+	 *
+	 * @param boolean $trigger_set_status_logic  EE_Registration::set_status() can trigger additional logic
+	 *                                           depending on whether the reg status changes to or from "Approved"
+	 * @return boolean whether the Registration status was updated
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function updateStatusBasedOnTotalPaid($trigger_set_status_logic = true)
+	{
+		$paid  = $this->paid();
+		$price = $this->final_price();
+		switch (true) {
+			// overpaid or paid
+			case EEH_Money::compare_floats($paid, $price, '>'):
+			case EEH_Money::compare_floats($paid, $price):
+				$new_status = EEM_Registration::status_id_approved;
+				break;
+			//  underpaid
+			case EEH_Money::compare_floats($paid, $price, '<'):
+				$new_status = EEM_Registration::status_id_pending_payment;
+				break;
+			// uhhh Houston...
+			default:
+				throw new RuntimeException(
+					esc_html__('The total paid calculation for this registration is inaccurate.', 'event_espresso')
+				);
+		}
+		if ($new_status !== $this->status_ID()) {
+			if ($trigger_set_status_logic) {
+				return $this->set_status($new_status);
+			}
+			parent::set('STS_ID', $new_status);
+			return true;
+		}
+		return false;
+	}
+
+
+	/*************************** DEPRECATED ***************************/
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 */
+	public function price_paid()
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Registration::price_paid()',
+			esc_html__(
+				'This method is deprecated, please use EE_Registration::final_price() instead.',
+				'event_espresso'
+			),
+			'4.7.0'
+		);
+		return $this->final_price();
+	}
+
+
+	/**
+	 * @param float $REG_final_price
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws DomainException
+	 * @deprecated
+	 * @since     4.7.0
+	 */
+	public function set_price_paid($REG_final_price = 0.00)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Registration::set_price_paid()',
+			esc_html__(
+				'This method is deprecated, please use EE_Registration::set_final_price() instead.',
+				'event_espresso'
+			),
+			'4.7.0'
+		);
+		$this->set_final_price($REG_final_price);
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 * @since 4.7.0
+	 */
+	public function pretty_price_paid()
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Registration::pretty_price_paid()',
+			esc_html__(
+				'This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
+				'event_espresso'
+			),
+			'4.7.0'
+		);
+		return $this->pretty_final_price();
+	}
+
+
+	/**
+	 * Gets the primary datetime related to this registration via the related Event to this registration
+	 *
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated 4.9.17
+	 */
+	public function get_related_primary_datetime()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
+				'event_espresso'
+			),
+			'4.9.17',
+			'5.0.0'
+		);
+		return $this->event()->primary_datetime();
+	}
+
+
+	/**
+	 * Returns the contact's name (or "Unknown" if there is no contact.)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	public function name()
+	{
+		return $this->attendeeName();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wasMoved(): bool
+	{
+		// only need to check 'registration-moved-to' because
+		// the existence of a new REG ID means the registration was moved
+		$reg_moved = $this->get_extra_meta('registration-moved-to', true, []);
+		return isset($reg_moved['NEW_REG_ID']) && $reg_moved['NEW_REG_ID'];
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param float|null $amount
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.8.p
+	 */
+	public function applyPayment(EE_Payment $payment, ?float $amount = null): float
+	{
+		// echo "\n\n";
+		// \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
+		// \EEH_Debug_Tools::printr($this->ID(), 'REG ID', __FILE__, __LINE__);
+		$payment_amount = $amount ?? $payment->amount();
+		// ensure $payment_amount is NOT negative
+		$payment_amount = (float) abs($payment_amount);
+		// \EEH_Debug_Tools::printr($payment_amount, 'incoming $payment_amount', __FILE__, __LINE__);
+		// \EEH_Debug_Tools::printr($this->final_price(), 'reg final price', __FILE__, __LINE__);
+		// \EEH_Debug_Tools::printr($this->paid(), 'reg paid to date', __FILE__, __LINE__);
+		$payment_amount = $payment->is_a_refund()
+			? $this->processRefund($payment_amount)
+			: $this->processPayment($payment_amount);
+		// \EEH_Debug_Tools::printr($payment_amount, 'applied payment_amount', __FILE__, __LINE__);
+		if ($payment_amount) {
+			$reg_payment = EEM_Registration_Payment::instance()->get_one(
+				[['REG_ID' => $this->ID(), 'PAY_ID' => $payment->ID()]]
+			);
+			// if existing registration payment exists
+			if ($reg_payment instanceof EE_Registration_Payment) {
+				// echo "\nUPDATE EXISTING REG PAYMENT";
+				// then update that record
+				$reg_payment->set_amount($payment_amount);
+			} else {
+				// echo "\nCREATE NEW REG PAYMENT";
+				// or add new relation between registration and payment and set amount
+				$reg_payment = EE_Registration_Payment::new_instance(
+					[
+						'REG_ID'     => $this->ID(),
+						'PAY_ID'     => $payment->ID(),
+						'RPY_amount' => $payment_amount,
+					]
+				);
+				// $this->_add_relation_to($payment, 'Payment', ['RPY_amount' => $payment_amount]);
+			}
+			$reg_payment->save();
+			// \EEH_Debug_Tools::printr($reg_payment->ID(), '$reg payment ID', __FILE__, __LINE__);
+		}
+		return $payment_amount;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processPayment(float $payment_amount): float
+	{
+		// echo "\n";
+		// \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
+		$paid  = $this->paid();
+		$owing = $this->final_price() - $paid;
+		// \EEH_Debug_Tools::printr($owing, '$owing', __FILE__, __LINE__);
+		if ($owing <= 0) {
+			return 0.0;
+		}
+		// don't allow payment amount to exceed the incoming amount, OR the amount owing
+		$payment_amount = min($payment_amount, $owing);
+		$paid           = $paid + $payment_amount;
+		// \EEH_Debug_Tools::printr($paid, 'NEW REG PAID AMOUNT', __FILE__, __LINE__);
+		// calculate and set new REG_paid
+		$this->set_paid($paid);
+		// make it stick
+		$this->save();
+		return (float) $payment_amount;
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	private function processRefund(float $payment_amount): float
+	{
+		// echo "\n";
+		// \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
+		$paid = $this->paid();
+		if ($paid <= 0) {
+			return 0.0;
+		}
+		// don't allow refund amount to exceed the incoming amount, OR the amount paid
+		$payment_amount = min($payment_amount, $paid);
+		// calculate and set new REG_paid
+		$paid = $paid - $payment_amount;
+		// \EEH_Debug_Tools::printr($paid, 'NEW REG PAID AMOUNT', __FILE__, __LINE__);
+		$this->set_paid($paid);
+		// make it stick
+		$this->save();
+		// convert payment amount back to a negative value for storage in the db
+		return (float) $payment_amount;
+	}
 }

core/db_classes/EE_Question_Form_Input.class.php

Indentation +371 added lines, -371 removed lines

@@ -15,375 +15,375 @@
  */
 class EE_Question_Form_Input
 {
-    protected RequestInterface $request;
-
-    protected array $form_data;
-
-    private ?EE_Question $_QST = null;
-
-
-    private ?EE_Answer $_ANS = null;
-
-    /**
-     * $_QST_meta
-     * @var array
-     */
-    private array $_QST_meta = [];
-
-    /**
-     * $QST_input_name
-     * @var string
-     */
-    private string $QST_input_name = '';
-
-    /**
-     * $QST_input_id
-     * @var string
-     */
-    private string $QST_input_id = '';
-
-    /**
-     * $QST_input_class
-     * @var string
-     */
-    private string $QST_input_class = '';
-
-    private bool $QST_disabled = false;
-
-
-    /**
-     * @param EE_Question|null $QST EE_Question object
-     * @param EE_Answer|null   $ANS EE_Answer object
-     * @param array            $q_meta
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Question $QST = null, EE_Answer $ANS = null, array $q_meta = [])
-    {
-        $this->request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $this->form_data = $this->request->requestParams();
-        if (empty($QST) || empty($ANS)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. A valid EE_Question or EE_Answer object was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $this->_QST = $QST;
-        $this->_ANS = $ANS;
-        $this->set_question_form_input_meta($q_meta);
-        $this->set_question_form_input_init();
-    }
-
-
-    /**
-     * sets meta data for the question form input
-     *
-     * @param array $q_meta
-     * @return void
-     */
-    public function set_question_form_input_meta(array $q_meta = [])
-    {
-        $default_q_meta  = [
-            'att_nmbr'       => 1,
-            'ticket_id'      => '',
-            'date'           => '',
-            'time'           => '',
-            'input_name'     => '',
-            'input_id'       => '',
-            'input_class'    => '',
-            'label_class'    => '',
-            'input_prefix'   => 'qstn',
-            'append_qstn_id' => true,
-            'htmlentities'   => true,
-            'allow_null'     => false,
-        ];
-        $this->_QST_meta = array_merge($default_q_meta, $q_meta);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_question_form_input_init()
-    {
-        $qstn_id = $this->_QST->system_ID() ? $this->_QST->system_ID() : $this->_QST->ID();
-        $this->_set_input_name($qstn_id);
-        $this->_set_input_id($qstn_id);
-        $this->_set_input_class();
-        $this->set_question_form_input_answer($qstn_id);
-    }
-
-
-    /**
-     * @param $qstn_id
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _set_input_name($qstn_id)
-    {
-        if (! empty($qstn_id)) {
-            $ANS_ID  = $this->get('ANS_ID');
-            $qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
-        }
-        $this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
-            : $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
-    }
-
-
-    /**
-     * get property values for question form input
-     *
-     * @param string $property
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get(string $property = '')
-    {
-        if (! empty($property)) {
-            if (EEM_Question::instance()->has_field($property)) {
-                return $this->_QST->get($property);
-            } elseif (EEM_Answer::instance()->has_field($property)) {
-                return $this->_ANS->get($property);
-            // } elseif ($this->_question_form_input_property_exists($property)) {
-            } elseif (property_exists($this, $property)) {
-                return $this->{$property};
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * set property values for question form input
-     *
-     * @param string $property
-     * @param mixed  $value
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set(string $property = '', $value = null)
-    {
-        if (! empty($property)) {
-            if (EEM_Question::instance()->has_field($property)) {
-                $this->_QST->set($property, $value);
-            } elseif (EEM_Answer::instance()->has_field($property)) {
-                $this->_ANS->set($property, $value);
-            } elseif (property_exists($this, $property)) {
-                $this->{$property} = $value;
-            }
-        }
-    }
-
-
-    /**
-     * @param $qstn_id
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _set_input_id($qstn_id)
-    {
-        $input_id           = isset($this->_QST_meta['input_id']) && ! empty($this->_QST_meta['input_id'])
-            ? $this->_QST_meta['input_id']
-            : sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
-        $this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $input_id . '-' . $qstn_id
-            : $input_id;
-    }
-
-
-    /**
-     * @return void
-     */
-    private function _set_input_class()
-    {
-        $this->QST_input_class = $this->_QST_meta['input_class'] ?? '';
-    }
-
-
-    /**
-     * @param int|string $qstn_id
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_question_form_input_answer($qstn_id)
-    {
-        // check for answer in $this->form_data in case we are reprocessing a form after an error
-        if (
-            isset($this->_QST_meta['EVT_ID'])
-            && isset($this->_QST_meta['att_nmbr'])
-            && isset($this->_QST_meta['date'])
-            && isset($this->_QST_meta['time'])
-            && isset($this->_QST_meta['price_id'])
-        ) {
-            $EVT_ID   = $this->_QST_meta['EVT_ID'];
-            $att_nmbr = $this->_QST_meta['att_nmbr'];
-            $date     = $this->_QST_meta['date'];
-            $time     = $this->_QST_meta['time'];
-            $price_id = $this->_QST_meta['price_id'];
-            if (isset($this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ])) {
-                $answer = $this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ];
-                $this->_ANS->set('ANS_value', $answer);
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Base_class $object $object
-     * @param array         $input_types
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_question_form_inputs_for_object(
-        EE_Base_class $object,
-        array $input_types = []
-    ): array {
-        $inputs = [];
-        $fields = $object->get_model()->field_settings();
-        foreach ($fields as $field_ID => $field) {
-            if ($field instanceof EE_Model_Field_Base) {
-                if (isset($input_types[ $field_ID ])) {
-                    // label to display
-                    $label = $input_types[ $field_ID ]['label'] ?? $field->get_nicename();
-                    // get saved value for field
-                    $value = $object->get($field_ID);
-                    // if no saved value, then use default
-                    $value = $value ?? $field->get_default_value();
-                    // determine question type
-                    $type = $input_types[ $field_ID ]['type'] ?? 'TEXT';
-                    // input name
-                    $input_name = isset($input_types[ $field_ID ]['input_name'])
-                        ? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']'
-                        : $field_ID;
-                    // css class for input
-                    $class = $input_types[ $field_ID ]['class'] ?? '';
-                    // css class for label
-                    $label_class = $input_types[ $field_ID ]['label_class'] ?? '';
-                    // whether to apply htmlentities to answer
-                    $htmlentities = $input_types[ $field_ID ]['htmlentities'] ?? true;
-                    // whether to apply htmlentities to answer
-                    $label_b4 = $input_types[ $field_ID ]['label_b4'] ?? false;
-                    // whether to apply htmlentities to answer
-                    $use_desc_4_label = $input_types[ $field_ID ]['use_desc_4_label'] ?? false;
-                    // whether input is disabled
-                    $disabled = isset($input_types[ $field_ID ]['disabled']) && $input_types[ $field_ID ]['disabled'];
-                    // use a different label on mobile devices
-                    $add_mobile_label = isset($input_types[ $field_ID ]['add_mobile_label'])
-                        && $input_types[ $field_ID ]['add_mobile_label'];
-
-                    // create EE_Question_Form_Input object
-                    $QFI = new EE_Question_Form_Input(
-                        EE_Question::new_instance(
-                            [
-                                'QST_ID'           => 0,
-                                'QST_display_text' => $label,
-                                'QST_type'         => $type,
-                            ]
-                        ),
-                        EE_Answer::new_instance(
-                            [
-                                'ANS_ID'    => 0,
-                                'QST_ID'    => 0,
-                                'REG_ID'    => 0,
-                                'ANS_value' => $value,
-                            ]
-                        ),
-                        [
-                            'input_id'         => "$field_ID-{$object->ID()}",
-                            'input_name'       => $input_name,
-                            'input_class'      => "$field_ID $class",
-                            'label_class'      => $label_class,
-                            'input_prefix'     => '',
-                            'append_qstn_id'   => false,
-                            'htmlentities'     => $htmlentities,
-                            'label_b4'         => $label_b4,
-                            'use_desc_4_label' => $use_desc_4_label,
-                            'add_mobile_label' => $add_mobile_label,
-                        ]
-                    );
-                    // does question type have options ?
-                    if (
-                        in_array($type, ['DROPDOWN', 'RADIO_BTN', 'CHECKBOX'])
-                        && isset($input_types[ $field_ID ]['options'])
-                    ) {
-                        foreach ($input_types[ $field_ID ]['options'] as $option) {
-                            $option    = stripslashes_deep($option);
-                            $option_id = $option['id'] ?? null;
-                            $QSO       = EE_Question_Option::new_instance(
-                                [
-                                    'QSO_value'   => (string) $option_id,
-                                    'QSO_desc'    => $option['text'],
-                                    'QSO_deleted' => false,
-                                ]
-                            );
-                            // all QST (and ANS) properties can be accessed indirectly thru QFI
-                            $QFI->add_temp_option($QSO);
-                        }
-                    }
-                    // we don't want ppl manually changing primary keys cuz that would just lead to total craziness man
-                    if ($disabled || $field_ID == $object->get_model()->primary_key_name()) {
-                        $QFI->QST_disabled = true;
-                    }
-                    $inputs[ $field_ID ] = $QFI;
-                }
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * @param EE_Question_Option $QSO EE_Question_Option
-     * @return void
-     */
-    public function add_temp_option(EE_Question_Option $QSO)
-    {
-        $this->_QST->add_temp_option($QSO);
-    }
-
-
-    /**
-     * @param boolean           $notDeletedOptionsOnly            whether to return ALL options, or only the ones which
-     *                                                            have not yet been deleted
-     * @param string|array|null $selected_value_to_always_include when retrieving options to an ANSWERED question,
-     *                                                            we want to usually only show non-deleted options AND
-     *                                                            the value that was selected for the answer, whether
-     *                                                            it was trashed or not.
-     * @return EE_Question_Option[]
-     */
-    public function options(bool $notDeletedOptionsOnly = true, $selected_value_to_always_include = null): array
-    {
-        $temp_options = $this->_QST->temp_options();
-        return ! empty($temp_options)
-            ? $temp_options
-            : $this->_QST->options(
-                $notDeletedOptionsOnly,
-                $selected_value_to_always_include
-            );
-    }
-
-
-    /**
-     * @param mixed $key
-     * @return mixed
-     */
-    public function get_meta($key = false)
-    {
-        return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
-    }
+	protected RequestInterface $request;
+
+	protected array $form_data;
+
+	private ?EE_Question $_QST = null;
+
+
+	private ?EE_Answer $_ANS = null;
+
+	/**
+	 * $_QST_meta
+	 * @var array
+	 */
+	private array $_QST_meta = [];
+
+	/**
+	 * $QST_input_name
+	 * @var string
+	 */
+	private string $QST_input_name = '';
+
+	/**
+	 * $QST_input_id
+	 * @var string
+	 */
+	private string $QST_input_id = '';
+
+	/**
+	 * $QST_input_class
+	 * @var string
+	 */
+	private string $QST_input_class = '';
+
+	private bool $QST_disabled = false;
+
+
+	/**
+	 * @param EE_Question|null $QST EE_Question object
+	 * @param EE_Answer|null   $ANS EE_Answer object
+	 * @param array            $q_meta
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Question $QST = null, EE_Answer $ANS = null, array $q_meta = [])
+	{
+		$this->request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$this->form_data = $this->request->requestParams();
+		if (empty($QST) || empty($ANS)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. A valid EE_Question or EE_Answer object was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$this->_QST = $QST;
+		$this->_ANS = $ANS;
+		$this->set_question_form_input_meta($q_meta);
+		$this->set_question_form_input_init();
+	}
+
+
+	/**
+	 * sets meta data for the question form input
+	 *
+	 * @param array $q_meta
+	 * @return void
+	 */
+	public function set_question_form_input_meta(array $q_meta = [])
+	{
+		$default_q_meta  = [
+			'att_nmbr'       => 1,
+			'ticket_id'      => '',
+			'date'           => '',
+			'time'           => '',
+			'input_name'     => '',
+			'input_id'       => '',
+			'input_class'    => '',
+			'label_class'    => '',
+			'input_prefix'   => 'qstn',
+			'append_qstn_id' => true,
+			'htmlentities'   => true,
+			'allow_null'     => false,
+		];
+		$this->_QST_meta = array_merge($default_q_meta, $q_meta);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_question_form_input_init()
+	{
+		$qstn_id = $this->_QST->system_ID() ? $this->_QST->system_ID() : $this->_QST->ID();
+		$this->_set_input_name($qstn_id);
+		$this->_set_input_id($qstn_id);
+		$this->_set_input_class();
+		$this->set_question_form_input_answer($qstn_id);
+	}
+
+
+	/**
+	 * @param $qstn_id
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _set_input_name($qstn_id)
+	{
+		if (! empty($qstn_id)) {
+			$ANS_ID  = $this->get('ANS_ID');
+			$qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
+		}
+		$this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
+			? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
+			: $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
+	}
+
+
+	/**
+	 * get property values for question form input
+	 *
+	 * @param string $property
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get(string $property = '')
+	{
+		if (! empty($property)) {
+			if (EEM_Question::instance()->has_field($property)) {
+				return $this->_QST->get($property);
+			} elseif (EEM_Answer::instance()->has_field($property)) {
+				return $this->_ANS->get($property);
+			// } elseif ($this->_question_form_input_property_exists($property)) {
+			} elseif (property_exists($this, $property)) {
+				return $this->{$property};
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * set property values for question form input
+	 *
+	 * @param string $property
+	 * @param mixed  $value
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set(string $property = '', $value = null)
+	{
+		if (! empty($property)) {
+			if (EEM_Question::instance()->has_field($property)) {
+				$this->_QST->set($property, $value);
+			} elseif (EEM_Answer::instance()->has_field($property)) {
+				$this->_ANS->set($property, $value);
+			} elseif (property_exists($this, $property)) {
+				$this->{$property} = $value;
+			}
+		}
+	}
+
+
+	/**
+	 * @param $qstn_id
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _set_input_id($qstn_id)
+	{
+		$input_id           = isset($this->_QST_meta['input_id']) && ! empty($this->_QST_meta['input_id'])
+			? $this->_QST_meta['input_id']
+			: sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
+		$this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
+			? $input_id . '-' . $qstn_id
+			: $input_id;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function _set_input_class()
+	{
+		$this->QST_input_class = $this->_QST_meta['input_class'] ?? '';
+	}
+
+
+	/**
+	 * @param int|string $qstn_id
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_question_form_input_answer($qstn_id)
+	{
+		// check for answer in $this->form_data in case we are reprocessing a form after an error
+		if (
+			isset($this->_QST_meta['EVT_ID'])
+			&& isset($this->_QST_meta['att_nmbr'])
+			&& isset($this->_QST_meta['date'])
+			&& isset($this->_QST_meta['time'])
+			&& isset($this->_QST_meta['price_id'])
+		) {
+			$EVT_ID   = $this->_QST_meta['EVT_ID'];
+			$att_nmbr = $this->_QST_meta['att_nmbr'];
+			$date     = $this->_QST_meta['date'];
+			$time     = $this->_QST_meta['time'];
+			$price_id = $this->_QST_meta['price_id'];
+			if (isset($this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ])) {
+				$answer = $this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ];
+				$this->_ANS->set('ANS_value', $answer);
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Base_class $object $object
+	 * @param array         $input_types
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_question_form_inputs_for_object(
+		EE_Base_class $object,
+		array $input_types = []
+	): array {
+		$inputs = [];
+		$fields = $object->get_model()->field_settings();
+		foreach ($fields as $field_ID => $field) {
+			if ($field instanceof EE_Model_Field_Base) {
+				if (isset($input_types[ $field_ID ])) {
+					// label to display
+					$label = $input_types[ $field_ID ]['label'] ?? $field->get_nicename();
+					// get saved value for field
+					$value = $object->get($field_ID);
+					// if no saved value, then use default
+					$value = $value ?? $field->get_default_value();
+					// determine question type
+					$type = $input_types[ $field_ID ]['type'] ?? 'TEXT';
+					// input name
+					$input_name = isset($input_types[ $field_ID ]['input_name'])
+						? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']'
+						: $field_ID;
+					// css class for input
+					$class = $input_types[ $field_ID ]['class'] ?? '';
+					// css class for label
+					$label_class = $input_types[ $field_ID ]['label_class'] ?? '';
+					// whether to apply htmlentities to answer
+					$htmlentities = $input_types[ $field_ID ]['htmlentities'] ?? true;
+					// whether to apply htmlentities to answer
+					$label_b4 = $input_types[ $field_ID ]['label_b4'] ?? false;
+					// whether to apply htmlentities to answer
+					$use_desc_4_label = $input_types[ $field_ID ]['use_desc_4_label'] ?? false;
+					// whether input is disabled
+					$disabled = isset($input_types[ $field_ID ]['disabled']) && $input_types[ $field_ID ]['disabled'];
+					// use a different label on mobile devices
+					$add_mobile_label = isset($input_types[ $field_ID ]['add_mobile_label'])
+						&& $input_types[ $field_ID ]['add_mobile_label'];
+
+					// create EE_Question_Form_Input object
+					$QFI = new EE_Question_Form_Input(
+						EE_Question::new_instance(
+							[
+								'QST_ID'           => 0,
+								'QST_display_text' => $label,
+								'QST_type'         => $type,
+							]
+						),
+						EE_Answer::new_instance(
+							[
+								'ANS_ID'    => 0,
+								'QST_ID'    => 0,
+								'REG_ID'    => 0,
+								'ANS_value' => $value,
+							]
+						),
+						[
+							'input_id'         => "$field_ID-{$object->ID()}",
+							'input_name'       => $input_name,
+							'input_class'      => "$field_ID $class",
+							'label_class'      => $label_class,
+							'input_prefix'     => '',
+							'append_qstn_id'   => false,
+							'htmlentities'     => $htmlentities,
+							'label_b4'         => $label_b4,
+							'use_desc_4_label' => $use_desc_4_label,
+							'add_mobile_label' => $add_mobile_label,
+						]
+					);
+					// does question type have options ?
+					if (
+						in_array($type, ['DROPDOWN', 'RADIO_BTN', 'CHECKBOX'])
+						&& isset($input_types[ $field_ID ]['options'])
+					) {
+						foreach ($input_types[ $field_ID ]['options'] as $option) {
+							$option    = stripslashes_deep($option);
+							$option_id = $option['id'] ?? null;
+							$QSO       = EE_Question_Option::new_instance(
+								[
+									'QSO_value'   => (string) $option_id,
+									'QSO_desc'    => $option['text'],
+									'QSO_deleted' => false,
+								]
+							);
+							// all QST (and ANS) properties can be accessed indirectly thru QFI
+							$QFI->add_temp_option($QSO);
+						}
+					}
+					// we don't want ppl manually changing primary keys cuz that would just lead to total craziness man
+					if ($disabled || $field_ID == $object->get_model()->primary_key_name()) {
+						$QFI->QST_disabled = true;
+					}
+					$inputs[ $field_ID ] = $QFI;
+				}
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * @param EE_Question_Option $QSO EE_Question_Option
+	 * @return void
+	 */
+	public function add_temp_option(EE_Question_Option $QSO)
+	{
+		$this->_QST->add_temp_option($QSO);
+	}
+
+
+	/**
+	 * @param boolean           $notDeletedOptionsOnly            whether to return ALL options, or only the ones which
+	 *                                                            have not yet been deleted
+	 * @param string|array|null $selected_value_to_always_include when retrieving options to an ANSWERED question,
+	 *                                                            we want to usually only show non-deleted options AND
+	 *                                                            the value that was selected for the answer, whether
+	 *                                                            it was trashed or not.
+	 * @return EE_Question_Option[]
+	 */
+	public function options(bool $notDeletedOptionsOnly = true, $selected_value_to_always_include = null): array
+	{
+		$temp_options = $this->_QST->temp_options();
+		return ! empty($temp_options)
+			? $temp_options
+			: $this->_QST->options(
+				$notDeletedOptionsOnly,
+				$selected_value_to_always_include
+			);
+	}
+
+
+	/**
+	 * @param mixed $key
+	 * @return mixed
+	 */
+	public function get_meta($key = false)
+	{
+		return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
+	}
 }

Spacing +27 added lines, -27 removed lines

@@ -89,7 +89,7 @@ 
      */
     public function set_question_form_input_meta(array $q_meta = [])
     {
-        $default_q_meta  = [
+        $default_q_meta = [
             'att_nmbr'       => 1,
             'ticket_id'      => '',
             'date'           => '',
@@ -130,13 +130,13 @@ 
      */
     private function _set_input_name($qstn_id)
     {
-        if (! empty($qstn_id)) {
+        if ( ! empty($qstn_id)) {
             $ANS_ID  = $this->get('ANS_ID');
-            $qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
+            $qstn_id = ! empty($ANS_ID) ? '['.$qstn_id.']['.$ANS_ID.']' : '['.$qstn_id.']';
         }
         $this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
-            : $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
+            ? $this->_QST_meta['input_prefix'].$this->_QST_meta['input_name'].$qstn_id
+            : $this->_QST_meta['input_prefix'].$this->_QST_meta['input_name'];
     }
 
 
@@ -150,7 +150,7 @@ 
      */
     public function get(string $property = '')
     {
-        if (! empty($property)) {
+        if ( ! empty($property)) {
             if (EEM_Question::instance()->has_field($property)) {
                 return $this->_QST->get($property);
             } elseif (EEM_Answer::instance()->has_field($property)) {
@@ -175,7 +175,7 @@ 
      */
     public function set(string $property = '', $value = null)
     {
-        if (! empty($property)) {
+        if ( ! empty($property)) {
             if (EEM_Question::instance()->has_field($property)) {
                 $this->_QST->set($property, $value);
             } elseif (EEM_Answer::instance()->has_field($property)) {
@@ -199,7 +199,7 @@ 
             ? $this->_QST_meta['input_id']
             : sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
         $this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $input_id . '-' . $qstn_id
+            ? $input_id.'-'.$qstn_id
             : $input_id;
     }
 
@@ -234,8 +234,8 @@ 
             $date     = $this->_QST_meta['date'];
             $time     = $this->_QST_meta['time'];
             $price_id = $this->_QST_meta['price_id'];
-            if (isset($this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ])) {
-                $answer = $this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ];
+            if (isset($this->form_data['qstn'][$EVT_ID][$att_nmbr][$date][$time][$price_id][$qstn_id])) {
+                $answer = $this->form_data['qstn'][$EVT_ID][$att_nmbr][$date][$time][$price_id][$qstn_id];
                 $this->_ANS->set('ANS_value', $answer);
             }
         }
@@ -257,34 +257,34 @@ 
         $fields = $object->get_model()->field_settings();
         foreach ($fields as $field_ID => $field) {
             if ($field instanceof EE_Model_Field_Base) {
-                if (isset($input_types[ $field_ID ])) {
+                if (isset($input_types[$field_ID])) {
                     // label to display
-                    $label = $input_types[ $field_ID ]['label'] ?? $field->get_nicename();
+                    $label = $input_types[$field_ID]['label'] ?? $field->get_nicename();
                     // get saved value for field
                     $value = $object->get($field_ID);
                     // if no saved value, then use default
                     $value = $value ?? $field->get_default_value();
                     // determine question type
-                    $type = $input_types[ $field_ID ]['type'] ?? 'TEXT';
+                    $type = $input_types[$field_ID]['type'] ?? 'TEXT';
                     // input name
-                    $input_name = isset($input_types[ $field_ID ]['input_name'])
-                        ? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']'
+                    $input_name = isset($input_types[$field_ID]['input_name'])
+                        ? $input_types[$field_ID]['input_name'].'['.$field_ID.']'
                         : $field_ID;
                     // css class for input
-                    $class = $input_types[ $field_ID ]['class'] ?? '';
+                    $class = $input_types[$field_ID]['class'] ?? '';
                     // css class for label
-                    $label_class = $input_types[ $field_ID ]['label_class'] ?? '';
+                    $label_class = $input_types[$field_ID]['label_class'] ?? '';
                     // whether to apply htmlentities to answer
-                    $htmlentities = $input_types[ $field_ID ]['htmlentities'] ?? true;
+                    $htmlentities = $input_types[$field_ID]['htmlentities'] ?? true;
                     // whether to apply htmlentities to answer
-                    $label_b4 = $input_types[ $field_ID ]['label_b4'] ?? false;
+                    $label_b4 = $input_types[$field_ID]['label_b4'] ?? false;
                     // whether to apply htmlentities to answer
-                    $use_desc_4_label = $input_types[ $field_ID ]['use_desc_4_label'] ?? false;
+                    $use_desc_4_label = $input_types[$field_ID]['use_desc_4_label'] ?? false;
                     // whether input is disabled
-                    $disabled = isset($input_types[ $field_ID ]['disabled']) && $input_types[ $field_ID ]['disabled'];
+                    $disabled = isset($input_types[$field_ID]['disabled']) && $input_types[$field_ID]['disabled'];
                     // use a different label on mobile devices
-                    $add_mobile_label = isset($input_types[ $field_ID ]['add_mobile_label'])
-                        && $input_types[ $field_ID ]['add_mobile_label'];
+                    $add_mobile_label = isset($input_types[$field_ID]['add_mobile_label'])
+                        && $input_types[$field_ID]['add_mobile_label'];
 
                     // create EE_Question_Form_Input object
                     $QFI = new EE_Question_Form_Input(
@@ -319,9 +319,9 @@ 
                     // does question type have options ?
                     if (
                         in_array($type, ['DROPDOWN', 'RADIO_BTN', 'CHECKBOX'])
-                        && isset($input_types[ $field_ID ]['options'])
+                        && isset($input_types[$field_ID]['options'])
                     ) {
-                        foreach ($input_types[ $field_ID ]['options'] as $option) {
+                        foreach ($input_types[$field_ID]['options'] as $option) {
                             $option    = stripslashes_deep($option);
                             $option_id = $option['id'] ?? null;
                             $QSO       = EE_Question_Option::new_instance(
@@ -339,7 +339,7 @@ 
                     if ($disabled || $field_ID == $object->get_model()->primary_key_name()) {
                         $QFI->QST_disabled = true;
                     }
-                    $inputs[ $field_ID ] = $QFI;
+                    $inputs[$field_ID] = $QFI;
                 }
             }
         }
@@ -384,6 +384,6 @@ 
      */
     public function get_meta($key = false)
     {
-        return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
+        return $key && isset($this->_QST_meta[$key]) ? $this->_QST_meta[$key] : false;
     }
 }

core/exceptions/InsufficientPermissionsException.php

Indentation +20 added lines, -20 removed lines

@@ -14,24 +14,24 @@
  */
 class InsufficientPermissionsException extends \RuntimeException
 {
-    /**
-     * @access public
-     * @param string          $action
-     * @param string          $message
-     * @param int             $code
-     * @param Exception|null $previous
-     */
-    public function __construct($action, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'We\'re sorry, but you do not have the required permissions to perform the following action: %1$s',
-                    'event_espresso'
-                ),
-                ucwords(str_replace('_', ' ', $action))
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * @access public
+	 * @param string          $action
+	 * @param string          $message
+	 * @param int             $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($action, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'We\'re sorry, but you do not have the required permissions to perform the following action: %1$s',
+					'event_espresso'
+				),
+				ucwords(str_replace('_', ' ', $action))
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

caffeinated/admin/new/tickets/Tickets_List_Table.class.php

Indentation +170 added lines, -170 removed lines

@@ -16,174 +16,174 @@
  */
 class Tickets_List_Table extends EE_Admin_List_Table
 {
-    protected function _setup_data()
-    {
-        // \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        $trashed = $this->_admin_page->get_view() == 'trashed' ? true : false;
-        $this->_data = $this->_admin_page->get_default_tickets($this->_per_page, false, $trashed);
-        $this->_all_data_count = $this->_admin_page->get_default_tickets($this->_per_page, true, false);
-        $this->_trashed_count = $this->_admin_page->get_default_tickets($this->_per_page, true, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('ticket', 'event_espresso'),
-            'plural'   => esc_html__('tickets', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'              => '<input type="checkbox" />', // Render a checkbox instead of text
-            'id'              => esc_html__('ID', 'event_espresso'),
-            'TKT_name'        => esc_html__('Name', 'event_espresso'),
-            'TKT_description' => esc_html__('Description', 'event_espresso'),
-            'TKT_qty'         => esc_html__('Quantity', 'event_espresso'),
-            'TKT_uses'        => esc_html__('Uses', 'event_espresso'),
-            'TKT_min'         => esc_html__('Minimum', 'event_espresso'),
-            'TKT_max'         => esc_html__('Maximum', 'event_espresso'),
-            'TKT_price'       => esc_html__('Price', 'event_espresso'),
-            'TKT_taxable'     => esc_html__('Taxable', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            // TRUE means its already sorted
-            'id' => array('TKT_ID', false),
-            'TKT_name'        => array('TKT_name', true),
-            'TKT_description' => array('TKT_description', false),
-            'TKT_qty'         => array('TKT_qty', false),
-            'TKT_uses'        => array('TKT_uses', false),
-            'TKT_min'         => array('TKT_min', false),
-            'TKT_max'         => array('TKT_max', false),
-            'TKT_price'       => array('TKT_price', false),
-        );
-
-        $this->_hidden_columns = array();
-    }
-
-
-    protected function _get_table_filters()
-    {
-        return [];
-    }
-
-
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_all_data_count;
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_tickets', 'trash_ticket')) {
-            $this->_views['trashed']['count'] = $this->_trashed_count;
-        }
-    }
-
-
-    public function column_cb($item)
-    {
-        return $item->ID() === 1
-            ? '<span class="dashicons dashicons-lock"></span>'
-            : sprintf(
-                '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
-                $item->ID()
-            );
-    }
-
-
-    /**
-     * @param EE_Ticket $item
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_id($item): string
-    {
-        $content = '<span class="ee-entity-id">' . $item->ID() . '</span>';
-        $content .= '<span class="show-on-mobile-view-only">' . $this->column_TKT_name($item, false) . '</span>';
-        return $this->columnContent('id', $content, 'end');
-    }
-
-
-    public function column_TKT_name(EE_Ticket $ticket, bool $prep_content = true): string
-    {
-        // build row actions
-        $actions = array();
-
-        // trash links
-        if ($ticket->ID() !== 1) {
-            if ($this->_view == 'all') {
-                $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                    'action' => 'trash_ticket',
-                    'TKT_ID' => $ticket->ID(),
-                ), TICKETS_ADMIN_URL);
-                $actions['trash'] = '<a href="' . $trash_lnk_url . '" aria-label="'
-                                    . esc_attr__('Move Ticket to trash', 'event_espresso') . '">'
-                                    . esc_html__('Trash', 'event_espresso') . '</a>';
-            } else {
-                // restore price link
-                $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                    'action' => 'restore_ticket',
-                    'TKT_ID' => $ticket->ID(),
-                ), TICKETS_ADMIN_URL);
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" aria-label="'
-                                      . esc_attr__('Restore Ticket', 'event_espresso') . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
-                // delete price link
-                $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                    'action' => 'delete_ticket',
-                    'TKT_ID' => $ticket->ID(),
-                ), TICKETS_ADMIN_URL);
-                $actions['delete'] = '<a href="' . $delete_lnk_url . '" aria-label="'
-                                     . esc_attr__('Delete Ticket Permanently', 'event_espresso') . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso') . '</a>';
-            }
-        }
-        // return $ticket->get('TKT_name') . $this->row_actions($actions);
-        $content = $prep_content ? $ticket->name() . $this->row_actions($actions) : $ticket->name();
-        return $prep_content ? $this->columnContent('TKT_name', $content) : $content;
-    }
-
-
-    public function column_TKT_description(EE_Ticket $ticket)
-    {
-        return $this->columnContent('TKT_description', $ticket->description());
-    }
-
-
-    public function column_TKT_qty(EE_Ticket $ticket)
-    {
-
-        return $ticket->get_pretty('TKT_qty', 'text');
-        // return $this->columnContent('TKT_qty', $ticket->qty());
-    }
-
-
-    public function column_TKT_uses(EE_Ticket $ticket)
-    {
-        return $ticket->get_pretty('TKT_uses', 'text');
-    }
-
-
-    public function column_TKT_min(EE_Ticket $ticket)
-    {
-        return $ticket->get('TKT_min');
-    }
-
-
-    public function column_TKT_max(EE_Ticket $ticket)
-    {
-        return $ticket->get_pretty('TKT_max', 'text');
-    }
-
-
-    public function column_TKT_price(EE_Ticket $ticket)
-    {
-        return EEH_Template::format_currency($ticket->get('TKT_price'));
-    }
-
-
-    public function column_TKT_taxable(EE_Ticket $ticket)
-    {
-        return $ticket->get('TKT_taxable') ? esc_html__('Yes', 'event_espresso') : esc_html__('No', 'event_espresso');
-    }
+	protected function _setup_data()
+	{
+		// \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		$trashed = $this->_admin_page->get_view() == 'trashed' ? true : false;
+		$this->_data = $this->_admin_page->get_default_tickets($this->_per_page, false, $trashed);
+		$this->_all_data_count = $this->_admin_page->get_default_tickets($this->_per_page, true, false);
+		$this->_trashed_count = $this->_admin_page->get_default_tickets($this->_per_page, true, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('ticket', 'event_espresso'),
+			'plural'   => esc_html__('tickets', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'              => '<input type="checkbox" />', // Render a checkbox instead of text
+			'id'              => esc_html__('ID', 'event_espresso'),
+			'TKT_name'        => esc_html__('Name', 'event_espresso'),
+			'TKT_description' => esc_html__('Description', 'event_espresso'),
+			'TKT_qty'         => esc_html__('Quantity', 'event_espresso'),
+			'TKT_uses'        => esc_html__('Uses', 'event_espresso'),
+			'TKT_min'         => esc_html__('Minimum', 'event_espresso'),
+			'TKT_max'         => esc_html__('Maximum', 'event_espresso'),
+			'TKT_price'       => esc_html__('Price', 'event_espresso'),
+			'TKT_taxable'     => esc_html__('Taxable', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			// TRUE means its already sorted
+			'id' => array('TKT_ID', false),
+			'TKT_name'        => array('TKT_name', true),
+			'TKT_description' => array('TKT_description', false),
+			'TKT_qty'         => array('TKT_qty', false),
+			'TKT_uses'        => array('TKT_uses', false),
+			'TKT_min'         => array('TKT_min', false),
+			'TKT_max'         => array('TKT_max', false),
+			'TKT_price'       => array('TKT_price', false),
+		);
+
+		$this->_hidden_columns = array();
+	}
+
+
+	protected function _get_table_filters()
+	{
+		return [];
+	}
+
+
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_all_data_count;
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_tickets', 'trash_ticket')) {
+			$this->_views['trashed']['count'] = $this->_trashed_count;
+		}
+	}
+
+
+	public function column_cb($item)
+	{
+		return $item->ID() === 1
+			? '<span class="dashicons dashicons-lock"></span>'
+			: sprintf(
+				'<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
+				$item->ID()
+			);
+	}
+
+
+	/**
+	 * @param EE_Ticket $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_id($item): string
+	{
+		$content = '<span class="ee-entity-id">' . $item->ID() . '</span>';
+		$content .= '<span class="show-on-mobile-view-only">' . $this->column_TKT_name($item, false) . '</span>';
+		return $this->columnContent('id', $content, 'end');
+	}
+
+
+	public function column_TKT_name(EE_Ticket $ticket, bool $prep_content = true): string
+	{
+		// build row actions
+		$actions = array();
+
+		// trash links
+		if ($ticket->ID() !== 1) {
+			if ($this->_view == 'all') {
+				$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+					'action' => 'trash_ticket',
+					'TKT_ID' => $ticket->ID(),
+				), TICKETS_ADMIN_URL);
+				$actions['trash'] = '<a href="' . $trash_lnk_url . '" aria-label="'
+									. esc_attr__('Move Ticket to trash', 'event_espresso') . '">'
+									. esc_html__('Trash', 'event_espresso') . '</a>';
+			} else {
+				// restore price link
+				$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+					'action' => 'restore_ticket',
+					'TKT_ID' => $ticket->ID(),
+				), TICKETS_ADMIN_URL);
+				$actions['restore'] = '<a href="' . $restore_lnk_url . '" aria-label="'
+									  . esc_attr__('Restore Ticket', 'event_espresso') . '">'
+									  . esc_html__('Restore', 'event_espresso') . '</a>';
+				// delete price link
+				$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+					'action' => 'delete_ticket',
+					'TKT_ID' => $ticket->ID(),
+				), TICKETS_ADMIN_URL);
+				$actions['delete'] = '<a href="' . $delete_lnk_url . '" aria-label="'
+									 . esc_attr__('Delete Ticket Permanently', 'event_espresso') . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso') . '</a>';
+			}
+		}
+		// return $ticket->get('TKT_name') . $this->row_actions($actions);
+		$content = $prep_content ? $ticket->name() . $this->row_actions($actions) : $ticket->name();
+		return $prep_content ? $this->columnContent('TKT_name', $content) : $content;
+	}
+
+
+	public function column_TKT_description(EE_Ticket $ticket)
+	{
+		return $this->columnContent('TKT_description', $ticket->description());
+	}
+
+
+	public function column_TKT_qty(EE_Ticket $ticket)
+	{
+
+		return $ticket->get_pretty('TKT_qty', 'text');
+		// return $this->columnContent('TKT_qty', $ticket->qty());
+	}
+
+
+	public function column_TKT_uses(EE_Ticket $ticket)
+	{
+		return $ticket->get_pretty('TKT_uses', 'text');
+	}
+
+
+	public function column_TKT_min(EE_Ticket $ticket)
+	{
+		return $ticket->get('TKT_min');
+	}
+
+
+	public function column_TKT_max(EE_Ticket $ticket)
+	{
+		return $ticket->get_pretty('TKT_max', 'text');
+	}
+
+
+	public function column_TKT_price(EE_Ticket $ticket)
+	{
+		return EEH_Template::format_currency($ticket->get('TKT_price'));
+	}
+
+
+	public function column_TKT_taxable(EE_Ticket $ticket)
+	{
+		return $ticket->get('TKT_taxable') ? esc_html__('Yes', 'event_espresso') : esc_html__('No', 'event_espresso');
+	}
 }