eventespresso / event-espresso-core

core/services/payment_methods/forms/PayPalSettingsForm.php

Indentation +191 added lines, -191 removed lines

@@ -20,202 +20,202 @@
  */
 class PayPalSettingsForm extends EE_Payment_Method_Form
 {
-    /**
-     * @var string of HTML being the help tab link
-     */
-    protected $helpTabLink;
+	/**
+	 * @var string of HTML being the help tab link
+	 */
+	protected $helpTabLink;
 
-    public function __construct(array $options_array = array(), $help_tab_link = '')
-    {
-        $this->helpTabLink = $help_tab_link;
-        $options_array = array_replace_recursive(
-            array(
-                'extra_meta_inputs' => array(
-                    'api_username' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                // translators: %s link to help doc
-                                esc_html__('API Username %s', 'event_espresso'),
-                                $help_tab_link
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                    'api_password' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                // translators: %s link to help doc
-                                esc_html__('API Password %s', 'event_espresso'),
-                                $help_tab_link
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                    'api_signature' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                // translators: %s link to help doc
-                                esc_html__('API Signature %s', 'event_espresso'),
-                                $help_tab_link
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                )
-            ),
-            $options_array
-        );
-        parent::__construct($options_array);
-    }
+	public function __construct(array $options_array = array(), $help_tab_link = '')
+	{
+		$this->helpTabLink = $help_tab_link;
+		$options_array = array_replace_recursive(
+			array(
+				'extra_meta_inputs' => array(
+					'api_username' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								// translators: %s link to help doc
+								esc_html__('API Username %s', 'event_espresso'),
+								$help_tab_link
+							),
+							'required'        => true,
+						)
+					),
+					'api_password' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								// translators: %s link to help doc
+								esc_html__('API Password %s', 'event_espresso'),
+								$help_tab_link
+							),
+							'required'        => true,
+						)
+					),
+					'api_signature' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								// translators: %s link to help doc
+								esc_html__('API Signature %s', 'event_espresso'),
+								$help_tab_link
+							),
+							'required'        => true,
+						)
+					),
+				)
+			),
+			$options_array
+		);
+		parent::__construct($options_array);
+	}
 
