eventespresso / event-espresso-core

core/services/locators/LocatorInterface.php

Indentation +8 added lines, -8 removed lines

@@ -11,12 +11,12 @@
  */
 interface LocatorInterface
 {
-    /**
-     * given a string or an array of information for where to look,
-     * will find all files in that location
-     *
-     * @param array|string $location
-     * @return array
-     */
-    public function locate($location): array;
+	/**
+	 * given a string or an array of information for where to look,
+	 * will find all files in that location
+	 *
+	 * @param array|string $location
+	 * @return array
+	 */
+	public function locate($location): array;
 }

core/services/locators/FqcnLocator.php

Spacing +11 added lines, -11 removed lines

@@ -34,13 +34,13 @@ 
      */
     protected function setNamespace(?string $namespace, ?string $namespace_base_dir)
     {
-        if (! is_string($namespace)) {
+        if ( ! is_string($namespace)) {
             throw new InvalidDataTypeException('$namespace', $namespace, 'string');
         }
-        if (! is_string($namespace_base_dir)) {
+        if ( ! is_string($namespace_base_dir)) {
             throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
         }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
+        $this->namespaces[$namespace] = $namespace_base_dir;
     }
 
 
@@ -72,12 +72,12 @@ 
      */
     public function locate($namespaces): array
     {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
+        if ( ! (is_string($namespaces) || is_array($namespaces))) {
             throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
         }
         foreach ((array) $namespaces as $namespace) {
             foreach ($this->findFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
+                $this->FQCNs[$key] = $file;
             }
         }
         return $this->FQCNs;
@@ -106,11 +106,11 @@ 
         }
         foreach ($iterator as $file) {
             if ($file->isFile() && $file->getExtension() === 'php') {
-                $file = $file->getPath() . '/' . $file->getBasename('.php');
+                $file = $file->getPath().'/'.$file->getBasename('.php');
                 foreach ($this->namespaces as $namespace => $base_dir) {
                     $namespace .= Psr4Autoloader::NS;
                     if (strpos($file, $base_dir) === 0) {
-                        $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+                        $this->FQCNs[] = Psr4Autoloader::NS.str_replace(
                             [$base_dir, '/'],
                             [$namespace, Psr4Autoloader::NS],
                             $file
@@ -143,11 +143,11 @@ 
         // we're only interested in the Vendor and secondary base, so pull those from the array
         $vendor_base = array_slice($namespace_segments, 0, 2);
         $namespace   = $prefix = null;
-        while (! empty($vendor_base)) {
+        while ( ! empty($vendor_base)) {
             $namespace = implode(Psr4Autoloader::NS, $vendor_base);
             // check if there's a base directory registered for that namespace
-            $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
-            if (! empty($prefix) && ! empty($prefix[0])) {
+            $prefix = $psr4_loader->prefixes($namespace.Psr4Autoloader::NS);
+            if ( ! empty($prefix) && ! empty($prefix[0])) {
                 // found one!
                 break;
             }
@@ -160,6 +160,6 @@ 
         }
         $this->setNamespace($namespace, $prefix[0]);
         // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode('/', array_diff($namespace_segments, $vendor_base)) . '/';
+        return $prefix[0].implode('/', array_diff($namespace_segments, $vendor_base)).'/';
     }
 }

Indentation +142 added lines, -142 removed lines

@@ -18,146 +18,146 @@
  */
 class FqcnLocator extends Locator
 {
-    protected array $FQCNs      = [];
-
-    protected array $namespaces = [];
-
-
-    /**
-     * @param string|null $namespace
-     * @param string|null $namespace_base_dir
-     */
-    protected function setNamespace(?string $namespace, ?string $namespace_base_dir)
-    {
-        if (! is_string($namespace)) {
-            throw new InvalidDataTypeException('$namespace', $namespace, 'string');
-        }
-        if (! is_string($namespace_base_dir)) {
-            throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
-        }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getFQCNs(): array
-    {
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function count(): int
-    {
-        return count($this->FQCNs);
-    }
-
-
-    /**
-     * given a valid namespace, will find all files that match the provided mask
-     *
-     * @param string|array $namespaces
-     * @return array
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function locate($namespaces): array
-    {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
-            throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
-        }
-        foreach ((array) $namespaces as $namespace) {
-            foreach ($this->findFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * given a partial namespace, will find all files in that folder
-     * ** PLZ NOTE **
-     * This assumes that all files within the specified folder should be loaded
-     *
-     * @param string $partial_namespace
-     * @return array
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function findFQCNsByNamespace(string $partial_namespace): array
-    {
-        $iterator = new FilesystemIterator(
-            $this->getDirectoryFromPartialNamespace($partial_namespace)
-        );
-        $iterator->setFlags(FilesystemIterator::CURRENT_AS_FILEINFO);
-        $iterator->setFlags(FilesystemIterator::UNIX_PATHS);
-        if (iterator_count($iterator) === 0) {
-            return [];
-        }
-        foreach ($iterator as $file) {
-            if ($file->isFile() && $file->getExtension() === 'php') {
-                $file = $file->getPath() . '/' . $file->getBasename('.php');
-                foreach ($this->namespaces as $namespace => $base_dir) {
-                    $namespace .= Psr4Autoloader::NS;
-                    if (strpos($file, $base_dir) === 0) {
-                        $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
-                            [$base_dir, '/'],
-                            [$namespace, Psr4Autoloader::NS],
-                            $file
-                        );
-                    }
-                }
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * getDirectoryFromPartialNamespace
-     *
-     * @param string $partial_namespace almost fully qualified class name ?
-     * @return string
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws EE_Error
-     */
-    protected function getDirectoryFromPartialNamespace(string $partial_namespace): string
-    {
-        if (empty($partial_namespace)) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        // load our PSR-4 Autoloader so we can get the list of registered namespaces from it
-        $psr4_loader = EE_Psr4AutoloaderInit::psr4_loader();
-        // breakup the incoming namespace into segments so we can loop thru them
-        $namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
-        // we're only interested in the Vendor and secondary base, so pull those from the array
-        $vendor_base = array_slice($namespace_segments, 0, 2);
-        $namespace   = $prefix = null;
-        while (! empty($vendor_base)) {
-            $namespace = implode(Psr4Autoloader::NS, $vendor_base);
-            // check if there's a base directory registered for that namespace
-            $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
-            if (! empty($prefix) && ! empty($prefix[0])) {
-                // found one!
-                break;
-            }
-            // remove base and try vendor only portion of namespace
-            array_pop($vendor_base);
-        }
-        // nope? then the incoming namespace is invalid
-        if (empty($prefix) || empty($prefix[0])) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        $this->setNamespace($namespace, $prefix[0]);
-        // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode('/', array_diff($namespace_segments, $vendor_base)) . '/';
-    }
+	protected array $FQCNs      = [];
+
+	protected array $namespaces = [];
+
+
+	/**
+	 * @param string|null $namespace
+	 * @param string|null $namespace_base_dir
+	 */
+	protected function setNamespace(?string $namespace, ?string $namespace_base_dir)
+	{
+		if (! is_string($namespace)) {
+			throw new InvalidDataTypeException('$namespace', $namespace, 'string');
+		}
+		if (! is_string($namespace_base_dir)) {
+			throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
+		}
+		$this->namespaces[ $namespace ] = $namespace_base_dir;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getFQCNs(): array
+	{
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function count(): int
+	{
+		return count($this->FQCNs);
+	}
+
+
+	/**
+	 * given a valid namespace, will find all files that match the provided mask
+	 *
+	 * @param string|array $namespaces
+	 * @return array
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function locate($namespaces): array
+	{
+		if (! (is_string($namespaces) || is_array($namespaces))) {
+			throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
+		}
+		foreach ((array) $namespaces as $namespace) {
+			foreach ($this->findFQCNsByNamespace($namespace) as $key => $file) {
+				$this->FQCNs[ $key ] = $file;
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * given a partial namespace, will find all files in that folder
+	 * ** PLZ NOTE **
+	 * This assumes that all files within the specified folder should be loaded
+	 *
+	 * @param string $partial_namespace
+	 * @return array
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function findFQCNsByNamespace(string $partial_namespace): array
+	{
+		$iterator = new FilesystemIterator(
+			$this->getDirectoryFromPartialNamespace($partial_namespace)
+		);
+		$iterator->setFlags(FilesystemIterator::CURRENT_AS_FILEINFO);
+		$iterator->setFlags(FilesystemIterator::UNIX_PATHS);
+		if (iterator_count($iterator) === 0) {
+			return [];
+		}
+		foreach ($iterator as $file) {
+			if ($file->isFile() && $file->getExtension() === 'php') {
+				$file = $file->getPath() . '/' . $file->getBasename('.php');
+				foreach ($this->namespaces as $namespace => $base_dir) {
+					$namespace .= Psr4Autoloader::NS;
+					if (strpos($file, $base_dir) === 0) {
+						$this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+							[$base_dir, '/'],
+							[$namespace, Psr4Autoloader::NS],
+							$file
+						);
+					}
+				}
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * getDirectoryFromPartialNamespace
+	 *
+	 * @param string $partial_namespace almost fully qualified class name ?
+	 * @return string
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws EE_Error
+	 */
+	protected function getDirectoryFromPartialNamespace(string $partial_namespace): string
+	{
+		if (empty($partial_namespace)) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		// load our PSR-4 Autoloader so we can get the list of registered namespaces from it
+		$psr4_loader = EE_Psr4AutoloaderInit::psr4_loader();
+		// breakup the incoming namespace into segments so we can loop thru them
+		$namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
+		// we're only interested in the Vendor and secondary base, so pull those from the array
+		$vendor_base = array_slice($namespace_segments, 0, 2);
+		$namespace   = $prefix = null;
+		while (! empty($vendor_base)) {
+			$namespace = implode(Psr4Autoloader::NS, $vendor_base);
+			// check if there's a base directory registered for that namespace
+			$prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+			if (! empty($prefix) && ! empty($prefix[0])) {
+				// found one!
+				break;
+			}
+			// remove base and try vendor only portion of namespace
+			array_pop($vendor_base);
+		}
+		// nope? then the incoming namespace is invalid
+		if (empty($prefix) || empty($prefix[0])) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		$this->setNamespace($namespace, $prefix[0]);
+		// but if it's good, add that base directory to the rest of the path, and return it
+		return $prefix[0] . implode('/', array_diff($namespace_segments, $vendor_base)) . '/';
+	}
 }

admin_pages/registration_form/qtips/EE_Registration_Form_Tips.lib.php

Indentation +35 added lines, -35 removed lines

@@ -13,39 +13,39 @@
  */
 class EE_Registration_Form_Tips extends EE_Qtip_Config
 {
-    protected function _set_tips_array()
-    {
-        $this->_qtipsa = array(
-            0 => array(
-                'content_id' => 'about-system-lock-icon',
-                'target'     => '.questions .ee-system-lock',
-                'content'    => esc_html__('This question is a system question and cannot be trashed', 'event_espresso'),
-                'options'    => array(), // defaults
-            ),
-            1 => array(
-                'content_id' => 'about-non-system-lock-icon',
-                'target'     => '.questions .ee-alternate-color',
-                'content'    => esc_html__(
-                    'This question has answers attached to it from registrations that have the question.  It cannot be permanently deleted.',
-                    'event_espresso'
-                ),
-                'options'    => array(),
-            ),
-            2 => array(
-                'content_id' => 'about-question-group-lock-icon',
-                'target'     => '.questiongroups .ee-system-lock',
-                'content'    => esc_html__('This question group is a system group and cannot be trashed', 'event_espresso'),
-                'options'    => array(),
-            ),
-            3 => array(
-                'content_id' => 'about-non-system-qg-lock-icon',
-                'target'     => '.questiongroups .ee-alternate-color',
-                'content'    => esc_html__(
-                    'This question group has questions that have answers attached to it from registrations that have the question. It cannot be permanently deleted.',
-                    'event_espresso'
-                ),
-                'options'    => array(),
-            ),
-        );
-    }
+	protected function _set_tips_array()
+	{
+		$this->_qtipsa = array(
+			0 => array(
+				'content_id' => 'about-system-lock-icon',
+				'target'     => '.questions .ee-system-lock',
+				'content'    => esc_html__('This question is a system question and cannot be trashed', 'event_espresso'),
+				'options'    => array(), // defaults
+			),
+			1 => array(
+				'content_id' => 'about-non-system-lock-icon',
+				'target'     => '.questions .ee-alternate-color',
+				'content'    => esc_html__(
+					'This question has answers attached to it from registrations that have the question.  It cannot be permanently deleted.',
+					'event_espresso'
+				),
+				'options'    => array(),
+			),
+			2 => array(
+				'content_id' => 'about-question-group-lock-icon',
+				'target'     => '.questiongroups .ee-system-lock',
+				'content'    => esc_html__('This question group is a system group and cannot be trashed', 'event_espresso'),
+				'options'    => array(),
+			),
+			3 => array(
+				'content_id' => 'about-non-system-qg-lock-icon',
+				'target'     => '.questiongroups .ee-alternate-color',
+				'content'    => esc_html__(
+					'This question group has questions that have answers attached to it from registrations that have the question. It cannot be permanently deleted.',
+					'event_espresso'
+				),
+				'options'    => array(),
+			),
+		);
+	}
 }

admin_pages/transactions/qtips/Transactions_List_Table_Tips.lib.php

Indentation +61 added lines, -61 removed lines

@@ -13,69 +13,69 @@
  */
 class Transactions_List_Table_Tips extends EE_Qtip_Config
 {
-    protected function _set_tips_array()
-    {
-        $this->_qtipsa = array(
-            // 0 => array(
-            //     'content_id' => 'transaction-status-' . EEM_Transaction::overpaid_status_code,
-            //     'target'     => '.txn-status-' . EEM_Transaction::overpaid_status_code,
-            //     'content'    => $this->_transaction_status_legend(EEM_Transaction::overpaid_status_code),
-            //     'options'    => array(
-            //         'position' => array(
-            //             'target' => 'mouse',
-            //         ),
-            //     ),
-            // ),
-            // 1 => array(
-            //     'content_id' => 'transaction-status-' . EEM_Transaction::complete_status_code,
-            //     'target'     => '.txn-status-' . EEM_Transaction::complete_status_code,
-            //     'content'    => $this->_transaction_status_legend(EEM_Transaction::complete_status_code),
-            //     'options'    => array(
-            //         'position' => array(
-            //             'target' => 'mouse',
-            //         ),
-            //     ),
-            // ),
-            // 2 => array(
-            //     'content_id' => 'transaction-status-' . EEM_Transaction::incomplete_status_code,
-            //     'target'     => '.txn-status-' . EEM_Transaction::incomplete_status_code,
-            //     'content'    => $this->_transaction_status_legend(EEM_Transaction::incomplete_status_code),
-            //     'options'    => array(
-            //         'position' => array(
-            //             'target' => 'mouse',
-            //         ),
-            //     ),
-            // ),
-            // 3 => array(
-            //     'content_id' => 'transaction-status-' . EEM_Transaction::failed_status_code,
-            //     'target'     => '.txn-status-' . EEM_Transaction::failed_status_code,
-            //     'content'    => $this->_transaction_status_legend(EEM_Transaction::failed_status_code),
-            //     'options'    => array(
-            //         'position' => array(
-            //             'target' => 'mouse',
-            //         ),
-            //     ),
-            // )
-        );
-    }
+	protected function _set_tips_array()
+	{
+		$this->_qtipsa = array(
+			// 0 => array(
+			//     'content_id' => 'transaction-status-' . EEM_Transaction::overpaid_status_code,
+			//     'target'     => '.txn-status-' . EEM_Transaction::overpaid_status_code,
+			//     'content'    => $this->_transaction_status_legend(EEM_Transaction::overpaid_status_code),
+			//     'options'    => array(
+			//         'position' => array(
+			//             'target' => 'mouse',
+			//         ),
+			//     ),
+			// ),
+			// 1 => array(
+			//     'content_id' => 'transaction-status-' . EEM_Transaction::complete_status_code,
+			//     'target'     => '.txn-status-' . EEM_Transaction::complete_status_code,
+			//     'content'    => $this->_transaction_status_legend(EEM_Transaction::complete_status_code),
+			//     'options'    => array(
+			//         'position' => array(
+			//             'target' => 'mouse',
+			//         ),
+			//     ),
+			// ),
+			// 2 => array(
+			//     'content_id' => 'transaction-status-' . EEM_Transaction::incomplete_status_code,
+			//     'target'     => '.txn-status-' . EEM_Transaction::incomplete_status_code,
+			//     'content'    => $this->_transaction_status_legend(EEM_Transaction::incomplete_status_code),
+			//     'options'    => array(
+			//         'position' => array(
+			//             'target' => 'mouse',
+			//         ),
+			//     ),
+			// ),
+			// 3 => array(
+			//     'content_id' => 'transaction-status-' . EEM_Transaction::failed_status_code,
+			//     'target'     => '.txn-status-' . EEM_Transaction::failed_status_code,
+			//     'content'    => $this->_transaction_status_legend(EEM_Transaction::failed_status_code),
+			//     'options'    => array(
+			//         'position' => array(
+			//             'target' => 'mouse',
+			//         ),
+			//     ),
+			// )
+		);
+	}
 
 
-    /**
-     * output the relevant ee-status-legend with the designated status highlighted.
-     *
-     * @param  EEM_Transaction constant $status What status is set (by class)
-     * @return string         The status legend with the related status highlighted
-     */
-    private function _transaction_status_legend($status)
-    {
+	/**
+	 * output the relevant ee-status-legend with the designated status highlighted.
+	 *
+	 * @param  EEM_Transaction constant $status What status is set (by class)
+	 * @return string         The status legend with the related status highlighted
+	 */
+	private function _transaction_status_legend($status)
+	{
 
-        $status_array = array(
-            'overpaid'   => EEM_Transaction::overpaid_status_code,
-            'complete'   => EEM_Transaction::complete_status_code,
-            'incomplete' => EEM_Transaction::incomplete_status_code,
-            'failed'     => EEM_Transaction::failed_status_code,
-        );
+		$status_array = array(
+			'overpaid'   => EEM_Transaction::overpaid_status_code,
+			'complete'   => EEM_Transaction::complete_status_code,
+			'incomplete' => EEM_Transaction::incomplete_status_code,
+			'failed'     => EEM_Transaction::failed_status_code,
+		);
 
-        return EEH_Template::status_legend($status_array, $status);
-    }
+		return EEH_Template::status_legend($status_array, $status);
+	}
 }

core/libraries/messages/defaults/EE_Messages_Template_Defaults.lib.php

Spacing +5 added lines, -5 removed lines

@@ -109,9 +109,9 @@ 
         // notice).  The class name should be something like 'EE_Messages_Template_Pack_Default' where "default' would be
         // the incoming template pack reference.
         $class_name =
-            'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
+            'EE_Messages_Template_Pack_'.str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
 
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -156,7 +156,7 @@ 
     {
         $template_pack = 'default';
         // if we have the GRP_ID then let's use that to see if there is a set template pack and use that for the new templates.
-        if (! empty($this->_GRP_ID)) {
+        if ( ! empty($this->_GRP_ID)) {
             $message_template_group = $this->_message_template_group_model->get_one_by_ID($this->_GRP_ID);
             $template_pack          = $message_template_group instanceof EE_Message_Template_Group
                 ? $message_template_group->get_template_pack_name()
@@ -207,10 +207,10 @@ 
                 if ($field != 'extra') {
                     $template_data['MTP_context']        = $context;
                     $template_data['MTP_template_field'] = $field;
-                    $template_data['MTP_content']        = $this->_templates[ $context ][ $field ];
+                    $template_data['MTP_content']        = $this->_templates[$context][$field];
 
                     $MTP = $this->_message_template_model->insert($template_data);
-                    if (! $MTP) {
+                    if ( ! $MTP) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(

Indentation +227 added lines, -227 removed lines

@@ -11,231 +11,231 @@
  */
 class EE_Messages_Template_Defaults extends EE_Base
 {
-    /**
-     * Used for holding the EE_Message_Template GRP_ID field value.
-     *
-     * @var [type]
-     */
-    protected $_GRP_ID;
-
-    /**
-     * holds the messenger object
-     *
-     * @var EE_messenger
-     */
-    protected $_messenger;
-
-    /**
-     * holds the message type object
-     *
-     * @var EE_message_type
-     */
-    protected $_message_type;
-
-    /**
-     * holds the fields used (this is retrieved from the messenger)
-     *
-     * @var array
-     */
-    protected $_fields;
-
-    /**
-     * holds the assembled template (with defaults) for creation in the database
-     *
-     * @var array
-     */
-    protected $_templates;
-
-    /**
-     * holds the contexts used (this is retrieved from the message type)
-     *
-     * @var array
-     */
-    protected $_contexts;
-
-
-    /**
-     * @var EEM_Message_Template_Group
-     */
-    protected $_message_template_group_model;
-
-
-    /**
-     * @var EEM_Message_Template
-     */
-    protected $_message_template_model;
-
-
-    /**
-     * EE_Messages_Template_Defaults constructor.
-     *
-     * @param EE_messenger                    $messenger
-     * @param EE_message_type                 $message_type
-     * @param int|null                        $GRP_ID                 Optional.  If included then we're just
-     *                                                                regenerating the template fields for the given
-     *                                                                group not the message template group itself
-     * @param EEM_Message_Template_Group|null $message_template_group_model
-     * @param EEM_Message_Template|null       $message_template_model
-     * @throws EE_Error
-     */
-    public function __construct(
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        ?int $GRP_ID,
-        ?EEM_Message_Template_Group $message_template_group_model,
-        ?EEM_Message_Template $message_template_model
-    ) {
-        $this->_messenger    = $messenger;
-        $this->_message_type = $message_type;
-        $this->_GRP_ID       = $GRP_ID ?? 0;
-        // set the model object
-        $this->_message_template_group_model = $message_template_group_model ?? EEM_Message_Template_Group::instance();
-        $this->_message_template_model       = $message_template_model ?? EEM_Message_Template::instance();
-        $this->_fields                       = $this->_messenger->get_template_fields();
-        $this->_contexts                     = $this->_message_type->get_contexts();
-    }
-
-
-    /**
-     * Setup the _template_data property.
-     * This method sets the _templates property array before templates are created.
-     *
-     * @param string $template_pack This corresponds to a template pack class reference which will contain information
-     *                              about where to obtain the templates.
-     *
-     */
-    private function _set_templates(string $template_pack)
-    {
-        // get the corresponding template pack object (if present.  If not then we just load the default and add a
-        // notice).  The class name should be something like 'EE_Messages_Template_Pack_Default' where "default' would be
-        // the incoming template pack reference.
-        $class_name =
-            'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
-
-        if (! class_exists($class_name)) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The template pack represented by a class corresponding to "%1$s" does not exist. Likely the autoloader for this class has the wrong path or the incoming reference is misspelled. The default template pack has been used to generate the templates instead.',
-                        'event_espresso'
-                    ),
-                    $class_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $class_name = 'EE_Messages_Template_Pack_Default';
-        }
-        /** @type EE_Messages_Template_Pack $template_pack */
-        $template_pack = new $class_name();
-
-        // get all the templates from the template pack.
-        $this->_templates = $template_pack->get_templates($this->_messenger, $this->_message_type);
-    }
-
-
-    /**
-     * Return the contexts for the message type as cached on this instance.
-     *
-     * @return array
-     */
-    public function get_contexts(): array
-    {
-        return $this->_contexts;
-    }
-
-
-    /**
-     * public facing create new templates method
-     *
-     * @return array|false|int|string success array or false.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_new_templates()
-    {
-        $template_pack = 'default';
-        // if we have the GRP_ID then let's use that to see if there is a set template pack and use that for the new templates.
-        if (! empty($this->_GRP_ID)) {
-            $message_template_group = $this->_message_template_group_model->get_one_by_ID($this->_GRP_ID);
-            $template_pack          = $message_template_group instanceof EE_Message_Template_Group
-                ? $message_template_group->get_template_pack_name()
-                : 'default';
-            // we also need to reset the template variation to default
-            $message_template_group->set_template_pack_variation('default');
-        }
-        return $this->_create_new_templates($template_pack);
-    }
-
-
-    /**
-     *  Handles creating new default templates.
-     *
-     * @param string $template_pack This corresponds to a template pack class reference
-     *                              which will contain information about where to obtain the templates.
-     * @return array|bool            success array or false.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _create_new_templates(string $template_pack)
-    {
-        $this->_set_templates($template_pack);
-
-        // necessary properties are set, let's save the default templates
-        if (empty($this->_GRP_ID)) {
-            $main_template_data = [
-                'MTP_messenger'    => $this->_messenger->name,
-                'MTP_message_type' => $this->_message_type->name,
-                'MTP_is_override'  => 0,
-                'MTP_deleted'      => 0,
-                'MTP_is_global'    => 1,
-                'MTP_user_id'      => EEH_Activation::get_default_creator_id(),
-                'MTP_is_active'    => 1,
-            ];
-            // let's insert the above and get our GRP_ID, then reset the template data array to just include the GRP_ID
-            $grp_id = $this->_message_template_group_model->insert($main_template_data);
-            if (empty($grp_id)) {
-                return $grp_id;
-            }
-            $this->_GRP_ID = $grp_id;
-        }
-
-        $template_data = ['GRP_ID' => $this->_GRP_ID];
-
-        foreach ($this->_contexts as $context => $details) {
-            foreach ($this->_fields as $field => $field_type) {
-                if ($field != 'extra') {
-                    $template_data['MTP_context']        = $context;
-                    $template_data['MTP_template_field'] = $field;
-                    $template_data['MTP_content']        = $this->_templates[ $context ][ $field ];
-
-                    $MTP = $this->_message_template_model->insert($template_data);
-                    if (! $MTP) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'There was an error in saving new template data for %1$s messenger, %2$s message type, %3$s context and %4$s template field.',
-                                    'event_espresso'
-                                ),
-                                $this->_messenger->name,
-                                $this->_message_type->name,
-                                $context,
-                                $field
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                }
-            }
-        }
-
-        return [
-            'GRP_ID'      => $this->_GRP_ID,
-            'MTP_context' => key($this->_contexts),
-        ];
-    }
+	/**
+	 * Used for holding the EE_Message_Template GRP_ID field value.
+	 *
+	 * @var [type]
+	 */
+	protected $_GRP_ID;
+
+	/**
+	 * holds the messenger object
+	 *
+	 * @var EE_messenger
+	 */
+	protected $_messenger;
+
+	/**
+	 * holds the message type object
+	 *
+	 * @var EE_message_type
+	 */
+	protected $_message_type;
+
+	/**
+	 * holds the fields used (this is retrieved from the messenger)
+	 *
+	 * @var array
+	 */
+	protected $_fields;
+
+	/**
+	 * holds the assembled template (with defaults) for creation in the database
+	 *
+	 * @var array
+	 */
+	protected $_templates;
+
+	/**
+	 * holds the contexts used (this is retrieved from the message type)
+	 *
+	 * @var array
+	 */
+	protected $_contexts;
+
+
+	/**
+	 * @var EEM_Message_Template_Group
+	 */
+	protected $_message_template_group_model;
+
+
+	/**
+	 * @var EEM_Message_Template
+	 */
+	protected $_message_template_model;
+
+
+	/**
+	 * EE_Messages_Template_Defaults constructor.
+	 *
+	 * @param EE_messenger                    $messenger
+	 * @param EE_message_type                 $message_type
+	 * @param int|null                        $GRP_ID                 Optional.  If included then we're just
+	 *                                                                regenerating the template fields for the given
+	 *                                                                group not the message template group itself
+	 * @param EEM_Message_Template_Group|null $message_template_group_model
+	 * @param EEM_Message_Template|null       $message_template_model
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		?int $GRP_ID,
+		?EEM_Message_Template_Group $message_template_group_model,
+		?EEM_Message_Template $message_template_model
+	) {
+		$this->_messenger    = $messenger;
+		$this->_message_type = $message_type;
+		$this->_GRP_ID       = $GRP_ID ?? 0;
+		// set the model object
+		$this->_message_template_group_model = $message_template_group_model ?? EEM_Message_Template_Group::instance();
+		$this->_message_template_model       = $message_template_model ?? EEM_Message_Template::instance();
+		$this->_fields                       = $this->_messenger->get_template_fields();
+		$this->_contexts                     = $this->_message_type->get_contexts();
+	}
+
+
+	/**
+	 * Setup the _template_data property.
+	 * This method sets the _templates property array before templates are created.
+	 *
+	 * @param string $template_pack This corresponds to a template pack class reference which will contain information
+	 *                              about where to obtain the templates.
+	 *
+	 */
+	private function _set_templates(string $template_pack)
+	{
+		// get the corresponding template pack object (if present.  If not then we just load the default and add a
+		// notice).  The class name should be something like 'EE_Messages_Template_Pack_Default' where "default' would be
+		// the incoming template pack reference.
+		$class_name =
+			'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $template_pack)));
+
+		if (! class_exists($class_name)) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The template pack represented by a class corresponding to "%1$s" does not exist. Likely the autoloader for this class has the wrong path or the incoming reference is misspelled. The default template pack has been used to generate the templates instead.',
+						'event_espresso'
+					),
+					$class_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$class_name = 'EE_Messages_Template_Pack_Default';
+		}
+		/** @type EE_Messages_Template_Pack $template_pack */
+		$template_pack = new $class_name();
+
+		// get all the templates from the template pack.
+		$this->_templates = $template_pack->get_templates($this->_messenger, $this->_message_type);
+	}
+
+
+	/**
+	 * Return the contexts for the message type as cached on this instance.
+	 *
+	 * @return array
+	 */
+	public function get_contexts(): array
+	{
+		return $this->_contexts;
+	}
+
+
+	/**
+	 * public facing create new templates method
+	 *
+	 * @return array|false|int|string success array or false.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_new_templates()
+	{
+		$template_pack = 'default';
+		// if we have the GRP_ID then let's use that to see if there is a set template pack and use that for the new templates.
+		if (! empty($this->_GRP_ID)) {
+			$message_template_group = $this->_message_template_group_model->get_one_by_ID($this->_GRP_ID);
+			$template_pack          = $message_template_group instanceof EE_Message_Template_Group
+				? $message_template_group->get_template_pack_name()
+				: 'default';
+			// we also need to reset the template variation to default
+			$message_template_group->set_template_pack_variation('default');
+		}
+		return $this->_create_new_templates($template_pack);
+	}
+
+
+	/**
+	 *  Handles creating new default templates.
+	 *
+	 * @param string $template_pack This corresponds to a template pack class reference
+	 *                              which will contain information about where to obtain the templates.
+	 * @return array|bool            success array or false.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _create_new_templates(string $template_pack)
+	{
+		$this->_set_templates($template_pack);
+
+		// necessary properties are set, let's save the default templates
+		if (empty($this->_GRP_ID)) {
+			$main_template_data = [
+				'MTP_messenger'    => $this->_messenger->name,
+				'MTP_message_type' => $this->_message_type->name,
+				'MTP_is_override'  => 0,
+				'MTP_deleted'      => 0,
+				'MTP_is_global'    => 1,
+				'MTP_user_id'      => EEH_Activation::get_default_creator_id(),
+				'MTP_is_active'    => 1,
+			];
+			// let's insert the above and get our GRP_ID, then reset the template data array to just include the GRP_ID
+			$grp_id = $this->_message_template_group_model->insert($main_template_data);
+			if (empty($grp_id)) {
+				return $grp_id;
+			}
+			$this->_GRP_ID = $grp_id;
+		}
+
+		$template_data = ['GRP_ID' => $this->_GRP_ID];
+
+		foreach ($this->_contexts as $context => $details) {
+			foreach ($this->_fields as $field => $field_type) {
+				if ($field != 'extra') {
+					$template_data['MTP_context']        = $context;
+					$template_data['MTP_template_field'] = $field;
+					$template_data['MTP_content']        = $this->_templates[ $context ][ $field ];
+
+					$MTP = $this->_message_template_model->insert($template_data);
+					if (! $MTP) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'There was an error in saving new template data for %1$s messenger, %2$s message type, %3$s context and %4$s template field.',
+									'event_espresso'
+								),
+								$this->_messenger->name,
+								$this->_message_type->name,
+								$context,
+								$field
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				}
+			}
+		}
+
+		return [
+			'GRP_ID'      => $this->_GRP_ID,
+			'MTP_context' => key($this->_contexts),
+		];
+	}
 }

core/libraries/messages/messenger/EE_Html_messenger.class.php

Spacing +4 added lines, -4 removed lines

@@ -40,7 +40,7 @@ 
             'This messenger outputs a message to a browser for display.',
             'event_espresso'
         );
-        $this->label               = [
+        $this->label = [
             'singular' => esc_html__('html', 'event_espresso'),
             'plural'   => esc_html__('html', 'event_espresso'),
         ];
@@ -312,7 +312,7 @@ 
                     ],
                     'ticket_line_item_no_pms'       => [
                         'input'               => 'textarea',
-                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
+                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>'.esc_html__(
                             'Ticket Line Item List with no Price Modifiers',
                             'event_espresso'
                         ),
@@ -326,7 +326,7 @@ 
                     ],
                     'ticket_line_item_pms'          => [
                         'input'               => 'textarea',
-                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
+                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>'.esc_html__(
                             'Ticket Line Item List with Price Modifiers',
                             'event_espresso'
                         ),
@@ -551,7 +551,7 @@ 
                 'aln-cntr',
                 '',
                 ['utm_content' => 'messages_system']
-            ) . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
+            ).EEH_HTML::div(EEH_HTML::p('&nbsp;'));
         }
         return $content;
     }

Indentation +546 added lines, -546 removed lines

@@ -12,550 +12,550 @@
  */
 class EE_Html_messenger extends EE_messenger
 {
-    /**
-     * The following are the properties that this messenger requires for displaying the html
-     */
-    /**
-     * This is the html body generated by the template via the message type.
-     *
-     * @var string
-     */
-    protected $_content = '';
-
-    /**
-     * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
-     * equivalent to the "subject" of the page.
-     *
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * EE_Html_messenger constructor.
-     */
-    public function __construct()
-    {
-        // set properties
-        $this->name                = 'html';
-        $this->description         = esc_html__(
-            'This messenger outputs a message to a browser for display.',
-            'event_espresso'
-        );
-        $this->label               = [
-            'singular' => esc_html__('html', 'event_espresso'),
-            'plural'   => esc_html__('html', 'event_espresso'),
-        ];
-        $this->activate_on_install = true;
-        // add the "powered by EE" credit link to the HTML receipt and invoice
-        add_filter(
-            'FHEE__EE_Html_messenger___send_message__main_body',
-            [$this, 'add_powered_by_credit_link_to_receipt_and_invoice'],
-            10,
-            3
-        );
-        parent::__construct();
-    }
-
-
-    /**
-     * HTML Messenger desires execution immediately.
-     *
-     * @return bool
-     * @since  4.9.0
-     * @see    parent::send_now() for documentation.
-     */
-    public function send_now(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * HTML Messenger allows an empty to field.
-     *
-     * @return bool
-     * @since  4.9.0
-     * @see    parent::allow_empty_to_field() for documentation
-     */
-    public function allow_empty_to_field(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = ['events_edit' => true];
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes = [];
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_validator_config()
-    {
-        $this->_validator_config = [
-            'subject'                       => [
-                'shortcodes' => ['organization', 'primary_registration_details', 'email', 'transaction'],
-            ],
-            'content'                       => [
-                'shortcodes' => [
-                    'organization',
-                    'primary_registration_list',
-                    'primary_registration_details',
-                    'email',
-                    'transaction',
-                    'event_list',
-                    'payment_list',
-                    'venue',
-                    'line_item_list',
-                    'messenger',
-                    'ticket_list',
-                ],
-            ],
-            'event_list'                    => [
-                'shortcodes' => [
-                    'event',
-                    'ticket_list',
-                    'venue',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                ],
-                'required'   => ['[EVENT_LIST]'],
-            ],
-            'ticket_list'                   => [
-                'shortcodes' => [
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'line_item_list',
-                    'venue',
-                ],
-                'required'   => ['[TICKET_LIST]'],
-            ],
-            'ticket_line_item_no_pms'       => [
-                'shortcodes' => ['line_item', 'ticket'],
-                'required'   => ['[TICKET_LINE_ITEM_LIST]'],
-            ],
-            'ticket_line_item_pms'          => [
-                'shortcodes' => ['line_item', 'ticket', 'line_item_list'],
-                'required'   => ['[TICKET_LINE_ITEM_LIST]'],
-            ],
-            'price_modifier_line_item_list' => [
-                'shortcodes' => ['line_item'],
-                'required'   => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
-            ],
-            'datetime_list'                 => [
-                'shortcodes' => ['datetime'],
-                'required'   => ['[DATETIME_LIST]'],
-            ],
-            'attendee_list'                 => [
-                'shortcodes' => ['attendee'],
-                'required'   => ['[ATTENDEE_LIST]'],
-            ],
-            'tax_line_item_list'            => [
-                'shortcodes' => ['line_item'],
-                'required'   => ['[TAX_LINE_ITEM_LIST]'],
-            ],
-            'additional_line_item_list'     => [
-                'shortcodes' => ['line_item'],
-                'required'   => ['[ADDITIONAL_LINE_ITEM_LIST]'],
-            ],
-            'payment_list'                  => [
-                'shortcodes' => ['payment'],
-                'required'   => ['[PAYMENT_LIST_*]'],
-            ],
-        ];
-    }
-
-
-    /**
-     * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
-     * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
-     * (i.e. swap out css files or something else).
-     *
-     * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
-     * @return void
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name === 'pdf') {
-            add_filter('EE_messenger__get_variation__variation', [$this, 'add_html_css'], 10, 8);
-        }
-    }
-
-
-    /**
-     * @param                            $variation_path
-     * @param EE_Messages_Template_Pack  $template_pack
-     * @param                            $messenger_name
-     * @param                            $message_type_name
-     * @param                            $url
-     * @param                            $type
-     * @param                            $variation
-     * @param                            $skip_filters
-     * @return string
-     */
-    public function add_html_css(
-        $variation_path,
-        EE_Messages_Template_Pack $template_pack,
-        $messenger_name,
-        $message_type_name,
-        $url,
-        $type,
-        $variation,
-        $skip_filters
-    ): string {
-        return $template_pack->get_variation(
-            $this->name,
-            $message_type_name,
-            $type,
-            $variation,
-            $url,
-            '.css',
-            $skip_filters
-        );
-    }
-
-
-    /**
-     * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
-     * messenger can add their own js.
-     *
-     * @return void.
-     */
-    public function enqueue_scripts_styles()
-    {
-        parent::enqueue_scripts_styles();
-        do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger
-        // but will get used by a messenger field for shortcode replacement
-        // get added to the 'extra' key in an associated array
-        // indexed by the messenger field they relate to.
-        // This is important for the Messages_admin to know what fields to display to the user.
-        // Also, notice that the "values" are equal to the field type
-        // that messages admin will use to know what kind of field to display.
-        // The values ALSO have one index labeled "shortcode".
-        // The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
-        // is required in order for this extra field to be displayed.
-        //  If the required shortcode isn't part of the shortcodes array
-        // then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = [
-            'subject' => [
-                'input'      => 'text',
-                'label'      => esc_html__('Page Title', 'event_espresso'),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ],
-            'content' => '',
-            // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => [
-                'content' => [
-                    'main'                          => [
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => false,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ],
-                    'event_list'                    => [
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => ['[EVENT_LIST]'],
-                    ],
-                    'ticket_list'                   => [
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => ['[TICKET_LIST]'],
-                    ],
-                    'ticket_line_item_no_pms'       => [
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
-                            'Ticket Line Item List with no Price Modifiers',
-                            'event_espresso'
-                        ),
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
-                    ],
-                    'ticket_line_item_pms'          => [
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
-                            'Ticket Line Item List with Price Modifiers',
-                            'event_espresso'
-                        ),
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
-                    ],
-                    'price_modifier_line_item_list' => [
-                        'input'               => 'textarea',
-                        'label'               => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
-                    ],
-                    'datetime_list'                 => [
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[DATETIME_LIST]'],
-                    ],
-                    'attendee_list'                 => [
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[ATTENDEE_LIST]'],
-                    ],
-                    'tax_line_item_list'            => [
-                        'input'               => 'textarea',
-                        'label'               => '[TAX_LINE_ITEM_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[TAX_LINE_ITEM_LIST]'],
-                    ],
-                    'additional_line_item_list'     => [
-                        'input'               => 'textarea',
-                        'label'               => '[ADDITIONAL_LINE_ITEM_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[ADDITIONAL_LINE_ITEM_LIST]'],
-                    ],
-                    'payment_list'                  => [
-                        'input'               => 'textarea',
-                        'label'               => '[PAYMENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => false,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => ['[PAYMENT_LIST_*]'],
-                    ],
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = ['receipt', 'invoice'];
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = ['receipt', 'invoice'];
-    }
-
-
-    /**
-     * Displays the message in the browser.
-     *
-     * @return void.
-     * @since 4.5.0
-     */
-    protected function _send_message()
-    {
-        $this->_template_args = [
-            'page_title' => $this->_subject,
-            'base_css'   => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'base',
-                $this->_variation
-            ),
-            'print_css'  => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'print',
-                $this->_variation
-            ),
-            'main_css'   => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'main',
-                $this->_variation
-            ),
-            'main_body' => wpautop(
-                apply_filters(
-                    'FHEE__EE_Html_messenger___send_message__main_body',
-                    (string) $this->_content,
-                    (string) $this->_content,
-                    $this->_incoming_message_type
-                ),
-                false
-            ),
-        ];
-        $this->_deregister_wp_hooks();
-        add_action('wp_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
-        echo ($this->_get_main_template());
-        exit();
-    }
-
-
-    /**
-     * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
-     * interfere with our templates.  If users want to add any custom styles or scripts they must use the
-     * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
-     *
-     * @return void
-     * @since 4.5.0
-     */
-    protected function _deregister_wp_hooks()
-    {
-        remove_all_actions('wp_head');
-        remove_all_actions('wp_footer');
-        remove_all_actions('wp_print_footer_scripts');
-        remove_all_actions('wp_enqueue_scripts');
-        global $wp_scripts, $wp_styles;
-        $wp_scripts = $wp_styles = [];
-        // just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
-        add_action('wp_footer', 'wp_print_footer_scripts');
-        add_action('wp_print_footer_scripts', '_wp_footer_scripts');
-        add_action('wp_head', 'wp_enqueue_scripts');
-    }
-
-
-    /**
-     * Overwrite parent _get_main_template for display_html purposes.
-     *
-     * @param bool $preview
-     * @return string
-     * @since  4.5.0
-     */
-    protected function _get_main_template($preview = false): string
-    {
-        $wrapper_template = $this->_tmp_pack->get_wrapper($this->name);
-        // include message type as a template arg
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _preview()
-    {
-        $this->_send_message();
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-
-    /**
-     * add the "powered by EE" credit link to the HTML receipt and invoice
-     *
-     * @param string|null     $content
-     * @param string|null     $content_again
-     * @param EE_message_type $incoming_message_type
-     * @return string
-     */
-    public function add_powered_by_credit_link_to_receipt_and_invoice(
-        ?string $content,
-        ?string $content_again,
-        EE_message_type $incoming_message_type
-    ): string {
-        if (
-            ($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
-            && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
-        ) {
-            $content .= EEH_Template::powered_by_event_espresso(
-                'aln-cntr',
-                '',
-                ['utm_content' => 'messages_system']
-            ) . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
-        }
-        return $content;
-    }
+	/**
+	 * The following are the properties that this messenger requires for displaying the html
+	 */
+	/**
+	 * This is the html body generated by the template via the message type.
+	 *
+	 * @var string
+	 */
+	protected $_content = '';
+
+	/**
+	 * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
+	 * equivalent to the "subject" of the page.
+	 *
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * EE_Html_messenger constructor.
+	 */
+	public function __construct()
+	{
+		// set properties
+		$this->name                = 'html';
+		$this->description         = esc_html__(
+			'This messenger outputs a message to a browser for display.',
+			'event_espresso'
+		);
+		$this->label               = [
+			'singular' => esc_html__('html', 'event_espresso'),
+			'plural'   => esc_html__('html', 'event_espresso'),
+		];
+		$this->activate_on_install = true;
+		// add the "powered by EE" credit link to the HTML receipt and invoice
+		add_filter(
+			'FHEE__EE_Html_messenger___send_message__main_body',
+			[$this, 'add_powered_by_credit_link_to_receipt_and_invoice'],
+			10,
+			3
+		);
+		parent::__construct();
+	}
+
+
+	/**
+	 * HTML Messenger desires execution immediately.
+	 *
+	 * @return bool
+	 * @since  4.9.0
+	 * @see    parent::send_now() for documentation.
+	 */
+	public function send_now(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * HTML Messenger allows an empty to field.
+	 *
+	 * @return bool
+	 * @since  4.9.0
+	 * @see    parent::allow_empty_to_field() for documentation
+	 */
+	public function allow_empty_to_field(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = ['events_edit' => true];
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes = [];
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_validator_config()
+	{
+		$this->_validator_config = [
+			'subject'                       => [
+				'shortcodes' => ['organization', 'primary_registration_details', 'email', 'transaction'],
+			],
+			'content'                       => [
+				'shortcodes' => [
+					'organization',
+					'primary_registration_list',
+					'primary_registration_details',
+					'email',
+					'transaction',
+					'event_list',
+					'payment_list',
+					'venue',
+					'line_item_list',
+					'messenger',
+					'ticket_list',
+				],
+			],
+			'event_list'                    => [
+				'shortcodes' => [
+					'event',
+					'ticket_list',
+					'venue',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+				],
+				'required'   => ['[EVENT_LIST]'],
+			],
+			'ticket_list'                   => [
+				'shortcodes' => [
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'line_item_list',
+					'venue',
+				],
+				'required'   => ['[TICKET_LIST]'],
+			],
+			'ticket_line_item_no_pms'       => [
+				'shortcodes' => ['line_item', 'ticket'],
+				'required'   => ['[TICKET_LINE_ITEM_LIST]'],
+			],
+			'ticket_line_item_pms'          => [
+				'shortcodes' => ['line_item', 'ticket', 'line_item_list'],
+				'required'   => ['[TICKET_LINE_ITEM_LIST]'],
+			],
+			'price_modifier_line_item_list' => [
+				'shortcodes' => ['line_item'],
+				'required'   => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
+			],
+			'datetime_list'                 => [
+				'shortcodes' => ['datetime'],
+				'required'   => ['[DATETIME_LIST]'],
+			],
+			'attendee_list'                 => [
+				'shortcodes' => ['attendee'],
+				'required'   => ['[ATTENDEE_LIST]'],
+			],
+			'tax_line_item_list'            => [
+				'shortcodes' => ['line_item'],
+				'required'   => ['[TAX_LINE_ITEM_LIST]'],
+			],
+			'additional_line_item_list'     => [
+				'shortcodes' => ['line_item'],
+				'required'   => ['[ADDITIONAL_LINE_ITEM_LIST]'],
+			],
+			'payment_list'                  => [
+				'shortcodes' => ['payment'],
+				'required'   => ['[PAYMENT_LIST_*]'],
+			],
+		];
+	}
+
+
+	/**
+	 * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
+	 * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
+	 * (i.e. swap out css files or something else).
+	 *
+	 * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
+	 * @return void
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name === 'pdf') {
+			add_filter('EE_messenger__get_variation__variation', [$this, 'add_html_css'], 10, 8);
+		}
+	}
+
+
+	/**
+	 * @param                            $variation_path
+	 * @param EE_Messages_Template_Pack  $template_pack
+	 * @param                            $messenger_name
+	 * @param                            $message_type_name
+	 * @param                            $url
+	 * @param                            $type
+	 * @param                            $variation
+	 * @param                            $skip_filters
+	 * @return string
+	 */
+	public function add_html_css(
+		$variation_path,
+		EE_Messages_Template_Pack $template_pack,
+		$messenger_name,
+		$message_type_name,
+		$url,
+		$type,
+		$variation,
+		$skip_filters
+	): string {
+		return $template_pack->get_variation(
+			$this->name,
+			$message_type_name,
+			$type,
+			$variation,
+			$url,
+			'.css',
+			$skip_filters
+		);
+	}
+
+
+	/**
+	 * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
+	 * messenger can add their own js.
+	 *
+	 * @return void.
+	 */
+	public function enqueue_scripts_styles()
+	{
+		parent::enqueue_scripts_styles();
+		do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger
+		// but will get used by a messenger field for shortcode replacement
+		// get added to the 'extra' key in an associated array
+		// indexed by the messenger field they relate to.
+		// This is important for the Messages_admin to know what fields to display to the user.
+		// Also, notice that the "values" are equal to the field type
+		// that messages admin will use to know what kind of field to display.
+		// The values ALSO have one index labeled "shortcode".
+		// The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
+		// is required in order for this extra field to be displayed.
+		//  If the required shortcode isn't part of the shortcodes array
+		// then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = [
+			'subject' => [
+				'input'      => 'text',
+				'label'      => esc_html__('Page Title', 'event_espresso'),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			],
+			'content' => '',
+			// left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => [
+				'content' => [
+					'main'                          => [
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => false,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					],
+					'event_list'                    => [
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => ['[EVENT_LIST]'],
+					],
+					'ticket_list'                   => [
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => ['[TICKET_LIST]'],
+					],
+					'ticket_line_item_no_pms'       => [
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
+							'Ticket Line Item List with no Price Modifiers',
+							'event_espresso'
+						),
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
+					],
+					'ticket_line_item_pms'          => [
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LINE_ITEM_LIST] <br>' . esc_html__(
+							'Ticket Line Item List with Price Modifiers',
+							'event_espresso'
+						),
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[TICKET_LINE_ITEM_LIST]'],
+					],
+					'price_modifier_line_item_list' => [
+						'input'               => 'textarea',
+						'label'               => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[PRICE_MODIFIER_LINE_ITEM_LIST]'],
+					],
+					'datetime_list'                 => [
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[DATETIME_LIST]'],
+					],
+					'attendee_list'                 => [
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[ATTENDEE_LIST]'],
+					],
+					'tax_line_item_list'            => [
+						'input'               => 'textarea',
+						'label'               => '[TAX_LINE_ITEM_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[TAX_LINE_ITEM_LIST]'],
+					],
+					'additional_line_item_list'     => [
+						'input'               => 'textarea',
+						'label'               => '[ADDITIONAL_LINE_ITEM_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[ADDITIONAL_LINE_ITEM_LIST]'],
+					],
+					'payment_list'                  => [
+						'input'               => 'textarea',
+						'label'               => '[PAYMENT_LIST]',
+						'type'                => 'string',
+						'required'            => false,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => ['[PAYMENT_LIST_*]'],
+					],
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = ['receipt', 'invoice'];
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = ['receipt', 'invoice'];
+	}
+
+
+	/**
+	 * Displays the message in the browser.
+	 *
+	 * @return void.
+	 * @since 4.5.0
+	 */
+	protected function _send_message()
+	{
+		$this->_template_args = [
+			'page_title' => $this->_subject,
+			'base_css'   => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'base',
+				$this->_variation
+			),
+			'print_css'  => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'print',
+				$this->_variation
+			),
+			'main_css'   => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'main',
+				$this->_variation
+			),
+			'main_body' => wpautop(
+				apply_filters(
+					'FHEE__EE_Html_messenger___send_message__main_body',
+					(string) $this->_content,
+					(string) $this->_content,
+					$this->_incoming_message_type
+				),
+				false
+			),
+		];
+		$this->_deregister_wp_hooks();
+		add_action('wp_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
+		echo ($this->_get_main_template());
+		exit();
+	}
+
+
+	/**
+	 * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
+	 * interfere with our templates.  If users want to add any custom styles or scripts they must use the
+	 * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 */
+	protected function _deregister_wp_hooks()
+	{
+		remove_all_actions('wp_head');
+		remove_all_actions('wp_footer');
+		remove_all_actions('wp_print_footer_scripts');
+		remove_all_actions('wp_enqueue_scripts');
+		global $wp_scripts, $wp_styles;
+		$wp_scripts = $wp_styles = [];
+		// just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
+		add_action('wp_head', 'wp_enqueue_scripts');
+	}
+
+
+	/**
+	 * Overwrite parent _get_main_template for display_html purposes.
+	 *
+	 * @param bool $preview
+	 * @return string
+	 * @since  4.5.0
+	 */
+	protected function _get_main_template($preview = false): string
+	{
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name);
+		// include message type as a template arg
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _preview()
+	{
+		$this->_send_message();
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+
+	/**
+	 * add the "powered by EE" credit link to the HTML receipt and invoice
+	 *
+	 * @param string|null     $content
+	 * @param string|null     $content_again
+	 * @param EE_message_type $incoming_message_type
+	 * @return string
+	 */
+	public function add_powered_by_credit_link_to_receipt_and_invoice(
+		?string $content,
+		?string $content_again,
+		EE_message_type $incoming_message_type
+	): string {
+		if (
+			($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
+			&& apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
+		) {
+			$content .= EEH_Template::powered_by_event_espresso(
+				'aln-cntr',
+				'',
+				['utm_content' => 'messages_system']
+			) . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
+		}
+		return $content;
+	}
 }

core/interfaces/EEI_Collection.interface.php

Indentation +39 added lines, -39 removed lines

@@ -13,55 +13,55 @@
  */
 interface EEI_Collection
 {
-    /**
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EEI_Collection::set_info()
-     *
-     * @param object $object
-     * @param array|int|string $info
-     * @return bool
-     */
-    public function add($object, $info = ''): bool;
+	/**
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EEI_Collection::set_info()
+	 *
+	 * @param object $object
+	 * @param array|int|string $info
+	 * @return bool
+	 */
+	public function add($object, $info = ''): bool;
 
 
 
-    /**
-     * Sets the info associated with an object in the Collection
-     *
-     * @param object           $object
-     * @param array|int|string $info
-     * @return bool
-     */
-    public function set_info($object, $info = ''): bool;
+	/**
+	 * Sets the info associated with an object in the Collection
+	 *
+	 * @param object           $object
+	 * @param array|int|string $info
+	 * @return bool
+	 */
+	public function set_info($object, $info = ''): bool;
 
 
 
-    /**
-     * finds and returns an object in the Collection based on the info that was set using set_info() or add()
-     *
-     * @param array|int|string $info
-     * @return null | object
-     */
-    public function get_by_info($info = '');
+	/**
+	 * finds and returns an object in the Collection based on the info that was set using set_info() or add()
+	 *
+	 * @param array|int|string $info
+	 * @return null | object
+	 */
+	public function get_by_info($info = '');
 
 
 
-    /**
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @param object $object
-     * @return bool
-     */
-    public function has($object): bool;
+	/**
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @param object $object
+	 * @return bool
+	 */
+	public function has($object): bool;
 
 
 
-    /**
-     * detaches an object from the Collection
-     *
-     * @param $object
-     * @return void
-     */
-    public function remove($object);
+	/**
+	 * detaches an object from the Collection
+	 *
+	 * @param $object
+	 * @return void
+	 */
+	public function remove($object);
 }

core/domain/entities/DbSafeDateTime.php

Spacing +3 added lines, -3 removed lines

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

Indentation +191 added lines, -191 removed lines

@@ -19,195 +19,195 @@
  */
 class DbSafeDateTime extends DateTime
 {
-    // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
-    /**
-     * @type string db_safe_timestamp_format
-     */
-    const db_safe_timestamp_format = 'Y-m-d H:i:s O e';
-
-    // phpcs:enable
-
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    /**
-     * DateTime object converted to a string that includes the date, time, UTC offset, and timezone identifier
-     *
-     * @type string $_datetime_string
-     */
-    protected $_datetime_string = '';
-
-    /**
-     * where to write the error log to
-     *
-     * @type string $_error_log_dir
-     */
-    protected $_error_log_dir = '';
-
-    // phpcs:enable
-
-
-    /**
-     * @param string $error_log_dir
-     */
-    public function setErrorLogDir(string $error_log_dir): void
-    {
-        // if the folder path is writable, then except the path + filename, else keep empty
-        $this->_error_log_dir = is_writable(str_replace(basename($error_log_dir), '', $error_log_dir))
-            ? $error_log_dir
-            : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString(): string
-    {
-        return $this->format(DbSafeDateTime::db_safe_timestamp_format);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function __sleep(): array
-    {
-        $this->_datetime_string = $this->format(DbSafeDateTime::db_safe_timestamp_format);
-        $date                   = DateTime::createFromFormat(
-            DbSafeDateTime::db_safe_timestamp_format,
-            $this->_datetime_string
-        );
-        if (! $date instanceof DateTime) {
-            try {
-                // we want a stack trace to determine where the malformed date came from, so...
-                throw new DomainException('');
-            } catch (DomainException $e) {
-                $stack_trace = $e->getTraceAsString();
-            }
-            $this->writeToErrorLog(
-                sprintf(
-                    esc_html__(
-                        'A valid DateTime could not be generated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s %2$s Stack Trace: %5$s',
-                        'event_espresso'
-                    ),
-                    $this->_datetime_string,
-                    '<br />',
-                    print_r(DateTime::getLastErrors(), true),
-                    PHP_VERSION,
-                    $stack_trace
-                )
-            );
-        }
-        return ['_datetime_string'];
-    }
-
-
-    /**
-     * if an empty or null value got saved to the db for a datetime,
-     * then some servers and/or PHP itself will incorrectly convert that date string
-     * resulting in "-0001-11-30" for the year-month-day.
-     * see the Notes section
-     *
-     * @link http://php.net/manual/en/datetime.formats.date.php
-     * We'll replace those with "0000-00-00" which will allow a valid DateTime object to be created,
-     * but still result in the internal date for that object being set to "-0001-11-30 10:00:00.000000".
-     * so we're no better off, but at least things won't go fatal on us.
-     * @throws Exception
-     */
-    public function __wakeup(): void
-    {
-        $date = self::createFromFormat(
-            DbSafeDateTime::db_safe_timestamp_format,
-            $this->_datetime_string
-        );
-        if (! $date instanceof DateTime) {
-            $this->writeToErrorLog(
-                sprintf(
-                    esc_html__(
-                        'A valid DateTime could not be recreated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s',
-                        'event_espresso'
-                    ),
-                    $this->_datetime_string,
-                    '<br />',
-                    print_r(DateTime::getLastErrors(), true),
-                    PHP_VERSION
-                )
-            );
-        } else {
-            $this->__construct(
-                $date->format(EE_Datetime_Field::mysql_timestamp_format),
-                new DateTimeZone($date->format('e'))
-            );
-        }
-    }
-
-
-    /**
-     * Normalizes incoming date string so that it is a bit more stable for use.
-     *
-     * @param string $date_string
-     * @return string
-     */
-    public static function normalizeInvalidDate(string $date_string): string
-    {
-        return str_replace(
-            ['-0001-11-29', '-0001-11-30', '0000-00-00'],
-            '0000-01-03',
-            $date_string
-        );
-    }
-
-
-    /**
-     * Creates a DbSafeDateTime from ye old DateTime
-     *
-     * @param DateTime $datetime
-     * @return DbSafeDateTime
-     * @throws Exception
-     */
-    public static function createFromDateTime(DateTime $datetime): DbSafeDateTime
-    {
-        return new DbSafeDateTime(
-            $datetime->format(EE_Datetime_Field::mysql_timestamp_format),
-            new DateTimeZone($datetime->format('e'))
-        );
-    }
-
-
-    /**
-     * Parse a string into a new DateTime object according to the specified format
-     *
-     * @param string            $format   Format accepted by date().
-     * @param string            $time     String representing the time.
-     * @param DateTimeZone|null $timezone A DateTimeZone object representing the desired time zone.
-     * @return DbSafeDateTime|boolean
-     * @throws Exception
-     * @link https://php.net/manual/en/datetime.createfromformat.php
-     */
-    #[\ReturnTypeWillChange]
-    public static function createFromFormat($format, $time, ?DateTimeZone $timezone = null)
-    {
-        $time = self::normalizeInvalidDate($time);
-        // Various php versions handle the third argument differently.  This conditional accounts for that.
-        $DateTime = $timezone instanceof DateTimeZone
-            ? parent::createFromFormat($format, $time, $timezone)
-            : parent::createFromFormat($format, $time);
-        return $DateTime instanceof DateTime
-            ? self::createFromDateTime($DateTime)
-            : $DateTime;
-    }
-
-
-    /**
-     * @param string $message
-     */
-    private function writeToErrorLog(string $message)
-    {
-        if (! empty($this->_error_log_dir)) {
-            /** @noinspection ForgottenDebugOutputInspection */
-            error_log($message, 3, $this->_error_log_dir);
-        } else {
-            /** @noinspection ForgottenDebugOutputInspection */
-            error_log($message);
-        }
-    }
+	// phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
+	/**
+	 * @type string db_safe_timestamp_format
+	 */
+	const db_safe_timestamp_format = 'Y-m-d H:i:s O e';
+
+	// phpcs:enable
+
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	/**
+	 * DateTime object converted to a string that includes the date, time, UTC offset, and timezone identifier
+	 *
+	 * @type string $_datetime_string
+	 */
+	protected $_datetime_string = '';
+
+	/**
+	 * where to write the error log to
+	 *
+	 * @type string $_error_log_dir
+	 */
+	protected $_error_log_dir = '';
+
+	// phpcs:enable
+
+
+	/**
+	 * @param string $error_log_dir
+	 */
+	public function setErrorLogDir(string $error_log_dir): void
+	{
+		// if the folder path is writable, then except the path + filename, else keep empty
+		$this->_error_log_dir = is_writable(str_replace(basename($error_log_dir), '', $error_log_dir))
+			? $error_log_dir
+			: '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString(): string
+	{
+		return $this->format(DbSafeDateTime::db_safe_timestamp_format);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function __sleep(): array
+	{
+		$this->_datetime_string = $this->format(DbSafeDateTime::db_safe_timestamp_format);
+		$date                   = DateTime::createFromFormat(
+			DbSafeDateTime::db_safe_timestamp_format,
+			$this->_datetime_string
+		);
+		if (! $date instanceof DateTime) {
+			try {
+				// we want a stack trace to determine where the malformed date came from, so...
+				throw new DomainException('');
+			} catch (DomainException $e) {
+				$stack_trace = $e->getTraceAsString();
+			}
+			$this->writeToErrorLog(
+				sprintf(
+					esc_html__(
+						'A valid DateTime could not be generated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s %2$s Stack Trace: %5$s',
+						'event_espresso'
+					),
+					$this->_datetime_string,
+					'<br />',
+					print_r(DateTime::getLastErrors(), true),
+					PHP_VERSION,
+					$stack_trace
+				)
+			);
+		}
+		return ['_datetime_string'];
+	}
+
+
+	/**
+	 * if an empty or null value got saved to the db for a datetime,
+	 * then some servers and/or PHP itself will incorrectly convert that date string
+	 * resulting in "-0001-11-30" for the year-month-day.
+	 * see the Notes section
+	 *
+	 * @link http://php.net/manual/en/datetime.formats.date.php
+	 * We'll replace those with "0000-00-00" which will allow a valid DateTime object to be created,
+	 * but still result in the internal date for that object being set to "-0001-11-30 10:00:00.000000".
+	 * so we're no better off, but at least things won't go fatal on us.
+	 * @throws Exception
+	 */
+	public function __wakeup(): void
+	{
+		$date = self::createFromFormat(
+			DbSafeDateTime::db_safe_timestamp_format,
+			$this->_datetime_string
+		);
+		if (! $date instanceof DateTime) {
+			$this->writeToErrorLog(
+				sprintf(
+					esc_html__(
+						'A valid DateTime could not be recreated from "%1$s" because the following errors occurred: %2$s %3$s %2$s PHP version: %4$s',
+						'event_espresso'
+					),
+					$this->_datetime_string,
+					'<br />',
+					print_r(DateTime::getLastErrors(), true),
+					PHP_VERSION
+				)
+			);
+		} else {
+			$this->__construct(
+				$date->format(EE_Datetime_Field::mysql_timestamp_format),
+				new DateTimeZone($date->format('e'))
+			);
+		}
+	}
+
+
+	/**
+	 * Normalizes incoming date string so that it is a bit more stable for use.
+	 *
+	 * @param string $date_string
+	 * @return string
+	 */
+	public static function normalizeInvalidDate(string $date_string): string
+	{
+		return str_replace(
+			['-0001-11-29', '-0001-11-30', '0000-00-00'],
+			'0000-01-03',
+			$date_string
+		);
+	}
+
+
+	/**
+	 * Creates a DbSafeDateTime from ye old DateTime
+	 *
+	 * @param DateTime $datetime
+	 * @return DbSafeDateTime
+	 * @throws Exception
+	 */
+	public static function createFromDateTime(DateTime $datetime): DbSafeDateTime
+	{
+		return new DbSafeDateTime(
+			$datetime->format(EE_Datetime_Field::mysql_timestamp_format),
+			new DateTimeZone($datetime->format('e'))
+		);
+	}
+
+
+	/**
+	 * Parse a string into a new DateTime object according to the specified format
+	 *
+	 * @param string            $format   Format accepted by date().
+	 * @param string            $time     String representing the time.
+	 * @param DateTimeZone|null $timezone A DateTimeZone object representing the desired time zone.
+	 * @return DbSafeDateTime|boolean
+	 * @throws Exception
+	 * @link https://php.net/manual/en/datetime.createfromformat.php
+	 */
+	#[\ReturnTypeWillChange]
+	public static function createFromFormat($format, $time, ?DateTimeZone $timezone = null)
+	{
+		$time = self::normalizeInvalidDate($time);
+		// Various php versions handle the third argument differently.  This conditional accounts for that.
+		$DateTime = $timezone instanceof DateTimeZone
+			? parent::createFromFormat($format, $time, $timezone)
+			: parent::createFromFormat($format, $time);
+		return $DateTime instanceof DateTime
+			? self::createFromDateTime($DateTime)
+			: $DateTime;
+	}
+
+
+	/**
+	 * @param string $message
+	 */
+	private function writeToErrorLog(string $message)
+	{
+		if (! empty($this->_error_log_dir)) {
+			/** @noinspection ForgottenDebugOutputInspection */
+			error_log($message, 3, $this->_error_log_dir);
+		} else {
+			/** @noinspection ForgottenDebugOutputInspection */
+			error_log($message);
+		}
+	}
 }

core/libraries/messages/EE_Message_Repository.lib.php

Indentation +239 added lines, -239 removed lines

@@ -10,243 +10,243 @@
  */
 class EE_Message_Repository extends EE_Base_Class_Repository
 {
-    /**
-     * EE_Message_Repository constructor
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_Message';
-        parent::__construct();
-    }
-
-
-    /**
-     * Add the EE_Message to the repository.
-     * This also ensures that the MSG_token is saves as a part of the info for retrieval.
-     *
-     * @param EE_Message $message
-     * @param mixed      $info Any included data is saved in the attached object info array indexed by 'data'
-     * @return bool
-     */
-    public function add($message, $info = ''): bool
-    {
-        // ensure $info is an array if not already
-        $info = (array) $info;
-        $attached = parent::add($message);
-        $data = $this->_init_data($info, $attached, $message);
-        if ($attached) {
-            $this->set_info($message, $data);
-        }
-        return $attached;
-    }
-
-
-    /**
-     * Initializes the data from the incoming info.
-     *
-     * @param array      $info     incoming data.
-     * @param bool       $attached Indicates whether the object was attached successfully.
-     * @param EE_Message $message
-     * @return array
-     */
-    protected function _init_data(array $info, bool $attached, EE_Message $message): array
-    {
-        $data = [
-            'test_send'               => false,
-            'preview'                 => false,
-            'data_handler_class_name' => '',
-            'data'                    => [
-                'MSG_generation_data' => [],
-            ],
-        ];
-        if (isset($info['preview'])) {
-            $data['preview'] = $info['preview'];
-            unset($info['preview']);
-        }
-        if (isset($info['test_send'])) {
-            $data['test_send'] = $info['test_send'];
-            unset($info['test_send']);
-        }
-        if (isset($info['data_handler_class_name'])) {
-            $data['data_handler_class_name'] = $info['data_handler_class_name'];
-            unset($info['data_handler_class_name']);
-        }
-        if ($attached && $message->STS_ID() === EEM_Message::status_incomplete) {
-            $generation_data = $info['MSG_generation_data'] ?? [];
-            // if data isn't in $info...let's see if its available via the message object
-            $generation_data = ! $generation_data ? $message->get_generation_data() : $generation_data;
-            // still empty then let's just use info
-            $generation_data                     = ! $generation_data ? $info : $generation_data;
-            $data['data']['MSG_generation_data'] = $generation_data;
-        }
-        return $data;
-    }
-
-
-    /**
-     * Save all EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only When true, only the hooks related to saving are fired.
-     * @return array [
-     *                  'updated'    => 0, // count of how many messages updated
-     *                  'notupdated' => 0, // count of how many messages not updated.
-     *                  'errors'     => array( $token ), // message object tokens that had errors in saving
- *                  ]
-     */
-    public function saveAll(bool $do_hooks_only = false): array
-    {
-        $save_tracking = ['updated' => 0, 'notupdated' => 0, 'errors' => []];
-
-        if (! $do_hooks_only) {
-            $this->rewind();
-            // exit early if there is nothing to save.
-            if ($this->count() < 1) {
-                return $save_tracking;
-            }
-
-            while ($this->valid()) {
-                $saved = $this->current()->save();
-                if ($saved === false) {
-                    $save_tracking['errors'][] = $this->current()->MSG_token();
-                } elseif ($saved) {
-                    $save_tracking['updated']++;
-                } else {
-                    $save_tracking['notupdated']++;
-                }
-                // maybe persist generation data if this is an incomplete EE_Message.
-                $this->_maybe_persist_attached_data();
-
-                $this->next();
-            }
-        }
-        do_action('AHEE__EE_Message_Repository__saveAll__after', $save_tracking, $this, $do_hooks_only);
-        return $save_tracking;
-    }
-
-
-    /**
-     * Retrieves a EE_Message from the repository that matches the given token.
-     *
-     * @param string $token Token.
-     * @return EE_Message | null
-     */
-    public function getMessageByToken(string $token): ?EE_Message
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->MSG_token() === $token) {
-                $message = $this->current();
-                $this->rewind();
-                return $message;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * This retrieves any data required for generation that may be saved with the current EE_Message in storage.
-     *
-     * @return array();
-     */
-    public function get_generation_data(): array
-    {
-        // first verify we're at a valid iterator point.
-        if (! $this->valid()) {
-            return [];
-        }
-        $info = $this->getInfo();
-        return $info['data']['MSG_generation_data'] ?? [];
-    }
-
-
-    /**
-     * Retrieves the data_handler_class_name or reference associated with the current EE_Message object in the iterator.
-     *
-     * @return string
-     */
-    public function get_data_handler(): string
-    {
-        if (! $this->valid()) {
-            return '';
-        }
-        $info = $this->getInfo();
-        return $info['data_handler_class_name'] ?? '';
-    }
-
-
-    /**
-     * Returns whether this EE_Message is for a preview or not.
-     *
-     * @return bool
-     */
-    public function is_preview(): bool
-    {
-        if (! $this->valid()) {
-            return false;
-        }
-        $info = $this->getInfo();
-        return filter_var($info['preview'] ?? false, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * Returns whether the current message pointed to is for a test send.
-     *
-     * @return bool
-     */
-    public function is_test_send(): bool
-    {
-        if (! $this->valid()) {
-            return false;
-        }
-        $info = $this->getInfo();
-        return filter_var($info['test_send'] ?? false, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     *  This checks if the current EE_Message in the iterator is incomplete. If it is, then
-     *  data is attached for later retrieval (batch generation).
-     */
-    protected function _maybe_persist_attached_data()
-    {
-        if (! $this->valid()) {
-            return;
-        }
-
-        $info                    = $this->getInfo();
-        $data_handler_class_name = $info['data_handler_class_name'] ?? '';
-        $data                    = $info['data']['MSG_generation_data'] ?? [];
-        if ($data && $this->current()->STS_ID() === EEM_Message::status_incomplete) {
-            $this->current()->set_generation_data($data);
-            $this->current()->set_field_or_extra_meta('data_handler_class_name', $data_handler_class_name);
-        }
-    }
-
-
-    /**
-     * This method returns a count of messages in the repository that have a given priority.
-     *
-     * @param int               $priority the priority that is being filtered for the count.
-     * @param array|string|null $status   the optional status(es) that will also be filtered by when priority matches.
-     * @return int  count of messages in the queue matching the conditions.
-     */
-    public function count_by_priority_and_status(int $priority, $status = []): int
-    {
-        $count  = 0;
-        $status = is_array($status) ? $status : [$status];
-        $this->rewind();
-        while ($this->valid()) {
-            if (
-                $this->current()->priority() === $priority
-                && (empty($status) || in_array($this->current()->STS_ID(), $status))
-            ) {
-                $count++;
-            }
-            $this->next();
-        }
-        return $count;
-    }
+	/**
+	 * EE_Message_Repository constructor
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_Message';
+		parent::__construct();
+	}
+
+
+	/**
+	 * Add the EE_Message to the repository.
+	 * This also ensures that the MSG_token is saves as a part of the info for retrieval.
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $info Any included data is saved in the attached object info array indexed by 'data'
+	 * @return bool
+	 */
+	public function add($message, $info = ''): bool
+	{
+		// ensure $info is an array if not already
+		$info = (array) $info;
+		$attached = parent::add($message);
+		$data = $this->_init_data($info, $attached, $message);
+		if ($attached) {
+			$this->set_info($message, $data);
+		}
+		return $attached;
+	}
+
+
+	/**
+	 * Initializes the data from the incoming info.
+	 *
+	 * @param array      $info     incoming data.
+	 * @param bool       $attached Indicates whether the object was attached successfully.
+	 * @param EE_Message $message
+	 * @return array
+	 */
+	protected function _init_data(array $info, bool $attached, EE_Message $message): array
+	{
+		$data = [
+			'test_send'               => false,
+			'preview'                 => false,
+			'data_handler_class_name' => '',
+			'data'                    => [
+				'MSG_generation_data' => [],
+			],
+		];
+		if (isset($info['preview'])) {
+			$data['preview'] = $info['preview'];
+			unset($info['preview']);
+		}
+		if (isset($info['test_send'])) {
+			$data['test_send'] = $info['test_send'];
+			unset($info['test_send']);
+		}
+		if (isset($info['data_handler_class_name'])) {
+			$data['data_handler_class_name'] = $info['data_handler_class_name'];
+			unset($info['data_handler_class_name']);
+		}
+		if ($attached && $message->STS_ID() === EEM_Message::status_incomplete) {
+			$generation_data = $info['MSG_generation_data'] ?? [];
+			// if data isn't in $info...let's see if its available via the message object
+			$generation_data = ! $generation_data ? $message->get_generation_data() : $generation_data;
+			// still empty then let's just use info
+			$generation_data                     = ! $generation_data ? $info : $generation_data;
+			$data['data']['MSG_generation_data'] = $generation_data;
+		}
+		return $data;
+	}
+
+
+	/**
+	 * Save all EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only When true, only the hooks related to saving are fired.
+	 * @return array [
+	 *                  'updated'    => 0, // count of how many messages updated
+	 *                  'notupdated' => 0, // count of how many messages not updated.
+	 *                  'errors'     => array( $token ), // message object tokens that had errors in saving
+	 *                  ]
+	 */
+	public function saveAll(bool $do_hooks_only = false): array
+	{
+		$save_tracking = ['updated' => 0, 'notupdated' => 0, 'errors' => []];
+
+		if (! $do_hooks_only) {
+			$this->rewind();
+			// exit early if there is nothing to save.
+			if ($this->count() < 1) {
+				return $save_tracking;
+			}
+
+			while ($this->valid()) {
+				$saved = $this->current()->save();
+				if ($saved === false) {
+					$save_tracking['errors'][] = $this->current()->MSG_token();
+				} elseif ($saved) {
+					$save_tracking['updated']++;
+				} else {
+					$save_tracking['notupdated']++;
+				}
+				// maybe persist generation data if this is an incomplete EE_Message.
+				$this->_maybe_persist_attached_data();
+
+				$this->next();
+			}
+		}
+		do_action('AHEE__EE_Message_Repository__saveAll__after', $save_tracking, $this, $do_hooks_only);
+		return $save_tracking;
+	}
+
+
+	/**
+	 * Retrieves a EE_Message from the repository that matches the given token.
+	 *
+	 * @param string $token Token.
+	 * @return EE_Message | null
+	 */
+	public function getMessageByToken(string $token): ?EE_Message
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->MSG_token() === $token) {
+				$message = $this->current();
+				$this->rewind();
+				return $message;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * This retrieves any data required for generation that may be saved with the current EE_Message in storage.
+	 *
+	 * @return array();
+	 */
+	public function get_generation_data(): array
+	{
+		// first verify we're at a valid iterator point.
+		if (! $this->valid()) {
+			return [];
+		}
+		$info = $this->getInfo();
+		return $info['data']['MSG_generation_data'] ?? [];
+	}
+
+
+	/**
+	 * Retrieves the data_handler_class_name or reference associated with the current EE_Message object in the iterator.
+	 *
+	 * @return string
+	 */
+	public function get_data_handler(): string
+	{
+		if (! $this->valid()) {
+			return '';
+		}
+		$info = $this->getInfo();
+		return $info['data_handler_class_name'] ?? '';
+	}
+
+
+	/**
+	 * Returns whether this EE_Message is for a preview or not.
+	 *
+	 * @return bool
+	 */
+	public function is_preview(): bool
+	{
+		if (! $this->valid()) {
+			return false;
+		}
+		$info = $this->getInfo();
+		return filter_var($info['preview'] ?? false, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * Returns whether the current message pointed to is for a test send.
+	 *
+	 * @return bool
+	 */
+	public function is_test_send(): bool
+	{
+		if (! $this->valid()) {
+			return false;
+		}
+		$info = $this->getInfo();
+		return filter_var($info['test_send'] ?? false, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 *  This checks if the current EE_Message in the iterator is incomplete. If it is, then
+	 *  data is attached for later retrieval (batch generation).
+	 */
+	protected function _maybe_persist_attached_data()
+	{
+		if (! $this->valid()) {
+			return;
+		}
+
+		$info                    = $this->getInfo();
+		$data_handler_class_name = $info['data_handler_class_name'] ?? '';
+		$data                    = $info['data']['MSG_generation_data'] ?? [];
+		if ($data && $this->current()->STS_ID() === EEM_Message::status_incomplete) {
+			$this->current()->set_generation_data($data);
+			$this->current()->set_field_or_extra_meta('data_handler_class_name', $data_handler_class_name);
+		}
+	}
+
+
+	/**
+	 * This method returns a count of messages in the repository that have a given priority.
+	 *
+	 * @param int               $priority the priority that is being filtered for the count.
+	 * @param array|string|null $status   the optional status(es) that will also be filtered by when priority matches.
+	 * @return int  count of messages in the queue matching the conditions.
+	 */
+	public function count_by_priority_and_status(int $priority, $status = []): int
+	{
+		$count  = 0;
+		$status = is_array($status) ? $status : [$status];
+		$this->rewind();
+		while ($this->valid()) {
+			if (
+				$this->current()->priority() === $priority
+				&& (empty($status) || in_array($this->current()->STS_ID(), $status))
+			) {
+				$count++;
+			}
+			$this->next();
+		}
+		return $count;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -97,7 +97,7 @@ 
     {
         $save_tracking = ['updated' => 0, 'notupdated' => 0, 'errors' => []];
 
-        if (! $do_hooks_only) {
+        if ( ! $do_hooks_only) {
             $this->rewind();
             // exit early if there is nothing to save.
             if ($this->count() < 1) {
@@ -153,7 +153,7 @@ 
     public function get_generation_data(): array
     {
         // first verify we're at a valid iterator point.
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return [];
         }
         $info = $this->getInfo();
@@ -168,7 +168,7 @@ 
      */
     public function get_data_handler(): string
     {
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return '';
         }
         $info = $this->getInfo();
@@ -183,7 +183,7 @@ 
      */
     public function is_preview(): bool
     {
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return false;
         }
         $info = $this->getInfo();
@@ -198,7 +198,7 @@ 
      */
     public function is_test_send(): bool
     {
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return false;
         }
         $info = $this->getInfo();
@@ -212,7 +212,7 @@ 
      */
     protected function _maybe_persist_attached_data()
     {
-        if (! $this->valid()) {
+        if ( ! $this->valid()) {
             return;
         }