-    /**
-     * Tests the the PayPal API credentials work ok
-     * @return string of an error using the credentials, otherwise, if the credentials work, returns a blank string
-     * @throws EE_Error
-     */
-    protected function checkForCredentialsErrors()
-    {
-        $request_params = array(
-            'METHOD'    => 'GetBalance',
-            'VERSION'   => '204.0',
-            'USER'      => $this->get_input_value('api_username'),
-            'PWD'       => $this->get_input_value('api_password'),
-            'SIGNATURE' => $this->get_input_value('api_signature'),
-        );
-        $gateway_url = $this->get_input_value('PMD_debug_mode')
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-        // Request Customer Details.
-        $response = wp_remote_post(
-            $gateway_url,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($request_params, '', '&'),
-            )
-        );
-        if (is_wp_error($response) || empty($response['body'])) {
-            // If we got here then there was an error in this request.
-            // maybe is turned off. We don't know the credentials are invalid
-            EE_Error::add_error(
-                sprintf(
-                    // translators: %1$s Error message received from PayPal
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'Your PayPal credentials could not be verified. The following error occurred while communicating with PayPal: %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $response->get_error_message()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $response_args = array();
-        parse_str(urldecode($response['body']), $response_args);
+	/**
+	 * Tests the the PayPal API credentials work ok
+	 * @return string of an error using the credentials, otherwise, if the credentials work, returns a blank string
+	 * @throws EE_Error
+	 */
+	protected function checkForCredentialsErrors()
+	{
+		$request_params = array(
+			'METHOD'    => 'GetBalance',
+			'VERSION'   => '204.0',
+			'USER'      => $this->get_input_value('api_username'),
+			'PWD'       => $this->get_input_value('api_password'),
+			'SIGNATURE' => $this->get_input_value('api_signature'),
+		);
+		$gateway_url = $this->get_input_value('PMD_debug_mode')
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+		// Request Customer Details.
+		$response = wp_remote_post(
+			$gateway_url,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($request_params, '', '&'),
+			)
+		);
+		if (is_wp_error($response) || empty($response['body'])) {
+			// If we got here then there was an error in this request.
+			// maybe is turned off. We don't know the credentials are invalid
+			EE_Error::add_error(
+				sprintf(
+					// translators: %1$s Error message received from PayPal
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'Your PayPal credentials could not be verified. The following error occurred while communicating with PayPal: %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$response->get_error_message()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$response_args = array();
+		parse_str(urldecode($response['body']), $response_args);
 
-        if (empty($response_args['ACK'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Your PayPal credentials could not be verified. Part of their response was missing.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        if (
-            in_array(
-                $response_args['ACK'],
-                array(
-                'Success',
-                'SuccessWithWarning'
-                ),
-                true
-            )
-        ) {
-            return '';
-        } else {
-            return sprintf(
-                // translators: %1$s: PayPal response message, %2$s: PayPal response code
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'Your PayPal API credentials appear to be invalid. PayPal said "%1$s (%2$s)". Please see tips below.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                isset($response_args['L_LONGMESSAGE0'])
-                    ? $response_args['L_LONGMESSAGE0']
-                    : esc_html__('No error message received from PayPal', 'event_espresso'),
-                isset($response_args['L_ERRORCODE0']) ? $response_args['L_ERRORCODE0'] : 0
-            );
-        }
-    }
+		if (empty($response_args['ACK'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'Your PayPal credentials could not be verified. Part of their response was missing.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		if (
+			in_array(
+				$response_args['ACK'],
+				array(
+				'Success',
+				'SuccessWithWarning'
+				),
+				true
+			)
+		) {
+			return '';
+		} else {
+			return sprintf(
+				// translators: %1$s: PayPal response message, %2$s: PayPal response code
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'Your PayPal API credentials appear to be invalid. PayPal said "%1$s (%2$s)". Please see tips below.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				isset($response_args['L_LONGMESSAGE0'])
+					? $response_args['L_LONGMESSAGE0']
+					: esc_html__('No error message received from PayPal', 'event_espresso'),
+				isset($response_args['L_ERRORCODE0']) ? $response_args['L_ERRORCODE0'] : 0
+			);
+		}
+	}
 
-    /**
-     * Gets the HTML to show the link to the help tab
-     * @return string
-     */
-    protected function helpTabLink()
-    {
-        return $this->helpTabLink;
-    }
+	/**
+	 * Gets the HTML to show the link to the help tab
+	 * @return string
+	 */
+	protected function helpTabLink()
+	{
+		return $this->helpTabLink;
+	}
 
-    /**
-     * Does the normal validation, but also verifies the PayPal API credentials work.
-     * If they don't, sets a validation error on the entire form, and adds validation errors (which are really more
-     * tips) on each of the inputs that could be the cause of the problem.
-     * @throws EE_Error
-     */
-    public function _validate()
-    {
-        parent::_validate();
-        $credentials_message = $this->checkForCredentialsErrors();
-        if ($credentials_message !== '') {
-            $this->add_validation_error($credentials_message);
-            $this->get_input('PMD_debug_mode')->add_validation_error(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'If you are using PayPal Sandbox (test) credentials, Debug mode should be set to "Yes". Otherwise, if you are using live PayPal credentials, set this to "No".',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                )
-            );
-            $this->get_input('api_username')->add_validation_error(
-                sprintf(
-                    // translators: $1$s HTML for a link to the help tab
-                    esc_html__(
-                        'Are you sure this is your API username, not your login username? %1$s',
-                        'event_espresso'
-                    ),
-                    $this->helpTabLink()
-                )
-            );
-            $this->get_input('api_password')->add_validation_error(
-                sprintf(
-                    // translators: $1$s HTML for a link to the help tab
-                    esc_html__(
-                        'Are you sure this is your API password, not your login password? %1$s',
-                        'event_espresso'
-                    ),
-                    $this->helpTabLink()
-                )
-            );
-            $this->get_input('api_signature')->add_validation_error(
-                sprintf(
-                    // translators: $1$s HTML for a link to the help tab
-                    esc_html__('Please verify your API signature is correct. %1$s', 'event_espresso'),
-                    $this->helpTabLink()
-                )
-            );
-        }
-    }
+	/**
+	 * Does the normal validation, but also verifies the PayPal API credentials work.
+	 * If they don't, sets a validation error on the entire form, and adds validation errors (which are really more
+	 * tips) on each of the inputs that could be the cause of the problem.
+	 * @throws EE_Error
+	 */
+	public function _validate()
+	{
+		parent::_validate();
+		$credentials_message = $this->checkForCredentialsErrors();
+		if ($credentials_message !== '') {
+			$this->add_validation_error($credentials_message);
+			$this->get_input('PMD_debug_mode')->add_validation_error(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'If you are using PayPal Sandbox (test) credentials, Debug mode should be set to "Yes". Otherwise, if you are using live PayPal credentials, set this to "No".',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				)
+			);
+			$this->get_input('api_username')->add_validation_error(
+				sprintf(
+					// translators: $1$s HTML for a link to the help tab
+					esc_html__(
+						'Are you sure this is your API username, not your login username? %1$s',
+						'event_espresso'
+					),
+					$this->helpTabLink()
+				)
+			);
+			$this->get_input('api_password')->add_validation_error(
+				sprintf(
+					// translators: $1$s HTML for a link to the help tab
+					esc_html__(
+						'Are you sure this is your API password, not your login password? %1$s',
+						'event_espresso'
+					),
+					$this->helpTabLink()
+				)
+			);
+			$this->get_input('api_signature')->add_validation_error(
+				sprintf(
+					// translators: $1$s HTML for a link to the help tab
+					esc_html__('Please verify your API signature is correct. %1$s', 'event_espresso'),
+					$this->helpTabLink()
+				)
+			);
+		}
+	}
 }
 // End of file PayPalSettingsForm.php
 // Location: ${NAMESPACE}/PayPalSettingsForm.php

core/services/collections/CollectionDetails.php

Spacing +8 added lines, -8 removed lines

@@ -193,7 +193,7 @@ 
      */
     protected function setCollectionInterface($collection_interface)
     {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+        if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) {
             throw new InvalidInterfaceException($collection_interface);
         }
         $this->collection_interface = $collection_interface;
@@ -221,7 +221,7 @@ 
      */
     protected function setCollectionName($collection_name)
     {
-        if (! is_string($collection_name)) {
+        if ( ! is_string($collection_name)) {
             throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
         }
         $this->collection_name = str_replace(
@@ -281,7 +281,7 @@ 
      */
     protected function setIdentifierCallback($identifier_callback = 'identifier')
     {
-        if (! is_string($identifier_callback)) {
+        if ( ! is_string($identifier_callback)) {
             throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
         }
         $this->identifier_callback = $identifier_callback;
@@ -311,7 +311,7 @@ 
         $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
         // we know our default is a string, so if it's not a string now,
         // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
+        if ( ! is_string($this->file_mask)) {
             throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
         }
     }
@@ -336,7 +336,7 @@ 
     public function setCollectionFQCNs($collection_FQCNs)
     {
         foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
+            if ( ! empty($collection_FQCN)) {
                 if (class_exists($collection_FQCN)) {
                     $this->collection_FQCNs[] = $collection_FQCN;
                 } else {
@@ -358,7 +358,7 @@ 
      */
     protected function getFQCNsFromPartialNamespace($partial_FQCN)
     {
-        if (! $this->file_locator instanceof FqcnLocator) {
+        if ( ! $this->file_locator instanceof FqcnLocator) {
             $this->file_locator = new FqcnLocator();
         }
         $this->file_locator->locate($partial_FQCN);
@@ -384,8 +384,8 @@ 
     public function setCollectionPaths($collection_paths)
     {
         foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
+            if ( ! empty($collection_path)) {
+                if ( ! is_readable($collection_path)) {
                     throw new InvalidFilePathException($collection_path);
                 }
                 $this->collection_paths[] = $collection_path;

Indentation +349 added lines, -349 removed lines

@@ -42,353 +42,353 @@
  */
 class CollectionDetails implements CollectionDetailsInterface
 {
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's spl_object_hash() as it's identifier
-     */
-    const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's class name as it's identifier
-     */
-    const ID_CLASS_NAME = 'identifier-uses-object-class-name';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use the return value from a specified callback method on each object
-     */
-    const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
-
-    /**
-     * The interface used for controlling what gets added to the collection
-     *
-     * @var string $collection_interface
-     */
-    protected $collection_interface = '';
-
-    /**
-     * a unique name used to identify the collection in filter names
-     * supplied value is run through sanitize_title_with_dashes(),
-     * but then also converts dashes to underscores
-     *
-     * @var string $collection_name
-     */
-    protected $collection_name = '';
-
-    /**
-     * what the collection uses for the object identifier.
-     * corresponds to one of the class constants above.
-     * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
-     * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
-     * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
-     * defaults to using spl_object_hash() so that multiple objects of the same class can be added
-     *
-     * @var string $identifier_type
-     */
-    protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
-
-    /**
-     * the pattern applied to paths when searching for class files to add to the collection
-     * ie: "My_Awesome_*.class.php"
-     * defaults to "*.php"
-     *
-     * @var string $file_mask
-     */
-    protected $file_mask = '';
-
-    /**
-     * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
-     * then this specifies the method to use on each entity.
-     * If the callback method does not exist, then an exception will be thrown
-     *
-     * @var string $identifier_callback
-     */
-    protected $identifier_callback = '';
-
-    /**
-     * an array of Fully Qualified Class Names
-     *  for example:
-     *  $FQCNs = array(
-     *      '/Fully/Qualified/ClassNameA'
-     *      '/Fully/Qualified/Other/ClassNameB'
-     *  );
-     *
-     * @var array $collection_FQCNs
-     */
-    protected $collection_FQCNs = array();
-
-    /**
-     * an array of full server paths to folders containing files to be loaded into collection
-     *  for example:
-     *  $paths = array(
-     *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
-     *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
-     *  );
-     *
-     * @var array $collection_paths
-     */
-    protected $collection_paths = array();
-
-    /**
-     * @var LocatorInterface $file_locator
-     */
-    protected $file_locator;
-
-
-    /**
-     * CollectionDetails constructor.
-     *
-     * @access public
-     * @param string           $collection_name
-     * @param string           $collection_interface
-     * @param array            $collection_FQCNs
-     * @param array            $collection_paths
-     * @param string           $file_mask
-     * @param string           $identifier_type
-     * @param string           $identifier_callback
-     * @param LocatorInterface $file_locator
-     * @throws CollectionDetailsException
-     */
-    public function __construct(
-        $collection_name,
-        $collection_interface,
-        array $collection_FQCNs = array(),
-        array $collection_paths = array(),
-        $file_mask = '',
-        $identifier_type = CollectionDetails::ID_OBJECT_HASH,
-        $identifier_callback = '',
-        LocatorInterface $file_locator = null
-    ) {
-        try {
-            $this->setCollectionName($collection_name);
-            $this->setCollectionInterface($collection_interface);
-            $this->setCollectionFQCNs($collection_FQCNs);
-            $this->setCollectionPaths($collection_paths);
-            $this->setFileMasks($file_mask);
-            $this->setIdentifierType($identifier_type);
-            $this->setIdentifierCallback($identifier_callback);
-            $this->file_locator = $file_locator;
-        } catch (Exception $exception) {
-            throw new CollectionDetailsException($exception);
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return mixed
-     */
-    public function getCollectionInterface()
-    {
-        return $this->collection_interface;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $collection_interface
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function setCollectionInterface($collection_interface)
-    {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
-            throw new InvalidInterfaceException($collection_interface);
-        }
-        $this->collection_interface = $collection_interface;
-    }
-
-
-    /**
-     * the collection name will be used for creating dynamic filters
-     *
-     * @access public
-     * @return string
-     */
-    public function collectionName()
-    {
-        return $this->collection_name;
-    }
-
-
-    /**
-     * sanitizes collection name and converts spaces and dashes to underscores
-     *
-     * @access protected
-     * @param string $collection_name
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setCollectionName($collection_name)
-    {
-        if (! is_string($collection_name)) {
-            throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
-        }
-        $this->collection_name = str_replace(
-            '-',
-            '_',
-            sanitize_title_with_dashes($collection_name, '', 'save')
-        );
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierType()
-    {
-        return $this->identifier_type;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_type
-     * @throws InvalidIdentifierException
-     */
-    protected function setIdentifierType($identifier_type)
-    {
-        if (
-            ! ($identifier_type === CollectionDetails::ID_CLASS_NAME
-               || $identifier_type === CollectionDetails::ID_OBJECT_HASH
-               || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
-            )
-        ) {
-            throw new InvalidIdentifierException(
-                $identifier_type,
-                'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
-            );
-        }
-        $this->identifier_type = $identifier_type;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierCallback()
-    {
-        return $this->identifier_callback;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_callback
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setIdentifierCallback($identifier_callback = 'identifier')
-    {
-        if (! is_string($identifier_callback)) {
-            throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
-        }
-        $this->identifier_callback = $identifier_callback;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function getFileMask()
-    {
-        return $this->file_mask;
-    }
-
-
-    /**
-     * sets the file mask which is then used to filter what files get loaded
-     * when searching for classes to add to the collection. Defaults to '*.php'
-     *
-     * @access protected
-     * @param string $file_mask
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setFileMasks($file_mask)
-    {
-        $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
-        // we know our default is a string, so if it's not a string now,
-        // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
-            throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionFQCNs()
-    {
-        return $this->collection_FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_FQCNs
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function setCollectionFQCNs($collection_FQCNs)
-    {
-        foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
-                if (class_exists($collection_FQCN)) {
-                    $this->collection_FQCNs[] = $collection_FQCN;
-                } else {
-                    foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
-                        $this->collection_FQCNs[] = $FQCN;
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @access protected
-     * @param  string $partial_FQCN
-     * @return array
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getFQCNsFromPartialNamespace($partial_FQCN)
-    {
-        if (! $this->file_locator instanceof FqcnLocator) {
-            $this->file_locator = new FqcnLocator();
-        }
-        $this->file_locator->locate($partial_FQCN);
-        return $this->file_locator->getFQCNs();
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionPaths()
-    {
-        return $this->collection_paths;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_paths
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
-     */
-    public function setCollectionPaths($collection_paths)
-    {
-        foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
-                    throw new InvalidFilePathException($collection_path);
-                }
-                $this->collection_paths[] = $collection_path;
-            }
-        }
-    }
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's spl_object_hash() as it's identifier
+	 */
+	const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's class name as it's identifier
+	 */
+	const ID_CLASS_NAME = 'identifier-uses-object-class-name';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use the return value from a specified callback method on each object
+	 */
+	const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
+
+	/**
+	 * The interface used for controlling what gets added to the collection
+	 *
+	 * @var string $collection_interface
+	 */
+	protected $collection_interface = '';
+
+	/**
+	 * a unique name used to identify the collection in filter names
+	 * supplied value is run through sanitize_title_with_dashes(),
+	 * but then also converts dashes to underscores
+	 *
+	 * @var string $collection_name
+	 */
+	protected $collection_name = '';
+
+	/**
+	 * what the collection uses for the object identifier.
+	 * corresponds to one of the class constants above.
+	 * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
+	 * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
+	 * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
+	 * defaults to using spl_object_hash() so that multiple objects of the same class can be added
+	 *
+	 * @var string $identifier_type
+	 */
+	protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
+
+	/**
+	 * the pattern applied to paths when searching for class files to add to the collection
+	 * ie: "My_Awesome_*.class.php"
+	 * defaults to "*.php"
+	 *
+	 * @var string $file_mask
+	 */
+	protected $file_mask = '';
+
+	/**
+	 * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
+	 * then this specifies the method to use on each entity.
+	 * If the callback method does not exist, then an exception will be thrown
+	 *
+	 * @var string $identifier_callback
+	 */
+	protected $identifier_callback = '';
+
+	/**
+	 * an array of Fully Qualified Class Names
+	 *  for example:
+	 *  $FQCNs = array(
+	 *      '/Fully/Qualified/ClassNameA'
+	 *      '/Fully/Qualified/Other/ClassNameB'
+	 *  );
+	 *
+	 * @var array $collection_FQCNs
+	 */
+	protected $collection_FQCNs = array();
+
+	/**
+	 * an array of full server paths to folders containing files to be loaded into collection
+	 *  for example:
+	 *  $paths = array(
+	 *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
+	 *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
+	 *  );
+	 *
+	 * @var array $collection_paths
+	 */
+	protected $collection_paths = array();
+
+	/**
+	 * @var LocatorInterface $file_locator
+	 */
+	protected $file_locator;
+
+
+	/**
+	 * CollectionDetails constructor.
+	 *
+	 * @access public
+	 * @param string           $collection_name
+	 * @param string           $collection_interface
+	 * @param array            $collection_FQCNs
+	 * @param array            $collection_paths
+	 * @param string           $file_mask
+	 * @param string           $identifier_type
+	 * @param string           $identifier_callback
+	 * @param LocatorInterface $file_locator
+	 * @throws CollectionDetailsException
+	 */
+	public function __construct(
+		$collection_name,
+		$collection_interface,
+		array $collection_FQCNs = array(),
+		array $collection_paths = array(),
+		$file_mask = '',
+		$identifier_type = CollectionDetails::ID_OBJECT_HASH,
+		$identifier_callback = '',
+		LocatorInterface $file_locator = null
+	) {
+		try {
+			$this->setCollectionName($collection_name);
+			$this->setCollectionInterface($collection_interface);
+			$this->setCollectionFQCNs($collection_FQCNs);
+			$this->setCollectionPaths($collection_paths);
+			$this->setFileMasks($file_mask);
+			$this->setIdentifierType($identifier_type);
+			$this->setIdentifierCallback($identifier_callback);
+			$this->file_locator = $file_locator;
+		} catch (Exception $exception) {
+			throw new CollectionDetailsException($exception);
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return mixed
+	 */
+	public function getCollectionInterface()
+	{
+		return $this->collection_interface;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $collection_interface
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function setCollectionInterface($collection_interface)
+	{
+		if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+			throw new InvalidInterfaceException($collection_interface);
+		}
+		$this->collection_interface = $collection_interface;
+	}
+
+
+	/**
+	 * the collection name will be used for creating dynamic filters
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function collectionName()
+	{
+		return $this->collection_name;
+	}
+
+
+	/**
+	 * sanitizes collection name and converts spaces and dashes to underscores
+	 *
+	 * @access protected
+	 * @param string $collection_name
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setCollectionName($collection_name)
+	{
+		if (! is_string($collection_name)) {
+			throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
+		}
+		$this->collection_name = str_replace(
+			'-',
+			'_',
+			sanitize_title_with_dashes($collection_name, '', 'save')
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierType()
+	{
+		return $this->identifier_type;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_type
+	 * @throws InvalidIdentifierException
+	 */
+	protected function setIdentifierType($identifier_type)
+	{
+		if (
+			! ($identifier_type === CollectionDetails::ID_CLASS_NAME
+			   || $identifier_type === CollectionDetails::ID_OBJECT_HASH
+			   || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
+			)
+		) {
+			throw new InvalidIdentifierException(
+				$identifier_type,
+				'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
+			);
+		}
+		$this->identifier_type = $identifier_type;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierCallback()
+	{
+		return $this->identifier_callback;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_callback
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setIdentifierCallback($identifier_callback = 'identifier')
+	{
+		if (! is_string($identifier_callback)) {
+			throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
+		}
+		$this->identifier_callback = $identifier_callback;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function getFileMask()
+	{
+		return $this->file_mask;
+	}
+
+
+	/**
+	 * sets the file mask which is then used to filter what files get loaded
+	 * when searching for classes to add to the collection. Defaults to '*.php'
+	 *
+	 * @access protected
+	 * @param string $file_mask
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setFileMasks($file_mask)
+	{
+		$this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
+		// we know our default is a string, so if it's not a string now,
+		// then that means the incoming parameter was something else
+		if (! is_string($this->file_mask)) {
+			throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionFQCNs()
+	{
+		return $this->collection_FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_FQCNs
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function setCollectionFQCNs($collection_FQCNs)
+	{
+		foreach ((array) $collection_FQCNs as $collection_FQCN) {
+			if (! empty($collection_FQCN)) {
+				if (class_exists($collection_FQCN)) {
+					$this->collection_FQCNs[] = $collection_FQCN;
+				} else {
+					foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
+						$this->collection_FQCNs[] = $FQCN;
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @access protected
+	 * @param  string $partial_FQCN
+	 * @return array
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getFQCNsFromPartialNamespace($partial_FQCN)
+	{
+		if (! $this->file_locator instanceof FqcnLocator) {
+			$this->file_locator = new FqcnLocator();
+		}
+		$this->file_locator->locate($partial_FQCN);
+		return $this->file_locator->getFQCNs();
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionPaths()
+	{
+		return $this->collection_paths;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_paths
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
+	 */
+	public function setCollectionPaths($collection_paths)
+	{
+		foreach ((array) $collection_paths as $collection_path) {
+			if (! empty($collection_path)) {
+				if (! is_readable($collection_path)) {
+					throw new InvalidFilePathException($collection_path);
+				}
+				$this->collection_paths[] = $collection_path;
+			}
+		}
+	}
 }

core/services/notifications/PersistentAdminNoticeManager.php

Spacing +9 added lines, -9 removed lines

@@ -85,7 +85,7 @@ 
      */
     public function setReturnUrl($return_url)
     {
-        if (! is_string($return_url)) {
+        if ( ! is_string($return_url)) {
             throw new InvalidDataTypeException('$return_url', $return_url, 'string');
         }
         $this->return_url = $return_url;
@@ -102,7 +102,7 @@ 
      */
     protected function getPersistentAdminNoticeCollection()
     {
-        if (! $this->notice_collection instanceof Collection) {
+        if ( ! $this->notice_collection instanceof Collection) {
             $this->notice_collection = new Collection(
                 'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
             );
@@ -125,7 +125,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 (
@@ -247,14 +247,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
@@ -285,7 +285,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';
     }
 
 
@@ -310,7 +310,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);
@@ -360,10 +360,10 @@ 
             foreach ($this->notice_collection as $persistent_admin_notice) {
                 // are we deleting this notice ?
                 if ($persistent_admin_notice->getPurge()) {
-                    unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
+                    unset($persistent_admin_notices[$persistent_admin_notice->getName()]);
                 } else {
                     /** @var PersistentAdminNotice $persistent_admin_notice */
-                    $persistent_admin_notices[ $persistent_admin_notice->getName() ] = array(
+                    $persistent_admin_notices[$persistent_admin_notice->getName()] = array(
                         'message'     => $persistent_admin_notice->getMessage(),
                         'capability'  => $persistent_admin_notice->getCapability(),
                         'cap_context' => $persistent_admin_notice->getCapContext(),

Indentation +388 added lines, -388 removed lines

@@ -30,392 +30,392 @@
  */
 class PersistentAdminNoticeManager
 {
-    const WP_OPTION_KEY = 'ee_pers_admin_notices';
-
-    /**
-     * @var Collection|PersistentAdminNotice[] $notice_collection
-     */
-    private $notice_collection;
-
-    /**
-     * 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 $return_url;
-
-    /**
-     * @var CapabilitiesChecker $capabilities_checker
-     */
-    private $capabilities_checker;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-
-    /**
-     * PersistentAdminNoticeManager constructor
-     *
-     * @param CapabilitiesChecker $capabilities_checker
-     * @param RequestInterface    $request
-     * @param string              $return_url where to  redirect to after dismissing notices
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        CapabilitiesChecker $capabilities_checker,
-        RequestInterface $request,
-        string $return_url = ''
-    ) {
-        $this->setReturnUrl($return_url);
-        $this->capabilities_checker = $capabilities_checker;
-        $this->request = $request;
-        // 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
-     * @throws InvalidDataTypeException
-     */
-    public function setReturnUrl($return_url)
-    {
-        if (! is_string($return_url)) {
-            throw new InvalidDataTypeException('$return_url', $return_url, 'string');
-        }
-        $this->return_url = $return_url;
-    }
-
-
-    /**
-     * @return Collection
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function getPersistentAdminNoticeCollection()
-    {
-        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 InvalidDataTypeException
-     * @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(
-                            $name,
-                            $details['message'],
-                            false,
-                            $details['capability'],
-                            $details['cap_context'],
-                            $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(
-                                $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 InvalidDataTypeException
-     * @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 InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function dismissNotice($pan_name = '', $purge = false, $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 InvalidDataTypeException
-     * @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');
-            }
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                // are we deleting this notice ?
-                if ($persistent_admin_notice->getPurge()) {
-                    unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
-                } else {
-                    /** @var PersistentAdminNotice $persistent_admin_notice */
-                    $persistent_admin_notices[ $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, $persistent_admin_notices);
-        }
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @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 InvalidDataTypeException
-     * @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';
+
+	/**
+	 * @var Collection|PersistentAdminNotice[] $notice_collection
+	 */
+	private $notice_collection;
+
+	/**
+	 * 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 $return_url;
+
+	/**
+	 * @var CapabilitiesChecker $capabilities_checker
+	 */
+	private $capabilities_checker;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+
+	/**
+	 * PersistentAdminNoticeManager constructor
+	 *
+	 * @param CapabilitiesChecker $capabilities_checker
+	 * @param RequestInterface    $request
+	 * @param string              $return_url where to  redirect to after dismissing notices
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		CapabilitiesChecker $capabilities_checker,
+		RequestInterface $request,
+		string $return_url = ''
+	) {
+		$this->setReturnUrl($return_url);
+		$this->capabilities_checker = $capabilities_checker;
+		$this->request = $request;
+		// 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
+	 * @throws InvalidDataTypeException
+	 */
+	public function setReturnUrl($return_url)
+	{
+		if (! is_string($return_url)) {
+			throw new InvalidDataTypeException('$return_url', $return_url, 'string');
+		}
+		$this->return_url = $return_url;
+	}
+
+
+	/**
+	 * @return Collection
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function getPersistentAdminNoticeCollection()
+	{
+		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 InvalidDataTypeException
+	 * @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(
+							$name,
+							$details['message'],
+							false,
+							$details['capability'],
+							$details['cap_context'],
+							$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(
+								$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 InvalidDataTypeException
+	 * @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 InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function dismissNotice($pan_name = '', $purge = false, $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 InvalidDataTypeException
+	 * @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');
+			}
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				// are we deleting this notice ?
+				if ($persistent_admin_notice->getPurge()) {
+					unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
+				} else {
+					/** @var PersistentAdminNotice $persistent_admin_notice */
+					$persistent_admin_notices[ $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, $persistent_admin_notices);
+		}
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @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 InvalidDataTypeException
+	 * @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();
+		}
+	}
 }

core/services/database/TableAnalysis.php

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     public function ensureTableNameHasPrefix($table_name)
     {
         global $wpdb;
-        return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix . $table_name;
+        return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix.$table_name;
     }
 
 
@@ -81,7 +81,7 @@ 
         $wpdb->last_error = $old_error;
         $EZSQL_ERROR = $ezsql_error_cache;
         // if there was a table doesn't exist error
-        if (! empty($new_error)) {
+        if ( ! empty($new_error)) {
             if (
                 in_array(
                     \EEH_Activation::last_wpdb_error_code(),

Indentation +121 added lines, -121 removed lines

@@ -13,132 +13,132 @@
  */
 class TableAnalysis extends \EE_Base
 {
-    /**
-     * The maximum number of characters that can be indexed on a column using utf8mb4 collation,
-     * see https://events.codebasehq.com/redirect?https://make.wordpress.org/core/2015/04/02/the-utf8mb4-upgrade/
-     */
-    const INDEX_COLUMN_SIZE = 191;
+	/**
+	 * The maximum number of characters that can be indexed on a column using utf8mb4 collation,
+	 * see https://events.codebasehq.com/redirect?https://make.wordpress.org/core/2015/04/02/the-utf8mb4-upgrade/
+	 */
+	const INDEX_COLUMN_SIZE = 191;
 
-    /**
-     * Returns the table name which will definitely have the wpdb prefix on the front,
-     * except if it currently has the wpdb->base_prefix on the front, in which case
-     * it will have the wpdb->base_prefix on it
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return string $tableName, having ensured it has the wpdb prefix on the front
-     */
-    public function ensureTableNameHasPrefix($table_name)
-    {
-        global $wpdb;
-        return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix . $table_name;
-    }
+	/**
+	 * Returns the table name which will definitely have the wpdb prefix on the front,
+	 * except if it currently has the wpdb->base_prefix on the front, in which case
+	 * it will have the wpdb->base_prefix on it
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return string $tableName, having ensured it has the wpdb prefix on the front
+	 */
+	public function ensureTableNameHasPrefix($table_name)
+	{
+		global $wpdb;
+		return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix . $table_name;
+	}
 
 
-    /**
-     * Indicates whether or not the table has any entries. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return bool
-     */
-    public function tableIsEmpty($table_name)
-    {
-        global $wpdb;
-        $table_name = $this->ensureTableNameHasPrefix($table_name);
-        if ($this->tableExists($table_name)) {
-            $count = $wpdb->get_var("SELECT COUNT(*) FROM $table_name");
-            return absint($count) === 0 ? true : false;
-        }
-        return false;
-    }
+	/**
+	 * Indicates whether or not the table has any entries. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return bool
+	 */
+	public function tableIsEmpty($table_name)
+	{
+		global $wpdb;
+		$table_name = $this->ensureTableNameHasPrefix($table_name);
+		if ($this->tableExists($table_name)) {
+			$count = $wpdb->get_var("SELECT COUNT(*) FROM $table_name");
+			return absint($count) === 0 ? true : false;
+		}
+		return false;
+	}
 
 
-    /**
-     * Indicates whether or not the table exists. $table_name can optionally
-     * have the $wpdb->prefix on the beginning, or not.
-     *
-     * @global \wpdb $wpdb
-     * @global array EZSQL_Error
-     * @param        $table_name
-     * @return bool
-     */
-    public function tableExists($table_name)
-    {
-        global $wpdb, $EZSQL_ERROR;
-        $table_name = $this->ensureTableNameHasPrefix($table_name);
-        // ignore if this causes an sql error
-        $old_error = $wpdb->last_error;
-        $old_suppress_errors = $wpdb->suppress_errors();
-        $old_show_errors_value = $wpdb->show_errors(false);
-        $ezsql_error_cache = $EZSQL_ERROR;
-        $wpdb->get_results("SELECT * from $table_name LIMIT 1");
-        $wpdb->show_errors($old_show_errors_value);
-        $wpdb->suppress_errors($old_suppress_errors);
-        $new_error = $wpdb->last_error;
-        $wpdb->last_error = $old_error;
-        $EZSQL_ERROR = $ezsql_error_cache;
-        // if there was a table doesn't exist error
-        if (! empty($new_error)) {
-            if (
-                in_array(
-                    \EEH_Activation::last_wpdb_error_code(),
-                    array(
-                    1051, // bad table
-                    1109, // unknown table
-                    117, // no such table
-                    )
-                )
-                ||
-                preg_match(
-                    '~^Table .* doesn\'t exist~',
-                    $new_error
-                ) // in case not using mysql and error codes aren't reliable, just check for this error string
-            ) {
-                return false;
-            } else {
-                // log this because that's weird. Just use the normal PHP error log
-                error_log(
-                    sprintf(
-                        esc_html__(
-                            'Event Espresso error detected when checking if table existed: %1$s (it wasn\'t just that the table didn\'t exist either)',
-                            'event_espresso'
-                        ),
-                        $new_error
-                    )
-                );
-            }
-        }
-        return true;
-    }
+	/**
+	 * Indicates whether or not the table exists. $table_name can optionally
+	 * have the $wpdb->prefix on the beginning, or not.
+	 *
+	 * @global \wpdb $wpdb
+	 * @global array EZSQL_Error
+	 * @param        $table_name
+	 * @return bool
+	 */
+	public function tableExists($table_name)
+	{
+		global $wpdb, $EZSQL_ERROR;
+		$table_name = $this->ensureTableNameHasPrefix($table_name);
+		// ignore if this causes an sql error
+		$old_error = $wpdb->last_error;
+		$old_suppress_errors = $wpdb->suppress_errors();
+		$old_show_errors_value = $wpdb->show_errors(false);
+		$ezsql_error_cache = $EZSQL_ERROR;
+		$wpdb->get_results("SELECT * from $table_name LIMIT 1");
+		$wpdb->show_errors($old_show_errors_value);
+		$wpdb->suppress_errors($old_suppress_errors);
+		$new_error = $wpdb->last_error;
+		$wpdb->last_error = $old_error;
+		$EZSQL_ERROR = $ezsql_error_cache;
+		// if there was a table doesn't exist error
+		if (! empty($new_error)) {
+			if (
+				in_array(
+					\EEH_Activation::last_wpdb_error_code(),
+					array(
+					1051, // bad table
+					1109, // unknown table
+					117, // no such table
+					)
+				)
+				||
+				preg_match(
+					'~^Table .* doesn\'t exist~',
+					$new_error
+				) // in case not using mysql and error codes aren't reliable, just check for this error string
+			) {
+				return false;
+			} else {
+				// log this because that's weird. Just use the normal PHP error log
+				error_log(
+					sprintf(
+						esc_html__(
+							'Event Espresso error detected when checking if table existed: %1$s (it wasn\'t just that the table didn\'t exist either)',
+							'event_espresso'
+						),
+						$new_error
+					)
+				);
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param $table_name
-     * @param $index_name
-     * @return array of columns used on that index, Each entry is an object with the following properties {
-     * @type string Table
-     * @type string Non_unique "0" or "1"
-     * @type string Key_name
-     * @type string Seq_in_index
-     * @type string Column_name
-     * @type string Collation
-     * @type string Cardinality
-     * @type string Sub_part on a column, usually this is just the number of characters from this column to use in
-     *       indexing
-     * @type string|null Packed
-     * @type string Null
-     * @type string Index_type
-     * @type string Comment
-     * @type string Index_comment
-     * }
-     */
-    public function showIndexes($table_name, $index_name)
-    {
-        global $wpdb;
-        $table_name = $this->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE Key_name = '{$index_name}'";
-        return $wpdb->get_results($index_exists_query);
-    }
+	/**
+	 * @param $table_name
+	 * @param $index_name
+	 * @return array of columns used on that index, Each entry is an object with the following properties {
+	 * @type string Table
+	 * @type string Non_unique "0" or "1"
+	 * @type string Key_name
+	 * @type string Seq_in_index
+	 * @type string Column_name
+	 * @type string Collation
+	 * @type string Cardinality
+	 * @type string Sub_part on a column, usually this is just the number of characters from this column to use in
+	 *       indexing
+	 * @type string|null Packed
+	 * @type string Null
+	 * @type string Index_type
+	 * @type string Comment
+	 * @type string Index_comment
+	 * }
+	 */
+	public function showIndexes($table_name, $index_name)
+	{
+		global $wpdb;
+		$table_name = $this->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM {$table_name} WHERE Key_name = '{$index_name}'";
+		return $wpdb->get_results($index_exists_query);
+	}
 }

core/services/cache/TransientCacheStorage.php

Spacing +10 added lines, -10 removed lines

@@ -57,7 +57,7 @@ 
         // round current time down to closest 5 minutes to simplify scheduling
         $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
         $this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
             add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
         }
     }
@@ -190,7 +190,7 @@ 
      */
     public function get($transient_key, $standard_cache = true)
     {
-        if (isset($this->transients[ $transient_key ])) {
+        if (isset($this->transients[$transient_key])) {
             // to avoid cache stampedes (AKA:dogpiles) for standard cache items,
             // check if known cache expires within the next minute,
             // and if so, remove it from our tracking and and return nothing.
@@ -199,17 +199,17 @@ 
             // until it gets replaced with the refreshed content
             if (
                 $standard_cache
-                && $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
+                && $this->transients[$transient_key] - time() <= MINUTE_IN_SECONDS
             ) {
-                unset($this->transients[ $transient_key ]);
+                unset($this->transients[$transient_key]);
                 $this->updateTransients();
                 return null;
             }
 
             // for non standard cache items, remove the key from our tracking,
             // but proceed to retrieve the transient so that it also gets removed from the db
-            if ($this->transients[ $transient_key ] <= time()) {
-                unset($this->transients[ $transient_key ]);
+            if ($this->transients[$transient_key] <= time()) {
+                unset($this->transients[$transient_key]);
                 $this->updateTransients();
             }
         }
@@ -282,7 +282,7 @@ 
         // and round to the closest 15 minutes
         $expiration = $this->roundTimestamp($expiration);
         // save transients to clear using their ID as the key to avoid duplicates
-        $this->transients[ $transient_key ] = $expiration;
+        $this->transients[$transient_key] = $expiration;
         $this->updateTransients();
     }
 
@@ -334,8 +334,8 @@ 
                 if ($expiration > $this->current_time) {
                     continue;
                 }
-                if (! $expiration || ! $transient_key) {
-                    unset($this->transients[ $transient_key ]);
+                if ( ! $expiration || ! $transient_key) {
+                    unset($this->transients[$transient_key]);
                     $update = true;
                     continue;
                 }
@@ -374,7 +374,7 @@ 
                 ? str_replace('_transient_', '', $transient_key)
                 : $transient_key;
             delete_transient($transient_key);
-            unset($this->transients[ $transient_key ]);
+            unset($this->transients[$transient_key]);
             $counter++;
         }
         return $counter > 0;

Indentation +363 added lines, -363 removed lines

@@ -15,367 +15,367 @@
  */
 class TransientCacheStorage implements CacheStorageInterface
 {
-    /**
-     * wp-option option_name for tracking transients
-     *
-     * @type string
-     */
-    const TRANSIENT_SCHEDULE_OPTIONS_KEY = 'ee_transient_schedule';
-
-    /**
-     * @var int $current_time
-     */
-    private $current_time;
-
-    /**
-     * how often to perform transient cleanup
-     *
-     * @var string $transient_cleanup_frequency
-     */
-    private $transient_cleanup_frequency;
-
-    /**
-     * options for how often to perform transient cleanup
-     *
-     * @var array $transient_cleanup_frequency_options
-     */
-    private $transient_cleanup_frequency_options = array();
-
-    /**
-     * @var array $transients
-     */
-    private $transients;
-
-
-    /**
-     * TransientCacheStorage constructor.
-     */
-    public function __construct()
-    {
-        $this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
-        // round current time down to closest 5 minutes to simplify scheduling
-        $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
-        $this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
-            add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
-        }
-    }
-
-
-    /**
-     * Sets how often transient cleanup occurs
-     *
-     * @return string
-     */
-    private function setTransientCleanupFrequency()
-    {
-        // sets how often transients are cleaned up
-        $this->transient_cleanup_frequency_options = apply_filters(
-            'FHEE__TransientCacheStorage__transient_cleanup_schedule_options',
-            array(
-                'off',
-                '15-minutes',
-                'hour',
-                '12-hours',
-                'day',
-            )
-        );
-        $transient_cleanup_frequency = apply_filters(
-            'FHEE__TransientCacheStorage__transient_cleanup_schedule',
-            'hour'
-        );
-        return in_array(
-            $transient_cleanup_frequency,
-            $this->transient_cleanup_frequency_options,
-            true
-        )
-            ? $transient_cleanup_frequency
-            : 'hour';
-    }
-
-
-    /**
-     * we need to be able to round timestamps off to match the set transient cleanup frequency
-     * so if a transient is set to expire at 1:17 pm for example, and our cleanup schedule is every hour,
-     * then that timestamp needs to be rounded up to 2:00 pm so that it is removed
-     * during the next scheduled cleanup after its expiration.
-     * We also round off the current time timestamp to the closest 5 minutes
-     * just to make the timestamps a little easier to round which helps with debugging.
-     *
-     * @param int    $timestamp [required]
-     * @param string $cleanup_frequency
-     * @param bool   $round_up
-     * @return int
-     */
-    private function roundTimestamp($timestamp, $cleanup_frequency = 'hour', $round_up = true)
-    {
-        $cleanup_frequency = $cleanup_frequency ? $cleanup_frequency : $this->transient_cleanup_frequency;
-        // in order to round the time to the closest xx minutes (or hours),
-        // we take the minutes (or hours) portion of the timestamp and divide it by xx,
-        // round down to a whole number, then multiply by xx to bring us almost back up to where we were
-        // why round down ? so the minutes (or hours) don't go over 60 (or 24)
-        // and bump the hour, which could bump the day, which could bump the month, etc,
-        // which would be bad because we don't always want to round up,
-        // but when we do we can easily achieve that by simply adding the desired offset,
-        $minutes = '00';
-        $hours = 'H';
-        switch ($cleanup_frequency) {
-            case '5-minutes':
-                $minutes = floor((int) date('i', $timestamp) / 5) * 5;
-                $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
-                $offset = MINUTE_IN_SECONDS * 5;
-                break;
-            case '15-minutes':
-                $minutes = floor((int) date('i', $timestamp) / 15) * 15;
-                $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
-                $offset = MINUTE_IN_SECONDS * 15;
-                break;
-            case '12-hours':
-                $hours = floor((int) date('H', $timestamp) / 12) * 12;
-                $hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
-                $offset = HOUR_IN_SECONDS * 12;
-                break;
-            case 'day':
-                $hours = '03'; // run cleanup at 3:00 am (or first site hit after that)
-                $offset = DAY_IN_SECONDS;
-                break;
-            case 'hour':
-            default:
-                $offset = HOUR_IN_SECONDS;
-                break;
-        }
-        $rounded_timestamp = (int) strtotime(date("Y-m-d {$hours}:{$minutes}:00", $timestamp));
-        $rounded_timestamp += $round_up ? $offset : 0;
-        return apply_filters(
-            'FHEE__TransientCacheStorage__roundTimestamp__timestamp',
-            $rounded_timestamp,
-            $timestamp,
-            $cleanup_frequency,
-            $round_up
-        );
-    }
-
-
-    /**
-     * Saves supplied data to a transient
-     * if an expiration is set, then it automatically schedules the transient for cleanup
-     *
-     * @param string $transient_key [required]
-     * @param string $data          [required]
-     * @param int    $expiration    number of seconds until the cache expires
-     * @return bool
-     */
-    public function add($transient_key, $data, $expiration = 0)
-    {
-        $expiration = (int) abs($expiration);
-        $saved = set_transient($transient_key, $data, $expiration);
-        if ($saved && $expiration) {
-            $this->scheduleTransientCleanup($transient_key, $expiration);
-        }
-        return $saved;
-    }
-
-
-    /**
-     * retrieves transient data
-     * automatically triggers early cache refresh for standard cache items
-     * in order to avoid cache stampedes on busy sites.
-     * For non-standard cache items like PHP Session data where early refreshing is not wanted,
-     * the $standard_cache parameter should be set to false when retrieving data
-     *
-     * @param string $transient_key [required]
-     * @param bool   $standard_cache
-     * @return mixed|null
-     */
-    public function get($transient_key, $standard_cache = true)
-    {
-        if (isset($this->transients[ $transient_key ])) {
-            // to avoid cache stampedes (AKA:dogpiles) for standard cache items,
-            // check if known cache expires within the next minute,
-            // and if so, remove it from our tracking and and return nothing.
-            // this should trigger the cache content to be regenerated during this request,
-            // while allowing any following requests to still access the existing cache
-            // until it gets replaced with the refreshed content
-            if (
-                $standard_cache
-                && $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
-            ) {
-                unset($this->transients[ $transient_key ]);
-                $this->updateTransients();
-                return null;
-            }
-
-            // for non standard cache items, remove the key from our tracking,
-            // but proceed to retrieve the transient so that it also gets removed from the db
-            if ($this->transients[ $transient_key ] <= time()) {
-                unset($this->transients[ $transient_key ]);
-                $this->updateTransients();
-            }
-        }
-
-        $content = get_transient($transient_key);
-        return $content !== false ? $content : null;
-    }
-
-
-    /**
-     * delete a single transient and remove tracking
-     *
-     * @param string $transient_key [required] full or partial transient key to be deleted
-     */
-    public function delete($transient_key)
-    {
-        $this->deleteMany(array($transient_key));
-    }
-
-
-    /**
-     * delete multiple transients and remove tracking
-     *
-     * @param array $transient_keys [required] array of full or partial transient keys to be deleted
-     * @param bool  $force_delete   [optional] if true, then will not check incoming keys against those being tracked
-     *                              and proceed directly to deleting those entries from the cache storage
-     */
-    public function deleteMany(array $transient_keys, $force_delete = false)
-    {
-        $full_transient_keys = $force_delete ? $transient_keys : array();
-        if (empty($full_transient_keys)) {
-            foreach ($this->transients as $transient_key => $expiration) {
-                foreach ($transient_keys as $transient_key_to_delete) {
-                    if (strpos($transient_key, $transient_key_to_delete) !== false) {
-                        $full_transient_keys[] = $transient_key;
-                    }
-                }
-            }
-        }
-        if ($this->deleteTransientKeys($full_transient_keys)) {
-            $this->updateTransients();
-        }
-    }
-
-
-    /**
-     * sorts transients numerically by timestamp
-     * then saves the transient schedule to a WP option
-     */
-    private function updateTransients()
-    {
-        asort($this->transients, SORT_NUMERIC);
-        update_option(
-            TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY,
-            $this->transients
-        );
-    }
-
-
-    /**
-     * schedules a transient for cleanup by adding it to the transient tracking
-     *
-     * @param string $transient_key [required]
-     * @param int    $expiration    [required]
-     */
-    private function scheduleTransientCleanup($transient_key, $expiration)
-    {
-        // make sure a valid future timestamp is set
-        $expiration += $expiration < time() ? time() : 0;
-        // and round to the closest 15 minutes
-        $expiration = $this->roundTimestamp($expiration);
-        // save transients to clear using their ID as the key to avoid duplicates
-        $this->transients[ $transient_key ] = $expiration;
-        $this->updateTransients();
-    }
-
-
-    /**
-     * Since our tracked transients are sorted by their timestamps
-     * we can grab the first transient and see when it is scheduled for cleanup.
-     * If that timestamp is less than or equal to the current time,
-     * then cleanup is triggered
-     */
-    public function checkTransientCleanupSchedule()
-    {
-        if (empty($this->transients)) {
-            return;
-        }
-        // when do we run the next cleanup job?
-        reset($this->transients);
-        $next_scheduled_cleanup = current($this->transients);
-        // if the next cleanup job is scheduled for the current hour
-        if ($next_scheduled_cleanup <= $this->current_time) {
-            if ($this->cleanupExpiredTransients()) {
-                $this->updateTransients();
-            }
-        }
-    }
-
-
-    /**
-     * loops through the array of tracked transients,
-     * compiles a list of those that have expired, and sends that list off for deletion.
-     * Also removes any bad records from the transients array
-     *
-     * @return bool
-     */
-    private function cleanupExpiredTransients()
-    {
-        $update = false;
-        // filter the query limit. Set to 0 to turn off garbage collection
-        $limit = (int) abs(
-            apply_filters(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                50
-            )
-        );
-        // non-zero LIMIT means take out the trash
-        if ($limit) {
-            $transient_keys = array();
-            foreach ($this->transients as $transient_key => $expiration) {
-                if ($expiration > $this->current_time) {
-                    continue;
-                }
-                if (! $expiration || ! $transient_key) {
-                    unset($this->transients[ $transient_key ]);
-                    $update = true;
-                    continue;
-                }
-                $transient_keys[] = $transient_key;
-            }
-            // delete expired keys, but maintain value of $update if nothing is deleted
-            $update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
-            do_action('FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
-        }
-        return $update;
-    }
-
-
-    /**
-     * calls delete_transient() on each transient key provided, up to the specified limit
-     *
-     * @param array $transient_keys [required]
-     * @param int   $limit
-     * @return bool
-     */
-    private function deleteTransientKeys(array $transient_keys, $limit = 50)
-    {
-        if (empty($transient_keys)) {
-            return false;
-        }
-        $counter = 0;
-        foreach ($transient_keys as $transient_key) {
-            if ($counter === $limit) {
-                break;
-            }
-            // remove any transient prefixes
-            $transient_key = strpos($transient_key, '_transient_timeout_') === 0
-                ? str_replace('_transient_timeout_', '', $transient_key)
-                : $transient_key;
-            $transient_key = strpos($transient_key, '_transient_') === 0
-                ? str_replace('_transient_', '', $transient_key)
-                : $transient_key;
-            delete_transient($transient_key);
-            unset($this->transients[ $transient_key ]);
-            $counter++;
-        }
-        return $counter > 0;
-    }
+	/**
+	 * wp-option option_name for tracking transients
+	 *
+	 * @type string
+	 */
+	const TRANSIENT_SCHEDULE_OPTIONS_KEY = 'ee_transient_schedule';
+
+	/**
+	 * @var int $current_time
+	 */
+	private $current_time;
+
+	/**
+	 * how often to perform transient cleanup
+	 *
+	 * @var string $transient_cleanup_frequency
+	 */
+	private $transient_cleanup_frequency;
+
+	/**
+	 * options for how often to perform transient cleanup
+	 *
+	 * @var array $transient_cleanup_frequency_options
+	 */
+	private $transient_cleanup_frequency_options = array();
+
+	/**
+	 * @var array $transients
+	 */
+	private $transients;
+
+
+	/**
+	 * TransientCacheStorage constructor.
+	 */
+	public function __construct()
+	{
+		$this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
+		// round current time down to closest 5 minutes to simplify scheduling
+		$this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
+		$this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
+			add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
+		}
+	}
+
+
+	/**
+	 * Sets how often transient cleanup occurs
+	 *
+	 * @return string
+	 */
+	private function setTransientCleanupFrequency()
+	{
+		// sets how often transients are cleaned up
+		$this->transient_cleanup_frequency_options = apply_filters(
+			'FHEE__TransientCacheStorage__transient_cleanup_schedule_options',
+			array(
+				'off',
+				'15-minutes',
+				'hour',
+				'12-hours',
+				'day',
+			)
+		);
+		$transient_cleanup_frequency = apply_filters(
+			'FHEE__TransientCacheStorage__transient_cleanup_schedule',
+			'hour'
+		);
+		return in_array(
+			$transient_cleanup_frequency,
+			$this->transient_cleanup_frequency_options,
+			true
+		)
+			? $transient_cleanup_frequency
+			: 'hour';
+	}
+
+
+	/**
+	 * we need to be able to round timestamps off to match the set transient cleanup frequency
+	 * so if a transient is set to expire at 1:17 pm for example, and our cleanup schedule is every hour,
+	 * then that timestamp needs to be rounded up to 2:00 pm so that it is removed
+	 * during the next scheduled cleanup after its expiration.
+	 * We also round off the current time timestamp to the closest 5 minutes
+	 * just to make the timestamps a little easier to round which helps with debugging.
+	 *
+	 * @param int    $timestamp [required]
+	 * @param string $cleanup_frequency
+	 * @param bool   $round_up
+	 * @return int
+	 */
+	private function roundTimestamp($timestamp, $cleanup_frequency = 'hour', $round_up = true)
+	{
+		$cleanup_frequency = $cleanup_frequency ? $cleanup_frequency : $this->transient_cleanup_frequency;
+		// in order to round the time to the closest xx minutes (or hours),
+		// we take the minutes (or hours) portion of the timestamp and divide it by xx,
+		// round down to a whole number, then multiply by xx to bring us almost back up to where we were
+		// why round down ? so the minutes (or hours) don't go over 60 (or 24)
+		// and bump the hour, which could bump the day, which could bump the month, etc,
+		// which would be bad because we don't always want to round up,
+		// but when we do we can easily achieve that by simply adding the desired offset,
+		$minutes = '00';
+		$hours = 'H';
+		switch ($cleanup_frequency) {
+			case '5-minutes':
+				$minutes = floor((int) date('i', $timestamp) / 5) * 5;
+				$minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
+				$offset = MINUTE_IN_SECONDS * 5;
+				break;
+			case '15-minutes':
+				$minutes = floor((int) date('i', $timestamp) / 15) * 15;
+				$minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
+				$offset = MINUTE_IN_SECONDS * 15;
+				break;
+			case '12-hours':
+				$hours = floor((int) date('H', $timestamp) / 12) * 12;
+				$hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
+				$offset = HOUR_IN_SECONDS * 12;
+				break;
+			case 'day':
+				$hours = '03'; // run cleanup at 3:00 am (or first site hit after that)
+				$offset = DAY_IN_SECONDS;
+				break;
+			case 'hour':
+			default:
+				$offset = HOUR_IN_SECONDS;
+				break;
+		}
+		$rounded_timestamp = (int) strtotime(date("Y-m-d {$hours}:{$minutes}:00", $timestamp));
+		$rounded_timestamp += $round_up ? $offset : 0;
+		return apply_filters(
+			'FHEE__TransientCacheStorage__roundTimestamp__timestamp',
+			$rounded_timestamp,
+			$timestamp,
+			$cleanup_frequency,
+			$round_up
+		);
+	}
+
+
+	/**
+	 * Saves supplied data to a transient
+	 * if an expiration is set, then it automatically schedules the transient for cleanup
+	 *
+	 * @param string $transient_key [required]
+	 * @param string $data          [required]
+	 * @param int    $expiration    number of seconds until the cache expires
+	 * @return bool
+	 */
+	public function add($transient_key, $data, $expiration = 0)
+	{
+		$expiration = (int) abs($expiration);
+		$saved = set_transient($transient_key, $data, $expiration);
+		if ($saved && $expiration) {
+			$this->scheduleTransientCleanup($transient_key, $expiration);
+		}
+		return $saved;
+	}
+
+
+	/**
+	 * retrieves transient data
+	 * automatically triggers early cache refresh for standard cache items
+	 * in order to avoid cache stampedes on busy sites.
+	 * For non-standard cache items like PHP Session data where early refreshing is not wanted,
+	 * the $standard_cache parameter should be set to false when retrieving data
+	 *
+	 * @param string $transient_key [required]
+	 * @param bool   $standard_cache
+	 * @return mixed|null
+	 */
+	public function get($transient_key, $standard_cache = true)
+	{
+		if (isset($this->transients[ $transient_key ])) {
+			// to avoid cache stampedes (AKA:dogpiles) for standard cache items,
+			// check if known cache expires within the next minute,
+			// and if so, remove it from our tracking and and return nothing.
+			// this should trigger the cache content to be regenerated during this request,
+			// while allowing any following requests to still access the existing cache
+			// until it gets replaced with the refreshed content
+			if (
+				$standard_cache
+				&& $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
+			) {
+				unset($this->transients[ $transient_key ]);
+				$this->updateTransients();
+				return null;
+			}
+
+			// for non standard cache items, remove the key from our tracking,
+			// but proceed to retrieve the transient so that it also gets removed from the db
+			if ($this->transients[ $transient_key ] <= time()) {
+				unset($this->transients[ $transient_key ]);
+				$this->updateTransients();
+			}
+		}
+
+		$content = get_transient($transient_key);
+		return $content !== false ? $content : null;
+	}
+
+
+	/**
+	 * delete a single transient and remove tracking
+	 *
+	 * @param string $transient_key [required] full or partial transient key to be deleted
+	 */
+	public function delete($transient_key)
+	{
+		$this->deleteMany(array($transient_key));
+	}
+
+
+	/**
+	 * delete multiple transients and remove tracking
+	 *
+	 * @param array $transient_keys [required] array of full or partial transient keys to be deleted
+	 * @param bool  $force_delete   [optional] if true, then will not check incoming keys against those being tracked
+	 *                              and proceed directly to deleting those entries from the cache storage
+	 */
+	public function deleteMany(array $transient_keys, $force_delete = false)
+	{
+		$full_transient_keys = $force_delete ? $transient_keys : array();
+		if (empty($full_transient_keys)) {
+			foreach ($this->transients as $transient_key => $expiration) {
+				foreach ($transient_keys as $transient_key_to_delete) {
+					if (strpos($transient_key, $transient_key_to_delete) !== false) {
+						$full_transient_keys[] = $transient_key;
+					}
+				}
+			}
+		}
+		if ($this->deleteTransientKeys($full_transient_keys)) {
+			$this->updateTransients();
+		}
+	}
+
+
+	/**
+	 * sorts transients numerically by timestamp
+	 * then saves the transient schedule to a WP option
+	 */
+	private function updateTransients()
+	{
+		asort($this->transients, SORT_NUMERIC);
+		update_option(
+			TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY,
+			$this->transients
+		);
+	}
+
+
+	/**
+	 * schedules a transient for cleanup by adding it to the transient tracking
+	 *
+	 * @param string $transient_key [required]
+	 * @param int    $expiration    [required]
+	 */
+	private function scheduleTransientCleanup($transient_key, $expiration)
+	{
+		// make sure a valid future timestamp is set
+		$expiration += $expiration < time() ? time() : 0;
+		// and round to the closest 15 minutes
+		$expiration = $this->roundTimestamp($expiration);
+		// save transients to clear using their ID as the key to avoid duplicates
+		$this->transients[ $transient_key ] = $expiration;
+		$this->updateTransients();
+	}
+
+
+	/**
+	 * Since our tracked transients are sorted by their timestamps
+	 * we can grab the first transient and see when it is scheduled for cleanup.
+	 * If that timestamp is less than or equal to the current time,
+	 * then cleanup is triggered
+	 */
+	public function checkTransientCleanupSchedule()
+	{
+		if (empty($this->transients)) {
+			return;
+		}
+		// when do we run the next cleanup job?
+		reset($this->transients);
+		$next_scheduled_cleanup = current($this->transients);
+		// if the next cleanup job is scheduled for the current hour
+		if ($next_scheduled_cleanup <= $this->current_time) {
+			if ($this->cleanupExpiredTransients()) {
+				$this->updateTransients();
+			}
+		}
+	}
+
+
+	/**
+	 * loops through the array of tracked transients,
+	 * compiles a list of those that have expired, and sends that list off for deletion.
+	 * Also removes any bad records from the transients array
+	 *
+	 * @return bool
+	 */
+	private function cleanupExpiredTransients()
+	{
+		$update = false;
+		// filter the query limit. Set to 0 to turn off garbage collection
+		$limit = (int) abs(
+			apply_filters(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				50
+			)
+		);
+		// non-zero LIMIT means take out the trash
+		if ($limit) {
+			$transient_keys = array();
+			foreach ($this->transients as $transient_key => $expiration) {
+				if ($expiration > $this->current_time) {
+					continue;
+				}
+				if (! $expiration || ! $transient_key) {
+					unset($this->transients[ $transient_key ]);
+					$update = true;
+					continue;
+				}
+				$transient_keys[] = $transient_key;
+			}
+			// delete expired keys, but maintain value of $update if nothing is deleted
+			$update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
+			do_action('FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
+		}
+		return $update;
+	}
+
+
+	/**
+	 * calls delete_transient() on each transient key provided, up to the specified limit
+	 *
+	 * @param array $transient_keys [required]
+	 * @param int   $limit
+	 * @return bool
+	 */
+	private function deleteTransientKeys(array $transient_keys, $limit = 50)
+	{
+		if (empty($transient_keys)) {
+			return false;
+		}
+		$counter = 0;
+		foreach ($transient_keys as $transient_key) {
+			if ($counter === $limit) {
+				break;
+			}
+			// remove any transient prefixes
+			$transient_key = strpos($transient_key, '_transient_timeout_') === 0
+				? str_replace('_transient_timeout_', '', $transient_key)
+				: $transient_key;
+			$transient_key = strpos($transient_key, '_transient_') === 0
+				? str_replace('_transient_', '', $transient_key)
+				: $transient_key;
+			delete_transient($transient_key);
+			unset($this->transients[ $transient_key ]);
+			$counter++;
+		}
+		return $counter > 0;
+	}
 }

core/services/container/DependencyInjector.php

Spacing +26 added lines, -26 removed lines

@@ -71,12 +71,12 @@ 
     public function getReflectionClass($class_name)
     {
         if (
-            ! isset($this->reflectors[ $class_name ])
-            || ! $this->reflectors[ $class_name ] instanceof ReflectionClass
+            ! isset($this->reflectors[$class_name])
+            || ! $this->reflectors[$class_name] instanceof ReflectionClass
         ) {
-            $this->reflectors[ $class_name ] = new ReflectionClass($class_name);
+            $this->reflectors[$class_name] = new ReflectionClass($class_name);
         }
-        return $this->reflectors[ $class_name ];
+        return $this->reflectors[$class_name];
     }
 
 
@@ -91,12 +91,12 @@ 
     protected function getConstructor(ReflectionClass $reflector)
     {
         if (
-            ! isset($this->constructors[ $reflector->getName() ])
-            || ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
+            ! isset($this->constructors[$reflector->getName()])
+            || ! $this->constructors[$reflector->getName()] instanceof ReflectionMethod
         ) {
-            $this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
+            $this->constructors[$reflector->getName()] = $reflector->getConstructor();
         }
-        return $this->constructors[ $reflector->getName() ];
+        return $this->constructors[$reflector->getName()];
     }
 
 
@@ -110,10 +110,10 @@ 
      */
     protected function getParameters(ReflectionMethod $constructor)
     {
-        if (! isset($this->parameters[ $constructor->class ])) {
-            $this->parameters[ $constructor->class ] = $constructor->getParameters();
+        if ( ! isset($this->parameters[$constructor->class])) {
+            $this->parameters[$constructor->class] = $constructor->getParameters();
         }
-        return $this->parameters[ $constructor->class ];
+        return $this->parameters[$constructor->class];
     }
 
 
@@ -148,7 +148,7 @@ 
         // let's examine the constructor
         $constructor = $this->getConstructor($reflector);
         // whu? huh? nothing?
-        if (! $constructor) {
+        if ( ! $constructor) {
             return $arguments;
         }
         // get constructor parameters
@@ -161,7 +161,7 @@ 
         $argument_keys = array_keys($arguments);
         // now loop thru all of the constructors expected parameters
         foreach ($params as $index => $param) {
-            if (! $param instanceof ReflectionParameter) {
+            if ( ! $param instanceof ReflectionParameter) {
                 continue;
             }
             // is this a dependency for a specific class ?
@@ -169,41 +169,41 @@ 
             $param_name = $param->getName() ? $param->getName() : '';
             if (
 // param is not a class but is specified in the list of ingredients for this Recipe
-                is_string($param_name) && isset($ingredients[ $param_name ])
+                is_string($param_name) && isset($ingredients[$param_name])
             ) {
                 // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $ingredients[ $param_name ];
+                $resolved_parameters[$index] = $ingredients[$param_name];
             } elseif (
 // param is specified in the list of ingredients for this Recipe
-                isset($ingredients[ $param_class ])
+                isset($ingredients[$param_class])
             ) { // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
+                $resolved_parameters[$index] = $this->injectDependency($reflector, $ingredients[$param_class]);
             } elseif (
 // param is not even a class
                 empty($param_class)
                 // and something already exists in the incoming arguments for this param
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
             ) {
                 // add parameter from incoming arguments
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
+                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
             } elseif (
 // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
                 ! empty($param_class)
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+                && $arguments[$argument_keys[$index]] instanceof $param_class
             ) {
                 // add parameter from incoming arguments
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
+                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
             } elseif (
 // parameter is type hinted as a class, and should be injected
                 ! empty($param_class)
             ) {
                 // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
+                $resolved_parameters[$index] = $this->injectDependency($reflector, $param_class);
             } elseif ($param->isOptional()) {
-                $resolved_parameters[ $index ] = $param->getDefaultValue();
+                $resolved_parameters[$index] = $param->getDefaultValue();
             } else {
-                $resolved_parameters[ $index ] = null;
+                $resolved_parameters[$index] = null;
             }
         }
         return $resolved_parameters;
@@ -219,7 +219,7 @@ 
     private function injectDependency(ReflectionClass $reflector, $param_class)
     {
         $dependency = $this->coffee_pot->brew($param_class);
-        if (! $dependency instanceof $param_class) {
+        if ( ! $dependency instanceof $param_class) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(

Indentation +207 added lines, -207 removed lines

@@ -20,216 +20,216 @@
  */
 class DependencyInjector implements InjectorInterface
 {
-    /**
-     * @var CoffeePotInterface $coffee_pot
-     */
-    private $coffee_pot;
-
-    /**
-     * @var EEH_Array $array_helper
-     */
-    private $array_helper;
-
-    /**
-     * @var ReflectionClass[] $reflectors
-     */
-    private $reflectors;
-
-    /**
-     * @var ReflectionMethod[] $constructors
-     */
-    private $constructors;
-
-    /**
-     * @var ReflectionParameter[] $parameters
-     */
-    private $parameters;
-
-
-    /**
-     * DependencyInjector constructor
-     *
-     * @param CoffeePotInterface $coffee_pot
-     * @param EEH_Array          $array_helper
-     */
-    public function __construct(CoffeePotInterface $coffee_pot, EEH_Array $array_helper)
-    {
-        $this->coffee_pot = $coffee_pot;
-        $this->array_helper = $array_helper;
-    }
-
-
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @param string $class_name
-     * @return ReflectionClass
-     */
-    public function getReflectionClass($class_name)
-    {
-        if (
-            ! isset($this->reflectors[ $class_name ])
-            || ! $this->reflectors[ $class_name ] instanceof ReflectionClass
-        ) {
-            $this->reflectors[ $class_name ] = new ReflectionClass($class_name);
-        }
-        return $this->reflectors[ $class_name ];
-    }
-
-
-    /**
-     * getConstructor
-     * checks if a ReflectionMethod object has already been generated for the class constructor
-     * and returns that instead of creating a new one
-     *
-     * @param ReflectionClass $reflector
-     * @return ReflectionMethod
-     */
-    protected function getConstructor(ReflectionClass $reflector)
-    {
-        if (
-            ! isset($this->constructors[ $reflector->getName() ])
-            || ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
-        ) {
-            $this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
-        }
-        return $this->constructors[ $reflector->getName() ];
-    }
-
-
-    /**
-     * getParameters
-     * checks if an array of ReflectionParameter objects has already been generated for the class constructor
-     * and returns that instead of creating a new one
-     *
-     * @param ReflectionMethod $constructor
-     * @return ReflectionParameter[]
-     */
-    protected function getParameters(ReflectionMethod $constructor)
-    {
-        if (! isset($this->parameters[ $constructor->class ])) {
-            $this->parameters[ $constructor->class ] = $constructor->getParameters();
-        }
-        return $this->parameters[ $constructor->class ];
-    }
-
-
-    /**
-     * resolveDependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param RecipeInterface $recipe
-     * @param ReflectionClass $reflector
-     * @param array           $arguments
-     * @return array
-     * @throws UnexpectedValueException
-     */
-    public function resolveDependencies(RecipeInterface $recipe, ReflectionClass $reflector, $arguments = array())
-    {
-        // if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : array($arguments);
-        $resolved_parameters = array();
-        // let's examine the constructor
-        // let's examine the constructor
-        $constructor = $this->getConstructor($reflector);
-        // whu? huh? nothing?
-        if (! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $this->getParameters($constructor);
-        if (empty($params)) {
-            return $resolved_parameters;
-        }
-        $ingredients = $recipe->ingredients();
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            if (! $param instanceof ReflectionParameter) {
-                continue;
-            }
-            // is this a dependency for a specific class ?
-            $param_class = $param->getClass() ? $param->getClass()->name : '';
-            $param_name = $param->getName() ? $param->getName() : '';
-            if (
+	/**
+	 * @var CoffeePotInterface $coffee_pot
+	 */
+	private $coffee_pot;
+
+	/**
+	 * @var EEH_Array $array_helper
+	 */
+	private $array_helper;
+
+	/**
+	 * @var ReflectionClass[] $reflectors
+	 */
+	private $reflectors;
+
+	/**
+	 * @var ReflectionMethod[] $constructors
+	 */
+	private $constructors;
+
+	/**
+	 * @var ReflectionParameter[] $parameters
+	 */
+	private $parameters;
+
+
+	/**
+	 * DependencyInjector constructor
+	 *
+	 * @param CoffeePotInterface $coffee_pot
+	 * @param EEH_Array          $array_helper
+	 */
+	public function __construct(CoffeePotInterface $coffee_pot, EEH_Array $array_helper)
+	{
+		$this->coffee_pot = $coffee_pot;
+		$this->array_helper = $array_helper;
+	}
+
+
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 */
+	public function getReflectionClass($class_name)
+	{
+		if (
+			! isset($this->reflectors[ $class_name ])
+			|| ! $this->reflectors[ $class_name ] instanceof ReflectionClass
+		) {
+			$this->reflectors[ $class_name ] = new ReflectionClass($class_name);
+		}
+		return $this->reflectors[ $class_name ];
+	}
+
+
+	/**
+	 * getConstructor
+	 * checks if a ReflectionMethod object has already been generated for the class constructor
+	 * and returns that instead of creating a new one
+	 *
+	 * @param ReflectionClass $reflector
+	 * @return ReflectionMethod
+	 */
+	protected function getConstructor(ReflectionClass $reflector)
+	{
+		if (
+			! isset($this->constructors[ $reflector->getName() ])
+			|| ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
+		) {
+			$this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
+		}
+		return $this->constructors[ $reflector->getName() ];
+	}
+
+
+	/**
+	 * getParameters
+	 * checks if an array of ReflectionParameter objects has already been generated for the class constructor
+	 * and returns that instead of creating a new one
+	 *
+	 * @param ReflectionMethod $constructor
+	 * @return ReflectionParameter[]
+	 */
+	protected function getParameters(ReflectionMethod $constructor)
+	{
+		if (! isset($this->parameters[ $constructor->class ])) {
+			$this->parameters[ $constructor->class ] = $constructor->getParameters();
+		}
+		return $this->parameters[ $constructor->class ];
+	}
+
+
+	/**
+	 * resolveDependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param RecipeInterface $recipe
+	 * @param ReflectionClass $reflector
+	 * @param array           $arguments
+	 * @return array
+	 * @throws UnexpectedValueException
+	 */
+	public function resolveDependencies(RecipeInterface $recipe, ReflectionClass $reflector, $arguments = array())
+	{
+		// if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: array($arguments);
+		$resolved_parameters = array();
+		// let's examine the constructor
+		// let's examine the constructor
+		$constructor = $this->getConstructor($reflector);
+		// whu? huh? nothing?
+		if (! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $this->getParameters($constructor);
+		if (empty($params)) {
+			return $resolved_parameters;
+		}
+		$ingredients = $recipe->ingredients();
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			if (! $param instanceof ReflectionParameter) {
+				continue;
+			}
+			// is this a dependency for a specific class ?
+			$param_class = $param->getClass() ? $param->getClass()->name : '';
+			$param_name = $param->getName() ? $param->getName() : '';
+			if (
 // param is not a class but is specified in the list of ingredients for this Recipe
-                is_string($param_name) && isset($ingredients[ $param_name ])
-            ) {
-                // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $ingredients[ $param_name ];
-            } elseif (
+				is_string($param_name) && isset($ingredients[ $param_name ])
+			) {
+				// attempt to inject the dependency
+				$resolved_parameters[ $index ] = $ingredients[ $param_name ];
+			} elseif (
 // param is specified in the list of ingredients for this Recipe
-                isset($ingredients[ $param_class ])
-            ) { // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
-            } elseif (
+				isset($ingredients[ $param_class ])
+			) { // attempt to inject the dependency
+				$resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
+			} elseif (
 // param is not even a class
-                empty($param_class)
-                // and something already exists in the incoming arguments for this param
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-            ) {
-                // add parameter from incoming arguments
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
-            } elseif (
+				empty($param_class)
+				// and something already exists in the incoming arguments for this param
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
+			) {
+				// add parameter from incoming arguments
+				$resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
+			} elseif (
 // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                ! empty($param_class)
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
-            ) {
-                // add parameter from incoming arguments
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
-            } elseif (
+				! empty($param_class)
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
+				&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+			) {
+				// add parameter from incoming arguments
+				$resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
+			} elseif (
 // parameter is type hinted as a class, and should be injected
-                ! empty($param_class)
-            ) {
-                // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
-            } elseif ($param->isOptional()) {
-                $resolved_parameters[ $index ] = $param->getDefaultValue();
-            } else {
-                $resolved_parameters[ $index ] = null;
-            }
-        }
-        return $resolved_parameters;
-    }
-
-
-    /**
-     * @param ReflectionClass $reflector
-     * @param string          $param_class
-     * @return mixed
-     * @throws UnexpectedValueException
-     */
-    private function injectDependency(ReflectionClass $reflector, $param_class)
-    {
-        $dependency = $this->coffee_pot->brew($param_class);
-        if (! $dependency instanceof $param_class) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
-                        'event_espresso'
-                    ),
-                    $param_class,
-                    $reflector->getName()
-                )
-            );
-        }
-        return $dependency;
-    }
+				! empty($param_class)
+			) {
+				// attempt to inject the dependency
+				$resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
+			} elseif ($param->isOptional()) {
+				$resolved_parameters[ $index ] = $param->getDefaultValue();
+			} else {
+				$resolved_parameters[ $index ] = null;
+			}
+		}
+		return $resolved_parameters;
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflector
+	 * @param string          $param_class
+	 * @return mixed
+	 * @throws UnexpectedValueException
+	 */
+	private function injectDependency(ReflectionClass $reflector, $param_class)
+	{
+		$dependency = $this->coffee_pot->brew($param_class);
+		if (! $dependency instanceof $param_class) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
+						'event_espresso'
+					),
+					$param_class,
+					$reflector->getName()
+				)
+			);
+		}
+		return $dependency;
+	}
 }

core/db_classes/EE_Datetime.class.php

Spacing +9 added lines, -9 removed lines

@@ -533,7 +533,7 @@ 
             $date_or_time,
             $echo
         );
-        if (! $echo) {
+        if ( ! $echo) {
             return $dtt;
         }
         return '';
@@ -635,7 +635,7 @@ 
             ' ',
             $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt)
         );
-        return $start !== $end ? $start . $conjunction . $end : $start;
+        return $start !== $end ? $start.$conjunction.$end : $start;
     }
 
 
@@ -743,7 +743,7 @@ 
             ' ',
             $this->get_i18n_datetime('DTT_EVT_end', $tm_format)
         );
-        return $start !== $end ? $start . $conjunction . $end : $start;
+        return $start !== $end ? $start.$conjunction.$end : $start;
     }
 
 
@@ -788,7 +788,7 @@ 
     ) {
         $dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
         $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
-        $full_format = $dt_format . $separator . $tm_format;
+        $full_format = $dt_format.$separator.$tm_format;
         // the range output depends on various conditions
         switch (true) {
             // start date timestamp and end date timestamp are the same.
@@ -1029,7 +1029,7 @@ 
         // tickets remaining available for purchase
         // no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
         $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
-        if (! $consider_tickets) {
+        if ( ! $consider_tickets) {
             return $dtt_remaining;
         }
         $tickets_remaining = $this->tickets_remaining();
@@ -1053,7 +1053,7 @@ 
     {
         $sum = 0;
         $tickets = $this->tickets($query_params);
-        if (! empty($tickets)) {
+        if ( ! empty($tickets)) {
             foreach ($tickets as $ticket) {
                 if ($ticket instanceof EE_Ticket) {
                     // get the actual amount of tickets that can be sold
@@ -1204,7 +1204,7 @@ 
     {
         if ($use_dtt_name) {
             $dtt_name = $this->name();
-            if (! empty($dtt_name)) {
+            if ( ! empty($dtt_name)) {
                 return $dtt_name;
             }
         }
@@ -1212,14 +1212,14 @@ 
         if (
             date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end'))
         ) {
-            $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a');
+            $display_date = $this->start_date('M j\, Y g:i a').' - '.$this->end_date('M j\, Y g:i a');
             // next condition is if its the same month but different day
         } else {
             if (
                 date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end'))
                 && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end'))
             ) {
-                $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y');
+                $display_date = $this->start_date('M j\, g:i a').' - '.$this->end_date('M j\, g:i a Y');
             } else {
                 $display_date = $this->start_date('F j\, Y')
                                 . ' @ '

Indentation +1552 added lines, -1552 removed lines

@@ -12,1560 +12,1560 @@
  */
 class EE_Datetime extends EE_Soft_Delete_Base_Class
 {
-    /**
-     * constant used by get_active_status, indicates datetime has no more available spaces
-     */
-    const sold_out = 'DTS';
-
-    /**
-     * constant used by get_active_status, indicating datetime is still active (even is not over, can be registered-for)
-     */
-    const active = 'DTA';
-
-    /**
-     * constant used by get_active_status, indicating the datetime cannot be used for registrations yet, but has not
-     * expired
-     */
-    const upcoming = 'DTU';
-
-    /**
-     * Datetime is postponed
-     */
-    const postponed = 'DTP';
-
-    /**
-     * Datetime is cancelled
-     */
-    const cancelled = 'DTC';
-
-    /**
-     * constant used by get_active_status, indicates datetime has expired (event is over)
-     */
-    const expired = 'DTE';
-
-    /**
-     * constant used in various places indicating that an event is INACTIVE (not yet ready to be published)
-     */
-    const inactive = 'DTI';
-
-
-    /**
-     * @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_Datetime
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object(
-            $props_n_values,
-            __CLASS__,
-            $timezone,
-            $date_formats
-        );
-        return $has_object
-            ? $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_Datetime
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param $name
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('DTT_name', $name);
-    }
-
-
-    /**
-     * @param $description
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_description($description)
-    {
-        $this->set('DTT_description', $description);
-    }
-
-
-    /**
-     * Set event start date
-     * set the start date for an event
-     *
-     * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_start_date($date)
-    {
-        $this->_set_date_for($date, 'DTT_EVT_start');
-    }
-
-
-    /**
-     * Set event start time
-     * set the start time for an event
-     *
-     * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_start_time($time)
-    {
-        $this->_set_time_for($time, 'DTT_EVT_start');
-    }
-
-
-    /**
-     * Set event end date
-     * set the end date for an event
-     *
-     * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_end_date($date)
-    {
-        $this->_set_date_for($date, 'DTT_EVT_end');
-    }
-
-
-    /**
-     * Set event end time
-     * set the end time for an event
-     *
-     * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_end_time($time)
-    {
-        $this->_set_time_for($time, 'DTT_EVT_end');
-    }
-
-
-    /**
-     * Set registration limit
-     * set the maximum number of attendees that can be registered for this datetime slot
-     *
-     * @param int|float $reg_limit
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_reg_limit($reg_limit)
-    {
-        $this->set('DTT_reg_limit', $reg_limit);
-    }
-
-
-    /**
-     * get the number of tickets sold for this datetime slot
-     *
-     * @return mixed int on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sold()
-    {
-        return $this->get_raw('DTT_sold');
-    }
-
-
-    /**
-     * @param int $sold
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_sold($sold)
-    {
-        // sold can not go below zero
-        $sold = max(0, $sold);
-        $this->set('DTT_sold', $sold);
-    }
-
-
-    /**
-     * Increments sold by amount passed by $qty, and persists it immediately to the database.
-     * Simultaneously decreases the reserved count, unless $also_decrease_reserved is false.
-     *
-     * @param int $qty
-     * @param boolean $also_decrease_reserved
-     * @return boolean indicating success
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function increaseSold(int $qty = 1, bool $also_decrease_reserved = true): bool
-    {
-        $qty = absint($qty);
-        if ($also_decrease_reserved) {
-            $success = $this->adjustNumericFieldsInDb(
-                [
-                    'DTT_reserved' => $qty * -1,
-                    'DTT_sold' => $qty
-                ]
-            );
-        } else {
-            $success = $this->adjustNumericFieldsInDb(
-                [
-                    'DTT_sold' => $qty
-                ]
-            );
-        }
-
-        do_action(
-            'AHEE__EE_Datetime__increase_sold',
-            $this,
-            $qty,
-            $this->sold(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need
-     * to save afterwards.)
-     *
-     * @param int $qty
-     * @return boolean indicating success
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function decreaseSold(int $qty = 1): bool
-    {
-        $qty = absint($qty);
-        $success = $this->adjustNumericFieldsInDb(
-            [
-                'DTT_sold' => $qty * -1
-            ]
-        );
-        do_action(
-            'AHEE__EE_Datetime__decrease_sold',
-            $this,
-            $qty,
-            $this->sold(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Gets qty of reserved tickets for this datetime
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function reserved(): int
-    {
-        return $this->get_raw('DTT_reserved');
-    }
-
-
-    /**
-     * Sets qty of reserved tickets for this datetime
-     *
-     * @param int $reserved
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_reserved(int $reserved)
-    {
-        // reserved can not go below zero
-        $reserved = max(0, $reserved);
-        $this->set('DTT_reserved', $reserved);
-    }
-
-
-    /**
-     * Increments reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @param int $qty
-     * @return boolean indicating success
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function increaseReserved(int $qty = 1): bool
-    {
-        $qty = absint($qty);
-        $success = $this->incrementFieldConditionallyInDb(
-            'DTT_reserved',
-            'DTT_sold',
-            'DTT_reg_limit',
-            $qty
-        );
-        do_action(
-            'AHEE__EE_Datetime__increase_reserved',
-            $this,
-            $qty,
-            $this->reserved(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @param int $qty
-     * @return boolean indicating success
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function decreaseReserved(int $qty = 1): bool
-    {
-        $qty = absint($qty);
-        $success = $this->adjustNumericFieldsInDb(
-            [
-                'DTT_reserved' => $qty * -1
-            ]
-        );
-        do_action(
-            'AHEE__EE_Datetime__decrease_reserved',
-            $this,
-            $qty,
-            $this->reserved(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * total sold and reserved tickets
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sold_and_reserved(): int
-    {
-        return $this->sold() + $this->reserved();
-    }
-
-
-    /**
-     * returns the datetime name
-     *
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function name(): string
-    {
-        return $this->get('DTT_name');
-    }
-
-
-    /**
-     * returns the datetime description
-     *
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function description(): string
-    {
-        return $this->get('DTT_description');
-    }
-
-
-    /**
-     * This helper simply returns whether the event_datetime for the current datetime is a primary datetime
-     *
-     * @return boolean  TRUE if is primary, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_primary(): bool
-    {
-        return $this->get('DTT_is_primary');
-    }
-
-
-    /**
-     * This helper simply returns the order for the datetime
-     *
-     * @return int  The order of the datetime for this event.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function order(): int
-    {
-        return $this->get('DTT_order');
-    }
-
-
-    /**
-     * This helper simply returns the parent id for the datetime
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function parent(): int
-    {
-        return $this->get('DTT_parent');
-    }
-
-
-    /**
-     * show date and/or time
-     *
-     * @param string $date_or_time    whether to display a date or time or both
-     * @param string $start_or_end    whether to display start or end datetimes
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param bool   $echo            whether we echo or return (note echoing uses "pretty" formats,
-     *                                otherwise we use the standard formats)
-     * @return string|bool  string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function _show_datetime(
-        $date_or_time = null,
-        $start_or_end = 'start',
-        $dt_frmt = '',
-        $tm_frmt = '',
-        $echo = false
-    ) {
-        $field_name = "DTT_EVT_{$start_or_end}";
-        $dtt = $this->_get_datetime(
-            $field_name,
-            $dt_frmt,
-            $tm_frmt,
-            $date_or_time,
-            $echo
-        );
-        if (! $echo) {
-            return $dtt;
-        }
-        return '';
-    }
-
-
-    /**
-     * get event start date.  Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt string representation of date format defaults to 'F j, Y'
-     * @return mixed            string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start_date($dt_frmt = '')
-    {
-        return $this->_show_datetime('D', 'start', $dt_frmt);
-    }
-
-
-    /**
-     * Echoes start_date()
-     *
-     * @param string $dt_frmt
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_start_date($dt_frmt = '')
-    {
-        $this->_show_datetime('D', 'start', $dt_frmt, null, true);
-    }
-
-
-    /**
-     * get end date. Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt string representation of date format defaults to 'F j, Y'
-     * @return mixed            string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end_date($dt_frmt = '')
-    {
-        return $this->_show_datetime('D', 'end', $dt_frmt);
-    }
-
-
-    /**
-     * Echoes the end date. See end_date()
-     *
-     * @param string $dt_frmt
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_end_date($dt_frmt = '')
-    {
-        $this->_show_datetime('D', 'end', $dt_frmt, null, true);
-    }
-
-
-    /**
-     * get date_range - meaning the start AND end date
-     *
-     * @access public
-     * @param string $dt_frmt     string representation of date format defaults to WP settings
-     * @param string $conjunction conjunction junction what's your function ?
-     *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return mixed              string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function date_range($dt_frmt = '', $conjunction = ' - ')
-    {
-        $dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
-        $start = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt)
-        );
-        $end = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt)
-        );
-        return $start !== $end ? $start . $conjunction . $end : $start;
-    }
-
-
-    /**
-     * @param string $dt_frmt
-     * @param string $conjunction
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_date_range($dt_frmt = '', $conjunction = ' - ')
-    {
-        echo esc_html($this->date_range($dt_frmt, $conjunction));
-    }
-
-
-    /**
-     * get start time
-     *
-     * @param string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return mixed        string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start_time($tm_format = '')
-    {
-        return $this->_show_datetime('T', 'start', null, $tm_format);
-    }
-
-
-    /**
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_start_time($tm_format = '')
-    {
-        $this->_show_datetime('T', 'start', null, $tm_format, true);
-    }
-
-
-    /**
-     * get end time
-     *
-     * @param string $tm_format string representation of time format defaults to 'g:i a'
-     * @return mixed                string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end_time($tm_format = '')
-    {
-        return $this->_show_datetime('T', 'end', null, $tm_format);
-    }
-
-
-    /**
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_end_time($tm_format = '')
-    {
-        $this->_show_datetime('T', 'end', null, $tm_format, true);
-    }
-
-
-    /**
-     * get time_range
-     *
-     * @access public
-     * @param string $tm_format   string representation of time format defaults to 'g:i a'
-     * @param string $conjunction conjunction junction what's your function ?
-     *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return mixed              string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function time_range($tm_format = '', $conjunction = ' - ')
-    {
-        $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
-        $start = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_start', $tm_format)
-        );
-        $end = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_end', $tm_format)
-        );
-        return $start !== $end ? $start . $conjunction . $end : $start;
-    }
-
-
-    /**
-     * @param string $tm_format
-     * @param string $conjunction
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_time_range($tm_format = '', $conjunction = ' - ')
-    {
-        echo esc_html($this->time_range($tm_format, $conjunction));
-    }
-
-
-    /**
-     * This returns a range representation of the date and times.
-     * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end.
-     * Also, the return value is localized.
-     *
-     * @param string $dt_format
-     * @param string $tm_format
-     * @param string $conjunction used between two different dates or times.
-     *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
-     * @param string $separator   used between the date and time formats.
-     *                            ex: Dec 1, 2016{$separator}2pm
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function date_and_time_range(
-        $dt_format = '',
-        $tm_format = '',
-        $conjunction = ' - ',
-        $separator = ' '
-    ) {
-        $dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
-        $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
-        $full_format = $dt_format . $separator . $tm_format;
-        // the range output depends on various conditions
-        switch (true) {
-            // start date timestamp and end date timestamp are the same.
-            case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')):
-                $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format);
-                break;
-            // start and end date are the same but times are different
-            case ($this->start_date() === $this->end_date()):
-                $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
-                          . $conjunction
-                          . $this->get_i18n_datetime('DTT_EVT_end', $tm_format);
-                break;
-            // all other conditions
-            default:
-                $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
-                          . $conjunction
-                          . $this->get_i18n_datetime('DTT_EVT_end', $full_format);
-                break;
-        }
-        return $output;
-    }
-
-
-    /**
-     * This echos the results of date and time range.
-     *
-     * @see date_and_time_range() for more details on purpose.
-     * @param string $dt_format
-     * @param string $tm_format
-     * @param string $conjunction
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ')
-    {
-        echo esc_html($this->date_and_time_range($dt_format, $tm_format, $conjunction));
-    }
-
-
-    /**
-     * get start date and start time
-     *
-     * @param    string $dt_format - string representation of date format defaults to 'F j, Y'
-     * @param    string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return    mixed    string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start_date_and_time($dt_format = '', $tm_format = '')
-    {
-        return $this->_show_datetime('', 'start', $dt_format, $tm_format);
-    }
-
-
-    /**
-     * @param string $dt_frmt
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_start_date_and_time($dt_frmt = '', $tm_format = '')
-    {
-        $this->_show_datetime('', 'start', $dt_frmt, $tm_format, true);
-    }
-
-
-    /**
-     * Shows the length of the event (start to end time).
-     * Can be shown in 'seconds','minutes','hours', or 'days'.
-     * By default, rounds up. (So if you use 'days', and then event
-     * only occurs for 1 hour, it will return 1 day).
-     *
-     * @param string $units 'seconds','minutes','hours','days'
-     * @param bool   $round_up
-     * @return float|int|mixed
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function length($units = 'seconds', $round_up = false)
-    {
-        $start = $this->get_raw('DTT_EVT_start');
-        $end = $this->get_raw('DTT_EVT_end');
-        $length_in_units = $end - $start;
-        switch ($units) {
-            // NOTE: We purposefully don't use "break;" in order to chain the divisions
-            /** @noinspection PhpMissingBreakStatementInspection */
-            // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-            case 'days':
-                $length_in_units /= 24;
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'hours':
-                // fall through is intentional
-                $length_in_units /= 60;
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'minutes':
-                // fall through is intentional
-                $length_in_units /= 60;
-            case 'seconds':
-            default:
-                $length_in_units = ceil($length_in_units);
-        }
-        // phpcs:enable
-        if ($round_up) {
-            $length_in_units = max($length_in_units, 1);
-        }
-        return $length_in_units;
-    }
-
-
-    /**
-     *        get end date and time
-     *
-     * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
-     * @param string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return    mixed                string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end_date_and_time($dt_frmt = '', $tm_format = '')
-    {
-        return $this->_show_datetime('', 'end', $dt_frmt, $tm_format);
-    }
-
-
-    /**
-     * @param string $dt_frmt
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_end_date_and_time($dt_frmt = '', $tm_format = '')
-    {
-        $this->_show_datetime('', 'end', $dt_frmt, $tm_format, true);
-    }
-
-
-    /**
-     *        get start timestamp
-     *
-     * @return        int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start()
-    {
-        return $this->get_raw('DTT_EVT_start');
-    }
-
-
-    /**
-     *        get end timestamp
-     *
-     * @return        int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end()
-    {
-        return $this->get_raw('DTT_EVT_end');
-    }
-
-
-    /**
-     *    get the registration limit for this datetime slot
-     *
-     * @return int|float                int = finite limit   EE_INF(float) = unlimited
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function reg_limit()
-    {
-        return $this->get_raw('DTT_reg_limit');
-    }
-
-
-    /**
-     *    have the tickets sold for this datetime, met or exceed the registration limit ?
-     *
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sold_out()
-    {
-        return $this->reg_limit() > 0 && $this->sold() >= $this->reg_limit();
-    }
-
-
-    /**
-     * return the total number of spaces remaining at this venue.
-     * This only takes the venue's capacity into account, NOT the tickets available for sale
-     *
-     * @param bool $consider_tickets Whether to consider tickets remaining when determining if there are any spaces left
-     *                               Because if all tickets attached to this datetime have no spaces left,
-     *                               then this datetime IS effectively sold out.
-     *                               However, there are cases where we just want to know the spaces
-     *                               remaining for this particular datetime, hence the flag.
-     * @return int|float
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function spaces_remaining($consider_tickets = false)
-    {
-        // tickets remaining available for purchase
-        // no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
-        $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
-        if (! $consider_tickets) {
-            return $dtt_remaining;
-        }
-        $tickets_remaining = $this->tickets_remaining();
-        return min($dtt_remaining, $tickets_remaining);
-    }
-
-
-    /**
-     * Counts the total tickets available
-     * (from all the different types of tickets which are available for this datetime).
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function tickets_remaining($query_params = array())
-    {
-        $sum = 0;
-        $tickets = $this->tickets($query_params);
-        if (! empty($tickets)) {
-            foreach ($tickets as $ticket) {
-                if ($ticket instanceof EE_Ticket) {
-                    // get the actual amount of tickets that can be sold
-                    $qty = $ticket->qty('saleable');
-                    if ($qty === EE_INF) {
-                        return EE_INF;
-                    }
-                    // no negative ticket quantities plz
-                    if ($qty > 0) {
-                        $sum += $qty;
-                    }
-                }
-            }
-        }
-        return $sum;
-    }
-
-
-    /**
-     * Gets the count of all the tickets available at this datetime (not ticket types)
-     * before any were sold
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sum_tickets_initially_available($query_params = array())
-    {
-        return $this->sum_related('Ticket', $query_params, 'TKT_qty');
-    }
-
-
-    /**
-     * Returns the lesser-of-the two: spaces remaining at this datetime, or
-     * the total tickets remaining (a sum of the tickets remaining for each ticket type
-     * that is available for this datetime).
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function total_tickets_available_at_this_datetime()
-    {
-        return $this->spaces_remaining(true);
-    }
-
-
-    /**
-     * This simply compares the internal dtt for the given string with NOW
-     * and determines if the date is upcoming or not.
-     *
-     * @access public
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_upcoming()
-    {
-        return ($this->get_raw('DTT_EVT_start') > time());
-    }
-
-
-    /**
-     * This simply compares the internal datetime for the given string with NOW
-     * and returns if the date is active (i.e. start and end time)
-     *
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time());
-    }
-
-
-    /**
-     * This simply compares the internal dtt for the given string with NOW
-     * and determines if the date is expired or not.
-     *
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_expired()
-    {
-        return ($this->get_raw('DTT_EVT_end') < time());
-    }
-
-
-    /**
-     * This returns the active status for whether an event is active, upcoming, or expired
-     *
-     * @return int return value will be one of the EE_Datetime status constants.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_active_status()
-    {
-        $total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime();
-        if ($total_tickets_for_this_dtt !== false && $total_tickets_for_this_dtt < 1) {
-            return EE_Datetime::sold_out;
-        }
-        if ($this->is_expired()) {
-            return EE_Datetime::expired;
-        }
-        if ($this->is_upcoming()) {
-            return EE_Datetime::upcoming;
-        }
-        if ($this->is_active()) {
-            return EE_Datetime::active;
-        }
-        return null;
-    }
-
-
-    /**
-     * This returns a nice display name for the datetime that is contingent on the span between the dates and times.
-     *
-     * @param  boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty.
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_dtt_display_name($use_dtt_name = false)
-    {
-        if ($use_dtt_name) {
-            $dtt_name = $this->name();
-            if (! empty($dtt_name)) {
-                return $dtt_name;
-            }
-        }
-        // first condition is to see if the months are different
-        if (
-            date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end'))
-        ) {
-            $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a');
-            // next condition is if its the same month but different day
-        } else {
-            if (
-                date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end'))
-                && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end'))
-            ) {
-                $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y');
-            } else {
-                $display_date = $this->start_date('F j\, Y')
-                                . ' @ '
-                                . $this->start_date('g:i a')
-                                . ' - '
-                                . $this->end_date('g:i a');
-            }
-        }
-        return $display_date;
-    }
-
-
-    /**
-     * Gets all the tickets for this datetime
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function tickets($query_params = array())
-    {
-        return $this->get_many_related('Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets all the ticket types currently available for purchase
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Ticket[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function ticket_types_available_for_purchase($query_params = array())
-    {
-        // first check if datetime is valid
-        if ($this->sold_out() || ! ($this->is_upcoming() || $this->is_active())) {
-            return array();
-        }
-        if (empty($query_params)) {
-            $query_params = array(
-                array(
-                    'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')),
-                    'TKT_end_date'   => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
-                    'TKT_deleted'    => false,
-                ),
-            );
-        }
-        return $this->tickets($query_params);
-    }
-
-
-    /**
-     * @return EE_Base_Class|EE_Event
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function event()
-    {
-        return $this->get_first_related('Event');
-    }
-
-
-    /**
-     * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime
-     * (via the tickets).
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function update_sold()
-    {
-        $count_regs_for_this_datetime = EEM_Registration::instance()->count(
-            array(
-                array(
-                    'STS_ID'                 => EEM_Registration::status_id_approved,
-                    'REG_deleted'            => 0,
-                    'Ticket.Datetime.DTT_ID' => $this->ID(),
-                ),
-            )
-        );
-        $this->set_sold($count_regs_for_this_datetime);
-        $this->save();
-        return $count_regs_for_this_datetime;
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param int|EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_venue($venue_id_or_obj): EE_Venue
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_venue($venue_id_or_obj): EE_Venue
-    {
-        $venue_id_or_obj = ! empty($venue_id_or_obj) ? $venue_id_or_obj : $this->venue();
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets the venue related to the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue_ID(array $query_params = []): int
-    {
-        $venue = $this->get_first_related('Venue', $query_params);
-        return $venue instanceof EE_Venue
-            ? $venue->ID()
-            : 0;
-    }
-
-
-    /**
-     * Gets the venue related to the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue(array $query_params = [])
-    {
-        return $this->get_first_related('Venue', $query_params);
-    }
-
-
-    /**
-     * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
-     * @param string                   $relationName
-     * @param array                    $extra_join_model_fields_n_values
-     * @param string|null              $cache_id
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    public function _add_relation_to(
-        $otherObjectModelObjectOrID,
-        $relationName,
-        $extra_join_model_fields_n_values = [],
-        $cache_id = null
-    ) {
-        // if we're adding a new relation to a ticket
-        if ($relationName === 'Ticket' && ! $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
-            /** @var EE_Ticket $ticket */
-            $ticket = EEM_Ticket::instance()->ensure_is_obj($otherObjectModelObjectOrID);
-            $this->increaseSold($ticket->sold(), false);
-            $this->increaseReserved($ticket->reserved());
-            $this->save();
-            $otherObjectModelObjectOrID = $ticket;
-        }
-        return parent::_add_relation_to(
-            $otherObjectModelObjectOrID,
-            $relationName,
-            $extra_join_model_fields_n_values,
-            $cache_id
-        );
-    }
-
-
-    /**
-     * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
-     * @param string                   $relationName
-     * @param array                    $where_query
-     * @return bool|EE_Base_Class|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = [])
-    {
-        if ($relationName === 'Ticket' && $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
-            /** @var EE_Ticket $ticket */
-            $ticket = EEM_Ticket::instance()->ensure_is_obj($otherObjectModelObjectOrID);
-            $this->decreaseSold($ticket->sold());
-            $this->decreaseReserved($ticket->reserved());
-            $this->save();
-            $otherObjectModelObjectOrID = $ticket;
-        }
-        return parent::_remove_relation_to(
-            $otherObjectModelObjectOrID,
-            $relationName,
-            $where_query
-        );
-    }
-
-
-    /**
-     * Removes ALL the related things for the $relationName.
-     *
-     * @param string $relationName
-     * @param array  $where_query_params
-     * @return EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    public function _remove_relations($relationName, $where_query_params = [])
-    {
-        if ($relationName === 'Ticket') {
-            $tickets = $this->tickets();
-            foreach ($tickets as $ticket) {
-                $this->decreaseSold($ticket->sold());
-                $this->decreaseReserved($ticket->reserved());
-                $this->save();
-            }
-        }
-        return parent::_remove_relations($relationName, $where_query_params);
-    }
-
-
-    /*******************************************************************
+	/**
+	 * constant used by get_active_status, indicates datetime has no more available spaces
+	 */
+	const sold_out = 'DTS';
+
+	/**
+	 * constant used by get_active_status, indicating datetime is still active (even is not over, can be registered-for)
+	 */
+	const active = 'DTA';
+
+	/**
+	 * constant used by get_active_status, indicating the datetime cannot be used for registrations yet, but has not
+	 * expired
+	 */
+	const upcoming = 'DTU';
+
+	/**
+	 * Datetime is postponed
+	 */
+	const postponed = 'DTP';
+
+	/**
+	 * Datetime is cancelled
+	 */
+	const cancelled = 'DTC';
+
+	/**
+	 * constant used by get_active_status, indicates datetime has expired (event is over)
+	 */
+	const expired = 'DTE';
+
+	/**
+	 * constant used in various places indicating that an event is INACTIVE (not yet ready to be published)
+	 */
+	const inactive = 'DTI';
+
+
+	/**
+	 * @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_Datetime
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object(
+			$props_n_values,
+			__CLASS__,
+			$timezone,
+			$date_formats
+		);
+		return $has_object
+			? $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_Datetime
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('DTT_name', $name);
+	}
+
+
+	/**
+	 * @param $description
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_description($description)
+	{
+		$this->set('DTT_description', $description);
+	}
+
+
+	/**
+	 * Set event start date
+	 * set the start date for an event
+	 *
+	 * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_start_date($date)
+	{
+		$this->_set_date_for($date, 'DTT_EVT_start');
+	}
+
+
+	/**
+	 * Set event start time
+	 * set the start time for an event
+	 *
+	 * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_start_time($time)
+	{
+		$this->_set_time_for($time, 'DTT_EVT_start');
+	}
+
+
+	/**
+	 * Set event end date
+	 * set the end date for an event
+	 *
+	 * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_end_date($date)
+	{
+		$this->_set_date_for($date, 'DTT_EVT_end');
+	}
+
+
+	/**
+	 * Set event end time
+	 * set the end time for an event
+	 *
+	 * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_end_time($time)
+	{
+		$this->_set_time_for($time, 'DTT_EVT_end');
+	}
+
+
+	/**
+	 * Set registration limit
+	 * set the maximum number of attendees that can be registered for this datetime slot
+	 *
+	 * @param int|float $reg_limit
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_reg_limit($reg_limit)
+	{
+		$this->set('DTT_reg_limit', $reg_limit);
+	}
+
+
+	/**
+	 * get the number of tickets sold for this datetime slot
+	 *
+	 * @return mixed int on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sold()
+	{
+		return $this->get_raw('DTT_sold');
+	}
+
+
+	/**
+	 * @param int $sold
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_sold($sold)
+	{
+		// sold can not go below zero
+		$sold = max(0, $sold);
+		$this->set('DTT_sold', $sold);
+	}
+
+
+	/**
+	 * Increments sold by amount passed by $qty, and persists it immediately to the database.
+	 * Simultaneously decreases the reserved count, unless $also_decrease_reserved is false.
+	 *
+	 * @param int $qty
+	 * @param boolean $also_decrease_reserved
+	 * @return boolean indicating success
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function increaseSold(int $qty = 1, bool $also_decrease_reserved = true): bool
+	{
+		$qty = absint($qty);
+		if ($also_decrease_reserved) {
+			$success = $this->adjustNumericFieldsInDb(
+				[
+					'DTT_reserved' => $qty * -1,
+					'DTT_sold' => $qty
+				]
+			);
+		} else {
+			$success = $this->adjustNumericFieldsInDb(
+				[
+					'DTT_sold' => $qty
+				]
+			);
+		}
+
+		do_action(
+			'AHEE__EE_Datetime__increase_sold',
+			$this,
+			$qty,
+			$this->sold(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need
+	 * to save afterwards.)
+	 *
+	 * @param int $qty
+	 * @return boolean indicating success
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function decreaseSold(int $qty = 1): bool
+	{
+		$qty = absint($qty);
+		$success = $this->adjustNumericFieldsInDb(
+			[
+				'DTT_sold' => $qty * -1
+			]
+		);
+		do_action(
+			'AHEE__EE_Datetime__decrease_sold',
+			$this,
+			$qty,
+			$this->sold(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Gets qty of reserved tickets for this datetime
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function reserved(): int
+	{
+		return $this->get_raw('DTT_reserved');
+	}
+
+
+	/**
+	 * Sets qty of reserved tickets for this datetime
+	 *
+	 * @param int $reserved
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_reserved(int $reserved)
+	{
+		// reserved can not go below zero
+		$reserved = max(0, $reserved);
+		$this->set('DTT_reserved', $reserved);
+	}
+
+
+	/**
+	 * Increments reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @param int $qty
+	 * @return boolean indicating success
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function increaseReserved(int $qty = 1): bool
+	{
+		$qty = absint($qty);
+		$success = $this->incrementFieldConditionallyInDb(
+			'DTT_reserved',
+			'DTT_sold',
+			'DTT_reg_limit',
+			$qty
+		);
+		do_action(
+			'AHEE__EE_Datetime__increase_reserved',
+			$this,
+			$qty,
+			$this->reserved(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @param int $qty
+	 * @return boolean indicating success
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function decreaseReserved(int $qty = 1): bool
+	{
+		$qty = absint($qty);
+		$success = $this->adjustNumericFieldsInDb(
+			[
+				'DTT_reserved' => $qty * -1
+			]
+		);
+		do_action(
+			'AHEE__EE_Datetime__decrease_reserved',
+			$this,
+			$qty,
+			$this->reserved(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * total sold and reserved tickets
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sold_and_reserved(): int
+	{
+		return $this->sold() + $this->reserved();
+	}
+
+
+	/**
+	 * returns the datetime name
+	 *
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function name(): string
+	{
+		return $this->get('DTT_name');
+	}
+
+
+	/**
+	 * returns the datetime description
+	 *
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function description(): string
+	{
+		return $this->get('DTT_description');
+	}
+
+
+	/**
+	 * This helper simply returns whether the event_datetime for the current datetime is a primary datetime
+	 *
+	 * @return boolean  TRUE if is primary, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_primary(): bool
+	{
+		return $this->get('DTT_is_primary');
+	}
+
+
+	/**
+	 * This helper simply returns the order for the datetime
+	 *
+	 * @return int  The order of the datetime for this event.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function order(): int
+	{
+		return $this->get('DTT_order');
+	}
+
+
+	/**
+	 * This helper simply returns the parent id for the datetime
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function parent(): int
+	{
+		return $this->get('DTT_parent');
+	}
+
+
+	/**
+	 * show date and/or time
+	 *
+	 * @param string $date_or_time    whether to display a date or time or both
+	 * @param string $start_or_end    whether to display start or end datetimes
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param bool   $echo            whether we echo or return (note echoing uses "pretty" formats,
+	 *                                otherwise we use the standard formats)
+	 * @return string|bool  string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function _show_datetime(
+		$date_or_time = null,
+		$start_or_end = 'start',
+		$dt_frmt = '',
+		$tm_frmt = '',
+		$echo = false
+	) {
+		$field_name = "DTT_EVT_{$start_or_end}";
+		$dtt = $this->_get_datetime(
+			$field_name,
+			$dt_frmt,
+			$tm_frmt,
+			$date_or_time,
+			$echo
+		);
+		if (! $echo) {
+			return $dtt;
+		}
+		return '';
+	}
+
+
+	/**
+	 * get event start date.  Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt string representation of date format defaults to 'F j, Y'
+	 * @return mixed            string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start_date($dt_frmt = '')
+	{
+		return $this->_show_datetime('D', 'start', $dt_frmt);
+	}
+
+
+	/**
+	 * Echoes start_date()
+	 *
+	 * @param string $dt_frmt
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_start_date($dt_frmt = '')
+	{
+		$this->_show_datetime('D', 'start', $dt_frmt, null, true);
+	}
+
+
+	/**
+	 * get end date. Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt string representation of date format defaults to 'F j, Y'
+	 * @return mixed            string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end_date($dt_frmt = '')
+	{
+		return $this->_show_datetime('D', 'end', $dt_frmt);
+	}
+
+
+	/**
+	 * Echoes the end date. See end_date()
+	 *
+	 * @param string $dt_frmt
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_end_date($dt_frmt = '')
+	{
+		$this->_show_datetime('D', 'end', $dt_frmt, null, true);
+	}
+
+
+	/**
+	 * get date_range - meaning the start AND end date
+	 *
+	 * @access public
+	 * @param string $dt_frmt     string representation of date format defaults to WP settings
+	 * @param string $conjunction conjunction junction what's your function ?
+	 *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
+	 * @return mixed              string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function date_range($dt_frmt = '', $conjunction = ' - ')
+	{
+		$dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
+		$start = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_start', $dt_frmt)
+		);
+		$end = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_end', $dt_frmt)
+		);
+		return $start !== $end ? $start . $conjunction . $end : $start;
+	}
+
+
+	/**
+	 * @param string $dt_frmt
+	 * @param string $conjunction
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_date_range($dt_frmt = '', $conjunction = ' - ')
+	{
+		echo esc_html($this->date_range($dt_frmt, $conjunction));
+	}
+
+
+	/**
+	 * get start time
+	 *
+	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return mixed        string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start_time($tm_format = '')
+	{
+		return $this->_show_datetime('T', 'start', null, $tm_format);
+	}
+
+
+	/**
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_start_time($tm_format = '')
+	{
+		$this->_show_datetime('T', 'start', null, $tm_format, true);
+	}
+
+
+	/**
+	 * get end time
+	 *
+	 * @param string $tm_format string representation of time format defaults to 'g:i a'
+	 * @return mixed                string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end_time($tm_format = '')
+	{
+		return $this->_show_datetime('T', 'end', null, $tm_format);
+	}
+
+
+	/**
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_end_time($tm_format = '')
+	{
+		$this->_show_datetime('T', 'end', null, $tm_format, true);
+	}
+
+
+	/**
+	 * get time_range
+	 *
+	 * @access public
+	 * @param string $tm_format   string representation of time format defaults to 'g:i a'
+	 * @param string $conjunction conjunction junction what's your function ?
+	 *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
+	 * @return mixed              string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function time_range($tm_format = '', $conjunction = ' - ')
+	{
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$start = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_start', $tm_format)
+		);
+		$end = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_end', $tm_format)
+		);
+		return $start !== $end ? $start . $conjunction . $end : $start;
+	}
+
+
+	/**
+	 * @param string $tm_format
+	 * @param string $conjunction
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_time_range($tm_format = '', $conjunction = ' - ')
+	{
+		echo esc_html($this->time_range($tm_format, $conjunction));
+	}
+
+
+	/**
+	 * This returns a range representation of the date and times.
+	 * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end.
+	 * Also, the return value is localized.
+	 *
+	 * @param string $dt_format
+	 * @param string $tm_format
+	 * @param string $conjunction used between two different dates or times.
+	 *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
+	 * @param string $separator   used between the date and time formats.
+	 *                            ex: Dec 1, 2016{$separator}2pm
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function date_and_time_range(
+		$dt_format = '',
+		$tm_format = '',
+		$conjunction = ' - ',
+		$separator = ' '
+	) {
+		$dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$full_format = $dt_format . $separator . $tm_format;
+		// the range output depends on various conditions
+		switch (true) {
+			// start date timestamp and end date timestamp are the same.
+			case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')):
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format);
+				break;
+			// start and end date are the same but times are different
+			case ($this->start_date() === $this->end_date()):
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
+						  . $conjunction
+						  . $this->get_i18n_datetime('DTT_EVT_end', $tm_format);
+				break;
+			// all other conditions
+			default:
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
+						  . $conjunction
+						  . $this->get_i18n_datetime('DTT_EVT_end', $full_format);
+				break;
+		}
+		return $output;
+	}
+
+
+	/**
+	 * This echos the results of date and time range.
+	 *
+	 * @see date_and_time_range() for more details on purpose.
+	 * @param string $dt_format
+	 * @param string $tm_format
+	 * @param string $conjunction
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ')
+	{
+		echo esc_html($this->date_and_time_range($dt_format, $tm_format, $conjunction));
+	}
+
+
+	/**
+	 * get start date and start time
+	 *
+	 * @param    string $dt_format - string representation of date format defaults to 'F j, Y'
+	 * @param    string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return    mixed    string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start_date_and_time($dt_format = '', $tm_format = '')
+	{
+		return $this->_show_datetime('', 'start', $dt_format, $tm_format);
+	}
+
+
+	/**
+	 * @param string $dt_frmt
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_start_date_and_time($dt_frmt = '', $tm_format = '')
+	{
+		$this->_show_datetime('', 'start', $dt_frmt, $tm_format, true);
+	}
+
+
+	/**
+	 * Shows the length of the event (start to end time).
+	 * Can be shown in 'seconds','minutes','hours', or 'days'.
+	 * By default, rounds up. (So if you use 'days', and then event
+	 * only occurs for 1 hour, it will return 1 day).
+	 *
+	 * @param string $units 'seconds','minutes','hours','days'
+	 * @param bool   $round_up
+	 * @return float|int|mixed
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function length($units = 'seconds', $round_up = false)
+	{
+		$start = $this->get_raw('DTT_EVT_start');
+		$end = $this->get_raw('DTT_EVT_end');
+		$length_in_units = $end - $start;
+		switch ($units) {
+			// NOTE: We purposefully don't use "break;" in order to chain the divisions
+			/** @noinspection PhpMissingBreakStatementInspection */
+			// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+			case 'days':
+				$length_in_units /= 24;
+			/** @noinspection PhpMissingBreakStatementInspection */
+			case 'hours':
+				// fall through is intentional
+				$length_in_units /= 60;
+			/** @noinspection PhpMissingBreakStatementInspection */
+			case 'minutes':
+				// fall through is intentional
+				$length_in_units /= 60;
+			case 'seconds':
+			default:
+				$length_in_units = ceil($length_in_units);
+		}
+		// phpcs:enable
+		if ($round_up) {
+			$length_in_units = max($length_in_units, 1);
+		}
+		return $length_in_units;
+	}
+
+
+	/**
+	 *        get end date and time
+	 *
+	 * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
+	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return    mixed                string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end_date_and_time($dt_frmt = '', $tm_format = '')
+	{
+		return $this->_show_datetime('', 'end', $dt_frmt, $tm_format);
+	}
+
+
+	/**
+	 * @param string $dt_frmt
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_end_date_and_time($dt_frmt = '', $tm_format = '')
+	{
+		$this->_show_datetime('', 'end', $dt_frmt, $tm_format, true);
+	}
+
+
+	/**
+	 *        get start timestamp
+	 *
+	 * @return        int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start()
+	{
+		return $this->get_raw('DTT_EVT_start');
+	}
+
+
+	/**
+	 *        get end timestamp
+	 *
+	 * @return        int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end()
+	{
+		return $this->get_raw('DTT_EVT_end');
+	}
+
+
+	/**
+	 *    get the registration limit for this datetime slot
+	 *
+	 * @return int|float                int = finite limit   EE_INF(float) = unlimited
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function reg_limit()
+	{
+		return $this->get_raw('DTT_reg_limit');
+	}
+
+
+	/**
+	 *    have the tickets sold for this datetime, met or exceed the registration limit ?
+	 *
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sold_out()
+	{
+		return $this->reg_limit() > 0 && $this->sold() >= $this->reg_limit();
+	}
+
+
+	/**
+	 * return the total number of spaces remaining at this venue.
+	 * This only takes the venue's capacity into account, NOT the tickets available for sale
+	 *
+	 * @param bool $consider_tickets Whether to consider tickets remaining when determining if there are any spaces left
+	 *                               Because if all tickets attached to this datetime have no spaces left,
+	 *                               then this datetime IS effectively sold out.
+	 *                               However, there are cases where we just want to know the spaces
+	 *                               remaining for this particular datetime, hence the flag.
+	 * @return int|float
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function spaces_remaining($consider_tickets = false)
+	{
+		// tickets remaining available for purchase
+		// no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
+		$dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
+		if (! $consider_tickets) {
+			return $dtt_remaining;
+		}
+		$tickets_remaining = $this->tickets_remaining();
+		return min($dtt_remaining, $tickets_remaining);
+	}
+
+
+	/**
+	 * Counts the total tickets available
+	 * (from all the different types of tickets which are available for this datetime).
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function tickets_remaining($query_params = array())
+	{
+		$sum = 0;
+		$tickets = $this->tickets($query_params);
+		if (! empty($tickets)) {
+			foreach ($tickets as $ticket) {
+				if ($ticket instanceof EE_Ticket) {
+					// get the actual amount of tickets that can be sold
+					$qty = $ticket->qty('saleable');
+					if ($qty === EE_INF) {
+						return EE_INF;
+					}
+					// no negative ticket quantities plz
+					if ($qty > 0) {
+						$sum += $qty;
+					}
+				}
+			}
+		}
+		return $sum;
+	}
+
+
+	/**
+	 * Gets the count of all the tickets available at this datetime (not ticket types)
+	 * before any were sold
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sum_tickets_initially_available($query_params = array())
+	{
+		return $this->sum_related('Ticket', $query_params, 'TKT_qty');
+	}
+
+
+	/**
+	 * Returns the lesser-of-the two: spaces remaining at this datetime, or
+	 * the total tickets remaining (a sum of the tickets remaining for each ticket type
+	 * that is available for this datetime).
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function total_tickets_available_at_this_datetime()
+	{
+		return $this->spaces_remaining(true);
+	}
+
+
+	/**
+	 * This simply compares the internal dtt for the given string with NOW
+	 * and determines if the date is upcoming or not.
+	 *
+	 * @access public
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_upcoming()
+	{
+		return ($this->get_raw('DTT_EVT_start') > time());
+	}
+
+
+	/**
+	 * This simply compares the internal datetime for the given string with NOW
+	 * and returns if the date is active (i.e. start and end time)
+	 *
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time());
+	}
+
+
+	/**
+	 * This simply compares the internal dtt for the given string with NOW
+	 * and determines if the date is expired or not.
+	 *
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_expired()
+	{
+		return ($this->get_raw('DTT_EVT_end') < time());
+	}
+
+
+	/**
+	 * This returns the active status for whether an event is active, upcoming, or expired
+	 *
+	 * @return int return value will be one of the EE_Datetime status constants.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_active_status()
+	{
+		$total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime();
+		if ($total_tickets_for_this_dtt !== false && $total_tickets_for_this_dtt < 1) {
+			return EE_Datetime::sold_out;
+		}
+		if ($this->is_expired()) {
+			return EE_Datetime::expired;
+		}
+		if ($this->is_upcoming()) {
+			return EE_Datetime::upcoming;
+		}
+		if ($this->is_active()) {
+			return EE_Datetime::active;
+		}
+		return null;
+	}
+
+
+	/**
+	 * This returns a nice display name for the datetime that is contingent on the span between the dates and times.
+	 *
+	 * @param  boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty.
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_dtt_display_name($use_dtt_name = false)
+	{
+		if ($use_dtt_name) {
+			$dtt_name = $this->name();
+			if (! empty($dtt_name)) {
+				return $dtt_name;
+			}
+		}
+		// first condition is to see if the months are different
+		if (
+			date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end'))
+		) {
+			$display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a');
+			// next condition is if its the same month but different day
+		} else {
+			if (
+				date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end'))
+				&& date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end'))
+			) {
+				$display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y');
+			} else {
+				$display_date = $this->start_date('F j\, Y')
+								. ' @ '
+								. $this->start_date('g:i a')
+								. ' - '
+								. $this->end_date('g:i a');
+			}
+		}
+		return $display_date;
+	}
+
+
+	/**
+	 * Gets all the tickets for this datetime
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function tickets($query_params = array())
+	{
+		return $this->get_many_related('Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets all the ticket types currently available for purchase
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Ticket[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function ticket_types_available_for_purchase($query_params = array())
+	{
+		// first check if datetime is valid
+		if ($this->sold_out() || ! ($this->is_upcoming() || $this->is_active())) {
+			return array();
+		}
+		if (empty($query_params)) {
+			$query_params = array(
+				array(
+					'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')),
+					'TKT_end_date'   => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
+					'TKT_deleted'    => false,
+				),
+			);
+		}
+		return $this->tickets($query_params);
+	}
+
+
+	/**
+	 * @return EE_Base_Class|EE_Event
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function event()
+	{
+		return $this->get_first_related('Event');
+	}
+
+
+	/**
+	 * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime
+	 * (via the tickets).
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function update_sold()
+	{
+		$count_regs_for_this_datetime = EEM_Registration::instance()->count(
+			array(
+				array(
+					'STS_ID'                 => EEM_Registration::status_id_approved,
+					'REG_deleted'            => 0,
+					'Ticket.Datetime.DTT_ID' => $this->ID(),
+				),
+			)
+		);
+		$this->set_sold($count_regs_for_this_datetime);
+		$this->save();
+		return $count_regs_for_this_datetime;
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param int|EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_venue($venue_id_or_obj): EE_Venue
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_venue($venue_id_or_obj): EE_Venue
+	{
+		$venue_id_or_obj = ! empty($venue_id_or_obj) ? $venue_id_or_obj : $this->venue();
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets the venue related to the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue_ID(array $query_params = []): int
+	{
+		$venue = $this->get_first_related('Venue', $query_params);
+		return $venue instanceof EE_Venue
+			? $venue->ID()
+			: 0;
+	}
+
+
+	/**
+	 * Gets the venue related to the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue(array $query_params = [])
+	{
+		return $this->get_first_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
+	 * @param string                   $relationName
+	 * @param array                    $extra_join_model_fields_n_values
+	 * @param string|null              $cache_id
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	public function _add_relation_to(
+		$otherObjectModelObjectOrID,
+		$relationName,
+		$extra_join_model_fields_n_values = [],
+		$cache_id = null
+	) {
+		// if we're adding a new relation to a ticket
+		if ($relationName === 'Ticket' && ! $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
+			/** @var EE_Ticket $ticket */
+			$ticket = EEM_Ticket::instance()->ensure_is_obj($otherObjectModelObjectOrID);
+			$this->increaseSold($ticket->sold(), false);
+			$this->increaseReserved($ticket->reserved());
+			$this->save();
+			$otherObjectModelObjectOrID = $ticket;
+		}
+		return parent::_add_relation_to(
+			$otherObjectModelObjectOrID,
+			$relationName,
+			$extra_join_model_fields_n_values,
+			$cache_id
+		);
+	}
+
+
+	/**
+	 * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
+	 * @param string                   $relationName
+	 * @param array                    $where_query
+	 * @return bool|EE_Base_Class|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = [])
+	{
+		if ($relationName === 'Ticket' && $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
+			/** @var EE_Ticket $ticket */
+			$ticket = EEM_Ticket::instance()->ensure_is_obj($otherObjectModelObjectOrID);
+			$this->decreaseSold($ticket->sold());
+			$this->decreaseReserved($ticket->reserved());
+			$this->save();
+			$otherObjectModelObjectOrID = $ticket;
+		}
+		return parent::_remove_relation_to(
+			$otherObjectModelObjectOrID,
+			$relationName,
+			$where_query
+		);
+	}
+
+
+	/**
+	 * Removes ALL the related things for the $relationName.
+	 *
+	 * @param string $relationName
+	 * @param array  $where_query_params
+	 * @return EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	public function _remove_relations($relationName, $where_query_params = [])
+	{
+		if ($relationName === 'Ticket') {
+			$tickets = $this->tickets();
+			foreach ($tickets as $ticket) {
+				$this->decreaseSold($ticket->sold());
+				$this->decreaseReserved($ticket->reserved());
+				$this->save();
+			}
+		}
+		return parent::_remove_relations($relationName, $where_query_params);
+	}
+
+
+	/*******************************************************************
      ***********************  DEPRECATED METHODS  **********************
      *******************************************************************/
 
 
-    /**
-     * Increments sold by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function increase_sold($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Datetime::increaseSold() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->increaseSold($qty);
-    }
-
-
-    /**
-     * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need
-     * to save afterwards.)
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function decrease_sold($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Datetime::decreaseSold() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->decreaseSold($qty);
-    }
-
-
-    /**
-     * Increments reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return boolean indicating success
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function increase_reserved($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Datetime::increaseReserved() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->increaseReserved($qty);
-    }
-
-
-    /**
-     * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function decrease_reserved($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Datetime::decreaseReserved() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->decreaseReserved($qty);
-    }
+	/**
+	 * Increments sold by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function increase_sold($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Datetime::increaseSold() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->increaseSold($qty);
+	}
+
+
+	/**
+	 * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need
+	 * to save afterwards.)
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function decrease_sold($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Datetime::decreaseSold() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->decreaseSold($qty);
+	}
+
+
+	/**
+	 * Increments reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return boolean indicating success
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function increase_reserved($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Datetime::increaseReserved() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->increaseReserved($qty);
+	}
+
+
+	/**
+	 * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function decrease_reserved($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Datetime::decreaseReserved() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->decreaseReserved($qty);
+	}
 }

core/data_migration_scripts/EE_Data_Migration_Script_Base.core.php

Spacing +25 added lines, -25 removed lines

@@ -135,7 +135,7 @@ 
     public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
     {
         $this->_migration_stages = (array) apply_filters(
-            'FHEE__' . get_class($this) . '__construct__migration_stages',
+            'FHEE__'.get_class($this).'__construct__migration_stages',
             $this->_migration_stages
         );
         foreach ($this->_migration_stages as $migration_stage) {
@@ -170,10 +170,10 @@ 
     public function set_mapping($old_table, $old_pk, $new_table, $new_pk)
     {
         // make sure it has the needed keys
-        if (! isset($this->_mappings[ $old_table ]) || ! isset($this->_mappings[ $old_table ][ $new_table ])) {
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+        if ( ! isset($this->_mappings[$old_table]) || ! isset($this->_mappings[$old_table][$new_table])) {
+            $this->_mappings[$old_table][$new_table] = $this->_get_mapping_option($old_table, $new_table);
         }
-        $this->_mappings[ $old_table ][ $new_table ][ $old_pk ] = $new_pk;
+        $this->_mappings[$old_table][$new_table][$old_pk] = $new_pk;
     }
 
 
@@ -189,14 +189,14 @@ 
     public function get_mapping_new_pk($old_table, $old_pk, $new_table)
     {
         if (
-            ! isset($this->_mappings[ $old_table ]) ||
-            ! isset($this->_mappings[ $old_table ][ $new_table ])
+            ! isset($this->_mappings[$old_table]) ||
+            ! isset($this->_mappings[$old_table][$new_table])
         ) {
             // try fetching the option
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+            $this->_mappings[$old_table][$new_table] = $this->_get_mapping_option($old_table, $new_table);
         }
-        return isset($this->_mappings[ $old_table ][ $new_table ][ $old_pk ])
-            ? $this->_mappings[ $old_table ][ $new_table ][ $old_pk ] : null;
+        return isset($this->_mappings[$old_table][$new_table][$old_pk])
+            ? $this->_mappings[$old_table][$new_table][$old_pk] : null;
     }
 
 
@@ -212,16 +212,16 @@ 
     public function get_mapping_old_pk($old_table, $new_table, $new_pk)
     {
         if (
-            ! isset($this->_mappings[ $old_table ]) ||
-            ! isset($this->_mappings[ $old_table ][ $new_table ])
+            ! isset($this->_mappings[$old_table]) ||
+            ! isset($this->_mappings[$old_table][$new_table])
         ) {
             // try fetching the option
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+            $this->_mappings[$old_table][$new_table] = $this->_get_mapping_option($old_table, $new_table);
         }
-        if (isset($this->_mappings[ $old_table ][ $new_table ])) {
-            $new_pk_to_old_pk = array_flip($this->_mappings[ $old_table ][ $new_table ]);
-            if (isset($new_pk_to_old_pk[ $new_pk ])) {
-                return $new_pk_to_old_pk[ $new_pk ];
+        if (isset($this->_mappings[$old_table][$new_table])) {
+            $new_pk_to_old_pk = array_flip($this->_mappings[$old_table][$new_table]);
+            if (isset($new_pk_to_old_pk[$new_pk])) {
+                return $new_pk_to_old_pk[$new_pk];
             }
         }
         return null;
@@ -271,7 +271,7 @@ 
         $new_table_name_sans_wp = str_replace($wpdb->prefix, "", $new_table_name);
         $migrates_to = EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this));
         return substr(
-            EE_Data_Migration_Manager::data_migration_script_mapping_option_prefix . $migrates_to ['slug'] . '_' . $migrates_to['version'] . '_' . $old_table_name_sans_wp . '_' . $new_table_name_sans_wp,
+            EE_Data_Migration_Manager::data_migration_script_mapping_option_prefix.$migrates_to ['slug'].'_'.$migrates_to['version'].'_'.$old_table_name_sans_wp.'_'.$new_table_name_sans_wp,
             0,
             64
         );
@@ -343,12 +343,12 @@ 
                         $num_records_to_migrate_limit - $num_records_actually_migrated
                     );
                     $num_records_actually_migrated += $records_migrated_during_stage;
-                    $records_migrated_per_stage[ $stage->pretty_name() ] = $records_migrated_during_stage;
+                    $records_migrated_per_stage[$stage->pretty_name()] = $records_migrated_during_stage;
                 } catch (Exception $e) {
                     // yes if we catch an exception here, we consider that migration stage borked.
                     $stage->set_status(EE_Data_Migration_Manager::status_fatal_error);
                     $this->set_status(EE_Data_Migration_Manager::status_fatal_error);
-                    $stage->add_error($e->getMessage() . ". Stack-trace:" . $e->getTraceAsString());
+                    $stage->add_error($e->getMessage().". Stack-trace:".$e->getTraceAsString());
                     throw $e;
                 }
                 // check that the migration stage didn't mark itself as having a fatal error
@@ -421,8 +421,8 @@ 
     private function _maybe_do_schema_changes($before = true)
     {
         // so this property will be either _schema_changes_after_migration_ran or _schema_changes_before_migration_ran
-        $property_name = '_schema_changes_' . ($before ? 'before' : 'after') . '_migration_ran';
-        if (! $this->{$property_name}) {
+        $property_name = '_schema_changes_'.($before ? 'before' : 'after').'_migration_ran';
+        if ( ! $this->{$property_name}) {
             try {
                 ob_start();
                 if ($before) {
@@ -659,7 +659,7 @@ 
         try {
             EEH_Activation::create_table($table_name, $table_definition_sql, $engine_string, $drop_pre_existing_tables);
         } catch (EE_Error $e) {
-            $message = $e->getMessage() . '<br>Stack Trace:' . $e->getTraceAsString();
+            $message = $e->getMessage().'<br>Stack Trace:'.$e->getTraceAsString();
             $this->add_error($message);
             $this->_feedback_message .= $message;
         }
@@ -705,7 +705,7 @@ 
     public function get_errors()
     {
         $all_errors = $this->_errors;
-        if (! is_array($all_errors)) {
+        if ( ! is_array($all_errors)) {
             $all_errors = array();
         }
         foreach ($this->stages() as $stage) {
@@ -739,7 +739,7 @@ 
      */
     protected function stages()
     {
-        $stages = apply_filters('FHEE__' . get_class($this) . '__stages', $this->_migration_stages);
+        $stages = apply_filters('FHEE__'.get_class($this).'__stages', $this->_migration_stages);
         ksort($stages);
         return $stages;
     }
@@ -768,7 +768,7 @@ 
         $properties = parent::properties_as_array();
         $properties['_migration_stages'] = array();
         foreach ($this->_migration_stages as $migration_stage_priority => $migration_stage_class) {
-            $properties['_migration_stages'][ $migration_stage_priority ] = $migration_stage_class->properties_as_array(
+            $properties['_migration_stages'][$migration_stage_priority] = $migration_stage_class->properties_as_array(
             );
         }
         unset($properties['_mappings']);

Indentation +890 added lines, -890 removed lines

@@ -14,894 +14,894 @@
  */
 abstract class EE_Data_Migration_Script_Base extends EE_Data_Migration_Class_Base
 {
-    /**
-     * Set by client code to indicate this DMS is being ran as part of a proper migration,
-     * instead of being used to merely setup (or verify) the database structure.
-     * Defaults to TRUE, so client code that's NOT using this DMS as part of a proper migration
-     * should call EE_Data_Migration_Script_Base::set_migrating( FALSE )
-     *
-     * @var boolean
-     */
-    protected $_migrating = true;
-
-    /**
-     * numerically-indexed array where each value is EE_Data_Migration_Script_Stage object
-     *
-     * @var EE_Data_Migration_Script_Stage[] $migration_functions
-     */
-    protected $_migration_stages = array();
-
-    /**
-     * Indicates we've already ran the schema changes that needed to happen BEFORE the data migration
-     *
-     * @var boolean
-     */
-    protected $_schema_changes_before_migration_ran = null;
-
-    /**
-     * Indicates we've already ran the schema changes that needed to happen AFTER the data migration
-     *
-     * @var boolean
-     */
-    protected $_schema_changes_after_migration_ran = null;
-
-    /**
-     * String which describes what's currently happening in this migration
-     *
-     * @var string
-     */
-    protected $_feedback_message;
-
-    /**
-     * Indicates the script's priority. Like wp's add_action and add_filter, lower numbers
-     * correspond to earlier execution
-     *
-     * @var int
-     */
-    protected $_priority = 5;
-
-    /**
-     * Multi-dimensional array that defines the mapping from OLD table Primary Keys
-     * to NEW table Primary Keys.
-     * Top-level array keys are OLD table names (minus the "wp_" part),
-     * 2nd-level array keys are NEW table names (again, minus the "wp_" part),
-     * 3rd-level array keys are the OLD table primary keys
-     * and 3rd-level array values are the NEW table primary keys
-     *
-     * @var array
-     */
-    protected $_mappings = array();
-
-    /**
-     * @var EE_Data_Migration_Script_Base
-     */
-    protected $previous_dms;
-
-
-    /**
-     * Returns whether or not this data migration script can operate on the given version of the database.
-     * Eg, if this migration script can migrate from 3.1.26 or higher (but not anything after 4.0.0), and
-     * it's passed a string like '3.1.38B', it should return true.
-     * If this DMS is to migrate data from an EE3 addon, you will probably want to use
-     * EventEspresso\core\services\database\TableAnalysis::tableExists() to check for old EE3 tables, and
-     * EE_Data_Migration_Manager::get_migration_ran() to check that core was already
-     * migrated from EE3 to EE4 (ie, this DMS probably relies on some migration data generated
-     * during the Core 4.1.0 DMS. If core didn't run that DMS, you probably don't want
-     * to run this DMS).
-     * If this DMS migrates data from a previous version of this EE4 addon, just
-     * comparing $current_database_state_of[ $this->slug() ] will probably suffice.
-     * If this DMS should never migrate data, because it's only used to define the initial
-     * database state, just return FALSE (and core's activation process will take care
-     * of calling its schema_changes_before_migration() and
-     * schema_changes_after_migration() for you. )
-     *
-     * @param array $current_database_state_of keys are EE plugin slugs (eg 'Core', 'Calendar', 'Mailchimp', etc)
-     * @return boolean
-     */
-    abstract public function can_migrate_from_version($current_database_state_of);
-
-
-    /**
-     * Performs database schema changes that need to occur BEFORE the data is migrated.
-     * Eg, if we were going to change user passwords from plaintext to encoded versions
-     * during this migration, this would probably add a new column called something like
-     * "encoded_password".
-     *
-     * @return boolean of success
-     */
-    abstract public function schema_changes_before_migration();
-
-
-    /**
-     * Performs the database schema changes that need to occur AFTER the data has been migrated.
-     * Usually this will mean we'll be removing old columns. Eg, if we were changing passwords
-     * from plaintext to encoded versions, and we had added a column called "encoded_password",
-     * this function would probably remove the old column "password" (which still holds the plaintext password)
-     * and possibly rename "encoded_password" to "password"
-     *
-     * @return boolean of success
-     */
-    abstract public function schema_changes_after_migration();
-
-
-    /**
-     * All children of this must call parent::__construct()
-     * at the end of their constructor or suffer the consequences!
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_migration_stages = (array) apply_filters(
-            'FHEE__' . get_class($this) . '__construct__migration_stages',
-            $this->_migration_stages
-        );
-        foreach ($this->_migration_stages as $migration_stage) {
-            if ($migration_stage instanceof EE_Data_Migration_Script_Stage) {
-                $migration_stage->_construct_finalize($this);
-            }
-        }
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-
-    /**
-     * Place to add hooks and filters for tweaking the migrations page, in order
-     * to customize it
-     */
-    public function migration_page_hooks()
-    {
-        // by default none are added because we normally like the default look of the migration page
-    }
-
-
-    /**
-     * Sets the mapping from old table primary keys to new table primary keys.
-     * This mapping is automatically persisted as a property on the migration
-     *
-     * @param string     $old_table with wpdb prefix (wp_). Eg: wp_events_detail
-     * @param int|string $old_pk    old primary key. Eg events_detail.id's value
-     * @param string     $new_table with wpdb prefix (wp_). Eg: wp_posts
-     * @param int|string $new_pk    eg posts.ID
-     * @return void
-     */
-    public function set_mapping($old_table, $old_pk, $new_table, $new_pk)
-    {
-        // make sure it has the needed keys
-        if (! isset($this->_mappings[ $old_table ]) || ! isset($this->_mappings[ $old_table ][ $new_table ])) {
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
-        }
-        $this->_mappings[ $old_table ][ $new_table ][ $old_pk ] = $new_pk;
-    }
-
-
-    /**
-     * Gets the new primary key, if provided with the OLD table and the primary key
-     * of an item in the old table, and the new table
-     *
-     * @param string     $old_table with wpdb prefix (wp_). Eg: wp_events_detail
-     * @param int|string $old_pk    old primary key. Eg events_detail.id's value
-     * @param string     $new_table with wpdb prefix (wp_). Eg: wp_posts
-     * @return mixed the primary key on the new table
-     */
-    public function get_mapping_new_pk($old_table, $old_pk, $new_table)
-    {
-        if (
-            ! isset($this->_mappings[ $old_table ]) ||
-            ! isset($this->_mappings[ $old_table ][ $new_table ])
-        ) {
-            // try fetching the option
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
-        }
-        return isset($this->_mappings[ $old_table ][ $new_table ][ $old_pk ])
-            ? $this->_mappings[ $old_table ][ $new_table ][ $old_pk ] : null;
-    }
-
-
-    /**
-     * Gets the old primary key, if provided with the OLD table,
-     * and the new table and the primary key of an item in the new table
-     *
-     * @param string $old_table with wpdb prefix (wp_). Eg: wp_events_detail
-     * @param string $new_table with wpdb prefix (wp_). Eg: wp_posts
-     * @param mixed  $new_pk
-     * @return mixed
-     */
-    public function get_mapping_old_pk($old_table, $new_table, $new_pk)
-    {
-        if (
-            ! isset($this->_mappings[ $old_table ]) ||
-            ! isset($this->_mappings[ $old_table ][ $new_table ])
-        ) {
-            // try fetching the option
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
-        }
-        if (isset($this->_mappings[ $old_table ][ $new_table ])) {
-            $new_pk_to_old_pk = array_flip($this->_mappings[ $old_table ][ $new_table ]);
-            if (isset($new_pk_to_old_pk[ $new_pk ])) {
-                return $new_pk_to_old_pk[ $new_pk ];
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the mapping array option specified by the table names
-     *
-     * @param string $old_table_name
-     * @param string $new_table_name
-     * @return array
-     */
-    protected function _get_mapping_option($old_table_name, $new_table_name)
-    {
-        $option = get_option($this->_get_mapping_option_name($old_table_name, $new_table_name), array());
-        return $option;
-    }
-
-
-    /**
-     * Updates the mapping option specified by the table names with the array provided
-     *
-     * @param string $old_table_name
-     * @param string $new_table_name
-     * @param array  $mapping_array
-     * @return boolean success of updating option
-     */
-    protected function _set_mapping_option($old_table_name, $new_table_name, $mapping_array)
-    {
-        $success = update_option($this->_get_mapping_option_name($old_table_name, $new_table_name), $mapping_array, false);
-        return $success;
-    }
-
-
-    /**
-     * Gets the option name for this script to map from $old_table_name to $new_table_name
-     *
-     * @param string $old_table_name
-     * @param string $new_table_name
-     * @return string
-     */
-    protected function _get_mapping_option_name($old_table_name, $new_table_name)
-    {
-        global $wpdb;
-        $old_table_name_sans_wp = str_replace($wpdb->prefix, "", $old_table_name);
-        $new_table_name_sans_wp = str_replace($wpdb->prefix, "", $new_table_name);
-        $migrates_to = EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this));
-        return substr(
-            EE_Data_Migration_Manager::data_migration_script_mapping_option_prefix . $migrates_to ['slug'] . '_' . $migrates_to['version'] . '_' . $old_table_name_sans_wp . '_' . $new_table_name_sans_wp,
-            0,
-            64
-        );
-    }
-
-
-    /**
-     * Counts all the records that will be migrated during this data migration.
-     * For example, if we were changing old user passwords from plaintext to encoded versions,
-     * this would be a count of all users who have passwords. If we were going to also split
-     * attendee records into transactions, registrations, and attendee records, this would include
-     * the count of all attendees currently in existence in the DB (ie, users + attendees).
-     * If you can't determine how many records there are to migrate, just provide a guess: this
-     * number will only be used in calculating the percent complete. If you estimate there to be
-     * 100 records to migrate, and it turns out there's 120, we'll just show the migration as being at
-     * 99% until the function "migration_step" returns EE_Data_Migration_Script_Base::status_complete.
-     *
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        $count = 0;
-        foreach ($this->stages() as $stage) {
-            $count += $stage->count_records_to_migrate();
-        }
-        return $count;
-    }
-
-
-    /**
-     * Returns the number of records updated so far. Usually this is easiest to do
-     * by just setting a transient and updating it after each migration_step
-     *
-     * @return int
-     */
-    public function count_records_migrated()
-    {
-        $count = 0;
-        foreach ($this->stages() as $stage) {
-            $count += $stage->count_records_migrated();
-        }
-        $this->_records_migrated = $count;
-        return $count;
-    }
-
-
-    /**
-     * @param int $num_records_to_migrate_limit
-     * @return int
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function migration_step($num_records_to_migrate_limit)
-    {
-        // reset the feedback message
-        $this->_feedback_message = '';
-        // if we haven't yet done the 1st schema changes, do them now. buffer any output
-        $this->_maybe_do_schema_changes(true);
-
-        $num_records_actually_migrated = 0;
-        $records_migrated_per_stage = array();
-        // setup the 'stage' variable, which should hold the last run stage of the migration  (or none at all if nothing runs)
-        $stage = null;
-        // get the next stage that isn't complete
-        foreach ($this->stages() as $stage) {
-            if ($stage->get_status() == EE_Data_Migration_Manager::status_continue) {
-                try {
-                    $records_migrated_during_stage = $stage->migration_step(
-                        $num_records_to_migrate_limit - $num_records_actually_migrated
-                    );
-                    $num_records_actually_migrated += $records_migrated_during_stage;
-                    $records_migrated_per_stage[ $stage->pretty_name() ] = $records_migrated_during_stage;
-                } catch (Exception $e) {
-                    // yes if we catch an exception here, we consider that migration stage borked.
-                    $stage->set_status(EE_Data_Migration_Manager::status_fatal_error);
-                    $this->set_status(EE_Data_Migration_Manager::status_fatal_error);
-                    $stage->add_error($e->getMessage() . ". Stack-trace:" . $e->getTraceAsString());
-                    throw $e;
-                }
-                // check that the migration stage didn't mark itself as having a fatal error
-                if ($stage->is_broken()) {
-                    $this->set_broken();
-                    throw new EE_Error($stage->get_last_error());
-                }
-            }
-            // once we've migrated all the number we intended to (possibly from different stages), stop migrating
-            // or if we had a fatal error
-            // or if the current script stopped early- its not done, but it's done all it thinks we should do on this step
-            if (
-                $num_records_actually_migrated >= $num_records_to_migrate_limit
-                || $stage->is_broken()
-                || $stage->has_more_to_do()
-            ) {
-                break;
-            }
-        }
-        // check if we're all done this data migration...
-        // which is indicated by being done early AND the last stage claims to be done
-        if ($stage == null) {
-            // this migration script apparently has NO stages... which is super weird, but whatever
-            $this->set_completed();
-            $this->_maybe_do_schema_changes(false);
-        } elseif ($num_records_actually_migrated < $num_records_to_migrate_limit && ! $stage->has_more_to_do()) {
-            // apparently we're done, because we couldn't migrate the number we intended to
-            $this->set_completed();
-            $this->_update_feedback_message(array_reverse($records_migrated_per_stage));
-            // do schema changes for after the migration now
-            // first double-check we haven't already done this
-            $this->_maybe_do_schema_changes(false);
-        } else {
-            // update feedback message, keeping in mind that we show them with the most recent at the top
-            $this->_update_feedback_message(array_reverse($records_migrated_per_stage));
-        }
-        return $num_records_actually_migrated;
-    }
-
-
-    /**
-     * Updates the feedback message according to what was done during this migration stage.
-     *
-     * @param array $records_migrated_per_stage KEYS are pretty names for each stage; values are the count of records
-     *                                          migrated from that stage
-     * @return void
-     */
-    private function _update_feedback_message($records_migrated_per_stage)
-    {
-        $feedback_message_array = array();
-        foreach ($records_migrated_per_stage as $migration_stage_name => $num_records_migrated) {
-            $feedback_message_array[] = sprintf(
-                esc_html__("Migrated %d records successfully during %s", "event_espresso"),
-                $num_records_migrated,
-                $migration_stage_name
-            );
-        }
-        $this->_feedback_message .= implode("<br>", $feedback_message_array);
-    }
-
-
-    /**
-     * Calls either schema_changes_before_migration() (if $before==true) or schema_changes_after_migration
-     * (if $before==false). Buffers their outputs and stores them on the class.
-     *
-     * @param boolean $before
-     * @throws Exception
-     * @return void
-     */
-    private function _maybe_do_schema_changes($before = true)
-    {
-        // so this property will be either _schema_changes_after_migration_ran or _schema_changes_before_migration_ran
-        $property_name = '_schema_changes_' . ($before ? 'before' : 'after') . '_migration_ran';
-        if (! $this->{$property_name}) {
-            try {
-                ob_start();
-                if ($before) {
-                    $this->schema_changes_before_migration();
-                } else {
-                    $this->schema_changes_after_migration();
-                }
-                $output = ob_get_contents();
-                ob_end_clean();
-            } catch (Exception $e) {
-                $this->set_status(EE_Data_Migration_Manager::status_fatal_error);
-                throw $e;
-            }
-            // record that we've done these schema changes
-            $this->{$property_name} = true;
-            // if there were any warnings etc, record them as non-fatal errors
-            if ($output) {
-                // there were some warnings
-                $this->_errors[] = $output;
-            }
-        }
-    }
-
-
-    /**
-     * Wrapper for EEH_Activation::create_table. However, takes into account the request type when
-     * deciding what to pass for its 4th arg, $drop_pre_existing_tables. Using this function, instead
-     * of _table_should_exist_previously, indicates that this table should be new to the EE version being migrated to
-     * or
-     * activated currently. If this is a brand new activation or a migration, and we're indicating this table should
-     * not
-     * previously exist, then we want to set $drop_pre_existing_tables to TRUE (ie, we shouldn't discover that this
-     * table exists in the DB in EEH_Activation::create_table- if it DOES exist, something's wrong and the old table
-     * should be nuked.
-     *
-     * Just for a bit of context, the migration script's db_schema_changes_* methods
-     * are called basically in 3 cases: on brand new activation of EE4 (ie no previous version of EE existed and the
-     * plugin is being activated and we want to add all the brand new tables), upon reactivation of EE4 (it was
-     * deactivated and then reactivated, in which case we want to just verify the DB structure is ok) that table should
-     * be dropped), and during a migration when we're moving the DB to the state of the migration script
-     *
-     * @param string $table_name
-     * @param string $table_definition_sql
-     * @param string $engine_string
-     */
-    protected function _table_is_new_in_this_version(
-        $table_name,
-        $table_definition_sql,
-        $engine_string = 'ENGINE=InnoDB '
-    ) {
-        $this->_create_table_and_catch_errors(
-            $table_name,
-            $table_definition_sql,
-            $engine_string,
-            $this->_pre_existing_table_should_be_dropped(true)
-        );
-    }
-
-    /**
-     * Like _table_is_new_in_this_version and _table_should_exist_previously, this function verifies the given table
-     * exists. But we understand that this table has CHANGED in this version since the previous version. So it's not
-     * completely new, but it's different. So we need to treat it like a new table in terms of verifying it's schema is
-     * correct on activations, migrations, upgrades; but if it exists when it shouldn't, we need to be as lenient as
-     * _table_should_exist_previously.
-     * 8656]{Assumes only this plugin could have added this table (ie, if its a new activation of this plugin, the
-     * table shouldn't exist).
-     *
-     * @param string $table_name
-     * @param string $table_definition_sql
-     * @param string $engine_string
-     */
-    protected function _table_is_changed_in_this_version(
-        $table_name,
-        $table_definition_sql,
-        $engine_string = 'ENGINE=MyISAM'
-    ) {
-        $this->_create_table_and_catch_errors(
-            $table_name,
-            $table_definition_sql,
-            $engine_string,
-            $this->_pre_existing_table_should_be_dropped(false)
-        );
-    }
-
-
-    /**
-     * _old_table_exists
-     * returns TRUE if the requested table exists in the current database
-     *
-     * @param string $table_name
-     * @return boolean
-     */
-    protected function _old_table_exists($table_name)
-    {
-        return $this->_get_table_analysis()->tableExists($table_name);
-    }
-
-
-    /**
-     * _delete_table_if_empty
-     * returns TRUE if the requested table was empty and successfully empty
-     *
-     * @param string $table_name
-     * @return boolean
-     */
-    protected function _delete_table_if_empty($table_name)
-    {
-        return EEH_Activation::delete_db_table_if_empty($table_name);
-    }
-
-
-    /**
-     * It is preferred to use _table_has_not_changed_since_previous or _table_is_changed_in_this_version
-     * as these are significantly more efficient or explicit.
-     * Please see description of _table_is_new_in_this_version. This function will only set
-     * EEH_Activation::create_table's $drop_pre_existing_tables to TRUE if it's a brand
-     * new activation. ie, a more accurate name for this method would be "_table_added_previously_by_this_plugin"
-     * because the table will be cleared out if this is a new activation (ie, if its a new activation, it actually
-     * should exist previously). Otherwise, we'll always set $drop_pre_existing_tables to FALSE because the table
-     * should have existed. Note, if the table is being MODIFIED in this version being activated or migrated to, then
-     * you want _table_is_changed_in_this_version NOT this one. We don't check this table's structure during migrations
-     * because apparently it hasn't changed since the previous one, right?
-     *
-     * @param string $table_name
-     * @param string $table_definition_sql
-     * @param string $engine_string
-     */
-    protected function _table_should_exist_previously(
-        $table_name,
-        $table_definition_sql,
-        $engine_string = 'ENGINE=MyISAM'
-    ) {
-        $this->_create_table_and_catch_errors(
-            $table_name,
-            $table_definition_sql,
-            $engine_string,
-            $this->_pre_existing_table_should_be_dropped(false)
-        );
-    }
-
-    /**
-     * Exactly the same as _table_should_exist_previously(), except if this migration script is currently doing
-     * a migration, we skip checking this table's structure in the database and just assume it's correct.
-     * So this is useful only to improve efficiency when doing migrations (not a big deal for single site installs,
-     * but important for multisite where migrations can take a very long time otherwise).
-     * If the table is known to have changed since previous version, use _table_is_changed_in_this_version().
-     * Assumes only this plugin could have added this table (ie, if its a new activation of this plugin, the table
-     * shouldn't exist).
-     *
-     * @param string $table_name
-     * @param string $table_definition_sql
-     * @param string $engine_string
-     */
-    protected function _table_has_not_changed_since_previous(
-        $table_name,
-        $table_definition_sql,
-        $engine_string = 'ENGINE=MyISAM'
-    ) {
-        if ($this->_currently_migrating()) {
-            // if we're doing a migration, and this table apparently already exists, then we don't need do anything right?
-            return;
-        }
-        $this->_create_table_and_catch_errors(
-            $table_name,
-            $table_definition_sql,
-            $engine_string,
-            $this->_pre_existing_table_should_be_dropped(false)
-        );
-    }
-
-    /**
-     * Returns whether or not this migration script is being used as part of an actual migration
-     *
-     * @return boolean
-     */
-    protected function _currently_migrating()
-    {
-        // we want to know if we are currently performing a migration. We could just believe what was set on the _migrating property, but let's double-check (ie the script should apply and we should be in MM)
-        return $this->_migrating &&
-               $this->can_migrate_from_version(
-                   EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set()
-               ) &&
-               EE_Maintenance_Mode::instance()->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance;
-    }
-
-    /**
-     * Determines if a table should be dropped, based on whether it's reported to be new in $table_is_new,
-     * and the plugin's request type.
-     * Assumes only this plugin could have added the table (ie, if its a new activation of this plugin, the table
-     * shouldn't exist no matter what).
-     *
-     * @param boolean $table_is_new
-     * @return boolean
-     */
-    protected function _pre_existing_table_should_be_dropped($table_is_new)
-    {
-        if ($table_is_new) {
-            if (
-                $this->_get_req_type_for_plugin_corresponding_to_this_dms() == EE_System::req_type_new_activation
-                || $this->_currently_migrating()
-            ) {
-                return true;
-            } else {
-                return false;
-            }
-        } else {
-            if (
-                in_array(
-                    $this->_get_req_type_for_plugin_corresponding_to_this_dms(),
-                    array(EE_System::req_type_new_activation)
-                )
-            ) {
-                return true;
-            } else {
-                return false;
-            }
-        }
-    }
-
-    /**
-     * Just wraps EEH_Activation::create_table, but catches any errors it may throw and adds them as errors on the DMS
-     *
-     * @param string  $table_name
-     * @param string  $table_definition_sql
-     * @param string  $engine_string
-     * @param boolean $drop_pre_existing_tables
-     */
-    private function _create_table_and_catch_errors(
-        $table_name,
-        $table_definition_sql,
-        $engine_string = 'ENGINE=MyISAM',
-        $drop_pre_existing_tables = false
-    ) {
-        try {
-            EEH_Activation::create_table($table_name, $table_definition_sql, $engine_string, $drop_pre_existing_tables);
-        } catch (EE_Error $e) {
-            $message = $e->getMessage() . '<br>Stack Trace:' . $e->getTraceAsString();
-            $this->add_error($message);
-            $this->_feedback_message .= $message;
-        }
-    }
-
-
-    /**
-     * Gets the request type for the plugin (core or addon) that corresponds to this DMS
-     *
-     * @return int one of EE_System::_req_type_* constants
-     * @throws EE_Error
-     */
-    private function _get_req_type_for_plugin_corresponding_to_this_dms()
-    {
-        if ($this->slug() == 'Core') {
-            return EE_System::instance()->detect_req_type();
-        } else {// it must be for an addon
-            $addon_name = $this->slug();
-            if (EE_Registry::instance()->get_addon_by_name($addon_name)) {
-                return EE_Registry::instance()->get_addon_by_name($addon_name)->detect_req_type();
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "The DMS slug '%s' should correspond to the addon's name, which should also be '%s', but no such addon was registered. These are the registered addons' names: %s",
-                            "event_espresso"
-                        ),
-                        $this->slug(),
-                        $addon_name,
-                        implode(",", array_keys(EE_Registry::instance()->get_addons_by_name()))
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * returns an array of strings describing errors by all the script's stages
-     *
-     * @return array
-     */
-    public function get_errors()
-    {
-        $all_errors = $this->_errors;
-        if (! is_array($all_errors)) {
-            $all_errors = array();
-        }
-        foreach ($this->stages() as $stage) {
-            $all_errors = array_merge($stage->get_errors(), $all_errors);
-        }
-        return $all_errors;
-    }
-
-
-    /**
-     * Indicates whether or not this migration script should continue
-     *
-     * @return boolean
-     */
-    public function can_continue()
-    {
-        return in_array(
-            $this->get_status(),
-            EE_Data_Migration_Manager::instance()->stati_that_indicate_to_continue_single_migration_script
-        );
-    }
-
-
-    /**
-     * Gets all the data migration stages associated with this script. Note:
-     * addons can filter this list to add their own stages, and because the list is
-     * numerically-indexed, they can insert their stage wherever they like and it will
-     * get ordered by the indexes
-     *
-     * @return EE_Data_Migration_Script_Stage[]
-     */
-    protected function stages()
-    {
-        $stages = apply_filters('FHEE__' . get_class($this) . '__stages', $this->_migration_stages);
-        ksort($stages);
-        return $stages;
-    }
-
-
-    /**
-     * Gets a string which should describe what's going on currently with this migration, which
-     * can be displayed to the user
-     *
-     * @return string
-     */
-    public function get_feedback_message()
-    {
-        return $this->_feedback_message;
-    }
-
-
-    /**
-     * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
-     * properties to the DB. However, we don't want to use __sleep() because its quite
-     * possible that this class is defined when it goes to sleep, but NOT available when it
-     * awakes (eg, this class is part of an addon that is deactivated at some point).
-     */
-    public function properties_as_array()
-    {
-        $properties = parent::properties_as_array();
-        $properties['_migration_stages'] = array();
-        foreach ($this->_migration_stages as $migration_stage_priority => $migration_stage_class) {
-            $properties['_migration_stages'][ $migration_stage_priority ] = $migration_stage_class->properties_as_array(
-            );
-        }
-        unset($properties['_mappings']);
-        unset($properties['previous_dms']);
-
-        foreach ($this->_mappings as $old_table_name => $mapping_to_new_table) {
-            foreach ($mapping_to_new_table as $new_table_name => $mapping) {
-                $this->_set_mapping_option($old_table_name, $new_table_name, $mapping);
-            }
-        }
-        return $properties;
-    }
-
-
-    /**
-     * Sets all of the properties of this script stage to match what's in the array, which is assumed
-     * to have been made from the properties_as_array() function.
-     *
-     * @param array $array_of_properties like what's produced from properties_as_array() method
-     * @return void
-     */
-    public function instantiate_from_array_of_properties($array_of_properties)
-    {
-        $stages_properties_arrays = $array_of_properties['_migration_stages'];
-        unset($array_of_properties['_migration_stages']);
-        unset($array_of_properties['class']);
-        foreach ($array_of_properties as $property_name => $property_value) {
-            $this->{$property_name} = $property_value;
-        }
-        // _migration_stages are already instantiated, but have only default data
-        foreach ($this->_migration_stages as $stage) {
-            $stage_data = $this->_find_migration_stage_data_with_classname(
-                get_class($stage),
-                $stages_properties_arrays
-            );
-            // SO, if we found the stage data that was saved, use it. Otherwise, I guess the stage is new? (maybe added by
-            // an addon? Unlikely... not sure why it wouldn't exist, but if it doesn't just treat it like it was never started yet)
-            if ($stage_data) {
-                $stage->instantiate_from_array_of_properties($stage_data);
-            }
-        }
-    }
-
-
-    /**
-     * Gets the migration data from the array $migration_stage_data_arrays (which is an array of arrays, each of which
-     * is pretty well identical to EE_Data_Migration_Stage objects except all their properties are array indexes)
-     * for the given classname
-     *
-     * @param string $classname
-     * @param array  $migration_stage_data_arrays
-     * @return null
-     */
-    private function _find_migration_stage_data_with_classname($classname, $migration_stage_data_arrays)
-    {
-        foreach ($migration_stage_data_arrays as $migration_stage_data_array) {
-            if (isset($migration_stage_data_array['class']) && $migration_stage_data_array['class'] == $classname) {
-                return $migration_stage_data_array;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns the version that this script migrates to, based on the script's name.
-     * Cannot be overwritten because lots of code needs to know which version a script
-     * migrates to knowing only its name.
-     *
-     * @return array where the first key is the plugin's slug, the 2nd is the version of that plugin
-     * that will be updated to. Eg array('Core','4.1.0')
-     */
-    final public function migrates_to_version()
-    {
-        return EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this));
-    }
-
-
-    /**
-     * Gets this addon's slug as it would appear in the current_db_state wp option,
-     * and if this migration script is for an addon, it SHOULD match the addon's slug
-     * (and also the addon's classname, minus the 'EE_' prefix.). Eg, 'Calendar' for the EE_Calendar addon.
-     * Or 'Core' for core (non-addon).
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        $migrates_to_version_info = $this->migrates_to_version();
-        // the slug is the first part of the array
-        return $migrates_to_version_info['slug'];
-    }
-
-
-    /**
-     * Returns the script's priority relative to DMSs from other addons. However, when
-     * two DMSs from the same addon/core apply, this is ignored (and instead the version that
-     * the script migrates to is used to determine which to run first). The default is 5, but all core DMSs
-     * normally have priority 10. (So if you want a DMS "A" to run before DMS "B", both of which are from addons,
-     * and both of which CAN run at the same time (ie, "B" doesn't depend on "A" to set
-     * the database up so it can run), then you can set "A" to priority 3 or something.
-     *
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->_priority;
-    }
-
-
-    /**
-     * Sets whether or not this DMS is being ran as part of a migration, instead of
-     * just being used to setup (or verify) the current database structure matches
-     * what the latest DMS indicates it should be
-     *
-     * @param boolean $migrating
-     * @return void
-     */
-    public function set_migrating($migrating = true)
-    {
-        $this->_migrating = $migrating;
-    }
-
-    /**
-     * Marks that we think this migration class can continue to migrate
-     */
-    public function reattempt()
-    {
-        parent::reattempt();
-        // also, we want to reattempt any stages that were marked as borked
-        foreach ($this->stages() as $stage) {
-            if ($stage->is_broken()) {
-                $stage->reattempt();
-            }
-        }
-    }
+	/**
+	 * Set by client code to indicate this DMS is being ran as part of a proper migration,
+	 * instead of being used to merely setup (or verify) the database structure.
+	 * Defaults to TRUE, so client code that's NOT using this DMS as part of a proper migration
+	 * should call EE_Data_Migration_Script_Base::set_migrating( FALSE )
+	 *
+	 * @var boolean
+	 */
+	protected $_migrating = true;
+
+	/**
+	 * numerically-indexed array where each value is EE_Data_Migration_Script_Stage object
+	 *
+	 * @var EE_Data_Migration_Script_Stage[] $migration_functions
+	 */
+	protected $_migration_stages = array();
+
+	/**
+	 * Indicates we've already ran the schema changes that needed to happen BEFORE the data migration
+	 *
+	 * @var boolean
+	 */
+	protected $_schema_changes_before_migration_ran = null;
+
+	/**
+	 * Indicates we've already ran the schema changes that needed to happen AFTER the data migration
+	 *
+	 * @var boolean
+	 */
+	protected $_schema_changes_after_migration_ran = null;
+
+	/**
+	 * String which describes what's currently happening in this migration
+	 *
+	 * @var string
+	 */
+	protected $_feedback_message;
+
+	/**
+	 * Indicates the script's priority. Like wp's add_action and add_filter, lower numbers
+	 * correspond to earlier execution
+	 *
+	 * @var int
+	 */
+	protected $_priority = 5;
+
+	/**
+	 * Multi-dimensional array that defines the mapping from OLD table Primary Keys
+	 * to NEW table Primary Keys.
+	 * Top-level array keys are OLD table names (minus the "wp_" part),
+	 * 2nd-level array keys are NEW table names (again, minus the "wp_" part),
+	 * 3rd-level array keys are the OLD table primary keys
+	 * and 3rd-level array values are the NEW table primary keys
+	 *
+	 * @var array
+	 */
+	protected $_mappings = array();
+
+	/**
+	 * @var EE_Data_Migration_Script_Base
+	 */
+	protected $previous_dms;
+
+
+	/**
+	 * Returns whether or not this data migration script can operate on the given version of the database.
+	 * Eg, if this migration script can migrate from 3.1.26 or higher (but not anything after 4.0.0), and
+	 * it's passed a string like '3.1.38B', it should return true.
+	 * If this DMS is to migrate data from an EE3 addon, you will probably want to use
+	 * EventEspresso\core\services\database\TableAnalysis::tableExists() to check for old EE3 tables, and
+	 * EE_Data_Migration_Manager::get_migration_ran() to check that core was already
+	 * migrated from EE3 to EE4 (ie, this DMS probably relies on some migration data generated
+	 * during the Core 4.1.0 DMS. If core didn't run that DMS, you probably don't want
+	 * to run this DMS).
+	 * If this DMS migrates data from a previous version of this EE4 addon, just
+	 * comparing $current_database_state_of[ $this->slug() ] will probably suffice.
+	 * If this DMS should never migrate data, because it's only used to define the initial
+	 * database state, just return FALSE (and core's activation process will take care
+	 * of calling its schema_changes_before_migration() and
+	 * schema_changes_after_migration() for you. )
+	 *
+	 * @param array $current_database_state_of keys are EE plugin slugs (eg 'Core', 'Calendar', 'Mailchimp', etc)
+	 * @return boolean
+	 */
+	abstract public function can_migrate_from_version($current_database_state_of);
+
+
+	/**
+	 * Performs database schema changes that need to occur BEFORE the data is migrated.
+	 * Eg, if we were going to change user passwords from plaintext to encoded versions
+	 * during this migration, this would probably add a new column called something like
+	 * "encoded_password".
+	 *
+	 * @return boolean of success
+	 */
+	abstract public function schema_changes_before_migration();
+
+
+	/**
+	 * Performs the database schema changes that need to occur AFTER the data has been migrated.
+	 * Usually this will mean we'll be removing old columns. Eg, if we were changing passwords
+	 * from plaintext to encoded versions, and we had added a column called "encoded_password",
+	 * this function would probably remove the old column "password" (which still holds the plaintext password)
+	 * and possibly rename "encoded_password" to "password"
+	 *
+	 * @return boolean of success
+	 */
+	abstract public function schema_changes_after_migration();
+
+
+	/**
+	 * All children of this must call parent::__construct()
+	 * at the end of their constructor or suffer the consequences!
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_migration_stages = (array) apply_filters(
+			'FHEE__' . get_class($this) . '__construct__migration_stages',
+			$this->_migration_stages
+		);
+		foreach ($this->_migration_stages as $migration_stage) {
+			if ($migration_stage instanceof EE_Data_Migration_Script_Stage) {
+				$migration_stage->_construct_finalize($this);
+			}
+		}
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+
+	/**
+	 * Place to add hooks and filters for tweaking the migrations page, in order
+	 * to customize it
+	 */
+	public function migration_page_hooks()
+	{
+		// by default none are added because we normally like the default look of the migration page
+	}
+
+
+	/**
+	 * Sets the mapping from old table primary keys to new table primary keys.
+	 * This mapping is automatically persisted as a property on the migration
+	 *
+	 * @param string     $old_table with wpdb prefix (wp_). Eg: wp_events_detail
+	 * @param int|string $old_pk    old primary key. Eg events_detail.id's value
+	 * @param string     $new_table with wpdb prefix (wp_). Eg: wp_posts
+	 * @param int|string $new_pk    eg posts.ID
+	 * @return void
+	 */
+	public function set_mapping($old_table, $old_pk, $new_table, $new_pk)
+	{
+		// make sure it has the needed keys
+		if (! isset($this->_mappings[ $old_table ]) || ! isset($this->_mappings[ $old_table ][ $new_table ])) {
+			$this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+		}
+		$this->_mappings[ $old_table ][ $new_table ][ $old_pk ] = $new_pk;
+	}
+
+
+	/**
+	 * Gets the new primary key, if provided with the OLD table and the primary key
+	 * of an item in the old table, and the new table
+	 *
+	 * @param string     $old_table with wpdb prefix (wp_). Eg: wp_events_detail
+	 * @param int|string $old_pk    old primary key. Eg events_detail.id's value
+	 * @param string     $new_table with wpdb prefix (wp_). Eg: wp_posts
+	 * @return mixed the primary key on the new table
+	 */
+	public function get_mapping_new_pk($old_table, $old_pk, $new_table)
+	{
+		if (
+			! isset($this->_mappings[ $old_table ]) ||
+			! isset($this->_mappings[ $old_table ][ $new_table ])
+		) {
+			// try fetching the option
+			$this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+		}
+		return isset($this->_mappings[ $old_table ][ $new_table ][ $old_pk ])
+			? $this->_mappings[ $old_table ][ $new_table ][ $old_pk ] : null;
+	}
+
+
+	/**
+	 * Gets the old primary key, if provided with the OLD table,
+	 * and the new table and the primary key of an item in the new table
+	 *
+	 * @param string $old_table with wpdb prefix (wp_). Eg: wp_events_detail
+	 * @param string $new_table with wpdb prefix (wp_). Eg: wp_posts
+	 * @param mixed  $new_pk
+	 * @return mixed
+	 */
+	public function get_mapping_old_pk($old_table, $new_table, $new_pk)
+	{
+		if (
+			! isset($this->_mappings[ $old_table ]) ||
+			! isset($this->_mappings[ $old_table ][ $new_table ])
+		) {
+			// try fetching the option
+			$this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+		}
+		if (isset($this->_mappings[ $old_table ][ $new_table ])) {
+			$new_pk_to_old_pk = array_flip($this->_mappings[ $old_table ][ $new_table ]);
+			if (isset($new_pk_to_old_pk[ $new_pk ])) {
+				return $new_pk_to_old_pk[ $new_pk ];
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the mapping array option specified by the table names
+	 *
+	 * @param string $old_table_name
+	 * @param string $new_table_name
+	 * @return array
+	 */
+	protected function _get_mapping_option($old_table_name, $new_table_name)
+	{
+		$option = get_option($this->_get_mapping_option_name($old_table_name, $new_table_name), array());
+		return $option;
+	}
+
+
+	/**
+	 * Updates the mapping option specified by the table names with the array provided
+	 *
+	 * @param string $old_table_name
+	 * @param string $new_table_name
+	 * @param array  $mapping_array
+	 * @return boolean success of updating option
+	 */
+	protected function _set_mapping_option($old_table_name, $new_table_name, $mapping_array)
+	{
+		$success = update_option($this->_get_mapping_option_name($old_table_name, $new_table_name), $mapping_array, false);
+		return $success;
+	}
+
+
+	/**
+	 * Gets the option name for this script to map from $old_table_name to $new_table_name
+	 *
+	 * @param string $old_table_name
+	 * @param string $new_table_name
+	 * @return string
+	 */
+	protected function _get_mapping_option_name($old_table_name, $new_table_name)
+	{
+		global $wpdb;
+		$old_table_name_sans_wp = str_replace($wpdb->prefix, "", $old_table_name);
+		$new_table_name_sans_wp = str_replace($wpdb->prefix, "", $new_table_name);
+		$migrates_to = EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this));
+		return substr(
+			EE_Data_Migration_Manager::data_migration_script_mapping_option_prefix . $migrates_to ['slug'] . '_' . $migrates_to['version'] . '_' . $old_table_name_sans_wp . '_' . $new_table_name_sans_wp,
+			0,
+			64
+		);
+	}
+
+
+	/**
+	 * Counts all the records that will be migrated during this data migration.
+	 * For example, if we were changing old user passwords from plaintext to encoded versions,
+	 * this would be a count of all users who have passwords. If we were going to also split
+	 * attendee records into transactions, registrations, and attendee records, this would include
+	 * the count of all attendees currently in existence in the DB (ie, users + attendees).
+	 * If you can't determine how many records there are to migrate, just provide a guess: this
+	 * number will only be used in calculating the percent complete. If you estimate there to be
+	 * 100 records to migrate, and it turns out there's 120, we'll just show the migration as being at
+	 * 99% until the function "migration_step" returns EE_Data_Migration_Script_Base::status_complete.
+	 *
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		$count = 0;
+		foreach ($this->stages() as $stage) {
+			$count += $stage->count_records_to_migrate();
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Returns the number of records updated so far. Usually this is easiest to do
+	 * by just setting a transient and updating it after each migration_step
+	 *
+	 * @return int
+	 */
+	public function count_records_migrated()
+	{
+		$count = 0;
+		foreach ($this->stages() as $stage) {
+			$count += $stage->count_records_migrated();
+		}
+		$this->_records_migrated = $count;
+		return $count;
+	}
+
+
+	/**
+	 * @param int $num_records_to_migrate_limit
+	 * @return int
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function migration_step($num_records_to_migrate_limit)
+	{
+		// reset the feedback message
+		$this->_feedback_message = '';
+		// if we haven't yet done the 1st schema changes, do them now. buffer any output
+		$this->_maybe_do_schema_changes(true);
+
+		$num_records_actually_migrated = 0;
+		$records_migrated_per_stage = array();
+		// setup the 'stage' variable, which should hold the last run stage of the migration  (or none at all if nothing runs)
+		$stage = null;
+		// get the next stage that isn't complete
+		foreach ($this->stages() as $stage) {
+			if ($stage->get_status() == EE_Data_Migration_Manager::status_continue) {
+				try {
+					$records_migrated_during_stage = $stage->migration_step(
+						$num_records_to_migrate_limit - $num_records_actually_migrated
+					);
+					$num_records_actually_migrated += $records_migrated_during_stage;
+					$records_migrated_per_stage[ $stage->pretty_name() ] = $records_migrated_during_stage;
+				} catch (Exception $e) {
+					// yes if we catch an exception here, we consider that migration stage borked.
+					$stage->set_status(EE_Data_Migration_Manager::status_fatal_error);
+					$this->set_status(EE_Data_Migration_Manager::status_fatal_error);
+					$stage->add_error($e->getMessage() . ". Stack-trace:" . $e->getTraceAsString());
+					throw $e;
+				}
+				// check that the migration stage didn't mark itself as having a fatal error
+				if ($stage->is_broken()) {
+					$this->set_broken();
+					throw new EE_Error($stage->get_last_error());
+				}
+			}
+			// once we've migrated all the number we intended to (possibly from different stages), stop migrating
+			// or if we had a fatal error
+			// or if the current script stopped early- its not done, but it's done all it thinks we should do on this step
+			if (
+				$num_records_actually_migrated >= $num_records_to_migrate_limit
+				|| $stage->is_broken()
+				|| $stage->has_more_to_do()
+			) {
+				break;
+			}
+		}
+		// check if we're all done this data migration...
+		// which is indicated by being done early AND the last stage claims to be done
+		if ($stage == null) {
+			// this migration script apparently has NO stages... which is super weird, but whatever
+			$this->set_completed();
+			$this->_maybe_do_schema_changes(false);
+		} elseif ($num_records_actually_migrated < $num_records_to_migrate_limit && ! $stage->has_more_to_do()) {
+			// apparently we're done, because we couldn't migrate the number we intended to
+			$this->set_completed();
+			$this->_update_feedback_message(array_reverse($records_migrated_per_stage));
+			// do schema changes for after the migration now
+			// first double-check we haven't already done this
+			$this->_maybe_do_schema_changes(false);
+		} else {
+			// update feedback message, keeping in mind that we show them with the most recent at the top
+			$this->_update_feedback_message(array_reverse($records_migrated_per_stage));
+		}
+		return $num_records_actually_migrated;
+	}
+
+
+	/**
+	 * Updates the feedback message according to what was done during this migration stage.
+	 *
+	 * @param array $records_migrated_per_stage KEYS are pretty names for each stage; values are the count of records
+	 *                                          migrated from that stage
+	 * @return void
+	 */
+	private function _update_feedback_message($records_migrated_per_stage)
+	{
+		$feedback_message_array = array();
+		foreach ($records_migrated_per_stage as $migration_stage_name => $num_records_migrated) {
+			$feedback_message_array[] = sprintf(
+				esc_html__("Migrated %d records successfully during %s", "event_espresso"),
+				$num_records_migrated,
+				$migration_stage_name
+			);
+		}
+		$this->_feedback_message .= implode("<br>", $feedback_message_array);
+	}
+
+
+	/**
+	 * Calls either schema_changes_before_migration() (if $before==true) or schema_changes_after_migration
+	 * (if $before==false). Buffers their outputs and stores them on the class.
+	 *
+	 * @param boolean $before
+	 * @throws Exception
+	 * @return void
+	 */
+	private function _maybe_do_schema_changes($before = true)
+	{
+		// so this property will be either _schema_changes_after_migration_ran or _schema_changes_before_migration_ran
+		$property_name = '_schema_changes_' . ($before ? 'before' : 'after') . '_migration_ran';
+		if (! $this->{$property_name}) {
+			try {
+				ob_start();
+				if ($before) {
+					$this->schema_changes_before_migration();
+				} else {
+					$this->schema_changes_after_migration();
+				}
+				$output = ob_get_contents();
+				ob_end_clean();
+			} catch (Exception $e) {
+				$this->set_status(EE_Data_Migration_Manager::status_fatal_error);
+				throw $e;
+			}
+			// record that we've done these schema changes
+			$this->{$property_name} = true;
+			// if there were any warnings etc, record them as non-fatal errors
+			if ($output) {
+				// there were some warnings
+				$this->_errors[] = $output;
+			}
+		}
+	}
+
+
+	/**
+	 * Wrapper for EEH_Activation::create_table. However, takes into account the request type when
+	 * deciding what to pass for its 4th arg, $drop_pre_existing_tables. Using this function, instead
+	 * of _table_should_exist_previously, indicates that this table should be new to the EE version being migrated to
+	 * or
+	 * activated currently. If this is a brand new activation or a migration, and we're indicating this table should
+	 * not
+	 * previously exist, then we want to set $drop_pre_existing_tables to TRUE (ie, we shouldn't discover that this
+	 * table exists in the DB in EEH_Activation::create_table- if it DOES exist, something's wrong and the old table
+	 * should be nuked.
+	 *
+	 * Just for a bit of context, the migration script's db_schema_changes_* methods
+	 * are called basically in 3 cases: on brand new activation of EE4 (ie no previous version of EE existed and the
+	 * plugin is being activated and we want to add all the brand new tables), upon reactivation of EE4 (it was
+	 * deactivated and then reactivated, in which case we want to just verify the DB structure is ok) that table should
+	 * be dropped), and during a migration when we're moving the DB to the state of the migration script
+	 *
+	 * @param string $table_name
+	 * @param string $table_definition_sql
+	 * @param string $engine_string
+	 */
+	protected function _table_is_new_in_this_version(
+		$table_name,
+		$table_definition_sql,
+		$engine_string = 'ENGINE=InnoDB '
+	) {
+		$this->_create_table_and_catch_errors(
+			$table_name,
+			$table_definition_sql,
+			$engine_string,
+			$this->_pre_existing_table_should_be_dropped(true)
+		);
+	}
+
+	/**
+	 * Like _table_is_new_in_this_version and _table_should_exist_previously, this function verifies the given table
+	 * exists. But we understand that this table has CHANGED in this version since the previous version. So it's not
+	 * completely new, but it's different. So we need to treat it like a new table in terms of verifying it's schema is
+	 * correct on activations, migrations, upgrades; but if it exists when it shouldn't, we need to be as lenient as
+	 * _table_should_exist_previously.
+	 * 8656]{Assumes only this plugin could have added this table (ie, if its a new activation of this plugin, the
+	 * table shouldn't exist).
+	 *
+	 * @param string $table_name
+	 * @param string $table_definition_sql
+	 * @param string $engine_string
+	 */
+	protected function _table_is_changed_in_this_version(
+		$table_name,
+		$table_definition_sql,
+		$engine_string = 'ENGINE=MyISAM'
+	) {
+		$this->_create_table_and_catch_errors(
+			$table_name,
+			$table_definition_sql,
+			$engine_string,
+			$this->_pre_existing_table_should_be_dropped(false)
+		);
+	}
+
+
+	/**
+	 * _old_table_exists
+	 * returns TRUE if the requested table exists in the current database
+	 *
+	 * @param string $table_name
+	 * @return boolean
+	 */
+	protected function _old_table_exists($table_name)
+	{
+		return $this->_get_table_analysis()->tableExists($table_name);
+	}
+
+
+	/**
+	 * _delete_table_if_empty
+	 * returns TRUE if the requested table was empty and successfully empty
+	 *
+	 * @param string $table_name
+	 * @return boolean
+	 */
+	protected function _delete_table_if_empty($table_name)
+	{
+		return EEH_Activation::delete_db_table_if_empty($table_name);
+	}
+
+
+	/**
+	 * It is preferred to use _table_has_not_changed_since_previous or _table_is_changed_in_this_version
+	 * as these are significantly more efficient or explicit.
+	 * Please see description of _table_is_new_in_this_version. This function will only set
+	 * EEH_Activation::create_table's $drop_pre_existing_tables to TRUE if it's a brand
+	 * new activation. ie, a more accurate name for this method would be "_table_added_previously_by_this_plugin"
+	 * because the table will be cleared out if this is a new activation (ie, if its a new activation, it actually
+	 * should exist previously). Otherwise, we'll always set $drop_pre_existing_tables to FALSE because the table
+	 * should have existed. Note, if the table is being MODIFIED in this version being activated or migrated to, then
+	 * you want _table_is_changed_in_this_version NOT this one. We don't check this table's structure during migrations
+	 * because apparently it hasn't changed since the previous one, right?
+	 *
+	 * @param string $table_name
+	 * @param string $table_definition_sql
+	 * @param string $engine_string
+	 */
+	protected function _table_should_exist_previously(
+		$table_name,
+		$table_definition_sql,
+		$engine_string = 'ENGINE=MyISAM'
+	) {
+		$this->_create_table_and_catch_errors(
+			$table_name,
+			$table_definition_sql,
+			$engine_string,
+			$this->_pre_existing_table_should_be_dropped(false)
+		);
+	}
+
+	/**
+	 * Exactly the same as _table_should_exist_previously(), except if this migration script is currently doing
+	 * a migration, we skip checking this table's structure in the database and just assume it's correct.
+	 * So this is useful only to improve efficiency when doing migrations (not a big deal for single site installs,
+	 * but important for multisite where migrations can take a very long time otherwise).
+	 * If the table is known to have changed since previous version, use _table_is_changed_in_this_version().
+	 * Assumes only this plugin could have added this table (ie, if its a new activation of this plugin, the table
+	 * shouldn't exist).
+	 *
+	 * @param string $table_name
+	 * @param string $table_definition_sql
+	 * @param string $engine_string
+	 */
+	protected function _table_has_not_changed_since_previous(
+		$table_name,
+		$table_definition_sql,
+		$engine_string = 'ENGINE=MyISAM'
+	) {
+		if ($this->_currently_migrating()) {
+			// if we're doing a migration, and this table apparently already exists, then we don't need do anything right?
+			return;
+		}
+		$this->_create_table_and_catch_errors(
+			$table_name,
+			$table_definition_sql,
+			$engine_string,
+			$this->_pre_existing_table_should_be_dropped(false)
+		);
+	}
+
+	/**
+	 * Returns whether or not this migration script is being used as part of an actual migration
+	 *
+	 * @return boolean
+	 */
+	protected function _currently_migrating()
+	{
+		// we want to know if we are currently performing a migration. We could just believe what was set on the _migrating property, but let's double-check (ie the script should apply and we should be in MM)
+		return $this->_migrating &&
+			   $this->can_migrate_from_version(
+				   EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set()
+			   ) &&
+			   EE_Maintenance_Mode::instance()->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance;
+	}
+
+	/**
+	 * Determines if a table should be dropped, based on whether it's reported to be new in $table_is_new,
+	 * and the plugin's request type.
+	 * Assumes only this plugin could have added the table (ie, if its a new activation of this plugin, the table
+	 * shouldn't exist no matter what).
+	 *
+	 * @param boolean $table_is_new
+	 * @return boolean
+	 */
+	protected function _pre_existing_table_should_be_dropped($table_is_new)
+	{
+		if ($table_is_new) {
+			if (
+				$this->_get_req_type_for_plugin_corresponding_to_this_dms() == EE_System::req_type_new_activation
+				|| $this->_currently_migrating()
+			) {
+				return true;
+			} else {
+				return false;
+			}
+		} else {
+			if (
+				in_array(
+					$this->_get_req_type_for_plugin_corresponding_to_this_dms(),
+					array(EE_System::req_type_new_activation)
+				)
+			) {
+				return true;
+			} else {
+				return false;
+			}
+		}
+	}
+
+	/**
+	 * Just wraps EEH_Activation::create_table, but catches any errors it may throw and adds them as errors on the DMS
+	 *
+	 * @param string  $table_name
+	 * @param string  $table_definition_sql
+	 * @param string  $engine_string
+	 * @param boolean $drop_pre_existing_tables
+	 */
+	private function _create_table_and_catch_errors(
+		$table_name,
+		$table_definition_sql,
+		$engine_string = 'ENGINE=MyISAM',
+		$drop_pre_existing_tables = false
+	) {
+		try {
+			EEH_Activation::create_table($table_name, $table_definition_sql, $engine_string, $drop_pre_existing_tables);
+		} catch (EE_Error $e) {
+			$message = $e->getMessage() . '<br>Stack Trace:' . $e->getTraceAsString();
+			$this->add_error($message);
+			$this->_feedback_message .= $message;
+		}
+	}
+
+
+	/**
+	 * Gets the request type for the plugin (core or addon) that corresponds to this DMS
+	 *
+	 * @return int one of EE_System::_req_type_* constants
+	 * @throws EE_Error
+	 */
+	private function _get_req_type_for_plugin_corresponding_to_this_dms()
+	{
+		if ($this->slug() == 'Core') {
+			return EE_System::instance()->detect_req_type();
+		} else {// it must be for an addon
+			$addon_name = $this->slug();
+			if (EE_Registry::instance()->get_addon_by_name($addon_name)) {
+				return EE_Registry::instance()->get_addon_by_name($addon_name)->detect_req_type();
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"The DMS slug '%s' should correspond to the addon's name, which should also be '%s', but no such addon was registered. These are the registered addons' names: %s",
+							"event_espresso"
+						),
+						$this->slug(),
+						$addon_name,
+						implode(",", array_keys(EE_Registry::instance()->get_addons_by_name()))
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * returns an array of strings describing errors by all the script's stages
+	 *
+	 * @return array
+	 */
+	public function get_errors()
+	{
+		$all_errors = $this->_errors;
+		if (! is_array($all_errors)) {
+			$all_errors = array();
+		}
+		foreach ($this->stages() as $stage) {
+			$all_errors = array_merge($stage->get_errors(), $all_errors);
+		}
+		return $all_errors;
+	}
+
+
+	/**
+	 * Indicates whether or not this migration script should continue
+	 *
+	 * @return boolean
+	 */
+	public function can_continue()
+	{
+		return in_array(
+			$this->get_status(),
+			EE_Data_Migration_Manager::instance()->stati_that_indicate_to_continue_single_migration_script
+		);
+	}
+
+
+	/**
+	 * Gets all the data migration stages associated with this script. Note:
+	 * addons can filter this list to add their own stages, and because the list is
+	 * numerically-indexed, they can insert their stage wherever they like and it will
+	 * get ordered by the indexes
+	 *
+	 * @return EE_Data_Migration_Script_Stage[]
+	 */
+	protected function stages()
+	{
+		$stages = apply_filters('FHEE__' . get_class($this) . '__stages', $this->_migration_stages);
+		ksort($stages);
+		return $stages;
+	}
+
+
+	/**
+	 * Gets a string which should describe what's going on currently with this migration, which
+	 * can be displayed to the user
+	 *
+	 * @return string
+	 */
+	public function get_feedback_message()
+	{
+		return $this->_feedback_message;
+	}
+
+
+	/**
+	 * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
+	 * properties to the DB. However, we don't want to use __sleep() because its quite
+	 * possible that this class is defined when it goes to sleep, but NOT available when it
+	 * awakes (eg, this class is part of an addon that is deactivated at some point).
+	 */
+	public function properties_as_array()
+	{
+		$properties = parent::properties_as_array();
+		$properties['_migration_stages'] = array();
+		foreach ($this->_migration_stages as $migration_stage_priority => $migration_stage_class) {
+			$properties['_migration_stages'][ $migration_stage_priority ] = $migration_stage_class->properties_as_array(
+			);
+		}
+		unset($properties['_mappings']);
+		unset($properties['previous_dms']);
+
+		foreach ($this->_mappings as $old_table_name => $mapping_to_new_table) {
+			foreach ($mapping_to_new_table as $new_table_name => $mapping) {
+				$this->_set_mapping_option($old_table_name, $new_table_name, $mapping);
+			}
+		}
+		return $properties;
+	}
+
+
+	/**
+	 * Sets all of the properties of this script stage to match what's in the array, which is assumed
+	 * to have been made from the properties_as_array() function.
+	 *
+	 * @param array $array_of_properties like what's produced from properties_as_array() method
+	 * @return void
+	 */
+	public function instantiate_from_array_of_properties($array_of_properties)
+	{
+		$stages_properties_arrays = $array_of_properties['_migration_stages'];
+		unset($array_of_properties['_migration_stages']);
+		unset($array_of_properties['class']);
+		foreach ($array_of_properties as $property_name => $property_value) {
+			$this->{$property_name} = $property_value;
+		}
+		// _migration_stages are already instantiated, but have only default data
+		foreach ($this->_migration_stages as $stage) {
+			$stage_data = $this->_find_migration_stage_data_with_classname(
+				get_class($stage),
+				$stages_properties_arrays
+			);
+			// SO, if we found the stage data that was saved, use it. Otherwise, I guess the stage is new? (maybe added by
+			// an addon? Unlikely... not sure why it wouldn't exist, but if it doesn't just treat it like it was never started yet)
+			if ($stage_data) {
+				$stage->instantiate_from_array_of_properties($stage_data);
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the migration data from the array $migration_stage_data_arrays (which is an array of arrays, each of which
+	 * is pretty well identical to EE_Data_Migration_Stage objects except all their properties are array indexes)
+	 * for the given classname
+	 *
+	 * @param string $classname
+	 * @param array  $migration_stage_data_arrays
+	 * @return null
+	 */
+	private function _find_migration_stage_data_with_classname($classname, $migration_stage_data_arrays)
+	{
+		foreach ($migration_stage_data_arrays as $migration_stage_data_array) {
+			if (isset($migration_stage_data_array['class']) && $migration_stage_data_array['class'] == $classname) {
+				return $migration_stage_data_array;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns the version that this script migrates to, based on the script's name.
+	 * Cannot be overwritten because lots of code needs to know which version a script
+	 * migrates to knowing only its name.
+	 *
+	 * @return array where the first key is the plugin's slug, the 2nd is the version of that plugin
+	 * that will be updated to. Eg array('Core','4.1.0')
+	 */
+	final public function migrates_to_version()
+	{
+		return EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this));
+	}
+
+
+	/**
+	 * Gets this addon's slug as it would appear in the current_db_state wp option,
+	 * and if this migration script is for an addon, it SHOULD match the addon's slug
+	 * (and also the addon's classname, minus the 'EE_' prefix.). Eg, 'Calendar' for the EE_Calendar addon.
+	 * Or 'Core' for core (non-addon).
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		$migrates_to_version_info = $this->migrates_to_version();
+		// the slug is the first part of the array
+		return $migrates_to_version_info['slug'];
+	}
+
+
+	/**
+	 * Returns the script's priority relative to DMSs from other addons. However, when
+	 * two DMSs from the same addon/core apply, this is ignored (and instead the version that
+	 * the script migrates to is used to determine which to run first). The default is 5, but all core DMSs
+	 * normally have priority 10. (So if you want a DMS "A" to run before DMS "B", both of which are from addons,
+	 * and both of which CAN run at the same time (ie, "B" doesn't depend on "A" to set
+	 * the database up so it can run), then you can set "A" to priority 3 or something.
+	 *
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->_priority;
+	}
+
+
+	/**
+	 * Sets whether or not this DMS is being ran as part of a migration, instead of
+	 * just being used to setup (or verify) the current database structure matches
+	 * what the latest DMS indicates it should be
+	 *
+	 * @param boolean $migrating
+	 * @return void
+	 */
+	public function set_migrating($migrating = true)
+	{
+		$this->_migrating = $migrating;
+	}
+
+	/**
+	 * Marks that we think this migration class can continue to migrate
+	 */
+	public function reattempt()
+	{
+		parent::reattempt();
+		// also, we want to reattempt any stages that were marked as borked
+		foreach ($this->stages() as $stage) {
+			if ($stage->is_broken()) {
+				$stage->reattempt();
+			}
+		}
+	}
 }

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_shortcodes.dmsstage.php

Spacing +2 added lines, -2 removed lines

@@ -18,7 +18,7 @@ 
     {
         $new_post_content = $this->_change_event_list_shortcode($old_row['post_content']);
         global $wpdb;
-        $wpdb->query($wpdb->prepare("UPDATE " . $this->_old_table . " SET post_content=%s WHERE ID=%d", $new_post_content, $old_row['ID']));
+        $wpdb->query($wpdb->prepare("UPDATE ".$this->_old_table." SET post_content=%s WHERE ID=%d", $new_post_content, $old_row['ID']));
     }
 
     /**
@@ -48,7 +48,7 @@ 
     public function _count_records_to_migrate()
     {
         global $wpdb;
-        $count = $wpdb->get_var("SELECT COUNT(id) FROM " . $this->_old_table . $this->_sql_to_only_select_non_drafts());
+        $count = $wpdb->get_var("SELECT COUNT(id) FROM ".$this->_old_table.$this->_sql_to_only_select_non_drafts());
         return $count;
     }
 

Indentation +47 added lines, -48 removed lines

@@ -2,58 +2,57 @@
 
 /**
  * Goes through all the posts and pages, and converts old shortcodes to new ones
-
-*/
+ */
 
 class EE_DMS_4_1_0_shortcodes extends EE_Data_Migration_Script_Stage
 {
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = esc_html__("Shortcodes", "event_espresso");
-        $this->_old_table = $wpdb->posts;
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        $new_post_content = $this->_change_event_list_shortcode($old_row['post_content']);
-        global $wpdb;
-        $wpdb->query($wpdb->prepare("UPDATE " . $this->_old_table . " SET post_content=%s WHERE ID=%d", $new_post_content, $old_row['ID']));
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = esc_html__("Shortcodes", "event_espresso");
+		$this->_old_table = $wpdb->posts;
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		$new_post_content = $this->_change_event_list_shortcode($old_row['post_content']);
+		global $wpdb;
+		$wpdb->query($wpdb->prepare("UPDATE " . $this->_old_table . " SET post_content=%s WHERE ID=%d", $new_post_content, $old_row['ID']));
+	}
 
-    /**
-     * replaces [EVENT_LIST... with [ESPRESSO_EVENTS...]
-     * @param string $old_content
-     */
-    private function _change_event_list_shortcode($old_content)
-    {
-        return str_replace("[EVENT_LIST", "[ESPRESSO_EVENTS", $old_content);
-    }
+	/**
+	 * replaces [EVENT_LIST... with [ESPRESSO_EVENTS...]
+	 * @param string $old_content
+	 */
+	private function _change_event_list_shortcode($old_content)
+	{
+		return str_replace("[EVENT_LIST", "[ESPRESSO_EVENTS", $old_content);
+	}
 
-    public function _migration_step($num_items = 50)
-    {
-        global $wpdb;
-        $start_at_record = $this->count_records_migrated();
-        $rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table {$this->_sql_to_only_select_non_drafts()} LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A);
-        $items_actually_migrated = 0;
-        foreach ($rows as $old_row) {
-            $this->_migrate_old_row($old_row);
-            $items_actually_migrated++;
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
-    public function _count_records_to_migrate()
-    {
-        global $wpdb;
-        $count = $wpdb->get_var("SELECT COUNT(id) FROM " . $this->_old_table . $this->_sql_to_only_select_non_drafts());
-        return $count;
-    }
+	public function _migration_step($num_items = 50)
+	{
+		global $wpdb;
+		$start_at_record = $this->count_records_migrated();
+		$rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table {$this->_sql_to_only_select_non_drafts()} LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A);
+		$items_actually_migrated = 0;
+		foreach ($rows as $old_row) {
+			$this->_migrate_old_row($old_row);
+			$items_actually_migrated++;
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
+	public function _count_records_to_migrate()
+	{
+		global $wpdb;
+		$count = $wpdb->get_var("SELECT COUNT(id) FROM " . $this->_old_table . $this->_sql_to_only_select_non_drafts());
+		return $count;
+	}
 
-    private function _sql_to_only_select_non_drafts()
-    {
-        return " WHERE post_type NOT IN ('revision','auto-draft','attachment','nav_menu_item') ";
-    }
+	private function _sql_to_only_select_non_drafts()
+	{
+		return " WHERE post_type NOT IN ('revision','auto-draft','attachment','nav_menu_item') ";
+	}
 }